Oracle Cloud Infrastructure Documentation

Creating an Apply Rollback Job

Create an apply rollback job in Resource Manager.

When you create (run) an apply rollback job for a stack, Terraform provisions the resources and executes the action defined in the target job's Terraform configuration, applying the execution plan to the associated stack. This job rolls back your Oracle Cloud Infrastructure resources to a previous state.

We recommend creating (running) a plan rollback job (generating an execution plan) before running an apply rollback job, using the following flow.

  1. Identify the successful apply job that you want to roll back to.

    The job you want to roll back to is also known as the "target job."

  2. Create a plan rollback job for the target job.

  3. Confirm that the plan rollback job succeeded.

  4. Confirm that the generated execution plan meets expectations.

  5. Create an apply rollback job using the generated execution plan (executionPlanRollbackStrategy).

    Instructions are on this page.

    1. On the Stacks list page, select the stack that you want to work with. If you need help finding the list page or the stack, see Listing Stacks.
    2. In the Jobs list, find the job that you want to use for creating an apply rollback job.
      You can choose a plan rollback job (recommended) or an apply job.
    3. From the Actions menu (Actions Menu) for the job, select Rollback.
      The Rollback panel opens, showing the OCID and name of the selected job. Execution plan rollback strategy is automatically selected based on the selected job you're using for the apply rollback job: Use execution plan from plan rollback job for a plan rollback job and Automatically approve for an apply job. For more information about Automatically approve, see Auto-Approve Option for Terraform Apply Command
    4. For Rollback job type, select Apply to create an apply rollback job.
    5. (Optional) Edit the default name for the rollback job. Avoid entering confidential information.
    6. To generate detailed log content for debugging, select Show advanced options and select the log level that you want from Detailed log level.
      For more information, see Debugging Terraform.
    7. To adjust the maximum number of concurrent operations as Terraform walks the graph, select Show advanced options and edit the value for Maximum number of parallel operations. (Default: 10.) Use this option to speed up the job.
      Note

      A high value might cause throttling of resources. For example, consider a Terraform configuration that defines hundreds of compute instances. An Apply job attempts to create as many instances as possible at the same time. In this example, a value of 100 might cause throttling by the Compute service.
    8. To fetch the latest state before running the job, select Show advanced options and select Refresh resource states before checking for differences.

      Use this option to refresh the state first. For example, consider using this option with an Apply job that you intend to run on manually updated (existing) infrastructure.

      Note

      Refreshing the state can affect performance. If the configuration includes several resources, consider not using this option.
    9. (Optional) Add tags:
      1. To show tagging options, select Show advanced options.
      2. To add a defined tag, select the namespace and key, then enter a value.
      3. To add a free-form tag, enter a key and value.
    10. Select Ok.

    The apply rollback job is created. The new job is listed under Jobs.

  • Use the oci resource-manager job create-apply-rollback-job command and required parameters to run an apply rollback job.

    oci resource-manager job create-apply-rollback-job --stack-id <stack_OCID> --execution-plan-rollback-strategy <source_of_execution_plan>

    For a complete list of parameters and values for CLI commands, see the Command Line Reference for Resource Manager.

  • Use the CreateJob operation to create an apply rollback job.

    For examples of details for an apply rollback job, see ApplyRollbackJobOperationDetails.

What's Next

Depending on the number and type of resources specified, a given apply rollback job can take some time.

After running an apply rollback job, get the job's details to check its status. You can optionally view the Terraform state file, view the logs, and confirm existence of provisioned resources.

Monitor the job status (lifecycle state) by getting the job's details. Succeeded (SUCCEEDED) indicates that the job has completed. Depending on the complexity of the job, the operation can take some time. While the job runs, or after it finishes, you can get the job logs content.

To view the Terraform state file (shows the state of your resources after running the job), select the name of the job to display the Job details page, then select View state under Resources. Optionally select Show changes in this version.

To view the logs for the job, select the job to open its details page, then select Logs under Resources.

To confirm existence of newly provisioned resources, inspect resources in the compartment.