Missing information on `CLUSTER_ID` in EKS Documentation for outposts/eks-outposts-self-managed-nodes.adoc

Open
  • Is something wrong?
#833 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
aws
Domain
cloud, documentation

Research direction

Open outposts/eks-outposts-self-managed-nodes.adoc and start at the “Launch self-managed Linux nodes using AWS Management Console” section, step 5 under BootstrapArguments. Confirm where CLUSTER_ID and the other required values come from, then add instructions or a documentation link so users can complete the bootstrap configuration.

Written by the indexing model from the issue text.

Description

Issue:

The documentation Create Amazon Linux nodes on AWS Outposts contains steps to create self-managed Linux nodes for an EKS cluster on AWS Outposts using AWS Management Console. However, there seems to be missing information regarding the CLUSTER_ID parameter required in the BootstrapArguments section.

Steps to Reproduce:

  1. Navigate to the section Launch self-managed Linux nodes using AWS Management Console.
  2. Scroll to step 5 under BootstrapArguments.
Image
  1. The snippet provided for BootstrapArguments is as follows:
--b64-cluster-ca ${CLUSTER_CA} --apiserver-endpoint https://${APISERVER_ENDPOINT} --enable-local-outpost true --cluster-id ${CLUSTER_ID}
  1. Notice that the document does not provide guidance on where to retrieve the value of ${CLUSTER_ID}.

Problem:

The snippet mentions the --cluster-id parameter but does not explain how or where to obtain the value for ${CLUSTER_ID}. This information is critical for users attempting to configure self-managed nodes correctly. Without this detail, the documentation is incomplete and may lead to user confusion or misconfiguration.

Suggested Fix:

  1. Include specific instructions or a link to another section of the documentation that explains how to retrieve the CLUSTER_ID and other required values of bootstrap arguments.

Additional Context:

This improvement will help streamline the user experience and reduce potential errors during the setup of self-managed Linux nodes on AWS Outposts.

Dominant language
Shell
Stars
454
Forks
788
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from awsdocs/amazon-eks-user-guide

All issues in awsdocs/amazon-eks-user-guide

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.