Skip to content

Commit fe70640

Browse files
NickVolynkinNickVolynkin
committed
[apps] Give examples of new resources in managed app README's
- Change wording for `resources` and `resourcesPreset` variables. - Explain and give exampls of other object-type variables, if their child fields are not annotated. - Fix a few typos, improve wording. - Bump all application charts to ensure that new texts are shown immediately after updating Cozystack. Incorporate changes in resourcesPreset values from #1155
1 parent 0d46393 commit fe70640

47 files changed

Lines changed: 694 additions & 282 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/apps/clickhouse/Chart.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ type: application
1616
# This is the chart version. This version number should be incremented each time you make changes
1717
# to the chart and its templates, including the app version.
1818
# Versions are expected to follow Semantic Versioning (https://semver.org/)
19-
version: 0.10.1
19+
version: 0.10.2
2020

2121
# This is the version number of the application being deployed. This version number should be
2222
# incremented each time you make changes to the application. Versions are not expected to

‎packages/apps/clickhouse/README.md‎

Lines changed: 38 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
# Managed Clickhouse Service
1+
# Managed ClickHouse Service
22

33
ClickHouse is an open source high-performance and column-oriented SQL database management system (DBMS).
44
It is used for online analytical processing (OLAP).
5-
Cozystack platform uses Altinity operator to provide ClickHouse.
65

7-
### How to restore backup:
6+
### How to restore backup from S3
87

9-
1. Find a snapshot:
10-
```
8+
1. Find the snapshot:
9+
10+
```bash
1111
restic -r s3:s3.example.org/clickhouse-backups/table_name snapshots
1212
```
1313

1414
2. Restore it:
15-
```
15+
16+
```bash
1617
restic -r s3:s3.example.org/clickhouse-backups/table_name restore latest --target /tmp/
1718
```
1819

