diff --git a/packages/apps/clickhouse/README.md b/packages/apps/clickhouse/README.md index acb2dcb4..c96f6745 100644 --- a/packages/apps/clickhouse/README.md +++ b/packages/apps/clickhouse/README.md @@ -1,18 +1,19 @@ -# Managed Clickhouse Service +# Managed ClickHouse Service ClickHouse is an open source high-performance and column-oriented SQL database management system (DBMS). It is used for online analytical processing (OLAP). -Cozystack platform uses Altinity operator to provide ClickHouse. -### How to restore backup: +### How to restore backup from S3 -1. Find a snapshot: - ``` +1. Find the snapshot: + + ```bash restic -r s3:s3.example.org/clickhouse-backups/table_name snapshots ``` 2. Restore it: - ``` + + ```bash restic -r s3:s3.example.org/clickhouse-backups/table_name restore latest --target /tmp/ ``` @@ -39,32 +40,41 @@ For more details, read [Restic: Effective Backup from Stdin](https://blog.aenix. ### Backup parameters -| Name | Description | Value | -| ------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------ | -| `backup.enabled` | Enable periodic backups | `false` | -| `backup.s3Region` | AWS S3 region where backups are stored | `us-east-1` | -| `backup.s3Bucket` | S3 bucket used for storing backups | `s3.example.org/clickhouse-backups` | -| `backup.schedule` | Cron schedule for automated backups | `0 2 * * *` | -| `backup.cleanupStrategy` | Retention strategy for cleaning up old backups | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` | -| `backup.s3AccessKey` | Access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | -| `backup.s3SecretKey` | Secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` | -| `backup.resticPassword` | Password for Restic backup encryption | `ChaXoveekoh6eigh4siesheeda2quai0` | -| `resources` | Explicit CPU/memory resource requests and limits for the Clickhouse service | `{}` | -| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. | `small` | +| Name | Description | Value | +| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | +| `backup.enabled` | Enable periodic backups | `false` | +| `backup.s3Region` | AWS S3 region where backups are stored | `us-east-1` | +| `backup.s3Bucket` | S3 bucket used for storing backups | `s3.example.org/clickhouse-backups` | +| `backup.schedule` | Cron schedule for automated backups | `0 2 * * *` | +| `backup.cleanupStrategy` | Retention strategy for cleaning up old backups | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` | +| `backup.s3AccessKey` | Access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | +| `backup.s3SecretKey` | Secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` | +| `backup.resticPassword` | Password for Restic backup encryption | `ChaXoveekoh6eigh4siesheeda2quai0` | +| `resources` | Explicit CPU and memory configuration for each ClickHouse replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `small` | +## Parameter examples and reference -In production environments, it's recommended to set `resources` explicitly. -Example of `resources`: +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. ```yaml resources: - limits: - cpu: 4000m - memory: 4Gi - requests: - cpu: 100m - memory: 512Mi + cpu: 4000m + memory: 4Gi ``` -Allowed values for `resourcesPreset` are `none`, `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. -This value is ignored if `resources` value is set. +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | diff --git a/packages/apps/clickhouse/values.schema.json b/packages/apps/clickhouse/values.schema.json index e105588a..ddc88b97 100644 --- a/packages/apps/clickhouse/values.schema.json +++ b/packages/apps/clickhouse/values.schema.json @@ -79,12 +79,12 @@ }, "resources": { "type": "object", - "description": "Explicit CPU/memory resource requests and limits for the Clickhouse service", + "description": "Explicit CPU and memory configuration for each ClickHouse replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly.", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "small", "enum": [ "none", diff --git a/packages/apps/clickhouse/values.yaml b/packages/apps/clickhouse/values.yaml index a49ddc6b..2ddfbbb2 100644 --- a/packages/apps/clickhouse/values.yaml +++ b/packages/apps/clickhouse/values.yaml @@ -47,11 +47,11 @@ backup: s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog resticPassword: ChaXoveekoh6eigh4siesheeda2quai0 -## @param resources Explicit CPU/memory resource requests and limits for the Clickhouse service +## @param resources Explicit CPU and memory configuration for each ClickHouse replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi -## @param resourcesPreset Use a common resources preset when `resources` is not set explicitly. +## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "small" diff --git a/packages/apps/ferretdb/README.md b/packages/apps/ferretdb/README.md index 47b367f1..75592c08 100644 --- a/packages/apps/ferretdb/README.md +++ b/packages/apps/ferretdb/README.md @@ -1,17 +1,21 @@ # Managed FerretDB Service +FerretDB is an open source MongoDB alternative. +It translates MongoDB wire protocol queries to SQL and can be used as a direct replacement for MongoDB 5.0+. +Internally, FerretDB service is backed by Postgres. + ## Parameters ### Common parameters -| Name | Description | Value | -| ------------------------ | ----------------------------------------------------------------------------------------------------------------------- | ------- | -| `external` | Enable external access from outside the cluster | `false` | -| `size` | Persistent Volume size | `10Gi` | -| `replicas` | Number of Postgres replicas | `2` | -| `storageClass` | StorageClass used to store the data | `""` | -| `quorum.minSyncReplicas` | Minimum number of synchronous replicas that must acknowledge a transaction before it is considered committed. | `0` | -| `quorum.maxSyncReplicas` | Maximum number of synchronous replicas that can acknowledge a transaction (must be lower than the number of instances). | `0` | +| Name | Description | Value | +| ------------------------ | --------------------------------------------------------------------------------------------------------------------------- | ------- | +| `external` | Enable external access from outside the cluster | `false` | +| `size` | Persistent Volume size | `10Gi` | +| `replicas` | Number of replicas | `2` | +| `storageClass` | StorageClass used to store the data | `""` | +| `quorum.minSyncReplicas` | Minimum number of synchronous replicas that must acknowledge a transaction before it is considered committed | `0` | +| `quorum.maxSyncReplicas` | Maximum number of synchronous replicas that can acknowledge a transaction (must be lower than the total number of replicas) | `0` | ### Configuration parameters @@ -21,17 +25,43 @@ ### Backup parameters -| Name | Description | Value | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | -| `backup.enabled` | Enable pereiodic backups | `false` | -| `backup.s3Region` | The AWS S3 region where backups are stored | `us-east-1` | -| `backup.s3Bucket` | The S3 bucket used for storing backups | `s3.example.org/postgres-backups` | -| `backup.schedule` | Cron schedule for automated backups | `0 2 * * *` | -| `backup.cleanupStrategy` | The strategy for cleaning up old backups | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` | -| `backup.s3AccessKey` | The access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | -| `backup.s3SecretKey` | The secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` | -| `backup.resticPassword` | The password for Restic backup encryption | `ChaXoveekoh6eigh4siesheeda2quai0` | -| `resources` | Resources | `{}` | -| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `nano` | +| Name | Description | Value | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | +| `backup.enabled` | Enable periodic backups | `false` | +| `backup.s3Region` | The AWS S3 region where backups are stored | `us-east-1` | +| `backup.s3Bucket` | The S3 bucket used for storing backups | `s3.example.org/postgres-backups` | +| `backup.schedule` | Cron schedule for automated backups | `0 2 * * *` | +| `backup.cleanupStrategy` | The strategy for cleaning up old backups | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` | +| `backup.s3AccessKey` | The access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | +| `backup.s3SecretKey` | The secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` | +| `backup.resticPassword` | The password for Restic backup encryption | `ChaXoveekoh6eigh4siesheeda2quai0` | +| `resources` | Explicit CPU and memory configuration for each FerretDB replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | + +## Parameter examples and reference + +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. + +```yaml +resources: + cpu: 4000m + memory: 4Gi +``` + +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | diff --git a/packages/apps/ferretdb/values.schema.json b/packages/apps/ferretdb/values.schema.json index 8e2e1f80..de59c190 100644 --- a/packages/apps/ferretdb/values.schema.json +++ b/packages/apps/ferretdb/values.schema.json @@ -14,7 +14,7 @@ }, "replicas": { "type": "number", - "description": "Number of Postgres replicas", + "description": "Number of replicas", "default": 2 }, "storageClass": { @@ -27,12 +27,12 @@ "properties": { "minSyncReplicas": { "type": "number", - "description": "Minimum number of synchronous replicas that must acknowledge a transaction before it is considered committed.", + "description": "Minimum number of synchronous replicas that must acknowledge a transaction before it is considered committed", "default": 0 }, "maxSyncReplicas": { "type": "number", - "description": "Maximum number of synchronous replicas that can acknowledge a transaction (must be lower than the number of instances).", + "description": "Maximum number of synchronous replicas that can acknowledge a transaction (must be lower than the total number of replicas)", "default": 0 } } @@ -42,7 +42,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Enable pereiodic backups", + "description": "Enable periodic backups", "default": false }, "s3Region": { @@ -84,12 +84,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each FerretDB replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "nano", "enum": [ "none", diff --git a/packages/apps/ferretdb/values.yaml b/packages/apps/ferretdb/values.yaml index 2963b7eb..c1f1356e 100644 --- a/packages/apps/ferretdb/values.yaml +++ b/packages/apps/ferretdb/values.yaml @@ -2,7 +2,7 @@ ## @param external Enable external access from outside the cluster ## @param size Persistent Volume size -## @param replicas Number of Postgres replicas +## @param replicas Number of replicas ## @param storageClass StorageClass used to store the data ## external: false @@ -11,8 +11,8 @@ replicas: 2 storageClass: "" ## Configuration for the quorum-based synchronous replication -## @param quorum.minSyncReplicas Minimum number of synchronous replicas that must acknowledge a transaction before it is considered committed. -## @param quorum.maxSyncReplicas Maximum number of synchronous replicas that can acknowledge a transaction (must be lower than the number of instances). +## @param quorum.minSyncReplicas Minimum number of synchronous replicas that must acknowledge a transaction before it is considered committed +## @param quorum.maxSyncReplicas Maximum number of synchronous replicas that can acknowledge a transaction (must be lower than the total number of replicas) quorum: minSyncReplicas: 0 maxSyncReplicas: 0 @@ -31,7 +31,7 @@ users: {} ## @section Backup parameters -## @param backup.enabled Enable pereiodic backups +## @param backup.enabled Enable periodic backups ## @param backup.s3Region The AWS S3 region where backups are stored ## @param backup.s3Bucket The S3 bucket used for storing backups ## @param backup.schedule Cron schedule for automated backups @@ -49,11 +49,11 @@ backup: s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog resticPassword: ChaXoveekoh6eigh4siesheeda2quai0 -## @param resources Resources +## @param resources Explicit CPU and memory configuration for each FerretDB replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi - -## @param resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) + +## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "nano" diff --git a/packages/apps/http-cache/README.md b/packages/apps/http-cache/README.md index 68c5bfe8..a806a191 100644 --- a/packages/apps/http-cache/README.md +++ b/packages/apps/http-cache/README.md @@ -1,8 +1,9 @@ -# Managed Nginx Caching Service +# Managed Nginx-based HTTP Cache Service -The Nginx Caching Service is designed to optimize web traffic and enhance web application performance. This service combines custom-built Nginx instances with HAproxy for efficient caching and load balancing. +The Nginx-based HTTP caching service is designed to optimize web traffic and enhance web application performance. +This service combines custom-built Nginx instances with HAProxy for efficient caching and load balancing. -## Deployment infromation +## Deployment information The Nginx instances include the following modules and features: @@ -53,27 +54,67 @@ The deployment architecture is illustrated in the diagram below: ## Known issues -VTS module shows wrong upstream resonse time -- https://github.com/vozlt/nginx-module-vts/issues/198 +- VTS module shows wrong upstream response time, [github.com/vozlt/nginx-module-vts#198](https://github.com/vozlt/nginx-module-vts/issues/198) ## Parameters ### Common parameters -| Name | Description | Value | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -| `external` | Enable external access from outside the cluster | `false` | -| `size` | Persistent Volume size | `10Gi` | -| `storageClass` | StorageClass used to store the data | `""` | -| `haproxy.replicas` | Number of HAProxy replicas | `2` | -| `nginx.replicas` | Number of Nginx replicas | `2` | -| `haproxy.resources` | | `{}` | -| `haproxy.resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `nano` | -| `nginx.resources` | Resources | `{}` | -| `nginx.resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `nano` | +| Name | Description | Value | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------- | +| `external` | Enable external access from outside the cluster | `false` | +| `size` | Persistent Volume size | `10Gi` | +| `storageClass` | StorageClass used to store the data | `""` | +| `haproxy.replicas` | Number of HAProxy replicas | `2` | +| `nginx.replicas` | Number of Nginx replicas | `2` | +| `haproxy.resources` | Explicit CPU and memory configuration for each HAProxy replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `haproxy.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| `nginx.resources` | Explicit CPU and memory configuration for each nginx replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `nginx.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | ### Configuration parameters | Name | Description | Value | | ----------- | ----------------------- | ----- | | `endpoints` | Endpoints configuration | `[]` | + +## Parameter examples and reference + +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. + +```yaml +resources: + cpu: 4000m + memory: 4Gi +``` + +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | + + +### endpoints + +`endpoints` is a flat list of IP addresses: + +```yaml +endpoints: + - 10.100.3.1:80 + - 10.100.3.11:80 + - 10.100.3.2:80 + - 10.100.3.12:80 + - 10.100.3.3:80 + - 10.100.3.13:80 +``` diff --git a/packages/apps/http-cache/values.schema.json b/packages/apps/http-cache/values.schema.json index 293937ff..c624c8b5 100644 --- a/packages/apps/http-cache/values.schema.json +++ b/packages/apps/http-cache/values.schema.json @@ -27,12 +27,12 @@ }, "resources": { "type": "object", - "description": "", + "description": "Explicit CPU and memory configuration for each HAProxy replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "nano", "enum": [ "none", @@ -57,12 +57,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each nginx replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "nano", "enum": [ "none", diff --git a/packages/apps/http-cache/values.yaml b/packages/apps/http-cache/values.yaml index 67e05125..d6d05b06 100644 --- a/packages/apps/http-cache/values.yaml +++ b/packages/apps/http-cache/values.yaml @@ -12,23 +12,23 @@ size: 10Gi storageClass: "" haproxy: replicas: 2 - ## @param haproxy.resources + ## @param haproxy.resources Explicit CPU and memory configuration for each HAProxy replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi - - ## @param haproxy.resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) + + ## @param haproxy.resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "nano" nginx: replicas: 2 - ## @param nginx.resources Resources + ## @param nginx.resources Explicit CPU and memory configuration for each nginx replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi - - ## @param nginx.resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) + + ## @param nginx.resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "nano" ## @section Configuration parameters diff --git a/packages/apps/kafka/README.md b/packages/apps/kafka/README.md index 3af4e452..7e71175e 100644 --- a/packages/apps/kafka/README.md +++ b/packages/apps/kafka/README.md @@ -4,22 +4,67 @@ ### Common parameters -| Name | Description | Value | -| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -| `external` | Enable external access from outside the cluster | `false` | -| `kafka.size` | Persistent Volume size for Kafka | `10Gi` | -| `kafka.replicas` | Number of Kafka replicas | `3` | -| `kafka.storageClass` | StorageClass used to store the Kafka data | `""` | -| `zookeeper.size` | Persistent Volume size for ZooKeeper | `5Gi` | -| `zookeeper.replicas` | Number of ZooKeeper replicas | `3` | -| `zookeeper.storageClass` | StorageClass used to store the ZooKeeper data | `""` | -| `kafka.resources` | Resources | `{}` | -| `kafka.resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `small` | -| `zookeeper.resources` | Resources | `{}` | -| `zookeeper.resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `small` | +| Name | Description | Value | +| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `external` | Enable external access from outside the cluster | `false` | +| `kafka.size` | Persistent Volume size for Kafka | `10Gi` | +| `kafka.replicas` | Number of Kafka replicas | `3` | +| `kafka.storageClass` | StorageClass used to store the Kafka data | `""` | +| `zookeeper.size` | Persistent Volume size for ZooKeeper | `5Gi` | +| `zookeeper.replicas` | Number of ZooKeeper replicas | `3` | +| `zookeeper.storageClass` | StorageClass used to store the ZooKeeper data | `""` | +| `kafka.resources` | Explicit CPU and memory configuration for each Kafka replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `kafka.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `small` | +| `zookeeper.resources` | Explicit CPU and memory configuration for each Zookeeper replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `zookeeper.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `small` | ### Configuration parameters | Name | Description | Value | | -------- | -------------------- | ----- | | `topics` | Topics configuration | `[]` | + +## Parameter examples and reference + +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. + +```yaml +resources: + cpu: 4000m + memory: 4Gi +``` + +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | + +### topics + +```yaml +topics: + - name: Results + partitions: 1 + replicas: 3 + config: + min.insync.replicas: 2 + - name: Orders + config: + cleanup.policy: compact + segment.ms: 3600000 + max.compaction.lag.ms: 5400000 + min.insync.replicas: 2 + partitions: 1 + replicas: 3 +``` diff --git a/packages/apps/kafka/values.schema.json b/packages/apps/kafka/values.schema.json index 0fc2eb6b..64fe7cf7 100644 --- a/packages/apps/kafka/values.schema.json +++ b/packages/apps/kafka/values.schema.json @@ -27,12 +27,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each Kafka replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "small", "enum": [ "none", @@ -67,12 +67,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each Zookeeper replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "small", "enum": [ "none", diff --git a/packages/apps/kafka/values.yaml b/packages/apps/kafka/values.yaml index 7bdcbd73..e8204655 100644 --- a/packages/apps/kafka/values.yaml +++ b/packages/apps/kafka/values.yaml @@ -14,26 +14,24 @@ kafka: size: 10Gi replicas: 3 storageClass: "" - ## @param kafka.resources Resources + ## @param kafka.resources Explicit CPU and memory configuration for each Kafka replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi - - ## @param kafka.resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) + ## @param kafka.resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "small" zookeeper: size: 5Gi replicas: 3 storageClass: "" - ## @param zookeeper.resources Resources + ## @param zookeeper.resources Explicit CPU and memory configuration for each Zookeeper replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi - - ## @param zookeeper.resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) + ## @param zookeeper.resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "small" ## @section Configuration parameters diff --git a/packages/apps/kubernetes/README.md b/packages/apps/kubernetes/README.md index cee58a0f..aba4f5b5 100644 --- a/packages/apps/kubernetes/README.md +++ b/packages/apps/kubernetes/README.md @@ -112,34 +112,43 @@ See the reference for components utilized in this service: ### Kubernetes Control Plane Configuration -| Name | Description | Value | -| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | -| `controlPlane.apiServer.resources` | Explicit CPU/memory resource requests and limits for the API server. | `{}` | -| `controlPlane.apiServer.resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `medium` | -| `controlPlane.controllerManager.resources` | Explicit CPU/memory resource requests and limits for the controller manager. | `{}` | -| `controlPlane.controllerManager.resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `micro` | -| `controlPlane.scheduler.resources` | Explicit CPU/memory resource requests and limits for the scheduler. | `{}` | -| `controlPlane.scheduler.resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `micro` | -| `controlPlane.konnectivity.server.resources` | Explicit CPU/memory resource requests and limits for the Konnectivity. | `{}` | -| `controlPlane.konnectivity.server.resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `micro` | +| Name | Description | Value | +| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| `controlPlane.apiServer.resources` | Explicit CPU and memory configuration for the API Server. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `controlPlane.apiServer.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `medium` | +| `controlPlane.controllerManager.resources` | Explicit CPU and memory configuration for the Controller Manager. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `controlPlane.controllerManager.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `micro` | +| `controlPlane.scheduler.resources` | Explicit CPU and memory configuration for the Scheduler. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `controlPlane.scheduler.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `micro` | +| `controlPlane.konnectivity.server.resources` | Explicit CPU and memory configuration for Konnectivity. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `controlPlane.konnectivity.server.resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `micro` | -In production environments, it's recommended to set `resources` explicitly. -Example of `controlPlane.*.resources`: + +## Parameter examples and reference + +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. ```yaml resources: - limits: - cpu: 4000m - memory: 4Gi - requests: - cpu: 100m - memory: 512Mi + cpu: 4000m + memory: 4Gi ``` -Allowed values for `controlPlane.*.resourcesPreset` are `none`, `nano`, `micro`, `small`, `medium`, `large`, `xlarge`, `2xlarge`. -This value is ignored if the corresponding `resources` value is set. +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. -## Resources Reference +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | ### instanceType Resources diff --git a/packages/apps/kubernetes/values.schema.json b/packages/apps/kubernetes/values.schema.json index 02de6c1d..9792d03a 100644 --- a/packages/apps/kubernetes/values.schema.json +++ b/packages/apps/kubernetes/values.schema.json @@ -20,12 +20,12 @@ "properties": { "resources": { "type": "object", - "description": "Explicit CPU/memory resource requests and limits for the API server.", + "description": "Explicit CPU and memory configuration for the API Server. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "medium", "enum": [ "none", @@ -45,12 +45,12 @@ "properties": { "resources": { "type": "object", - "description": "Explicit CPU/memory resource requests and limits for the controller manager.", + "description": "Explicit CPU and memory configuration for the Controller Manager. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "micro", "enum": [ "none", @@ -70,12 +70,12 @@ "properties": { "resources": { "type": "object", - "description": "Explicit CPU/memory resource requests and limits for the scheduler.", + "description": "Explicit CPU and memory configuration for the Scheduler. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "micro", "enum": [ "none", @@ -98,12 +98,12 @@ "properties": { "resources": { "type": "object", - "description": "Explicit CPU/memory resource requests and limits for the Konnectivity.", + "description": "Explicit CPU and memory configuration for Konnectivity. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "micro", "enum": [ "none", diff --git a/packages/apps/kubernetes/values.yaml b/packages/apps/kubernetes/values.yaml index 89c9aee4..68e7c244 100644 --- a/packages/apps/kubernetes/values.yaml +++ b/packages/apps/kubernetes/values.yaml @@ -121,8 +121,8 @@ controlPlane: replicas: 2 apiServer: - ## @param controlPlane.apiServer.resources Explicit CPU/memory resource requests and limits for the API server. - ## @param controlPlane.apiServer.resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) + ## @param controlPlane.apiServer.resources Explicit CPU and memory configuration for the API Server. When left empty, the preset defined in `resourcesPreset` is applied. + ## @param controlPlane.apiServer.resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. ## e.g: ## resources: ## cpu: 4000m @@ -132,20 +132,20 @@ controlPlane: resources: {} controllerManager: - ## @param controlPlane.controllerManager.resources Explicit CPU/memory resource requests and limits for the controller manager. - ## @param controlPlane.controllerManager.resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) + ## @param controlPlane.controllerManager.resources Explicit CPU and memory configuration for the Controller Manager. When left empty, the preset defined in `resourcesPreset` is applied. + ## @param controlPlane.controllerManager.resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "micro" resources: {} scheduler: - ## @param controlPlane.scheduler.resources Explicit CPU/memory resource requests and limits for the scheduler. - ## @param controlPlane.scheduler.resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) + ## @param controlPlane.scheduler.resources Explicit CPU and memory configuration for the Scheduler. When left empty, the preset defined in `resourcesPreset` is applied. + ## @param controlPlane.scheduler.resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "micro" resources: {} konnectivity: server: - ## @param controlPlane.konnectivity.server.resources Explicit CPU/memory resource requests and limits for the Konnectivity. - ## @param controlPlane.konnectivity.server.resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) + ## @param controlPlane.konnectivity.server.resources Explicit CPU and memory configuration for Konnectivity. When left empty, the preset defined in `resourcesPreset` is applied. + ## @param controlPlane.konnectivity.server.resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, 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 cf86a13c..6fb0d793 100644 --- a/packages/apps/mysql/README.md +++ b/packages/apps/mysql/README.md @@ -1,6 +1,7 @@ ## Managed MariaDB Service -The Managed MariaDB Service offers a powerful and widely used relational database solution. This service allows you to create and manage a replicated MariaDB cluster seamlessly. +The Managed MariaDB Service offers a powerful and widely used relational database solution. +This service allows you to create and manage a replicated MariaDB cluster seamlessly. ## Deployment Details @@ -46,7 +47,7 @@ restic -r s3:s3.example.org/mariadb-backups/database_name restore latest --targe ``` more details: -- https://itnext.io/restic-effective-backup-from-stdin-4bc1e8f083c1 +- https://blog.aenix.io/restic-effective-backup-from-stdin-4bc1e8f083c1 ### Known issues @@ -83,16 +84,66 @@ more details: ### Backup parameters -| Name | Description | Value | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | -| `backup.enabled` | Enable pereiodic backups | `false` | -| `backup.s3Region` | The AWS S3 region where backups are stored | `us-east-1` | -| `backup.s3Bucket` | The S3 bucket used for storing backups | `s3.example.org/postgres-backups` | -| `backup.schedule` | Cron schedule for automated backups | `0 2 * * *` | -| `backup.cleanupStrategy` | The strategy for cleaning up old backups | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` | -| `backup.s3AccessKey` | The access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | -| `backup.s3SecretKey` | The secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` | -| `backup.resticPassword` | The password for Restic backup encryption | `ChaXoveekoh6eigh4siesheeda2quai0` | -| `resources` | Resources | `{}` | -| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `nano` | +| Name | Description | Value | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | +| `backup.enabled` | Enable periodic backups | `false` | +| `backup.s3Region` | The AWS S3 region where backups are stored | `us-east-1` | +| `backup.s3Bucket` | The S3 bucket used for storing backups | `s3.example.org/postgres-backups` | +| `backup.schedule` | Cron schedule for automated backups | `0 2 * * *` | +| `backup.cleanupStrategy` | The strategy for cleaning up old backups | `--keep-last=3 --keep-daily=3 --keep-within-weekly=1m` | +| `backup.s3AccessKey` | The access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | +| `backup.s3SecretKey` | The secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` | +| `backup.resticPassword` | The password for Restic backup encryption | `ChaXoveekoh6eigh4siesheeda2quai0` | +| `resources` | Explicit CPU and memory configuration for each MariaDB replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +## Parameter examples and reference + +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. + +```yaml +resources: + cpu: 4000m + memory: 4Gi +``` + +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | + +### users + +```yaml +users: + user1: + maxUserConnections: 1000 + password: hackme + user2: + maxUserConnections: 1000 + password: hackme +``` + + +### databases + +```yaml +databases: + myapp1: + roles: + admin: + - user1 + readonly: + - user2 +``` diff --git a/packages/apps/mysql/values.schema.json b/packages/apps/mysql/values.schema.json index f3150748..a183f764 100644 --- a/packages/apps/mysql/values.schema.json +++ b/packages/apps/mysql/values.schema.json @@ -27,7 +27,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Enable pereiodic backups", + "description": "Enable periodic backups", "default": false }, "s3Region": { @@ -69,12 +69,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each MariaDB replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "nano", "enum": [ "none", diff --git a/packages/apps/mysql/values.yaml b/packages/apps/mysql/values.yaml index 5d4c74c1..1e74e340 100644 --- a/packages/apps/mysql/values.yaml +++ b/packages/apps/mysql/values.yaml @@ -37,7 +37,7 @@ databases: {} ## @section Backup parameters -## @param backup.enabled Enable pereiodic backups +## @param backup.enabled Enable periodic backups ## @param backup.s3Region The AWS S3 region where backups are stored ## @param backup.s3Bucket The S3 bucket used for storing backups ## @param backup.schedule Cron schedule for automated backups @@ -55,11 +55,11 @@ backup: s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog resticPassword: ChaXoveekoh6eigh4siesheeda2quai0 -## @param resources Resources +## @param resources Explicit CPU and memory configuration for each MariaDB replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi -## @param resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) +## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "nano" diff --git a/packages/apps/nats/README.md b/packages/apps/nats/README.md index 9bf7e67d..2c90d045 100644 --- a/packages/apps/nats/README.md +++ b/packages/apps/nats/README.md @@ -1,18 +1,48 @@ # Managed NATS Service +NATS is an open-source, simple, secure, and high performance messaging system. +It provides a data layer for cloud native applications, IoT messaging, and microservices architectures. + ## Parameters ### Common parameters -| Name | Description | Value | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -| `external` | Enable external access from outside the cluster | `false` | -| `replicas` | Persistent Volume size for NATS | `2` | -| `storageClass` | StorageClass used to store the data | `""` | -| `users` | Users configuration | `{}` | -| `jetstream.size` | Jetstream persistent storage size | `10Gi` | -| `jetstream.enabled` | Enable or disable Jetstream | `true` | -| `config.merge` | Additional configuration to merge into NATS config | `{}` | -| `config.resolver` | Additional configuration to merge into NATS config | `{}` | -| `resources` | Resources | `{}` | -| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `nano` | +| Name | Description | Value | +| ------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `external` | Enable external access from outside the cluster | `false` | +| `replicas` | Persistent Volume size for NATS | `2` | +| `storageClass` | StorageClass used to store the data | `""` | +| `users` | Users configuration | `{}` | +| `jetstream.size` | Jetstream persistent storage size | `10Gi` | +| `jetstream.enabled` | Enable or disable Jetstream | `true` | +| `config.merge` | Additional configuration to merge into NATS config | `{}` | +| `config.resolver` | Additional configuration to merge into NATS config | `{}` | +| `resources` | Explicit CPU and memory configuration for each NATS replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | + +## Parameter examples and reference + +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. + +```yaml +resources: + cpu: 4000m + memory: 4Gi +``` + +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | + diff --git a/packages/apps/nats/values.schema.json b/packages/apps/nats/values.schema.json index 2973a1fe..5d67d1c8 100644 --- a/packages/apps/nats/values.schema.json +++ b/packages/apps/nats/values.schema.json @@ -49,12 +49,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each NATS replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "nano", "enum": [ "none", diff --git a/packages/apps/nats/values.yaml b/packages/apps/nats/values.yaml index 3a736b9d..41b5021f 100644 --- a/packages/apps/nats/values.yaml +++ b/packages/apps/nats/values.yaml @@ -62,11 +62,11 @@ config: ## Example see: https://github.com/nats-io/k8s/blob/main/helm/charts/nats/values.yaml#L247 resolver: {} -## @param resources Resources +## @param resources Explicit CPU and memory configuration for each NATS replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi -## @param resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) +## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "nano" diff --git a/packages/apps/postgres/README.md b/packages/apps/postgres/README.md index 9956f0c5..a8bfac80 100644 --- a/packages/apps/postgres/README.md +++ b/packages/apps/postgres/README.md @@ -1,6 +1,8 @@ # Managed PostgreSQL Service -PostgreSQL is currently the leading choice among relational databases, known for its robust features and performance. Our Managed PostgreSQL Service takes advantage of platform-side implementation to provide a self-healing replicated cluster. This cluster is efficiently managed using the highly acclaimed CloudNativePG operator, which has gained popularity within the community. +PostgreSQL is currently the leading choice among relational databases, known for its robust features and performance. +The Managed PostgreSQL Service takes advantage of platform-side implementation to provide a self-healing replicated cluster. +This cluster is efficiently managed using the highly acclaimed CloudNativePG operator, which has gained popularity within the community. ## Deployment Details @@ -11,7 +13,7 @@ This managed service is controlled by the CloudNativePG operator, ensuring effic ## HowTos -### How to switch master/slave replica +### How to switch primary/secondary replica See: @@ -33,7 +35,7 @@ restic -r s3:s3.example.org/postgres-backups/database_name restore latest --targ more details: -- +- ## Parameters @@ -70,10 +72,70 @@ more details: ### Bootstrap parameters -| Name | Description | Value | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -| `bootstrap.enabled` | Restore cluster from backup | `false` | -| `bootstrap.recoveryTime` | Time stamp up to which recovery will proceed, expressed in RFC 3339 format, if empty, will restore latest | `""` | -| `bootstrap.oldName` | Name of cluster before deleting | `""` | -| `resources` | Resources | `{}` | -| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `micro` | +| Name | Description | Value | +| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `bootstrap.enabled` | Restore cluster from backup | `false` | +| `bootstrap.recoveryTime` | Time stamp up to which recovery will proceed, expressed in RFC 3339 format, if empty, will restore latest | `""` | +| `bootstrap.oldName` | Name of cluster before deleting | `""` | +| `resources` | Explicit CPU and memory configuration for each PostgreSQL replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `micro` | + + +## Parameter examples and reference + +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. + +```yaml +resources: + cpu: 4000m + memory: 4Gi +``` + +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | + +### users + +```yaml +users: + user1: + password: strongpassword + user2: + password: hackme + airflow: + password: qwerty123 + debezium: + replication: true +``` + +### databases + +```yaml +databases: + myapp: + roles: + admin: + - user1 + - debezium + readonly: + - user2 + airflow: + roles: + admin: + - airflow + extensions: + - hstore +``` diff --git a/packages/apps/postgres/values.schema.json b/packages/apps/postgres/values.schema.json index 5b5e7e8b..ba60b35c 100644 --- a/packages/apps/postgres/values.schema.json +++ b/packages/apps/postgres/values.schema.json @@ -119,12 +119,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each PostgreSQL replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "micro", "enum": [ "none", diff --git a/packages/apps/postgres/values.yaml b/packages/apps/postgres/values.yaml index cbf2e065..9e1867d6 100644 --- a/packages/apps/postgres/values.yaml +++ b/packages/apps/postgres/values.yaml @@ -87,11 +87,11 @@ bootstrap: recoveryTime: "" oldName: "" -## @param resources Resources +## @param resources Explicit CPU and memory configuration for each PostgreSQL replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi -## @param resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) +## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "micro" diff --git a/packages/apps/rabbitmq/README.md b/packages/apps/rabbitmq/README.md index a4ceee2c..cd65fb61 100644 --- a/packages/apps/rabbitmq/README.md +++ b/packages/apps/rabbitmq/README.md @@ -22,9 +22,36 @@ The service utilizes official RabbitMQ operator. This ensures the reliability an ### Configuration parameters -| Name | Description | Value | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | -| `users` | Users configuration | `{}` | -| `vhosts` | Virtual Hosts configuration | `{}` | -| `resources` | Resources | `{}` | -| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `nano` | +| Name | Description | Value | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------ | +| `users` | Users configuration | `{}` | +| `vhosts` | Virtual Hosts configuration | `{}` | +| `resources` | Explicit CPU and memory configuration for each RabbitMQ replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | + +## Parameter examples and reference + +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. + +```yaml +resources: + cpu: 4000m + memory: 4Gi +``` + +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `100m` | `128Mi` | +| `micro` | `250m` | `256Mi` | +| `small` | `500m` | `512Mi` | +| `medium` | `500m` | `1Gi` | +| `large` | `1` | `2Gi` | +| `xlarge` | `2` | `4Gi` | +| `2xlarge` | `4` | `8Gi` | + diff --git a/packages/apps/rabbitmq/values.schema.json b/packages/apps/rabbitmq/values.schema.json index f0033d05..2e40482d 100644 --- a/packages/apps/rabbitmq/values.schema.json +++ b/packages/apps/rabbitmq/values.schema.json @@ -29,12 +29,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each RabbitMQ replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "nano", "enum": [ "none", diff --git a/packages/apps/rabbitmq/values.yaml b/packages/apps/rabbitmq/values.yaml index 9f037f7b..c6df1725 100644 --- a/packages/apps/rabbitmq/values.yaml +++ b/packages/apps/rabbitmq/values.yaml @@ -40,11 +40,11 @@ users: {} ## - user3 vhosts: {} -## @param resources Resources +## @param resources Explicit CPU and memory configuration for each RabbitMQ replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi -## @param resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) +## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "nano" diff --git a/packages/apps/redis/README.md b/packages/apps/redis/README.md index e56990cd..e394a06d 100644 --- a/packages/apps/redis/README.md +++ b/packages/apps/redis/README.md @@ -13,14 +13,38 @@ Service utilizes the Spotahome Redis Operator for efficient management and orche ### Common parameters -| Name | Description | Value | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -| `external` | Enable external access from outside the cluster | `false` | -| `size` | Persistent Volume size | `1Gi` | -| `replicas` | Number of Redis replicas | `2` | -| `storageClass` | StorageClass used to store the data | `""` | -| `authEnabled` | Enable password generation | `true` | -| `resources` | Resources | `{}` | -| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `nano` | +| Name | Description | Value | +| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `external` | Enable external access from outside the cluster | `false` | +| `size` | Persistent Volume size | `1Gi` | +| `replicas` | Number of Redis replicas | `2` | +| `storageClass` | StorageClass used to store the data | `""` | +| `authEnabled` | Enable password generation | `true` | +| `resources` | Explicit CPU and memory configuration for each Redis replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +## Parameter examples and reference +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. + +```yaml +resources: + cpu: 4000m + memory: 4Gi +``` + +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | diff --git a/packages/apps/redis/values.schema.json b/packages/apps/redis/values.schema.json index 6e0472d6..17e05c1a 100644 --- a/packages/apps/redis/values.schema.json +++ b/packages/apps/redis/values.schema.json @@ -29,12 +29,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each Redis replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "nano", "enum": [ "none", diff --git a/packages/apps/redis/values.yaml b/packages/apps/redis/values.yaml index 94d57425..439e2029 100644 --- a/packages/apps/redis/values.yaml +++ b/packages/apps/redis/values.yaml @@ -12,11 +12,11 @@ replicas: 2 storageClass: "" authEnabled: true -## @param resources Resources +## @param resources Explicit CPU and memory configuration for each Redis replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi -## @param resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) +## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "nano" diff --git a/packages/apps/tcp-balancer/README.md b/packages/apps/tcp-balancer/README.md index 66f5f30a..82f79c90 100644 --- a/packages/apps/tcp-balancer/README.md +++ b/packages/apps/tcp-balancer/README.md @@ -19,13 +19,39 @@ Managed TCP Load Balancer Service efficiently utilizes HAProxy for load balancin ### Configuration parameters -| Name | Description | Value | -| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -| `httpAndHttps.mode` | Mode for balancer. Allowed values: `tcp` and `tcp-with-proxy` | `tcp` | -| `httpAndHttps.targetPorts.http` | HTTP port number. | `80` | -| `httpAndHttps.targetPorts.https` | HTTPS port number. | `443` | -| `httpAndHttps.endpoints` | Endpoint addresses list | `[]` | -| `whitelistHTTP` | Secure HTTP by enabling client networks whitelisting | `false` | -| `whitelist` | List of client networks | `[]` | -| `resources` | Resources | `{}` | -| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `nano` | +| Name | Description | Value | +| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `httpAndHttps.mode` | Mode for balancer. Allowed values: `tcp` and `tcp-with-proxy` | `tcp` | +| `httpAndHttps.targetPorts.http` | HTTP port number. | `80` | +| `httpAndHttps.targetPorts.https` | HTTPS port number. | `443` | +| `httpAndHttps.endpoints` | Endpoint addresses list | `[]` | +| `whitelistHTTP` | Secure HTTP by enabling client networks whitelisting | `false` | +| `whitelist` | List of client networks | `[]` | +| `resources` | Explicit CPU and memory configuration for each TCP Balancer replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | + +## Parameter examples and reference + +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. + +```yaml +resources: + cpu: 4000m + memory: 4Gi +``` + +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | diff --git a/packages/apps/tcp-balancer/values.schema.json b/packages/apps/tcp-balancer/values.schema.json index 986d49c8..908a72c5 100644 --- a/packages/apps/tcp-balancer/values.schema.json +++ b/packages/apps/tcp-balancer/values.schema.json @@ -60,12 +60,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each TCP Balancer replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "nano", "enum": [ "none", diff --git a/packages/apps/tcp-balancer/values.yaml b/packages/apps/tcp-balancer/values.yaml index 0bc20399..17ede5ce 100644 --- a/packages/apps/tcp-balancer/values.yaml +++ b/packages/apps/tcp-balancer/values.yaml @@ -44,11 +44,11 @@ httpAndHttps: whitelistHTTP: false whitelist: [] -## @param resources Resources +## @param resources Explicit CPU and memory configuration for each TCP Balancer replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi -## @param resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) +## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "nano" diff --git a/packages/apps/vpn/README.md b/packages/apps/vpn/README.md index 7ead4c91..0a4d4475 100644 --- a/packages/apps/vpn/README.md +++ b/packages/apps/vpn/README.md @@ -1,12 +1,16 @@ # Managed VPN Service -A Virtual Private Network (VPN) is a critical tool for ensuring secure and private communication over the internet. Managed VPN Service simplifies the deployment and management of VPN server, enabling you to establish secure connections with ease. +A Virtual Private Network (VPN) is a critical tool for ensuring secure and private communication over the internet. +Managed VPN Service simplifies the deployment and management of VPN server, enabling you to establish secure connections with ease. -- Clients: https://shadowsocks5.github.io/en/download/clients.html +- VPN client applications: https://shadowsocks5.github.io/en/download/clients.html ## Deployment Details -The VPN Service is powered by the Outline Server, an advanced and user-friendly VPN solution. Internally known as "Shadowbox", which simplifies the process of setting up and sharing Shadowsocks servers. It operates by launching Shadowsocks instances on demand. Furthermore, Shadowbox is compatible with standard Shadowsocks clients, providing flexibility and ease of use for your VPN requirements. +The VPN Service is powered by the Outline Server, an advanced and user-friendly VPN solution. +Internally known as "Shadowbox", which simplifies the process of setting up and sharing Shadowsocks servers. +It operates by launching Shadowsocks instances on demand. +Furthermore, Shadowbox is compatible with standard Shadowsocks clients, providing flexibility and ease of use for your VPN requirements. - Docs: https://shadowsocks.org/ - Docs: https://github.com/Jigsaw-Code/outline-server/tree/master/src/shadowbox @@ -18,14 +22,60 @@ The VPN Service is powered by the Outline Server, an advanced and user-friendly | Name | Description | Value | | ---------- | ----------------------------------------------- | ------- | | `external` | Enable external access from outside the cluster | `false` | -| `replicas` | Number of VPN-server replicas | `2` | +| `replicas` | Number of VPN server replicas | `2` | ### Configuration parameters -| Name | Description | Value | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | -| `host` | Host used to substitute into generated URLs | `""` | -| `users` | Users configuration | `{}` | -| `externalIPs` | List of externalIPs for service. | `[]` | -| `resources` | Resources | `{}` | -| `resourcesPreset` | Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) | `nano` | +| Name | Description | Value | +| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------ | +| `host` | Host used to substitute into generated URLs | `""` | +| `users` | Users configuration | `{}` | +| `externalIPs` | List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default. | `[]` | +| `resources` | Explicit CPU and memory configuration for each VPN server replica. When left empty, the preset defined in `resourcesPreset` is applied. | `{}` | +| `resourcesPreset` | Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | + +## Parameter examples and reference + +### resources and resourcesPreset + +`resources` sets explicit CPU and memory configurations for each replica. +When left empty, the preset defined in `resourcesPreset` is applied. + +```yaml +resources: + cpu: 4000m + memory: 4Gi +``` + +`resourcesPreset` sets named CPU and memory configurations for each replica. +This setting is ignored if the corresponding `resources` value is set. + +| Preset name | CPU | memory | +|-------------|--------|---------| +| `nano` | `250m` | `128Mi` | +| `micro` | `500m` | `256Mi` | +| `small` | `1` | `512Mi` | +| `medium` | `1` | `1Gi` | +| `large` | `3` | `2Gi` | +| `xlarge` | `4` | `4Gi` | +| `2xlarge` | `8` | `8Gi` | + + +### users + +```yaml +users: + user1: + password: hackme + user2: {} # autogenerated password +``` + + +### externalIPs + +```yaml +externalIPs: + - "11.22.33.44" + - "11.22.33.45" + - "11.22.33.46" +``` diff --git a/packages/apps/vpn/values.schema.json b/packages/apps/vpn/values.schema.json index 23b88ad9..13921381 100644 --- a/packages/apps/vpn/values.schema.json +++ b/packages/apps/vpn/values.schema.json @@ -9,7 +9,7 @@ }, "replicas": { "type": "number", - "description": "Number of VPN-server replicas", + "description": "Number of VPN server replicas", "default": 2 }, "host": { @@ -19,7 +19,7 @@ }, "externalIPs": { "type": "array", - "description": "List of externalIPs for service.", + "description": "List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.", "default": "[]", "items": { "type": "string" @@ -27,12 +27,12 @@ }, "resources": { "type": "object", - "description": "Resources", + "description": "Explicit CPU and memory configuration for each VPN server replica. When left empty, the preset defined in `resourcesPreset` is applied.", "default": {} }, "resourcesPreset": { "type": "string", - "description": "Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge)", + "description": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", "default": "nano", "enum": [ "none", diff --git a/packages/apps/vpn/values.yaml b/packages/apps/vpn/values.yaml index 98bae29a..9af5f6f2 100644 --- a/packages/apps/vpn/values.yaml +++ b/packages/apps/vpn/values.yaml @@ -1,7 +1,7 @@ ## @section Common parameters ## @param external Enable external access from outside the cluster -## @param replicas Number of VPN-server replicas +## @param replicas Number of VPN server replicas ## external: false replicas: 2 @@ -19,8 +19,7 @@ host: "" ## user2: {} # autogenerated password users: {} -## @param externalIPs [array] List of externalIPs for service. -## Optional. If not specified will use LoadBalancer service by default. +## @param externalIPs [array] List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default. ## ## e.g: ## externalIPs: @@ -30,11 +29,11 @@ users: {} ## externalIPs: [] -## @param resources Resources +## @param resources Explicit CPU and memory configuration for each VPN server replica. When left empty, the preset defined in `resourcesPreset` is applied. resources: {} # resources: # cpu: 4000m # memory: 4Gi -## @param resourcesPreset Use a common resources preset when `resources` is not set explicitly. (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge) +## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "nano"