Merge pull request #2 from tekpeek/1-update-readme

docs: Add detailed sections for prerequisites, configuration, install…

Author: AvinashSubhash

README.md

@@ -26,6 +26,110 @@ It integrates smoothly with Kubernetes clusters and can be deployed as a contain
 
 ---
 
+## Prerequisites
+
+Before deploying, ensure you have the following tools installed:
+- `kubectl`
+- `jq`
+- `sed`
+- An Ingress Controller (e.g., Nginx, Traefik) is recommended for external access.
+
+---
+
+## Configuration
+
+The deployment script and application require specific environment variables to be set.
+
+| Variable | Description | Required |
+|----------|-------------|----------|
+| `OBJECT_STORE_REQ` | The target URL for uploading snapshots via HTTP PUT (e.g., `https://objectstorage.us-region.oraclecloud.com/p/...`). | **Yes** |
+| `SF_API_KEY` | A secure key used to authenticate API requests. | **Yes** |
+| `NAMESPACE` | The Kubernetes namespace to deploy into. Defaults to `kubesnap`. | No |
+
+---
+
+## Installation
+
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/tekpeek/kubesnap.git
+   cd kubesnap
+   ```
+
+2. **Set Environment Variables**
+   Export the required variables before running the deployment script.
+   ```bash
+   export OBJECT_STORE_REQ="<YOUR_OBJECT_STORAGE_PUT_URL>"
+   export SF_API_KEY="<YOUR_SECURE_API_KEY>"
+   # Optional: Custom namespace
+   export NAMESPACE="kubesnap"
+   ```
+
+3. **Deploy**
+   Give execute permissions and run the deployment script.
+   ```bash
+   chmod +x deploy_project.sh
+   ./deploy_project.sh
+   ```
+
+---
+
+## API Reference
+
+Once deployed, you can interact with **kubesnap** using its REST API.
+
+### Authentication
+All requests to the snapshot endpoint require the `X-API-Key` header.
+```bash
+-H "X-API-Key: <YOUR_SF_API_KEY>"
+```
+
+### Endpoints
+
+#### 1. Health Check
+Check if the service is running.
+- **URL:** `/api/kubesnap/health`
+- **Method:** `GET`
+- **Response:**
+  ```json
+  {
+    "status": "OK",
+    "timestamp": "2023-10-27 10:00:00+00:00"
+  }
+  ```
+
+#### 2. Create Snapshot
+Trigger a snapshot for a specific namespace.
+- **URL:** `/api/kubesnap/{namespace}`
+- **Method:** `GET`
+- **Headers:** `X-API-Key: <SF_API_KEY>`
+- **Response:**
+  ```json
+  {
+    "snapshot_status": "success",
+    "file_name": "kubesnap_2023_10_27_10_00_00.zip",
+    "timestamp": "1698400800.0",
+    "upload_status": "success"
+  }
+  ```
+
+---
+
+## Snapshot Artifacts
+
+The generated snapshot is a `.zip` file containing the following structure:
+
+```
+kubesnap_<timestamp>.zip
+├── pod_logs/       # Logs from all pods in the namespace
+├── deployments/    # YAML configurations of deployments
+├── jobs/           # YAML configurations of jobs
+├── cronjobs/       # YAML configurations of cronjobs
+└── configmaps/     # YAML configurations of configmaps
+```
+
+---
+
 ## 📂 Project Structure  
 
 ```
@@ -51,15 +155,4 @@ kubesnap/
 └── .github/workflows/
     ├── build.yml                   # CI build workflow
     └── deploy.yml                  # CD deployment workflow
-```
-
-# Installation
-
-- Clone the repository
-- Enter the kubesnap repository
-- In case you want to deploy kubesnap to a custom namespace, run the command
-    - `export NAMESPACE="<CUSTOM-NAMESPACE>"`
-- Give execute permissions to the file
-    - `chmod +x deploy_project.sh`
-- Run the file
-    - `./deploy_project.sh`
+```