@@ -39,32 +40,41 @@ For more details, read [Restic: Effective Backup from Stdin](https://blog.aenix.
3940

4041
### Backup parameters
4142

42-
| Name | Description | Value |
43-
| ------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------ |
44-
| `backup.enabled` | Enable periodic backups | `false` |
45-
| `backup.s3Region` | AWS S3 region where backups are stored | `us-east-1` |
46-
| `backup.s3Bucket` | S3 bucket used for storing backups | `s3.example.org/clickhouse-backups` |
47-
| `backup.schedule` | Cron schedule for automated backups | `0 2 * * *` |
48-
| `backup.cleanupStrategy` | Retention strategy for cleaning up old backups | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` |
49-
| `backup.s3AccessKey` | Access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` |
50-
| `backup.s3SecretKey` | Secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` |
51-
| `backup.resticPassword` | Password for Restic backup encryption | `ChaXoveekoh6eigh4siesheeda2quai0` |
52-
| `resources` | Explicit CPU/memory resource requests and limits for the Clickhouse service | `{}` |
53-
| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. | `small` |
43+
| Name | Description | Value |
44+
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
45+
| `backup.enabled` | Enable periodic backups | `false` |
46+
| `backup.s3Region` | AWS S3 region where backups are stored | `us-east-1` |
47+
| `backup.s3Bucket` | S3 bucket used for storing backups | `s3.example.org/clickhouse-backups` |
48+
| `backup.schedule` | Cron schedule for automated backups | `0 2 * * *` |
49+
| `backup.cleanupStrategy` | Retention strategy for cleaning up old backups | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` |
50+
| `backup.s3AccessKey` | Access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` |
51+
| `backup.s3SecretKey` | Secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` |
52+
| `backup.resticPassword` | Password for Restic backup encryption | `ChaXoveekoh6eigh4siesheeda2quai0` |
53+
| `resources` | Explicit CPU and memory configuration for each ClickHouse replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` |
54+
| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `small` |
55+
56+
## Parameter examples and reference
5457

58+
### resources and resourcesPreset
5559

56-
In production environments, it's recommended to set `resources` explicitly.
57-
Example of `resources`:
60+
`resources` sets explicit CPU and memory configurations for each replica.
61+
When left empty, the preset defined in `resourcesPreset` is applied.
5862

5963
```yaml
6064
resources:
61-
limits:
62-
cpu: 4000m
63-
memory: 4Gi
64-
requests:
65-
cpu: 100m
66-
memory: 512Mi
65+
cpu: 4000m
66+
memory: 4Gi
6767
```
6868

69-
Allowed values for `resourcesPreset` are `none`, `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.
70-
This value is ignored if `resources` value is set.
69+
`resourcesPreset` sets named CPU and memory configurations for each replica.
70+
This setting is ignored if the corresponding `resources` value is set.
71+
72+
| Preset name | CPU | memory |
73+
|-------------|--------|---------|
74+
| `nano` | `250m` | `128Mi` |
75+
| `micro` | `500m` | `256Mi` |
76+
| `small` | `1` | `512Mi` |
77+
| `medium` | `1` | `1Gi` |
78+
| `large` | `2` | `2Gi` |
79+
| `xlarge` | `4` | `4Gi` |
80+
| `2xlarge` | `8` | `8Gi` |

‎packages/apps/clickhouse/values.schema.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,12 @@
7979
},
8080
"resources": {
8181
"type": "object",
82-
"description": "Explicit CPU/memory resource requests and limits for the Clickhouse service",
82+
"description": "Explicit CPU and memory configuration for each ClickHouse replica. When left empty, the preset defined in `resourcesPreset` is applied.",
8383
"default": {}
8484
},
8585
"resourcesPreset": {
8686
"type": "string",
87-
"description": "Use a common resources preset when `resources` is not set explicitly.",
87+
"description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.",
8888
"default": "small",
8989
"enum": [
9090
"none",

‎packages/apps/clickhouse/values.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ backup:
4747
s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog
4848
resticPassword: ChaXoveekoh6eigh4siesheeda2quai0
4949

50-
## @param resources Explicit CPU/memory resource requests and limits for the Clickhouse service
50+
## @param resources Explicit CPU and memory configuration for each ClickHouse replica. When left empty, the preset defined in `resourcesPreset` is applied.
5151
resources: {}
5252
# resources:
5353
# cpu: 4000m
5454
# memory: 4Gi
5555

56-
## @param resourcesPreset Use a common resources preset when `resources` is not set explicitly.
56+
## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.
5757
resourcesPreset: "small"

‎packages/apps/ferretdb/Chart.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ type: application
1616
# This is the chart version. This version number should be incremented each time you make changes
1717
# to the chart and its templates, including the app version.
1818
# Versions are expected to follow Semantic Versioning (https://semver.org/)
19-
version: 0.7.1
19+
version: 0.7.2
2020

2121
# This is the version number of the application being deployed. This version number should be
2222
# incremented each time you make changes to the application. Versions are not expected to

‎packages/apps/ferretdb/README.md‎

Lines changed: 50 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
# Managed FerretDB Service
22

3+
FerretDB is an open source MongoDB alternative.
4+
It translates MongoDB wire protocol queries to SQL and can be used as a direct replacement for MongoDB 5.0+.
5+
Internally, FerretDB service is backed by Postgres.
6+
37
## Parameters
48

59
### Common parameters
610

7-
| Name | Description | Value |
8-
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------- | ------- |
9-
| `external` | Enable external access from outside the cluster | `false` |
10-
| `size` | Persistent Volume size | `10Gi` |
11-
| `replicas` | Number of Postgres replicas | `2` |
12-
| `storageClass` | StorageClass used to store the data | `""` |
13-
| `quorum.minSyncReplicas` | Minimum number of synchronous replicas that must acknowledge a transaction before it is considered committed. | `0` |
14-
| `quorum.maxSyncReplicas` | Maximum number of synchronous replicas that can acknowledge a transaction (must be lower than the number of instances). | `0` |
11+
| Name | Description | Value |
12+
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------- | ------- |
13+
| `external` | Enable external access from outside the cluster | `false` |
14+
| `size` | Persistent Volume size | `10Gi` |
15+
| `replicas` | Number of replicas | `2` |
16+
| `storageClass` | StorageClass used to store the data | `""` |
17+
| `quorum.minSyncReplicas` | Minimum number of synchronous replicas that must acknowledge a transaction before it is considered committed | `0` |
18+
| `quorum.maxSyncReplicas` | Maximum number of synchronous replicas that can acknowledge a transaction (must be lower than the total number of replicas) | `0` |
1519

1620
### Configuration parameters
1721

@@ -21,17 +25,43 @@
2125

2226
### Backup parameters
2327

24-
| Name | Description | Value |
25-
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ |
26-
| `backup.enabled` | Enable pereiodic backups | `false` |
27-
| `backup.s3Region` | The AWS S3 region where backups are stored | `us-east-1` |
28-
| `backup.s3Bucket` | The S3 bucket used for storing backups | `s3.example.org/postgres-backups` |
29-
| `backup.schedule` | Cron schedule for automated backups | `0 2 * * *` |
30-
| `backup.cleanupStrategy` | The strategy for cleaning up old backups | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` |
31-
| `backup.s3AccessKey` | The access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` |
32-
| `backup.s3SecretKey` | The secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` |
33-
| `backup.resticPassword` | The password for Restic backup encryption | `ChaXoveekoh6eigh4siesheeda2quai0` |
34-
| `resources` | Resources | `{}` |
35-
| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `nano` |
28+
| Name | Description | Value |
29+
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
30+
| `backup.enabled` | Enable periodic backups | `false` |
31+
| `backup.s3Region` | The AWS S3 region where backups are stored | `us-east-1` |
32+
| `backup.s3Bucket` | The S3 bucket used for storing backups | `s3.example.org/postgres-backups` |
33+
| `backup.schedule` | Cron schedule for automated backups | `0 2 * * *` |
34+
| `backup.cleanupStrategy` | The strategy for cleaning up old backups | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` |
35+
| `backup.s3AccessKey` | The access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` |
36+
| `backup.s3SecretKey` | The secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` |
37+
| `backup.resticPassword` | The password for Restic backup encryption | `ChaXoveekoh6eigh4siesheeda2quai0` |
38+
| `resources` | Explicit CPU and memory configuration for each FerretDB replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` |
39+
| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` |
40+
41+
42+
43+
## Parameter examples and reference
44+
45+
### resources and resourcesPreset
46+
47+
`resources` sets explicit CPU and memory configurations for each replica.
48+
When left empty, the preset defined in `resourcesPreset` is applied.
49+
50+
```yaml
51+
resources:
52+
cpu: 4000m
53+
memory: 4Gi
54+
```
3655
56+
`resourcesPreset` sets named CPU and memory configurations for each replica.
57+
This setting is ignored if the corresponding `resources` value is set.
3758

59+
| Preset name | CPU | memory |
60+
|-------------|--------|---------|
61+
| `nano` | `250m` | `128Mi` |
62+
| `micro` | `500m` | `256Mi` |
63+
| `small` | `1` | `512Mi` |
64+
| `medium` | `1` | `1Gi` |
65+
| `large` | `2` | `2Gi` |
66+
| `xlarge` | `4` | `4Gi` |
67+
| `2xlarge` | `8` | `8Gi` |

0 commit comments

Comments
 (0)