From 195cee7021ed5fea8ea808522026b5790c44e120 Mon Sep 17 00:00:00 2001 From: Gennadiy Chechin Date: Fri, 21 Feb 2025 14:54:48 +0300 Subject: [PATCH] add helm chart --- .dockerignore | 1 + helm/dochub/.helmignore | 23 +++++++ helm/dochub/Chart.yaml | 24 +++++++ helm/dochub/README.md | 93 +++++++++++++++++++++++++++ helm/dochub/templates/NOTES.txt | 22 +++++++ helm/dochub/templates/_helpers.tpl | 62 ++++++++++++++++++ helm/dochub/templates/deployment.yaml | 75 +++++++++++++++++++++ helm/dochub/templates/hpa.yaml | 28 ++++++++ helm/dochub/templates/ingress.yaml | 61 ++++++++++++++++++ helm/dochub/templates/service.yaml | 15 +++++ helm/dochub/values.yaml | 93 +++++++++++++++++++++++++++ 11 files changed, 497 insertions(+) create mode 100644 helm/dochub/.helmignore create mode 100644 helm/dochub/Chart.yaml create mode 100644 helm/dochub/README.md create mode 100644 helm/dochub/templates/NOTES.txt create mode 100644 helm/dochub/templates/_helpers.tpl create mode 100644 helm/dochub/templates/deployment.yaml create mode 100644 helm/dochub/templates/hpa.yaml create mode 100644 helm/dochub/templates/ingress.yaml create mode 100644 helm/dochub/templates/service.yaml create mode 100644 helm/dochub/values.yaml diff --git a/.dockerignore b/.dockerignore index bc78819c..693c7200 100644 --- a/.dockerignore +++ b/.dockerignore @@ -6,3 +6,4 @@ node_modules dist .github pics +helm diff --git a/helm/dochub/.helmignore b/helm/dochub/.helmignore new file mode 100644 index 00000000..0e8a0eb3 --- /dev/null +++ b/helm/dochub/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/helm/dochub/Chart.yaml b/helm/dochub/Chart.yaml new file mode 100644 index 00000000..de4dde03 --- /dev/null +++ b/helm/dochub/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: dochub +description: A Helm chart for Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +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.1.0 + +# 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.16.0" diff --git a/helm/dochub/README.md b/helm/dochub/README.md new file mode 100644 index 00000000..c3a3d26f --- /dev/null +++ b/helm/dochub/README.md @@ -0,0 +1,93 @@ + +# Helm chart for Dochub + +Dochub is ArchOps tool. Dochub allows describing architecture as a code. + +## Prerequisites + +- Kubernetes 1.23+ +- Helm 3.8.0+ + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +helm install my-release helm/dochub -f helm/dochub/values.yaml +``` + +> **Tip**: List all releases using `helm list` + +### Securing traffic using TLS + +Dochub can encrypt communications by setting `tls` values. The chart allows configuration option: + +- Provide your own secret using the `tls.secretName` value. Also set the correct name of the `YOUR_HOST` value. + +### Use a different version + +To modify the application version used in this chart, specify a different version of the image using the `image.tag` parameter and/or a different repository using the `image.repository` parameter. + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```console +helm install my-release \ + --set image.tag=1.1 \ + helm/dochub -f helm/dochub/values.yaml +``` + +### Adding environment variables + +In case you want to add environment variables, you can use the `vars` property. + +```yaml +vars: + VUE_APP_DOCHUB_MODE: backend +``` + +### Setting Pod's affinity + +This chart allows you to set your custom affinity using the `affinity` parameter. Find more information about Pod's affinity in the [kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity). + + +### Ingress + +This chart provides support for ingress resources. If you have an ingress controller installed on your cluster, such as [nginx-ingress-controller](https://github.com/bitnami/charts/tree/main/bitnami/nginx-ingress-controller) you can utilize the ingress controller to serve your application. + +To enable ingress integration, please set `ingress.enabled` to `true`. + +## Parameters + +### Common parameters + +| Name | Description | Value | +| ------------------------ | --------------------------------------------------------------------------------------- | --------------- | +| `nameOverride` | String to partially override dochub.fullname template (will maintain the release name) | `""` | +| `fullnameOverride` | String to fully override dochub.fullname template | `""` | + + +### Dochub parameters + +| Name | Description | Value | +| ------------------------------ | ----------------------------------------------------------------------------------------------------- | ----------------------- | +| `image.repository` | Dochub image repository | `REPOSITORY_NAME/dochub` | +| `image.pullPolicy` | Dochub image pull policy | `Always` | +| `image.pullSecrets` | Specify docker-registry secret names as an array | `[]` | +| `command` | Override default container command (useful when using custom images) | `[]` | +| `args` | Override default container args (useful when using custom images) | `[]` | +| `vars` | Environment variables to be set on Dochub containers | `[]` | + + +## License + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/helm/dochub/templates/NOTES.txt b/helm/dochub/templates/NOTES.txt new file mode 100644 index 00000000..a0f32c6e --- /dev/null +++ b/helm/dochub/templates/NOTES.txt @@ -0,0 +1,22 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "dochub.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "dochub.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "dochub.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "dochub.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/helm/dochub/templates/_helpers.tpl b/helm/dochub/templates/_helpers.tpl new file mode 100644 index 00000000..245acd69 --- /dev/null +++ b/helm/dochub/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "dochub.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "dochub.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "dochub.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "dochub.labels" -}} +helm.sh/chart: {{ include "dochub.chart" . }} +{{ include "dochub.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "dochub.selectorLabels" -}} +app.kubernetes.io/name: {{ include "dochub.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "dochub.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "dochub.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/helm/dochub/templates/deployment.yaml b/helm/dochub/templates/deployment.yaml new file mode 100644 index 00000000..3ca60b5c --- /dev/null +++ b/helm/dochub/templates/deployment.yaml @@ -0,0 +1,75 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "dochub.fullname" . }} + labels: + {{- include "dochub.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "dochub.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "dochub.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "dochub.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + env: + {{- if .Values.vars }} + {{- $mergedVars := merge (.Values.vars | default (dict)) }} + {{- range $key, $val := $mergedVars }} + - name: {{ $key }} + value: {{ tpl ($val | toString) $ | quote }} + {{- end }} + {{- end }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + {{- if .Values.command }} + command: {{ .Values.command }} + {{- end }} + {{- if .Values.args }} + args: {{ .Values.args }} + {{- end }} + ports: + - name: http + containerPort: {{ .Values.service.targetPort }} + protocol: TCP + livenessProbe: + httpGet: + path: / + port: http + readinessProbe: + httpGet: + path: / + port: http + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/helm/dochub/templates/hpa.yaml b/helm/dochub/templates/hpa.yaml new file mode 100644 index 00000000..266523a7 --- /dev/null +++ b/helm/dochub/templates/hpa.yaml @@ -0,0 +1,28 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2beta1 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "dochub.fullname" . }} + labels: + {{- include "dochub.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "dochub.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/helm/dochub/templates/ingress.yaml b/helm/dochub/templates/ingress.yaml new file mode 100644 index 00000000..2372ebec --- /dev/null +++ b/helm/dochub/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "dochub.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }} + {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }} + {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}} + {{- end }} +{{- end }} +{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1 +{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1beta1 +{{- else -}} +apiVersion: extensions/v1beta1 +{{- end }} +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + {{- include "dochub.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }} + pathType: {{ .pathType }} + {{- end }} + backend: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} + service: + name: {{ $fullName }} + port: + number: {{ $svcPort }} + {{- else }} + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} + {{- end }} + {{- end }} +{{- end }} diff --git a/helm/dochub/templates/service.yaml b/helm/dochub/templates/service.yaml new file mode 100644 index 00000000..ae363ddd --- /dev/null +++ b/helm/dochub/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "dochub.fullname" . }} + labels: + {{- include "dochub.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: {{ .Values.service.targetPort }} + protocol: TCP + name: http + selector: + {{- include "dochub.selectorLabels" . | nindent 4 }} diff --git a/helm/dochub/values.yaml b/helm/dochub/values.yaml new file mode 100644 index 00000000..a99f1e51 --- /dev/null +++ b/helm/dochub/values.yaml @@ -0,0 +1,93 @@ +# Default values for dochub. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: "" + pullPolicy: Always + # Overrides the image tag whose default is the chart appVersion. + tag: "" + + +imagePullSecrets: [] +nameOverride: "dochub" +fullnameOverride: "dochub" + +command: [] +args: [] + +serviceAccount: + # Specifies whether a service account should be created + create: false + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +podAnnotations: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + type: ClusterIP + port: 8080 + targetPort: 8080 + +ingress: + enabled: true + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: YOUR_HOST + paths: + - path: / + pathType: ImplementationSpecific + tls: + - secretName: tls + hosts: + - YOUR_HOST + +resources: + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + limits: + cpu: 500m + memory: 1048Mi + requests: + cpu: 100m + memory: 128Mi + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 10 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +vars: + VUE_APP_DOCHUB_MODE: backend + VUE_APP_DOCHUB_BACKEND_PORT: 8080 + VUE_APP_DOCHUB_APPEND_DOCHUB_DOCS: n +