Skip to content

Commit 2d7022e

Browse files
olotenalexmolev
andauthored
Parameterized the files under content_bestpractices (#2521)
Replaced or reworked product names with either variables or generic content for best practices section Co-authored-by: alexmolev <amolev@gmail.com>
1 parent 48f7fe9 commit 2d7022e

6 files changed

Lines changed: 22 additions & 22 deletions

File tree

content/bestpractices/jenkins-plugin.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Jenkins Plugin"
3-
description: "Introduction to Jenkins' Cloudify integration"
3+
description: "Introduction to Jenkins' integration"
44
weight: 99
55
alwaysopen: false
66
---
@@ -11,15 +11,15 @@ alwaysopen: false
1111

1212
![Jenkins Plugin]( /images/jenkins/jenkins-plugin.png )
1313

14-
The Jenkins Plugin for Cloudify, provided with version 5.0.5 onward, allows Jenkins authors
15-
to embed Cloudify functions within jobs and pipelines.
14+
The Jenkins Plugin for {{< param product_name >}}, provided with version 5.0.5 onward, allows Jenkins authors
15+
to embed {{< param product_name >}} functions within jobs and pipelines.
1616

1717
### Plugin contents
1818

1919
The plugin provides:
2020

21-
* Discrete build steps for basic Cloudify functions (uploading / deleting blueprints, creating / deleting environments, workflow execution and so forth)
22-
* A standard Jenkins _Build Wrapper_, a convenient enclosure for other build steps that sets up a Cloudify environment before the main steps and deletes the environment afterwards
21+
* Discrete build steps for basic {{< param product_name >}} functions (uploading / deleting blueprints, creating / deleting environments, workflow execution and so forth)
22+
* A standard Jenkins _Build Wrapper_, a convenient enclosure for other build steps that sets up a {{< param product_name >}} environment before the main steps and deletes the environment afterwards
2323
* Build steps for integration with other provisioning tools:
2424
* Azure ARM
2525
* AWS CloudFormation

content/bestpractices/manager_of_managers/_index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,22 @@ abstract: Spire Manager
77
weight: 102
88
---
99

10-
# Using Cloudify as a Manager of Managers (a.k.a MoM or Spire)
11-
![Using Cloudify as a Manager of Managers](/images/mom/spire.png "Using Cloudify as a Manager of Managers")
12-
*Using Cloudify as a Manager of Managers*
10+
# Using {{< param product_name >}} as a Manager of Managers (a.k.a MoM or Spire)
11+
![Using {{< param product_name >}} as a Manager of Managers](/images/mom/spire.png "Using {{< param product_name >}} as a Manager of Managers")
12+
*Using {{< param product_name >}} as a Manager of Managers*
1313

1414

15-
The Cloudify managers of managers (Spire) feature allows control of several managers (*local managers*) from one manager (*Spire*) via the deploy-on feature.
15+
The {{< param product_name >}} managers of managers (Spire) feature allows control of several managers (*local managers*) from one manager (*Spire*) via the deploy-on feature.
1616
The deploy-on feature allows users to deploy services on the discovered environments.
1717
The deploy-on feature also provides a means to deploy the same service on multiple environments using a single command. Users can group the environments based on location, tagging and filters.
1818
The following guide provides a step by step guide on how to install sub managers, add them to a central manager using a discovery mechanism, and deploy an application on multiple managers through a single command.
1919

2020

21-
## 1. Installation of Cloudify Spire Manager
21+
## 1. Installation of {{< param cfy_spire_name >}} Manager
2222

23-
To install the ***MAIN Manager (Spire)***, please refer to the [Cloudify official documentation.](https://docs.cloudify.co/latest/install_maintain/installation/installing-manager/)
23+
To install the ***MAIN Manager (Spire)***, please refer to the [{{< param product_name >}} official documentation.](https://docs.cloudify.co/latest/install_maintain/installation/installing-manager/)
2424

25-
You can also check [Cloudify EC2 Provisioning](https://github.com/cloudify-community/cloudify-catalog/tree/6.4.0-build/cloudify_manager/ec2). It is the package for installing the *Cloudify Manager* on an ec2 AWS instance.
25+
You can also check [{{< param product_name >}} EC2 Provisioning](https://github.com/cloudify-community/cloudify-catalog/tree/6.4.0-build/cloudify_manager/ec2). It is the package for installing the *{{< param cfy_manager_name >}}* on an ec2 AWS instance.
2626

2727
## 2. Installation of sub-managers
2828

@@ -40,17 +40,17 @@ First step is to deploy [manager_discovery.yaml](https://github.com/cloudify-com
4040
- ***protocol*** - protocol used by sub manager
4141
- ***port*** - number of port which sub manager is exposed
4242

43-
[Installation using the Cloudify Management Console]({{< relref "exposing_submanager/exposing_submanager_ui.md" >}})
43+
[Installation using the {{< param cfy_console_name >}}]({{< relref "exposing_submanager/exposing_submanager_ui.md" >}})
4444

45-
[Installation using the Cloudify API]({{< relref "exposing_submanager/exposing_submanager_api.md" >}})
45+
[Installation using the {{< param cfy_api_name >}}]({{< relref "exposing_submanager/exposing_submanager_api.md" >}})
4646

47-
[Installation using the Cloudify CLI]({{< relref "exposing_submanager/exposing_submanager_cli.md" >}})
47+
[Installation using the {{< param cfy_api_name >}}]({{< relref "exposing_submanager/exposing_submanager_cli.md" >}})
4848

4949

5050
### Required secrets
5151

5252
To perform correct management, you need to create also a proper [secret](https://docs.cloudify.co/latest/cli/orch_cli/secrets/) about your **all** sub managers in Spire central manager. There are two ways to connect Spire with sub managers:
53-
- _Token_ - contains the proper value of [Cloudify token](https://docs.cloudify.co/latest/cli/orch_cli/tokens/). The token can be created with command ***cfy token create***
53+
- _Token_ - contains the proper value of [{{< param product_name >}} token](https://docs.cloudify.co/latest/cli/orch_cli/tokens/). The token can be created with command ***cfy token create***
5454
- _User password_ and _username_- contains the value of password and name of the user
5555
![Secrets]( /images/mom/secrets.png )
5656

content/bestpractices/manager_of_managers/deploy_on_mechanism/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Inputs description:
2727
- *trust_all* - the value of ***CLOUDIFY_SSL_TRUST_ALL*** (true if the certificate is not valid or for testing purpose)
2828
- optional (depends on authentication type):
2929
- *cloudify_secret_token* - the name of the secret which contains token value
30-
- *cloudify_password_secret_name* and *cloudify_user_secret_name*- the name of the secret which contains value of the password and the user name of Cloudify user.
30+
- *cloudify_password_secret_name* and *cloudify_user_secret_name*- the name of the secret which contains value of the password and the user name of {{< param product_name >}} user.
3131

3232
## Verification “Deploy on” mechanism
3333
To check if deployments are deployed on local managers, follow the example below/

content/bestpractices/manager_of_managers/exposing_submanager/exposing_submanager_cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 105
55
alwaysopen: false
66
---
77

8-
#### Installation via Cloudify CLI.
8+
#### Installation via {{< param cfy_cli_name >}}.
99

1010
To proceed with CLI installation, refer to [official documentation](https://docs.cloudify.co/latest/cli/orch_cli/).
1111

content/bestpractices/plugin-development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Cloudify Plugin Development: Best Practices"
2+
title: "Plugin Development: Best Practices"
33
description: "Tips and best practices for plugin development"
44
weight: 98
55
alwaysopen: false
@@ -159,7 +159,7 @@ finally:
159159

160160
### Using `causes` with `RecoverableError` / `NonRecoverableError`
161161

162-
When raising one of Cloudify’s exceptions (`RecoverableError` or `NonRecoverableError`), as a result of an underlying exception, you should use the “causes” feature when creating the exception class. This ensures that important troubleshooting data is not lost.
162+
When raising one of {{< param product_name >}}’s exceptions (`RecoverableError` or `NonRecoverableError`), as a result of an underlying exception, you should use the “causes” feature when creating the exception class. This ensures that important troubleshooting data is not lost.
163163

164164
For example:
165165

content/bestpractices/vmware_docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Cloudify Solution for the VMware stack
2+
title: Solution for the VMware stack
33
category: Manager Architecture
44
draft: false
5-
abstract: Cloudify Solution for the VMware stack
5+
abstract: Solution for the VMware stack
66
weight: 100
77
aliases: /manager_architecture/create-deployment-flow/
88
---

0 commit comments

Comments
 (0)