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

@@ -111,7 +111,7 @@ This means individual resources can use simple, component-specific selectors lik
### Gomplate Templating
Resource files in this repository are **templates** that get compiled when operators run `wild-app-add`. Use gomplate syntax to reference configuration:
Resource files in this repository are **templates** that get compiled when users add apps via the web app, CLI, or API. Use gomplate syntax to reference configuration:
```yaml
# Common template variables
@@ -125,7 +125,7 @@ dbHost: {{ .apps.myapp.dbHostname }} # App-specific config
1. Standard Wild Cloud variables (`{{ .cloud.* }}`, `{{ .operator.* }}`)
2. App-specific variables defined in your manifest's `defaultConfig`
All template variables must be defined in one of these locations. The compiled files are placed in the operator's Wild Cloud home directory as standard Kubernetes manifests.
All template variables must be defined in one of these locations. The compiled files are placed in the instance's directory as standard Kubernetes manifests.
### External DNS
@@ -177,7 +177,7 @@ When apps need database URLs with embedded credentials, **always use a dedicated
key: apps.myapp.dbUrl
```
Add `apps.myapp.dbUrl` to your manifest's `requiredSecrets`, and `wild-app-add` will generate the complete URL with embedded credentials automatically.
Add `apps.myapp.dbUrl` to your manifest's `requiredSecrets`, and the system will generate the complete URL with embedded credentials automatically when the app is added.
## Security Requirements
@@ -232,8 +232,8 @@ env:
**Secret workflow:**
1. List secrets in manifest's `requiredSecrets`
2. `wild-app-add` generates random values in operator's `secrets.yaml`
3. `wild-app-deploy` creates a Kubernetes Secret named `<app-name>-secrets`
2. When adding an app, the system generates random values in the instance's `secrets.yaml`
3. When deploying, the system creates a Kubernetes Secret named `<app-name>-secrets`
4. Resources reference secrets using full dotted paths
**Important:** Never commit `secrets.yaml` to Git. Templates should only reference secrets, never contain actual secret values.