Skip to content

Commit

Permalink
chore: add single control plane note in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
onedr0p committed Feb 3, 2022
1 parent df6b412 commit 85a26f6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,8 @@ In order to use Terraform and `cert-manager` with the Cloudflare DNS challenge y

:round_pushpin: The `.config.env` file contains necessary configuration that is needed by Ansible, Terraform and Flux.

:round_pushpin: It is suggested to use **three control plane nodes**. If you **only need a single control plane node**, make sure **you update** `./provision/ansible/inventory/group_vars/kubernetes/k3s.yml` and set `k3s_use_unsupported_config` to `true`

1. Copy the `.config.sample.env` to `.config.env` and start filling out all the environment variables. **All are required** and read the comments they will explain further what is required.

2. Once that is done, verify the configuration is correct by running `./configure.sh --verify`
Expand Down Expand Up @@ -198,6 +200,8 @@ In order to use Terraform and `cert-manager` with the Cloudflare DNS challenge y

:round_pushpin: Here we will be running a Ansible Playbook to install [k3s](https://k3s.io/) with [this](https://galaxy.ansible.com/xanmanning/k3s) wonderful k3s Ansible galaxy role. After completion, Ansible will drop a `kubeconfig` in `./provision/kubeconfig` for use with interacting with your cluster with `kubectl`.

:round_pushpin: Once more over, it is suggested to use **three control plane nodes**. If you **only need a single control plane node**, make sure **you update** `./provision/ansible/inventory/group_vars/kubernetes/k3s.yml` and set `k3s_use_unsupported_config` to `true`

1. Verify Ansible can view your config by running `task ansible:list`

2. Verify Ansible can ping your nodes by running `task ansible:adhoc:ping`
Expand Down

0 comments on commit 85a26f6

Please sign in to comment.