Starting an Orchestration v1

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

Plan your orchestrations carefully, so that you can control the creation and deletion of objects that consume resource quotas. For example, if you’re about to start an orchestration that creates a large number of storage volumes, 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 My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

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

  • You must have already created all the objects or nested orchestrations that this orchestration depends on.

  • If you created an instance using the Create Instance wizard, the appropriate master, instance, and storage orchestrations would have been created automatically. Next, if you stopped the master orchestration, the instance and storage orchestrations would have stopped. If you want to start those orchestrations again, ensure that all of the objects referenced by those orchestrations exist and are available before starting the master orchestration.

Note:

If any of the objects defined in an orchestration already exist, another object of the same type with the same name won’t be created and the existing object won’t be modified. The orchestration will continue starting, without reporting an error. To ensure that an orchestration creates each object that is defined in it, ensure that each object defined in an orchestration has a unique name, so that objects of the same type with the same name don’t already exist.

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 Error. An orchestration might transition from the Error to the Ready state when it completes creating all the specified objects.

If the status of your orchestration continues to show Error, then stop the orchestration, identify and fix the issue in the orchestration JSON file, and the start the orchestration again.

To start an orchestration using the CLI, use the opc compute orchestration update ––action START 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 an orchestration using the API, use the PUT /orchestration/name method with the query argument action=START. For more information, 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 the objects, stop the orchestration. See Terminating an Orchestration v1.