Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Added a cmd for topology labels in Mayastor Configuration document #489

Merged
merged 2 commits into from
Oct 7, 2024
Merged

docs: Added a cmd for topology labels in Mayastor Configuration document #489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b832e8
docs: Added a cmd for topology labels in Mayastor Configuration document
balaharish7 Sep 24, 2024
f3abb43
docs: Added a cmd for topology labels in Mayastor Configuration document
balaharish7 Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion ...guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@ spec:
EOF
```

The diskpool is created with labels to satisfy `poolHasTopologyKey` and `poolAffinityTopologyLabel` parameters of the storage class. This helps place the replicas of volume based on the pool labels.
Inorder to place the volume replicas based on the pool labels i.e. to satisfy `poolHasTopologyKey` and `poolAffinityTopologyLabel` parameters of the storage class, the pools must be labelled with the topology field.
This can be achieved in two ways:

1. Create a new pool with the labels.

**Example DiskPool Definition with Labels**
```
Expand All @@ -87,6 +90,12 @@ spec:
EOF
```

2. The existing pools can be labelled using the plugin. This will not affect any of the pre-existing volumes.

```
kubectl mayastor label pool pool-on-node-1 topology-key=topology-value -n openebs
```

**YAML**
```text
apiVersion: "openebs.io/v1beta2"
Expand Down Expand Up @@ -244,6 +253,7 @@ parameters:
zone: us-west-1
provisioner: io.openebs.csi-mayastor
volumeBindingMode: Immediate
EOF
```

Apply the labels to the nodes using the below command:
Expand Down Expand Up @@ -283,6 +293,7 @@ parameters:
rack
provisioner: io.openebs.csi-mayastor
volumeBindingMode: Immediate
EOF
```

Apply the labels on the node using the below command:
Expand Down Expand Up @@ -325,6 +336,7 @@ parameters:
zone
provisioner: io.openebs.csi-mayastor
volumeBindingMode: Immediate
EOF
```

Apply the labels to the nodes using the below command:
Expand Down Expand Up @@ -369,6 +381,7 @@ parameters:
zone: us-west-1
provisioner: io.openebs.csi-mayastor
volumeBindingMode: Immediate
EOF
```

Apply the labels to the pools using the below command:
Expand Down Expand Up @@ -411,6 +424,7 @@ spec:
topology:
labelled:
zone: us-west-1
EOF
```

**Command (Get filtered pools based on labels)**
Expand Down Expand Up @@ -448,6 +462,7 @@ parameters:
zone
provisioner: io.openebs.csi-mayastor
volumeBindingMode: Immediate
EOF
```

**Command (Get filtered pools based on labels)**
Expand Down
17 changes: 16 additions & 1 deletion ...guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@ spec:
EOF
```

The diskpool is created with labels to satisfy `poolHasTopologyKey` and `poolAffinityTopologyLabel` parameters of the storage class. This helps place the replicas of volume based on the pool labels.
Inorder to place the volume replicas based on the pool labels i.e. to satisfy `poolHasTopologyKey` and `poolAffinityTopologyLabel` parameters of the storage class, the pools must be labelled with the topology field.
This can be achieved in two ways:

1. Create a new pool with the labels.

**Example DiskPool Definition with Labels**
```
Expand All @@ -87,6 +90,12 @@ spec:
EOF
```

2. The existing pools can be labelled using the plugin. This will not affect any of the pre-existing volumes.

```
kubectl mayastor label pool pool-on-node-1 topology-key=topology-value -n openebs
```

**YAML**
```text
apiVersion: "openebs.io/v1beta2"
Expand Down Expand Up @@ -244,6 +253,7 @@ parameters:
zone: us-west-1
provisioner: io.openebs.csi-mayastor
volumeBindingMode: Immediate
EOF
```

Apply the labels to the nodes using the below command:
Expand Down Expand Up @@ -283,6 +293,7 @@ parameters:
rack
provisioner: io.openebs.csi-mayastor
volumeBindingMode: Immediate
EOF
```

Apply the labels on the node using the below command:
Expand Down Expand Up @@ -325,6 +336,7 @@ parameters:
zone
provisioner: io.openebs.csi-mayastor
volumeBindingMode: Immediate
EOF
```

Apply the labels to the nodes using the below command:
Expand Down Expand Up @@ -369,6 +381,7 @@ parameters:
zone: us-west-1
provisioner: io.openebs.csi-mayastor
volumeBindingMode: Immediate
EOF
```

Apply the labels to the pools using the below command:
Expand Down Expand Up @@ -411,6 +424,7 @@ spec:
topology:
labelled:
zone: us-west-1
EOF
```

**Command (Get filtered pools based on labels)**
Expand Down Expand Up @@ -448,6 +462,7 @@ parameters:
zone
provisioner: io.openebs.csi-mayastor
volumeBindingMode: Immediate
EOF
```

**Command (Get filtered pools based on labels)**
Expand Down
Loading