Update docs for adding apps.

This commit is contained in:
2025-10-22 22:36:53 +00:00
parent 458e70b7be
commit 351f58b80d
4 changed files with 97 additions and 28 deletions

View File

@@ -14,24 +14,79 @@ Apps use gomplate templates that compile with your Wild Cloud configuration when
## Using Wild Cloud Apps
### Commands
### Web App (Recommended)
Run these commands from your Wild Cloud home directory:
The easiest way to manage apps is through the Wild Cloud web app:
- **`wild-apps-list`** - Browse all available apps in the repository
- **`wild-app-add <app-name>`** - Add an app to your cluster:
- Copies the app manifest to your `apps` directory
- Adds default configuration to your `config.yaml`
- Generates required secrets in your `secrets.yaml`
- Compiles templates with your configuration
- **`wild-app-deploy <app-name>`** - Deploy or update the app in your cluster
1. **Navigate to Apps**: Access your instance in the web app and go to the Apps page
2. **Browse Available Apps**: View all available apps from the Wild Directory with descriptions and icons
3. **Add an App**: Click on an app to view details and click "Add" to:
- Copy the app manifest to your instance's `apps` directory
- Add default configuration to your `config.yaml`
- Generate required secrets in your `secrets.yaml`
- Compile templates with your configuration
4. **Configure** (optional): Modify app settings before deployment
5. **Deploy**: Click "Deploy" to apply the app to your cluster
6. **Monitor**: View app status, logs, and manage deployments
### CLI
For terminal-based workflows, use the Wild CLI:
```bash
# List available apps
wild app list
# Add app to instance
wild app add <app-name>
# Deploy app
wild app deploy <app-name>
# List deployed apps
wild app list-deployed
# Get app status
wild app status <app-name>
# Delete app
wild app delete <app-name>
```
The CLI connects to the Wild Central API (default: `http://localhost:5055`). You can override with `--daemon-url` or set `WILD_API_URI` environment variable.
### API
For automation or advanced workflows, use the Wild Central API:
```bash
# List available apps
curl http://localhost:5055/api/v1/apps/available
# Get app details
curl http://localhost:5055/api/v1/apps/available/{app-name}
# List deployed apps for an instance
curl http://localhost:5055/api/v1/instances/{instance-name}/apps
# Add app to configuration
curl -X POST http://localhost:5055/api/v1/instances/{instance-name}/apps \
-H "Content-Type: application/json" \
-d '{"name": "app-name", "config": {}}'
# Deploy app
curl -X POST http://localhost:5055/api/v1/instances/{instance-name}/apps/{app-name}/deploy
# Get app status
curl http://localhost:5055/api/v1/instances/{instance-name}/apps/{app-name}/status
```
### How It Works
1. **Add an app**: `wild-app-add` compiles the app's templates using your Wild Cloud configuration (domain, email, etc.) and creates standard Kustomize files in your Wild Cloud home directory
2. **Customize** (optional): Modify the compiled files in your home directory, or use Kustomize patches/overlays
3. **Deploy**: `wild-app-deploy` applies the Kustomize configuration to your cluster
4. **Manage**: Track changes with Git, update configurations as needed
1. **Add an app**: The system compiles the app's templates using your Wild Cloud configuration (domain, email, etc.) and creates standard Kustomize files in your instance directory
2. **Customize** (optional): Modify app configuration through the web app, CLI, or by editing files directly
3. **Deploy**: The system applies the Kustomize configuration to your cluster
4. **Manage**: Track changes with Git, update configurations, and monitor app health
### Dependencies
@@ -54,7 +109,7 @@ This repository includes apps for:
- Databases (PostgreSQL, MySQL, Redis, Memcached)
- And more...
Run `wild-apps-list` to see the full catalog with descriptions.
Browse the full catalog with descriptions through the web app, CLI, or via the API endpoint `/api/v1/apps/available`.
## Contributing