docs: Added a cmd for topology labels in Mayastor Configuration document #489
Conversation
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
Signed-off-by: Bala Harish <[email protected]>
sinhaashish
approved these changes
Sep 24, 2024
avishnu
reviewed
Sep 24, 2024
| @@ -69,6 +69,11 @@ 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. | |||
| You can use the plugin to add labels to pools that do not have topology labels: | |||
There was a problem hiding this comment.
The content seems fine, but the intent is missing. Why / when does a user need to do this?
There was a problem hiding this comment.
Inorder to place the replicas of a volume 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.
- The existing pools can be labelled using the plugin : (Note : There will not be any effect on all the pre-existing volumes)
kubectl mayastor label pool pool-on-node-1 topology-key=topology-value -n openebs
- Create a new pool with the labels
Example DiskPool Definition with Labels
cat <<EOF | kubectl create -f -
apiVersion: "openebs.io/v1beta2"
kind: DiskPool
metadata:
name: pool-on-node-1
namespace: openebs
spec:
node: workernode-1-hostname
disks: ["/dev/disk/by-id/<id>"]
topology:
labelled:
topology-key: topology-value
EOF
There was a problem hiding this comment.
@avishnu Does this seems ok ?
There was a problem hiding this comment.
Seems ok, change the order of (1) and (2).
There was a problem hiding this comment.
The suggested changes are done :)
Signed-off-by: Bala Harish <[email protected]>
sinhaashish
approved these changes
Sep 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.