Skip to content

Commit

Permalink
Document updated cert manager
Browse files Browse the repository at this point in the history
  • Loading branch information
tamalsaha committed Oct 6, 2017
1 parent a091893 commit 25464f2
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 6 deletions.
18 changes: 17 additions & 1 deletion docs/user-guide/certificate/README.md
@@ -1,4 +1,20 @@
## Certificates
# Certificate

Voyager comes with a built-in certificate manager that can issue free TLS/SSL certificates from Let's Encrypt.


Voyager can automatically provision and refresh SSL certificates issued from Let's Encrypt using a custom Kubernetes Certificate resource.

Features

Provision free TLS certificates from Let's Encrypt,
Manage issued certificates using a Kubernetes Third Party Resource,
Domain validation using ACME dns-01 challenges,
Support for multiple DNS providers,
Auto Renew Certificates,
Use issued Certificates with Ingress to Secure Communications.


Voyager manages certificates objects to create Certificates default from Let's Encrypt.

### Core features of AppsCode Certificates:
Expand Down
11 changes: 11 additions & 0 deletions docs/user-guide/certificate/create.md
Expand Up @@ -30,6 +30,17 @@ data:
ACME_EMAIL: test@appscode.com
```

Create ACME User Secret with key ACME_EMAIL.
```yaml
kind: Secret
metadata:
name: test-user-secret
namespace: default
data:
ACME_EMAIL: test@appscode.com
ACME_SERVER_URL: https://acme-staging.api.letsencrypt.org/directory
```

Create the Certificate resource.
```yaml
apiVersion: voyager.appscode.com/v1beta1
Expand Down
12 changes: 7 additions & 5 deletions docs/user-guide/certificate/provider.md
@@ -1,14 +1,16 @@
# Configuring your challenge provider(s)
# Let's Encrypt Challenge Providers

## http-01
HTTP Provider will requires an running [Ingress](/docs/user-guide/ingress) reference to resolve with.
Reference an Ingress name for http provider. Ingress IP should be setted as domain A record in its provider.
Read how to create certificate using [HTTP Provider](/docs/user-guide/certificate/create.md#create-certificate-with-http-provider)


## DNS Providers
Voyager uses kubernetes secret within the pod to fetch credentials required for various DNS providers.
Making those correctly accessible to Voyager will require specifying the secret name inside an certificate objects.
The Secret will need the Key name exactly provided.

### HTTP (beta)
HTTP Provider will requires an running [Ingress](/docs/user-guide/ingress) reference to resolve with.
Reference an Ingress name for http provider. Ingress IP should be setted as domain A record in its provider.
Read how to create certificate using [HTTP Provider](/docs/user-guide/certificate/create.md#create-certificate-with-http-provider)

### Cloudflare
`CLOUDFLARE_EMAIL`: The email of the cloudflare user <br>
Expand Down

0 comments on commit 25464f2

Please sign in to comment.