diff --git a/autocert/INSTALL.md b/autocert/INSTALL.md index 93066a18..61787a81 100644 --- a/autocert/INSTALL.md +++ b/autocert/INSTALL.md @@ -96,7 +96,7 @@ apiVersion: admissionregistration.k8s.io/v1beta1 kind: MutatingWebhookConfiguration metadata: name: autocert-webhook-config - labels: {app: controller} + labels: {app: autocert} webhooks: - name: autocert.step.sm clientConfig: diff --git a/autocert/README.md b/autocert/README.md index 0c553e70..ed247cea 100644 --- a/autocert/README.md +++ b/autocert/README.md @@ -1,8 +1,12 @@ # Autocert -Autocert issues X.509 certificates from your own internal certificate authority and auto-mounts them in kubernetes containers so services can use TLS. +**Autocert** is a kubernetes add-on that automatically injects TLS/HTTPS certificates into your containers. -Autocert is a kubernetes add-on that integrates with `step certificates` to automatically issue X.509 certificates and mount them in your containers. It also automatically renews certificates before they expire. +![Animated terminal showing autocert in practice](demo.gif) + +To request a certificate you simply annotate your pods with a name to include in the injected certificate. Certificates are issued by your own **internal certificate authority** and mounted at `/var/run/autocert.step.sm` along with the corresponding private key and root certificate. + +TLS (e.g., HTTPS) is the most widely deployed cryptographic protocol in the world. Mutual TLS (mTLS) provides end-to-end security for service-to-service communication and can **replace complex VPN** technologies to secure communication into, out of, and between kubernetes clusters. But **to use mTLS you need certificates issued by your own certificate authority (CA)**. Building and operating a CA, issuing certificates, and making sure they're renewed before they expire is tricky. Autocert does all of this for you. ## Key Features @@ -13,39 +17,9 @@ Autocert is a kubernetes add-on that integrates with `step certificates` to auto * Namespaced installation to restrict access to privileged CA and provisioner containers * Ability to run subordinate to an existing public key infrastructure * Supports federatation with other roots - -## Example - -Autocert is incredibly easy to use. To trigger automatic certificate management you simply add an annotation to your pods specifying your service's DNS hostname. Autocert will do the rest: securely issuing a certificate, mounting it in containers, and handling renewals. - -``` -$ cat <