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

Parameterized content_cli for Wind River #2522

Open
wants to merge 3 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/cli/_index.md
Original file line number Diff line number Diff line change
@@ -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
+++
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/clusters.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/config.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/init.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/ldap.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 4 additions & 4 deletions content/cli/maint_cli/license.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -28,7 +28,7 @@ Upload a license to a Manager.
$ cfy license upload license.yaml
...

Uploading Cloudify License `license.yaml` to the Manager...
Uploading Cloudify license `license.yaml` to the Manager...
Cloudify license successfully uploaded.

...
Expand All @@ -48,7 +48,7 @@ List the details of the {{< param product_name >}} license.
$ cfy license list
...

Retrieving Cloudify License
Retrieving License
...
Cloudify License

Expand Down Expand Up @@ -76,7 +76,7 @@ $ cfy license remove
...

Removing Cloudify License from the Manager...
Cloudify license successfully removed.
Cloudify License successfully removed.

...
{{< /highlight >}}
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/profiles.md
Original file line number Diff line number Diff line change
@@ -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 the product profiles.
category: Docs
draft: false
abstract: Command-Line Interface
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/snapshots.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/ssh.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/tenants.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/use.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/usergroups.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
2 changes: 1 addition & 1 deletion content/cli/maint_cli/users.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
32 changes: 16 additions & 16 deletions content/cli/orch_cli/_index.md
Original file line number Diff line number Diff line change
@@ -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 [installed {{< param product_name >}}]({{< relref "cloudify_manager/cloudify_cli" >}}), now would be a good time to do so.

# Usage

Expand All @@ -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:
Expand All @@ -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
Expand All @@ -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

Expand Down
8 changes: 4 additions & 4 deletions content/cli/orch_cli/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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]`

Expand Down
10 changes: 5 additions & 5 deletions content/cli/orch_cli/blueprints.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions content/cli/orch_cli/deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion content/cli/orch_cli/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: events
category: Docs
draft: false
abstract: Cloudify's Command-Line Interface
abstract: Command-Line Interface
aliases: /cli/events/
---

Expand Down
4 changes: 2 additions & 2 deletions content/cli/orch_cli/executions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion content/cli/orch_cli/filter-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
---

Expand Down
2 changes: 1 addition & 1 deletion content/cli/orch_cli/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: groups
category: Docs
draft: false
abstract: Cloudify's Command-Line Interface
abstract: Command-Line Interface
aliases: /cli/groups/
---

Expand Down
4 changes: 2 additions & 2 deletions content/cli/orch_cli/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading