From 7d2f4b61b4b27974e7974d97fcdb3b0d05f90578 Mon Sep 17 00:00:00 2001 From: "lin.huang" Date: Mon, 25 Sep 2023 00:24:09 +0800 Subject: [PATCH] Initial submission of the help charts script for openim API --- .../services/openim-api/Chart.yaml | 30 ++++++ .../services/openim-api/templates/NOTES.txt | 22 +++++ .../openim-api/templates/_helpers.tpl | 68 +++++++++++++ .../services/openim-api/templates/app-cm.yaml | 12 +++ .../openim-api/templates/app-data-pv.yaml | 47 +++++++++ .../openim-api/templates/deployment.yaml | 61 ++++++++++++ .../services/openim-api/templates/hpa.yaml | 28 ++++++ .../openim-api/templates/ingress.yaml | 27 ++++++ .../openim-api/templates/service.yaml | 14 +++ .../services/openim-api/values.yaml | 97 +++++++++++++++++++ 10 files changed, 406 insertions(+) create mode 100644 manifest/helm-charts/services/openim-api/Chart.yaml create mode 100644 manifest/helm-charts/services/openim-api/templates/NOTES.txt create mode 100644 manifest/helm-charts/services/openim-api/templates/_helpers.tpl create mode 100644 manifest/helm-charts/services/openim-api/templates/app-cm.yaml create mode 100644 manifest/helm-charts/services/openim-api/templates/app-data-pv.yaml create mode 100644 manifest/helm-charts/services/openim-api/templates/deployment.yaml create mode 100644 manifest/helm-charts/services/openim-api/templates/hpa.yaml create mode 100644 manifest/helm-charts/services/openim-api/templates/ingress.yaml create mode 100644 manifest/helm-charts/services/openim-api/templates/service.yaml create mode 100644 manifest/helm-charts/services/openim-api/values.yaml diff --git a/manifest/helm-charts/services/openim-api/Chart.yaml b/manifest/helm-charts/services/openim-api/Chart.yaml new file mode 100644 index 000000000..9cdf11f66 --- /dev/null +++ b/manifest/helm-charts/services/openim-api/Chart.yaml @@ -0,0 +1,30 @@ +apiVersion: v2 +name: openim-api +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. +appVersion: 0.1.0 + +# kube version dependency +kubeVersion: 1.20.x + +# keywords use in search +keywords: + - openim-api diff --git a/manifest/helm-charts/services/openim-api/templates/NOTES.txt b/manifest/helm-charts/services/openim-api/templates/NOTES.txt new file mode 100644 index 000000000..e9ce81bdb --- /dev/null +++ b/manifest/helm-charts/services/openim-api/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 "openim-api.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 "openim-api.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "openim-api.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 "openim-api.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/manifest/helm-charts/services/openim-api/templates/_helpers.tpl b/manifest/helm-charts/services/openim-api/templates/_helpers.tpl new file mode 100644 index 000000000..3b0276d93 --- /dev/null +++ b/manifest/helm-charts/services/openim-api/templates/_helpers.tpl @@ -0,0 +1,68 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "openim-api.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 "openim-api.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 "openim-api.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "openim-api.labels" -}} +helm.sh/chart: {{ include "openim-api.chart" . }} +{{ include "openim-api.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- if .Values.extraLabels }} +{{ toYaml .Values.extraLabels }} +{{- end }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "openim-api.selectorLabels" -}} +app.kubernetes.io/name: {{ include "openim-api.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- if .Values.extraLabels }} +{{ toYaml .Values.extraLabels }} +{{- end }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "openim-api.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "openim-api.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/manifest/helm-charts/services/openim-api/templates/app-cm.yaml b/manifest/helm-charts/services/openim-api/templates/app-cm.yaml new file mode 100644 index 000000000..ff9a469c5 --- /dev/null +++ b/manifest/helm-charts/services/openim-api/templates/app-cm.yaml @@ -0,0 +1,12 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ .Chart.Name }}-cm +data: + config.yaml: |+ + {{- with .Values.config }} + # 服务端口 + port: {{ .port }} + grpc: {{ .grpc }} + + {{- end }} diff --git a/manifest/helm-charts/services/openim-api/templates/app-data-pv.yaml b/manifest/helm-charts/services/openim-api/templates/app-data-pv.yaml new file mode 100644 index 000000000..e738676b9 --- /dev/null +++ b/manifest/helm-charts/services/openim-api/templates/app-data-pv.yaml @@ -0,0 +1,47 @@ +{{- $pvType := .Values.storage.persistentVolumeType }} +{{- if or (eq $pvType "nfs") (eq $pvType "hostPath") }} +{{- range .Values.storage.persistentVolumes }} +--- +apiVersion: v1 +kind: PersistentVolume +metadata: + name: {{ .name }}-pv +spec: + capacity: + storage: {{ .capacity }} + accessModes: + - ReadWriteMany + storageClassName: {{ .name }}-sc + persistentVolumeReclaimPolicy: Retain +{{- if eq $pvType "nfs" }} + mountOptions: + - timeo=20 + - tcp + nfs: + {{- if not (empty $.Values.storage.nfsServer) }} + server: {{ $.Values.storage.nfsServer }} + {{- end }} + {{- if not (empty .path) }} + path: {{ .path }} + {{- end }} +{{- else }} + hostPath: + path: {{ .path }} +{{- end }} +{{- end }} +{{- range .Values.storage.persistentVolumes }} +--- +kind: PersistentVolumeClaim +apiVersion: v1 +metadata: + name: {{ .name }} +spec: + storageClassName: {{ .name }}-sc + accessModes: + - ReadWriteMany + resources: + requests: + storage: {{ .claimCapacity }} + +{{- end }} +{{- end }} diff --git a/manifest/helm-charts/services/openim-api/templates/deployment.yaml b/manifest/helm-charts/services/openim-api/templates/deployment.yaml new file mode 100644 index 000000000..120dc31d2 --- /dev/null +++ b/manifest/helm-charts/services/openim-api/templates/deployment.yaml @@ -0,0 +1,61 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "openim-api.fullname" . }} + labels: + {{- include "openim-api.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "openim-api.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "openim-api.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "openim-api.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: {{ .Values.service.port }} + protocol: TCP + resources: + {{- toYaml .Values.resources | nindent 12 }} + volumeMounts: + - mountPath: /app/configs/config.yaml + name: config + subPath: config.yaml + volumes: + - name: config + configMap: + name: openim-api-cm + {{- 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/manifest/helm-charts/services/openim-api/templates/hpa.yaml b/manifest/helm-charts/services/openim-api/templates/hpa.yaml new file mode 100644 index 000000000..0e5848181 --- /dev/null +++ b/manifest/helm-charts/services/openim-api/templates/hpa.yaml @@ -0,0 +1,28 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2beta1 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "openim-api.fullname" . }} + labels: + {{- include "openim-api.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "openim-api.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/manifest/helm-charts/services/openim-api/templates/ingress.yaml b/manifest/helm-charts/services/openim-api/templates/ingress.yaml new file mode 100644 index 000000000..e99a8b90e --- /dev/null +++ b/manifest/helm-charts/services/openim-api/templates/ingress.yaml @@ -0,0 +1,27 @@ +{{- if (eq .Values.ingress.kind "istio") }} +apiVersion: networking.istio.io/v1alpha3 +kind: VirtualService +metadata: + name: {{ .Chart.Name }}-app +spec: + hosts: + - "*" + gateways: + - aistudio-gateway + http: + - match: + - uri: + prefix: /{{ .Chart.Name }}/ + rewrite: + uri: "/" + headers: + request: + set: + From: "fronted" + X-Internal-Req: "false" + route: + - destination: + host: {{ .Chart.Name }} + port: + number: {{ .Values.service.port }} + {{- end}} diff --git a/manifest/helm-charts/services/openim-api/templates/service.yaml b/manifest/helm-charts/services/openim-api/templates/service.yaml new file mode 100644 index 000000000..fdd96cffd --- /dev/null +++ b/manifest/helm-charts/services/openim-api/templates/service.yaml @@ -0,0 +1,14 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "openim-api.fullname" . }} + labels: + {{- include "openim-api.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: {{ .Values.service.port }} + protocol: TCP + selector: + {{- include "openim-api.selectorLabels" . | nindent 4 }} diff --git a/manifest/helm-charts/services/openim-api/values.yaml b/manifest/helm-charts/services/openim-api/values.yaml new file mode 100644 index 000000000..68cddf81f --- /dev/null +++ b/manifest/helm-charts/services/openim-api/values.yaml @@ -0,0 +1,97 @@ +images: + jobInitContainer: "" + imgaeName: "" + +otherConfigs: + url: "" + ansible_arch: "" + + +replicaCount: 1 + +image: + repository: harbor.apulis.cn:8443/huawei630/apulistech/openim-api + pullPolicy: Always + # Overrides the image tag whose default is the chart appVersion. + tag: "v0.1.0" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +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. + name: "" + +podAnnotations: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + +service: + type: ClusterIP + port: 80 + +resources: {} + +config: + port: 80 + grpc: 81 + debug: true + apiV1Prefix: /api/v1 + db: + serverType: postgres + username: postgres + password: root + host: 172.17.0.1 + port: 5432 + +storage: + persistentVolumeType: hostPath + nfsServer: 192.168.3.9 + persistentVolumes: + - name: aiplatform-app-data-pvc + capacity: 20Gi + claimCapacity: 5Gi + path: /dev-d/app/ai-app-data + mounts: #first pvc mounted as main storage + - name: aiplatform-app-data-pvc + subPath: openim-api + mountPath: /app/openim-api-data + configs: + - name: openim-api-cm + subPath: config.yaml + mountPath: /app/configs/config.yaml + +nodeSelector: { + archType: amd64 +} +tolerations: [] + +affinity: {} + +ingress: + kind: "istio" + enabled: true + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: + paths: + - path: /openim-api + pathType: Prefix + tls: + secretName: https-tls + # hosts: + # - chart-example.local + +# Custom labels to apply to Deployment, Pod, Configmap, Service, ServiceMonitor. Including autoscaler if enabled. +extraLabels: {}