Skip to content

Commit cdcb271

Browse files
yankawaiyankawai
committed
docs(apps): correct the shared resources and preset paragraphs
Two sentences of the boilerplate shared by the app READMEs were wrong. "When left empty, the preset is applied" described an all-or-nothing rule, but cozy-lib.resources.defaultingSanitize merges per key: every resource that resources leaves unset comes from the preset. And the legacy flat names were called aliases of their "1:1 instance-type equivalents", which reads as the c1 series; nano through small match t1, and medium matches c1.small rather than c1.medium, the trap docs/operations/resource-presets.md already warns about. Signed-off-by: Yan Bondarenko <[email protected]>
1 parent 0f21d06 commit cdcb271

12 files changed

Lines changed: 22 additions & 22 deletions

File tree

‎packages/apps/clickhouse/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ chart-emitted CronJob renders only when `backup.schedule` is non-empty.
176176
### resources and resourcesPreset
177177

178178
`resources` sets explicit CPU and memory configurations for each replica.
179-
When left empty, the preset defined in `resourcesPreset` is applied.
179+
Every resource it leaves unset is taken from the preset defined in `resourcesPreset`.
180180

181181
```yaml
182182
resources:

‎packages/apps/kafka/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
### resources and resourcesPreset
4444

4545
`resources` sets explicit CPU and memory configurations for each replica.
46-
When left empty, the preset defined in `resourcesPreset` is applied.
46+
Every resource it leaves unset is taken from the preset defined in `resourcesPreset`.
4747

4848
```yaml
4949
resources:
@@ -54,7 +54,7 @@ resources:
5454
`resourcesPreset` sets named CPU and memory configurations for each replica.
5555
This setting is ignored if the corresponding `resources` value is set.
5656

57-
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases of their 1:1 instance-type equivalents.
57+
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases and keep their original sizes, which do not follow one series: `nano` through `small` equal the `t1` sizes of the same name, while `medium` equals `c1.small` rather than `c1.medium`.
5858

5959
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
6060

‎packages/apps/kubernetes/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ See the reference for components utilized in this service:
222222
### resources and resourcesPreset
223223
224224
`resources` sets explicit CPU and memory configurations for each replica.
225-
When left empty, the preset defined in `resourcesPreset` is applied.
225+
Every resource it leaves unset is taken from the preset defined in `resourcesPreset`.
226226
227227
```yaml
228228
resources:

‎packages/apps/mariadb/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ Uninstalling the instance does this for you; only the turn-it-off-and-keep-runni
234234
### resources and resourcesPreset
235235

236236
`resources` sets explicit CPU and memory configurations for each replica.
237-
When left empty, the preset defined in `resourcesPreset` is applied.
237+
Every resource it leaves unset is taken from the preset defined in `resourcesPreset`.
238238

239239
```yaml
240240
resources:
@@ -245,7 +245,7 @@ resources:
245245
`resourcesPreset` sets named CPU and memory configurations for each replica.
246246
This setting is ignored if the corresponding `resources` value is set.
247247

248-
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases of their 1:1 instance-type equivalents.
248+
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases and keep their original sizes, which do not follow one series: `nano` through `small` equal the `t1` sizes of the same name, while `medium` equals `c1.small` rather than `c1.medium`.
249249

250250
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
251251

‎packages/apps/nats/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ It provides a data layer for cloud native applications, IoT messaging, and micro
4141
### resources and resourcesPreset
4242

4343
`resources` sets explicit CPU and memory configurations for each replica.
44-
When left empty, the preset defined in `resourcesPreset` is applied.
44+
Every resource it leaves unset is taken from the preset defined in `resourcesPreset`.
4545

4646
```yaml
4747
resources:
@@ -52,7 +52,7 @@ resources:
5252
`resourcesPreset` sets named CPU and memory configurations for each replica.
5353
This setting is ignored if the corresponding `resources` value is set.
5454

55-
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases of their 1:1 instance-type equivalents.
55+
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases and keep their original sizes, which do not follow one series: `nano` through `small` equal the `t1` sizes of the same name, while `medium` equals `c1.small` rather than `c1.medium`.
5656

5757
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
5858

‎packages/apps/postgres/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ For `sslmode=verify-full` to work, the CA bundle retrieved above must be saved t
315315
### resources and resourcesPreset
316316

317317
`resources` sets explicit CPU and memory configurations for each replica.
318-
When left empty, the preset defined in `resourcesPreset` is applied.
318+
Every resource it leaves unset is taken from the preset defined in `resourcesPreset`.
319319

320320
```yaml
321321
resources:
@@ -326,7 +326,7 @@ resources:
326326
`resourcesPreset` sets named CPU and memory configurations for each replica.
327327
This setting is ignored if the corresponding `resources` value is set.
328328

