Create a standard operation and maintenance process

This topic describes how to create a Standard Operation and Maintenance Process (SOP) task in OCP.

Prerequisites

• The current OCP user has any of the Cluster Management, Tenant Management, or Host Management resource permissions (for operating the target resource).
• The Update permission on the cluster/tenant/host (for creating, starting, or executing steps).
• SOP permissions are automatically determined by the system based on the logged-in user's identity. For details, see Overview of Standard Operation and Maintenance Processes.

Background information

When you need to perform standardized fault recovery operations on an OceanBase cluster, tenant, or host, you can create a new SOP task to accomplish it. OCP provides preset process templates. You only need to select the task type and configure the target parameters and steps to create a standard operation and maintenance process task.

Procedure

1. Log in to OCP.

2. In the left navigation bar, click O&M > Standard workflow.

3. On the Standard workflow page, click Create. The system pops up the Create standard O&M workflow dialog box.

4. Configure the following information in the Create standard O&M workflow dialog box.

   1. Configure basic information.

      Parameter	Description
      Task Name	Enter the task name. It must meet the following rules: Supports 2 to 32 characters. Must start with a Chinese, Japanese character, or English letter. Must end with a Chinese, Japanese character, English letter, or number. Only underscores are supported as special characters. The task name must be globally unique.
      Task Type	Select the SOP task type. Options include Rebuild standby tenant, Enable arbitration service after a replica failure, or Data Rebuilding after OBServer Exception. For detailed descriptions, see Overview of Standard Operation and Maintenance Processes.
      Remarks (Optional)	Enter task remarks to record the purpose or description of the task.
      Execute Now	If selected, the task will start immediately after creation. If not selected, the task status will be Pending Execution after creation, and you can manually start it later.

   2. Configure target parameters based on the selected task type.

      • Rebuild standby tenant: Select the cluster and standby tenant to rebuild, and choose the primary/standby synchronization method (network-based or archive-based).

      • Enable arbitration service after a replica failure: Select the target cluster, and choose the arbitration service or arbitration service group (choose one).

      • Data Rebuilding after OBServer Exception: Select the target cluster. You can preselect an alternative host. If no alternative host is selected, you can set it before performing the Add OBServer step.

   3. Configure the steps.

      The system automatically loads the default step template based on the selected task type. You can view and adjust the configuration for each step:

      Parameter	Description
      Step Number	The execution order of the step, starting from 1. Steps that can be moved are adjustable within the template.
      Step Name	The display name of the current step.
      Step Type	EXECUTABLE: An executable step that may create an OCP task instance; CONFIRMATION: A confirmation step that does not create a task instance.
      Automatic Execution	When enabled, this step is automatically triggered after the previous step completes. When disabled, this step requires manual confirmation before proceeding. The automatic execution switch for some steps cannot be modified.
      Enable	Whether to enable this step. Some steps are fixed to be enabled and cannot be disabled.

      Note

      • The stepKey of a step must belong to the template and be unique.
      • Steps that are fixed to be enabled must be retained and cannot be disabled.
      • Whether the automatic execution switch for a step can be modified depends on the editable attribute of that step in the template.

5. Click Create.

   • If Execute Now is selected, the task starts automatically after creation, and the page jumps to the execution details page.
   • If Execute Now is not selected, the status of the task after successful creation is Pending. You can view it in the task list and start its execution at any time.

What to do next

• For tasks in the Pending Execution state, you can start their execution, edit task configurations, or delete the tasks.
• For tasks that are in progress, you can view execution details, proceed to the next step, retry failed steps, or update step configurations. For more information, see View execution details of a standard O&M process.