Skip to content

Commit 609cf39

Browse files
committed
docs: add docs for volumegroupreplication CR
add docs for volumegroupreplication and volumegroupreplicationclass CRs. Signed-off-by: Nikhil-Ladha <nikhilladha1999@gmail.com>
1 parent 92af4df commit 609cf39

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/volumegroupreplicationclass.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# VolumeGroupReplicationClass
2+
3+
VolumeGroupReplicationClass is a cluster scoped resource that contains driver related configuration parameters for volume group replication.
4+
5+
`provisioner` is name of the storage provisioner.
6+
7+
`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.
8+
9+
## Reserved parameter keys
10+
11+
- `replication.storage.openshift.io/group-replication-secret-name`
12+
- `replication.storage.openshift.io/group-replication-secret-namespace`
13+
14+
```yaml
15+
apiVersion: replication.storage.openshift.io/v1alpha1
16+
kind: VolumeGroupReplicationClass
17+
metadata:
18+
name: volumegroupreplicationclass-sample
19+
spec:
20+
provisioner: example.provisioner.io
21+
parameters:
22+
replication.storage.openshift.io/group-replication-secret-name: secret-name
23+
replication.storage.openshift.io/group-replication-secret-namespace: secret-namespace
24+
```

0 commit comments

Comments
 (0)