Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parametrization of the working_with subfolder #2552

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/about/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: About Cloudify
description: Cloudify is an open-source cloud orchestration framework. which enables you to model applications and services and automate their entire life cycle
title: Overview
description: This product provides an open-source cloud orchestration framework enabling you to model applications and services, and automate their entire life cycle.
canonical: xxx.yyy
weight: 10
alwaysopen: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: What Is Cloudify?
title: Introduction
category: Introduction
draft: false
weight: 100
aliases: /intro/what-is-cloudify/
aliases: /intro/introduction/
---

{{< param product_name >}} is an open-source multi-cloud and edge orchestration platform.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Cloudify Manager
title: Manager Overview
category: Introduction
draft: false
weight: 200
Expand Down Expand Up @@ -28,6 +28,6 @@ In addition, the {{< param cfy_manager_name >}}:
* Retains a history of metrics and events
* Manages agents running on an application's host machines

Although you can use Cloudify to provision resources directly from the CLI, use Cloudify Manager to manage production-level applications.
Although you can use {{< param product_name >}} to provision resources directly from the CLI, use {{< param cfy_manager_name >}} to manage production-level applications.

For more information about Cloudify Manager, see the Cloudify Manager section later in this user's guide.
For more information about {{< param cfy_manager_name >}}, see the {{< param cfy_manager_name >}} section later in this user's guide.
2 changes: 1 addition & 1 deletion content/working_with/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Working with Cloudify
title: Working with Blueprints and Deployments
description: Working with blueprints and deployments for orchestration
weight: 50
alwaysopen: false
Expand Down
2 changes: 1 addition & 1 deletion content/working_with/console/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using the Cloudify Console
title: Using the Console
description:
weight: 60
alwaysopen: false
Expand Down
2 changes: 1 addition & 1 deletion content/working_with/integration/circleci.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "CircleCI"
description = "Introduction to Cloudify's CircleCI Integration"
description = "Introduction to the CircleCI Integration"
weight = 26
alwaysopen = false
+++
Expand Down
2 changes: 1 addition & 1 deletion content/working_with/integration/github-actions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "GitHub Actions"
description = "Introduction to Cloudify's GitHub Actions"
description = "Introduction to GitHub Actions"
weight = 25
alwaysopen = false
+++
Expand Down
2 changes: 1 addition & 1 deletion content/working_with/integration/gitlab-ci.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "GitLab CI/CD"
description = "Introduction to Cloudify's GitLab CI/CD integration"
description = "Introduction to GitLab CI/CD integration"
weight = 25
alwaysopen = false
+++
Expand Down
2 changes: 1 addition & 1 deletion content/working_with/integration/jenkins-plugin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Jenkins Plugin"
description = "Introduction to Jenkins' Cloudify integration"
description = "Introduction to Jenkins' integration"
weight = 24
alwaysopen = false
+++
Expand Down
2 changes: 1 addition & 1 deletion content/working_with/manager/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using the Cloudify Manager
title: Using the Manager
description:
weight: 20
alwaysopen: false
Expand Down
4 changes: 2 additions & 2 deletions content/working_with/manager/okta_authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases: /manager/okta_authentication/

{{< param product_name >}} enables integration with your local Okta system to authenticate users and provide Role-Based Access Control. This guide describes the configuration steps required to enable Okta authentication.

Other SAML 2.0 authentication solutions can be integrated with Cloudify. However, only Okta is tested and officially supported.
Other SAML 2.0 authentication solutions can be integrated with {{< param product_name >}}. However, only Okta is tested and officially supported.

{{% tip title="openssl version" %}}
To enable Okta integration, the openssl package on {{< param cfy_manager_name >}} needs to be of version 1.0.2. If you are running a {{< param product_name >}} image this is already the case, however if you are installing {{< param product_name >}} make sure to update the openssl package prior to the Okta configuration.
Expand All @@ -24,7 +24,7 @@ You'll need Okta administrator privileges and your {{< param product_name >}} IP
1. Open the Okta Admin dashboard
2. From the top menu, choose <b>Applications > Applications > Create App Integration</b>
3. In the <b>Create a new app integration</b> form, choose **SAML 2.0** as sign-in method
4. In the <b>General Settings</b> step, configure the application name, such as Cloudify Dev and add the logo.
4. In the <b>General Settings</b> step, configure the application name, such as {{< param product_name >}} Dev and add the logo.
5. In the <b>Configure SAML</b> step, configure the following in the **SAML Settings** section:

