Starting an Orchestration v2

When you start an orchestration, the objects defined in it are created, and when you stop an orchestration, those objects are deleted.

If your orchestration has the desired_state defined as active, it starts immediately when you upload the orchestration. If the desired state specified isn’t active, then you must explicitly start the orchestration. You can also start an orchestration if you had previously suspended or stopped it.

Note:

If you’re about to start an orchestration that creates a large number of storage volumes or instances, consider whether you really need all those resources. If not, redefine your orchestration to create only the resources that you need.

Prerequisites

  • To complete this task, you must have the Compute_Operations role. If this role isn’t assigned to you or you’re not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud Infrastructure Classic Console. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

  • You must have uploaded the orchestration to Compute Classic. See Uploading an Orchestration v2.

Note:

Ensure that each object defined in an orchestration has a unique name, and that objects of the same type with the same name don’t already exist. If any of the objects defined in an orchestration already exists, when the orchestration attempts to start, it reports an error.

Procedure

  1. Sign in to the Compute Classic console.
  2. (Optional) If your domain spans multiple sites, then check that the site you’ve selected has sufficient capacity to create the required resources. Click Site near the top of the page to view the aggregate resource usage by all tenants on the currently selected site. If resource usage on the selected site is close to maximum, pick another site.

    If you’re using the REST API to create resources, note the API end point of the site that you want to use.

  3. Click the Orchestrations tab.
  4. Go to the orchestration that you want to start. From the menu icon menu, select Start.

When you start an orchestration, its status changes to Starting and the objects defined in the orchestration are provisioned. When all the objects have been created, the status of the orchestration changes to Ready.

If the orchestration can’t create an object, its status changes to Transient Error or Terminal Error. An orchestration might transition from the Transient Error to the Ready state when it completes creating all the specified objects.

If the status of your orchestration shows Terminal Error, then you must stop the orchestration, identify and fix the issues in the orchestration JSON file, and then start the orchestration again.

To start an orchestration using the CLI, use the opc compute orchestration-v2 update command. For help with that command, run the command with the -h option. For the instructions to install the CLI client, see Preparing to Use the Compute Classic CLI in CLI Reference for Oracle Cloud Infrastructure Compute Classic.

To start orchestrations v2 using the API, use the PUT /platform/v1/orchestration/orchestrationName method with the query argument desired_state=active. See REST API for Oracle Cloud Infrastructure Compute Classic.

After starting an orchestration, you can view its status on the Orchestrations page. If you no longer require any of the objects created by an orchestration, then to delete all the objects, stop the orchestration. Alternatively, to delete only nonpersistent objects, suspend the orchestration. See Terminating an Orchestration v2 or Suspending an Orchestration v2.