[Feature] Improvements to the additionalVolumes section and documentation

[pptb-aws]

trafficstars

What feature/behavior/change do you want?

I would like an option in the additionalVolumes section that allows for the directory to be named and mounted automatically. Something like this,

apiVersion: eksctl.io/v1alpha5
kind: ClusterConfig

metadata:
  name: dev-cluster
  region: eu-north-1

managedNodeGroups:
  - name: ng-1-workers
    labels: { role: workers }
    instanceType: m5.xlarge
    desiredCapacity: 10
    volumeSize: 80
    additionalVolumes:
      - volumeName: '/tmp/mount-1' # required
        volumeSize: 80
        volumeType: 'gp3'
        volumeEncrypted: true
        volumeKmsKeyID: 'id'
        volumeIOPS: 3000
        volumeThroughput: 125
        directoryPath: /data
      - volumeName: '/tmp/mount-2'  # required
        volumeSize: 80
        volumeType: 'gp2'
        snapshotID: 'snapshot-id'
        directoryPath: /tmp/scratch

If the above is not viable to implement, then I believe a summary of the solution provide here would be beneficial to users reading the additionalVolumes documentation.

I also think more clarification regarding volumeName would be helpful. Perhaps a link to this documentation regarding device naming with the text, "For details about selecting volumeNames, see the device naming documentation."

Why do you want this feature?

When using the additionalVolumes section I was able to successfully add another EBS volume, but it did not start mounted. I also did not initially understand what the volumeName section was until I reviewed the CloudFormation template. The above requests are intended to improve the user experience when using the additionalVolumes option.

[github-actions[bot]]

Hello # :wave: Thank you for opening an issue in eksctl project. The team will review the issue and aim to respond within 1-3 business days. Meanwhile, please read about the Contribution and Code of Conduct guidelines here. You can find out more information about eksctl on our website

[nikimanoledaki]

Hi, we welcome community PRs if that is something you are interested in! :)

Would you like to open a PR to improve the docs around volumeName?

I'm not sure how/where we would set the directoryPath (perhaps in a similar way as the preBoostrapCommands like you said?) so that needs a bit of investigation.

[Himangini]

We will first do a spike to Investigate this feature, what's involved from our side to support this setting We'll document the findings here on this ticket

Timebox: 1-2 days

[Himangini]

At this point, we will not be adding the suggested directoryPath option. I have opened up a PR to update the docs with more information.