Skip to content

Commit dc25d4a

Browse files
author
James Munnelly
committed
Update README
1 parent c94bdbc commit dc25d4a

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# cert-manager
2+
3+
cert-manager is a Kubernetes addon to automate the management and issuance of
4+
certificates from an aribitrary issuing source.
5+
6+
It is loosely based upon the work of [kube-lego](https://github.com/jetstack/kube-lego)
7+
and has borrowed some wisdome from other similar projects eg.
8+
[kube-cert-manager](https://github.com/PalmStoneGames/kube-cert-manager).
9+
10+
## Current status
11+
12+
This project is still heavily under development and is not ready for use
13+
**yet**. However, if you want to experiment, please do try running the current
14+
development build and reporting any issues you run into.
15+
16+
## Future plans
17+
18+
Soon, I'd like to see cert-manager expose it's own API server, to be used by
19+
the apiserver-aggregator. This will allow us to perform verification of
20+
resources as they are submitted, and consequently reject 'bad' manifests.
21+
22+
## Deploying
23+
24+
To deploy the latest development version, run:
25+
26+
```
27+
$ kubectl create -f docs/cert-manager.yaml
28+
```
29+
30+
There is an example Certificate resource in `docs/acme-cert.yaml`, however
31+
requesting certificates via Ingress is not currently supported - instead, you
32+
must point your domain at the service created for cert-manager manually. This
33+
will naturally change over the coming days and weeks!
34+
35+
```
36+
$ kubectl create -f docs/acme-cert.yaml
37+
```

0 commit comments

Comments
 (0)