Skip to content

Commit

Permalink
Merge pull request #153 from superstreamlabs/qa
Browse files Browse the repository at this point in the history
Qa
  • Loading branch information
bkochauri-memphis authored Oct 21, 2024
2 parents 93508f4 + b399494 commit c3d2802
Show file tree
Hide file tree
Showing 11 changed files with 267 additions and 166 deletions.
42 changes: 25 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,8 @@ nats:
# Kafka Autoscaler config
############################################################
# Optional service to automatically scale the Kafka cluster up/down based on CPU and memory metrics
superstreamEngine:
kafkaAutoScaler:
enabled: false
autoScaler:
enabled: true
```
To deploy it, run the following:
Expand All @@ -62,7 +61,11 @@ The following table lists the configurable parameters of the SuperStream chart a
| `global.labels` | Global labels to use for all container images in the chart. | `""` |
| `nats.config.cluster.enabled` | Indicates whether the NATS cluster is enabled. | `true` |
| `nats.config.jetstream.fileStore.pvc.storageClassName` | Specifies the storage class name for the Jetstream file store PVC. | `""` |
| `superstreamEngine.releaseDate` | Release date for the backend component. | `"2024-02-22-13-03"` |
| `nats.config.nats.tls.enabled` | Enables or disables TLS (Transport Layer Security) for the NATS server. Set to `true` to enable TLS. | `false` |
| `nats.config.nats.tls.secretName` | If provided, mounts an existing secret to the directory for TLS credentials. Useful for referencing pre-existing certificates and keys. | `""` |
| `nats.config.nats.tls.localCa.enabled` | Enables or disables the use of a local Certificate Authority (CA) for generating TLS certificates. | `false` |
| `nats.config.nats.tls.localCa.secretName` | The name of the secret containing the local CA’s certificates. Required if `nats.config.nats.tls.localCa.enabled` is set to `true`. | `false` |
| `superstreamEngine.releaseDate` | Release date for the backend component. | `""` |
| `superstreamEngine.replicaCount` | Number of replicas for the backend deployment. | `2` |
| `superstreamEngine.image.repository` | Docker image repository for the backend service. | `superstreamlabs/superstream-data-plane-be` |
| `superstreamEngine.image.pullPolicy` | Policy for pulling the image. | `Always` |
Expand Down Expand Up @@ -93,11 +96,6 @@ The following table lists the configurable parameters of the SuperStream chart a
| `superstreamEngine.service.enabled` | Enable service for the backend. | `true` |
| `superstreamEngine.service.type` | Type of service for the backend. | `ClusterIP` |
| `superstreamEngine.service.port` | Port for the backend service. | `7777` |
| `superstreamEngine.ingress.enabled` | Enable ingress for the backend. | `false` |
| `superstreamEngine.ingress.className` | Class name for the ingress resource. | `""` |
| `superstreamEngine.ingress.annotations` | Annotations to add to the ingress resource. | `{}` |
| `superstreamEngine.ingress.hosts` | Hosts for the ingress resource, including paths and path types. | `[{ host: "chart-example.local", paths: [{ path: "/", pathType: "ImplementationSpecific" }] }]` |
| `superstreamEngine.ingress.tls` | TLS settings for the ingress resource, including secret names and hosts. | `[]` |
| `superstreamEngine.resources.limits.cpu` | CPU limit for the backend pod. | `8` |
| `superstreamEngine.resources.limits.memory` | Memory limit for the backend pod. | `8Gi` |
| `superstreamEngine.resources.requests.cpu` | CPU request for the backend pod. | `500m` |
Expand All @@ -117,14 +115,24 @@ The following table lists the configurable parameters of the SuperStream chart a
| `superstreamEngine.syslog.enabled` | Determines whether the syslog is enabled for the superstream engine. | `true` |
| `superstreamEngine.syslog.remoteSyslog` | Remote syslog server to send logs to. | `"superstream-syslog"` |
| `superstreamEngine.releaseDate` | Release date for the backend component. | `"2024-03-20-11-12"`
| `superstreamEngine.kafkaAutoScaler.enabled` | Enables the Kafka auto-scaler. | `"false"` |
| `superstreamEngine.kafkaAutoScaler.image.repository` | Docker image repository for the Kafka auto-scaler. | `"superstreamlabs/superstream-kafka-auto-scaler"` |
| `superstreamEngine.kafkaAutoScaler.image.pullPolicy` | Policy for pulling the Docker image. | `Always` |
| `superstreamEngine.kafkaAutoScaler.image.tag` | Docker image tag (Overrides the image). | `"latest"` |
| `superstreamEngine.kafkaAutoScaler.resources.limits.cpu` | CPU limit for the auto-scaler. | `"2"` |
| `superstreamEngine.kafkaAutoScaler.resources.limits.memory` | Memory limit for the auto-scaler. | `"2Gi"` |
| `superstreamEngine.kafkaAutoScaler.resources.requests.cpu` | CPU request for the auto-scaler. | `"500m"` |
| `superstreamEngine.kafkaAutoScaler.resources.requests.memory` | Memory request for the auto-scaler. | `"500Mi"` |
| `autoScaler.enabled` | Enables the Kafka auto-scaler. | `"true"` |
| `autoScaler.releaseDate` | Release date for the autoscaler. | `""` |
| `autoScaler.replicaCount` | Enables the Kafka auto-scaler. | `"false"` |
| `autoScaler.image.repository` | Docker image repository for the Kafka auto-scaler. | `"superstreamlabs/superstream-kafka-auto-scaler"` |
| `autoScaler.image.pullPolicy` | Policy for pulling the Docker image. | `Always` |
| `autoScaler.image.tag` | Docker image tag (Overrides the image). | `"latest"` |
| `autoScaler.resources.limits.cpu` | CPU limit for the auto-scaler. | `"2"` |
| `autoScaler.resources.limits.memory` | Memory limit for the auto-scaler. | `"2Gi"` |
| `autoScaler.resources.requests.cpu` | CPU request for the auto-scaler. | `"500m"` |
| `autoScaler.resources.requests.memory` | Memory request for the auto-scaler. | `"500Mi"` |
| `autoScaler.autoscaling.enabled` | Enable autoscaling for the backend. | `true` |
| `autoScaler.autoscaling.minReplicas` | Minimum number of replicas for autoscaling. | `2` |
| `autoScaler.autoscaling.maxReplicas` | Maximum number of replicas for autoscaling. | `5` |
| `autoScaler.autoscaling.targetCPUUtilizationPercentage` | CPU utilization percentage for autoscaling. | `75` |
| `autoScaler.autoscaling.targetMemoryUtilizationPercentage` | Memory utilization percentage for autoscaling. | `75` |
| `autoScaler.nodeSelector` | Node selectors to control the placement of pods. | `{}` |
| `autoScaler.tolerations` | Tolerations for pods to tolerate certain node conditions or taints. | `[]` |
| `autoScaler.affinity` | Affinity rules for pod scheduling. | `{}` |
| `syslog.replicaCount` | Number of replicas for the syslog deployment. | `1` |
| `syslog.image.repository` | Docker image repository for syslog. | `linuxserver/syslog-ng` |
| `syslog.image.pullPolicy` | Pull policy for the syslog image. | `IfNotPresent` |
Expand Down
4 changes: 2 additions & 2 deletions charts/superstream/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.4.18
version: 0.4.19
# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "1.0.601"
appVersion: "1.0.700"
icon: https://memphis-public-files.s3.eu-central-1.amazonaws.com/superstream_logo.png
dependencies:
- name: nats
Expand Down
Loading

0 comments on commit c3d2802

Please sign in to comment.