Orchestration Commands

agents

The cfy agents command is used to manage Cloudify agents on existing deployments. See agents for more information. Commands Common agents arguments -d, --deployment-id TEXT - The unique identifier for the deployment --node-id TEXT - The node id to filter to be used for filtering --node-instance-id TEXT - The node instance id to be used for filtering --install-method TEXT - Only show agents installed with this install_method -a, --all-tenants - Include resources from all tenants associated with the user.

blueprints

The cfy blueprints command is used to manage blueprints on a Cloudify Manager instance. You can use the command to upload, delete, download, validate and list blueprints and to retrieve information for a specific blueprint. Use of spaces is not supported in file names. Optional flags These commands support the common CLI flags. Commands upload Usage cfy blueprints upload [options] BLUEPRINT_PATH Upload a blueprint to a Cloudify Manager.

deployments

The cfy deployments command is used to manage running deployments on a Cloudify manager. You can use the command to create, delete, update and list deployments and to show the outputs for a specific deployment. Use of spaces is not supported in file names. For more information, see deployment update process. Optional flags These commands support the common CLI flags. Commands create Usage cfy deployments create [OPTIONS] [DEPLOYMENT_ID]

events

The cfy events command is used to view events of a specific execution. Optional flags These commands support the common CLI flags. Commands list Usage cfy events list [OPTIONS] EXECUTION_ID Display events for an execution. EXECUTION_ID is the unique identifier for the execution. Optional flags --include-logs / --no-logs - Include logs in returned events. [default: True] --json - Output events in a consumable JSON format. --tail - Tail the events of the specified execution until it ends.

executions

The cfy executions command is used to manage workflow executions on Cloudify Manager. You can use the command to start, cancel and and list executions and to retrieve information about a single execution. You can also schedule executions to start in a specific date and time in the future (using the --schedule flag). Optional flags These commands support the common CLI flags. Commands start Usage cfy executions start [OPTIONS] WORKFLOW_ID

groups

The cfy groups command is used to view information on the different groups in a deployment. You can use the command to list all groups. Optional flags These commands support the common CLI flags. Commands list Usage cfy groups list [OPTIONS] Lists all groups for a deployment. DEPLOYMENT_ID is the ID of the deployment for which to list groups. Required flags -d, --deployment-id TEXT - The ID of the deployment for which to list groups.

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. Usage cfy install [OPTIONS] [BLUEPRINT_PATH] Install an application via the manager BLUEPRINT_PATH can be either a local blueprint yaml file or blueprint archive; a url to a blueprint archive or an organization/blueprint_repo[:tag/branch] (to be retrieved from GitHub)

logs

The cfy logs command is used to manage log files on Cloudify Manager. You can use the command to download, backup and purge Cloudify Manager 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. Optional flags These commands support the common CLI flags. Commands backup Usage cfy logs backup [OPTIONS]

maintenance-mode

The cfy maintenance-mode command is used to restrict REST access to the manager. This is required, for instance, when you upgrade a manager. Putting the manager in maintenance-mode prevents it from running any executions. See maintenance-mode for more information. Optional flags These commands support the common CLI flags. Commands activate Usage cfy maintenance-mode activate [OPTIONS] Enter maintenance-mode on Cloudify Manager, rejecting further REST requests. Optional flags --wait - Wait until there are no running executions and automatically activate maintenance-mode.

node-instances

The cfy node-instances command is used to view information about the different node-instances of a deployment. You can use the command to list the node-instances of a specific deployment or of all deployments, and to retrieve information about a single node-instance. Optional flags These commands support the common CLI flags. Commands list Usage cfy node-instances list [OPTIONS] List node-instances. If DEPLOYMENT_ID is provided, lists node-instances for that deployment. Otherwise, lists node-instances for all deployments.

nodes

The cfy nodes command is used to view information on the different nodes of a deployment. You can use the command to list all nodes and get information on a single node. Optional flags These commands support the common CLI flags. Commands list Usage cfy nodes list [OPTIONS] Lists all nodes for a deployment. If DEPLOYMENT_ID is provided, lists nodes for that deployment. Otherwise, list nodes for all deployments.

plugins

The cfy plugins command is used to manage plugins stored on a Cloudify manager. 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. Each plugin has a plugin.yaml file that map node lifecycle operations to appropriate plugin functions. See plugins for more information. Optional flags These commands support the common CLI flags.

