Skip to content

Commit 55a98b8

Browse files
committed
docs(apps): point seven app README preset tables at canonical docs
Address review feedback from coderabbitai across: - packages/apps/kubernetes/README.md - packages/apps/mariadb/README.md - packages/apps/nats/README.md - packages/apps/qdrant/README.md - packages/apps/redis/README.md - packages/apps/tcp-balancer/README.md - packages/apps/vpn/README.md Each of these READMEs left an inline 7-row preset table listing only the legacy flat names after the parameters block above already defaulted to an instance-type value (e.g. `t1.nano`). cozyvalues-gen only regenerates the `## Parameters` block, so the hand-written section drifted. Replace the inline tables with the same short paragraph already used by postgres and kafka READMEs: name the five series, note that the seven legacy names remain accepted as deprecated aliases, and link to the canonical reference at docs/operations/resource-presets.md so the full size matrix and legacy mapping live in exactly one place. Signed-off-by: Aleksei Sviridkin <[email protected]>
1 parent e90736e commit 55a98b8

7 files changed

Lines changed: 21 additions & 63 deletions

File tree

‎packages/apps/kubernetes/README.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -211,15 +211,9 @@ resources:
211211
`resourcesPreset` sets named CPU and memory configurations for each replica.
212212
This setting is ignored if the corresponding `resources` value is set.
213213

214-
| Preset name | CPU | memory |
215-
|-------------|--------|---------|
216-
| `nano` | `250m` | `128Mi` |
217-
| `micro` | `500m` | `256Mi` |
218-
| `small` | `1` | `512Mi` |
219-
| `medium` | `1` | `1Gi` |
220-
| `large` | `2` | `2Gi` |
221-
| `xlarge` | `4` | `4Gi` |
222-
| `2xlarge` | `8` | `8Gi` |
214+
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.
215+
216+
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
223217

224218
### instanceType Resources
225219

‎packages/apps/mariadb/README.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -126,15 +126,9 @@ resources:
126126
`resourcesPreset` sets named CPU and memory configurations for each replica.
127127
This setting is ignored if the corresponding `resources` value is set.
128128

129-
| Preset name | CPU | memory |
130-
|-------------|--------|---------|
131-
| `nano` | `250m` | `128Mi` |
132-
| `micro` | `500m` | `256Mi` |
133-
| `small` | `1` | `512Mi` |
134-
| `medium` | `1` | `1Gi` |
135-
| `large` | `2` | `2Gi` |
136-
| `xlarge` | `4` | `4Gi` |
137-
| `2xlarge` | `8` | `8Gi` |
129+
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.
130+
131+
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
138132

139133
### users
140134

‎packages/apps/nats/README.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,7 @@ resources:
4848
`resourcesPreset` sets named CPU and memory configurations for each replica.
4949
This setting is ignored if the corresponding `resources` value is set.
5050

51-
| Preset name | CPU | memory |
52-
|-------------|--------|---------|
53-
| `nano` | `250m` | `128Mi` |
54-
| `micro` | `500m` | `256Mi` |
55-
| `small` | `1` | `512Mi` |
56-
| `medium` | `1` | `1Gi` |
57-
| `large` | `2` | `2Gi` |
58-
| `xlarge` | `4` | `4Gi` |
59-
| `2xlarge` | `8` | `8Gi` |
51+
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.
52+
53+
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
6054

‎packages/apps/qdrant/README.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,6 @@ resources:
4141
`resourcesPreset` sets named CPU and memory configurations for each replica.
4242
This setting is ignored if the corresponding `resources` value is set.
4343

44-
| Preset name | CPU | memory |
45-
|-------------|--------|---------|
46-
| `nano` | `250m` | `128Mi` |
47-
| `micro` | `500m` | `256Mi` |
48-
| `small` | `1` | `512Mi` |
49-
| `medium` | `1` | `1Gi` |
50-
| `large` | `2` | `2Gi` |
51-
| `xlarge` | `4` | `4Gi` |
52-
| `2xlarge` | `8` | `8Gi` |
44+
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.
45+
46+
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.

‎packages/apps/redis/README.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,6 @@ resources:
4949
`resourcesPreset` sets named CPU and memory configurations for each replica.
5050
This setting is ignored if the corresponding `resources` value is set.
5151

52-
| Preset name | CPU | memory |
53-
|-------------|--------|---------|
54-
| `nano` | `250m` | `128Mi` |
55-
| `micro` | `500m` | `256Mi` |
56-
| `small` | `1` | `512Mi` |
57-
| `medium` | `1` | `1Gi` |
58-
| `large` | `2` | `2Gi` |
59-
| `xlarge` | `4` | `4Gi` |
60-
| `2xlarge` | `8` | `8Gi` |
52+
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.
53+
54+
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.

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

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +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-
| Preset name | CPU | memory |
56-
|-------------|--------|---------|
57-
| `nano` | `250m` | `128Mi` |
58-
| `micro` | `500m` | `256Mi` |
59-
| `small` | `1` | `512Mi` |
60-
| `medium` | `1` | `1Gi` |
61-
| `large` | `2` | `2Gi` |
62-
| `xlarge` | `4` | `4Gi` |
63-
| `2xlarge` | `8` | `8Gi` |
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.
56+
57+
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.

‎packages/apps/vpn/README.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,9 @@ resources:
5555
`resourcesPreset` sets named CPU and memory configurations for each replica.
5656
This setting is ignored if the corresponding `resources` value is set.
5757

58-
| Preset name | CPU | memory |
59-
|-------------|--------|---------|
60-
| `nano` | `250m` | `128Mi` |
61-
| `micro` | `500m` | `256Mi` |
62-
| `small` | `1` | `512Mi` |
63-
| `medium` | `1` | `1Gi` |
64-
| `large` | `2` | `2Gi` |
65-
| `xlarge` | `4` | `4Gi` |
66-
| `2xlarge` | `8` | `8Gi` |
58+
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.
59+
60+
See [`docs/operations/resource-presets.md`](../../../docs/operations/resource-presets.md) for the full size matrix and the legacy-to-instance-type mapping.
6761

6862

6963
### users

0 commit comments

Comments
 (0)