Skip to content

[docs] Update managed apps reference for v1.5.0-rc.1 #562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cozystack-ci wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs] Update managed apps reference for v1.5.0-rc.1 #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
175 changes: 133 additions & 42 deletions content/en/docs/next/applications/clickhouse.md
View file
Open in desktop

Large diffs are not rendered by default.

79 changes: 43 additions & 36 deletions content/en/docs/next/applications/foundationdb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 50
<!--
Autogenerated content. Don't edit this file directly; edit sources instead.
metadata: https://github.com/cozystack/website/blob/main/content/en/docs/next/applications/_include/foundationdb.md
source: https://github.com/cozystack/cozystack/blob/v1.3.0/packages/apps/foundationdb/README.md
source: https://github.com/cozystack/cozystack/blob/main/packages/apps/foundationdb/README.md
-->


Expand Down Expand Up @@ -64,20 +64,25 @@ resources:
memory: "4Gi"
```

### Backup (Optional)

```yaml
backup:
enabled: true
s3:
bucket: "my-fdb-backups"
endpoint: "https://s3.amazonaws.com"
region: "us-east-1"
credentials:
accessKeyId: "AKIA..."
secretAccessKey: "..."
retentionPolicy: "7d"
```
### Backups

The recommended backup flow uses the Cozystack backups framework: a
cluster-scoped `BackupClass` binds `apps.cozystack.io/FoundationDB` to a
`strategy.backups.cozystack.io/FoundationDB` strategy, and tenants drive
runs via `BackupJob` / `RestoreJob`. See
[`examples/backups/foundationdb/`](../../../examples/backups/foundationdb/)
for an end-to-end walkthrough (admin setup, backup, in-place restore,
to-copy restore).

The legacy in-chart `backup.*` values (`backup.enabled`, `backup.s3`,
`backup.retentionPolicy`) are **DEPRECATED** but still render the
original `FoundationDBBackup` CR unchanged when `backup.enabled=true`,
for backward compatibility. New deployments should leave
`backup.enabled=false` (the default) and use the BackupClass flow above.
Mixing the two on the same cluster is unsupported — the FoundationDB
operator only permits one running backup directory per cluster, and the
backup driver fails fast with `Ready=False/ConflictingInChartBackup`
when it sees a chart-rendered Running backup against the same target.

### Advanced Configuration

Expand All @@ -86,8 +91,8 @@ backup:
customParameters:
- "knob_disable_posix_kernel_aio=1"

# Image type (unified is default and recommended for new deployments)
imageType: "unified"
# Image type (split is the default; matches existing clusters' effective value)
imageType: "split"

# Enable automatic pod replacements
automaticReplacements: true
Expand Down Expand Up @@ -154,6 +159,8 @@ For issues related to FoundationDB itself, refer to the [FoundationDB documentat

For Cozystack-specific issues, consult the Cozystack documentation or support channels.

> `storageClass` is annotated as immutable in the chart schema — see [`docs/storage-immutability.md`](../../../docs/storage-immutability.md) for the contract and which consumers enforce it.

## Parameters

### Common parameters
Expand All @@ -177,29 +184,29 @@ For Cozystack-specific issues, consult the Cozystack documentation or support ch
| `resources` | Explicit CPU and memory configuration for each FoundationDB instance. When omitted, the preset defined in `resourcesPreset` is applied. | `object` | `{}` |
| `resources.cpu` | CPU available to each instance. | `quantity` | `""` |
| `resources.memory` | Memory (RAM) available to each instance. | `quantity` | `""` |
| `resourcesPreset` | Default sizing preset used when `resources` is omitted. | `string` | `medium` |
| `backup` | Backup configuration. | `object` | `{}` |
| `backup.enabled` | Enable backups. | `bool` | `false` |
| `backup.s3` | S3 configuration for backups. | `object` | `{}` |
| `backup.s3.bucket` | S3 bucket name. | `string` | `""` |
| `backup.s3.endpoint` | S3 endpoint URL. | `string` | `""` |
| `backup.s3.region` | S3 region. | `string` | `us-east-1` |
| `backup.s3.credentials` | S3 credentials. | `object` | `{}` |
| `backup.s3.credentials.accessKeyId` | S3 access key ID. | `string` | `""` |
| `backup.s3.credentials.secretAccessKey` | S3 secret access key. | `string` | `""` |
| `backup.retentionPolicy` | Retention policy for backups. | `string` | `7d` |
| `resourcesPreset` | Default sizing preset used when `resources` is omitted. | `string` | `c1.small` |
| `backup` | DEPRECATED Backup configuration (use the Cozystack backups framework: BackupClass + FoundationDB strategy). | `object` | `{}` |
| `backup.enabled` | DEPRECATED Enable in-chart backups (superseded by BackupClass + FoundationDB strategy). | `bool` | `false` |
| `backup.s3` | DEPRECATED S3 configuration for backups. | `object` | `{}` |
| `backup.s3.bucket` | DEPRECATED S3 bucket name. | `string` | `""` |
| `backup.s3.endpoint` | DEPRECATED S3 endpoint URL. | `string` | `""` |
| `backup.s3.region` | DEPRECATED S3 region. | `string` | `us-east-1` |
| `backup.s3.credentials` | DEPRECATED S3 credentials. | `object` | `{}` |
| `backup.s3.credentials.accessKeyId` | DEPRECATED S3 access key ID. | `string` | `""` |
| `backup.s3.credentials.secretAccessKey` | DEPRECATED S3 secret access key. | `string` | `""` |
| `backup.retentionPolicy` | DEPRECATED Retention policy for backups. | `string` | `7d` |
| `monitoring` | Monitoring configuration. | `object` | `{}` |
| `monitoring.enabled` | Enable WorkloadMonitor integration. | `bool` | `true` |


### FoundationDB configuration

| Name | Description | Type | Value |
| ---------------------------- | ------------------------------------------ | ---------- | --------- |
| `customParameters` | Custom parameters to pass to FoundationDB. | `[]string` | `[]` |
| `imageType` | Container image deployment type. | `string` | `unified` |
| `securityContext` | Security context for containers. | `object` | `{}` |
| `securityContext.runAsUser` | User ID to run the container. | `int` | `4059` |
| `securityContext.runAsGroup` | Group ID to run the container. | `int` | `4059` |
| `automaticReplacements` | Enable automatic pod replacements. | `bool` | `true` |
| Name | Description | Type | Value |
| ---------------------------- | ------------------------------------------ | ---------- | ------- |
| `customParameters` | Custom parameters to pass to FoundationDB. | `[]string` | `[]` |
| `imageType` | Container image deployment type. | `string` | `split` |
| `securityContext` | Security context for containers. | `object` | `{}` |
| `securityContext.runAsUser` | User ID to run the container. | `int` | `4059` |
| `securityContext.runAsGroup` | Group ID to run the container. | `int` | `4059` |
| `automaticReplacements` | Enable automatic pod replacements. | `bool` | `true` |

Loading