* In <b>General</b> subsection:
Expand Down
2 changes: 1 addition & 1 deletion content/working_with/manager/user-management.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Managing Users
description: Cloudify provides a user management mechanism, so you can define different users with different permissions, and upon login perform authentication and authorization to control the users’ access to resources.
description: A user management mechanism is provided, so you can define different users with different permissions, and upon login perform authentication and authorization to control the users’ access to resources.
category: Manager
draft: false
weight: 1400
Expand Down
10 changes: 5 additions & 5 deletions content/working_with/official_plugins/Configuration/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,15 +193,15 @@ Similar to the Script Plugin and the Fabric Plugin, you do not have to use any s

In addition, you can provide additional key-word args parameters to the AnsiblePlaybookFromFile class, such as `options_config`.

## Ansible Module for Cloudify
## Ansible Module for {{< param product_name >}}

You may use the ansible Cloudify module to store runtime properties inside of your Ansible playbooks.
You may use the ansible {{< param product_name >}} module to store runtime properties inside of your Ansible playbooks.

**requirements**

* Cloudify Ansible Plugin 3.0.0, or higher.
* Cloudify Manager 6.4, or higher.
* A Cloudify Manager that supports SSL, or your Cloudify manager rest credentials. You must collect your {{< param product_name >}} manager credentials. The module will try to use environment variables to connect to {{< param product_name >}} Manager, however, if your manager is not configured for SSL or if your security does not permit, you must provide credentials directly in the playbook. The module will try to load the {{< param product_name >}} rest client from the management worker virtual env, i.e. `/opt/mgmtworker/env/lib/python3.6/site-packages/` in Cloudify 6.4. If this path does not contain `cloudify_rest_client` or if it doesn't exist at all, or if it's not valid anymore, then the module will not work.
* {{< param product_name >}} Ansible Plugin 3.0.0, or higher.
* {{< param product_name >}} Manager 6.4, or higher.
* A {{< param cfy_manager_name >}} that supports SSL, or your {{< param cfy_manager_name >}} rest credentials. You must collect your {{< param product_name >}} manager credentials. The module will try to use environment variables to connect to {{< param product_name >}} Manager, however, if your manager is not configured for SSL or if your security does not permit, you must provide credentials directly in the playbook. The module will try to load the {{< param product_name >}} rest client from the management worker virtual env, i.e. `/opt/mgmtworker/env/lib/python3.6/site-packages/` in Cloudify 6.4. If this path does not contain `cloudify_rest_client` or if it doesn't exist at all, or if it's not valid anymore, then the module will not work.
* You must install the Ansible module in one of the appropriate paths for ansible modules, for example `/etc/cloudify/.ansible/plugins/modules.`.

## Using the module:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Diamond Plugin
category: Official Plugins
draft: false
abstract: "Cloudify diamond plugin description and configuration"
abstract: "Diamond plugin description and configuration"
description: "DEPRECATED: The Diamond plugin is used to install & configure a Diamond monitoring agent (version 3.5) on hosts."
weight: 120
aliases:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Fabric (SSH) Plugin
category: Official Plugins
draft: false
abstract: "Cloudify Fabric plugin description and configuration"
abstract: "Fabric plugin description and configuration"
description: You can use the Fabric plugin to map operations to SSH commands or Fabric tasks that are included in your blueprint.
weight: 100
aliases:
Expand Down
4 changes: 2 additions & 2 deletions content/working_with/official_plugins/Configuration/script.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Script Plugin
category: Official Plugins
draft: false
abstract: "Cloudify script plugin description and configuration"
abstract: "Script plugin description and configuration"
description: "The Script plugin can be used to map node life-cycle operations and workflows to scripts that are included in your blueprint. Scripts can be written in Python, bash, ruby, and so on."
weight: 100
aliases:
Expand Down Expand Up @@ -45,7 +45,7 @@ imports:
node_templates:
example_web_server:
# The web server type is only used for this example. The type used
# could be any valid cloudify type.
# could be any valid {{< param product_name >}} type.
type: cloudify.nodes.WebServer
interfaces:
cloudify.interfaces.lifecycle:
Expand Down
8 changes: 4 additions & 4 deletions content/working_with/official_plugins/Infrastructure/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -1060,7 +1060,7 @@ For more information, and possible keyword arguments, see: [EC2:create_key_pair]

