93 lines
4.1 KiB
Markdown
93 lines
4.1 KiB
Markdown
# 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](https://github.com/jetstack/kube-lego)
|
|
and has borrowed some wisdom from other similar projects e.g.
|
|
[kube-cert-manager](https://github.com/PalmStoneGames/kube-cert-manager).
|
|
|
|
|
|
|
|
## Current status
|
|
|
|
As this project is pre-1.0, we do not currently offer strong guarantees around our
|
|
API stability.
|
|
|
|
Notably, we may choose to make breaking changes to our API specification (i.e. the
|
|
Issuer, ClusterIssuer and Certificate resources) in new minor releases.
|
|
|
|
These will always be clearly documented in the [upgrade section of the documentation](https://cert-manager.readthedocs.io/en/latest/admin/upgrading/index.html)
|
|
|
|
## Documentation
|
|
|
|
Documentation for cert-manager can be found at [cert-manager.readthedocs.io](https://cert-manager.readthedocs.io/en/latest/).
|
|
Please make sure to select the correct version of the documentation to view on
|
|
the bottom left of the page.
|
|
|
|
For the common use-case of automatically issuing TLS certificates to
|
|
Ingress resources, aka a [kube-lego](https://github.com/jetstack/kube-lego)
|
|
replacement, see the [cert-manager nginx ingress quick start
|
|
guide](docs/tutorials/quick-start/index.rst).
|
|
|
|
See [Getting started](https://cert-manager.readthedocs.io/en/latest/getting-started/)
|
|
within the [documentation](https://cert-manager.readthedocs.io/en/latest/)
|
|
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.
|
|
|
|
The quickest way to ask a question is to first post on our Slack channel (#cert-manager)
|
|
on the [Kubernetes Slack](http://slack.kubernetes.io/).
|
|
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](https://github.com/jetstack/cert-manager/issues).
|
|
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](https://cert-manager.readthedocs.io/en/latest/)
|
|
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](https://github.com/jetstack/cert-manager/issues).
|
|
Please be sure to include as much information as possible about your environment.
|
|
|
|
## Community
|
|
|
|
There is a Google Group used for project wide announcements and development coordination.
|
|
Anybody can join the group by visiting [here](https://groups.google.com/forum/#!forum/cert-manager-dev)
|
|
and clicking "Join Group". A Google account is required to join the group.
|
|
|
|
Once you have become a member, you should receive an invite to the weekly development
|
|
meeting, hosted on **Wednesdays at 4pm UTC** on Zoom.us.
|
|
|
|
Anyone is welcome to join these calls, even if just to ask questions.
|
|
|
|
Meeting notes are recorded in [Google docs](https://docs.google.com/document/d/1Tc5t6ylY9dhXAan1OjOoldeaoys1Yh4Ir710ATfBa5U).
|
|
|
|
## 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](https://github.com/jetstack/cert-manager/issues)
|
|
if you are unsure where to start with getting involved!
|
|
|
|
We also use the #cert-manager channel on kubernetes.slack.com for chat relating to
|
|
the project.
|
|
|
|
Developer documentation is available in the [official documentation](http://cert-manager.readthedocs.io/en/latest/devel/index.html).
|
|
|
|
## Changelog
|
|
|
|
The [list of releases](https://github.com/jetstack/cert-manager/releases)
|
|
is the best place to look for information on changes between releases.
|