change to defaultSecrets

This commit is contained in:
2025-12-30 03:41:18 +00:00
parent 47cdf16b54
commit d586e10776
2 changed files with 6 additions and 6 deletions

View File

@@ -43,7 +43,7 @@ defaultConfig:
storage: 10Gi storage: 10Gi
dbHostname: postgres.postgres.svc.cluster.local dbHostname: postgres.postgres.svc.cluster.local
dbUsername: myapp dbUsername: myapp
requiredSecrets: defaultSecrets:
- apps.myapp.dbPassword - apps.myapp.dbPassword
- apps.postgres.password - apps.postgres.password
``` ```
@@ -55,7 +55,7 @@ requiredSecrets:
- `icon` - A URL to an icon representing the app - `icon` - A URL to an icon representing the app
- `requires` - A list of other apps that this app depends on (each entry should be the name of another app) - `requires` - A list of other apps that this app depends on (each entry should be the name of another app)
- `defaultConfig` - A set of default configuration values for the app (when an app is added using `wild-app-add`, these values will be added to the Wild Cloud `config.yaml` file) - `defaultConfig` - A set of default configuration values for the app (when an app is added using `wild-app-add`, these values will be added to the Wild Cloud `config.yaml` file)
- `requiredSecrets` - A list of secrets that must be set in the Wild Cloud `secrets.yaml` file for the app to function properly (these secrets are typically sensitive information like database passwords or API keys; keys with random values will be generated automatically when the app is added) - `defaultSecrets` - A list of secrets that must be set in the Wild Cloud `secrets.yaml` file for the app to function properly (these secrets are typically sensitive information like database passwords or API keys; keys with random values will be generated automatically when the app is added)
### Kustomization Configuration ### Kustomization Configuration
@@ -354,7 +354,7 @@ spec:
```yaml ```yaml
# In manifest.yaml # In manifest.yaml
requiredSecrets: defaultSecrets:
- apps.myapp.dbUrl - apps.myapp.dbUrl
# Generated secret (by wild-app-add) # Generated secret (by wild-app-add)
@@ -509,7 +509,7 @@ Wild Cloud includes apps for common self-hosted services:
**Manifest Design**: **Manifest Design**:
- Include comprehensive `defaultConfig` for all configurable values - Include comprehensive `defaultConfig` for all configurable values
- List all `requiredSecrets` the app needs - List all `defaultSecrets` the app needs
- Specify dependencies in `requires` field - Specify dependencies in `requires` field
- Use semantic versioning - Use semantic versioning

View File

@@ -247,7 +247,7 @@ wild-secret-set apps.database '{"user":"admin","password":"secret"}'
When you run `wild-app-add`, Wild Cloud automatically generates required secrets: When you run `wild-app-add`, Wild Cloud automatically generates required secrets:
1. **Reads App Manifest**: Identifies `requiredSecrets` list 1. **Reads App Manifest**: Identifies `defaultSecrets` list
2. **Checks Existing Secrets**: Never overwrites existing values 2. **Checks Existing Secrets**: Never overwrites existing values
3. **Generates Missing Secrets**: Creates secure random values 3. **Generates Missing Secrets**: Creates secure random values
4. **Updates secrets.yaml**: Adds new secrets with proper structure 4. **Updates secrets.yaml**: Adds new secrets with proper structure
@@ -255,7 +255,7 @@ When you run `wild-app-add`, Wild Cloud automatically generates required secrets
**Example App Manifest**: **Example App Manifest**:
```yaml ```yaml
name: ghost name: ghost
requiredSecrets: defaultSecrets:
- apps.ghost.dbPassword # Auto-generated if missing - apps.ghost.dbPassword # Auto-generated if missing
- apps.ghost.jwtSecret # Auto-generated if missing - apps.ghost.jwtSecret # Auto-generated if missing
- apps.postgresql.password # Auto-generated if missing (dependency) - apps.postgresql.password # Auto-generated if missing (dependency)