Workflows for Updating Orchestrations v2

You can update an orchestration that is in the Active, Suspended, Stopped, or Error state.

When an orchestration is stopped, all objects created by that orchestration are deleted, so all the attributes of an object can be updated. When you start the orchestration, the objects are created with the updated attributes.

When an orchestration is suspended, nonpersistent objects have the status Inactive and all attributes of those objects can be updated. Those objects are created with the updated attributes when you start the orchestration or when you change the object’s properties from nonpersistent to persistent.

When an orchestration is suspended, persistent objects aren’t deleted. Those objects have the status Active and some attributes of those objects can’t be updated. For example, you can’t update the name of a storage volume while the storage volume is online. Updates to attributes of persistent objects take effect immediately. Attempting to modify attributes that can’t be modified while an object has the status Active might cause the orchestration to go into a terminal error state, indicating that the update failed.

The following table displays the situations in which some or all of an object’s attributes can be modified and the actions required for the updates to be effective.

Orchestration Status Object Persistence Object Status Modifiable Attributes of an Object Updates Effective
Ready Persistent Active Some Immediately.
Ready Nonpersistent Active Some Immediately.
Suspended Persistent Active Some Immediately.
Suspended Nonpersistent Inactive All When orchestration is started or object is updated to be persistent.
Stopped Persistent Inactive All When orchestration is started.
Stopped Nonpersistent Inactive All When orchestration is started.

Workflow for Changing the Persistence of an Object

You can specify persistence for each object in an orchestration. When you suspend an orchestration, nonpersistent objects are deleted, but persistent objects are retained. For most object types, certain attributes of an object can’t be modified while the object exists. This means that, if you want to update those attributes of an object, after suspending the orchestration you must also ensure that the object is nonpersistent and its current status is Inactive.

Similarly, if you’ve suspended an orchestration and added or updated an object in that orchestration, then to start that object without changing the status of the orchestration, you can specify the object to be persistent. The object is created right away while the orchestration remains in the Suspended state.

Caution:

When you specify an object as nonpersistent, if the orchestration is in the Suspended state, the object is deleted immediately.

  1. Select the name of the required orchestration to open the orchestrations details page.

  2. On the orchestrations details page, go to the object for which you want to specify persistence. From the menu icon menu, select Properties.

  3. In the Object Properties dialog box, to set the object as persistent, select the Persistent check box. To set the object as nonpersistent, deselect the Persistent check box. Then click Update.

If the orchestration is in the Suspended state, the change in object persistence is effective immediately. If you updated the object to be nonpersistent, it is deleted and the orchestration details page shows the object’s status as Inactive. If you updated the object to be persistent, it is created and the orchestration details page shows its status as Active.

If the orchestration is in the Stopped state, the change in object persistence is updated in the orchestration and it is effective when the orchestration is started.

Workflow for Adding an Instance

To add an instance to an existing orchestration:

  1. Select the name of the required orchestration to open the orchestrations details page.

  2. On the orchestrations details page, go to the Instance section and click Add. An instance with default configuration is added to the orchestration with the status Inactive.

  3. (Optional) To view or modify the instance configuration, from the menu icon menu, select Update. The instance details page displays the instance configuration. You can modify the configuration as required.

    Alternatively, you can view and modify the instance configuration JSON by selecting Edit JSON.

  4. To create the instance, start the orchestration, or if the orchestration is in the Suspended state, set the instance to be persistent.

Workflow for Adding an Object to an Orchestration

To add an object to an existing orchestration:

  1. Select the name of the required orchestration to open the orchestrations details page.

  2. On the orchestrations details page, go to the object type that you want to add and click Add.

  3. A dialog box is displayed. Enter the required information to create the object. The object is added to the orchestration.

  4. To create the object, start the orchestration, or if the orchestration is in the Suspended state, set the object to be persistent.

Workflow for Updating a Nonpersistent Object

You can specify persistence for each object in an orchestration. All nonpersistent objects are deleted when you either suspend or stop an orchestration. To update a nonpersistent object:

  1. Select the name of the required orchestration to open the orchestrations details page.

  2. On the orchestration details page, go to the object that you want to update and from the menu icon menu, select Update.

    Alternatively, you can view and modify the JSON by selecting Edit JSON.

  3. A dialog box is displayed. Modify the object attributes as required. The orchestration is updated.

  4. To create the object with the updated attributes, start the orchestration, or if the orchestration is in the Suspended state, set the object to be persistent.

Workflow for Updating a Persistent Object

You can specify persistence for each object in an orchestration. While persistent objects are deleted when you stop an orchestration, when you suspend an orchestration, persistent objects aren’t deleted. The orchestration details page shows the status for these object as Active. Although you can update almost all the attributes of an object while it has the status Active, the name of the object can’t be updated.

To update a persistent object:

  1. Select the name of the required orchestration to open the orchestrations details page.

  2. If you want to change the name of the object, then modify the object to be nonpersistent:

    1. On the orchestration details page, go to the object that you want to update and from the menu icon menu, select Properties.

    2. In the Object Properties dialog box, to set the object as nonpersistent, deselect the Persistent check box. Then click Update.

      Caution:

      When you specify an object as nonpersistent, if the orchestration is in the Suspended state, the object is deleted immediately.

  3. On the orchestration details page, go to the object that you want to update and from the menu icon menu, select Update.

    Alternatively, you can view and modify the JSON by selecting Edit JSON.

  4. A dialog box is displayed. Modify the object attributes as required.

  5. To create the object with the updated attributes, start the orchestration, or if the orchestration is in the Suspended state, set the object to be persistent.

Workflow for Resizing an Instance

You can’t resize a running instance. Before you resize an instance, you must ensure that the instance is deleted. You can re-create the instance later, after it has been resized. To resize an instance:

  1. Select the name of the required orchestration to open the orchestrations details page.

  2. If the instance status is displayed as Active, then:

    1. On the orchestration details page, go to the instance that you want to resize and from the menu icon menu, select Properties.

    2. In the Object Properties dialog box, deselect the Persistent check box. Then click Update. The status of the instance changes from Active to Inactive.

  3. On the orchestration details page, go to the instance that you want to update and from the menu icon menu, select Update.

  4. In the Resize an Instance dialog box, select the required shape. Ensure that the shape you select is bigger than the current shape and click Resize. The orchestration is updated with the selected shape.

  5. To create the instance with the updated shape, start the orchestration, or if the orchestration is in the Suspended state, update the instance to be persistent.

Workflow for Updating an Instance

When an instance is running, you can modify some attributes of the instance. For example, you can add storage volumes to the instance and you can add the instance to security lists in the shared network. However, many other instance attributes can be modified only when the instance is deleted. To update an instance:

  1. Select the name of the required orchestration to open the orchestrations details page.

  2. If the orchestration is suspended (not stopped), and if the updates that you want to make require the instance to be deleted, then ensure that the instance is nonpersistent:

    1. On the orchestration details page, go to the instance that you want to update and from the menu icon menu, select Properties.

    2. In the Object Properties dialog box, ensure that the Persistent check box isn’t selected. If it is, then deselect it, and then click Update. The status of the instance changes from Active to Inactive.

  3. On the orchestration details page, go to the instance that you want to update and from the menu icon menu, select Update.

    Alternatively, you can view and modify the instance configuration JSON by selecting Edit JSON.

  4. Make the required changes to the instance configuration. The orchestration is updated with your changes.

  5. To create the instance with the updated attributes, start the orchestration, or if the orchestration is in the Suspended state, set the instance to be persistent.