Updates docs.

This commit is contained in:
2025-10-01 05:19:37 -07:00
parent d21eb18dc9
commit 395bdff2a6
9 changed files with 37 additions and 73 deletions

View File

@@ -166,22 +166,13 @@ Shows:
- Installation status - Installation status
- Required configuration - Required configuration
### 2. Fetching Phase ### 2. Configuration Phase
**Command**: `wild-app-fetch <app-name>`
Downloads app templates to local cache:
- Copies app directory from Wild Cloud repository
- Stores in `.wildcloud/cache/apps/`
- Options: `--update` to overwrite existing cache
- Required before configuration or deployment
### 3. Configuration Phase
**Command**: `wild-app-add <app-name>` **Command**: `wild-app-add <app-name>`
Processes app templates and prepares for deployment: Processes app templates and prepares for deployment:
**What it does**: **What it does**:
1. Reads app manifest from cache 1. Reads app manifest directly from Wild Cloud repository
2. Merges default configuration with existing `config.yaml` 2. Merges default configuration with existing `config.yaml`
3. Generates required secrets automatically 3. Generates required secrets automatically
4. Compiles templates with gomplate using your configuration 4. Compiles templates with gomplate using your configuration
@@ -193,7 +184,7 @@ Processes app templates and prepares for deployment:
- App-specific configuration merged into your `config.yaml` - App-specific configuration merged into your `config.yaml`
- Required secrets added to your `secrets.yaml` - Required secrets added to your `secrets.yaml`
### 4. Deployment Phase ### 3. Deployment Phase
**Command**: `wild-app-deploy <app-name>` **Command**: `wild-app-deploy <app-name>`
Deploys the app to your Kubernetes cluster: Deploys the app to your Kubernetes cluster:
@@ -210,7 +201,7 @@ Deploys the app to your Kubernetes cluster:
- `--force` - Overwrite existing resources - `--force` - Overwrite existing resources
- `--dry-run` - Preview changes without applying - `--dry-run` - Preview changes without applying
### 5. Operations Phase ### 4. Operations Phase
**Monitoring**: `wild-app-doctor <app-name>` **Monitoring**: `wild-app-doctor <app-name>`
- Runs app-specific diagnostic tests - Runs app-specific diagnostic tests
@@ -218,6 +209,7 @@ Deploys the app to your Kubernetes cluster:
- Options: `--keep`, `--follow`, `--timeout` - Options: `--keep`, `--follow`, `--timeout`
**Updates**: Re-run `wild-app-add` then `wild-app-deploy` **Updates**: Re-run `wild-app-add` then `wild-app-deploy`
- Use `--force` flag to overwrite existing configuration
- Updates configuration changes - Updates configuration changes
- Handles image updates - Handles image updates
- Preserves persistent data - Preserves persistent data

View File

@@ -56,9 +56,9 @@ Wild Cloud provides 34+ command-line tools (all prefixed with `wild-`) for manag
### 🏗️ Cluster Infrastructure Management ### 🏗️ Cluster Infrastructure Management
**`wild-setup-cluster`** - Complete cluster setup (Phases 1-3) **`wild-setup-cluster`** - Complete cluster setup (Phases 1-3)
- Interactive node registration and hardware detection - Automated control plane node setup and bootstrapping
- Configures Talos control plane and worker nodes - Configures Talos control plane nodes using wild-node-setup
- Options: `--skip-installer`, `--skip-hardware` - Options: `--skip-hardware`
- **Usage**: `wild-setup-cluster [options]` - **Usage**: `wild-setup-cluster [options]`
- **Requires**: `wild-init` completed first - **Requires**: `wild-init` completed first
@@ -68,18 +68,18 @@ Wild Cloud provides 34+ command-line tools (all prefixed with `wild-`) for manag
- **Usage**: `wild-cluster-config-generate` - **Usage**: `wild-cluster-config-generate`
**`wild-node-setup`** - Complete node lifecycle management **`wild-node-setup`** - Complete node lifecycle management
- Handles detect → patch → deploy for individual nodes - Handles detect → configure → patch → deploy for individual nodes
- Automatically detects maintenance mode - Automatically detects maintenance mode and handles IP transitions
- Options: `--detect`, `--no-deploy` - Options: `--reconfigure`, `--no-deploy`
- **Usage**: `wild-node-setup <node-name> [options]` - **Usage**: `wild-node-setup <node-name> [options]`
- **Examples**: - **Examples**:
- `wild-node-setup control-1` (complete setup) - `wild-node-setup control-1` (complete setup)
- `wild-node-setup worker-1 --detect` (force hardware re-detection) - `wild-node-setup worker-1 --reconfigure` (force node reconfiguration)
- `wild-node-setup control-2 --no-deploy` (configuration only) - `wild-node-setup control-2 --no-deploy` (configuration only)
**`wild-node-detect`** - Hardware detection utility **`wild-node-detect`** - Hardware detection utility
- Discovers network interfaces and disks from maintenance mode - Discovers network interfaces and disks from maintenance mode
- Returns JSON with hardware specifications - Returns JSON with hardware specifications and maintenance mode status
- **Usage**: `wild-node-detect <node-ip>` - **Usage**: `wild-node-detect <node-ip>`
- **Note**: Primarily used internally by `wild-node-setup` - **Note**: Primarily used internally by `wild-node-setup`
@@ -90,8 +90,8 @@ Wild Cloud provides 34+ command-line tools (all prefixed with `wild-`) for manag
### 🔧 Cluster Services Management ### 🔧 Cluster Services Management
**`wild-setup-services`** - Install cluster services (Phase 4) **`wild-setup-services`** - Set up all cluster services (Phase 4)
- Manages MetalLB, Traefik, cert-manager, etc. - Manages MetalLB, Traefik, cert-manager, etc. in dependency order
- Options: `--fetch` for fresh templates, `--no-deploy` for config-only - Options: `--fetch` for fresh templates, `--no-deploy` for config-only
- **Usage**: `wild-setup-services [options]` - **Usage**: `wild-setup-services [options]`
- **Requires**: Working Kubernetes cluster - **Requires**: Working Kubernetes cluster
@@ -120,15 +120,11 @@ Wild Cloud provides 34+ command-line tools (all prefixed with `wild-`) for manag
- Options: `--verbose`, `--json`, `--yaml` - Options: `--verbose`, `--json`, `--yaml`
- **Usage**: `wild-apps-list [options]` - **Usage**: `wild-apps-list [options]`
**`wild-app-fetch`** - Download app templates to cache **`wild-app-add`** - Configure app from repository
- Options: `--update` to overwrite existing
- **Usage**: `wild-app-fetch <app-name> [--update]`
**`wild-app-add`** - Configure app from cache
- Processes manifest.yaml with configuration - Processes manifest.yaml with configuration
- Generates required secrets automatically - Generates required secrets automatically
- Options: `--update` to overwrite existing app files - Options: `--force` to overwrite existing app files
- **Usage**: `wild-app-add <app-name> [--update]` - **Usage**: `wild-app-add <app-name> [--force]`
**`wild-app-deploy`** - Deploy application to cluster **`wild-app-deploy`** - Deploy application to cluster
- Creates namespaces, handles dependencies - Creates namespaces, handles dependencies
@@ -166,8 +162,10 @@ Wild Cloud provides 34+ command-line tools (all prefixed with `wild-`) for manag
### 🔍 Utilities & Helpers ### 🔍 Utilities & Helpers
**`wild-health`** - System health checks **`wild-health`** - Comprehensive infrastructure validation
- Basic health monitoring for components - Validates core components (MetalLB, Traefik, CoreDNS)
- Checks installed services (cert-manager, ExternalDNS, Kubernetes Dashboard)
- Tests DNS resolution, routing, certificates, and storage systems
- **Usage**: `wild-health` - **Usage**: `wild-health`
**`wild-talos-schema`** - Talos schema management **`wild-talos-schema`** - Talos schema management
@@ -212,7 +210,6 @@ wild-setup-services # Resume full setup if needed
### Application Management ### Application Management
```bash ```bash
wild-apps-list # See available apps wild-apps-list # See available apps
wild-app-fetch ghost # Download app templates
wild-app-add ghost # Configure app wild-app-add ghost # Configure app
wild-app-deploy ghost # Deploy to cluster wild-app-deploy ghost # Deploy to cluster
wild-app-doctor ghost # Troubleshoot issues wild-app-doctor ghost # Troubleshoot issues
@@ -252,9 +249,8 @@ wild-health # Check system health
### App Deployment Pipeline ### App Deployment Pipeline
1. `wild-apps-list` → discover applications 1. `wild-apps-list` → discover applications
2. `wild-app-fetch` → cache app templates 2. `wild-app-add` → configure and prepare application
3. `wild-app-add` → prepare configuration 3. `wild-app-deploy` → deploy to cluster
4. `wild-app-deploy` → deploy to cluster
### Node Management Flow ### Node Management Flow
1. `wild-cluster-config-generate` → base configurations 1. `wild-cluster-config-generate` → base configurations

View File

@@ -153,7 +153,6 @@ wild-setup-services # Install core services
wild-apps-list wild-apps-list
# Deploy a blog # Deploy a blog
wild-app-fetch ghost
wild-app-add ghost wild-app-add ghost
wild-app-deploy ghost wild-app-deploy ghost
@@ -215,10 +214,9 @@ storage: 10Gi
### Application Lifecycle ### Application Lifecycle
1. **Discovery**: `wild-apps-list` - Browse available apps 1. **Discovery**: `wild-apps-list` - Browse available apps
2. **Fetching**: `wild-app-fetch app-name` - Download templates 2. **Configuration**: `wild-app-add app-name` - Configure and prepare application
3. **Configuration**: `wild-app-add app-name` - Process and configure 3. **Deployment**: `wild-app-deploy app-name` - Deploy to cluster
4. **Deployment**: `wild-app-deploy app-name` - Deploy to cluster 4. **Operations**: `wild-app-doctor app-name` - Monitor and troubleshoot
5. **Operations**: `wild-app-doctor app-name` - Monitor and troubleshoot
## Available Applications ## Available Applications
@@ -259,7 +257,6 @@ wild-setup-services # Deploy cluster services only
### Application Management ### Application Management
```bash ```bash
wild-apps-list # List available applications wild-apps-list # List available applications
wild-app-fetch <app> # Download app templates
wild-app-add <app> # Configure application wild-app-add <app> # Configure application
wild-app-deploy <app> # Deploy to cluster wild-app-deploy <app> # Deploy to cluster
wild-app-delete <app> # Remove application wild-app-delete <app> # Remove application
@@ -317,7 +314,6 @@ wild-app-backup <app> # Backup specific application
### Personal Blog/Website ### Personal Blog/Website
```bash ```bash
# Deploy Ghost blog with custom domain # Deploy Ghost blog with custom domain
wild-app-fetch ghost
wild-config-set apps.ghost.domain "blog.yourdomain.com" wild-config-set apps.ghost.domain "blog.yourdomain.com"
wild-app-add ghost wild-app-add ghost
wild-app-deploy ghost wild-app-deploy ghost
@@ -326,7 +322,6 @@ wild-app-deploy ghost
### Photo Management ### Photo Management
```bash ```bash
# Deploy Immich for photo backup and management # Deploy Immich for photo backup and management
wild-app-fetch immich postgresql
wild-app-add postgresql immich wild-app-add postgresql immich
wild-app-deploy postgresql immich wild-app-deploy postgresql immich
``` ```
@@ -334,7 +329,6 @@ wild-app-deploy postgresql immich
### Development Environment ### Development Environment
```bash ```bash
# Set up Git hosting and container registry # Set up Git hosting and container registry
wild-app-fetch gitea docker-registry
wild-app-add gitea docker-registry wild-app-add gitea docker-registry
wild-app-deploy gitea docker-registry wild-app-deploy gitea docker-registry
``` ```
@@ -342,7 +336,6 @@ wild-app-deploy gitea docker-registry
### AI/ML Workloads ### AI/ML Workloads
```bash ```bash
# Deploy vLLM for local AI inference # Deploy vLLM for local AI inference
wild-app-fetch vllm
wild-config-set apps.vllm.model "Qwen/Qwen2.5-7B-Instruct" wild-config-set apps.vllm.model "Qwen/Qwen2.5-7B-Instruct"
wild-app-add vllm wild-app-add vllm
wild-app-deploy vllm wild-app-deploy vllm

