-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add docs for volumegroupreplicationclass
added docs for volumegroupreplicationclass Signed-off-by: Nikhil-Ladha <[email protected]>
- Loading branch information
1 parent
8781201
commit 33d4a6a
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# VolumeGroupReplicationClass | ||
|
||
VolumeGroupReplicationClass is a cluster scoped resource that contains driver related configuration parameters for volume group replication. | ||
|
||
`provisioner` is name of the storage provisioner. | ||
|
||
`parameters` contains key-value pairs that are passed down to the driver. Users can add their own key-value pairs. Keys with `replication.storage.openshift.io/` prefix are reserved by operator and not passed down to the driver. | ||
|
||
## Reserved parameter keys | ||
|
||
- `replication.storage.openshift.io/group-replication-secret-name` | ||
- `replication.storage.openshift.io/group-replication-secret-namespace` | ||
|
||
```yaml | ||
apiVersion: replication.storage.openshift.io/v1alpha1 | ||
kind: VolumeGroupReplicationClass | ||
metadata: | ||
name: volumegroupreplicationclass-sample | ||
spec: | ||
provisioner: example.provisioner.io | ||
parameters: | ||
replication.storage.openshift.io/group-replication-secret-name: secret-name | ||
replication.storage.openshift.io/group-replication-secret-namespace: secret-namespace | ||
``` |