This topic describes how to view the execution details of a Standard Operation and Maintenance Process (SOP) task and perform operation and maintenance operations on an ongoing task.
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 operations such as starting, proceeding to the next step, or retrying 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.
Applicability
This content applies only to OCP Enterprise Edition. OCP Community Edition does not provide this feature.
View execution details
Log in to OCP.
In the left navigation bar, click O&M > Standard workflow.
On the Standard workflow page, locate the target task and click the task name or Execution Details to go to the execution details page.
The execution details page displays the following information:
Basic Information
Displays the basic information about the task, including the task name, task type, execution object, creation time, creator, start time, end time, and current status.
Execution Progress
Displays the overall execution progress of the task, including the number of completed steps and the total number of enabled steps (for example, 7/7), as well as the execution status of each step.
Step List
Displays detailed execution information for all steps:
Parameter |
Description |
|---|---|
| Step No. | Step execution number. |
| Step | The display name of the step. |
| Step Status | Current status of the step:
|
| Automatic Execution | Whether this step is in automatic execution mode. |
| Associated Tasks | The ID of the OCP task instance created during step execution. |
| Retry Count | The number of retries for this step. |
| Error message | The error message from the most recent failed step. |
| Start Time | The time when the step starts. |
| End Time | The time when the step execution ended. |
Perform operation and maintenance operations
Depending on the task status, you can perform the following operations:
Start a task
For a task in the Pending state, click Start to create an execution instance and start the first step.
- When the first step is automatically executed, the return status depends on the immediate processing result.
- When the first step requires manual execution, the return status is Pending Confirmation.
Note
A task can only be started once and cannot be restarted after starting.
Proceed to Next Step
When the task status is Pending Confirmation or Executing, and there are ready steps with autoRun=false, you can click Proceed to Next Step to advance the manual steps.
- If multiple steps can be advanced, you need to select the step number to proceed.
- Explicit confirmation is required when proceeding to the next step; advancement is not allowed without confirmation.
Retry Failed Steps
When a step fails, the following retry options are supported:
Retry All Failed Steps: When the overall execution instance status is FAILED, you can retry all failed steps at once.
Retry Specified Failed Step: Retry a single step that has a status of FAILED. The overall execution instance does not necessarily need to be in a FAILED state, but the specified step must be FAILED.
Update Step Configuration
You can update the configuration of a step that is in the PENDING state in a started task:
- Modify Auto Execution Switch: Only steps marked as editable (editable=true) in the template allow modification.
- Set Step Parameters: You can save step-level parameters before a step is executed. The configurable parameters vary by SOP type/step:
- For the Add OBServer step in Data Reconstruction After OBServer Failure: You can set the replacement host ID (
replacementHostId) and replacement host IP (replacementHostIp). - For the Create Standby Tenant step in Rebuild Standby Tenant: You can set the complete parameters (
createStandbyTenantParamJson) for creating a new standby tenant, including the tenant name, compatibility mode, primary tenant ID, standby cluster ID, primary-standby synchronization method, Zone replica configuration, tenant parameters, etc.
- For the Add OBServer step in Data Reconstruction After OBServer Failure: You can set the replacement host ID (
Edit Task
For a task in the Pending state, click Edit to modify the task's name, target parameters, step configuration, and remarks. The task type cannot be modified; the server always retains the original task type.
Note
Started tasks cannot be edited. An error will be returned if the task already has an execution instance.
Delete Task
- Tasks in the Pending state can be deleted directly.
- Tasks in the Ended or Failed state can be deleted.
- Tasks in the Waiting for Confirmation or In Progress state cannot be deleted.
Deleting a task will cascade clean up the execution instances, step execution records, and step-associated task records.
Step Identifier Description
The step identifiers for different SOP types are as follows. When creating or editing a task, only identifiers of the corresponding type can be used in the step array.
SOP Type |
Step ID (in the default step sequence) |
|---|---|
| Rebuild Standby Tenant | Confirm Operation Object (CONFIRM_STANDBY_TENANT_INFO), Decouple Primary and Standby (DISCONNECT_STANDBY_TENANT), Lock Original and Standby Tenants (LOCK_STANDBY_TENANT), Backup Primary Tenant (BACKUP_PRIMARY_TENANT), Delete Original and Standby Tenants (DELETE_STANDBY_TENANT), Create Standby Tenant (CREATE_STANDBY_TENANT), Verify Primary-standby Synchronization (VERIFY_PRIMARY_STANDBY_SYNC) |
| Abnormal arbitration service enabled for replicas | Confirm Arbitration Target (CONFIRM_ARBITRATION_TARGET), Add Arbitration Service (ADD_ARBITRATION_SERVICE), Delete Tenant Replica (DELETE_TENANT_REPLICA), Delete OBSERVER (DELETE_OBSERVER), Enable Tenant Arbitration Service (ENABLE_TENANT_ARBITRATION), Verify Tenant Arbitration Service Availability (VERIFY_TENANT_ARBITRATION) |
| Data Reconstruction After OBServer Failure | Confirm Operation Target (CONFIRM_OBSERVER_TARGET), Delete Tenant Replica (DELETE_TENANT_REPLICA), Delete OBServer (DELETE_OBSERVER), Force Delete Host (FORCE_DELETE_HOST), Add OBServer (ADD_OBSERVER), Add Tenant Replica (ADD_TENANT_REPLICA), Verify Tenant Replica Rebuild Success (VERIFY_REPLICA_REBUILD) |
