Merge pull request 'doc: improved it further' (#151) from improve_doc into main

Reviewed-on: https://gitea.obmondo.com/EnableIT/kubeaid-bootstrap-script/pulls/151

Author: ashish1099

README.md

@@ -35,15 +35,16 @@ NOTE: You can also run the ./scripts/install-runtime-dependencies.sh
 ### Quick Setup
 
 1. **Download the compose file**:
+  - Get the compose file
   ```bash
   wget https://raw.githubusercontent.com/Obmondo/kubeaid-bootstrap-script/refs/heads/main/docker-compose.yaml
   ```
 
 2. **Configure Your Environment**:
+  - Setup the .env file
   ```raw
   # cat .env
   CLOUD_PROVIDER=local
-  #FLAVOR=hcloud
   CLUSTER_NAME=kubeaid-demo
   ```
 
@@ -76,9 +77,16 @@ NOTE: You can also run the ./scripts/install-runtime-dependencies.sh
 ## Cloud Provider Support
 
 - **AWS**: Self-managed and EKS
+  - Documentation: [docs/aws.md](docs/aws.md)
+
 - **Azure**: AKS and self-managed
+  - Documentation: [docs/azure.md](docs/azure.md)
+
 - **Hetzner**: Cloud, Robot, and Hybrid
+  - Documentation: [docs/hetzner.md](docs/hetzner.md)
+
 - **Local**: Minikube or other local setups
+  - Documentation: [docs/local.md](docs/local.md)
 
 ## Contributing
 

docs/hetzner/hcloud.md

@@ -7,30 +7,52 @@
 
 - Generate the [GitHub token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token).
 
-## Bootstrap the cluster
-
-* Add the user and ssh key in the general.yaml.
-
-```yaml
-# Any additional users you want to be setup for each Kubernetes node.
-additionalUsers:
- - name: your-username
-   sshPublicKey: xxxxxxxxxx
-```
-
-* Add the git username and token in the secret.yaml
-
-```yaml
-git:
-  username: xxxxxxxxxx
-  password: xxxxxxxxxx
-```
-
-* Bootstrap the cluster
-
-```sh
-docker compose run bootstrap-cluster
-```
+### Setup
+
+1. **Configure Your Environment**:
+   - Setup the .env file
+   ```raw
+   # cat .env
+   CLOUD_PROVIDER=hetzner
+   FLAVOR=hcloud
+   CLUSTER_NAME=kubeaid-demo
+   ```
+
+2. **Generate the config**:
+   - Run the compose to generate the config, it will drop the file in **/outputs/config**
+   ```bash
+   docker compose run bootstrap-generate
+   ```
+
+3. **Add the user and ssh key**:
+   - Edit general.yaml
+   ```yaml
+   # Any additional users you want to be setup for each Kubernetes node.
+   additionalUsers:
+    - name: your-username
+      sshPublicKey: xxxxxxxxxx
+   ```
+
+4. **Add the git username and token**:
+   - Edit secret.yaml
+   ```yaml
+   git:
+     username: xxxxxxxxxx
+     password: xxxxxxxxxx
+   ```
+
+5. **Bootstrap the cluster**:
+   - Setup the Hetzner cloud k8s cluster
+   ```sh
+   docker compose run bootstrap-cluster
+   ```
+
+6. **Access Your Cluster**:
+   - Once the setup is complete, you can access your Kubernetes cluster using `kubectl`:
+   ```bash
+   export KUBECONFIG=./outputs/kubeconfigs/main.yaml
+   kubectl get nodes
+   ```
 
 ## Reference