search

kubernetes-sigs / aws-load-balancer-controller

A Kubernetes controller for Elastic Load Balancers
https://kubernetes-sigs.github.io/aws-load-balancer-controller/
Apache License 2.0
3.83k stars 1.42k forks source link

bug(docs) or feat(clarify VPC tagging requirements - small LoE big impact) #3076

Closed neoakris closed 6 months ago

neoakris commented 1 year ago

Is your feature request related to a problem?
Install Pre Reqs Docs are too vague about VPC tagging requirement.
If the docs were improved the following related issue (https://github.com/kubernetes-sigs/aws-load-balancer-controller/issues/2812 ) might not exist.

What it looks like today:
https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.4/deploy/installation/#deployment-considerations

Deployment Considerations Additional Requirements for non-EKS clusters: Ensure subnets are tagged appropriately for auto-discovery to work For IP targets, pods must have IPs from the VPC subnets. You can configure amazon-vpc-cni-k8s plugin for this purpose.

Describe the solution you'd like "Deployment Considerations" info should be moved to "Network Configuration" (it's definitely a network config issue, and because it's in the wrong spot it's easy to miss)

Also elaborate on it as the following vague statement isn't remotely useful: "Ensure subnets are tagged appropriately for auto-discovery to work.".

At bare minimum reference this https://aws.amazon.com/premiumsupport/knowledge-center/eks-load-balancer-controller-subnets/ consider pointing out an example snippet of how VPC should be tagged: https://github.com/terraform-aws-modules/terraform-aws-eks/blob/d7016cf39d25245eb0c2992971d711fbe8ddf71e/examples/complete/main.tf#L418-L424 

public_subnet_tags = {
  "kubernetes.io/cluster/${local.cluster_name}" = "shared"
  "kubernetes.io/role/elb"                      = "1"
}
private_subnet_tags = {
  "kubernetes.io/cluster/${local.cluster_name}" = "shared"
  "kubernetes.io/role/internal-elb"             = "1"
}

Describe alternatives you've considered Not sure if this is a bug or a feature request

kishorj commented 1 year ago

@neoakris, thanks for the feedback. For the subnet tagging, we can add link to the subnet auto discovery live docs (https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.4/deploy/subnet_discovery/). If you have any changes in mind, feel free to raise a PR.

/kind documentation

neoakris commented 1 year ago

@kishorj @M00nF1sh @johngmyers https://engineering.doit.com/demystifying-the-kubernetes-aws-lb-controller-5e06ad0f276d I wrote a blog post about this project that I wanted to put on your radar. I'm also trying to work with my employer's AWS partnership rep to have their docs team get eyes on it to see if they can help in terms of AWS's public docs.

Also about PR: I need to study for 4 exam recertifications that are lapsing, but I'll set a slack reminder to check the docs at the end of the year. If no one was able to get to it within a few months, I'll try to make a 1-2 doc related PRs when some spare time free's up later in the year.

k8s-triage-robot commented 1 year ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot commented 1 year ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot commented 6 months ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

k8s-ci-robot commented 6 months ago

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to [this](https://github.com/kubernetes-sigs/aws-load-balancer-controller/issues/3076#issuecomment-1900855538): >The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. > >This bot triages issues according to the following rules: >- After 90d of inactivity, `lifecycle/stale` is applied >- After 30d of inactivity since `lifecycle/stale` was applied, `lifecycle/rotten` is applied >- After 30d of inactivity since `lifecycle/rotten` was applied, the issue is closed > >You can: >- Reopen this issue with `/reopen` >- Mark this issue as fresh with `/remove-lifecycle rotten` >- Offer to help out with [Issue Triage][1] > >Please send feedback to sig-contributor-experience at [kubernetes/community](https://github.com/kubernetes/community). > >/close not-planned > >[1]: https://www.kubernetes.dev/docs/guide/issue-triage/ Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.