Skip to content

Docs: mention ACM in Certificate Discovery #4112

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sdarwin
Copy link

@sdarwin sdarwin commented Mar 28, 2025

Hi,

This is both an Issue and an attempted Pull Request to solve the issue.

On the page "Certificate Discovery" https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/ingress/cert_discovery/ , I was reading and wondered about where the discovered TLS certificates come from. Consider that the main kubernetes documentation about Ingress https://kubernetes.io/docs/concepts/services-networking/ingress/ includes a nearly identical spec:

spec:
  tls:
  - hosts:
      - https-example.foo.com

Where do those TLS certs on the official page come from?
They are k8s Secrets, which are resources in the cluster, similar to ConfigMaps.
If this controller is doing something similar to the official Ingress spec, but "discovering" tls, perhaps that also means from k8s secrets.
"ACM" "AWS Certificate Manager" is referred to 0 times on the "Certificate Discovery" page.
All of this might lead one to think about "secrets" and not "ACM". Which is it? And so, the text update in this pull request.
Let me know, if it should to be edited/modified.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sdarwin
Once this PR has been reviewed and has the lgtm label, please assign zac-nixon for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 28, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @sdarwin. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Mar 28, 2025
@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Mar 28, 2025
@sdarwin
Copy link
Author

sdarwin commented Mar 31, 2025

There is another topic that could be mentioned on this page also.

  1. Often, certificates are associated with multiple domains.
  2. One ingress might have multiple different entries. with multiple domains.

text -

  1. "If an ACM certificate has many domains and/or wildcards, it's sufficient for the discovery process to find one of those domains, and that will count as a match."
  2. show an example?

@zac-nixon
Copy link
Collaborator

I agree with your two points, that would be helpful to mention! We can work on updating those examples, or would you prefer to work off this PR?

@sdarwin
Copy link
Author

sdarwin commented Apr 18, 2025

Hi @zac-nixon ,

If you will work on it, that's great.
For me, it doesn't matter if that's through this PR, or creating another one. This PR has "Allow edits by maintainers". But a new one is fine also.
"I agree with your two points". Yes. There is an issue I often find in documentation: let's say an --options-flag or a config setting can take multiple entries. The docs might say that "You can add multiple domains". The reader is left wondering "Would those be comma-separated, or completely separate flags, or in a formatted json array, or..." Any time something can be multiplied it's worthwhile to actually show examples. I was trying to think of such cases here. "What if a cert has multiple domains". "What if an ingress takes multiple certs". etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants