From 282c06daba9d55e950a0c58ad2777c06e0622200 Mon Sep 17 00:00:00 2001 From: Rick <1450685+LinuxSuRen@users.noreply.github.com> Date: Fri, 13 Oct 2023 17:41:48 +0800 Subject: [PATCH] feat: support releasing api-testing as a Helm chart (#235) --- .github/workflows/build.yaml | 3 + .github/workflows/release.yaml | 7 ++ .gitignore | 1 + Makefile | 9 ++ docs/README.md | 1 + docs/helm.md | 13 +++ helm/api-testing/.helmignore | 23 ++++++ helm/api-testing/Chart.yaml | 24 ++++++ helm/api-testing/templates/NOTES.txt | 22 +++++ helm/api-testing/templates/_helpers.tpl | 62 ++++++++++++++ helm/api-testing/templates/deployment.yaml | 61 ++++++++++++++ helm/api-testing/templates/hpa.yaml | 32 ++++++++ helm/api-testing/templates/ingress.yaml | 61 ++++++++++++++ helm/api-testing/templates/service.yaml | 15 ++++ .../api-testing/templates/serviceaccount.yaml | 12 +++ .../templates/tests/test-connection.yaml | 15 ++++ helm/api-testing/values.yaml | 82 +++++++++++++++++++ 17 files changed, 443 insertions(+) create mode 100644 docs/helm.md create mode 100644 helm/api-testing/.helmignore create mode 100644 helm/api-testing/Chart.yaml create mode 100644 helm/api-testing/templates/NOTES.txt create mode 100644 helm/api-testing/templates/_helpers.tpl create mode 100644 helm/api-testing/templates/deployment.yaml create mode 100644 helm/api-testing/templates/hpa.yaml create mode 100644 helm/api-testing/templates/ingress.yaml create mode 100644 helm/api-testing/templates/service.yaml create mode 100644 helm/api-testing/templates/serviceaccount.yaml create mode 100644 helm/api-testing/templates/tests/test-connection.yaml create mode 100644 helm/api-testing/values.yaml diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 382c99a..c350596 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -20,6 +20,9 @@ jobs: - name: Long Test run: | make testlong + - name: Lint Helm + run: | + make helm-package helm-lint - name: Report if: github.actor == 'linuxsuren' env: diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 5c41c88..98067f5 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -154,3 +154,10 @@ jobs: platforms: linux/amd64,linux/arm64 cache-from: type=gha cache-to: type=gha,mode=max + - name: Set output + id: vars + run: echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT + - name: Release Helm + run: | + echo ${{ secrets.DOCKER_HUB_PUBLISH_SECRETS }} | helm registry login docker.io -u linuxsuren --password-stdin + APP_VERSION=${{ steps.vars.outputs.tag }} make helm-package helm-push diff --git a/.gitignore b/.gitignore index bc420c1..068e66f 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,4 @@ cmd/data/index.js cmd/data/index.css operator/bundle oryxbuildbinary +helm/*.tgz diff --git a/Makefile b/Makefile index a64f1e0..e8265f5 100644 --- a/Makefile +++ b/Makefile @@ -2,6 +2,7 @@ IMG_TOOL?=podman BINARY?=atest TOOLEXEC?=-toolexec="skywalking-go-agent" GOPROXY?=https://goproxy.cn,direct +APP_VERSION?=v0.0.13 build: mkdir -p bin @@ -43,6 +44,14 @@ copy-restart: build-embed-ui make copy atest service restart +# helm +helm-package: + helm package helm/api-testing --version ${APP_VERSION}-helm --app-version ${APP_VERSION} -d bin +helm-push: + helm push bin/api-testing-${APP_VERSION}-helm.tgz oci://docker.io/linuxsuren +helm-lint: + helm lint helm/api-testing + # plugins plugin-git: GOOS=${OS} go build -ldflags "-w -s" -o bin/atest-store-git extensions/store-git/main.go diff --git a/docs/README.md b/docs/README.md index 5ea5fa9..e260922 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,6 +19,7 @@ You can install in various methods: * Web server * [Kubernetes](https://github.com/LinuxSuRen/api-testing/tree/master/docs/manifests/kubernetes) * [Argo CD](https://github.com/LinuxSuRen/api-testing/blob/master/docs/manifests/argocd/simple.yaml) +* [Helm](helm.md) If you're developing APIs locally, the best way is installing it as a container service. Then you can access it via your browser. diff --git a/docs/helm.md b/docs/helm.md new file mode 100644 index 0000000..605f766 --- /dev/null +++ b/docs/helm.md @@ -0,0 +1,13 @@ +You could install api-testing via Helm chart: + +```shell +helm install atest oci://registry-1.docker.io/surenpi/api-testing \ + --version v0.0.2 \ + --set service.type=NodePort +``` + +or upgrade it: + +```shell +helm upgrade atest oci://registry-1.docker.io/surenpi/api-testing --version v0.0.3 +``` diff --git a/helm/api-testing/.helmignore b/helm/api-testing/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/helm/api-testing/.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/api-testing/Chart.yaml b/helm/api-testing/Chart.yaml new file mode 100644 index 0000000..4f11de2 --- /dev/null +++ b/helm/api-testing/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: api-testing +description: YAML based API testing tool + +# 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: v0.0.1 + +# 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: "v0.0.13" diff --git a/helm/api-testing/templates/NOTES.txt b/helm/api-testing/templates/NOTES.txt new file mode 100644 index 0000000..ee1dd5c --- /dev/null +++ b/helm/api-testing/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 "api-testing.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 "api-testing.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "api-testing.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 "api-testing.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/api-testing/templates/_helpers.tpl b/helm/api-testing/templates/_helpers.tpl new file mode 100644 index 0000000..4f54f64 --- /dev/null +++ b/helm/api-testing/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "api-testing.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 "api-testing.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 "api-testing.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "api-testing.labels" -}} +helm.sh/chart: {{ include "api-testing.chart" . }} +{{ include "api-testing.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "api-testing.selectorLabels" -}} +app.kubernetes.io/name: {{ include "api-testing.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "api-testing.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "api-testing.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/helm/api-testing/templates/deployment.yaml b/helm/api-testing/templates/deployment.yaml new file mode 100644 index 0000000..89f5082 --- /dev/null +++ b/helm/api-testing/templates/deployment.yaml @@ -0,0 +1,61 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "api-testing.fullname" . }} + labels: + {{- include "api-testing.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "api-testing.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "api-testing.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "api-testing.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: {{ .Values.service.port }} + 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/api-testing/templates/hpa.yaml b/helm/api-testing/templates/hpa.yaml new file mode 100644 index 0000000..8736fd9 --- /dev/null +++ b/helm/api-testing/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "api-testing.fullname" . }} + labels: + {{- include "api-testing.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "api-testing.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/helm/api-testing/templates/ingress.yaml b/helm/api-testing/templates/ingress.yaml new file mode 100644 index 0000000..0d097d0 --- /dev/null +++ b/helm/api-testing/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "api-testing.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 "api-testing.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/api-testing/templates/service.yaml b/helm/api-testing/templates/service.yaml new file mode 100644 index 0000000..1473d40 --- /dev/null +++ b/helm/api-testing/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "api-testing.fullname" . }} + labels: + {{- include "api-testing.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "api-testing.selectorLabels" . | nindent 4 }} diff --git a/helm/api-testing/templates/serviceaccount.yaml b/helm/api-testing/templates/serviceaccount.yaml new file mode 100644 index 0000000..a652de4 --- /dev/null +++ b/helm/api-testing/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "api-testing.serviceAccountName" . }} + labels: + {{- include "api-testing.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/helm/api-testing/templates/tests/test-connection.yaml b/helm/api-testing/templates/tests/test-connection.yaml new file mode 100644 index 0000000..67b6b3c --- /dev/null +++ b/helm/api-testing/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "api-testing.fullname" . }}-test-connection" + labels: + {{- include "api-testing.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "api-testing.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/helm/api-testing/values.yaml b/helm/api-testing/values.yaml new file mode 100644 index 0000000..a4c900e --- /dev/null +++ b/helm/api-testing/values.yaml @@ -0,0 +1,82 @@ +# Default values for api-testing. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: linuxsuren/api-testing + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # 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 + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +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: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {}