diff --git a/packages/apps/clickhouse/README.md b/packages/apps/clickhouse/README.md index 1896e0e2..25e896bf 100644 --- a/packages/apps/clickhouse/README.md +++ b/packages/apps/clickhouse/README.md @@ -23,35 +23,35 @@ For more details, read [Restic: Effective Backup from Stdin](https://blog.aenix. ### Common parameters -| Name | Description | Value | -| ---------------- | -------------------------------------------------------- | ------ | -| `size` | Size of Persistent Volume for data | `10Gi` | -| `logStorageSize` | Size of Persistent Volume for logs | `2Gi` | -| `shards` | Number of Clickhouse shards | `1` | -| `replicas` | Number of Clickhouse replicas | `2` | -| `storageClass` | StorageClass used to store the data | `""` | -| `logTTL` | TTL (expiration time) for query_log and query_thread_log | `15` | +| Name | Description | Value | +| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `replicas` | Number of Clickhouse replicas | `2` | +| `shards` | Number of Clickhouse shards | `1` | +| `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: nano, micro, small, medium, large, xlarge, 2xlarge. | `small` | +| `size` | Persistent Volume Claim size, available for application data | `10Gi` | +| `storageClass` | StorageClass used to store the application data | `""` | -### Configuration parameters +### Application-specific parameters -| Name | Description | Value | -| ------- | ------------------- | ----- | -| `users` | Users configuration | `{}` | +| Name | Description | Value | +| ---------------- | -------------------------------------------------------- | ----- | +| `logStorageSize` | Size of Persistent Volume for logs | `2Gi` | +| `logTTL` | TTL (expiration time) for query_log and query_thread_log | `15` | +| `users` | Users configuration | `{}` | ### 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 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: nano, micro, small, medium, large, xlarge, 2xlarge. | `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` | ## Parameter examples and reference diff --git a/packages/apps/clickhouse/values.schema.json b/packages/apps/clickhouse/values.schema.json index 8f471332..a0e373cf 100644 --- a/packages/apps/clickhouse/values.schema.json +++ b/packages/apps/clickhouse/values.schema.json @@ -2,31 +2,50 @@ "title": "Chart Values", "type": "object", "properties": { - "size": { - "type": "string", - "description": "Size of Persistent Volume for data", - "default": "10Gi" - }, - "logStorageSize": { - "type": "string", - "description": "Size of Persistent Volume for logs", - "default": "2Gi" + "replicas": { + "type": "number", + "description": "Number of Clickhouse replicas", + "default": 2 }, "shards": { "type": "number", "description": "Number of Clickhouse shards", "default": 1 }, - "replicas": { - "type": "number", - "description": "Number of Clickhouse replicas", - "default": 2 + "resources": { + "type": "object", + "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": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", + "default": "small", + "enum": [ + "nano", + "micro", + "small", + "medium", + "large", + "xlarge", + "2xlarge" + ] + }, + "size": { + "type": "string", + "description": "Persistent Volume Claim size, available for application data", + "default": "10Gi" }, "storageClass": { "type": "string", - "description": "StorageClass used to store the data", + "description": "StorageClass used to store the application data", "default": "" }, + "logStorageSize": { + "type": "string", + "description": "Size of Persistent Volume for logs", + "default": "2Gi" + }, "logTTL": { "type": "number", "description": "TTL (expiration time) for query_log and query_thread_log", @@ -76,25 +95,6 @@ "default": "ChaXoveekoh6eigh4siesheeda2quai0" } } - }, - "resources": { - "type": "object", - "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": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", - "default": "small", - "enum": [ - "nano", - "micro", - "small", - "medium", - "large", - "xlarge", - "2xlarge" - ] } } } diff --git a/packages/apps/clickhouse/values.yaml b/packages/apps/clickhouse/values.yaml index 5c7d7341..dbe0ddae 100644 --- a/packages/apps/clickhouse/values.yaml +++ b/packages/apps/clickhouse/values.yaml @@ -1,21 +1,29 @@ ## @section Common parameters - -## @param size Size of Persistent Volume for data -## @param logStorageSize Size of Persistent Volume for logs -## @param shards Number of Clickhouse shards -## @param replicas Number of Clickhouse replicas -## @param storageClass StorageClass used to store the data -## @param logTTL TTL (expiration time) for query_log and query_thread_log ## -size: 10Gi -logStorageSize: 2Gi -shards: 1 +## @param replicas Number of Clickhouse replicas replicas: 2 +## @param shards Number of Clickhouse shards +shards: 1 +## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. +resourcesPreset: "small" +## @param size Persistent Volume Claim size, available for application data +size: 10Gi +## @param storageClass StorageClass used to store the application data storageClass: "" + + +## @section Application-specific parameters +## +## @param logStorageSize Size of Persistent Volume for logs +logStorageSize: 2Gi +## @param logTTL TTL (expiration time) for query_log and query_thread_log logTTL: 15 - -## @section Configuration parameters - ## @param users [object] Users configuration ## Example: ## users: @@ -27,6 +35,7 @@ logTTL: 15 ## users: {} + ## @section Backup parameters ## @param backup.enabled Enable periodic backups @@ -47,11 +56,3 @@ backup: s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog resticPassword: ChaXoveekoh6eigh4siesheeda2quai0 -## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. -resourcesPreset: "small" diff --git a/packages/apps/ferretdb/README.md b/packages/apps/ferretdb/README.md index 9c3c41cc..aeb00bbc 100644 --- a/packages/apps/ferretdb/README.md +++ b/packages/apps/ferretdb/README.md @@ -8,20 +8,22 @@ Internally, FerretDB service is backed by Postgres. ### Common parameters -| 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` | +| Name | Description | Value | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `replicas` | Number of replicas | `2` | +| `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. | `micro` | +| `size` | Persistent Volume size | `10Gi` | +| `storageClass` | StorageClass used to store the data | `""` | +| `external` | Enable external access from outside the cluster | `false` | -### Configuration parameters +### Application-specific parameters -| Name | Description | Value | -| ------- | ------------------- | ----- | -| `users` | Users configuration | `{}` | +| Name | Description | Value | +| ------------------------ | --------------------------------------------------------------------------------------------------------------------------- | ----- | +| `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` | +| `users` | Users configuration | `{}` | ### Backup parameters @@ -35,15 +37,13 @@ Internally, FerretDB service is backed by Postgres. | `backup.s3AccessKey` | Access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | | `backup.s3SecretKey` | Secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` | -### Bootstrap parameters +### Bootstrap (recovery) parameters -| Name | Description | Value | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------- | -| `bootstrap.enabled` | Restore database cluster from a backup | `false` | -| `bootstrap.recoveryTime` | Timestamp (PITR) up to which recovery will proceed, expressed in RFC 3339 format. If left empty, will restore latest | `""` | -| `bootstrap.oldName` | Name of database cluster before deleting | `""` | -| `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. | `micro` | +| Name | Description | Value | +| ------------------------ | -------------------------------------------------------------------------------------------------------------------- | ------- | +| `bootstrap.enabled` | Restore database cluster from a backup | `false` | +| `bootstrap.recoveryTime` | Timestamp (PITR) up to which recovery will proceed, expressed in RFC 3339 format. If left empty, will restore latest | `""` | +| `bootstrap.oldName` | Name of database cluster before deleting | `""` | diff --git a/packages/apps/ferretdb/values.schema.json b/packages/apps/ferretdb/values.schema.json index 92bb8626..e58e0566 100644 --- a/packages/apps/ferretdb/values.schema.json +++ b/packages/apps/ferretdb/values.schema.json @@ -2,26 +2,45 @@ "title": "Chart Values", "type": "object", "properties": { - "external": { - "type": "boolean", - "description": "Enable external access from outside the cluster", - "default": false + "replicas": { + "type": "number", + "description": "Number of replicas", + "default": 2 + }, + "resources": { + "type": "object", + "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": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", + "default": "micro", + "enum": [ + "nano", + "micro", + "small", + "medium", + "large", + "xlarge", + "2xlarge" + ] }, "size": { "type": "string", "description": "Persistent Volume size", "default": "10Gi" }, - "replicas": { - "type": "number", - "description": "Number of replicas", - "default": 2 - }, "storageClass": { "type": "string", "description": "StorageClass used to store the data", "default": "" }, + "external": { + "type": "boolean", + "description": "Enable external access from outside the cluster", + "default": false + }, "quorum": { "type": "object", "properties": { @@ -96,25 +115,6 @@ "default": "" } } - }, - "resources": { - "type": "object", - "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": "Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge.", - "default": "micro", - "enum": [ - "nano", - "micro", - "small", - "medium", - "large", - "xlarge", - "2xlarge" - ] } } } diff --git a/packages/apps/ferretdb/values.yaml b/packages/apps/ferretdb/values.yaml index 5d6e12f0..7250ea57 100644 --- a/packages/apps/ferretdb/values.yaml +++ b/packages/apps/ferretdb/values.yaml @@ -1,24 +1,30 @@ ## @section Common parameters - -## @param external Enable external access from outside the cluster -## @param size Persistent Volume size -## @param replicas Number of replicas -## @param storageClass StorageClass used to store the data ## -external: false -size: 10Gi +## @param replicas Number of replicas replicas: 2 +## @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 Default sizing preset used when `resources` is omitted. Allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge. +resourcesPreset: "micro" +## @param size Persistent Volume size +size: 10Gi +## @param storageClass StorageClass used to store the data storageClass: "" +## @param external Enable external access from outside the cluster +external: false + +## @section Application-specific parameters +## ## 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 total number of replicas) quorum: minSyncReplicas: 0 maxSyncReplicas: 0 - -## @section Configuration parameters - ## @param users [object] Users configuration ## Example: ## users: @@ -29,8 +35,9 @@ quorum: ## users: {} -## @section Backup parameters +## @section Backup parameters +## ## @param backup.enabled Enable regular backups ## @param backup.schedule Cron schedule for automated backups ## @param backup.retentionPolicy Retention policy @@ -47,8 +54,9 @@ backup: s3AccessKey: oobaiRus9pah8PhohL1ThaeTa4UVa7gu s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog -## @section Bootstrap parameters +## @section Bootstrap (recovery) parameters +## ## @param bootstrap.enabled Restore database cluster from a backup ## @param bootstrap.recoveryTime Timestamp (PITR) up to which recovery will proceed, expressed in RFC 3339 format. If left empty, will restore latest ## @param bootstrap.oldName Name of database cluster before deleting @@ -60,11 +68,3 @@ bootstrap: oldName: "" -## @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 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/http-cache/README.md b/packages/apps/http-cache/README.md index 188b00b0..b20dedf0 100644 --- a/packages/apps/http-cache/README.md +++ b/packages/apps/http-cache/README.md @@ -60,24 +60,34 @@ The deployment architecture is illustrated in the diagram below: ### 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` | 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: 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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| Name | Description | Value | +| -------------- | ----------------------------------------------- | ------- | +| `size` | Persistent Volume size | `10Gi` | +| `storageClass` | StorageClass used to store the data | `""` | +| `external` | Enable external access from outside the cluster | `false` | -### Configuration parameters +### Application-specific parameters | Name | Description | Value | | ----------- | ----------------------- | ----- | | `endpoints` | Endpoints configuration | `[]` | +### HAProxy parameters + +| Name | Description | Value | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------ | +| `haproxy.replicas` | Number of HAProxy 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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | + +### Nginx parameters + +| Name | Description | Value | +| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------ | +| `nginx.replicas` | Number of Nginx replicas | `2` | +| `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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | + ## Parameter examples and reference ### resources and resourcesPreset diff --git a/packages/apps/http-cache/values.schema.json b/packages/apps/http-cache/values.schema.json index 99eda009..cce4199d 100644 --- a/packages/apps/http-cache/values.schema.json +++ b/packages/apps/http-cache/values.schema.json @@ -2,11 +2,6 @@ "title": "Chart Values", "type": "object", "properties": { - "external": { - "type": "boolean", - "description": "Enable external access from outside the cluster", - "default": false - }, "size": { "type": "string", "description": "Persistent Volume size", @@ -17,6 +12,17 @@ "description": "StorageClass used to store the data", "default": "" }, + "external": { + "type": "boolean", + "description": "Enable external access from outside the cluster", + "default": false + }, + "endpoints": { + "type": "array", + "description": "Endpoints configuration", + "default": [], + "items": {} + }, "haproxy": { "type": "object", "properties": { @@ -74,12 +80,6 @@ ] } } - }, - "endpoints": { - "type": "array", - "description": "Endpoints configuration", - "default": [], - "items": {} } } } diff --git a/packages/apps/http-cache/values.yaml b/packages/apps/http-cache/values.yaml index d353b3d0..db88617d 100644 --- a/packages/apps/http-cache/values.yaml +++ b/packages/apps/http-cache/values.yaml @@ -1,37 +1,12 @@ - ## @section Common parameters - -## @param external Enable external access from outside the cluster -## @param size Persistent Volume size -## @param storageClass StorageClass used to store the data -## @param haproxy.replicas Number of HAProxy replicas -## @param nginx.replicas Number of Nginx replicas ## -external: false +## @param size Persistent Volume size size: 10Gi +## @param storageClass StorageClass used to store the data storageClass: "" -haproxy: - replicas: 2 - ## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. - resourcesPreset: "nano" -nginx: - replicas: 2 - ## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. - resourcesPreset: "nano" - -## @section Configuration parameters +## @param external Enable external access from outside the cluster +external: false +## @section Application-specific parameters ## @param endpoints Endpoints configuration ## Example: @@ -44,3 +19,29 @@ nginx: ## - 10.100.3.13:80 ## endpoints: [] + +## @section HAProxy parameters +haproxy: + ## @param haproxy.replicas Number of HAProxy replicas + replicas: 2 + ## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. + resourcesPreset: "nano" + +## @section Nginx parameters +nginx: + ## @param nginx.replicas Number of Nginx replicas + replicas: 2 + ## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. + resourcesPreset: "nano" diff --git a/packages/apps/kafka/README.md b/packages/apps/kafka/README.md index 96135af4..9b030c1d 100644 --- a/packages/apps/kafka/README.md +++ b/packages/apps/kafka/README.md @@ -4,25 +4,35 @@ ### Common parameters +| Name | Description | Value | +| ---------- | ----------------------------------------------- | ------- | +| `external` | Enable external access from outside the cluster | `false` | + +### Application-specific parameters + +| Name | Description | Value | +| -------- | ---------------------------------- | ----- | +| `topics` | Topics configuration (see example) | `[]` | + +### Kafka configuration + +| Name | Description | Value | +| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `kafka.replicas` | Number of Kafka replicas | `3` | +| `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: nano, micro, small, medium, large, xlarge, 2xlarge. | `small` | +| `kafka.size` | Persistent Volume size for Kafka | `10Gi` | +| `kafka.storageClass` | StorageClass used to store the Kafka data | `""` | + +### Zookeeper configuration + | 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: 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: nano, micro, small, medium, large, xlarge, 2xlarge. | `small` | - -### Configuration parameters - -| Name | Description | Value | -| -------- | -------------------- | ----- | -| `topics` | Topics configuration | `[]` | +| `zookeeper.size` | Persistent Volume size for ZooKeeper | `5Gi` | +| `zookeeper.storageClass` | StorageClass used to store the ZooKeeper data | `""` | ## Parameter examples and reference diff --git a/packages/apps/kafka/values.schema.json b/packages/apps/kafka/values.schema.json index 5082ffd1..54ffe956 100644 --- a/packages/apps/kafka/values.schema.json +++ b/packages/apps/kafka/values.schema.json @@ -7,24 +7,20 @@ "description": "Enable external access from outside the cluster", "default": false }, + "topics": { + "type": "array", + "description": "Topics configuration (see example)", + "default": [], + "items": {} + }, "kafka": { "type": "object", "properties": { - "size": { - "type": "string", - "description": "Persistent Volume size for Kafka", - "default": "10Gi" - }, "replicas": { "type": "number", "description": "Number of Kafka replicas", "default": 3 }, - "storageClass": { - "type": "string", - "description": "StorageClass used to store the Kafka data", - "default": "" - }, "resources": { "type": "object", "description": "Explicit CPU and memory configuration for each Kafka replica. When left empty, the preset defined in `resourcesPreset` is applied.", @@ -43,27 +39,27 @@ "xlarge", "2xlarge" ] + }, + "size": { + "type": "string", + "description": "Persistent Volume size for Kafka", + "default": "10Gi" + }, + "storageClass": { + "type": "string", + "description": "StorageClass used to store the Kafka data", + "default": "" } } }, "zookeeper": { "type": "object", "properties": { - "size": { - "type": "string", - "description": "Persistent Volume size for ZooKeeper", - "default": "5Gi" - }, "replicas": { "type": "number", "description": "Number of ZooKeeper replicas", "default": 3 }, - "storageClass": { - "type": "string", - "description": "StorageClass used to store the ZooKeeper data", - "default": "" - }, "resources": { "type": "object", "description": "Explicit CPU and memory configuration for each Zookeeper replica. When left empty, the preset defined in `resourcesPreset` is applied.", @@ -82,14 +78,18 @@ "xlarge", "2xlarge" ] + }, + "size": { + "type": "string", + "description": "Persistent Volume size for ZooKeeper", + "default": "5Gi" + }, + "storageClass": { + "type": "string", + "description": "StorageClass used to store the ZooKeeper data", + "default": "" } } - }, - "topics": { - "type": "array", - "description": "Topics configuration", - "default": [], - "items": {} } } } diff --git a/packages/apps/kafka/values.yaml b/packages/apps/kafka/values.yaml index 102ba3f0..f6ee0bb9 100644 --- a/packages/apps/kafka/values.yaml +++ b/packages/apps/kafka/values.yaml @@ -1,42 +1,12 @@ - ## @section Common parameters - -## @param external Enable external access from outside the cluster -## @param kafka.size Persistent Volume size for Kafka -## @param kafka.replicas Number of Kafka replicas -## @param kafka.storageClass StorageClass used to store the Kafka data -## @param zookeeper.size Persistent Volume size for ZooKeeper -## @param zookeeper.replicas Number of ZooKeeper replicas -## @param zookeeper.storageClass StorageClass used to store the ZooKeeper data ## +## @param external Enable external access from outside the cluster external: false -kafka: - size: 10Gi - replicas: 3 - storageClass: "" - ## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. - resourcesPreset: "small" -zookeeper: - size: 5Gi - replicas: 3 - storageClass: "" - ## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. - resourcesPreset: "small" -## @section Configuration parameters - -## @param topics Topics configuration +## @section Application-specific parameters +## +## @param topics Topics configuration (see example) ## Example: ## topics: ## - name: Results @@ -54,3 +24,41 @@ zookeeper: ## replicas: 3 ## topics: [] + +## @section Kafka configuration +## +kafka: + ## @param kafka.replicas Number of Kafka replicas + replicas: 3 + ## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. + resourcesPreset: "small" + ## @param kafka.size Persistent Volume size for Kafka + size: 10Gi + ## @param kafka.storageClass StorageClass used to store the Kafka data + storageClass: "" + + +## @section Zookeeper configuration +## +zookeeper: + ## @param zookeeper.replicas Number of ZooKeeper replicas + replicas: 3 + ## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. + resourcesPreset: "small" + ## @param zookeeper.size Persistent Volume size for ZooKeeper + size: 5Gi + ## @param zookeeper.storageClass StorageClass used to store the ZooKeeper data + storageClass: "" + + + diff --git a/packages/apps/kubernetes/README.md b/packages/apps/kubernetes/README.md index f0e720a4..0db94881 100644 --- a/packages/apps/kubernetes/README.md +++ b/packages/apps/kubernetes/README.md @@ -84,13 +84,17 @@ See the reference for components utilized in this service: ### Common Parameters -| Name | Description | Value | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------ | -| `host` | Hostname used to access the Kubernetes cluster externally. Defaults to `.` when empty. | `""` | -| `controlPlane.replicas` | Number of replicas for Kubernetes control-plane components. | `2` | -| `storageClass` | StorageClass used to store user data. | `replicated` | -| `version` | Kubernetes version given as vMAJOR.MINOR. Available are versions from 1.28 to 1.33. | `v1.32` | -| `nodeGroups` | nodeGroups configuration | `{}` | +| Name | Description | Value | +| -------------- | ------------------------------------- | ------------ | +| `storageClass` | StorageClass used to store user data. | `replicated` | + +### Application-specific parameters + +| Name | Description | Value | +| ------------ | ----------------------------------------------------------------------------------------------------------------- | ------- | +| `version` | Kubernetes version given as vMAJOR.MINOR. Available are versions from 1.28 to 1.33. | `v1.32` | +| `host` | Hostname used to access the Kubernetes cluster externally. Defaults to `.` when empty. | `""` | +| `nodeGroups` | Worker nodes configuration (see example) | `{}` | ### Cluster Addons @@ -101,9 +105,9 @@ See the reference for components utilized in this service: | `addons.cilium.valuesOverride` | Custom values to override | `{}` | | `addons.gatewayAPI.enabled` | Enable the Gateway API | `false` | | `addons.ingressNginx.enabled` | Enable the Ingress-NGINX controller (requires nodes labeled with the 'ingress-nginx' role). | `false` | -| `addons.ingressNginx.valuesOverride` | Custom values to override | `{}` | | `addons.ingressNginx.exposeMethod` | Method to expose the Ingress-NGINX controller. (allowed values: Proxied, LoadBalancer) | `Proxied` | | `addons.ingressNginx.hosts` | List of domain names that the parent cluster should route to this tenant cluster. Taken into account only when `exposeMethod` is set to `Proxied`. | `[]` | +| `addons.ingressNginx.valuesOverride` | Custom values to override | `{}` | | `addons.gpuOperator.enabled` | Enable the GPU-operator | `false` | | `addons.gpuOperator.valuesOverride` | Custom values to override | `{}` | | `addons.fluxcd.enabled` | Enable FluxCD | `false` | @@ -118,6 +122,7 @@ See the reference for components utilized in this service: | Name | Description | Value | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| `controlPlane.replicas` | Number of replicas for Kubernetes control-plane components. | `2` | | `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: 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. | `{}` | diff --git a/packages/apps/kubernetes/values.schema.json b/packages/apps/kubernetes/values.schema.json index d3807782..51000a2f 100644 --- a/packages/apps/kubernetes/values.schema.json +++ b/packages/apps/kubernetes/values.schema.json @@ -2,11 +2,169 @@ "title": "Chart Values", "type": "object", "properties": { + "storageClass": { + "type": "string", + "description": "StorageClass used to store user data.", + "default": "replicated" + }, + "version": { + "type": "string", + "description": "Kubernetes version given as vMAJOR.MINOR. Available are versions from 1.28 to 1.33.", + "default": "v1.32", + "enum": [ + "v1.28", + "v1.29", + "v1.30", + "v1.31", + "v1.32", + "v1.33" + ] + }, "host": { "type": "string", "description": "Hostname used to access the Kubernetes cluster externally. Defaults to `.` when empty.", "default": "" }, + "addons": { + "type": "object", + "properties": { + "certManager": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable cert-manager, which automatically creates and manages SSL/TLS certificates.", + "default": false + }, + "valuesOverride": { + "type": "object", + "description": "Custom values to override", + "default": {} + } + } + }, + "cilium": { + "type": "object", + "properties": { + "valuesOverride": { + "type": "object", + "description": "Custom values to override", + "default": {} + } + } + }, + "gatewayAPI": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable the Gateway API", + "default": false + } + } + }, + "ingressNginx": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable the Ingress-NGINX controller (requires nodes labeled with the 'ingress-nginx' role).", + "default": false + }, + "exposeMethod": { + "type": "string", + "description": "Method to expose the Ingress-NGINX controller. (allowed values: Proxied, LoadBalancer)", + "default": "Proxied", + "enum": [ + "Proxied", + "LoadBalancer" + ] + }, + "hosts": { + "type": "array", + "description": "List of domain names that the parent cluster should route to this tenant cluster. Taken into account only when `exposeMethod` is set to `Proxied`.", + "default": [], + "items": {} + }, + "valuesOverride": { + "type": "object", + "description": "Custom values to override", + "default": {} + } + } + }, + "gpuOperator": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable the GPU-operator", + "default": false + }, + "valuesOverride": { + "type": "object", + "description": "Custom values to override", + "default": {} + } + } + }, + "fluxcd": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable FluxCD", + "default": false + }, + "valuesOverride": { + "type": "object", + "description": "Custom values to override", + "default": {} + } + } + }, + "monitoringAgents": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable monitoring agents (Fluent Bit and VMAgents) to send logs and metrics. If tenant monitoring is enabled, data is sent to tenant storage; otherwise, it goes to root storage.", + "default": false + }, + "valuesOverride": { + "type": "object", + "description": "Custom values to override", + "default": {} + } + } + }, + "verticalPodAutoscaler": { + "type": "object", + "properties": { + "valuesOverride": { + "type": "object", + "description": "Custom values to override", + "default": {} + } + } + }, + "velero": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable velero for backup and restore k8s cluster.", + "default": false + }, + "valuesOverride": { + "type": "object", + "description": "Custom values to override", + "default": {} + } + } + } + } + }, "controlPlane": { "type": "object", "properties": { @@ -117,164 +275,6 @@ } } } - }, - "storageClass": { - "type": "string", - "description": "StorageClass used to store user data.", - "default": "replicated" - }, - "version": { - "type": "string", - "description": "Kubernetes version given as vMAJOR.MINOR. Available are versions from 1.28 to 1.33.", - "default": "v1.32", - "enum": [ - "v1.28", - "v1.29", - "v1.30", - "v1.31", - "v1.32", - "v1.33" - ] - }, - "addons": { - "type": "object", - "properties": { - "certManager": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable cert-manager, which automatically creates and manages SSL/TLS certificates.", - "default": false - }, - "valuesOverride": { - "type": "object", - "description": "Custom values to override", - "default": {} - } - } - }, - "cilium": { - "type": "object", - "properties": { - "valuesOverride": { - "type": "object", - "description": "Custom values to override", - "default": {} - } - } - }, - "gatewayAPI": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable the Gateway API", - "default": false - } - } - }, - "ingressNginx": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable the Ingress-NGINX controller (requires nodes labeled with the 'ingress-nginx' role).", - "default": false - }, - "valuesOverride": { - "type": "object", - "description": "Custom values to override", - "default": {} - }, - "exposeMethod": { - "type": "string", - "description": "Method to expose the Ingress-NGINX controller. (allowed values: Proxied, LoadBalancer)", - "default": "Proxied", - "enum": [ - "Proxied", - "LoadBalancer" - ] - }, - "hosts": { - "type": "array", - "description": "List of domain names that the parent cluster should route to this tenant cluster. Taken into account only when `exposeMethod` is set to `Proxied`.", - "default": [], - "items": {} - } - } - }, - "gpuOperator": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable the GPU-operator", - "default": false - }, - "valuesOverride": { - "type": "object", - "description": "Custom values to override", - "default": {} - } - } - }, - "fluxcd": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable FluxCD", - "default": false - }, - "valuesOverride": { - "type": "object", - "description": "Custom values to override", - "default": {} - } - } - }, - "monitoringAgents": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable monitoring agents (Fluent Bit and VMAgents) to send logs and metrics. If tenant monitoring is enabled, data is sent to tenant storage; otherwise, it goes to root storage.", - "default": false - }, - "valuesOverride": { - "type": "object", - "description": "Custom values to override", - "default": {} - } - } - }, - "verticalPodAutoscaler": { - "type": "object", - "properties": { - "valuesOverride": { - "type": "object", - "description": "Custom values to override", - "default": {} - } - } - }, - "velero": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable velero for backup and restore k8s cluster.", - "default": false - }, - "valuesOverride": { - "type": "object", - "description": "Custom values to override", - "default": {} - } - } - } - } } } } diff --git a/packages/apps/kubernetes/values.yaml b/packages/apps/kubernetes/values.yaml index de4fe5d1..133e0d52 100644 --- a/packages/apps/kubernetes/values.yaml +++ b/packages/apps/kubernetes/values.yaml @@ -1,14 +1,14 @@ ## @section Common Parameters -## @param host Hostname used to access the Kubernetes cluster externally. Defaults to `.` when empty. -## @param controlPlane.replicas Number of replicas for Kubernetes control-plane components. ## @param storageClass StorageClass used to store user data. -## @param version Kubernetes version given as vMAJOR.MINOR. Available are versions from 1.28 to 1.33. -## -host: "" storageClass: replicated + +## @section Application-specific parameters +## @param version Kubernetes version given as vMAJOR.MINOR. Available are versions from 1.28 to 1.33. version: "v1.32" -## @param nodeGroups [object] nodeGroups configuration +## @param host Hostname used to access the Kubernetes cluster externally. Defaults to `.` when empty. +host: "" +## @param nodeGroups [object] Worker nodes configuration (see example) ## nodeGroups: md0: @@ -34,13 +34,12 @@ nodeGroups: ## @section Cluster Addons ## addons: - ## Cert-manager: automatically creates and manages SSL/TLS certificate ## certManager: ## @param addons.certManager.enabled Enable cert-manager, which automatically creates and manages SSL/TLS certificates. - ## @param addons.certManager.valuesOverride Custom values to override enabled: false + ## @param addons.certManager.valuesOverride Custom values to override valuesOverride: {} ## Cilium CNI plugin @@ -59,18 +58,17 @@ addons: ## ingressNginx: ## @param addons.ingressNginx.enabled Enable the Ingress-NGINX controller (requires nodes labeled with the 'ingress-nginx' role). - ## @param addons.ingressNginx.valuesOverride Custom values to override - ## enabled: false ## @param addons.ingressNginx.exposeMethod Method to expose the Ingress-NGINX controller. (allowed values: Proxied, LoadBalancer) + exposeMethod: Proxied ## @param addons.ingressNginx.hosts List of domain names that the parent cluster should route to this tenant cluster. Taken into account only when `exposeMethod` is set to `Proxied`. ## e.g: ## hosts: ## - example.org ## - foo.example.net ## - exposeMethod: Proxied hosts: [] + ## @param addons.ingressNginx.valuesOverride Custom values to override valuesOverride: {} ## GPU-operator: NVIDIA GPU Operator @@ -117,12 +115,12 @@ addons: ## @section Kubernetes Control Plane Configuration ## - controlPlane: + ## @param controlPlane.replicas Number of replicas for Kubernetes control-plane components. replicas: 2 - apiServer: ## @param controlPlane.apiServer.resources Explicit CPU and memory configuration for the API Server. When left empty, the preset defined in `resourcesPreset` is applied. + resources: {} ## @param controlPlane.apiServer.resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. ## e.g: ## resources: @@ -130,7 +128,6 @@ controlPlane: ## memory: 4Gi ## resourcesPreset: "medium" - resources: {} controllerManager: ## @param controlPlane.controllerManager.resources Explicit CPU and memory configuration for the Controller Manager. When left empty, the preset defined in `resourcesPreset` is applied. diff --git a/packages/apps/mysql/README.md b/packages/apps/mysql/README.md index 48eed4a2..19ce3ece 100644 --- a/packages/apps/mysql/README.md +++ b/packages/apps/mysql/README.md @@ -68,14 +68,16 @@ more details: ### Common parameters -| Name | Description | Value | -| -------------- | ----------------------------------------------- | ------- | -| `external` | Enable external access from outside the cluster | `false` | -| `size` | Persistent Volume size | `10Gi` | -| `replicas` | Number of MariaDB replicas | `2` | -| `storageClass` | StorageClass used to store the data | `""` | +| Name | Description | Value | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------- | +| `replicas` | Number of MariaDB replicas | `2` | +| `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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| `size` | Persistent Volume size | `10Gi` | +| `storageClass` | StorageClass used to store the data | `""` | +| `external` | Enable external access from outside the cluster | `false` | -### Configuration parameters +### Application-specific parameters | Name | Description | Value | | ----------- | ----------------------- | ----- | @@ -84,18 +86,16 @@ more details: ### Backup parameters -| 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: 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` | ## Parameter examples and reference diff --git a/packages/apps/mysql/values.schema.json b/packages/apps/mysql/values.schema.json index 6b5ef0ae..c2a2feae 100644 --- a/packages/apps/mysql/values.schema.json +++ b/packages/apps/mysql/values.schema.json @@ -2,26 +2,45 @@ "title": "Chart Values", "type": "object", "properties": { - "external": { - "type": "boolean", - "description": "Enable external access from outside the cluster", - "default": false + "replicas": { + "type": "number", + "description": "Number of MariaDB replicas", + "default": 2 + }, + "resources": { + "type": "object", + "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": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", + "default": "nano", + "enum": [ + "nano", + "micro", + "small", + "medium", + "large", + "xlarge", + "2xlarge" + ] }, "size": { "type": "string", "description": "Persistent Volume size", "default": "10Gi" }, - "replicas": { - "type": "number", - "description": "Number of MariaDB replicas", - "default": 2 - }, "storageClass": { "type": "string", "description": "StorageClass used to store the data", "default": "" }, + "external": { + "type": "boolean", + "description": "Enable external access from outside the cluster", + "default": false + }, "backup": { "type": "object", "properties": { @@ -66,25 +85,6 @@ "default": "ChaXoveekoh6eigh4siesheeda2quai0" } } - }, - "resources": { - "type": "object", - "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": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", - "default": "nano", - "enum": [ - "nano", - "micro", - "small", - "medium", - "large", - "xlarge", - "2xlarge" - ] } } } diff --git a/packages/apps/mysql/values.yaml b/packages/apps/mysql/values.yaml index acc6f532..eea2b7ff 100644 --- a/packages/apps/mysql/values.yaml +++ b/packages/apps/mysql/values.yaml @@ -1,17 +1,23 @@ ## @section Common parameters - -## @param external Enable external access from outside the cluster -## @param size Persistent Volume size -## @param replicas Number of MariaDB replicas -## @param storageClass StorageClass used to store the data ## -external: false -size: 10Gi +## @param replicas Number of MariaDB replicas replicas: 2 +## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. +resourcesPreset: "nano" +## @param size Persistent Volume size +size: 10Gi +## @param storageClass StorageClass used to store the data storageClass: "" +## @param external Enable external access from outside the cluster +external: false -## @section Configuration parameters - +## @section Application-specific parameters +## ## @param users [object] Users configuration ## Example: ## users: @@ -36,7 +42,7 @@ users: {} databases: {} ## @section Backup parameters - +## ## @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 @@ -55,11 +61,3 @@ backup: s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog resticPassword: ChaXoveekoh6eigh4siesheeda2quai0 -## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. -resourcesPreset: "nano" diff --git a/packages/apps/nats/README.md b/packages/apps/nats/README.md index 0249b518..9875a21a 100644 --- a/packages/apps/nats/README.md +++ b/packages/apps/nats/README.md @@ -7,18 +7,23 @@ It provides a data layer for cloud native applications, IoT messaging, and micro ### 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` | 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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| Name | Description | Value | +| ----------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `replicas` | Number of replicas | `2` | +| `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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| `storageClass` | StorageClass used to store the data | `""` | +| `external` | Enable external access from outside the cluster | `false` | + +### Application-specific parameters + +| Name | Description | Value | +| ------------------- | ------------------------------------------------------------------------- | ------ | +| `users` | Users configuration (see example) | `{}` | +| `jetstream.enabled` | Enable or disable Jetstream | `true` | +| `jetstream.size` | Jetstream persistent storage size | `10Gi` | +| `config.merge` | Additional configuration to merge into NATS config (see example) | `{}` | +| `config.resolver` | Additional resolver configuration to merge into NATS config (see example) | `{}` | ## Parameter examples and reference diff --git a/packages/apps/nats/values.schema.json b/packages/apps/nats/values.schema.json index ece5062d..34848c8d 100644 --- a/packages/apps/nats/values.schema.json +++ b/packages/apps/nats/values.schema.json @@ -2,51 +2,11 @@ "title": "Chart Values", "type": "object", "properties": { - "external": { - "type": "boolean", - "description": "Enable external access from outside the cluster", - "default": false - }, "replicas": { "type": "number", - "description": "Persistent Volume size for NATS", + "description": "Number of replicas", "default": 2 }, - "storageClass": { - "type": "string", - "description": "StorageClass used to store the data", - "default": "" - }, - "jetstream": { - "type": "object", - "properties": { - "size": { - "type": "string", - "description": "Jetstream persistent storage size", - "default": "10Gi" - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable Jetstream", - "default": true - } - } - }, - "config": { - "type": "object", - "properties": { - "merge": { - "type": "object", - "description": "Additional configuration to merge into NATS config", - "default": {} - }, - "resolver": { - "type": "object", - "description": "Additional configuration to merge into NATS config", - "default": {} - } - } - }, "resources": { "type": "object", "description": "Explicit CPU and memory configuration for each NATS replica. When left empty, the preset defined in `resourcesPreset` is applied.", @@ -65,6 +25,46 @@ "xlarge", "2xlarge" ] + }, + "storageClass": { + "type": "string", + "description": "StorageClass used to store the data", + "default": "" + }, + "external": { + "type": "boolean", + "description": "Enable external access from outside the cluster", + "default": false + }, + "jetstream": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable Jetstream", + "default": true + }, + "size": { + "type": "string", + "description": "Jetstream persistent storage size", + "default": "10Gi" + } + } + }, + "config": { + "type": "object", + "properties": { + "merge": { + "type": "object", + "description": "Additional configuration to merge into NATS config (see example)", + "default": {} + }, + "resolver": { + "type": "object", + "description": "Additional resolver configuration to merge into NATS config (see example)", + "default": {} + } + } } } } diff --git a/packages/apps/nats/values.yaml b/packages/apps/nats/values.yaml index 8dc02d1d..6b5a7fb5 100644 --- a/packages/apps/nats/values.yaml +++ b/packages/apps/nats/values.yaml @@ -1,14 +1,22 @@ - ## @section Common parameters - -## @param external Enable external access from outside the cluster -## @param replicas Persistent Volume size for NATS -## @param storageClass StorageClass used to store the data ## -external: false +## @param replicas Number of replicas replicas: 2 +## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. +resourcesPreset: "nano" +## @param storageClass StorageClass used to store the data storageClass: "" -## @param users [object] Users configuration +## @param external Enable external access from outside the cluster +external: false + +## @section Application-specific parameters +## +## @param users [object] Users configuration (see example) ## Example: ## users: ## user1: @@ -17,18 +25,17 @@ storageClass: "" users: {} jetstream: + ## @param jetstream.enabled Enable or disable Jetstream + ## Set to true to enable Jetstream for persistent messaging in NATS. + ## Default: true + enabled: true ## @param jetstream.size Jetstream persistent storage size ## Specifies the size of the persistent storage for Jetstream (message store). ## Default: 10Gi size: 10Gi - ## @param jetstream.enabled Enable or disable Jetstream - ## Set to true to enable Jetstream for persistent messaging in NATS. - ## Default: true - enabled: true - config: - ## @param config.merge Additional configuration to merge into NATS config + ## @param config.merge Additional configuration to merge into NATS config (see example) ## Allows you to customize NATS server settings by merging additional configurations. ## For example, you can add extra parameters, configure authentication, or set custom settings. ## Default: {} @@ -56,17 +63,9 @@ config: ## include ./my-config-last.conf; ## } merge: {} - ## @param config.resolver Additional configuration to merge into NATS config + ## @param config.resolver Additional resolver configuration to merge into NATS config (see example) ## Allows you to customize NATS server settings by merging resolver configurations. ## Default: {} - ## Example see: https://github.com/nats-io/k8s/blob/main/helm/charts/nats/values.yaml#L247 + ## Example: https://github.com/nats-io/k8s/blob/94414664c254b0bbac3a07fc9693f6c4f8f88709/helm/charts/nats/values.yaml#L248-L270 resolver: {} -## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. -resourcesPreset: "nano" diff --git a/packages/apps/postgres/README.md b/packages/apps/postgres/README.md index 9d9dd00c..c8a9f37d 100644 --- a/packages/apps/postgres/README.md +++ b/packages/apps/postgres/README.md @@ -66,22 +66,24 @@ See: ### 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 | `""` | -| `postgresql.parameters.max_connections` | Determines the maximum number of concurrent connections to the database server. The default is typically 100 connections | `100` | -| `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 | +| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `replicas` | Number of Postgres replicas | `2` | +| `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: nano, micro, small, medium, large, xlarge, 2xlarge. | `micro` | +| `size` | Persistent Volume size | `10Gi` | +| `storageClass` | StorageClass used to store the data | `""` | +| `external` | Enable external access from outside the cluster | `false` | -### Configuration parameters +### Application-specific parameters -| Name | Description | Value | -| ----------- | ----------------------- | ----- | -| `users` | Users configuration | `{}` | -| `databases` | Databases configuration | `{}` | +| Name | Description | Value | +| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----- | +| `postgresql.parameters.max_connections` | Determines the maximum number of concurrent connections to the database server. The default is typically 100 connections | `100` | +| `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` | +| `users` | Users configuration | `{}` | +| `databases` | Databases configuration | `{}` | ### Backup parameters @@ -95,15 +97,13 @@ See: | `backup.s3AccessKey` | Access key for S3, used for authentication | `oobaiRus9pah8PhohL1ThaeTa4UVa7gu` | | `backup.s3SecretKey` | Secret key for S3, used for authentication | `ju3eum4dekeich9ahM1te8waeGai0oog` | -### Bootstrap parameters +### Bootstrap (recovery) parameters -| Name | Description | Value | -| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | ------- | -| `bootstrap.enabled` | Restore database cluster from a backup | `false` | -| `bootstrap.recoveryTime` | Timestamp (PITR) up to which recovery will proceed, expressed in RFC 3339 format. If left empty, will restore latest | `""` | -| `bootstrap.oldName` | Name of database 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: nano, micro, small, medium, large, xlarge, 2xlarge. | `micro` | +| Name | Description | Value | +| ------------------------ | -------------------------------------------------------------------------------------------------------------------- | ------- | +| `bootstrap.enabled` | Restore database cluster from a backup | `false` | +| `bootstrap.recoveryTime` | Timestamp (PITR) up to which recovery will proceed, expressed in RFC 3339 format. If left empty, will restore latest | `""` | +| `bootstrap.oldName` | Name of database cluster before deleting | `""` | ## Parameter examples and reference diff --git a/packages/apps/postgres/values.schema.json b/packages/apps/postgres/values.schema.json index f4f1a625..03a0d88f 100644 --- a/packages/apps/postgres/values.schema.json +++ b/packages/apps/postgres/values.schema.json @@ -2,26 +2,45 @@ "title": "Chart Values", "type": "object", "properties": { - "external": { - "type": "boolean", - "description": "Enable external access from outside the cluster", - "default": false + "replicas": { + "type": "number", + "description": "Number of Postgres replicas", + "default": 2 + }, + "resources": { + "type": "object", + "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": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", + "default": "micro", + "enum": [ + "nano", + "micro", + "small", + "medium", + "large", + "xlarge", + "2xlarge" + ] }, "size": { "type": "string", "description": "Persistent Volume size", "default": "10Gi" }, - "replicas": { - "type": "number", - "description": "Number of Postgres replicas", - "default": 2 - }, "storageClass": { "type": "string", "description": "StorageClass used to store the data", "default": "" }, + "external": { + "type": "boolean", + "description": "Enable external access from outside the cluster", + "default": false + }, "postgresql": { "type": "object", "properties": { @@ -116,25 +135,6 @@ "default": "" } } - }, - "resources": { - "type": "object", - "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": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", - "default": "micro", - "enum": [ - "nano", - "micro", - "small", - "medium", - "large", - "xlarge", - "2xlarge" - ] } } } diff --git a/packages/apps/postgres/values.yaml b/packages/apps/postgres/values.yaml index 43eac383..25aa091e 100644 --- a/packages/apps/postgres/values.yaml +++ b/packages/apps/postgres/values.yaml @@ -1,30 +1,35 @@ ## @section Common parameters - -## @param external Enable external access from outside the cluster -## @param size Persistent Volume size -## @param replicas Number of Postgres replicas -## @param storageClass StorageClass used to store the data ## -external: false -size: 10Gi +## @param replicas Number of Postgres replicas replicas: 2 +## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. +resourcesPreset: "micro" +## @param size Persistent Volume size +size: 10Gi +## @param storageClass StorageClass used to store the data storageClass: "" +## @param external Enable external access from outside the cluster +external: false -## Server Configuration + +## @section Application-specific parameters +## ## @param postgresql.parameters.max_connections Determines the maximum number of concurrent connections to the database server. The default is typically 100 connections postgresql: parameters: max_connections: 100 -## 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). quorum: minSyncReplicas: 0 maxSyncReplicas: 0 -## @section Configuration parameters - ## @param users [object] Users configuration ## Example: ## users: @@ -75,7 +80,7 @@ backup: s3AccessKey: oobaiRus9pah8PhohL1ThaeTa4UVa7gu s3SecretKey: ju3eum4dekeich9ahM1te8waeGai0oog -## @section Bootstrap parameters +## @section Bootstrap (recovery) parameters ## @param bootstrap.enabled Restore database cluster from a backup ## @param bootstrap.recoveryTime Timestamp (PITR) up to which recovery will proceed, expressed in RFC 3339 format. If left empty, will restore latest @@ -87,11 +92,3 @@ bootstrap: recoveryTime: "" oldName: "" -## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. -resourcesPreset: "micro" diff --git a/packages/apps/rabbitmq/README.md b/packages/apps/rabbitmq/README.md index 34f0d8c1..fbbd9133 100644 --- a/packages/apps/rabbitmq/README.md +++ b/packages/apps/rabbitmq/README.md @@ -13,21 +13,21 @@ The service utilizes official RabbitMQ operator. This ensures the reliability an ### Common parameters -| Name | Description | Value | -| -------------- | ----------------------------------------------- | ------- | -| `external` | Enable external access from outside the cluster | `false` | -| `size` | Persistent Volume size | `10Gi` | -| `replicas` | Number of RabbitMQ replicas | `3` | -| `storageClass` | StorageClass used to store the data | `""` | +| Name | Description | Value | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `replicas` | Number of RabbitMQ replicas | `3` | +| `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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| `size` | Persistent Volume size | `10Gi` | +| `storageClass` | StorageClass used to store the data | `""` | +| `external` | Enable external access from outside the cluster | `false` | -### Configuration parameters +### Application-specific parameters -| 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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| Name | Description | Value | +| -------- | --------------------------- | ----- | +| `users` | Users configuration | `{}` | +| `vhosts` | Virtual Hosts configuration | `{}` | ## Parameter examples and reference diff --git a/packages/apps/rabbitmq/values.schema.json b/packages/apps/rabbitmq/values.schema.json index 74f13a3c..5e3137d6 100644 --- a/packages/apps/rabbitmq/values.schema.json +++ b/packages/apps/rabbitmq/values.schema.json @@ -2,31 +2,11 @@ "title": "Chart Values", "type": "object", "properties": { - "external": { - "type": "boolean", - "description": "Enable external access from outside the cluster", - "default": false - }, - "size": { - "type": "string", - "description": "Persistent Volume size", - "default": "10Gi" - }, "replicas": { "type": "number", "description": "Number of RabbitMQ replicas", "default": 3 }, - "storageClass": { - "type": "string", - "description": "StorageClass used to store the data", - "default": "" - }, - "vhosts": { - "type": "object", - "description": "Virtual Hosts configuration", - "default": {} - }, "resources": { "type": "object", "description": "Explicit CPU and memory configuration for each RabbitMQ replica. When left empty, the preset defined in `resourcesPreset` is applied.", @@ -45,6 +25,26 @@ "xlarge", "2xlarge" ] + }, + "size": { + "type": "string", + "description": "Persistent Volume size", + "default": "10Gi" + }, + "storageClass": { + "type": "string", + "description": "StorageClass used to store the data", + "default": "" + }, + "external": { + "type": "boolean", + "description": "Enable external access from outside the cluster", + "default": false + }, + "vhosts": { + "type": "object", + "description": "Virtual Hosts configuration", + "default": {} } } } diff --git a/packages/apps/rabbitmq/values.yaml b/packages/apps/rabbitmq/values.yaml index b649f873..8435e387 100644 --- a/packages/apps/rabbitmq/values.yaml +++ b/packages/apps/rabbitmq/values.yaml @@ -1,17 +1,24 @@ ## @section Common parameters - -## @param external Enable external access from outside the cluster -## @param size Persistent Volume size -## @param replicas Number of RabbitMQ replicas -## @param storageClass StorageClass used to store the data ## -external: false -size: 10Gi +## @param replicas Number of RabbitMQ replicas replicas: 3 +## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. +resourcesPreset: "nano" +## @param size Persistent Volume size +size: 10Gi +## @param storageClass StorageClass used to store the data storageClass: "" +## @param external Enable external access from outside the cluster +external: false -## @section Configuration parameters +## @section Application-specific parameters +## ## @param users [object] Users configuration ## Example: ## users: @@ -40,11 +47,3 @@ users: {} ## - user3 vhosts: {} -## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. -resourcesPreset: "nano" diff --git a/packages/apps/redis/README.md b/packages/apps/redis/README.md index 822f4808..6ed7603a 100644 --- a/packages/apps/redis/README.md +++ b/packages/apps/redis/README.md @@ -15,13 +15,18 @@ Service utilizes the Spotahome Redis Operator for efficient management and orche | 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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| `size` | Persistent Volume size | `1Gi` | +| `storageClass` | StorageClass used to store the data | `""` | +| `external` | Enable external access from outside the cluster | `false` | + +### Application-specific parameters + +| Name | Description | Value | +| ------------- | -------------------------- | ------ | +| `authEnabled` | Enable password generation | `true` | ## Parameter examples and reference diff --git a/packages/apps/redis/values.schema.json b/packages/apps/redis/values.schema.json index f774384d..8547d908 100644 --- a/packages/apps/redis/values.schema.json +++ b/packages/apps/redis/values.schema.json @@ -2,31 +2,11 @@ "title": "Chart Values", "type": "object", "properties": { - "external": { - "type": "boolean", - "description": "Enable external access from outside the cluster", - "default": false - }, - "size": { - "type": "string", - "description": "Persistent Volume size", - "default": "1Gi" - }, "replicas": { "type": "number", "description": "Number of Redis replicas", "default": 2 }, - "storageClass": { - "type": "string", - "description": "StorageClass used to store the data", - "default": "" - }, - "authEnabled": { - "type": "boolean", - "description": "Enable password generation", - "default": true - }, "resources": { "type": "object", "description": "Explicit CPU and memory configuration for each Redis replica. When left empty, the preset defined in `resourcesPreset` is applied.", @@ -45,6 +25,26 @@ "xlarge", "2xlarge" ] + }, + "size": { + "type": "string", + "description": "Persistent Volume size", + "default": "1Gi" + }, + "storageClass": { + "type": "string", + "description": "StorageClass used to store the data", + "default": "" + }, + "external": { + "type": "boolean", + "description": "Enable external access from outside the cluster", + "default": false + }, + "authEnabled": { + "type": "boolean", + "description": "Enable password generation", + "default": true } } } diff --git a/packages/apps/redis/values.yaml b/packages/apps/redis/values.yaml index 602cf3bc..0058ac52 100644 --- a/packages/apps/redis/values.yaml +++ b/packages/apps/redis/values.yaml @@ -1,22 +1,23 @@ ## @section Common parameters - -## @param external Enable external access from outside the cluster -## @param size Persistent Volume size -## @param replicas Number of Redis replicas -## @param storageClass StorageClass used to store the data -## @param authEnabled Enable password generation ## -external: false -size: 1Gi +## @param replicas Number of Redis replicas replicas: 2 -storageClass: "" -authEnabled: true - ## @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 - + # resources: + # cpu: 4000m + # memory: 4Gi ## @param resourcesPreset Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. resourcesPreset: "nano" +## @param size Persistent Volume size +size: 1Gi +## @param storageClass StorageClass used to store the data +storageClass: "" +## @param external Enable external access from outside the cluster +external: false + + +## @section Application-specific parameters +## +## @param authEnabled Enable password generation +authEnabled: true diff --git a/packages/apps/tcp-balancer/README.md b/packages/apps/tcp-balancer/README.md index 3f85fb70..2236dff5 100644 --- a/packages/apps/tcp-balancer/README.md +++ b/packages/apps/tcp-balancer/README.md @@ -12,23 +12,23 @@ Managed TCP Load Balancer Service efficiently utilizes HAProxy for load balancin ### Common parameters -| Name | Description | Value | -| ---------- | ----------------------------------------------- | ------- | -| `external` | Enable external access from outside the cluster | `false` | -| `replicas` | Number of HAProxy replicas | `2` | +| Name | Description | Value | +| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `replicas` | Number of HAProxy replicas | `2` | +| `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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| `external` | Enable external access from outside the cluster | `false` | -### Configuration parameters +### Application-specific 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` | 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: 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 whitelisting client networks | `false` | +| `whitelist` | List of client networks | `[]` | ## Parameter examples and reference diff --git a/packages/apps/tcp-balancer/values.schema.json b/packages/apps/tcp-balancer/values.schema.json index e063e5c4..9035f06f 100644 --- a/packages/apps/tcp-balancer/values.schema.json +++ b/packages/apps/tcp-balancer/values.schema.json @@ -2,16 +2,35 @@ "title": "Chart Values", "type": "object", "properties": { - "external": { - "type": "boolean", - "description": "Enable external access from outside the cluster", - "default": false - }, "replicas": { "type": "number", "description": "Number of HAProxy replicas", "default": 2 }, + "resources": { + "type": "object", + "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": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", + "default": "nano", + "enum": [ + "nano", + "micro", + "small", + "medium", + "large", + "xlarge", + "2xlarge" + ] + }, + "external": { + "type": "boolean", + "description": "Enable external access from outside the cluster", + "default": false + }, "httpAndHttps": { "type": "object", "properties": { @@ -49,7 +68,7 @@ }, "whitelistHTTP": { "type": "boolean", - "description": "Secure HTTP by enabling client networks whitelisting", + "description": "Secure HTTP by whitelisting client networks", "default": false }, "whitelist": { @@ -57,25 +76,6 @@ "description": "List of client networks", "default": [], "items": {} - }, - "resources": { - "type": "object", - "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": "Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.", - "default": "nano", - "enum": [ - "nano", - "micro", - "small", - "medium", - "large", - "xlarge", - "2xlarge" - ] } } } diff --git a/packages/apps/tcp-balancer/values.yaml b/packages/apps/tcp-balancer/values.yaml index 47ee3b61..7684ca55 100644 --- a/packages/apps/tcp-balancer/values.yaml +++ b/packages/apps/tcp-balancer/values.yaml @@ -1,18 +1,27 @@ ## @section Common parameters - -## @param external Enable external access from outside the cluster -## @param replicas Number of HAProxy replicas ## -external: false +## @param replicas Number of HAProxy replicas replicas: 2 +## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. +resourcesPreset: "nano" +## +## @param external Enable external access from outside the cluster +external: false -## @section Configuration parameters +## @section Application-specific parameters +## ## @param httpAndHttps.mode Mode for balancer. Allowed values: `tcp` and `tcp-with-proxy` ## @param httpAndHttps.targetPorts.http HTTP port number. ## @param httpAndHttps.targetPorts.https HTTPS port number. ## @param httpAndHttps.endpoints Endpoint addresses list ## Example: +## ## httpAndHttps: ## mode: tcp ## targetPorts: @@ -33,7 +42,7 @@ httpAndHttps: https: 443 endpoints: [] -## @param whitelistHTTP Secure HTTP by enabling client networks whitelisting +## @param whitelistHTTP Secure HTTP by whitelisting client networks ## @param whitelist List of client networks ## Example: ## whitelistHTTP: true @@ -44,11 +53,3 @@ httpAndHttps: whitelistHTTP: false whitelist: [] -## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. -resourcesPreset: "nano" diff --git a/packages/apps/vpn/README.md b/packages/apps/vpn/README.md index 691738c0..01f1fd25 100644 --- a/packages/apps/vpn/README.md +++ b/packages/apps/vpn/README.md @@ -19,20 +19,20 @@ Furthermore, Shadowbox is compatible with standard Shadowsocks clients, providin ### Common parameters -| Name | Description | Value | -| ---------- | ----------------------------------------------- | ------- | -| `external` | Enable external access from outside the cluster | `false` | -| `replicas` | Number of VPN server replicas | `2` | +| Name | Description | Value | +| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `replicas` | Number of VPN server replicas | `2` | +| `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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| `external` | Enable external access from outside the cluster | `false` | -### Configuration parameters +### Application-specific parameters -| 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: nano, micro, small, medium, large, xlarge, 2xlarge. | `nano` | +| Name | Description | Value | +| ------------- | ----------------------------------------------------------------------------------------------------- | ----- | +| `host` | Host used to substitute into generated URLs | `""` | +| `users` | Users configuration (see example) | `{}` | +| `externalIPs` | List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default. | `[]` | ## Parameter examples and reference diff --git a/packages/apps/vpn/values.schema.json b/packages/apps/vpn/values.schema.json index 0fb124f6..0b88a90b 100644 --- a/packages/apps/vpn/values.schema.json +++ b/packages/apps/vpn/values.schema.json @@ -2,29 +2,11 @@ "title": "Chart Values", "type": "object", "properties": { - "external": { - "type": "boolean", - "description": "Enable external access from outside the cluster", - "default": false - }, "replicas": { "type": "number", "description": "Number of VPN server replicas", "default": 2 }, - "host": { - "type": "string", - "description": "Host used to substitute into generated URLs", - "default": "" - }, - "externalIPs": { - "type": "array", - "description": "List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.", - "default": "[]", - "items": { - "type": "string" - } - }, "resources": { "type": "object", "description": "Explicit CPU and memory configuration for each VPN server replica. When left empty, the preset defined in `resourcesPreset` is applied.", @@ -43,6 +25,24 @@ "xlarge", "2xlarge" ] + }, + "external": { + "type": "boolean", + "description": "Enable external access from outside the cluster", + "default": false + }, + "host": { + "type": "string", + "description": "Host used to substitute into generated URLs", + "default": "" + }, + "externalIPs": { + "type": "array", + "description": "List of externalIPs for service. Optional. If not specified will use LoadBalancer service by default.", + "default": "[]", + "items": { + "type": "string" + } } } } diff --git a/packages/apps/vpn/values.yaml b/packages/apps/vpn/values.yaml index 14df4880..eafa58be 100644 --- a/packages/apps/vpn/values.yaml +++ b/packages/apps/vpn/values.yaml @@ -1,17 +1,25 @@ ## @section Common parameters - -## @param external Enable external access from outside the cluster -## @param replicas Number of VPN server replicas ## -external: false +## @param replicas Number of VPN server replicas replicas: 2 +## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. +resourcesPreset: "nano" +## @param external Enable external access from outside the cluster +external: false -## @section Configuration parameters +## @section Application-specific parameters +## ## @param host Host used to substitute into generated URLs host: "" -## @param users [object] Users configuration +## @param users [object] Users configuration (see example) ## Example: ## users: ## user1: @@ -29,11 +37,3 @@ users: {} ## externalIPs: [] -## @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 Default sizing preset used when `resources` is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge. -resourcesPreset: "nano"