From 37d1f21aba46cb5e10831d03fade281135ca80f7 Mon Sep 17 00:00:00 2001 From: Sergey Vlasov Date: Mon, 23 Sep 2024 13:49:34 +0500 Subject: [PATCH] Change variables naming (#506) * [stat-receiver] Change variables naming --------- Co-authored-by: Sergey Vlasov --- charts/stat-receiver/README.md | 80 +++++++++---------- .../configs/streams/application.conf.template | 2 +- .../templates/api/configmap.yaml | 5 +- .../templates/api/deployment.yaml | 11 +-- .../stat-receiver/templates/api/ingress.yaml | 4 +- .../stat-receiver/templates/api/service.yaml | 6 +- charts/stat-receiver/templates/helpers.tpl | 16 ++-- .../templates/streams/configmap.yaml | 4 +- .../templates/streams/deployment.yaml | 10 +-- .../templates/streams/headless-service.yaml | 6 +- charts/stat-receiver/values.yaml | 29 ++++--- 11 files changed, 85 insertions(+), 88 deletions(-) diff --git a/charts/stat-receiver/README.md b/charts/stat-receiver/README.md index 6e6295204..0444fdd00 100644 --- a/charts/stat-receiver/README.md +++ b/charts/stat-receiver/README.md @@ -53,39 +53,50 @@ helm upgrade stat-receiver 2gis-on-premise/stat-receiver -f values-stat-receiver | Name | Description | Value | | --------------------- | --------------------------------------------------------------------------------------- | ----- | | `dgctlDockerRegistry` | Docker Registry endpoint where On-Premise services' images reside. Format: `host:port`. | `""` | +| `imagePullSecrets` | Kubernetes image pull secrets. | `[]` | ### API service settings -| Name | Description | Value | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| `api` | **Common settings** | | -| `api.replicas` | A replica count for the pod. | `1` | -| `api.revisionHistoryLimit` | Revision history limit (used for [rolling back](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) a deployment). | `3` | -| `api.jvmXmx` | Memory allocation options for JVM. | `-Xmx1500m` | -| `api.image` | **Deployment settings** | | -| `api.image.repository` | Repository | `2gis-on-premise/stat-receiver-api` | -| `api.image.tag` | Tag | `1.11.1` | -| `api.image.pullPolicy` | Pull Policy | `IfNotPresent` | -| `api.service` | **Service settings** | | -| `api.service.type` | Kubernetes [service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types). | `ClusterIP` | -| `api.service.port` | Service port. | `80` | -| `api.service.targetPort` | Port inside the container. | `8080` | +| Name | Description | Value | +| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | +| `api` | **Common settings** | | +| `api.replicas` | A replica count for the pod. | `1` | +| `api.revisionHistoryLimit` | Revision history limit (used for [rolling back](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) a deployment). | `3` | +| `api.jvmXmx` | Memory allocation options for JVM. | `-Xmx1500m` | +| `api.image` | **Deployment settings** | | +| `api.image.repository` | Repository | `2gis-on-premise/stat-receiver-api` | +| `api.image.tag` | Tag | `1.11.1` | +| `api.image.pullPolicy` | Pull Policy | `IfNotPresent` | +| `api.service` | **Service settings** | | +| `api.service.type` | Kubernetes [service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types). | `ClusterIP` | +| `api.service.port` | Service port. | `80` | +| `api.service.targetPort` | Port inside the container. | `8080` | +| `api.resources` | **Limits for the API service** | | +| `api.resources.requests.cpu` | A CPU request. | `0.5` | +| `api.resources.requests.memory` | A memory request. | `1500Mi` | +| `api.resources.limits.cpu` | A CPU limit. | `1` | +| `api.resources.limits.memory` | A memory limit. | `1500Mi` | ### Streams service settings -| Name | Description | Value | -| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -| `streams` | **Common settings** | | -| `streams.replicas` | A replica count for the pod. | `1` | -| `streams.revisionHistoryLimit` | Revision history limit (used for [rolling back](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) a deployment). | `3` | -| `streams.jvmXmx` | Memory allocation options for JVM. | `-Xmx2G -XX:+UseParallelGC` | -| `streams.jmxPort` | Port for JMX protocol. | `9010` | -| `streams.metricsPort` | Port for metrics. | `8081` | -| `streams.storageSize` | Size of ephemeral disk that holds temporary files | `500Mi` | -| `streams.image` | **Deployment settings** | | -| `streams.image.repository` | Repository | `2gis-on-premise/stat-receiver-streams` | -| `streams.image.tag` | Tag | `1.11.1` | -| `streams.image.pullPolicy` | Pull Policy | `IfNotPresent` | +| Name | Description | Value | +| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | +| `streams` | **Common settings** | | +| `streams.replicas` | A replica count for the pod. | `1` | +| `streams.revisionHistoryLimit` | Revision history limit (used for [rolling back](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) a deployment). | `3` | +| `streams.jvmXmx` | Memory allocation options for JVM. | `-Xmx2G -XX:+UseParallelGC` | +| `streams.jmxPort` | Port for JMX protocol. | `9010` | +| `streams.metricsPort` | Port for metrics. | `8081` | +| `streams.storageSize` | Size of ephemeral disk that holds temporary files | `500Mi` | +| `streams.image` | **Deployment settings** | | +| `streams.image.repository` | Repository | `2gis-on-premise/stat-receiver-streams` | +| `streams.image.tag` | Tag | `1.11.1` | +| `streams.image.pullPolicy` | Pull Policy | `IfNotPresent` | +| `streams.resources` | **Limits for the Streams service** | | +| `streams.resources.requests.cpu` | A CPU request. | `1` | +| `streams.resources.requests.memory` | A memory request. | `4G` | +| `streams.resources.limits.cpu` | A CPU limit. | `2` | +| `streams.resources.limits.memory` | A memory limit. | `4G` | ### Kafka service settings @@ -124,21 +135,6 @@ helm upgrade stat-receiver 2gis-on-premise/stat-receiver -f values-stat-receiver | `ingress.enabled` | If Ingress is enabled for the service. | `false` | | `ingress.hosts[0].host` | Hostname for the Ingress service. | `stat-receiver.host` | -### Limits - -| Name | Description | Value | -| ----------------------------------- | ---------------------------------- | -------- | -| `api.resources` | **Limits for the API service** | | -| `api.resources.requests.cpu` | A CPU request. | `0.5` | -| `api.resources.requests.memory` | A memory request. | `1500Mi` | -| `api.resources.limits.cpu` | A CPU limit. | `1` | -| `api.resources.limits.memory` | A memory limit. | `1500Mi` | -| `streams.resources` | **Limits for the Streams service** | | -| `streams.resources.requests.cpu` | A CPU request. | `1` | -| `streams.resources.requests.memory` | A memory request. | `4G` | -| `streams.resources.limits.cpu` | A CPU limit. | `2` | -| `streams.resources.limits.memory` | A memory limit. | `4G` | - ## Maintainers diff --git a/charts/stat-receiver/configs/streams/application.conf.template b/charts/stat-receiver/configs/streams/application.conf.template index e04f03baa..d34c24b4e 100644 --- a/charts/stat-receiver/configs/streams/application.conf.template +++ b/charts/stat-receiver/configs/streams/application.conf.template @@ -53,7 +53,7 @@ streams = { "rocksdb.shared.block.cache.size" = 536870912 # 512Mb "bootstrap.servers" = {{ required "A valid .Values.kafka.servers entry required" .Values.kafka.servers | quote }} {{- if .Values.kafka.sasl.mechanism }} - "sasl.mechanism" = {{ .Values.kafka.saslMechanism }} + "sasl.mechanism" = {{ .Values.kafka.sasl.mechanism }} {{- end }} {{- if .Values.kafka.securityProtocol }} "security.protocol" = {{ .Values.kafka.securityProtocol }} diff --git a/charts/stat-receiver/templates/api/configmap.yaml b/charts/stat-receiver/templates/api/configmap.yaml index f8ce8eb9d..4ee1e5b31 100644 --- a/charts/stat-receiver/templates/api/configmap.yaml +++ b/charts/stat-receiver/templates/api/configmap.yaml @@ -3,11 +3,12 @@ apiVersion: v1 kind: ConfigMap metadata: - name: {{ include "bss-receiver-api.name" . }} + name: {{ include "stat-receiver-api.name" . }} labels: - {{- include "bss-receiver-api.labels" . | nindent 4 }} + {{- include "stat-receiver-api.labels" . | nindent 4 }} data: application.conf: |- {{- tpl (.Files.Get "configs/api/application.conf.template") . | nindent 4 }} logback.xml: |- {{- .Files.Get "configs/api/logback.xml" | nindent 4 }} + \ No newline at end of file diff --git a/charts/stat-receiver/templates/api/deployment.yaml b/charts/stat-receiver/templates/api/deployment.yaml index 4cfb8f72b..e961bac2a 100644 --- a/charts/stat-receiver/templates/api/deployment.yaml +++ b/charts/stat-receiver/templates/api/deployment.yaml @@ -1,13 +1,13 @@ apiVersion: apps/v1 kind: Deployment metadata: - name: {{ include "bss-receiver-api.name" . }} + name: {{ include "stat-receiver-api.name" . }} {{- if .Values.api.annotations }} annotations: {{- toYaml .Values.api.annotations | nindent 4 }} {{- end }} labels: - {{- include "bss-receiver-api.labels" . | nindent 4 }} + {{- include "stat-receiver-api.labels" . | nindent 4 }} {{- if .Values.api.labels }} {{- toYaml .Values.api.labels | nindent 4 }} {{- end }} @@ -21,11 +21,11 @@ spec: type: RollingUpdate selector: matchLabels: - {{- include "bss-receiver-api.selectorLabels" . | nindent 6 }} + {{- include "stat-receiver-api.selectorLabels" . | nindent 6 }} template: metadata: labels: - {{- include "bss-receiver-api.labels" . | nindent 8 }} + {{- include "stat-receiver-api.labels" . | nindent 8 }} {{- if .Values.api.labels }} {{- toYaml .Values.api.labels | nindent 8 }} {{- end }} @@ -95,7 +95,7 @@ spec: volumes: - name: config-volume configMap: - name: {{ include "bss-receiver-api.name" . }} + name: {{ include "stat-receiver-api.name" . }} {{- if .Values.kafka.truststore.enabled }} - name: kafka-truststore secret: @@ -106,3 +106,4 @@ spec: secret: secretName: {{ .Values.kafka.keystore.secretName }} {{- end }} + \ No newline at end of file diff --git a/charts/stat-receiver/templates/api/ingress.yaml b/charts/stat-receiver/templates/api/ingress.yaml index a5f3a6243..104aa312e 100644 --- a/charts/stat-receiver/templates/api/ingress.yaml +++ b/charts/stat-receiver/templates/api/ingress.yaml @@ -1,12 +1,12 @@ {{- if .Values.ingress.enabled -}} -{{- $fullName := include "bss-receiver-api.name" . -}} +{{- $fullName := include "stat-receiver-api.name" . -}} {{- $svcPort := .Values.api.service.port -}} apiVersion: networking.k8s.io/v1 kind: Ingress metadata: name: {{ $fullName }} labels: - {{- include "bss-receiver-api.labels" . | nindent 4 }} + {{- include "stat-receiver-api.labels" . | nindent 4 }} {{- with .Values.ingress.annotations }} annotations: {{- toYaml . | nindent 4 }} diff --git a/charts/stat-receiver/templates/api/service.yaml b/charts/stat-receiver/templates/api/service.yaml index 03feeee8e..2c52efa4e 100644 --- a/charts/stat-receiver/templates/api/service.yaml +++ b/charts/stat-receiver/templates/api/service.yaml @@ -3,13 +3,13 @@ apiVersion: v1 kind: Service metadata: - name: {{ include "bss-receiver-api.name" . }} + name: {{ include "stat-receiver-api.name" . }} {{- if .Values.api.service.annotations }} annotations: {{- toYaml .Values.api.service.annotations | nindent 4 }} {{- end }} labels: - {{- include "bss-receiver-api.labels" . | nindent 4 }} + {{- include "stat-receiver-api.labels" . | nindent 4 }} {{- if .Values.api.service.labels }} {{- toYaml .Values.api.service.labels | nindent 4 }} {{- end }} @@ -22,4 +22,4 @@ spec: name: http appProtocol: http selector: - {{- include "bss-receiver-api.selectorLabels" . | nindent 4 }} + {{- include "stat-receiver-api.selectorLabels" . | nindent 4 }} diff --git a/charts/stat-receiver/templates/helpers.tpl b/charts/stat-receiver/templates/helpers.tpl index 168dff0ab..adba0ec24 100644 --- a/charts/stat-receiver/templates/helpers.tpl +++ b/charts/stat-receiver/templates/helpers.tpl @@ -1,28 +1,28 @@ -{{- define "bss-receiver-api.name" -}} +{{- define "stat-receiver-api.name" -}} {{- printf "%s-api" .Release.Name | trunc 32 | trimSuffix "-" }} {{- end }} -{{- define "bss-receiver-streams.name" -}} +{{- define "stat-receiver-streams.name" -}} {{- printf "%s-streams" .Release.Name | trunc 32 | trimSuffix "-" }} {{- end }} -{{- define "bss-receiver-api.selectorLabels" -}} +{{- define "stat-receiver-api.selectorLabels" -}} app.kubernetes.io/name: {{ .Chart.Name }} app.kubernetes.io/instance: {{ printf "%s-api" .Release.Name }} {{- end }} -{{- define "bss-receiver-api.labels" -}} -{{ include "bss-receiver-api.selectorLabels" . }} +{{- define "stat-receiver-api.labels" -}} +{{ include "stat-receiver-api.selectorLabels" . }} app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} {{- end }} -{{- define "bss-receiver-streams.selectorLabels" -}} +{{- define "stat-receiver-streams.selectorLabels" -}} app.kubernetes.io/name: {{ .Chart.Name }} app.kubernetes.io/instance: {{ printf "%s-streams" .Release.Name }} {{- end }} -{{- define "bss-receiver-streams.labels" -}} -{{ include "bss-receiver-streams.selectorLabels" . }} +{{- define "stat-receiver-streams.labels" -}} +{{ include "stat-receiver-streams.selectorLabels" . }} app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} {{- end }} diff --git a/charts/stat-receiver/templates/streams/configmap.yaml b/charts/stat-receiver/templates/streams/configmap.yaml index 63148a125..e0d797eed 100644 --- a/charts/stat-receiver/templates/streams/configmap.yaml +++ b/charts/stat-receiver/templates/streams/configmap.yaml @@ -1,9 +1,9 @@ apiVersion: v1 kind: ConfigMap metadata: - name: {{ include "bss-receiver-streams.name" . }} + name: {{ include "stat-receiver-streams.name" . }} labels: - {{- include "bss-receiver-streams.labels" . | nindent 4 }} + {{- include "stat-receiver-streams.labels" . | nindent 4 }} data: application.conf: |- {{- tpl (.Files.Get "configs/streams/application.conf.template") . | nindent 4 }} diff --git a/charts/stat-receiver/templates/streams/deployment.yaml b/charts/stat-receiver/templates/streams/deployment.yaml index 23dfee688..f2b9fb3ec 100644 --- a/charts/stat-receiver/templates/streams/deployment.yaml +++ b/charts/stat-receiver/templates/streams/deployment.yaml @@ -1,13 +1,13 @@ apiVersion: apps/v1 kind: Deployment metadata: - name: {{ include "bss-receiver-streams.name" . }} + name: {{ include "stat-receiver-streams.name" . }} {{- if .Values.streams.annotations }} annotations: {{- toYaml .Values.streams.annotations | nindent 4 }} {{- end }} labels: - {{- include "bss-receiver-streams.labels" . | nindent 4 }} + {{- include "stat-receiver-streams.labels" . | nindent 4 }} {{- if .Values.streams.labels }} {{- toYaml .Values.streams.labels | nindent 4 }} {{- end }} @@ -21,11 +21,11 @@ spec: type: RollingUpdate selector: matchLabels: - {{- include "bss-receiver-streams.selectorLabels" . | nindent 6 }} + {{- include "stat-receiver-streams.selectorLabels" . | nindent 6 }} template: metadata: labels: - {{- include "bss-receiver-streams.labels" . | nindent 8 }} + {{- include "stat-receiver-streams.labels" . | nindent 8 }} {{- if .Values.streams.labels }} {{- toYaml .Values.streams.labels | nindent 8 }} {{- end }} @@ -100,7 +100,7 @@ spec: volumes: - name: config-volume configMap: - name: {{ include "bss-receiver-streams.name" . }} + name: {{ include "stat-receiver-streams.name" . }} - name: data-volume emptyDir: sizeLimit: {{ .Values.streams.storageSize }} diff --git a/charts/stat-receiver/templates/streams/headless-service.yaml b/charts/stat-receiver/templates/streams/headless-service.yaml index fd8482af0..ee7bc7366 100644 --- a/charts/stat-receiver/templates/streams/headless-service.yaml +++ b/charts/stat-receiver/templates/streams/headless-service.yaml @@ -3,12 +3,12 @@ apiVersion: v1 kind: Service metadata: - name: {{ include "bss-receiver-streams.name" . }}-headless + name: {{ include "stat-receiver-streams.name" . }}-headless labels: - {{- include "bss-receiver-streams.labels" . | nindent 4 }} + {{- include "stat-receiver-streams.labels" . | nindent 4 }} spec: type: ClusterIP clusterIP: None publishNotReadyAddresses: true selector: - {{- include "bss-receiver-streams.selectorLabels" . | nindent 4 }} + {{- include "stat-receiver-streams.selectorLabels" . | nindent 4 }} diff --git a/charts/stat-receiver/values.yaml b/charts/stat-receiver/values.yaml index 3921fba10..5012833e0 100644 --- a/charts/stat-receiver/values.yaml +++ b/charts/stat-receiver/values.yaml @@ -1,8 +1,10 @@ # @section Docker Registry settings # @param dgctlDockerRegistry Docker Registry endpoint where On-Premise services' images reside. Format: `host:port`. +# @param imagePullSecrets Kubernetes image pull secrets. dgctlDockerRegistry: '' +imagePullSecrets: [] # @section API service settings @@ -38,6 +40,12 @@ api: port: 80 targetPort: 8080 + # @extra api.resources **Limits for the API service** + # @param api.resources.requests.cpu A CPU request. + # @param api.resources.requests.memory A memory request. + # @param api.resources.limits.cpu A CPU limit. + # @param api.resources.limits.memory A memory limit. + resources: requests: cpu: 0.5 @@ -77,6 +85,12 @@ streams: tag: 1.11.1 pullPolicy: IfNotPresent + # @extra streams.resources **Limits for the Streams service** + # @param streams.resources.requests.cpu A CPU request. + # @param streams.resources.requests.memory A memory request. + # @param streams.resources.limits.cpu A CPU limit. + # @param streams.resources.limits.memory A memory limit. + resources: requests: cpu: 1 @@ -154,18 +168,3 @@ ingress: enabled: false hosts: - host: stat-receiver.host - - -# @section Limits - -# @extra api.resources **Limits for the API service** -# @param api.resources.requests.cpu A CPU request. -# @param api.resources.requests.memory A memory request. -# @param api.resources.limits.cpu A CPU limit. -# @param api.resources.limits.memory A memory limit. - -# @extra streams.resources **Limits for the Streams service** -# @param streams.resources.requests.cpu A CPU request. -# @param streams.resources.requests.memory A memory request. -# @param streams.resources.limits.cpu A CPU limit. -# @param streams.resources.limits.memory A memory limit.