From c25e254d04c19f17795c5ae8bbaefde960677860 Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 23 Feb 2023 12:52:05 -0500 Subject: [PATCH 1/2] Parameterized content_cli for Applied variables and updated titles for product names in the files under content_cli --- content/cli/_index.md | 4 +-- content/cli/maint_cli/clusters.md | 4 +-- content/cli/maint_cli/config.md | 2 +- content/cli/maint_cli/init.md | 2 +- content/cli/maint_cli/ldap.md | 2 +- content/cli/maint_cli/license.md | 14 ++++----- content/cli/maint_cli/profiles.md | 2 +- content/cli/maint_cli/snapshots.md | 2 +- content/cli/maint_cli/ssh.md | 2 +- content/cli/maint_cli/tenants.md | 2 +- content/cli/maint_cli/use.md | 2 +- content/cli/maint_cli/usergroups.md | 2 +- content/cli/maint_cli/users.md | 2 +- content/cli/orch_cli/_index.md | 36 +++++++++++------------ content/cli/orch_cli/agents.md | 8 ++--- content/cli/orch_cli/blueprints.md | 10 +++---- content/cli/orch_cli/deployments.md | 6 ++-- content/cli/orch_cli/events.md | 2 +- content/cli/orch_cli/executions.md | 4 +-- content/cli/orch_cli/filter-rules.md | 2 +- content/cli/orch_cli/groups.md | 2 +- content/cli/orch_cli/install.md | 4 +-- content/cli/orch_cli/logs.md | 16 +++++----- content/cli/orch_cli/maintenance-mode.md | 8 ++--- content/cli/orch_cli/node-instances.md | 2 +- content/cli/orch_cli/nodes.md | 2 +- content/cli/orch_cli/plugins.md | 18 ++++++------ content/cli/orch_cli/secrets-providers.md | 2 +- content/cli/orch_cli/secrets.md | 4 +-- content/cli/orch_cli/status.md | 12 ++++---- content/cli/orch_cli/tokens.md | 6 ++-- content/cli/orch_cli/uninstall.md | 6 ++-- content/cli/orch_cli/workflows.md | 4 +-- 33 files changed, 98 insertions(+), 98 deletions(-) diff --git a/content/cli/_index.md b/content/cli/_index.md index c740f282f..77a06f432 100644 --- a/content/cli/_index.md +++ b/content/cli/_index.md @@ -1,6 +1,6 @@ +++ -title = "Cloudify CLI Commands" -description = "CLI Commands for the Cloudify Manager" +title = "CLI Commands" +description = "CLI Commands for the Manager" weight = 90 alwaysopen = false +++ diff --git a/content/cli/maint_cli/clusters.md b/content/cli/maint_cli/clusters.md index 3ec81797d..2df9da48a 100644 --- a/content/cli/maint_cli/clusters.md +++ b/content/cli/maint_cli/clusters.md @@ -1,6 +1,6 @@ --- title: cluster -description: The command is used to manage the Cloudify Manager cluster. +description: The command is used to manage the Manager cluster. category: Docs draft: false abstract: Command-Line Interface @@ -28,7 +28,7 @@ These commands support the [common CLI flags]({{< relref "cli/_index.md#common-o {{< highlight bash >}} $ cfy cluster status -Retrieving Cloudify cluster status... [ip=10.239.1.160] +Retrieving cluster status... [ip=10.239.1.160] Current cluster status is OK: Cluster status services: diff --git a/content/cli/maint_cli/config.md b/content/cli/maint_cli/config.md index 36f4bb512..5271d847d 100644 --- a/content/cli/maint_cli/config.md +++ b/content/cli/maint_cli/config.md @@ -1,6 +1,6 @@ --- title: config -description: The `cfy config` command is used to manage the Cloudify Manager's configuration. +description: The `cfy config` command is used to manage the Manager's configuration. category: Docs draft: false abstract: Command-Line Interface diff --git a/content/cli/maint_cli/init.md b/content/cli/maint_cli/init.md index b07eca2b2..dfd3c0ec8 100644 --- a/content/cli/maint_cli/init.md +++ b/content/cli/maint_cli/init.md @@ -1,6 +1,6 @@ --- title: init -description: The `cfy init` command is used to initialize a Cloudify working directory. +description: The `cfy init` command is used to initialize a working directory. category: Docs draft: false abstract: Command-Line Interface diff --git a/content/cli/maint_cli/ldap.md b/content/cli/maint_cli/ldap.md index 9786b2cd7..13ad683d8 100644 --- a/content/cli/maint_cli/ldap.md +++ b/content/cli/maint_cli/ldap.md @@ -1,6 +1,6 @@ --- title: ldap -description: The `cfy ldap` command is used to set LDAP authentication to enable you to integrate your LDAP users and groups with Cloudify. +description: The `cfy ldap` command is used to set LDAP authentication to enable you to integrate your LDAP users and groups. category: Docs draft: false abstract: Command-Line Interface diff --git a/content/cli/maint_cli/license.md b/content/cli/maint_cli/license.md index 72a8f9da2..09cb27afb 100644 --- a/content/cli/maint_cli/license.md +++ b/content/cli/maint_cli/license.md @@ -1,6 +1,6 @@ --- title: license -description: The `cfy license` command is used to manage the Cloudify Manager license. +description: The `cfy license` command is used to manage the Manager license. category: Docs draft: false abstract: Command-Line Interface @@ -28,8 +28,8 @@ Upload a license to a Manager. $ cfy license upload license.yaml ... -Uploading Cloudify License `license.yaml` to the Manager... -Cloudify license successfully uploaded. +Uploading license `license.yaml` to the Manager... +License successfully uploaded. ... {{< /highlight >}} @@ -48,9 +48,9 @@ List the details of the {{< param product_name >}} license. $ cfy license list ... -Retrieving Cloudify License +Retrieving License ... -Cloudify License +License +--------------+--------------------------+-----------------+-------+------------------+--------------+---------+ | customer_id | expiration_date | license_edition | trial | cloudify_version | capabilities | expired | @@ -75,8 +75,8 @@ Remove a {{< param product_name >}} license from the Manager. $ cfy license remove ... -Removing Cloudify License from the Manager... -Cloudify license successfully removed. +Removing License from the Manager... +License successfully removed. ... {{< /highlight >}} diff --git a/content/cli/maint_cli/profiles.md b/content/cli/maint_cli/profiles.md index 91c78e3d8..180463533 100644 --- a/content/cli/maint_cli/profiles.md +++ b/content/cli/maint_cli/profiles.md @@ -1,6 +1,6 @@ --- title: profiles -description: The `cfy profiles` command is used to manage the Cloudify profiles. +description: The `cfy profiles` command is used to manage product profiles. category: Docs draft: false abstract: Command-Line Interface diff --git a/content/cli/maint_cli/snapshots.md b/content/cli/maint_cli/snapshots.md index 2fc72cc22..7d5c8a9cc 100644 --- a/content/cli/maint_cli/snapshots.md +++ b/content/cli/maint_cli/snapshots.md @@ -1,6 +1,6 @@ --- title: snapshots -description: The `cfy snapshots` command is used to manage data snapshots of the Cloudify Manager. You must have `admin` credentials to create and restore snapshots. +description: The `cfy snapshots` command is used to manage data snapshots of the Manager. You must have `admin` credentials to create and restore snapshots. category: Docs draft: false abstract: Command-Line Interface diff --git a/content/cli/maint_cli/ssh.md b/content/cli/maint_cli/ssh.md index f2ddccc7e..4e4fcf266 100644 --- a/content/cli/maint_cli/ssh.md +++ b/content/cli/maint_cli/ssh.md @@ -1,6 +1,6 @@ --- title: ssh -description: The `cfy ssh` command is used to connect to a Cloudify Manager via SSH. +description: The `cfy ssh` command is used to connect to a Manager via SSH. category: Docs draft: false abstract: Command-Line Interface diff --git a/content/cli/maint_cli/tenants.md b/content/cli/maint_cli/tenants.md index c27834d4e..edd72bd17 100644 --- a/content/cli/maint_cli/tenants.md +++ b/content/cli/maint_cli/tenants.md @@ -1,6 +1,6 @@ --- title: tenants -description: The `cfy tenants` command is used to create and manage tenants on the Cloudify Manager. +description: The `cfy tenants` command is used to create and manage tenants on the Manager. category: Docs draft: false aliases: /cli/tenants/ diff --git a/content/cli/maint_cli/use.md b/content/cli/maint_cli/use.md index fe4a05235..16a53134d 100644 --- a/content/cli/maint_cli/use.md +++ b/content/cli/maint_cli/use.md @@ -1,6 +1,6 @@ --- title: use -description: The `cfy use` command is used to control a specific instance of the Cloudify Manager. +description: The `cfy use` command is used to control a specific instance of the Manager. category: Docs draft: true abstract: Command-Line Interface diff --git a/content/cli/maint_cli/usergroups.md b/content/cli/maint_cli/usergroups.md index a7a1061eb..1f47a1d3b 100644 --- a/content/cli/maint_cli/usergroups.md +++ b/content/cli/maint_cli/usergroups.md @@ -1,6 +1,6 @@ --- title: user-groups -description: The `cfy user-groups` command is used to define and manage user groups on the Cloudify Manager. +description: The `cfy user-groups` command is used to define and manage user groups on the Manager. category: Docs draft: false aliases: /cli/user-groups/ diff --git a/content/cli/maint_cli/users.md b/content/cli/maint_cli/users.md index 6b3382fbe..852d4eb7b 100644 --- a/content/cli/maint_cli/users.md +++ b/content/cli/maint_cli/users.md @@ -1,6 +1,6 @@ --- title: users -description: The `cfy users` command is used to manage users and passwords on the Cloudify Manager. +description: The `cfy users` command is used to manage users and passwords on the Manager. category: Docs draft: false aliases: /cli/users/ diff --git a/content/cli/orch_cli/_index.md b/content/cli/orch_cli/_index.md index 349bce26e..15d0b6426 100644 --- a/content/cli/orch_cli/_index.md +++ b/content/cli/orch_cli/_index.md @@ -1,23 +1,23 @@ --- title: Orchestration Commands -description: Cloudify CLI Commands for Orchestration +description: CLI Commands for Orchestration weight: 20 alwaysopen: false --- -The Cloudify command-line interface (CLI) is the default method for interacting with the Cloudify management environment, to manage your applications. It enables you to execute workflows on your local machine, and to interact with a running [Cloudify Manager]({{< relref "cloudify_manager/premium/aio/install_and_configure/centos_rhel.md" >}}) via SSH to upload and delete blueprints, create deployments, execute workflows, retrieve events, and more. +The {{< param product_name >}} command-line interface (CLI) is the default method for interacting with the {{< param product_name >}} management environment, to manage your applications. It enables you to execute workflows on your local machine, and to interact with a running [{{< param cfy_manager_name >}}]({{< relref "cloudify_manager/premium/aio/install_and_configure/centos_rhel.md" >}}) via SSH to upload and delete blueprints, create deployments, execute workflows, retrieve events, and more. -Working _locally_ refers to running workflows directly from the machine on which the CLI is installed. Working with an instance of Cloudify Manager refers to executing workflows directly from that Cloudify Manager instance. +Working _locally_ refers to running workflows directly from the machine on which the CLI is installed. Working with an instance of {{< param cfy_manager_name >}} refers to executing workflows directly from that {{< param cfy_manager_name >}} instance. -When you use the CLI to control a Cloudify Manager instance, additional commands appear in the CLI that are not available for use in local mode, for example communicating with a running Cloudify Manager using SSH, downloading its logs, creating snapshots, uploading plugins and so on. +When you use the CLI to control a {{< param cfy_manager_name >}} instance, additional commands appear in the CLI that are not available for use in local mode, for example communicating with a running {{< param cfy_manager_name >}} using SSH, downloading its logs, creating snapshots, uploading plugins and so on. {{% note title="Note" %}} -If you attempt to run a command that is not supported in local mode, an error message is returned advising you that the command is only supported when using Cloudify Manager. To use a Cloudify Manager, you can run [`cfy profiles use`]({{< relref "cli/maint_cli/profiles.md" >}}). +If you attempt to run a command that is not supported in local mode, an error message is returned advising you that the command is only supported when using {{< param cfy_manager_name >}}. To use a {{< param cfy_manager_name >}}, you can run [`cfy profiles use`]({{< relref "cli/maint_cli/profiles.md" >}}). {{% /note %}} -If you haven't already [installed Cloudify]({{< relref "cloudify_manager/cloudify_cli" >}}), now would be a good time to do so. +If you haven't already [{{< param product_name >}}]({{< relref "cloudify_manager/cloudify_cli" >}}), now would be a good time to do so. # Usage @@ -27,15 +27,15 @@ You can access the CLI by running the `cfy` command in your terminal. Use `cfy - $ cfy -h Usage: cfy [OPTIONS] COMMAND [ARGS]... - Cloudify's Command Line Interface + {{< param product_name >}}'s Command Line Interface Note that some commands are only available if you are using a Manager. You - can use Cloudify Manager by running the `cfy profiles use` command and providing + can use {{< param cfy_manager_name >}} by running the `cfy profiles use` command and providing it with the IP of the your manager (and SSH credentials if applicable). To activate bash-completion, run `eval "$(_CFY_COMPLETE=source cfy)"` - Cloudify's working directory resides in ~/.cloudify. To change it, set the + {{< param product_name >}}'s working directory resides in ~/.cloudify. To change it, set the variable `CFY_WORKDIR` to the appropriate directory (e.g. /tmp/). Options: @@ -49,7 +49,7 @@ Commands: agents Handle a deployment's agents apply Install a blueprint or update existing deployment with blueprint [manager only] blueprints Handle blueprints on the manager - cluster Handle the Cloudify Manager cluster + cluster Handle the {{< param cfy_manager_name >}} cluster deployments Handle deployments on the Manager dev Run fabric tasks [manager only] events Show events from workflow executions @@ -63,23 +63,23 @@ Commands: node-instances Handle a deployment's node-instances nodes Handle a deployment's nodes plugins Handle plugins on the manager - profiles Handle Cloudify CLI profiles Each profile can... - secrets Handle Cloudify secrets (key-value pairs) + profiles Handle {{< param cfy_api_name >}} profiles Each profile can... + secrets Handle {{< param product_name >}} secrets (key-value pairs) snapshots Handle manager snapshots ssh Connect using SSH [manager only] ssl Handle the manager's external ssl status Show manager status [manager only] - tenants Handle Cloudify tenants [Premium feature] + tenants Handle {{< param product_name >}} tenants [Premium feature] uninstall Uninstall an application blueprint [manager only] - user-groups Handle Cloudify user groups [Premium feature] - users Handle Cloudify users + user-groups Handle {{< param product_name >}} user groups [Premium feature] + users Handle {{< param product_name >}} users workflows Handle deployment workflows ... {{< /highlight >}} -Note that some features. such as viewing metric graphs and application topologies, are only available via the {{< param cfy_console_name >}} if you are running Cloudify Manager. +Note that some features. such as viewing metric graphs and application topologies, are only available via the {{< param cfy_console_name >}} if you are running {{< param cfy_manager_name >}}. # Inputs and Parameters @@ -98,7 +98,7 @@ You cannot pass non-string values when using the `key=value` method. # Configuration -By default, a `.cloudify` directory is created under ~(Home directory). You can change the location using an `_env_` variable (for example, `cfy init` or `cfy profiles use`). +By default, a `.{{< param product_name >}}` directory is created under ~(Home directory). You can change the location using an `_env_` variable (for example, `cfy init` or `cfy profiles use`). The directory contains a file named `config.yaml` that you can customize according to your preferences. @@ -140,6 +140,6 @@ The default sets the `cloudify.cli.main` and `cloudify.rest_client.http` loggers {{% note title="Note" %}} -The `.cloudify` directory might also contain other files and directories, which are used internally by `cfy`, that are not described in this section. +The `.{{< param product_name >}}` directory might also contain other files and directories, which are used internally by `cfy`, that are not described in this section. {{% /note %}} diff --git a/content/cli/orch_cli/agents.md b/content/cli/orch_cli/agents.md index 11c5995f4..f26204f4c 100644 --- a/content/cli/orch_cli/agents.md +++ b/content/cli/orch_cli/agents.md @@ -2,11 +2,11 @@ title: agents category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/agents/ --- -The `cfy agents` command is used to manage Cloudify agents on existing deployments. +The `cfy agents` command is used to manage {{< param product_name >}} agents on existing deployments. See [agents]({{< relref "install_maintain/agents/_index.md" >}}) for more information. @@ -84,8 +84,8 @@ and the and the [common CLI flags]({{< relref "cli/_index.md#common-options" >}} ### validate -Validates the connection between the Cloudify Manager and the live -Cloudify Agents (installed on remote hosts). +Validates the connection between the {{< param cfy_manager_name >}} and the live +{{< param cfy_agent_name >}} (installed on remote hosts). #### Usage `cfy agents validate [OPTIONS] [DEPLOYMENT_ID]` diff --git a/content/cli/orch_cli/blueprints.md b/content/cli/orch_cli/blueprints.md index 8266a0702..5ad21b626 100644 --- a/content/cli/orch_cli/blueprints.md +++ b/content/cli/orch_cli/blueprints.md @@ -2,11 +2,11 @@ title: blueprints category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/blueprints/ --- -The `cfy blueprints` command is used to manage blueprints on a Cloudify Manager instance. +The `cfy blueprints` command is used to manage blueprints on a {{< param cfy_manager_name >}} instance. You can use the command to upload, delete, download, validate and list blueprints and to retrieve information for a specific blueprint. @@ -25,7 +25,7 @@ These commands support the [common CLI flags]({{< relref "cli/_index.md#common-o #### Usage `cfy blueprints upload [options] BLUEPRINT_PATH` -Upload a blueprint to a Cloudify Manager. +Upload a blueprint to a {{< param cfy_manager_name >}}. `BLUEPRINT_PATH` can be either a local blueprint yaml file or blueprint archive; a url to a blueprint archive or an @@ -69,7 +69,7 @@ Supported archive types are: zip, tar, tar.gz and tar.bz2 * `-l, --visibility TEXT` - Defines who can see the resource, can be set to one of ['private', 'tenant', 'global'] [default: tenant]. {{% note title="Note" %}} -When you upload a local blueprint yaml, the CLI compresses the directory that contains the blueprint file and uploads the entire directory to the Cloudify Manager. +When you upload a local blueprint yaml, the CLI compresses the directory that contains the blueprint file and uploads the entire directory to the {{< param cfy_manager_name >}}. Make sure that: @@ -166,7 +166,7 @@ Packaging complete! #### Usage `cfy blueprints download [OPTIONS] BLUEPRINT_ID` -Download a blueprint from Cloudify Manager. +Download a blueprint from {{< param cfy_manager_name >}}. `BLUEPRINT_ID` - The ID of the blueprint to download. diff --git a/content/cli/orch_cli/deployments.md b/content/cli/orch_cli/deployments.md index 5ef83f055..05e2c4532 100644 --- a/content/cli/orch_cli/deployments.md +++ b/content/cli/orch_cli/deployments.md @@ -2,11 +2,11 @@ title: deployments category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/deployments/ --- -The `cfy deployments` command is used to manage running deployments on a Cloudify manager. +The `cfy deployments` command is used to manage running deployments on a {{< param cfy_manager_name >}}. You can use the command to create, delete, update and list deployments and to show the outputs for a specific deployment. @@ -194,7 +194,7 @@ List deployment update details. #### Usage `cfy deployments delete [OPTIONS] DEPLOYMENT_ID` -Delete a deployment from Cloudify Manager. +Delete a deployment from {{< param cfy_manager_name >}}. {{% note title="Note" %}} Deleting a deployment does not delete the resources of an application. To delete the resources, run the `uninstall` workflow (unless a custom uninstall workflow is provided). diff --git a/content/cli/orch_cli/events.md b/content/cli/orch_cli/events.md index 822059f78..6cd85beaf 100644 --- a/content/cli/orch_cli/events.md +++ b/content/cli/orch_cli/events.md @@ -2,7 +2,7 @@ title: events category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/events/ --- diff --git a/content/cli/orch_cli/executions.md b/content/cli/orch_cli/executions.md index 41811b92f..02e0bcbf6 100644 --- a/content/cli/orch_cli/executions.md +++ b/content/cli/orch_cli/executions.md @@ -2,11 +2,11 @@ title: executions category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/executions/ --- -The `cfy executions` command is used to manage workflow executions on Cloudify Manager. +The `cfy executions` command is used to manage workflow executions on {{< param cfy_manager_name >}}. You can use the command to start, cancel and and list executions and to retrieve information about a single execution. diff --git a/content/cli/orch_cli/filter-rules.md b/content/cli/orch_cli/filter-rules.md index b9ffe3908..e922b47f7 100644 --- a/content/cli/orch_cli/filter-rules.md +++ b/content/cli/orch_cli/filter-rules.md @@ -2,7 +2,7 @@ title: filter-rules category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/filter-rules/ --- diff --git a/content/cli/orch_cli/groups.md b/content/cli/orch_cli/groups.md index 2573cf472..5526e72ae 100644 --- a/content/cli/orch_cli/groups.md +++ b/content/cli/orch_cli/groups.md @@ -2,7 +2,7 @@ title: groups category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/groups/ --- diff --git a/content/cli/orch_cli/install.md b/content/cli/orch_cli/install.md index bde6e9d43..9a4a1e55d 100644 --- a/content/cli/orch_cli/install.md +++ b/content/cli/orch_cli/install.md @@ -2,11 +2,11 @@ title: install category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/install/ --- -The `cfy install` command is used to install an application using a Cloudify manager without having to manually go through the process of uploading a blueprint, creating a deployment and executing a workflow. +The `cfy install` command is used to install an application using a {{< param cfy_manager_name >}} without having to manually go through the process of uploading a blueprint, creating a deployment and executing a workflow. #### Usage diff --git a/content/cli/orch_cli/logs.md b/content/cli/orch_cli/logs.md index e9190cc00..b41ed93a5 100644 --- a/content/cli/orch_cli/logs.md +++ b/content/cli/orch_cli/logs.md @@ -2,13 +2,13 @@ title: logs category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/logs/ --- -The `cfy logs` command is used to manage log files on Cloudify Manager. +The `cfy logs` command is used to manage log files on {{< param cfy_manager_name >}}. -You can use the command to download, backup and purge Cloudify Manager service logs. +You can use the command to download, backup and purge {{< param cfy_manager_name >}} service logs. To use the command you must have the credentials (user and key) set in the local context and must run `cfy use -t MANAGEMENT_IP` prior to running the command. @@ -23,7 +23,7 @@ These commands support the [common CLI flags]({{< relref "cli/_index.md#common-o #### Usage `cfy logs backup [OPTIONS]` -Create a backup of all logs under a single archive and save it on Cloudify Manager under /var/log. +Create a backup of all logs under a single archive and save it on {{< param cfy_manager_name >}} under /var/log.   #### Example @@ -43,7 +43,7 @@ Backing up manager logs to /var/log/cloudify-manager-logs_20170330T122201_10.239 #### Usage `cfy logs download [OPTIONS]` -Download an archive containing all of the Cloudify Manager service logs. +Download an archive containing all of the {{< param cfy_manager_name >}} service logs. #### Optional flags @@ -70,11 +70,11 @@ Removing archive from manager... #### Usage `cfy logs purge [OPTIONS]` -Purge all log files on Cloudify Manager. +Purge all log files on {{< param cfy_manager_name >}}. Truncate all logs files under /var/log/cloudify. -This enables you to take extreme measures to clean up data from Cloudify Manager. For example, you might choose to run this command when the disk is full due to a bug that has caused the logs to bloat. +This enables you to take extreme measures to clean up data from {{< param cfy_manager_name >}}. For example, you might choose to run this command when the disk is full due to a bug that has caused the logs to bloat. The `-f, --force` flag is mandatory as a safety measure. @@ -84,7 +84,7 @@ The `-f, --force` flag is mandatory as a safety measure. {{% warning title="Forced Prerequisites Installation" %}} USE WITH CARE!
-Log files in Cloudify Manager are rotated. `cfy purge` is a safety measure in case disk space on Cloudify Manager runs out, and should only be used in extreme situations. +Log files in {{< param cfy_manager_name >}} are rotated. `cfy purge` is a safety measure in case disk space on {{< param cfy_manager_name >}} runs out, and should only be used in extreme situations. {{% /warning %}} diff --git a/content/cli/orch_cli/maintenance-mode.md b/content/cli/orch_cli/maintenance-mode.md index 577b45de9..1e8aee81b 100644 --- a/content/cli/orch_cli/maintenance-mode.md +++ b/content/cli/orch_cli/maintenance-mode.md @@ -2,7 +2,7 @@ title: maintenance-mode category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/maintenance-mode/ --- @@ -26,7 +26,7 @@ These commands support the [common CLI flags]({{< relref "cli/_index.md#common-o #### Usage `cfy maintenance-mode activate [OPTIONS]` -Enter maintenance-mode on Cloudify Manager, rejecting further REST requests. +Enter maintenance-mode on {{< param cfy_manager_name >}}, rejecting further REST requests. #### Optional flags @@ -55,7 +55,7 @@ Run 'cfy maintenance-mode status' to check the maintenance mode's status. #### Usage `cfy maintenance-mode deactivate` -Deactivate maintenance-mode on the Cloudify Manager, to accept REST requests. +Deactivate maintenance-mode on the {{< param cfy_manager_name >}}, to accept REST requests.   #### Example @@ -91,7 +91,7 @@ Maintenance Mode Status: Activated At: 2017-04-04T05:16:21.407Z Activation Requested At: 2017-04-04T05:16:21.407Z -INFO - Cloudify Manager is currently in maintenance mode. Most requests will be blocked. +INFO - {{< param cfy_manager_name >}} is currently in maintenance mode. Most requests will be blocked. ... {{< /highlight >}} diff --git a/content/cli/orch_cli/node-instances.md b/content/cli/orch_cli/node-instances.md index b90d62fec..c32026e8b 100644 --- a/content/cli/orch_cli/node-instances.md +++ b/content/cli/orch_cli/node-instances.md @@ -2,7 +2,7 @@ title: node-instances category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/node-instances/ --- diff --git a/content/cli/orch_cli/nodes.md b/content/cli/orch_cli/nodes.md index c5fdbf4a9..b36a99176 100644 --- a/content/cli/orch_cli/nodes.md +++ b/content/cli/orch_cli/nodes.md @@ -2,7 +2,7 @@ title: nodes category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/nodes/ --- diff --git a/content/cli/orch_cli/plugins.md b/content/cli/orch_cli/plugins.md index bf7c52a78..757cb4fb5 100644 --- a/content/cli/orch_cli/plugins.md +++ b/content/cli/orch_cli/plugins.md @@ -2,15 +2,15 @@ title: plugins category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/plugins/ --- -The `cfy plugins` command is used to manage plugins stored on a Cloudify manager. +The `cfy plugins` command is used to manage plugins stored on a {{< param cfy_manager_name >}}. You can use the command to upload, download, delete and list plugins and also to get information on a specific plugin. -A Cloudify plugin is an archive created by [wagon](http://github.com/cloudify-cosmo/wagon). +A {{< param product_name >}} plugin is an archive created by [wagon](http://github.com/cloudify-cosmo/wagon). Each plugin has a plugin.yaml file that map node lifecycle operations to appropriate plugin functions. @@ -27,12 +27,12 @@ These commands support the [common CLI flags]({{< relref "cli/_index.md#common-o #### Usage `cfy plugins upload [OPTIONS] PLUGIN_PATH` -Upload a plugin to Cloudify Manager. +Upload a plugin to {{< param cfy_manager_name >}}. `PLUGIN_PATH` is the path to the wagon archive to upload. {{% note title="Important" %}} -Wagon (via the `--format` flag) enables you to create archives in both `tar.gz` and `zip` formats. Cloudify only supports wagon in the `tar.gz` format. +Wagon (via the `--format` flag) enables you to create archives in both `tar.gz` and `zip` formats. {{< param product_name >}} only supports wagon in the `tar.gz` format. {{% /note %}} #### Required flags @@ -73,7 +73,7 @@ Plugin uploaded. The plugin's id is e90b1a09-6b56-4a92-b9cd-5fc4ef32ab74 #### Usage `cfy plugins download [OPTIONS] PLUGIN_ID` -Download a plugin from Cloudify Manager. +Download a plugin from {{< param cfy_manager_name >}}. `PLUGIN_ID` is the ID of the plugin to download. @@ -103,7 +103,7 @@ Plugin downloaded as e90b1a09-6b56-4a92-b9cd-5fc4ef32ab74.tar.gz #### Usage `cfy plugins delete [OPTIONS] PLUGIN_ID` -Delete a plugin from Cloudify Manager. +Delete a plugin from {{< param cfy_manager_name >}}. `PLUGIN_ID` is the ID of the plugin to be deleted. @@ -131,7 +131,7 @@ Plugin deleted #### Usage `cfy plugins list [OPTIONS]` -List all available plugins on Cloudify Manager. +List all available plugins on {{< param cfy_manager_name >}}. You can use this command to retrieve the IDs of the plugins you want to download or delete. #### Optional flags @@ -377,7 +377,7 @@ Delete resource tags from specific plugin. #### Usage `cfy plugins bundle-upload [OPTIONS]` -Upload a bundle of plugins to Cloudify Manager. +Upload a bundle of plugins to {{< param cfy_manager_name >}}. #### Optional flags diff --git a/content/cli/orch_cli/secrets-providers.md b/content/cli/orch_cli/secrets-providers.md index 86fa9eac9..1e5c2f4d4 100644 --- a/content/cli/orch_cli/secrets-providers.md +++ b/content/cli/orch_cli/secrets-providers.md @@ -2,7 +2,7 @@ title: secrets providers category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/secrets-providers/ --- diff --git a/content/cli/orch_cli/secrets.md b/content/cli/orch_cli/secrets.md index 1ae2eebb4..84d4e653c 100644 --- a/content/cli/orch_cli/secrets.md +++ b/content/cli/orch_cli/secrets.md @@ -2,11 +2,11 @@ title: secrets category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/secrets/ --- -The `cfy secrets` command is used to manage Cloudify secrets (key-value pairs). +The `cfy secrets` command is used to manage {{< param product_name >}} secrets (key-value pairs). #### Optional flags These commands support the [common CLI flags]({{< relref "cli/_index.md#common-options" >}}). diff --git a/content/cli/orch_cli/status.md b/content/cli/orch_cli/status.md index bc5348311..b84a239dc 100644 --- a/content/cli/orch_cli/status.md +++ b/content/cli/orch_cli/status.md @@ -2,11 +2,11 @@ title: status category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/status/ --- -The `cfy status` command is used to display the status of a running Cloudify Manager. +The `cfy status` command is used to display the status of a running {{< param cfy_manager_name >}}. To use the command you must `cfy profiles use -t MANAGEMENT_IP` first. @@ -35,13 +35,13 @@ Services: +--------------------------------+--------+ | service | status | +--------------------------------+--------+ -| Cloudify Console | Active | +| {{< param product_name >}} Console | Active | | PostgreSQL | Active | | AMQP-Postgres | Active | | Manager Rest-Service | Active | | RabbitMQ | Active | | Webserver | Active | -| Cloudify Composer | Active | +| {{< param product_name >}} Composer | Active | | Management Worker | Active | +--------------------------------+--------+ @@ -55,14 +55,14 @@ Services: +--------------------------------+--------+ | service | status | +--------------------------------+--------+ -| Cloudify Console | Active | +| {{< param product_name >}} Console | Active | | Manager Rest-Service | Active | | PostgreSQL | Active | | AMQP-Postgres | Active | | File Sync Service | Active | | RabbitMQ | Active | | Webserver | Active | -| Cloudify Composer | Active | +| {{< param product_name >}} Composer | Active | | Management Worker | Active | +--------------------------------+--------+ ... diff --git a/content/cli/orch_cli/tokens.md b/content/cli/orch_cli/tokens.md index 89bb78588..4b87dbc64 100644 --- a/content/cli/orch_cli/tokens.md +++ b/content/cli/orch_cli/tokens.md @@ -2,11 +2,11 @@ title: tokens category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/tokens/ --- -The `cfy tokens` command is used to receive a REST token from the Cloudify Manager. +The `cfy tokens` command is used to receive a REST token from the {{< param cfy_manager_name >}}. ## Commands @@ -15,7 +15,7 @@ The `cfy tokens` command is used to receive a REST token from the Cloudify Manag #### Usage `cfy tokens get [OPTIONS]` -Returns a valid REST token from the Cloudify Manager. +Returns a valid REST token from the {{< param cfy_manager_name >}}. #### Optional flags This command supports the [common CLI flags]({{< relref "cli/_index.md#common-options" >}}). diff --git a/content/cli/orch_cli/uninstall.md b/content/cli/orch_cli/uninstall.md index c9197fcd8..bcd94d1f9 100644 --- a/content/cli/orch_cli/uninstall.md +++ b/content/cli/orch_cli/uninstall.md @@ -2,17 +2,17 @@ title: uninstall category: Docs draft: false -abstract: Cloudify's Command-Line Interface +abstract: Command-Line Interface aliases: /cli/uninstall/ --- -The `cfy uninstall` command is used to uninstall an application using Cloudify Manager, without having to manually go through the process of executing a workflow, deleting a deployment and deleting a blueprint. +The `cfy uninstall` command is used to uninstall an application using {{< param cfy_manager_name >}}, without having to manually go through the process of executing a workflow, deleting a deployment and deleting a blueprint. #### Usage `cfy uninstall [OPTIONS] DEPLOYMENT_ID` -Uninstall an application via Cloudify Manager. +Uninstall an application via {{< param cfy_manager_name >}}. This command executes the `uninstall` workflow, deletes the deployment and the blueprint (if there is only one deployment for that blueprint). diff --git a/content/cli/orch_cli/workflows.md b/content/cli/orch_cli/workflows.md index 3bed2987b..8ba012d5b 100644 --- a/content/cli/orch_cli/workflows.md +++ b/content/cli/orch_cli/workflows.md @@ -2,7 +2,7 @@ title: workflows category: Docs draft: false -abstract: Cloudify Command-Line Interface +abstract: Command-Line Interface aliases: /cli/workflows/ --- @@ -20,7 +20,7 @@ These commands support the [common CLI flags]({{< relref "cli/_index.md#common-o #### Usage `cfy workflows list [OPTIONS]` -Lists all workflows on the Cloudify Manager for a specific deployment. +Lists all workflows on the {{< param cfy_manager_name >}} for a specific deployment. `DEPLOYMENT_ID` The ID of the deployment for which you want to list the workflows. From a5b267890caa0bdc5a5540e358cdf2cff1a75ac0 Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 30 May 2023 11:29:26 -0400 Subject: [PATCH 2/2] Updated with review comments Revised with comments from initial review. Restored "Cloudify" test where required. --- content/cli/maint_cli/clusters.md | 2 +- content/cli/maint_cli/license.md | 10 +++++----- content/cli/maint_cli/profiles.md | 2 +- content/cli/orch_cli/_index.md | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/content/cli/maint_cli/clusters.md b/content/cli/maint_cli/clusters.md index 2df9da48a..d808f6f96 100644 --- a/content/cli/maint_cli/clusters.md +++ b/content/cli/maint_cli/clusters.md @@ -28,7 +28,7 @@ These commands support the [common CLI flags]({{< relref "cli/_index.md#common-o {{< highlight bash >}} $ cfy cluster status -Retrieving cluster status... [ip=10.239.1.160] +Retrieving Cloudify cluster status... [ip=10.239.1.160] Current cluster status is OK: Cluster status services: diff --git a/content/cli/maint_cli/license.md b/content/cli/maint_cli/license.md index 09cb27afb..f4826cc47 100644 --- a/content/cli/maint_cli/license.md +++ b/content/cli/maint_cli/license.md @@ -28,8 +28,8 @@ Upload a license to a Manager. $ cfy license upload license.yaml ... -Uploading license `license.yaml` to the Manager... -License successfully uploaded. +Uploading Cloudify license `license.yaml` to the Manager... +Cloudify license successfully uploaded. ... {{< /highlight >}} @@ -50,7 +50,7 @@ $ cfy license list Retrieving License ... -License +Cloudify License +--------------+--------------------------+-----------------+-------+------------------+--------------+---------+ | customer_id | expiration_date | license_edition | trial | cloudify_version | capabilities | expired | @@ -75,8 +75,8 @@ Remove a {{< param product_name >}} license from the Manager. $ cfy license remove ... -Removing License from the Manager... -License successfully removed. +Removing Cloudify License from the Manager... +Cloudify License successfully removed. ... {{< /highlight >}} diff --git a/content/cli/maint_cli/profiles.md b/content/cli/maint_cli/profiles.md index 180463533..9ff307d75 100644 --- a/content/cli/maint_cli/profiles.md +++ b/content/cli/maint_cli/profiles.md @@ -1,6 +1,6 @@ --- title: profiles -description: The `cfy profiles` command is used to manage product profiles. +description: The `cfy profiles` command is used to manage the product profiles. category: Docs draft: false abstract: Command-Line Interface diff --git a/content/cli/orch_cli/_index.md b/content/cli/orch_cli/_index.md index 15d0b6426..a01dd7579 100644 --- a/content/cli/orch_cli/_index.md +++ b/content/cli/orch_cli/_index.md @@ -17,7 +17,7 @@ If you attempt to run a command that is not supported in local mode, an error me {{% /note %}} -If you haven't already [{{< param product_name >}}]({{< relref "cloudify_manager/cloudify_cli" >}}), now would be a good time to do so. +If you haven't already [installed {{< param product_name >}}]({{< relref "cloudify_manager/cloudify_cli" >}}), now would be a good time to do so. # Usage @@ -98,7 +98,7 @@ You cannot pass non-string values when using the `key=value` method. # Configuration -By default, a `.{{< param product_name >}}` directory is created under ~(Home directory). You can change the location using an `_env_` variable (for example, `cfy init` or `cfy profiles use`). +By default, a `.cloudify` directory is created under ~(Home directory). You can change the location using an `_env_` variable (for example, `cfy init` or `cfy profiles use`). The directory contains a file named `config.yaml` that you can customize according to your preferences. @@ -140,6 +140,6 @@ The default sets the `cloudify.cli.main` and `cloudify.rest_client.http` loggers {{% note title="Note" %}} -The `.{{< param product_name >}}` directory might also contain other files and directories, which are used internally by `cfy`, that are not described in this section. +The `.cloudify` directory might also contain other files and directories, which are used internally by `cfy`, that are not described in this section. {{% /note %}}