Processing a Runbook

Run an active runbook on active fleets to perform relevant lifecycle operations in Fleet Application Management.

Important

If the required Fleet Application Management plugin for lifecycle operations is disabled outside of Fleet Application Management, the operation fails. For example, if either the Fleet Application Management plugin or the OS Management Hub plugin is not enabled on a resource managed by Fleet Application Management, an error occurs.

On the Runbooks list page, select the runbook to work with. If you need help finding the Runbooks list page or a specific runbook, see Listing Runbooks

On the runbook details page, select Process.

Processing a runbook consists of the following pages:
Run each of the following workflows in order. You can return to a previous page by selecting Previous.
1. Add runbooks
On the Add runbooks page, add the required fleets for the runbook.
For Name, edit the value if needed. By default, Fleet Application Management sets a hyphenated, alphanumeric name that includes the lifecycle operation, date, and time.
For Create in compartment, select the compartment where you want to create the runbook process.
Select a runbook version, if applicable.
For Runbook processing duration, turn on the toggle to include the runbook's estimated time and specify the duration.

Note

When specifying the duration, consider the number of participating resources and the method (parallel or rolling). These factors help you calculate an appropriate schedule duration.

Select Add fleets.
In the Add fleets panel, select the checkbox next to the fleets to include in the runbook. Only active fleets are displayed.
Select Add fleets.
To add fleets from another compartment, select that compartment in the Add fleets panel and repeat these steps.
After you add fleets, they appear in the Add fleets table.
Tagging

If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.

Select Next to proceed to the next step.
2. Runbook parameters
On the Runbook parameters page, enter one or more arguments for the runbook task, if any are defined.

Depending on the runbook, the parameters may vary:
- Patching or discovery runbook:
  
  Argument name: Select the argument name associated with the task.
  
  Argument value: Change the default value by entering a value.
  
  Apply same value wherever applicable in a runbook: To use the same value across runbook tasks, turn on this switch. If you don't turn on the switch, specify the argument name and value for each runbook task.
- Provisioning runbook:
  
  Based on the runbook and its tasks (for example, provisioning a database or Compute resource), Fleet Application Management displays relevant configuration fields. You can tailor configurations to the specific resource being provisioned.
  
  Note
  
  You can view and modify configurations associated with a Terraform package or configuration file (such as, JSON, YAML, or .tf files) during provisioning.
  
  Configurations are presented as dynamic forms, populated based on the contents of the underlying file (for example, key-value pairs).
  
  The form fields are generated from the schema.yaml file in the Terraform package. If a default value is defined in the schema, the field is pre-populated. Otherwise, the field appears blank for you to complete. For more information about schema.yaml file, see Meta Schema for Validation.
  
  To configure the runbook tasks, select one of these options:
  
  Select existing: Select an existing configuration catalog item. The runbook uses the selected configuration without changes. You can't modify the configuration in this step and no form is displayed.
  
  Create new: Select Change to create a catalog item by entering configuration values directly in the Create configuration catalog item panel. The panel displays a dynamic form rendered from the content of the schema.yaml file in the Terraform catalog item file attached to the runbook task. This new configuration can then be saved in Object Storage for future use. See Creating a Private Catalog Item. Fleet Application Management creates a catalog item and associates it with the provisioning task.
  Note
  
  Configuration fields adapt based on the resource type (such as, database, Compute, notifications, or events). For example, provisioning a notification service might prompt fields for email addresses, while a database provisioning runbook displays settings such as "Create Alarm Enabled" or "Create Event."
  Select Configure and select to confirm the configuration changes, create and select the configuration for the runbook.
Select Next to continue.
3. Review
On the Review page:

To change settings, select Edit basic information.

To modify runbooks, select Edit runbooks. For field descriptions, see Creating a Runbook.

To change input or output variables, select Edit parameters. For field descriptions, see Creating a Task.

To update tags, select Edit tags.
When you have reviewed and verified all settings, select Create.

The runbook process starts. You can track its progress on the Runbook processes tab. See Listing Runbook Processes.
This task can't be performed using the CLI.

For a complete list of flags and variable options for Fleet Application Management CLI commands, see the CLI for Fleet Application Management.
This task can't be performed using the API.

Oracle Cloud Infrastructure Documentation

Processing a Runbook

1. Add runbooks

Tagging

2. Runbook parameters

3. Review