From 303df62cffb95b7c5859b8cefac13a78533bfc14 Mon Sep 17 00:00:00 2001 From: Pavel Kirilin Date: Thu, 5 Dec 2024 15:11:52 +0100 Subject: [PATCH] Added pgbouncer chart. --- .github/workflows/release.yaml | 3 +- charts/pgbouncer/.helmignore | 23 ++++ charts/pgbouncer/Chart.yaml | 24 ++++ charts/pgbouncer/templates/NOTES.txt | 16 +++ charts/pgbouncer/templates/_helpers.tpl | 87 ++++++++++++++ charts/pgbouncer/templates/deployment.yaml | 65 +++++++++++ .../pgbouncer/templates/external-secrets.yaml | 22 ++++ charts/pgbouncer/templates/hpa.yaml | 32 +++++ charts/pgbouncer/templates/service.yaml | 15 +++ .../pgbouncer/templates/serviceaccount.yaml | 13 +++ charts/pgbouncer/values.yaml | 110 ++++++++++++++++++ 11 files changed, 409 insertions(+), 1 deletion(-) create mode 100644 charts/pgbouncer/.helmignore create mode 100644 charts/pgbouncer/Chart.yaml create mode 100644 charts/pgbouncer/templates/NOTES.txt create mode 100644 charts/pgbouncer/templates/_helpers.tpl create mode 100644 charts/pgbouncer/templates/deployment.yaml create mode 100644 charts/pgbouncer/templates/external-secrets.yaml create mode 100644 charts/pgbouncer/templates/hpa.yaml create mode 100644 charts/pgbouncer/templates/service.yaml create mode 100644 charts/pgbouncer/templates/serviceaccount.yaml create mode 100644 charts/pgbouncer/values.yaml diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 47ec0fe..b729151 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -13,6 +13,7 @@ jobs: matrix: chart: - py-app + - pgbouncer permissions: contents: read packages: write @@ -23,7 +24,7 @@ jobs: version: latest - name: Build Helm chart run: | - helm package --app-version "${{ github.ref_name }}" --dependency-update ./charts/${{ matrix.chart }} + helm package --dependency-update ./charts/${{ matrix.chart }} helm show chart *.tgz helm registry login -u ${{ github.actor }} -p ${{ secrets.GITHUB_TOKEN }} ghcr.io helm push *.tgz oci://ghcr.io/intreecom/charts diff --git a/charts/pgbouncer/.helmignore b/charts/pgbouncer/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/pgbouncer/.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/charts/pgbouncer/Chart.yaml b/charts/pgbouncer/Chart.yaml new file mode 100644 index 0000000..ed9e008 --- /dev/null +++ b/charts/pgbouncer/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: pgbouncer +description: Helm chart for PGBouncer + +# 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: 1.0.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.23.1" diff --git a/charts/pgbouncer/templates/NOTES.txt b/charts/pgbouncer/templates/NOTES.txt new file mode 100644 index 0000000..3e24834 --- /dev/null +++ b/charts/pgbouncer/templates/NOTES.txt @@ -0,0 +1,16 @@ +1. Get the application URL by running these commands: +{{- if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "pgbouncer.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 its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "pgbouncer.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "pgbouncer.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 "pgbouncer.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/charts/pgbouncer/templates/_helpers.tpl b/charts/pgbouncer/templates/_helpers.tpl new file mode 100644 index 0000000..75659dd --- /dev/null +++ b/charts/pgbouncer/templates/_helpers.tpl @@ -0,0 +1,87 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "pgbouncer.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 "pgbouncer.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 "pgbouncer.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "pgbouncer.labels" -}} +helm.sh/chart: {{ include "pgbouncer.chart" . }} +{{ include "pgbouncer.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "pgbouncer.selectorLabels" -}} +app.kubernetes.io/name: {{ include "pgbouncer.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "pgbouncer.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "pgbouncer.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} + +{{- define "pgbouncer.envs" -}} +{{- with .Values.env }} +env: + {{- range $key, $val := . }} + - name: {{ $key }} + value: {{ $val | quote }} + {{- end }} +{{- end }} +{{- if or (.Values.externalSecrets) (.Values.existingSecrets) }} +envFrom: +{{- with .Values.externalSecrets }} + {{- range $name, $val := . }} + - secretRef: + name: {{ $val.targetName }} + {{- end }} +{{- end }} +{{- with .Values.existingSecrets }} + {{- range $name := . }} + - secretRef: + name: {{ $name }} + {{- end }} +{{- end }} +{{- end }} +{{ end -}} diff --git a/charts/pgbouncer/templates/deployment.yaml b/charts/pgbouncer/templates/deployment.yaml new file mode 100644 index 0000000..62af2d1 --- /dev/null +++ b/charts/pgbouncer/templates/deployment.yaml @@ -0,0 +1,65 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "pgbouncer.fullname" . }} + labels: + {{- include "pgbouncer.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + {{- with .Values.updateStrategy }} + strategy: + {{- toYaml . | nindent 4 }} + {{- end }} + selector: + matchLabels: + {{- include "pgbouncer.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "pgbouncer.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "pgbouncer.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 }} + {{- include "pgbouncer.envs" . | indent 10 -}} + ports: + - name: pg + containerPort: {{ .Values.service.port }} + protocol: TCP + livenessProbe: + {{- toYaml .Values.livenessProbe | nindent 12 }} + readinessProbe: + {{- toYaml .Values.readinessProbe | nindent 12 }} + 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/charts/pgbouncer/templates/external-secrets.yaml b/charts/pgbouncer/templates/external-secrets.yaml new file mode 100644 index 0000000..9c8494d --- /dev/null +++ b/charts/pgbouncer/templates/external-secrets.yaml @@ -0,0 +1,22 @@ +{{- range $name, $val := .Values.externalSecrets }} +--- +apiVersion: external-secrets.io/v1beta1 +kind: ExternalSecret +metadata: + name: "{{include "pgbouncer.name" $ }}-{{ $name }}" + labels: + {{- include "pgbouncer.labels" $ | nindent 4 }} + annotations: + argocd.argoproj.io/hook: PreSync,Sync + argocd.argoproj.io/sync-wave: "-1" +spec: + refreshInterval: {{ default "1h" $val.refreshInterval }} # rate SecretManager pulls GCPSM + secretStoreRef: + kind: ClusterSecretStore + name: {{ $val.secretStoreName }} # name of the SecretStore (or kind specified) + target: + name: {{ $val.targetName }} + creationPolicy: {{ default "Owner" $val.targetCreationPolicy }} + deletionPolicy: {{ default "Retain" $val.targetDeletionPolicy }} + dataFrom: {{ toYaml $val.dataFrom | nindent 4 }} +{{ end -}} diff --git a/charts/pgbouncer/templates/hpa.yaml b/charts/pgbouncer/templates/hpa.yaml new file mode 100644 index 0000000..305a72e --- /dev/null +++ b/charts/pgbouncer/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "pgbouncer.fullname" . }} + labels: + {{- include "pgbouncer.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "pgbouncer.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/charts/pgbouncer/templates/service.yaml b/charts/pgbouncer/templates/service.yaml new file mode 100644 index 0000000..3c39336 --- /dev/null +++ b/charts/pgbouncer/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "pgbouncer.fullname" . }} + labels: + {{- include "pgbouncer.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: pg + protocol: TCP + name: pg + selector: + {{- include "pgbouncer.selectorLabels" . | nindent 4 }} diff --git a/charts/pgbouncer/templates/serviceaccount.yaml b/charts/pgbouncer/templates/serviceaccount.yaml new file mode 100644 index 0000000..1137d66 --- /dev/null +++ b/charts/pgbouncer/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "pgbouncer.serviceAccountName" . }} + labels: + {{- include "pgbouncer.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/charts/pgbouncer/values.yaml b/charts/pgbouncer/values.yaml new file mode 100644 index 0000000..b54253d --- /dev/null +++ b/charts/pgbouncer/values.yaml @@ -0,0 +1,110 @@ +# Default values for pgbouncer. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ +replicaCount: 1 + +# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/ +image: + repository: bitnami/pgbouncer + # This sets the pull policy for images. + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +# Raw environment variables to use. +env: + PGBOUNCER_POOL_MODE: "transaction" + PGBOUNCER_PORT: "5432" + +# external secrets for env variables to create. +externalSecrets: {} + +# List of existing secrets to mount for env variables +existingSecrets: [] + +# This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ +imagePullSecrets: [] +# This is to override the chart name. +nameOverride: "" +fullnameOverride: "" + +#This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/ +serviceAccount: + # Specifies whether a service account should be created + create: true + # Automatically mount a ServiceAccount's API credentials? + automount: 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: "" + +# This is for setting Kubernetes Annotations to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ +podAnnotations: {} +# This is for setting Kubernetes Labels to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + + +# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ +service: + # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + type: ClusterIP + # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + port: 5432 + +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 + +# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ +livenessProbe: + tcpSocket: + port: pg +readinessProbe: + tcpSocket: + port: pg + +# The way application should be updated. +updateStrategy: {} + # type: RollingUpdate + # rollingUpdate: + # maxSurge: 1 + # maxUnavailable: 0 + +#This section is for setting up autoscaling more information can be found here: https://kubernetes.io/docs/concepts/workloads/autoscaling/ +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {}