diff --git a/packages/apps/clickhouse/README.md b/packages/apps/clickhouse/README.md index af76f6fe..8fd51fb2 100644 --- a/packages/apps/clickhouse/README.md +++ b/packages/apps/clickhouse/README.md @@ -28,8 +28,8 @@ For more details, read [Restic: Effective Backup from Stdin](https://blog.aenix. | `replicas` | Number of Clickhouse replicas | `int` | `2` | | `shards` | Number of Clickhouse shards | `int` | `1` | | `resources` | Explicit CPU and memory configuration for each Clickhouse replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `{}` | -| `resources.cpu` | CPU | `*quantity` | `null` | -| `resources.memory` | Memory | `*quantity` | `null` | +| `resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `small` | | `size` | Persistent Volume Claim size, available for application data | `quantity` | `10Gi` | | `storageClass` | StorageClass used to store the data | `string` | `""` | @@ -56,20 +56,20 @@ For more details, read [Restic: Effective Backup from Stdin](https://blog.aenix. | `backup.s3Bucket` | S3 bucket used for storing backups | `string` | `s3.example.org/clickhouse-backups` | | `backup.schedule` | Cron schedule for automated backups | `string` | `0 2 * * *` | | `backup.cleanupStrategy` | Retention strategy for cleaning up old backups | `string` | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` | -| `backup.s3AccessKey` | Access key for S3, used for authentication | `string` | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | -| `backup.s3SecretKey` | Secret key for S3, used for authentication | `string` | `ju3eum4dekeich9ahM1te8waeGai0oog` | -| `backup.resticPassword` | Password for Restic backup encryption | `string` | `ChaXoveekoh6eigh4siesheeda2quai0` | +| `backup.s3AccessKey` | Access key for S3, used for authentication | `string` | `` | +| `backup.s3SecretKey` | Secret key for S3, used for authentication | `string` | `` | +| `backup.resticPassword` | Password for Restic backup encryption | `string` | `` | ### Clickhouse Keeper parameters -| Name | Description | Type | Value | -| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | -| `clickhouseKeeper` | Clickhouse Keeper configuration | `*object` | `{}` | -| `clickhouseKeeper.enabled` | Deploy ClickHouse Keeper for cluster coordination | `*bool` | `true` | -| `clickhouseKeeper.size` | Persistent Volume Claim size, available for application data | `*quantity` | `1Gi` | -| `clickhouseKeeper.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. | `string` | `micro` | -| `clickhouseKeeper.replicas` | Number of keeper replicas | `*int` | `3` | +| Name | Description | Type | Value | +| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | +| `clickhouseKeeper` | Clickhouse Keeper configuration | `*object` | `{}` | +| `clickhouseKeeper.enabled` | Deploy ClickHouse Keeper for cluster coordination | `*bool` | `true` | +| `clickhouseKeeper.size` | Persistent Volume Claim size, available for application data | `*quantity` | `1Gi` | +| `clickhouseKeeper.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `micro` | +| `clickhouseKeeper.replicas` | Number of Keeper replicas | `*int` | `3` | ## Parameter examples and reference diff --git a/packages/apps/clickhouse/values.schema.json b/packages/apps/clickhouse/values.schema.json index 535fdabd..e1c16d2a 100644 --- a/packages/apps/clickhouse/values.schema.json +++ b/packages/apps/clickhouse/values.schema.json @@ -8,11 +8,11 @@ "default": { "cleanupStrategy": "--keep-last=3 --keep-daily=3 --keep-within-weekly=1m", "enabled": false, - "resticPassword": "ChaXoveekoh6eigh4siesheeda2quai0", - "s3AccessKey": "oobaiRus9pah8PhohL1ThaeTa4UVa7gu", + "resticPassword": "\u003cpassword\u003e", + "s3AccessKey": "\u003cyour-access-key\u003e", "s3Bucket": "s3.example.org/clickhouse-backups", "s3Region": "us-east-1", - "s3SecretKey": "ju3eum4dekeich9ahM1te8waeGai0oog", + "s3SecretKey": "\u003cyour-secret-key\u003e", "schedule": "0 2 * * *" }, "required": [ @@ -39,12 +39,12 @@ "resticPassword": { "description": "Password for Restic backup encryption", "type": "string", - "default": "ChaXoveekoh6eigh4siesheeda2quai0" + "default": "\u003cpassword\u003e" }, "s3AccessKey": { "description": "Access key for S3, used for authentication", "type": "string", - "default": "oobaiRus9pah8PhohL1ThaeTa4UVa7gu" + "default": "\u003cyour-access-key\u003e" }, "s3Bucket": { "description": "S3 bucket used for storing backups", @@ -59,7 +59,7 @@ "s3SecretKey": { "description": "Secret key for S3, used for authentication", "type": "string", - "default": "ju3eum4dekeich9ahM1te8waeGai0oog" + "default": "\u003cyour-secret-key\u003e" }, "schedule": { "description": "Cron schedule for automated backups", @@ -87,12 +87,12 @@ "default": true }, "replicas": { - "description": "Number of keeper replicas", + "description": "Number of Keeper replicas", "type": "integer", "default": 3 }, "resourcesPreset": { - "description": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.", "type": "string", "default": "micro", "enum": [ @@ -151,7 +151,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -164,7 +164,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/clickhouse/values.yaml b/packages/apps/clickhouse/values.yaml index 41424165..1eb4379c 100644 --- a/packages/apps/clickhouse/values.yaml +++ b/packages/apps/clickhouse/values.yaml @@ -5,8 +5,8 @@ replicas: 2 ## @param shards {int} Number of Clickhouse shards shards: 1 ## @param resources {*resources} Explicit CPU and memory configuration for each Clickhouse replica. When left empty, the preset defined in `resourcesPreset` is applied. -## @field resources.cpu {*quantity} CPU -## @field resources.memory {*quantity} Memory +## @field resources.cpu {*quantity} CPU available to each replica +## @field resources.memory {*quantity} Memory (RAM) available to each replica # resources: # cpu: 4000m # memory: 4Gi @@ -56,20 +56,20 @@ users: {} backup: enabled: false s3Region: us-east-1 - s3Bucket: s3.example.org/clickhouse-backups + s3Bucket: "s3.example.org/clickhouse-backups" schedule: "0 2 * * *" cleanupStrategy: "--keep-last=3 --keep-daily=3 --keep-within-weekly=1m" - s3AccessKey: oobaiRus9pah8PhohL1ThaeTa4UVa7gu - s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog - resticPassword: ChaXoveekoh6eigh4siesheeda2quai0 + s3AccessKey: "" + s3SecretKey: "" + resticPassword: "" ## @section Clickhouse Keeper parameters ## @param clickhouseKeeper {*clickhouseKeeper} Clickhouse Keeper configuration ## @field clickhouseKeeper.enabled {*bool} Deploy ClickHouse Keeper for cluster coordination ## @field clickhouseKeeper.size {*quantity} Persistent Volume Claim size, available for application data -## @field clickhouseKeeper.resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. -## @field clickhouseKeeper.replicas {*int} Number of keeper replicas +## @field clickhouseKeeper.resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. +## @field clickhouseKeeper.replicas {*int} Number of Keeper replicas clickhouseKeeper: enabled: true size: 1Gi diff --git a/packages/apps/ferretdb/README.md b/packages/apps/ferretdb/README.md index 18d1b9b7..052cb103 100644 --- a/packages/apps/ferretdb/README.md +++ b/packages/apps/ferretdb/README.md @@ -12,8 +12,8 @@ Internally, FerretDB service is backed by Postgres. | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `replicas` | Number of replicas | `int` | `2` | | `resources` | Explicit CPU and memory configuration for each FerretDB replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `{}` | -| `resources.cpu` | CPU | `*quantity` | `null` | -| `resources.memory` | Memory | `*quantity` | `null` | +| `resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `micro` | | `size` | Persistent Volume Claim size, available for application data | `quantity` | `10Gi` | | `storageClass` | StorageClass used to store the data | `string` | `""` | @@ -41,8 +41,8 @@ Internally, FerretDB service is backed by Postgres. | `backup.retentionPolicy` | Retention policy | `string` | `30d` | | `backup.endpointURL` | S3 Endpoint used to upload data to the cloud | `string` | `http://minio-gateway-service:9000` | | `backup.destinationPath` | Path to store the backup (i.e. s3://bucket/path/to/folder) | `string` | `s3://bucket/path/to/folder/` | -| `backup.s3AccessKey` | Access key for S3, used for authentication | `string` | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | -| `backup.s3SecretKey` | Secret key for S3, used for authentication | `string` | `ju3eum4dekeich9ahM1te8waeGai0oog` | +| `backup.s3AccessKey` | Access key for S3, used for authentication | `string` | `` | +| `backup.s3SecretKey` | Secret key for S3, used for authentication | `string` | `` | ### Bootstrap (recovery) parameters diff --git a/packages/apps/ferretdb/values.schema.json b/packages/apps/ferretdb/values.schema.json index d75c55f6..55899aa0 100644 --- a/packages/apps/ferretdb/values.schema.json +++ b/packages/apps/ferretdb/values.schema.json @@ -10,8 +10,8 @@ "enabled": false, "endpointURL": "http://minio-gateway-service:9000", "retentionPolicy": "30d", - "s3AccessKey": "oobaiRus9pah8PhohL1ThaeTa4UVa7gu", - "s3SecretKey": "ju3eum4dekeich9ahM1te8waeGai0oog", + "s3AccessKey": "\u003cyour-access-key\u003e", + "s3SecretKey": "\u003cyour-secret-key\u003e", "schedule": "0 2 * * * *" }, "required": [ @@ -47,12 +47,12 @@ "s3AccessKey": { "description": "Access key for S3, used for authentication", "type": "string", - "default": "oobaiRus9pah8PhohL1ThaeTa4UVa7gu" + "default": "\u003cyour-access-key\u003e" }, "s3SecretKey": { "description": "Secret key for S3, used for authentication", "type": "string", - "default": "ju3eum4dekeich9ahM1te8waeGai0oog" + "default": "\u003cyour-secret-key\u003e" }, "schedule": { "description": "Cron schedule for automated backups", @@ -125,7 +125,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -138,7 +138,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/ferretdb/values.yaml b/packages/apps/ferretdb/values.yaml index 18ba15ba..5abcb215 100644 --- a/packages/apps/ferretdb/values.yaml +++ b/packages/apps/ferretdb/values.yaml @@ -3,8 +3,8 @@ ## @param replicas {int} Number of replicas replicas: 2 ## @param resources {*resources} Explicit CPU and memory configuration for each FerretDB replica. When left empty, the preset defined in `resourcesPreset` is applied. -## @field resources.cpu {*quantity} CPU -## @field resources.memory {*quantity} Memory +## @field resources.cpu {*quantity} CPU available to each replica +## @field resources.memory {*quantity} Memory (RAM) available to each replica # resources: # cpu: 4000m # memory: 4Gi @@ -58,8 +58,8 @@ backup: retentionPolicy: 30d endpointURL: http://minio-gateway-service:9000 destinationPath: s3://bucket/path/to/folder/ - s3AccessKey: oobaiRus9pah8PhohL1ThaeTa4UVa7gu - s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog + s3AccessKey: "" + s3SecretKey: "" ## @section Bootstrap (recovery) parameters diff --git a/packages/apps/http-cache/README.md b/packages/apps/http-cache/README.md index c3d504df..f1ea73ee 100644 --- a/packages/apps/http-cache/README.md +++ b/packages/apps/http-cache/README.md @@ -81,8 +81,8 @@ The deployment architecture is illustrated in the diagram below: | `haproxy` | HAProxy configuration | `object` | `{}` | | `haproxy.replicas` | Number of HAProxy replicas | `int` | `2` | | `haproxy.resources` | Explicit CPU and memory configuration for each replica. When left empty, the preset defined in `resourcesPreset` is applied. | `object` | `{}` | -| `haproxy.resources.cpu` | CPU | `*quantity` | `null` | -| `haproxy.resources.memory` | Memory | `*quantity` | `null` | +| `haproxy.resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `haproxy.resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `haproxy.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `nano` | @@ -93,8 +93,8 @@ The deployment architecture is illustrated in the diagram below: | `nginx` | Nginx configuration | `object` | `{}` | | `nginx.replicas` | Number of Nginx replicas | `int` | `2` | | `nginx.resources` | Explicit CPU and memory configuration for each replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `null` | -| `nginx.resources.cpu` | CPU | `*quantity` | `null` | -| `nginx.resources.memory` | Memory | `*quantity` | `null` | +| `nginx.resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `nginx.resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `nginx.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `nano` | diff --git a/packages/apps/http-cache/values.schema.json b/packages/apps/http-cache/values.schema.json index 97597ff8..b79a35e6 100644 --- a/packages/apps/http-cache/values.schema.json +++ b/packages/apps/http-cache/values.schema.json @@ -40,7 +40,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -53,7 +53,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -107,7 +107,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -120,7 +120,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/http-cache/values.yaml b/packages/apps/http-cache/values.yaml index 3deb7090..644bc8e1 100644 --- a/packages/apps/http-cache/values.yaml +++ b/packages/apps/http-cache/values.yaml @@ -28,8 +28,8 @@ haproxy: ## @field haproxy.replicas {int} Number of HAProxy replicas replicas: 2 ## @field haproxy.resources {resources} Explicit CPU and memory configuration for each replica. When left empty, the preset defined in `resourcesPreset` is applied. - ## @field resources.cpu {*quantity} CPU - ## @field resources.memory {*quantity} Memory + ## @field resources.cpu {*quantity} CPU available to each replica + ## @field resources.memory {*quantity} Memory (RAM) available to each replica resources: {} # resources: # cpu: 4000m diff --git a/packages/apps/kafka/README.md b/packages/apps/kafka/README.md index bc3e5b90..00301364 100644 --- a/packages/apps/kafka/README.md +++ b/packages/apps/kafka/README.md @@ -27,8 +27,8 @@ | `kafka` | Kafka configuration | `object` | `{}` | | `kafka.replicas` | Number of Kafka replicas | `int` | `3` | | `kafka.resources` | Explicit CPU and memory configuration for each replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `null` | -| `kafka.resources.cpu` | CPU | `*quantity` | `null` | -| `kafka.resources.memory` | Memory | `*quantity` | `null` | +| `kafka.resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `kafka.resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `kafka.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `small` | | `kafka.size` | Persistent Volume size for Kafka | `quantity` | `10Gi` | | `kafka.storageClass` | StorageClass used to store the Kafka data | `string` | `""` | @@ -41,8 +41,8 @@ | `zookeeper` | Zookeeper configuration | `object` | `{}` | | `zookeeper.replicas` | Number of ZooKeeper replicas | `int` | `3` | | `zookeeper.resources` | Explicit CPU and memory configuration for each replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `null` | -| `zookeeper.resources.cpu` | CPU | `*quantity` | `null` | -| `zookeeper.resources.memory` | Memory | `*quantity` | `null` | +| `zookeeper.resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `zookeeper.resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `zookeeper.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `small` | | `zookeeper.size` | Persistent Volume size for ZooKeeper | `quantity` | `5Gi` | | `zookeeper.storageClass` | StorageClass used to store the ZooKeeper data | `string` | `""` | diff --git a/packages/apps/kafka/values.schema.json b/packages/apps/kafka/values.schema.json index 59f8f3d4..1b1a0971 100644 --- a/packages/apps/kafka/values.schema.json +++ b/packages/apps/kafka/values.schema.json @@ -35,7 +35,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -48,7 +48,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -157,7 +157,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -170,7 +170,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/kafka/values.yaml b/packages/apps/kafka/values.yaml index d8567dfd..20005c56 100644 --- a/packages/apps/kafka/values.yaml +++ b/packages/apps/kafka/values.yaml @@ -37,8 +37,8 @@ kafka: ## @field kafka.replicas {int} Number of Kafka replicas replicas: 3 ## @field kafka.resources {*resources} Explicit CPU and memory configuration for each replica. When left empty, the preset defined in `resourcesPreset` is applied. - ## @field resources.cpu {*quantity} CPU - ## @field resources.memory {*quantity} Memory + ## @field resources.cpu {*quantity} CPU available to each replica + ## @field resources.memory {*quantity} Memory (RAM) available to each replica # resources: # cpu: 4000m # memory: 4Gi diff --git a/packages/apps/kubernetes/README.md b/packages/apps/kubernetes/README.md index 7f96854e..9482557e 100644 --- a/packages/apps/kubernetes/README.md +++ b/packages/apps/kubernetes/README.md @@ -101,9 +101,9 @@ See the reference for components utilized in this service: | `nodeGroups[name].instanceType` | Virtual machine instance type | `string` | `""` | | `nodeGroups[name].ephemeralStorage` | Ephemeral storage size | `quantity` | `""` | | `nodeGroups[name].roles` | List of node's roles | `[]string` | `[]` | -| `nodeGroups[name].resources` | Available resources for each worker node | `object` | `{}` | -| `nodeGroups[name].resources.cpu` | Available CPU | `*quantity` | `null` | -| `nodeGroups[name].resources.memory` | Available memory (RAM) | `*quantity` | `null` | +| `nodeGroups[name].resources` | Resources available to each worker node | `object` | `{}` | +| `nodeGroups[name].resources.cpu` | CPU available to each worker node | `*quantity` | `null` | +| `nodeGroups[name].resources.memory` | Memory (RAM) available to each worker node | `*quantity` | `null` | | `nodeGroups[name].gpus` | List of GPUs to attach (WARN: NVIDIA driver requires at least 4 GiB of RAM) | `[]object` | `[]` | | `nodeGroups[name].gpus.name` | Name of GPU, such as "nvidia.com/AD102GL_L40S" | `string` | `""` | @@ -143,31 +143,31 @@ See the reference for components utilized in this service: ### Kubernetes Control Plane Configuration -| Name | Description | Type | Value | -| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -------- | -| `controlPlane` | Control Plane Configuration | `object` | `{}` | -| `controlPlane.replicas` | Number of replicas for Kubernetes control plane components. | `int` | `2` | -| `controlPlane.apiServer` | Control plane API server configuration. | `object` | `{}` | -| `controlPlane.apiServer.resources` | Explicit CPU and memory configuration for the API Server. When left empty, the preset defined in `resourcesPreset` is applied. | `object` | `{}` | -| `controlPlane.apiServer.resources.cpu` | Available CPU | `*quantity` | `null` | -| `controlPlane.apiServer.resources.memory` | Available memory (RAM) | `*quantity` | `null` | -| `controlPlane.apiServer.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. | `string` | `medium` | -| `controlPlane.controllerManager` | Controller Manager configuration. | `object` | `{}` | -| `controlPlane.controllerManager.resources` | Explicit CPU and memory configuration for the Controller Manager. When left empty, the preset defined in `resourcesPreset` is applied. | `object` | `{}` | -| `controlPlane.controllerManager.resources.cpu` | Available CPU | `*quantity` | `null` | -| `controlPlane.controllerManager.resources.memory` | Available memory (RAM) | `*quantity` | `null` | -| `controlPlane.controllerManager.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. | `string` | `micro` | -| `controlPlane.scheduler` | Scheduler configuration. | `object` | `{}` | -| `controlPlane.scheduler.resources` | Explicit CPU and memory configuration for the Scheduler. When left empty, the preset defined in `resourcesPreset` is applied. | `object` | `{}` | -| `controlPlane.scheduler.resources.cpu` | Available CPU | `*quantity` | `null` | -| `controlPlane.scheduler.resources.memory` | Available memory (RAM) | `*quantity` | `null` | -| `controlPlane.scheduler.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. | `string` | `micro` | -| `controlPlane.konnectivity` | Konnectivity configuration. | `object` | `{}` | -| `controlPlane.konnectivity.server` | Konnectivity server configuration. | `object` | `{}` | -| `controlPlane.konnectivity.server.resources` | Explicit CPU and memory configuration for Konnectivity. When left empty, the preset defined in `resourcesPreset` is applied. | `object` | `{}` | -| `controlPlane.konnectivity.server.resources.cpu` | Available CPU | `*quantity` | `null` | -| `controlPlane.konnectivity.server.resources.memory` | Available memory (RAM) | `*quantity` | `null` | -| `controlPlane.konnectivity.server.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. | `string` | `micro` | +| Name | Description | Type | Value | +| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -------- | +| `controlPlane` | Control Plane Configuration | `object` | `{}` | +| `controlPlane.replicas` | Number of replicas for Kubernetes control plane components. | `int` | `2` | +| `controlPlane.apiServer` | Control plane API server configuration. | `object` | `{}` | +| `controlPlane.apiServer.resources` | Explicit CPU and memory configuration for the API Server. When left empty, the preset defined in `resourcesPreset` is applied. | `object` | `{}` | +| `controlPlane.apiServer.resources.cpu` | CPU available to each worker node | `*quantity` | `null` | +| `controlPlane.apiServer.resources.memory` | Memory (RAM) available to each worker node | `*quantity` | `null` | +| `controlPlane.apiServer.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `medium` | +| `controlPlane.controllerManager` | Controller Manager configuration. | `object` | `{}` | +| `controlPlane.controllerManager.resources` | Explicit CPU and memory configuration for the Controller Manager. When left empty, the preset defined in `resourcesPreset` is applied. | `object` | `{}` | +| `controlPlane.controllerManager.resources.cpu` | CPU available to each worker node | `*quantity` | `null` | +| `controlPlane.controllerManager.resources.memory` | Memory (RAM) available to each worker node | `*quantity` | `null` | +| `controlPlane.controllerManager.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `micro` | +| `controlPlane.scheduler` | Scheduler configuration. | `object` | `{}` | +| `controlPlane.scheduler.resources` | Explicit CPU and memory configuration for the Scheduler. When left empty, the preset defined in `resourcesPreset` is applied. | `object` | `{}` | +| `controlPlane.scheduler.resources.cpu` | CPU available to each worker node | `*quantity` | `null` | +| `controlPlane.scheduler.resources.memory` | Memory (RAM) available to each worker node | `*quantity` | `null` | +| `controlPlane.scheduler.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `micro` | +| `controlPlane.konnectivity` | Konnectivity configuration. | `object` | `{}` | +| `controlPlane.konnectivity.server` | Konnectivity server configuration. | `object` | `{}` | +| `controlPlane.konnectivity.server.resources` | Explicit CPU and memory configuration for Konnectivity. When left empty, the preset defined in `resourcesPreset` is applied. | `object` | `{}` | +| `controlPlane.konnectivity.server.resources.cpu` | CPU available to each worker node | `*quantity` | `null` | +| `controlPlane.konnectivity.server.resources.memory` | Memory (RAM) available to each worker node | `*quantity` | `null` | +| `controlPlane.konnectivity.server.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `micro` | ## Parameter examples and reference diff --git a/packages/apps/kubernetes/values.schema.json b/packages/apps/kubernetes/values.schema.json index 7d7df2f4..5fb2eed1 100644 --- a/packages/apps/kubernetes/values.schema.json +++ b/packages/apps/kubernetes/values.schema.json @@ -329,7 +329,7 @@ "default": {}, "properties": { "cpu": { - "description": "Available CPU", + "description": "CPU available to each worker node", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -342,7 +342,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Available memory (RAM)", + "description": "Memory (RAM) available to each worker node", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -357,7 +357,7 @@ } }, "resourcesPreset": { - "description": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.", "type": "string", "default": "medium", "enum": [ @@ -390,7 +390,7 @@ "default": {}, "properties": { "cpu": { - "description": "Available CPU", + "description": "CPU available to each worker node", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -403,7 +403,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Available memory (RAM)", + "description": "Memory (RAM) available to each worker node", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -418,7 +418,7 @@ } }, "resourcesPreset": { - "description": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.", "type": "string", "default": "micro", "enum": [ @@ -464,7 +464,7 @@ "default": {}, "properties": { "cpu": { - "description": "Available CPU", + "description": "CPU available to each worker node", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -477,7 +477,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Available memory (RAM)", + "description": "Memory (RAM) available to each worker node", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -492,7 +492,7 @@ } }, "resourcesPreset": { - "description": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.", "type": "string", "default": "micro", "enum": [ @@ -532,7 +532,7 @@ "default": {}, "properties": { "cpu": { - "description": "Available CPU", + "description": "CPU available to each worker node", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -545,7 +545,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Available memory (RAM)", + "description": "Memory (RAM) available to each worker node", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -560,7 +560,7 @@ } }, "resourcesPreset": { - "description": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`.", "type": "string", "default": "micro", "enum": [ @@ -649,11 +649,11 @@ "type": "integer" }, "resources": { - "description": "Available resources for each worker node", + "description": "Resources available to each worker node", "type": "object", "properties": { "cpu": { - "description": "Available CPU", + "description": "CPU available to each worker node", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -666,7 +666,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Available memory (RAM)", + "description": "Memory (RAM) available to each worker node", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/kubernetes/values.yaml b/packages/apps/kubernetes/values.yaml index 83f5886c..fff70ce5 100644 --- a/packages/apps/kubernetes/values.yaml +++ b/packages/apps/kubernetes/values.yaml @@ -16,9 +16,9 @@ host: "" ## @field node.instanceType {string} Virtual machine instance type ## @field node.ephemeralStorage {quantity} Ephemeral storage size ## @field node.roles {[]string} List of node's roles -## @field node.resources {resources} Available resources for each worker node -## @field resources.cpu {*quantity} Available CPU -## @field resources.memory {*quantity} Available memory (RAM) +## @field node.resources {resources} Resources available to each worker node +## @field resources.cpu {*quantity} CPU available to each worker node +## @field resources.memory {*quantity} Memory (RAM) available to each worker node ## @field node.gpus {[]gpu} List of GPUs to attach (WARN: NVIDIA driver requires at least 4 GiB of RAM) ## @field gpu.name {string} Name of GPU, such as "nvidia.com/AD102GL_L40S" ## @@ -137,20 +137,20 @@ controlPlane: ## memory: 4Gi ## resources: {} - ## @field apiServer.resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. + ## @field apiServer.resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. resourcesPreset: "medium" ## @field controlPlane.controllerManager {controllerManager} Controller Manager configuration. controllerManager: ## @field controllerManager.resources {resources} Explicit CPU and memory configuration for the Controller Manager. When left empty, the preset defined in `resourcesPreset` is applied. - ## @field controllerManager.resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. + ## @field controllerManager.resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. resourcesPreset: "micro" resources: {} ## @field controlPlane.scheduler {scheduler} Scheduler configuration. scheduler: ## @field scheduler.resources {resources} Explicit CPU and memory configuration for the Scheduler. When left empty, the preset defined in `resourcesPreset` is applied. - ## @field scheduler.resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. + ## @field scheduler.resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. resourcesPreset: "micro" resources: {} @@ -159,6 +159,6 @@ controlPlane: ## @field konnectivity.server {konnectivityServer} Konnectivity server configuration. server: ## @field konnectivityServer.resources {resources} Explicit CPU and memory configuration for Konnectivity. When left empty, the preset defined in `resourcesPreset` is applied. - ## @field konnectivityServer.resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. + ## @field konnectivityServer.resourcesPreset {string enum:"nano,micro,small,medium,large,xlarge,2xlarge"} Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. resourcesPreset: "micro" resources: {} diff --git a/packages/apps/mysql/README.md b/packages/apps/mysql/README.md index c2d1ec09..72738185 100644 --- a/packages/apps/mysql/README.md +++ b/packages/apps/mysql/README.md @@ -14,12 +14,12 @@ This managed service is controlled by mariadb-operator, ensuring efficient manag ### How to switch master/slave replica -``` +```bash kubectl edit mariadb ``` update: -``` +```bash spec: replication: primary: @@ -28,7 +28,7 @@ spec: check status: -``` +```bash NAME READY STATUS PRIMARY POD AGE True Running app-db1-1 41d ``` @@ -36,13 +36,13 @@ NAME READY STATUS PRIMARY POD AGE ### How to restore backup: find snapshot: -``` +```bash restic -r s3:s3.example.org/mariadb-backups/database_name snapshots ``` restore: -``` +```bash restic -r s3:s3.example.org/mariadb-backups/database_name restore latest --target /tmp/ ``` @@ -51,15 +51,16 @@ more details: ### Known issues -- **Replication can't not be finished with various errors** -- **Replication can't be finised in case if binlog purged** - Until mariadbbackup is not used to bootstrap a node by mariadb-operator (this feature is not inmplemented yet), follow these manual steps to fix it: +- **Replication can't be finished with various errors** +- **Replication can't be finished in case if `binlog` purged** + + Until `mariadbbackup` is not used to bootstrap a node by mariadb-operator (this feature is not inmplemented yet), follow these manual steps to fix it: https://github.com/mariadb-operator/mariadb-operator/issues/141#issuecomment-1804760231 - **Corrupted indicies** Sometimes some indecies can be corrupted on master replica, you can recover them from slave: - ``` + ```bash mysqldump -h -P 3306 -u -p --column-statistics=0 ~/tmp/fix-table.sql mysql -h -P 3306 -u -p < ~/tmp/fix-table.sql ``` @@ -72,8 +73,8 @@ more details: | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `replicas` | Number of MariaDB replicas | `int` | `2` | | `resources` | Explicit CPU and memory configuration for each MariaDB replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `{}` | -| `resources.cpu` | CPU | `*quantity` | `null` | -| `resources.memory` | Memory | `*quantity` | `null` | +| `resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `nano` | | `size` | Persistent Volume Claim size, available for application data | `quantity` | `10Gi` | | `storageClass` | StorageClass used to store the data | `string` | `""` | @@ -100,12 +101,12 @@ more details: | `backup` | Backup configuration | `object` | `{}` | | `backup.enabled` | Enable regular backups, default is `false`. | `bool` | `false` | | `backup.s3Region` | AWS S3 region where backups are stored | `string` | `us-east-1` | -| `backup.s3Bucket` | S3 bucket used for storing backups | `string` | `s3.example.org/postgres-backups` | +| `backup.s3Bucket` | S3 bucket used for storing backups | `string` | `s3.example.org/mysql-backups` | | `backup.schedule` | Cron schedule for automated backups | `string` | `0 2 * * *` | | `backup.cleanupStrategy` | Retention strategy for cleaning up old backups | `string` | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` | -| `backup.s3AccessKey` | Access key for S3, used for authentication | `string` | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | -| `backup.s3SecretKey` | Secret key for S3, used for authentication | `string` | `ju3eum4dekeich9ahM1te8waeGai0oog` | -| `backup.resticPassword` | Password for Restic backup encryption | `string` | `ChaXoveekoh6eigh4siesheeda2quai0` | +| `backup.s3AccessKey` | Access key for S3, used for authentication | `string` | `` | +| `backup.s3SecretKey` | Secret key for S3, used for authentication | `string` | `` | +| `backup.resticPassword` | Password for Restic backup encryption | `string` | `` | ## Parameter examples and reference diff --git a/packages/apps/mysql/values.schema.json b/packages/apps/mysql/values.schema.json index 9cfb09fd..3c284a4e 100644 --- a/packages/apps/mysql/values.schema.json +++ b/packages/apps/mysql/values.schema.json @@ -8,11 +8,11 @@ "default": { "cleanupStrategy": "--keep-last=3 --keep-daily=3 --keep-within-weekly=1m", "enabled": false, - "resticPassword": "ChaXoveekoh6eigh4siesheeda2quai0", - "s3AccessKey": "oobaiRus9pah8PhohL1ThaeTa4UVa7gu", - "s3Bucket": "s3.example.org/postgres-backups", + "resticPassword": "\u003cpassword\u003e", + "s3AccessKey": "\u003cyour-access-key\u003e", + "s3Bucket": "s3.example.org/mysql-backups", "s3Region": "us-east-1", - "s3SecretKey": "ju3eum4dekeich9ahM1te8waeGai0oog", + "s3SecretKey": "\u003cyour-secret-key\u003e", "schedule": "0 2 * * *" }, "required": [ @@ -39,17 +39,17 @@ "resticPassword": { "description": "Password for Restic backup encryption", "type": "string", - "default": "ChaXoveekoh6eigh4siesheeda2quai0" + "default": "\u003cpassword\u003e" }, "s3AccessKey": { "description": "Access key for S3, used for authentication", "type": "string", - "default": "oobaiRus9pah8PhohL1ThaeTa4UVa7gu" + "default": "\u003cyour-access-key\u003e" }, "s3Bucket": { "description": "S3 bucket used for storing backups", "type": "string", - "default": "s3.example.org/postgres-backups" + "default": "s3.example.org/mysql-backups" }, "s3Region": { "description": "AWS S3 region where backups are stored", @@ -59,7 +59,7 @@ "s3SecretKey": { "description": "Secret key for S3, used for authentication", "type": "string", - "default": "ju3eum4dekeich9ahM1te8waeGai0oog" + "default": "\u003cyour-secret-key\u003e" }, "schedule": { "description": "Cron schedule for automated backups", @@ -114,7 +114,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -127,7 +127,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/mysql/values.yaml b/packages/apps/mysql/values.yaml index 0c4959f5..4d18dc31 100644 --- a/packages/apps/mysql/values.yaml +++ b/packages/apps/mysql/values.yaml @@ -3,8 +3,8 @@ ## @param replicas {int} Number of MariaDB replicas replicas: 2 ## @param resources {*resources} Explicit CPU and memory configuration for each MariaDB replica. When left empty, the preset defined in `resourcesPreset` is applied. -## @field resources.cpu {*quantity} CPU -## @field resources.memory {*quantity} Memory +## @field resources.cpu {*quantity} CPU available to each replica +## @field resources.memory {*quantity} Memory (RAM) available to each replica resources: {} # resources: # cpu: 4000m @@ -64,10 +64,10 @@ databases: {} backup: enabled: false s3Region: us-east-1 - s3Bucket: s3.example.org/postgres-backups + s3Bucket: "s3.example.org/mysql-backups" schedule: "0 2 * * *" cleanupStrategy: "--keep-last=3 --keep-daily=3 --keep-within-weekly=1m" - s3AccessKey: oobaiRus9pah8PhohL1ThaeTa4UVa7gu - s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog - resticPassword: ChaXoveekoh6eigh4siesheeda2quai0 + s3AccessKey: "" + s3SecretKey: "" + resticPassword: "" diff --git a/packages/apps/nats/README.md b/packages/apps/nats/README.md index 04359409..293cb944 100644 --- a/packages/apps/nats/README.md +++ b/packages/apps/nats/README.md @@ -11,8 +11,8 @@ It provides a data layer for cloud native applications, IoT messaging, and micro | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `replicas` | Number of replicas | `int` | `2` | | `resources` | Explicit CPU and memory configuration for each NATS replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `{}` | -| `resources.cpu` | CPU | `*quantity` | `null` | -| `resources.memory` | Memory | `*quantity` | `null` | +| `resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `nano` | | `storageClass` | StorageClass used to store the data | `string` | `""` | | `external` | Enable external access from outside the cluster | `bool` | `false` | diff --git a/packages/apps/nats/values.schema.json b/packages/apps/nats/values.schema.json index af8ce532..ffbaf94c 100644 --- a/packages/apps/nats/values.schema.json +++ b/packages/apps/nats/values.schema.json @@ -73,7 +73,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -86,7 +86,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/nats/values.yaml b/packages/apps/nats/values.yaml index f948f97d..5cd40a7c 100644 --- a/packages/apps/nats/values.yaml +++ b/packages/apps/nats/values.yaml @@ -3,8 +3,8 @@ ## @param replicas {int} Number of replicas replicas: 2 ## @param resources {*resources} Explicit CPU and memory configuration for each NATS replica. When left empty, the preset defined in `resourcesPreset` is applied. -## @field resources.cpu {*quantity} CPU -## @field resources.memory {*quantity} Memory +## @field resources.cpu {*quantity} CPU available to each replica +## @field resources.memory {*quantity} Memory (RAM) available to each replica resources: {} # resources: # cpu: 4000m diff --git a/packages/apps/postgres/README.md b/packages/apps/postgres/README.md index c312c3b7..e0ab053a 100644 --- a/packages/apps/postgres/README.md +++ b/packages/apps/postgres/README.md @@ -70,8 +70,8 @@ See: | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `replicas` | Number of Postgres replicas | `int` | `2` | | `resources` | Explicit CPU and memory configuration for each PostgreSQL replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `{}` | -| `resources.cpu` | CPU | `*quantity` | `null` | -| `resources.memory` | Memory | `*quantity` | `null` | +| `resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `micro` | | `size` | Persistent Volume Claim size, available for application data | `quantity` | `10Gi` | | `storageClass` | StorageClass used to store the data | `string` | `""` | @@ -108,8 +108,8 @@ See: | `backup.retentionPolicy` | Retention policy | `*string` | `30d` | | `backup.destinationPath` | Path to store the backup (i.e. s3://bucket/path/to/folder) | `*string` | `s3://bucket/path/to/folder/` | | `backup.endpointURL` | S3 Endpoint used to upload data to the cloud | `*string` | `http://minio-gateway-service:9000` | -| `backup.s3AccessKey` | Access key for S3, used for authentication | `*string` | `` | -| `backup.s3SecretKey` | Secret key for S3, used for authentication | `*string` | `` | +| `backup.s3AccessKey` | Access key for S3, used for authentication | `*string` | `` | +| `backup.s3SecretKey` | Secret key for S3, used for authentication | `*string` | `` | ### Bootstrap (recovery) parameters diff --git a/packages/apps/postgres/values.schema.json b/packages/apps/postgres/values.schema.json index ac56acbd..fb823721 100644 --- a/packages/apps/postgres/values.schema.json +++ b/packages/apps/postgres/values.schema.json @@ -10,8 +10,8 @@ "enabled": false, "endpointURL": "http://minio-gateway-service:9000", "retentionPolicy": "30d", - "s3AccessKey": "\u003caccess key\u003e", - "s3SecretKey": "\u003csecret key\u003e", + "s3AccessKey": "\u003cyour-access-key\u003e", + "s3SecretKey": "\u003cyour-secret-key\u003e", "schedule": "0 2 * * * *" }, "properties": { @@ -38,12 +38,12 @@ "s3AccessKey": { "description": "Access key for S3, used for authentication", "type": "string", - "default": "\u003caccess key\u003e" + "default": "\u003cyour-access-key\u003e" }, "s3SecretKey": { "description": "Secret key for S3, used for authentication", "type": "string", - "default": "\u003csecret key\u003e" + "default": "\u003cyour-secret-key\u003e" }, "schedule": { "description": "Cron schedule for automated backups", @@ -188,7 +188,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -201,7 +201,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/postgres/values.yaml b/packages/apps/postgres/values.yaml index f6f3849f..4444486c 100644 --- a/packages/apps/postgres/values.yaml +++ b/packages/apps/postgres/values.yaml @@ -3,8 +3,8 @@ ## @param replicas {int} Number of Postgres replicas replicas: 2 ## @param resources {*resources} Explicit CPU and memory configuration for each PostgreSQL replica. When left empty, the preset defined in `resourcesPreset` is applied. -## @field resources.cpu {*quantity} CPU -## @field resources.memory {*quantity} Memory +## @field resources.cpu {*quantity} CPU available to each replica +## @field resources.memory {*quantity} Memory (RAM) available to each replica resources: {} # resources: # cpu: 4000m @@ -91,8 +91,8 @@ backup: destinationPath: "s3://bucket/path/to/folder/" endpointURL: "http://minio-gateway-service:9000" schedule: "0 2 * * * *" - s3AccessKey: "" - s3SecretKey: "" + s3AccessKey: "" + s3SecretKey: "" ## @section Bootstrap (recovery) parameters diff --git a/packages/apps/rabbitmq/README.md b/packages/apps/rabbitmq/README.md index cfcf32e9..9699ccfa 100644 --- a/packages/apps/rabbitmq/README.md +++ b/packages/apps/rabbitmq/README.md @@ -17,8 +17,8 @@ The service utilizes official RabbitMQ operator. This ensures the reliability an | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `replicas` | Number of RabbitMQ replicas | `int` | `3` | | `resources` | Explicit CPU and memory configuration for each RabbitMQ replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `{}` | -| `resources.cpu` | CPU | `*quantity` | `null` | -| `resources.memory` | Memory | `*quantity` | `null` | +| `resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `nano` | | `size` | Persistent Volume Claim size, available for application data | `quantity` | `10Gi` | | `storageClass` | StorageClass used to store the data | `string` | `""` | @@ -35,10 +35,6 @@ The service utilizes official RabbitMQ operator. This ensures the reliability an | `vhosts[name].roles` | Virtual host roles list | `object` | `{}` | | `vhosts[name].roles.admin` | List of admin users | `[]string` | `[]` | | `vhosts[name].roles.readonly` | List of readonly users | `[]string` | `[]` | -| `vhost` | Virtual Host | `object` | `{}` | -| `vhost.roles` | Virtual host roles list | `object` | `{}` | -| `vhost.roles.admin` | List of admin users | `[]string` | `[]` | -| `vhost.roles.readonly` | List of readonly users | `[]string` | `[]` | ## Parameter examples and reference diff --git a/packages/apps/rabbitmq/values.schema.json b/packages/apps/rabbitmq/values.schema.json index fab480b8..3278fd99 100644 --- a/packages/apps/rabbitmq/values.schema.json +++ b/packages/apps/rabbitmq/values.schema.json @@ -18,7 +18,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -31,7 +31,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -91,35 +91,6 @@ } } }, - "vhost": { - "description": "Virtual Host", - "type": "object", - "required": [ - "roles" - ], - "properties": { - "roles": { - "description": "Virtual host roles list", - "type": "object", - "properties": { - "admin": { - "description": "List of admin users", - "type": "array", - "items": { - "type": "string" - } - }, - "readonly": { - "description": "List of readonly users", - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, "vhosts": { "description": "Virtual Hosts configuration", "type": "object", diff --git a/packages/apps/rabbitmq/values.yaml b/packages/apps/rabbitmq/values.yaml index b5034b51..30dfe2e8 100644 --- a/packages/apps/rabbitmq/values.yaml +++ b/packages/apps/rabbitmq/values.yaml @@ -3,8 +3,8 @@ ## @param replicas {int} Number of RabbitMQ replicas replicas: 3 ## @param resources {*resources} Explicit CPU and memory configuration for each RabbitMQ replica. When left empty, the preset defined in `resourcesPreset` is applied. -## @field resources.cpu {*quantity} CPU -## @field resources.memory {*quantity} Memory +## @field resources.cpu {*quantity} CPU available to each replica +## @field resources.memory {*quantity} Memory (RAM) available to each replica # resources: # cpu: 4000m # memory: 4Gi @@ -36,7 +36,6 @@ external: false users: {} ## @param vhosts {map[string]vhost} Virtual Hosts configuration -## @param vhost {vhost} Virtual Host ## @field vhost.roles {roles} Virtual host roles list ## @field roles.admin {[]string} List of admin users ## @field roles.readonly {[]string} List of readonly users diff --git a/packages/apps/redis/README.md b/packages/apps/redis/README.md index 90b211d6..206e26e8 100644 --- a/packages/apps/redis/README.md +++ b/packages/apps/redis/README.md @@ -17,8 +17,8 @@ Service utilizes the Spotahome Redis Operator for efficient management and orche | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `replicas` | Number of Redis replicas | `int` | `2` | | `resources` | Explicit CPU and memory configuration for each Redis replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `{}` | -| `resources.cpu` | CPU | `*quantity` | `null` | -| `resources.memory` | Memory | `*quantity` | `null` | +| `resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `nano` | | `size` | Persistent Volume Claim size, available for application data | `quantity` | `1Gi` | | `storageClass` | StorageClass used to store the data | `string` | `""` | diff --git a/packages/apps/redis/values.schema.json b/packages/apps/redis/values.schema.json index 03f00f8a..0c94e967 100644 --- a/packages/apps/redis/values.schema.json +++ b/packages/apps/redis/values.schema.json @@ -23,7 +23,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -36,7 +36,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/redis/values.yaml b/packages/apps/redis/values.yaml index a4deab27..518f43d4 100644 --- a/packages/apps/redis/values.yaml +++ b/packages/apps/redis/values.yaml @@ -3,8 +3,8 @@ ## @param replicas {int} Number of Redis replicas replicas: 2 ## @param resources {*resources} Explicit CPU and memory configuration for each Redis replica. When left empty, the preset defined in `resourcesPreset` is applied. -## @field resources.cpu {*quantity} CPU -## @field resources.memory {*quantity} Memory +## @field resources.cpu {*quantity} CPU available to each replica +## @field resources.memory {*quantity} Memory (RAM) available to each replica resources: {} # resources: # cpu: 4000m diff --git a/packages/apps/tcp-balancer/README.md b/packages/apps/tcp-balancer/README.md index 4e5eda0f..0409ea3c 100644 --- a/packages/apps/tcp-balancer/README.md +++ b/packages/apps/tcp-balancer/README.md @@ -16,8 +16,8 @@ Managed TCP Load Balancer Service efficiently utilizes HAProxy for load balancin | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | ------- | | `replicas` | Number of HAProxy replicas | `int` | `2` | | `resources` | Explicit CPU and memory configuration for each TCP Balancer replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `null` | -| `resources.cpu` | CPU | `*quantity` | `null` | -| `resources.memory` | Memory | `*quantity` | `null` | +| `resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `nano` | | `external` | Enable external access from outside the cluster | `bool` | `false` | diff --git a/packages/apps/tcp-balancer/values.schema.json b/packages/apps/tcp-balancer/values.schema.json index 5b87986b..c35ed12e 100644 --- a/packages/apps/tcp-balancer/values.schema.json +++ b/packages/apps/tcp-balancer/values.schema.json @@ -76,7 +76,7 @@ "type": "object", "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -89,7 +89,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/tcp-balancer/values.yaml b/packages/apps/tcp-balancer/values.yaml index 83bcf0d4..b763ceb3 100644 --- a/packages/apps/tcp-balancer/values.yaml +++ b/packages/apps/tcp-balancer/values.yaml @@ -3,8 +3,8 @@ ## @param replicas {int} Number of HAProxy replicas replicas: 2 ## @param resources {*resources} Explicit CPU and memory configuration for each TCP Balancer replica. When left empty, the preset defined in `resourcesPreset` is applied. -## @field resources.cpu {*quantity} CPU -## @field resources.memory {*quantity} Memory +## @field resources.cpu {*quantity} CPU available to each replica +## @field resources.memory {*quantity} Memory (RAM) available to each replica #resources: {} # resources: # cpu: 4000m diff --git a/packages/apps/virtual-machine/README.md b/packages/apps/virtual-machine/README.md index 85320639..8bfb54eb 100644 --- a/packages/apps/virtual-machine/README.md +++ b/packages/apps/virtual-machine/README.md @@ -36,27 +36,27 @@ virtctl ssh @ ### Common parameters -| Name | Description | Type | Value | -| ------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------- | ------------ | -| `external` | Enable external access from outside the cluster | `bool` | `false` | -| `externalMethod` | Specify method to pass through the traffic to the virtual machine. Allowed values: `WholeIP` and `PortList` | `string` | `PortList` | -| `externalPorts` | Specify ports to forward from outside the cluster | `[]int` | `[22]` | -| `running` | if the virtual machine should be running | `bool` | `true` | -| `instanceType` | Virtual Machine instance type | `string` | `u1.medium` | -| `instanceProfile` | Virtual Machine preferences profile | `string` | `ubuntu` | -| `systemDisk` | System disk configuration | `object` | `{}` | -| `systemDisk.image` | The base image for the virtual machine. Allowed values: `ubuntu`, `cirros`, `alpine`, `fedora` and `talos` | `string` | `ubuntu` | -| `systemDisk.storage` | The size of the disk allocated for the virtual machine | `string` | `5Gi` | -| `systemDisk.storageClass` | StorageClass used to store the data | `*string` | `replicated` | -| `gpus` | List of GPUs to attach | `[]object` | `[]` | -| `gpus[i].name` | The name of the GPU to attach. This should match the GPU resource name in the cluster. | `string` | `""` | -| `resources` | Resources | `*object` | `{}` | -| `resources.cpu` | The number of CPU cores allocated to the virtual machine | `*quantity` | `null` | -| `resources.sockets` | The number of CPU sockets allocated to the virtual machine (used to define vCPU topology) | `*quantity` | `null` | -| `resources.memory` | The amount of memory allocated to the virtual machine | `*quantity` | `null` | -| `sshKeys` | List of SSH public keys for authentication. Can be a single key or a list of keys. | `[]string` | `[]` | -| `cloudInit` | cloud-init user data config. See cloud-init documentation for more details. | `string` | `""` | -| `cloudInitSeed` | A seed string to generate an SMBIOS UUID for the VM. | `string` | `""` | +| Name | Description | Type | Value | +| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------ | +| `external` | Enable external access from outside the cluster | `bool` | `false` | +| `externalMethod` | Specify method to pass through the traffic to the virtual machine. Allowed values: `WholeIP` and `PortList` | `string` | `PortList` | +| `externalPorts` | Specify ports to forward from outside the cluster | `[]int` | `[22]` | +| `running` | if the virtual machine should be running | `bool` | `true` | +| `instanceType` | Virtual Machine instance type | `string` | `u1.medium` | +| `instanceProfile` | Virtual Machine preferences profile | `string` | `ubuntu` | +| `systemDisk` | System disk configuration | `object` | `{}` | +| `systemDisk.image` | The base image for the virtual machine. Allowed values: `ubuntu`, `cirros`, `alpine`, `fedora` and `talos` | `string` | `ubuntu` | +| `systemDisk.storage` | The size of the disk allocated for the virtual machine | `string` | `5Gi` | +| `systemDisk.storageClass` | StorageClass used to store the data | `*string` | `replicated` | +| `gpus` | List of GPUs to attach | `[]object` | `[]` | +| `gpus[i].name` | The name of the GPU to attach. This should match the GPU resource name in the cluster. | `string` | `""` | +| `resources` | Resources | `*object` | `{}` | +| `resources.cpu` | The number of CPU cores allocated to the virtual machine | `*quantity` | `null` | +| `resources.sockets` | The number of CPU sockets allocated to the virtual machine (used to define vCPU topology) | `*quantity` | `null` | +| `resources.memory` | The amount of memory allocated to the virtual machine | `*quantity` | `null` | +| `sshKeys` | List of SSH public keys for authentication. Can be a single key or a list of keys. | `[]string` | `[]` | +| `cloudInit` | Cloud-init user data config. See cloud-init documentation for more details: [format](https://cloudinit.readthedocs.io/en/latest/explanation/format.html), [examples](https://cloudinit.readthedocs.io/en/latest/reference/examples.html). | `string` | `""` | +| `cloudInitSeed` | A seed string to generate an SMBIOS UUID for the VM. | `string` | `""` | ## U Series diff --git a/packages/apps/virtual-machine/values.schema.json b/packages/apps/virtual-machine/values.schema.json index 8df250fc..dd609e9d 100644 --- a/packages/apps/virtual-machine/values.schema.json +++ b/packages/apps/virtual-machine/values.schema.json @@ -3,7 +3,7 @@ "type": "object", "properties": { "cloudInit": { - "description": "cloud-init user data config. See cloud-init documentation for more details.", + "description": "Cloud-init user data config. See cloud-init documentation for more details: [format](https://cloudinit.readthedocs.io/en/latest/explanation/format.html), [examples](https://cloudinit.readthedocs.io/en/latest/reference/examples.html).", "type": "string" }, "cloudInitSeed": { diff --git a/packages/apps/virtual-machine/values.yaml b/packages/apps/virtual-machine/values.yaml index 95db215a..c0046d96 100644 --- a/packages/apps/virtual-machine/values.yaml +++ b/packages/apps/virtual-machine/values.yaml @@ -55,7 +55,7 @@ resources: {} ## sshKeys: [] -## @param cloudInit {string} cloud-init user data config. See cloud-init documentation for more details. +## @param cloudInit {string} Cloud-init user data config. See cloud-init documentation for more details: [format](https://cloudinit.readthedocs.io/en/latest/explanation/format.html), [examples](https://cloudinit.readthedocs.io/en/latest/reference/examples.html). ## - https://cloudinit.readthedocs.io/en/latest/explanation/format.html ## - https://cloudinit.readthedocs.io/en/latest/reference/examples.html ## Example: diff --git a/packages/apps/vm-instance/README.md b/packages/apps/vm-instance/README.md index b2d8ed11..1ef09fe1 100644 --- a/packages/apps/vm-instance/README.md +++ b/packages/apps/vm-instance/README.md @@ -54,7 +54,7 @@ virtctl ssh @ | `resources.memory` | The amount of memory allocated to the virtual machine | `*quantity` | `null` | | `resources.sockets` | The number of CPU sockets allocated to the virtual machine (used to define vCPU topology) | `*quantity` | `null` | | `sshKeys` | List of SSH public keys for authentication. Can be a single key or a list of keys. | `[]string` | `[]` | -| `cloudInit` | cloud-init user data config. See cloud-init documentation for more details: [format](https://cloudinit.readthedocs.io/en/latest/explanation/format.html), [examples](https://cloudinit.readthedocs.io/en/latest/explanation/format.html). | `string` | `""` | +| `cloudInit` | Cloud-init user data config. See cloud-init documentation for more details: [format](https://cloudinit.readthedocs.io/en/latest/explanation/format.html), [examples](https://cloudinit.readthedocs.io/en/latest/reference/examples.html). | `string` | `""` | | `cloudInitSeed` | A seed string to generate an SMBIOS UUID for the VM. | `string` | `""` | diff --git a/packages/apps/vm-instance/values.schema.json b/packages/apps/vm-instance/values.schema.json index 9f28cf84..b19c886f 100644 --- a/packages/apps/vm-instance/values.schema.json +++ b/packages/apps/vm-instance/values.schema.json @@ -3,7 +3,7 @@ "type": "object", "properties": { "cloudInit": { - "description": "cloud-init user data config. See cloud-init documentation for more details: [format](https://cloudinit.readthedocs.io/en/latest/explanation/format.html), [examples](https://cloudinit.readthedocs.io/en/latest/explanation/format.html).", + "description": "Cloud-init user data config. See cloud-init documentation for more details: [format](https://cloudinit.readthedocs.io/en/latest/explanation/format.html), [examples](https://cloudinit.readthedocs.io/en/latest/reference/examples.html).", "type": "string" }, "cloudInitSeed": { diff --git a/packages/apps/vm-instance/values.yaml b/packages/apps/vm-instance/values.yaml index 0272edfe..f41b17e9 100644 --- a/packages/apps/vm-instance/values.yaml +++ b/packages/apps/vm-instance/values.yaml @@ -52,7 +52,7 @@ resources: {} ## sshKeys: [] -## @param cloudInit {string} cloud-init user data config. See cloud-init documentation for more details: [format](https://cloudinit.readthedocs.io/en/latest/explanation/format.html), [examples](https://cloudinit.readthedocs.io/en/latest/explanation/format.html). +## @param cloudInit {string} Cloud-init user data config. See cloud-init documentation for more details: [format](https://cloudinit.readthedocs.io/en/latest/explanation/format.html), [examples](https://cloudinit.readthedocs.io/en/latest/reference/examples.html). ## - https://cloudinit.readthedocs.io/en/latest/explanation/format.html ## - https://cloudinit.readthedocs.io/en/latest/reference/examples.html ## Example: diff --git a/packages/apps/vpn/README.md b/packages/apps/vpn/README.md index ac3cd3c8..4e445f56 100644 --- a/packages/apps/vpn/README.md +++ b/packages/apps/vpn/README.md @@ -23,8 +23,8 @@ Furthermore, Shadowbox is compatible with standard Shadowsocks clients, providin | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `replicas` | Number of VPN server replicas | `int` | `2` | | `resources` | Explicit CPU and memory configuration for each VPN server replica. When left empty, the preset defined in `resourcesPreset` is applied. | `*object` | `{}` | -| `resources.cpu` | CPU | `*quantity` | `null` | -| `resources.memory` | Memory | `*quantity` | `null` | +| `resources.cpu` | CPU available to each replica | `*quantity` | `null` | +| `resources.memory` | Memory (RAM) available to each replica | `*quantity` | `null` | | `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. | `string` | `nano` | | `external` | Enable external access from outside the cluster | `bool` | `false` | diff --git a/packages/apps/vpn/values.schema.json b/packages/apps/vpn/values.schema.json index 8c2cc999..1dbf277e 100644 --- a/packages/apps/vpn/values.schema.json +++ b/packages/apps/vpn/values.schema.json @@ -30,7 +30,7 @@ "default": {}, "properties": { "cpu": { - "description": "CPU", + "description": "CPU available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { @@ -43,7 +43,7 @@ "x-kubernetes-int-or-string": true }, "memory": { - "description": "Memory", + "description": "Memory (RAM) available to each replica", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "anyOf": [ { diff --git a/packages/apps/vpn/values.yaml b/packages/apps/vpn/values.yaml index 7b761acd..e8879d5f 100644 --- a/packages/apps/vpn/values.yaml +++ b/packages/apps/vpn/values.yaml @@ -3,8 +3,8 @@ ## @param replicas {int} Number of VPN server replicas replicas: 2 ## @param resources {*resources} Explicit CPU and memory configuration for each VPN server replica. When left empty, the preset defined in `resourcesPreset` is applied. -## @field resources.cpu {*quantity} CPU -## @field resources.memory {*quantity} Memory +## @field resources.cpu {*quantity} CPU available to each replica +## @field resources.memory {*quantity} Memory (RAM) available to each replica resources: {} # resources: # cpu: 4000m