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

Installation documentation doesn't reflect/reference the supported Helm installation configuration options #3882

Open
antmatts opened this issue Oct 7, 2024 · 0 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@antmatts
Copy link

antmatts commented Oct 7, 2024

Describe the bug
Installation documentation doesn't reflect, or reference, the supported AWS LBC Helm install configuration options. There is the Controller command line flags section in the Controller configuration options page; but these don't match the supported Helm install options.

This is confusing when trying to use the install guide to support the AL2023 EKS Optimized AMIs that default the Metadata hop limit to 1, causing this addon to get stuck in a CrashLoopBackOff on AL2023 Managed Node Group because it is failing to query the cluster VPC. Instead of using a Managed Node Group with custom LT, I'd rather configure the AWS LBC so it isn't dependent on the EC2 Metadata.

The controller command line flags references aws-region and aws-vpc-id. The actual Helm install options are region and vpcId for example. This doesn't cause the Helm install command to fail, but the expected values aren't set.

Steps to reproduce
Installed the AWS LBC with Helm using the following command based on the AWS Load Balancer Controller site documents:
helm install aws-load-balancer-controller eks/aws-load-balancer-controller -n kube-system --set clusterName=<cluster-name> --set serviceAccount.create=false --set serviceAccount.name=aws-load-balancer-controller --set aws-region=<region> --set aws-vpc-id=<vpcId>

Correct Helm install syntax to set the VPC ID and Region are the following using the Configuration options in the separate Helm chart GitHub project. So the above command should be:
helm install aws-load-balancer-controller eks/aws-load-balancer-controller -n kube-system --set clusterName=<cluster-name> --set serviceAccount.create=false --set serviceAccount.name=aws-load-balancer-controller --set region=<region> --set vpcId=<vpcId>
This works, but is not referenced at all in the installation or configuration documentation.

Expected outcome
AWS LBC Helm install configuration options should accurately reflect the Helm install configuration options. Update Controller command line flags to also reflect the Helm install configuration options.

It's confusing when the installation documentation doesn't reflect the actual Helm install Controller configuration options when Helm is the first recommended option to use to install this addon.

Environment

  • AWS Load Balancer controller version latest
  • Kubernetes version 1.31
  • Using EKS (yes/no), if so version? yes, 1.31

Additional Context:

@shraddhabang shraddhabang added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants