Skip to content

Commit 0a95bd0

Browse files
author
valeraBr
committed
edit readme
1 parent f62d742 commit 0a95bd0

File tree

1 file changed

+29
-26
lines changed

1 file changed

+29
-26
lines changed

README.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -43,32 +43,35 @@ The following table lists the configurable parameters of the SuperStream chart a
4343

4444
| Parameter | Description | Default |
4545
|-----------|-------------|---------|
46-
| `superstream.environment` | Deployment environment (e.g., staging, production). | `""` |
47-
| `superstream.serviceAccount.create` | Specifies whether a service account should be created. | `true` |
48-
| `superstream.serviceAccount.annotations` | Annotations to add to the service account. | `{}` |
49-
| `superstream.serviceAccount.name` | The name of the service account to use. | `""` |
50-
| `initContainers.image` | Image used for readiness checks or setup tasks. | `curlimages/curl:8.6.0` |
51-
| `dataPlane.releaseDate` | Release date for the backend component. | `"2024-02-22-13-03"` |
52-
| `dataPlane.replicaCount` | Number of replicas for the backend deployment. | `2` |
53-
| `dataPlane.image.repository` | Docker image repository for the backend service. | `memphisos/superstream-data-plane-be` |
54-
| `dataPlane.image.pullPolicy` | Policy for pulling the image. | `Always` |
55-
| `dataPlane.image.tag` | Overrides the image tag. | `"latest"` |
56-
| `dataPlane.imagePullSecrets` | Image pull secrets. | `""` |
57-
| `dataPlane.configMap.enable` | Enable ConfigMap settings. | `""` |
58-
| `dataPlane.secret.name` | Secret configuration for sensitive information. | `superstream-creds` |
59-
| `dataPlane.service.enabled` | Enable service for the backend. | `false` |
60-
| `dataPlane.service.type` | Type of service for the backend. | `ClusterIP` |
61-
| `dataPlane.service.port` | Port for the backend service. | `8888` |
62-
| `dataPlane.ingress.enabled` | Enable ingress for the backend. | `false` |
63-
| `dataPlane.resources.limits.cpu` | CPU limit for the backend pod. | `500m` |
64-
| `dataPlane.resources.limits.memory` | Memory limit for the backend pod. | `500Mi` |
65-
| `dataPlane.resources.requests.cpu` | CPU request for the backend pod. | `50m` |
66-
| `dataPlane.resources.requests.memory` | Memory request for the backend pod. | `100Mi` |
67-
| `dataPlane.autoscaling.enabled` | Enable autoscaling for the backend. | `true` |
68-
| `dataPlane.autoscaling.minReplicas` | Minimum number of replicas for autoscaling. | `2` |
69-
| `dataPlane.autoscaling.maxReplicas` | Maximum number of replicas for autoscaling. | `5` |
70-
| `dataPlane.autoscaling.targetCPUUtilizationPercentage` | CPU utilization percentage for autoscaling. | `75` |
71-
| `dataPlane.autoscaling.targetMemoryUtilizationPercentage` | Memory utilization percentage for autoscaling. | `75` |
46+
| `global.environment` | Define the superstream engine name within 32 characters, excluding '.', and using only lowercase letters, numbers, '-', and '_'. | `""` |
47+
| `global.accountId` | Provide the account ID associated with the deployment, which could be used for identifying resources or configurations tied to a specific account. | `""` |
48+
| `global.activationToken` | Enter the activation token required for services or resources that need an initial token for activation or authentication. | `""` |
49+
| `global.skipLocalAuthentication` | Specifies whether to skip local authentication. | `true` |
50+
| `superstreamEngine.serviceAccount.create` | Specifies whether a service account should be created. | `true` |
51+
| `superstreamEngine.serviceAccount.annotations` | Annotations to add to the service account. | `{}` |
52+
| `superstreamEngine.serviceAccount.name` | The name of the service account to use. | `""` |
53+
| `superstreamEngineinitContainers.image` | Image used for readiness checks or setup tasks. | `curlimages/curl:8.6.0` |
54+
| `superstreamEngine.releaseDate` | Release date for the backend component. | `"2024-02-22-13-03"` |
55+
| `superstreamEngine.replicaCount` | Number of replicas for the backend deployment. | `2` |
56+
| `superstreamEngine.image.repository` | Docker image repository for the backend service. | `memphisos/superstream-data-plane-be` |
57+
| `superstreamEngine.image.pullPolicy` | Policy for pulling the image. | `Always` |
58+
| `superstreamEngine.image.tag` | Overrides the image tag. | `"latest"` |
59+
| `superstreamEngine.imagePullSecrets` | Image pull secrets. | `""` |
60+
| `superstreamEngine.configMap.enable` | Enable ConfigMap settings. | `""` |
61+
| `superstreamEngine.secret.name` | Secret configuration for sensitive information. | `superstream-creds` |
62+
| `superstreamEngine.service.enabled` | Enable service for the backend. | `false` |
63+
| `superstreamEngine.service.type` | Type of service for the backend. | `ClusterIP` |
64+
| `superstreamEngine.service.port` | Port for the backend service. | `8888` |
65+
| `superstreamEngine.ingress.enabled` | Enable ingress for the backend. | `false` |
66+
| `superstreamEngine.resources.limits.cpu` | CPU limit for the backend pod. | `500m` |
67+
| `superstreamEngine.resources.limits.memory` | Memory limit for the backend pod. | `500Mi` |
68+
| `superstreamEngine.resources.requests.cpu` | CPU request for the backend pod. | `50m` |
69+
| `superstreamEngine.resources.requests.memory` | Memory request for the backend pod. | `100Mi` |
70+
| `superstreamEngine.autoscaling.enabled` | Enable autoscaling for the backend. | `true` |
71+
| `superstreamEngine.autoscaling.minReplicas` | Minimum number of replicas for autoscaling. | `2` |
72+
| `superstreamEngine.autoscaling.maxReplicas` | Maximum number of replicas for autoscaling. | `5` |
73+
| `superstreamEngine.autoscaling.targetCPUUtilizationPercentage` | CPU utilization percentage for autoscaling. | `75` |
74+
| `superstreamEngine.autoscaling.targetMemoryUtilizationPercentage` | Memory utilization percentage for autoscaling. | `75` |
7275
| `syslog.replicaCount` | Number of replicas for the syslog deployment. | `1` |
7376
| `syslog.image.repository` | Docker image repository for syslog. | `linuxserver/syslog-ng` |
7477
| `syslog.image.pullPolicy` | Pull policy for the syslog image. | `IfNotPresent` |

0 commit comments

Comments
 (0)