Skip to content

Commit

Permalink
readme updates from PR feedback
Browse files Browse the repository at this point in the history
copelco committed Feb 25, 2020
1 parent 2553203 commit 0a9d9d0
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -19,12 +19,12 @@ Development sponsored by [Caktus Consulting Group, LLC](http://www.caktusgroup.c

# Installation

1. Add to your ``requirements.yml``:
1. Add to your ``requirements.yaml``:


```yaml
---
# file: deployment/requirements.yaml
# file: deploy/requirements.yaml

- src: https://github.com/caktus/ansible-role-k8s-web-cluster
version: init-role # TODO: remove
@@ -35,9 +35,9 @@ Development sponsored by [Caktus Consulting Group, LLC](http://www.caktusgroup.c
```yaml
---
# file: playbooks/configure-cluster.yaml
# file: deploy/deploy.yaml

- hosts: k8s_clusters
- hosts: k8s
roles:
- role: caktus.k8s-web-cluster
```
@@ -54,11 +54,14 @@ Development sponsored by [Caktus Consulting Group, LLC](http://www.caktusgroup.c
k8s_cluster_type: <aws|gcp|azure|digitalocean>
k8s_context: <name of context from ~/.kube/config>
k8s_letsencrypt_email: <email to contact about expiring certs>

k8s_echotest_hostname: <test hostname assigned to your cluster ip, e.g. echotest.caktus-built.com>
```
4. Run ``playbooks/configure-cluster.yaml``
4. Run ``deploy.yaml`` playbook:
```sh
ansible-playbook -l <host/group> deploy.yaml -vv
```


### Testing that Let's Encrypt is working
@@ -71,17 +74,21 @@ k8s_echotest_hostname: <test hostname assigned to your cluster ip, e.g. echotest

```yaml
---
# file: playbooks/echotest.yaml
# file: echotest.yaml

- hosts: k8s_clusters
- hosts: k8s
tasks:
- name: Install echo test server
import_role:
name: caktus.k8s-web-cluster
tasks_from: echotest
```
5. Run ``playbooks/echotest.yaml``
5. Run ``echotest.yaml`` playbook:
```sh
ansible-playbook -l <host/group> echotest.yaml -vv
```

6. Give the certificate a couple minutes to be generated and validated. While waiting,
you can watch the output of:
@@ -107,4 +114,8 @@ k8s_echotest_hostname: <test hostname assigned to your cluster ip, e.g. echotest
If not, you may need to re-create the ingress by deleteing and re-applying
it.

8. When you're done, delete the echotest resources from the cluster. Run ``playbooks/echotest.yaml --extra-vars "k8s_echotest_state=absent"``
8. When you're done, delete the echotest resources from the cluster. Run:

```sh
ansible-playbook -l <host/group> echotest.yaml --extra-vars "k8s_echotest_state=absent" -vv
```

0 comments on commit 0a9d9d0

Please sign in to comment.