* `log_create_response`: Boolean. Opt-in to storing the create API request. Not recommended, will log private key material.
* `store_in_runtime_properties`: Boolean. Opt-in to save the KeyPair KeyMaterial in the node-instance runtime-properties. Not recommended.
* `create_secret`: Boolean. Opt-in to save the KeyPair KeyMaterial in the secret store. Only available in Cloudify Manager.
* `create_secret`: Boolean. Opt-in to save the KeyPair KeyMaterial in the secret store. Only available in {{< param cfy_manager_name >}}.
* `secret_name`: String. The name of the secret if `create_secret` is `true`.
* `update_existing_secret`: String. If `secret_name` already exists, overwrite the value.

Expand Down Expand Up @@ -2913,11 +2913,11 @@ For more information, and possible keyword arguments, see: [CloudFormation:creat
* `cloudify.interfaces.lifecycle.create`: Store `resource_config` in runtime properties.
* `cloudify.interfaces.lifecycle.configure`: Executes the [CreateStack](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html) action.
* `inputs`:
* `minimum_wait_time`: Sets the minimum time in seconds that Cloudify will wait for AWS to create the stack.
* `minimum_wait_time`: Sets the minimum time in seconds that {{< param product_name >}} will wait for AWS to create the stack.
* `cloudify.interfaces.lifecycle.start`: Executes the same operations as `cloudify.interfaces.lifecycle.pull`.
* `cloudify.interfaces.lifecycle.delete`: Executes the [DeleteStack](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeleteStack.html) action.
* `inputs`:
* `minimum_wait_time`: Sets the minimum time in seconds that Cloudify will wait for AWS to delete the stack.
* `minimum_wait_time`: Sets the minimum time in seconds that {{< param product_name >}} will wait for AWS to delete the stack.
* `cloudify.interfaces.lifecycle.pull`: Executes:
* [DetectStackDrift](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DetectStackDrift.html) action.
* [ListStackResources](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStackResources.html) action, and store the result under `state` runtime property .
Expand Down Expand Up @@ -2974,7 +2974,7 @@ Outputs:
```

Also, the order of the outputs is not guaranteed. That makes it impossible to refer to output values
through Cloudify's intrinsic functions (such as `get_attribute`).
through {{< param product_name >}}'s intrinsic functions (such as `get_attribute`).

In order to address this, the plugin sets a runtime property by the name `outputs_items`, which is a
dictionary containing the output values. This runtime property is only set if the `Outputs` key exists
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1162,7 +1162,7 @@ You can use existing resources on Azure, regardless of whether they have been cr

All {{< param product_name >}} Azure types have these properties that determine the behaviour:

* `use_external_resource` - Indicate whether the resource exists or if Cloudify should create the resource.
* `use_external_resource` - Indicate whether the resource exists or if {{< param product_name >}} should create the resource.
* `create_if_missing` - If use_external_resource is true, and the resource does not exist, create it.
* `use_if_exists`- If use_external_resource is false, but the resource does exist, use it.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Host-Pool Plugin
category: Official Plugins
description: The Host-Pool plugin is an infrastrcture-provisioning plugin that is used in conjunction with the Cloudify Host-Pool Service to use hosts from a pool of existing hosts
description: The Host-Pool plugin is an infrastrcture-provisioning plugin that is used in conjunction with the Host-Pool Service to use hosts from a pool of existing hosts
draft: false
abstract: "Cloudify Host-Pool plugin description and configuration"
abstract: "Host-Pool plugin description and configuration"
weight: 180
aliases:
- /plugins/host-pool/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: NSX-T Plugin
category: Official Plugins
description: Cloudify NSX-T Plugin enables users create NSX-T Resources in NSX-T manager
description: The NSX-T Plugin enables users create NSX-T Resources in NSX-T manager
draft: false
weight: 150
aliases:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1285,7 +1285,7 @@ my_volume:
1. Creates a server, with name `my_server`, and with name on OpenStack *the node's ID* (since no `name` parameter was supplied under the `server` property). The server is set with an image and flavor IDs.
2. Creates a volume. It is set with a relationship to the `my_server` node: This designated relationship type will take care of attaching the volume to OpenStack server node.

## Example IV: Using Windows server with a Cloudify agent
## Example IV: Using Windows server with a {{< param product_name >}} agent

This example demonstrates how to use a Windows server on which a {{< param product_name >}} agent is deployed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -870,7 +870,7 @@ For more information, and possible keyword arguments, see: [create_floating_ip](
project_name: { get_input: project_name }
resource_config:
name: { concat: [ { get_input: name_prefix }, 'security_group' ] }
description: 'A security group created by Cloudify OpenStack SDK plugin.'
description: 'A security group created by {{< param product_name >}} OpenStack SDK plugin.'

example-security-group-rule:
type: cloudify.nodes.openstack.SecurityGroupRule
Expand Down Expand Up @@ -1052,7 +1052,7 @@ For more information, and possible keyword arguments, see: [create_floating_ip](
project_name: { get_input: project_name }
resource_config:
name: { concat: [ { get_input: name_prefix }, 'security_group' ] }
description: 'A security group created by Cloudify OpenStack SDK plugin.'
description: 'A security group created by {{< param product_name >}} OpenStack SDK plugin.'

example-security-group-rule:
type: cloudify.nodes.openstack.SecurityGroupRule
Expand Down Expand Up @@ -1360,7 +1360,7 @@ For more information, and possible keyword arguments, see: [create_port](https:/
protocol: tcp
resource_config:
name: { concat: [ { get_input: name_prefix }, 'security-group' ] }
description: 'A security group created by Cloudify OpenStack SDK plugin.'
description: 'A security group created by {{< param product_name >}} OpenStack SDK plugin.'


example-network:
Expand Down Expand Up @@ -2358,7 +2358,7 @@ For more information, and possible keyword arguments, see: [create_security_grou
project_name: { get_input: project_name }
resource_config:
name: example-security-group
description: 'A security group created by Cloudify OpenStack SDK plugin.'
description: 'A security group created by {{< param product_name >}} OpenStack SDK plugin.'
security_group_rules:
- remote_ip_prefix: 0.0.0.0/0
port_range_max: 22
Expand All @@ -2382,7 +2382,7 @@ For more information, and possible keyword arguments, see: [create_security_grou
disable_default_egress_rules: true
resource_config:
name: example-security-group
description: 'A security group created by Cloudify OpenStack SDK plugin.'
description: 'A security group created by {{< param product_name >}} OpenStack SDK plugin.'
security_group_rules:
- remote_ip_prefix: 0.0.0.0/0
port_range_max: 22
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The following are possible for a StarlingX system deployment:

# Sites

During installation the plugin requests a system's location (latitude and longitude) from the StarlingX API, and creates a [Site]({{< relref "working_with/console/widgets/sites.md" >}}) in Cloudify. You can see sites' location on the map on the Dashboard screen.
During installation the plugin requests a system's location (latitude and longitude) from the StarlingX API, and creates a [Site]({{< relref "working_with/console/widgets/sites.md" >}}) in {{< param product_name >}}. You can see sites' location on the map on the Dashboard screen.

# Node Types

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: vCloud Plugin
category: Official Plugins
description: The vCloud Plugin 2 enables you to use a vCloud-based infrastructure for deploying services and applications
draft: false
abstract: Cloudify vCloud plugin description and configuration
abstract: vCloud plugin description and configuration
weight: 140
aliases:
- /plugins/vcloud/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Each type has a `connection_config` property. It can be used to pass parameters

* `cloudify.interfaces.host`:
* `get_state`:
* `minimum_wait_time`: Sets the minimum time in seconds that Cloudify will wait before pulling the state info.
* `minimum_wait_time`: Sets the minimum time in seconds that {{< param product_name >}} will wait before pulling the state info.
should be used when the os requires extra time to complete configuration and all the reported information to become available from vSphere.


Expand Down
2 changes: 1 addition & 1 deletion content/working_with/official_plugins/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Official Plugins
description: Overview of Cloudify Plugins
description: Plugins Overview
weight: 40
alwaysopen: false
aliases:
Expand Down
4 changes: 2 additions & 2 deletions content/working_with/service_now/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "Using ServiceNow"
description: "Get started with setting up your ServiceNow Application with Cloudify Manager"
description: "Get started with setting up your ServiceNow Application with the Manager"
weight: 100
alwaysopen: false
---

The Cloudify App for ServiceNow, available from version 5.1, allows ServiceNow users to embed {{< param product_name >}} functions within a company service portal, simplifying the usage of the {{< param cfy_manager_name >}} through ServiceNow.
The {{< param product_name >}} App for ServiceNow, available from version 5.1, allows ServiceNow users to embed {{< param product_name >}} functions within a company service portal, simplifying the usage of the {{< param cfy_manager_name >}} through ServiceNow.


{{%children style="h3" description="true"%}}
Loading