Go to file

James Munnelly 7dc50cdea6 Rewrite acme issuer for acme v2		2018-03-23 18:50:44 +00:00
.github	Create ISSUE_TEMPLATE.md	2017-10-23 21:15:01 +01:00
cmd	crtEqual -> certNeedsUpdate	2018-03-12 18:40:56 +00:00
contrib/charts	Merge branch 'master' into patch-1	2018-03-09 22:44:56 -05:00
docs	Merge pull request #376 from jetstack/munnerz-patch-1	2018-03-12 10:28:16 +00:00
hack	hack: correctly check for empty PULL_BASE_SHA	2018-03-15 19:09:21 -07:00
pkg	Rewrite acme issuer for acme v2	2018-03-23 18:50:44 +00:00
test	Update cluster resource namespace during e2e tests	2018-02-23 11:18:58 +00:00
third_party/crypto/acme	Copy across WIP acme v2 golang package	2018-03-23 18:50:44 +00:00
vendor	Update k8s dependencies to v1.10.0-rc.1	2018-03-23 18:30:16 +00:00
.gitignore	Update .gitignore	2018-01-18 22:24:19 +00:00
.gitlab-ci.yml	Fix .gitlab-ci.yml build	2018-03-08 13:29:21 +00:00
.travis.yml	make: split 'verify_pr' out	2018-03-15 19:09:21 -07:00
CODE_OF_CONDUCT.md
Gopkg.lock	Update k8s dependencies to v1.10.0-rc.1	2018-03-23 18:30:16 +00:00
Gopkg.toml	Update k8s dependencies to v1.10.0-rc.1	2018-03-23 18:30:16 +00:00
labels.yaml	Move to github.com/jetstack/cert-manager repo	2017-11-03 16:41:39 +00:00
LICENSE
Makefile	make: split 'verify_pr' out	2018-03-15 19:09:21 -07:00
OWNERS	Update OWNERS	2018-02-08 15:21:36 +00:00
README.md	Add links to new documentation content	2018-01-18 17:44:05 +00:00

README.md

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

This project is not yet ready to be a component in a critical production stack, however it is at a point where it offers comparable features to other projects in the space. If you have a non-critical piece of infrastructure, or are feeling brave, please do try cert-manager and report your experience here in the issue section.

NOTE: currently we provide no guarantees on our API stability. This means there may be breaking changes that will require changes to all Issuer/Certificate resources you have already created. We aim to provide a stable API after a 1.0 release.

Quickstart

Prebuilt images for cert-manager are made available on Dockerhub.

Pre-requisites

Kubernetes cluster with CustomResourceDefinition or ThirdPartyResource support

Deploying cert-manager

The easiest way to deploy cert-manager into your cluster is to use the Helm chart. For information on how to do this see the Deploying cert-manager using Helm user guide.

Creating your first Issuer and Certificate

An Issuer in cert-manager describes a source of X.509 certificates. A Certificate in cert-manager defines a desired X.509 certificate. Below is a list of user guides that can be used to get started with both resources:

Further documentation

For further documentation, please check the /docs directory in this repository.

Troubleshooting

If you encounter any issues whilst using cert-manager, and your issue is not documented, please file an issue.

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 #kube-lego channel on kubernetes.slack.com for chat relating to the project.

Developer documentation should be available soon at docs/devel.

Changelog

The list of releases is the best place to look for information on changes between releases.