From 4bbae53cdaac1bb69e312d8b015ee119ea43b3a2 Mon Sep 17 00:00:00 2001 From: Timofei Larkin Date: Fri, 16 May 2025 16:41:44 +0300 Subject: [PATCH] [docs] fix linter issues Signed-off-by: Timofei Larkin --- packages/apps/bucket/README.md | 3 + packages/apps/bucket/values.schema.json | 5 ++ packages/apps/bucket/values.yaml | 1 + packages/apps/kubernetes/README.md | 48 +++++++++--- packages/apps/kubernetes/values.schema.json | 87 ++++++++++++++++++++- 5 files changed, 131 insertions(+), 13 deletions(-) create mode 100644 packages/apps/bucket/README.md create mode 100644 packages/apps/bucket/values.schema.json create mode 100644 packages/apps/bucket/values.yaml diff --git a/packages/apps/bucket/README.md b/packages/apps/bucket/README.md new file mode 100644 index 00000000..89749b1d --- /dev/null +++ b/packages/apps/bucket/README.md @@ -0,0 +1,3 @@ +# S3 bucket + +## Parameters diff --git a/packages/apps/bucket/values.schema.json b/packages/apps/bucket/values.schema.json new file mode 100644 index 00000000..a40437af --- /dev/null +++ b/packages/apps/bucket/values.schema.json @@ -0,0 +1,5 @@ +{ + "title": "Chart Values", + "type": "object", + "properties": {} +} diff --git a/packages/apps/bucket/values.yaml b/packages/apps/bucket/values.yaml new file mode 100644 index 00000000..0967ef42 --- /dev/null +++ b/packages/apps/bucket/values.yaml @@ -0,0 +1 @@ +{} diff --git a/packages/apps/kubernetes/README.md b/packages/apps/kubernetes/README.md index bbc55cfd..32b7b055 100644 --- a/packages/apps/kubernetes/README.md +++ b/packages/apps/kubernetes/README.md @@ -27,20 +27,44 @@ How to access to deployed cluster: kubectl get secret -n kubernetes--admin-kubeconfig -o go-template='{{ printf "%s\n" (index .data "super-admin.conf" | base64decode) }}' > test ``` -# Series +## Parameters - +### Common parameters -. | U | O | CX | M | RT -----------------------------|-----|-----|------|-----|------ -*Has GPUs* | | | | | -*Hugepages* | | | ✓ | ✓ | ✓ -*Overcommitted Memory* | | ✓ | | | -*Dedicated CPU* | | | ✓ | | ✓ -*Burstable CPU performance* | ✓ | ✓ | | ✓ | -*Isolated emulator threads* | | | ✓ | | ✓ -*vNUMA* | | | ✓ | | ✓ -*vCPU-To-Memory Ratio* | 1:4 | 1:4 | 1:2 | 1:8 | 1:4 +| Name | Description | Value | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| `host` | The hostname used to access the Kubernetes cluster externally (defaults to using the cluster name as a subdomain for the tenant host). | `""` | +| `controlPlane.replicas` | Number of replicas for Kubernetes contorl-plane components | `2` | +| `storageClass` | StorageClass used to store user data | `replicated` | +| `nodeGroups` | nodeGroups configuration | `{}` | + +### Cluster Addons + +| Name | Description | Value | +| --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `addons.certManager.enabled` | Enables the cert-manager | `false` | +| `addons.certManager.valuesOverride` | Custom values to override | `{}` | +| `addons.ingressNginx.enabled` | Enable Ingress-NGINX controller (expect nodes with 'ingress-nginx' role) | `false` | +| `addons.ingressNginx.valuesOverride` | Custom values to override | `{}` | +| `addons.ingressNginx.hosts` | List of domain names that should be passed through to the cluster by upper cluster | `[]` | +| `addons.fluxcd.enabled` | Enables Flux CD | `false` | +| `addons.fluxcd.valuesOverride` | Custom values to override | `{}` | +| `addons.monitoringAgents.enabled` | Enables MonitoringAgents (fluentbit, vmagents for sending logs and metrics to storage) if tenant monitoring enabled, send to tenant storage, else to root storage | `false` | +| `addons.monitoringAgents.valuesOverride` | Custom values to override | `{}` | +| `addons.verticalPodAutoscaler.valuesOverride` | Custom values to override | `{}` | + +### Kamaji control plane + +| Name | Description | Value | +| --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `kamajiControlPlane.apiServer.resources` | Resources | `{}` | +| `kamajiControlPlane.apiServer.resourcesPreset` | Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production). | `small` | +| `kamajiControlPlane.controllerManager.resources` | Resources | `{}` | +| `kamajiControlPlane.controllerManager.resourcesPreset` | Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production). | `micro` | +| `kamajiControlPlane.scheduler.resources` | Resources | `{}` | +| `kamajiControlPlane.scheduler.resourcesPreset` | Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production). | `micro` | +| `kamajiControlPlane.addons.konnectivity.server.resources` | Resources | `{}` | +| `kamajiControlPlane.addons.konnectivity.server.resourcesPreset` | Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production). | `micro` | ## U Series diff --git a/packages/apps/kubernetes/values.schema.json b/packages/apps/kubernetes/values.schema.json index ed0de279..f630a41e 100644 --- a/packages/apps/kubernetes/values.schema.json +++ b/packages/apps/kubernetes/values.schema.json @@ -90,8 +90,93 @@ "default": {} } } + }, + "verticalPodAutoscaler": { + "type": "object", + "properties": { + "valuesOverride": { + "type": "object", + "description": "Custom values to override", + "default": {} + } + } + } + } + }, + "kamajiControlPlane": { + "type": "object", + "properties": { + "apiServer": { + "type": "object", + "properties": { + "resources": { + "type": "object", + "description": "Resources", + "default": {} + }, + "resourcesPreset": { + "type": "string", + "description": "Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production).", + "default": "small" + } + } + }, + "controllerManager": { + "type": "object", + "properties": { + "resources": { + "type": "object", + "description": "Resources", + "default": {} + }, + "resourcesPreset": { + "type": "string", + "description": "Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production).", + "default": "micro" + } + } + }, + "scheduler": { + "type": "object", + "properties": { + "resources": { + "type": "object", + "description": "Resources", + "default": {} + }, + "resourcesPreset": { + "type": "string", + "description": "Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production).", + "default": "micro" + } + } + }, + "addons": { + "type": "object", + "properties": { + "konnectivity": { + "type": "object", + "properties": { + "server": { + "type": "object", + "properties": { + "resources": { + "type": "object", + "description": "Resources", + "default": {} + }, + "resourcesPreset": { + "type": "string", + "description": "Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production).", + "default": "micro" + } + } + } + } + } + } } } } } -} +} \ No newline at end of file