readme updates

This commit is contained in:
Christian Lempa 2023-09-12 11:06:06 +02:00
parent c42461184a
commit 6ab41e340b

View File

@ -5,18 +5,19 @@
- Execution Instructions - Execution Instructions
## Introduction ## Introduction
> The objective of this playbook is to automate the installation and setup of a kubernetes instance. The playbook consist of 3 main plays. For both controller and nodes, for controller only and for nodes only. It will ask user confirmation before moving on to each stage. By the end of the playbook two files will be created on the controller node named **worker_conn_string** and locally inside the playbook directory with the name **Remote_Files/worker_conn_string**. This will have the **connection string**. (Note:- If you want to join controllers or nodes manually later. For controllers use **--control-plane** flag) > The objective of this playbook is to automate the installation and setup of a kubernetes instance. The playbook consist of 3 main plays. For both controller and nodes, for controller only and for nodes only. It will ask user confirmation before moving on to each stage. By the end of the playbook two files will be created on the controller node named **worker_conn_string** and locally inside the playbook directory with the name **Remote_Files/worker_conn_string**. This will have the **connection string**. (Note:- If you want to join controllers or nodes manually later. For controllers use **--control-plane** flag)
### References ### References
---
**Documentation** - https://kubernetes.io/docs/setup/ **Documentation** - https://kubernetes.io/docs/setup/
## Prerequisites ## Prerequisites
1. Atleast 2 VMs (1 For Control Node and 1 For Worker Node). - Atleast 2 VMs (1 For Control Node and 1 For Worker Node).
1. Static IPs should be set along with unique host names. - Static IPs should be set along with unique host names.
1. Inventory should be in this format <br> - Inventory should be in this format
```ini ```ini
[controllers] [controllers]
host_name ansible_ssh_host=<IP> ansible_user='<USERNAME>' ansible_become_pass='<PASSWORD>' host_name ansible_ssh_host=<IP> ansible_user='<USERNAME>' ansible_become_pass='<PASSWORD>'
@ -27,6 +28,7 @@
controllers controllers
nodes nodes
``` ```
(If you want to change this, don't forget to change the `inst-k8s` as well) (If you want to change this, don't forget to change the `inst-k8s` as well)
## Execution Instructions ## Execution Instructions
@ -34,7 +36,9 @@
```bash ```bash
ansible-playbook -i <INVENTORY> <PLAYBOOK> ansible-playbook -i <INVENTORY> <PLAYBOOK>
``` ```
### Optional Flags ### Optional Flags
| Flag | Use Case | | Flag | Use Case |
|-------|-----------| |-------|-----------|
| --ask-vault-pass | If the vault is encrypted | | --ask-vault-pass | If the vault is encrypted |