Update readme with local testing info, clarify kubectl

Signed-off-by: Derek Nola <derek.nola@suse.com>
This commit is contained in:
Derek Nola 2023-11-08 15:19:13 -08:00
parent 20afd4f19e
commit 08df1deff7
No known key found for this signature in database
GPG Key ID: 5E741CE7ED12510E
1 changed files with 14 additions and 3 deletions

View File

@ -22,7 +22,7 @@ on processor architecture:
## System requirements
Deployment environment must have Ansible 2.4.0+
Master and nodes must have passwordless SSH access
Server and agent nodes must have passwordless SSH access
## Usage
@ -48,7 +48,7 @@ k3s_cluster:
If needed, you can also edit `vars` section at the bottom to match your environment.
If multiple hosts are in the server group the playbook will automatically setup k3s in HA mode with embedded etcd.
An odd number of server nodes is recommended (3,5,7). Read the offical documentation below for more information and options.
An odd number of server nodes is required (3,5,7). Read the offical documentation below for more information and options.
https://rancher.com/docs/k3s/latest/en/installation/ha-embedded/
Using a loadbalancer or VIP as the API endpoint is preferred but not covered here.
@ -61,8 +61,19 @@ ansible-playbook playbook/site.yml -i inventory.yml
## Kubeconfig
To confirm access to your **Kubernetes** cluster use the following:
After successful bringup, the kubeconfig of the cluster is copied to the control-node and set as default (`~/.kube/config`).
Assuming you have [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) installed, you to confirm access to your **Kubernetes** cluster use the following:
```bash
kubectl get nodes
```
## Local Testing
A Vagrantfile is provided that provision a 5 nodes cluster using LibVirt or Virtualbox and Vagrant. To use it:
```bash
vagrant up
```
By default, each node is given 2 cores and 2GB of RAM and runs Ubuntu 20.04. You can customize these settings by editing the `Vagrantfile`.