Adding recent AGENTS file and recent README

2026-02-07 08:58:47 +01:00
parent ffa0140d0b
commit cb36f4606c
3 changed files with 84 additions and 23 deletions
@@ -0,0 +1,49 @@
+# AGENTS.md
+
+> [!NOTE]
+> This directory handles the **bootstrapping and provisioning** of the Haumdaucher Kubernetes cluster using **Kubespray**.
+
+## Project Overview
+*   **Tool**: [Kubespray](https://github.com/kubernetes-sigs/kubespray) (Ansible-based).
+*   **Method**: The local `inventory/` is the source of truth, which is synced into a checked-out Kubespray repository.
+*   **Idempotency**: The process is designed to be repeatable. The `kubespray` folder is treated as ephemeral and is re-created by `init.sh`.
+
+## Workflow & Scripts
+The core workflow is encapsulated in `init.sh`.
+
+### `init.sh`
+**Purpose**: Prepares the environment and Kubespray for deployment.
+**Actions**:
+1.  **Clean Slate**: Deletes existing `kubespray/` directory.
+2.  **Clone**: Clones Kubespray (version defined in variable `VERSION`, e.g., `release-2.27`).
+3.  **Environment**: Sets up Python virtualenv via `pyenv` and installs `requirements.txt`.
+4.  **Sync**: Copies local `./inventory/` configurations into `./kubespray/inventory/`.
+
+### Usage
+1.  **Source the script**:
+    ```bash
+    source init.sh
+    ```
+2.  **Deploy / Upgrade**:
+    After sourcing, go to the `kubespray` directory and run the Ansible playbooks as instructed by the script output.
+    *   **Standard Run**:
+        ```bash
+        cd kubespray
+        ansible-playbook -i inventory/prod/inventory.ini cluster.yml
+        ```
+    *   **Forced Upgrade**:
+        ```bash
+        cd kubespray
+        ansible-playbook -i inventory/prod/inventory.ini -e upgrade_cluster_setup=true cluster.yml
+        ```
+
+## Directory Structure
+*   `init.sh`: The entry point script. **Source of truth for Kubespray version.**
+*   `inventory/`: Contains cluster inventory configurations (hosts, variables). **Edit this, not the one in `kubespray/`**.
+*   `kubespray/`: (Ignored/Ephemeral) The checked-out Kubespray repository. **Do not edit files here directly**; they will be overwritten.
+
+## Configuration Updates
+To upgrade Kubespray or change cluster config:
+1.  **Version Upgrade**: Update `VERSION` in `init.sh` (e.g., to `release-2.28`).
+2.  **Config Changes**: Modify files in `./inventory/`.
+3.  **Apply**: Run `source init.sh` then execute the Ansible playbook.
@@ -1,17 +0,0 @@
-# Purpose
-
-This project configures a Kubernetes cluster utilizing Kubespray with a Vagrant-based development environment.
-
-# Current task
-
-Currently Kubespray `release-2.26`is used. I want you to:
-* Read the changelog of Kubespray 2.27 here: https://github.com/kubernetes-sigs/kubespray/releases
-* Analyze changes for this new version 2.27.
-* MOdify the inventory files in "./inventory" to fit those changes.
-* MOdify "init.sh" script and write "release-2.27" as the new version to be used.
-
-# Folder structure
-
-* `./init.sh` - Bootstrap script to set up the environment. The variable `release` defines the Kubespray version to be used.
-* `./inventory/` - Directory containing inventory configurations for the Kubernetes cluster. It also contains variables on the Kubeernetes version.
-* `./kubespray/` a checked out clone of the Kubespray repository with a specific version. We do not edit files in this sub folder. The "inventory folder from current sub folder will be synced into this "kubespray" folder.