Merge pull request 'doc: added missing steps and updated local cluster setup' (#153) from improve_doc_again into main

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

Author: ashish1099

README.md

@@ -35,40 +35,53 @@ 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
-  ```
+   - 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
-  CLUSTER_NAME=kubeaid-demo
-  ```
-
-3. **Deploy the local Cluster**:
+   - Setup the .env file
+   ```raw
+   # vim .env
+   CLOUD_PROVIDER=local
+   CLUSTER_NAME=kubeaid-demo
+   ```
+
+3. **Generate the config**:
+   - Run the compose to generate the config, it will drop the file in **/outputs/config**
+   ```bash
+   docker compose run bootstrap-generate
+   ```
+
+4. **Fix the config based on your requirements**:
+   - kubeaid-config git repo in general.yaml
+   ```yaml
+   forkURLs:
+     kubeaidConfig: https://github.com/xxxxxxxx/kubeaid-config.git
+   ```
+
+5. **Deploy the local Cluster**:
    - Run the docker compose:
    ```bash
    docker compose run bootstrap-cluster
    ```
 
-4. **Access Your 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
    ```
 
-5. **Access Keycloak, ArgoCD, and Monitoring**:
+7. **Access Keycloak, ArgoCD, and Monitoring**:
    - Follow the instructions in the [KubeAid](https://github.com/Obmondo/kubeaid) to access and configure Keycloak, ArgoCD, and Kube-Prometheus.
    - Example: ArgoCD
    ```bash
    kubectl port-forward svc/argocd-server --namespace argo-cd 8080:443
    ```
 
-6. **Destroy**
+8. **Destroy**
    - When you are done playing
    ```bash
    k3d cluster delete kubeaid-demo

docker-compose.yaml

@@ -14,7 +14,7 @@ services:
       - -c
       - |
         rm -fr outputs/configs
-        kubeaid-bootstrap-script config generate ${CLOUD_PROVIDER} ${FLAVOR}
+        kubeaid-bootstrap-script config generate ${CLOUD_PROVIDER} ${FLAVOR:-''}
     volumes:
       - ./outputs:/outputs
     networks:

docs/hetzner/hcloud.md

@@ -1,6 +1,6 @@
 ## Hetzner cloud
 
-## Generate token and ssh keys
+### Generate token and ssh keys
 - Generate an [HCloud API token](https://docs.hetzner.com/cloud/api/getting-started/generating-api-token)
 
 - Generate an [SSH key pair](https://community.hetzner.com/tutorials/add-ssh-key-to-your-hetzner-cloud)

docs/local.md

@@ -1,46 +1,60 @@
-# Hetzner KubeAid managed cluster
-
-## Installation
-
-* Download the compose file
-```sh
-wget https://raw.githubusercontent.com/Obmondo/kubeaid-bootstrap-script/refs/heads/main/docker-compose.yaml
-```
-
-* Add the cloud provider and flavour
-
-```
-# cat .env
-CLOUD_PROVIDER=hetzner
-FLAVOR=hcloud
-CLUSTER_NAME=kubeaid-demo
-```
-
-* Generate the config, which will be created under `./outputs/configs`
-
-```sh
-docker compose run bootstrap-generate
-```
-
-## Choose your flavor
-
-* [Hcloud](./hetzner/hcloud.md)
-* [Robot](./hetzner/robot.md)
-* [Hybrid](./hetzner/hybrid.md)
-
-## Access your cluster
-
-* Get your KUBECONFIG
-
-```sh
-cat ./outputs/kubeconfigs/main.yaml
-export KUBECONFIG=./outputs/kubeconfigs/main.yaml
-```
-
-## Destroy
-
-* When you want to destroy the cluster
-
-```sh
-k3d cluster delete kubeaid-demo
-```
+## Local KubeAid Cluster
+
+### Generate token and ssh keys
+
+- 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).
+
+### 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
+   # vim .env
+   CLOUD_PROVIDER=local
+   CLUSTER_NAME=kubeaid-demo
+   ```
+
+3. **Generate the config**:
+   - Run the compose to generate the config, it will drop the file in **/outputs/config**
+   ```bash
+   docker compose run bootstrap-generate
+   ```
+
+4. **Fix the config based on your requirements**:
+   - kubeaid-config git repo in general.yaml
+   ```yaml
+   forkURLs:
+     kubeaidConfig: https://github.com/xxxxxxxx/kubeaid-config.git
+   ```
+
+5. **Deploy the local Cluster**:
+   - Run the docker compose:
+   ```bash
+   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
+   ```
+
+7. **Access Keycloak, ArgoCD, and Monitoring**:
+   - Follow the instructions in the [KubeAid](https://github.com/Obmondo/kubeaid) to access and configure Keycloak, ArgoCD, and Kube-Prometheus.
+   - Example: ArgoCD
+   ```bash
+   kubectl port-forward svc/argocd-server --namespace argo-cd 8080:443
+   ```
+
+8. **Destroy**
+   - When you are done playing
+   ```bash
+   k3d cluster delete kubeaid-demo
+   ```