Edit On Github

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.

Commands

create

Usage: cfy deployments create [options] -d DEPLOYMENT_ID -b BLUEPRINT_ID

Start a workflow execution for a specific deployment

Required flags

• -d, --deployment-id=DEPLOYMENT_ID - A unique ID for the deployment
• -b, --blueprint-id=BLUEPRINT_ID - The blueprint’s ID for which to create the deployment

Optional flags

• -i, --inputs=INPUTS - Inputs for the deployment (Can be provided as wildcard based paths (*.yaml, etc..) to YAML files, a JSON string or as “key1=value1;key2=value2”). This argument can be used multiple times.

 

Example

  
$ cfy deployments create -d simple_website -b simple
...

Creating new deployment from blueprint simple...
Deployment created. The deployment's id is simple_website

...
  

update

Usage: cfy deployments update [options] -d DEPLOYMENT_ID

Retrieve information on a single execution.

Required flags

• -d, --deployment-id=DEPLOYMENT_ID - The id of the deployment to update

Optional flags

• -n, --blueprint-filename=BLUEPRINT_FILENAME - The name of the archive’s main blueprint file. (default: blueprint.yaml)
• -p, --blueprint-path=BLUEPRINT_PATH - The path to the application’s blueprint file. (default: blueprint.yaml)
• -l, --archive-location=ARCHIVE_LOCATION - The path or URL to the application’s blueprint archive
• --json - Output events in a consumable JSON format
• --skip-install - Skip install lifecycle operations
• --include-logs - Include logs in returned events
• -w, --workflow=WORKFLOW - A workflow to execute instead of update
• -f, --force - Force running update in case a previous update on this deployment has failed to finished successfully
• -i, --inputs=INPUTS - Inputs file/string for the deployment creation (Can be provided as wildcard based paths (*.yaml, etc..) to YAML files, a JSON string or as “key1=value1;key2=value2”). This argument can be used multiple times. (default: inputs.yaml)
• --skip-uninstall - Skip uninstall lifecycle operations

 

Example

  
$ cfy deployments update -d nodecellar -p nodecellar-blueprint/aws-ec2-blueprint.yaml
...

Updating deployment nodecellar using blueprint nodecellar-blueprint/aws-ec2-blueprint.yaml
2016-06-27T11:40:08 CFY <nodecellar> Starting 'update' workflow execution
2016-06-27T11:40:09 CFY <nodecellar> 'update' workflow execution succeeded
Finished executing workflow 'update' on deployment 'nodecellar'
Successfully updated deployment nodecellar. Deployment update id: nodecellar-6521e3ef-829f-4874-9ecf-ef388cc09212. Execution id: 26a9f8a8-f09f-468f-a46a-f64de4a31070

...
  

delete

Usage: cfy deployments delete [options] -d DEPLOYMENT_ID

Delete an existing deployment. It’s important to note that deleting a deployment does not mean deleting the resources of an application - for which you need to run the uninstall workflow (unless a custom uninstall workflow is provided).

Required flags

• -d, --deployment-id=DEPLOYMENT_ID - The ID of the deployment to delete

Optional flags

• -f, --ignore-live-nodes - Delete the deployment even if there are existing live resources for that deployment

 

Example

  
$ cfy deployments delete -d simple_website
...

Deleting deployment simple_website...
Deployment deleted

...
  

list

Usage: cfy deployments list -b BLUEPRINT_ID

List all existing deployments for a blueprint.

Required flags

• -b, --blueprint-id BLUEPRINT_ID - The ID of the blueprint you would like to list deployments for

 

Example

  
$ cfy deployments list -b simple
...

Listing deployments for blueprint simple...

Deployments:
+-------------------+--------------+----------------------------+----------------------------+
|         id        | blueprint_id |         created_at         |         updated_at         |
+-------------------+--------------+----------------------------+----------------------------+
|   simple_website  |    simple    | 2016-06-27 10:42:58.682240 | 2016-06-27 10:42:58.682240 |
|  simple_website_2 |    simple    | 2016-06-27 11:50:34.130098 | 2016-06-27 11:50:34.130098 |
+-------------------+--------------+----------------------------+----------------------------+

...
  

outputs

Usage: cfy deployments outputs [options] -d DEPLOYMENT_ID

Lists all outputs for a deployment. Note that not every deployment has outputs and it depends on whether or not outputs were defined in the blueprint from which the deployment was created

Required flags

• -d, --deployment-id=DEPLOYMENT_ID - The ID of the deployment you would like to list outputs for

 

Example

  
$ cfy deployments outputs -d simple_website
...

Retrieving outputs for deployment simple_website...
 - "http_endpoint":
     Description: Web server external endpoint
     Value: http://localhost:8000

...