[Doc Source]: Quickstart is missing information for cluster preparation

[cmontemuino]

Are you reporting an issue with existing content?

Section "Label Mayastor Node Candidates" from "Quickstart -> Preparing the cluster" is not complete. The requisite is to label nodes with openebs.io/engine=mayastor, but if you set csi.​node.​topology.​nodeSelector, then label openebs.io/csi-node=mayastor is also required.

• Otherwise, DaemonSet csi-controller and agent-ha-node will not spawn pods.
• Ref: https://mayastor.gitbook.io/introduction/quickstart/preparing-the-cluster#label-mayastor-node-candidates

The situation is a bit more complicated with the agent-ha-node. Only by inspecting the chart I could realize it is using the selectors defined under the csi.node.topology section. This is very confusing.

• Ref: https://github.com/openebs/mayastor-extensions/blob/develop/chart/templates/mayastor/agents/ha/ha-node-daemonset.yaml#L41-L44

Are you proposing new content, or a change to the existing documentation layout or structure?

• Update the aforementioned quikstart section to mention the label openebs.io/csi-node=mayastor
• Update the documentation for csi.​node.​topology.​nodeSelector element in chart values to include the agent-ha-node daemonset too.
  • Current doc: "Add topology segments to the csi-node daemonset node selector"
  • Proposed doc: "Add topology segments to the csi-node and agent-ha-node daemonset node selector"
  • Perhaps better: move the topology segments outside csi

[cmontemuino]

I can open a PR with proposed changes if required.

[tiagolobocastro]

but it is also required to label them with openebs.io/csi-node=mayastor.

hmm it's not necessary, only if you want to control on which nodes to run - by default they will run on any node.

[cmontemuino]

but it is also required to label them with openebs.io/csi-node=mayastor.

hmm it's not necessary, only if you want to control on which nodes to run - by default they will run on any node.

Yes, you're right. I've updated the description with this note:

... but if you set csi.​node.​topology.​nodeSelector, then label openebs.io/csi-node=mayastor is also required

It's kind of OKish if it was only the CSI Controller. Having the agent-ha-node daemonset using the same labels is a bit baffling. I still believe the documentation can be improved; otherwise there's no other action possible for users than looking at the chart implementation (as I had to do).

[tiagolobocastro]

The agent-ha-node should run on the same nodes as the csi-nodes, but I agree it does make it confusing.

I suggest as a first step let's improve the docs; then maybe we can think about how to improve label usage somehow or even potentially joining ha-node in the same pod as the csi, though I'm not quite sure if it's a good idea to do that.

[cmontemuino]

@tiagolobocastro -- I've opened two PRs to address this issue:

• docs(quickstart): add info about node selector mayastor-docs#207
• docs(chart): update topology segments usage mayastor-extensions#439

[tiagolobocastro]

Completed by @cmontemuino