|
3 | 3 |
|
4 | 4 | get-cluster-status:
|
5 | 5 | description: Get cluster status information
|
| 6 | + params: |
| 7 | + cluster-set: |
| 8 | + type: boolean |
| 9 | + default: False |
| 10 | + description: Whether to fetch the cluster or cluster-set status. |
| 11 | + Possible values are False (default) or True. |
6 | 12 |
|
7 | 13 | get-password:
|
8 | 14 | description: Fetch the system user's password, which is used by charm.
|
@@ -53,3 +59,53 @@ restore:
|
53 | 59 | pre-upgrade-check:
|
54 | 60 | description: Run necessary pre-upgrade checks and preparations before executing a charm refresh.
|
55 | 61 |
|
| 62 | +promote-standby-cluster: |
| 63 | + description: | |
| 64 | + Promotes this cluster to become the leader in the cluster-set. Used for safe switchover or failover. |
| 65 | + Must be run against the charm leader unit of a standby cluster. |
| 66 | + params: |
| 67 | + cluster-set-name: |
| 68 | + type: string |
| 69 | + description: | |
| 70 | + The name of the cluster-set. Mandatory option, used for confirmation. |
| 71 | + force: |
| 72 | + type: boolean |
| 73 | + default: False |
| 74 | + description: | |
| 75 | + Use force when previous primary is unreachable (failover). Will invalidate previous |
| 76 | + primary. |
| 77 | +
|
| 78 | +recreate-cluster: |
| 79 | + description: | |
| 80 | + Recreates cluster on one or more standalone units that were previously part of a standby cluster. |
| 81 | +
|
| 82 | + When a standby cluster is removed from an async replication relation, the cluster will be dissolved and |
| 83 | + each unit will be kept in blocked status. Recreating the cluster allows to rejoin the async replication |
| 84 | + relation, or usage as a standalone cluster. |
| 85 | +
|
| 86 | +fence-writes: |
| 87 | + description: | |
| 88 | + Stops write traffic to a primary cluster of a ClusterSet. |
| 89 | + params: |
| 90 | + cluster-set-name: |
| 91 | + type: string |
| 92 | + description: | |
| 93 | + The name of the cluster-set. Mandatory option, used for confirmation. |
| 94 | +
|
| 95 | +unfence-writes: |
| 96 | + description: | |
| 97 | + Resumes write traffic to a primary cluster of a ClusterSet. |
| 98 | + params: |
| 99 | + cluster-set-name: |
| 100 | + type: string |
| 101 | + description: | |
| 102 | + The name of the cluster-set. Mandatory option, used for confirmation. |
| 103 | +
|
| 104 | +rejoin-cluster: |
| 105 | + description: | |
| 106 | + Rejoins an invalidated cluster to the cluster-set, after a previous failover or switchover. |
| 107 | + params: |
| 108 | + cluster-name: |
| 109 | + type: string |
| 110 | + description: | |
| 111 | + The name of the cluster to be rejoined. |
0 commit comments