secrets

The cfy secrets command is used to manage Cloudify secrets (key-value pairs). Optional flags These commands support the common CLI flags. Commands create Usage cfy secrets create [OPTIONS] KEY Create a new secret (key-value pair) KEY is the new secret’s key Required flags One of these flags: -s, --secret-string TEXT - The string to use as the secret’s value. -f, --secret-file TEXT - The file with the contents of the secret.

status

The cfy status command is used to display the status of a running Cloudify Manager. To use the command you must cfy profiles use -t MANAGEMENT_IP first. Usage cfy status Show a list of the services running on the manager, whether it is in maintenance-mode, and its REST protocol. In cluster mode, PostgreSQL and RabbitMQ don’t run on the manager, so it verifies their connection. Optional flags This command supports the common CLI flags.

tokens

The cfy tokens command is used to receive a REST token from the Cloudify Manager. Commands get Usage cfy tokens get [OPTIONS] Returns a valid REST token from the Cloudify Manager. Optional flags This command supports the common CLI flags.

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. Usage cfy uninstall [OPTIONS] DEPLOYMENT_ID Uninstall an application via Cloudify Manager. This command executes the uninstall workflow, deletes the deployment and the blueprint (if there is only one deployment for that blueprint). DEPLOYMENT_ID is the ID of the deployment to uninstall.

workflows

The cfy workflows command is used to view information about the different workflows of a deployment. You can use the command to list the workflows of a specific deployment and to retrieve information about a single workflow. Optional flags These commands support the common CLI flags. Commands list Usage cfy workflows list [OPTIONS] Lists all workflows on the Cloudify Manager for a specific deployment. DEPLOYMENT_ID The ID of the deployment for which you want to list the workflows.

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 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.

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.

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.

If you haven’t already installed Cloudify, now would be a good time to do so.

Usage

You can access the CLI by running the cfy command in your terminal. Use cfy -h to display a list of all the commands and their descriptions.

$ cfy -h
Usage: cfy [OPTIONS] COMMAND [ARGS]...

  Cloudify'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
  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
  variable `CFY_WORKDIR` to the appropriate directory (e.g. /tmp/).

Options:
  -v, --verbose  Show verbose output. You can supply this up to three times
                 (i.e. -vvv)
  --version      Display the version and exit (if a manager is used, its
                 version will also show)
  -h, --help     Show this message and exit.

Commands:
  agents            Handle a deployment's agents
  blueprints        Handle blueprints on the manager
  cluster           Handle the Cloudify Manager cluster
  deployments       Handle deployments on the Manager
  dev               Run fabric tasks [manager only]
  events            Show events from workflow executions
  executions        Handle workflow executions
  groups            Handle deployment groups
  init              Initialize a working env
  install           Install an application blueprint [manager only]
  ldap              Set LDAP authenticator
  logs              Handle manager service logs
  maintenance-mode  Handle the manager's maintenance-mode
  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)
  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]
  uninstall         Uninstall an application blueprint [manager only]
  user-groups       Handle Cloudify user groups [Premium feature]
  users             Handle Cloudify users
  workflows         Handle deployment workflows


...

Note that some features. such as viewing metric graphs and application topologies, are only available via the Cloudify Management Console if you are running Cloudify Manager.

Inputs and Parameters

For commands that accept inputs or parameters (for example, cfy executions start or cfy deployments create) the value must represent a dictionary. Valid formats are:

A path to the YAML file
A path to a directory containing one or more YAML files
A wildcard-based path to one or more YAML files
A string in JSON format
A string formatted as “key1=value1;key2=value2”

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).

The directory contains a file named config.yaml that you can customize according to your preferences.

Configurable Parameters

You can configure the parameters described in this section.

Colored Output

Enables colored output of different cfy commands:

colors: true

The default value is false.

Logging

Specifies the path of the log file that cfy writes to:

logging:
  filename: /some/custom/path/to/a.log

The default value is $TMPDIR/cloudify-$USERNAME/cloudify.log.

Configure specific python logger levels:

logging:
  loggers:
    cloudify.rest_client.http: debug
    some.external.package: debug

The default sets the cloudify.cli.main and cloudify.rest_client.http loggers’ logging level to info.

The .cloudify directory might also contain other files and directories, which are used internally by cfy, that are not described in this section.