README
¶
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.
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
Documentation
Documentation for cert-manager can be found at cert-manager.readthedocs.io. 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 replacement, see the cert-manager nginx ingress quick start guide.
See Getting started 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.
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
There is a Google Group 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.
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.
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 channel on kubernetes.slack.com for chat relating to the project.
Developer documentation is available in the official documentation.
Changelog
The list of releases is the best place to look for information on changes between releases.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
ctl
Module
|
|
|
docs
|
|
|
generated/reference/generate/go_openapi
Package go_openapi describes OpenAPI type defintions for cert-manager APIs
|
Package go_openapi describes OpenAPI type defintions for cert-manager APIs |
|
pkg
|
|
|
apis/certmanager
Package certmanager is the internal version of the API.
|
Package certmanager is the internal version of the API. |
|
apis/certmanager/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apis/certmanager/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
|
Package v1alpha1 is the v1alpha1 version of the API. |
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/certmanager/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/certmanager/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
controller/test
Package test contains testing utilities used for constructing fake Contexts which can be used during tests.
|
Package test contains testing utilities used for constructing fake Contexts which can be used during tests. |
|
issuer/acme/dns/acmedns
Package acmedns implements a DNS provider for solving DNS-01 challenges using Joohoi's acme-dns project.
|
Package acmedns implements a DNS provider for solving DNS-01 challenges using Joohoi's acme-dns project. |
|
issuer/acme/dns/akamai
Package akamai implements a DNS provider for solving the DNS-01 challenge using Akamai FastDNS.
|
Package akamai implements a DNS provider for solving the DNS-01 challenge using Akamai FastDNS. |
|
issuer/acme/dns/azuredns
Package azuredns implements a DNS provider for solving the DNS-01 challenge using Azure DNS.
|
Package azuredns implements a DNS provider for solving the DNS-01 challenge using Azure DNS. |
|
issuer/acme/dns/clouddns
Package clouddns implements a DNS provider for solving the DNS-01 challenge using Google Cloud DNS.
|
Package clouddns implements a DNS provider for solving the DNS-01 challenge using Google Cloud DNS. |
|
issuer/acme/dns/cloudflare
Package cloudflare implements a DNS provider for solving the DNS-01 challenge using cloudflare DNS.
|
Package cloudflare implements a DNS provider for solving the DNS-01 challenge using cloudflare DNS. |
|
issuer/acme/dns/digitalocean
Package digitalocean implements a DNS provider for solving the DNS-01 challenge using digitalocean DNS.
|
Package digitalocean implements a DNS provider for solving the DNS-01 challenge using digitalocean DNS. |
|
issuer/acme/dns/route53
Package route53 implements a DNS provider for solving the DNS-01 challenge using AWS Route 53 DNS.
|
Package route53 implements a DNS provider for solving the DNS-01 challenge using AWS Route 53 DNS. |
|
metrics
Package metrics contains global structures related to metrics collection cert-manager exposes the following metrics: certificate_expiration_timestamp_seconds{name, namespace}
|
Package metrics contains global structures related to metrics collection cert-manager exposes the following metrics: certificate_expiration_timestamp_seconds{name, namespace} |
|
test
|
|
|
e2e/framework/addon/base
Package base implements a basis for plugins that need to use the Kubernetes API to build upon.
|
Package base implements a basis for plugins that need to use the Kubernetes API to build upon. |
|
e2e/framework/addon/nginxingress
package nginx contains an addon that installs nginx-ingress
|
package nginx contains an addon that installs nginx-ingress |
|
e2e/framework/addon/pebble
package Pebble contains an addon that installs Pebble
|
package Pebble contains an addon that installs Pebble |
|
e2e/framework/addon/vault
package vault contains an addon that installs Vault
|
package vault contains an addon that installs Vault |
|
e2e/framework/util/errors
Package errors contains shared error types that tests and addons can depend upon to communicate information about why something has failed
|
Package errors contains shared error types that tests and addons can depend upon to communicate information about why something has failed |
|
e2e/suite/issuers/acme/dnsproviders
Package dnsproviders contains addons that create DNS provider credentials in the target test environment.
|
Package dnsproviders contains addons that create DNS provider credentials in the target test environment. |
|
unit/gen
package gen implements helper functions to construct API resource test fixtures.
|
package gen implements helper functions to construct API resource test fixtures. |
|
third_party
|
|
|
crypto/acme
Package acme provides an implementation of the Automatic Certificate Management Environment (ACME) spec.
|
Package acme provides an implementation of the Automatic Certificate Management Environment (ACME) spec. |