329-
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases of their 1:1 instance-type equivalents.
329+
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases and keep their original sizes, which do not follow one series: `nano` through `small` equal the `t1` sizes of the same name, while `medium` equals `c1.small` rather than `c1.medium`.
330330

331331
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
332332

‎packages/apps/qdrant/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Service deploys Qdrant as a StatefulSet with automatic cluster mode when multipl
4040
### resources and resourcesPreset
4141

4242
`resources` sets explicit CPU and memory configurations for each replica.
43-
When left empty, the preset defined in `resourcesPreset` is applied.
43+
Every resource it leaves unset is taken from the preset defined in `resourcesPreset`.
4444

4545
```yaml
4646
resources:
@@ -51,7 +51,7 @@ resources:
5151
`resourcesPreset` sets named CPU and memory configurations for each replica.
5252
This setting is ignored if the corresponding `resources` value is set.
5353

54-
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases of their 1:1 instance-type equivalents.
54+
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases and keep their original sizes, which do not follow one series: `nano` through `small` equal the `t1` sizes of the same name, while `medium` equals `c1.small` rather than `c1.medium`.
5555

5656
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
5757

‎packages/apps/rabbitmq/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ kubectl delete secret rabbitmq-<name>-ca rabbitmq-<name>-tls --namespace <tenant
128128
### resources and resourcesPreset
129129

130130
`resources` sets explicit CPU and memory configurations for each replica.
131-
When left empty, the preset defined in `resourcesPreset` is applied.
131+
Every resource it leaves unset is taken from the preset defined in `resourcesPreset`.
132132

133133
```yaml
134134
resources:
@@ -139,7 +139,7 @@ resources:
139139
`resourcesPreset` sets named CPU and memory configurations for each replica.
140140
This setting is ignored if the corresponding `resources` value is set.
141141

142-
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases of their 1:1 instance-type equivalents.
142+
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases and keep their original sizes, which do not follow one series: `nano` through `small` equal the `t1` sizes of the same name, while `medium` equals `c1.small` rather than `c1.medium`.
143143

144144
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
145145

‎packages/apps/redis/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Service utilizes the freshworks-oss Redis Operator (a maintained fork of the arc
4949
### resources and resourcesPreset
5050

5151
`resources` sets explicit CPU and memory configurations for each replica.
52-
When left empty, the preset defined in `resourcesPreset` is applied.
52+
Every resource it leaves unset is taken from the preset defined in `resourcesPreset`.
5353

5454
```yaml
5555
resources:
@@ -60,7 +60,7 @@ resources:
6060
`resourcesPreset` sets named CPU and memory configurations for each replica.
6161
This setting is ignored if the corresponding `resources` value is set.
6262

63-
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases of their 1:1 instance-type equivalents.
63+
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases and keep their original sizes, which do not follow one series: `nano` through `small` equal the `t1` sizes of the same name, while `medium` equals `c1.small` rather than `c1.medium`.
6464

6565
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
6666

‎packages/apps/tcp-balancer/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Managed TCP Load Balancer Service efficiently utilizes HAProxy for load balancin
4141
### resources and resourcesPreset
4242

4343
`resources` sets explicit CPU and memory configurations for each replica.
44-
When left empty, the preset defined in `resourcesPreset` is applied.
44+
Every resource it leaves unset is taken from the preset defined in `resourcesPreset`.
4545

4646
```yaml
4747
resources:
@@ -52,6 +52,6 @@ resources:
5252
`resourcesPreset` sets named CPU and memory configurations for each replica.
5353
This setting is ignored if the corresponding `resources` value is set.
5454

55-
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases of their 1:1 instance-type equivalents.
55+
Presets follow a cloud-style `<series>.<size>` naming convention. Five series cover the full CPU-to-memory ratio range (`t1` 1:0.5, `c1` 1:1, `s1` 1:2, `u1` 1:4, `m1` 1:8) and each series ships eight sizes (`nano` through `4xlarge`). The legacy flat names (`nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`) remain accepted as deprecated aliases and keep their original sizes, which do not follow one series: `nano` through `small` equal the `t1` sizes of the same name, while `medium` equals `c1.small` rather than `c1.medium`.
5656

5757
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.

0 commit comments

Comments
 (0)