Maël ValaisandJake Sanders
30f9c123d3
Note that the gateway-shim is only half the work for supporting the Gateway API in cert-manager. The other half is the HTTP01 solver support, which is still worked on. The Gateway API in cert-manager is releases as an experimental feature and needs to be enabled manually with the following flag: --controllers=*,gateway-shim All the annotations supported by ingress-shim are also supported by gateway-shim, with some exceptions: "acme.cert-manager.io/http01-ingress-class" This annotation is not supported on the Gateway resource. Although the Gateway resource also has a "gatewayClass" field, we will need to add another field instead of "ingress-class" to avoid confusion with the ingress-shim. "acme.cert-manager.io/http01-edit-in-place" This annotation is not supported because it is specific to some ingress controllers like ingress-gce. "kubernetes.io/tls-acme" This annotation is not supported because it is a behavior inherited from kube-lego and we chose not to keep this behavior with the Gateway API. Unlike the ingress-shim, you can reuse the same Secret name in multiple TLS configurations on the same Gateway resource. The ingress-shim now shows the exact location of the duplicate secretName when the user gives the same secretName in two separate TLS blocks. Signed-off-by: Maël Valais <mael@vls.dev> Co-authored-by: Jake Sanders <i@am.so-aweso.me>
cert-manager
cert-manager is a Kubernetes add-on to automate the management and issuance of TLS certificates from various issuing sources.
It will ensure certificates are valid and up to date periodically, and attempt to renew certificates at an appropriate time before expiry.
It is loosely based upon the work of kube-lego and has borrowed some wisdom from other similar projects e.g. kube-cert-manager.
Documentation
Documentation for cert-manager can be found at cert-manager.io. Please make sure to select the correct version of the documentation to view on the top right of the page.
Issues and PRs towards the documentation should be filed in the website repo.
For the common use-case of automatically issuing TLS certificates to Ingress resources, aka a kube-lego replacement, see the cert-manager nginx ingress quick start guide.
See Installation within the documentation for installation instructions.
Troubleshooting
If you encounter any issues whilst using cert-manager, we have a number of places you can use to try and get help.
First of all we recommend looking at the troubleshooting guide of our documentation.
The quickest way to ask a question is to first post on our Slack channel (#cert-manager) on the Kubernetes Slack. There are a lot of community members in this channel, and you can often get an answer to your question straight away!
You can also try searching for an existing issue. Properly searching for an existing issue will help reduce the number of duplicates, and help you find the answer you are looking for quicker.
Please also make sure to read through the relevant pages in the documentation before opening an issue. You can also search the documentation using the search box on the top left of the page.
If you believe you have encountered a bug, and cannot find an existing issue similar to your own, you may open a new issue. Please be sure to include as much information as possible about your environment.
Community
The cert-manager-dev Google Group is used for project wide announcements and development coordination.
Anybody can join the group by visiting here
and clicking "Join Group". A Google account is required to join the group.
Bi-weekly Development Meeting
Once you've joined the cert-manager-dev Google Group, you should receive an invite to the bi-weekly development
meeting, hosted every other Wednesday at 5pm London time on Google Meet.
Anyone is welcome to join these calls, even if just to ask questions. Meeting notes are recorded in Google docs.
Daily Standups
You are also welcome to join our daily standup every weekday at 10.30am London time on Google Meet. For more information, see cert-manager.io.
Contributing
We welcome pull requests with open arms! There's a lot of work to do here, and we're especially concerned with ensuring the longevity and reliability of the project.
Please take a look at our issue tracker if you are unsure where to start with getting involved!
We also use the #cert-manager and #cert-manager-dev channels on Kubernetes Slack for chat relating to the project.
Developer documentation is available on the cert-manager.io website.
Coding Conventions
Code style guidelines are documented on the coding conventions page of the cert-manager website. Please try to follow those guidelines if you're submitting a pull request for cert-manager.
Importing cert-manager as a Module
⚠️ Please note that cert-manager does not currently provide a Go module compatibility guarantee. That means that
most code under pkg/ is subject to change in a breaking way, even between minor or patch releases and even if
the code is currently publicly exported.
This lack of a Go module compatibility guarantee does not affect API version guarantees under the Kubernetes Deprecation Policy.
Security Reporting
Security is the number one priority for cert-manager. If you think you've found a security vulnerability, we'd love to hear from you.
Please follow the instructions in SECURITY.md to report a vulnerability to the team.
Changelog
The list of releases is the best place to look for information on changes between releases.
Logo design by Zoe Paterson