Deployment Modfications API

class cloudify_rest_client.deployment_modifications.DeploymentModificationNodeInstances(node_instances)[source]

Bases: dict

List of added nodes and nodes that are related to them

List of removed nodes and nodes that are related to them

before_modification

List of node instances with their state as it existed before the deployment modification started

before_rollback

If deployment modification was rolledback, this will be a list of node instances with their state as it existed before the deployment modification was rolledback

class cloudify_rest_client.deployment_modifications.DeploymentModification(modification)[source]

Bases: dict

STARTED = 'started'
FINISHED = 'finished'
ROLLEDBACK = 'rolledback'
id

Deployment modification id

status

Deployment modification status

deployment_id

Deployment Id the outputs belong to.

node_instances

Dict containing added_and_related and remove_and_related node instances list

modified_nodes

Dict containing original modified nodes that started this modification

created_at

Deployment modification creation date

ended_at

Deployment modification end date

context

Dict containing context that has been attached to modification.

This context has no predefined schema. Its structure can be whatever has been attached to the modification when it was started.

class cloudify_rest_client.deployment_modifications.DeploymentModificationsClient(api)[source]

Bases: object

list(deployment_id=None, _include=None, **kwargs)[source]

List deployment modifications

Parameters:
  • deployment_id – The deployment id (optional)
  • kwargs – Optional filter fields. for a list of available fields see the REST service’s models.DeploymentModification.fields
start(deployment_id, nodes, context=None)[source]

Start deployment modification.

Parameters:
  • deployment_id – The deployment id
  • nodes – the nodes to modify
Returns:

DeploymentModification dict
Return type:

DeploymentModification
get(modification_id, _include=None)[source]

Get deployment modification

Parameters:modification_id – The modification id
finish(modification_id)[source]

Finish deployment modification

Parameters:modification_id – The modification id
rollback(modification_id)[source]

Rollback deployment modification

Parameters:modification_id – The modification id