View File

@@ -227,11 +227,10 @@ cluster:
### From Repository to Deployment ### From Repository to Deployment
1. **Template Storage**: Templates stored in repository with placeholder variables 1. **Template Storage**: Templates stored in repository with placeholder variables
2. **Template Fetching**: `wild-app-fetch` copies templates to user cache 2. **Configuration Merge**: `wild-app-add` reads templates directly from repository and merges app defaults with user config
3. **Configuration Merge**: `wild-app-add` merges app defaults with user config 3. **Template Compilation**: gomplate processes templates with user data
4. **Template Compilation**: gomplate processes templates with user data 4. **Manifest Generation**: Final Kubernetes manifests created in user directory
5. **Manifest Generation**: Final Kubernetes manifests created in user directory 5. **Deployment**: `wild-app-deploy` applies manifests to cluster
6. **Deployment**: `wild-app-deploy` applies manifests to cluster
### Template Variables ### Template Variables
@@ -344,7 +343,6 @@ wild-setup # Deploy infrastructure
**Daily Operations**: **Daily Operations**:
```bash ```bash
wild-apps-list # Browse available apps wild-apps-list # Browse available apps
wild-app-fetch ghost # Download app templates
wild-app-add ghost # Configure app wild-app-add ghost # Configure app
wild-app-deploy ghost # Deploy to cluster wild-app-deploy ghost # Deploy to cluster
``` ```

View File

@@ -220,8 +220,7 @@ This approach prevents naming conflicts between apps and makes secret keys more
Apps in Wild Cloud are managed by operators using a set of commands run from their Wild Cloud home directory. Apps in Wild Cloud are managed by operators using a set of commands run from their Wild Cloud home directory.
- `wild-apps-list`: Lists all available apps. - `wild-apps-list`: Lists all available apps.
- `wild-app-fetch <app-name>`: Fetches the latest app files from the Wild Cloud repository and stores them in your Wild Cloud cache. - `wild-app-add <app-name>`: Reads the app from the Wild Cloud repository, adds the app manifest to your Wild Cloud home `apps` directory, updates missing values in `config.yaml` and `secrets.yaml` with the app's default configurations, and compiles the app's Kustomize files.
- `wild-app-add <app-name>`: Adds the app manifest to your Wild Cloud home `apps` directory, updates missing values in `config.yaml` and `secrets.yaml` with the app's default configurations, and compiles the app's Kustomize files.
- `wild-app-deploy <app-name>`: Deploys the app to your Wild Cloud. - `wild-app-deploy <app-name>`: Deploys the app to your Wild Cloud.
## Contributing ## Contributing

View File

@@ -14,16 +14,10 @@ To list all available apps:
wild-apps-list wild-apps-list
``` ```
To fetch an app template to cache: To configure an app (reads directly from repository):
```bash ```bash
wild-app-fetch <app> wild-app-add <app>
```
To apply your configuration to a cached app (automatically fetches if not cached):
```bash
wild-app-config <app>
``` ```
To deploy a configured app to Kubernetes: To deploy a configured app to Kubernetes:

View File

@@ -16,8 +16,7 @@ wild-setup
```bash ```bash
wild-apps-list wild-apps-list
wild-app-fetch <app> wild-app-add <app>
wild-app-config <app>
wild-app-deploy <app> wild-app-deploy <app>
# Optional: Check in app templates. # Optional: Check in app templates.
``` ```

View File

@@ -20,16 +20,10 @@ The Wild Cloud app workflow consists of three steps:
### Commands ### Commands
To fetch an app template to cache: To configure an app (reads directly from repository):
```bash ```bash
wild-app-fetch <app> wild-app-add <app>
```
To apply your configuration to a cached app (automatically fetches if not cached):
```bash
wild-app-config <app>
``` ```
To deploy a configured app to Kubernetes: To deploy a configured app to Kubernetes:

View File

@@ -6,7 +6,6 @@ This directory is a test Wild Cloud home for debugging scripts and commands.
```bash ```bash
cd test/test-cloud cd test/test-cloud
wild-app-fetch <app-name>
wild-app-add <app-name> wild-app-add <app-name>
wild-app-deploy <app-name> wild-app-deploy <app-name>
# etc. # etc.