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.

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

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

Open
ad1mohan opened this issue Jan 15, 2025 · 1 comment
Assignees

Comments

@ad1mohan
Copy link

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.

@pgasca
Copy link
Contributor

pgasca commented Jan 31, 2025

Chris, this should be addressed by the author's PR:
#834

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants