From f85a4d0c09c7b9eb8c75707a4c74b34885bea707 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Mart=C3=ADn=20Garc=C3=ADa?= <49920382+amartingarcia@users.noreply.github.com> Date: Wed, 28 Jun 2023 08:34:10 +0200 Subject: [PATCH] feat(ssl-exporter): added new helm chart (#22) * feat(ssl-exporter): added new helm chart --- charts/ssl-exporter/.helmignore | 23 +++ charts/ssl-exporter/Chart.yaml | 12 ++ charts/ssl-exporter/templates/NOTES.txt | 22 +++ charts/ssl-exporter/templates/_helpers.tpl | 62 ++++++++ .../ssl-exporter/templates/clusterrole.yaml | 15 ++ charts/ssl-exporter/templates/configmap.yaml | 11 ++ charts/ssl-exporter/templates/deployment.yaml | 86 +++++++++++ charts/ssl-exporter/templates/ingress.yaml | 61 ++++++++ .../ssl-exporter/templates/rolebinding.yaml | 15 ++ charts/ssl-exporter/templates/service.yaml | 15 ++ .../templates/serviceaccount.yaml | 12 ++ .../templates/tests/test-connection.yaml | 15 ++ charts/ssl-exporter/values.yaml | 136 ++++++++++++++++++ 13 files changed, 485 insertions(+) create mode 100644 charts/ssl-exporter/.helmignore create mode 100644 charts/ssl-exporter/Chart.yaml create mode 100644 charts/ssl-exporter/templates/NOTES.txt create mode 100644 charts/ssl-exporter/templates/_helpers.tpl create mode 100644 charts/ssl-exporter/templates/clusterrole.yaml create mode 100644 charts/ssl-exporter/templates/configmap.yaml create mode 100644 charts/ssl-exporter/templates/deployment.yaml create mode 100644 charts/ssl-exporter/templates/ingress.yaml create mode 100644 charts/ssl-exporter/templates/rolebinding.yaml create mode 100644 charts/ssl-exporter/templates/service.yaml create mode 100644 charts/ssl-exporter/templates/serviceaccount.yaml create mode 100644 charts/ssl-exporter/templates/tests/test-connection.yaml create mode 100644 charts/ssl-exporter/values.yaml diff --git a/charts/ssl-exporter/.helmignore b/charts/ssl-exporter/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/ssl-exporter/.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/ssl-exporter/Chart.yaml b/charts/ssl-exporter/Chart.yaml new file mode 100644 index 0000000..dff2879 --- /dev/null +++ b/charts/ssl-exporter/Chart.yaml @@ -0,0 +1,12 @@ +apiVersion: v2 +name: ssl-exporter +description: A Helm Chart to SSL Certificate Exporter for Prometheus +type: application +version: 0.1.0 +appVersion: "2.4.2" +home: https://github.com/devops-ia/helm-charts/tree/main/charts/ssl-exporter +sources: + - https://github.com/ribbybibby/ssl_exporter +maintainers: + - name: "amartingarcia" + url: https://github.com/devops-ia diff --git a/charts/ssl-exporter/templates/NOTES.txt b/charts/ssl-exporter/templates/NOTES.txt new file mode 100644 index 0000000..ac07519 --- /dev/null +++ b/charts/ssl-exporter/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 "ssl-exporter.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 "ssl-exporter.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "ssl-exporter.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 "ssl-exporter.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/ssl-exporter/templates/_helpers.tpl b/charts/ssl-exporter/templates/_helpers.tpl new file mode 100644 index 0000000..19aa3c6 --- /dev/null +++ b/charts/ssl-exporter/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "ssl-exporter.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 "ssl-exporter.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 "ssl-exporter.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "ssl-exporter.labels" -}} +helm.sh/chart: {{ include "ssl-exporter.chart" . }} +{{ include "ssl-exporter.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "ssl-exporter.selectorLabels" -}} +app.kubernetes.io/name: {{ include "ssl-exporter.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "ssl-exporter.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "ssl-exporter.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/ssl-exporter/templates/clusterrole.yaml b/charts/ssl-exporter/templates/clusterrole.yaml new file mode 100644 index 0000000..d0ff672 --- /dev/null +++ b/charts/ssl-exporter/templates/clusterrole.yaml @@ -0,0 +1,15 @@ +{{- if .Values.rbac.enabled -}} +{{- $fullName := include "ssl-exporter.fullname" . -}} +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: {{ $fullName }} +rules: +- apiGroups: + - "" + resources: + - secrets + verbs: + - list + - get +{{- end }} \ No newline at end of file diff --git a/charts/ssl-exporter/templates/configmap.yaml b/charts/ssl-exporter/templates/configmap.yaml new file mode 100644 index 0000000..099a906 --- /dev/null +++ b/charts/ssl-exporter/templates/configmap.yaml @@ -0,0 +1,11 @@ +{{- if .Values.config.enabled }} +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "ssl-exporter.fullname" . }} + labels: + {{- include "ssl-exporter.labels" . | nindent 4 }} +data: + config.yaml: | + {{- .Values.config.data | nindent 4 }} +{{- end }} \ No newline at end of file diff --git a/charts/ssl-exporter/templates/deployment.yaml b/charts/ssl-exporter/templates/deployment.yaml new file mode 100644 index 0000000..c946042 --- /dev/null +++ b/charts/ssl-exporter/templates/deployment.yaml @@ -0,0 +1,86 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "ssl-exporter.fullname" . }} + labels: + {{- include "ssl-exporter.labels" . | nindent 4 }} +spec: + strategy: + type: Recreate + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + {{- include "ssl-exporter.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml" ) . | sha256sum }} + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "ssl-exporter.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "ssl-exporter.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 }} + args: + - --web.probe-path=/probe + - --web.listen-address=:9219 + - --log.level={{ .Values.logLevel }} + {{- if .Values.config.enabled }} + - --config.file=/config/config.yaml + {{- end}} + ports: + - name: http + containerPort: 9219 + protocol: TCP + livenessProbe: + httpGet: + path: / + port: http + readinessProbe: + httpGet: + path: / + port: http + resources: + {{- toYaml .Values.resources | nindent 12 }} + volumeMounts: + {{- if .Values.config.enabled }} + - name: config + mountPath: /config + {{- end }} + {{- with .Values.extraVolumeMounts }} + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} + volumes: + {{- if .Values.config.enabled }} + - name: config + configMap: + name: {{ include "ssl-exporter.fullname" . }} + {{- end }} + {{- with .Values.extraVolumes }} + {{- toYaml . | nindent 8 }} + {{- end }} \ No newline at end of file diff --git a/charts/ssl-exporter/templates/ingress.yaml b/charts/ssl-exporter/templates/ingress.yaml new file mode 100644 index 0000000..cb93f09 --- /dev/null +++ b/charts/ssl-exporter/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "ssl-exporter.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 "ssl-exporter.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 }} \ No newline at end of file diff --git a/charts/ssl-exporter/templates/rolebinding.yaml b/charts/ssl-exporter/templates/rolebinding.yaml new file mode 100644 index 0000000..1bc4f83 --- /dev/null +++ b/charts/ssl-exporter/templates/rolebinding.yaml @@ -0,0 +1,15 @@ +{{- if .Values.rbac.enabled -}} +{{- $fullName := include "ssl-exporter.fullname" . -}} +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: {{ $fullName }} +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: ClusterRole + name: {{ $fullName }} +subjects: +- kind: ServiceAccount + name: {{ include "ssl-exporter.serviceAccountName" . }} + namespace: {{ .Release.namespace }} +{{- end }} \ No newline at end of file diff --git a/charts/ssl-exporter/templates/service.yaml b/charts/ssl-exporter/templates/service.yaml new file mode 100644 index 0000000..600740f --- /dev/null +++ b/charts/ssl-exporter/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "ssl-exporter.fullname" . }} + labels: + {{- include "ssl-exporter.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "ssl-exporter.selectorLabels" . | nindent 4 }} \ No newline at end of file diff --git a/charts/ssl-exporter/templates/serviceaccount.yaml b/charts/ssl-exporter/templates/serviceaccount.yaml new file mode 100644 index 0000000..bf57a8b --- /dev/null +++ b/charts/ssl-exporter/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "ssl-exporter.serviceAccountName" . }} + labels: + {{- include "ssl-exporter.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} \ No newline at end of file diff --git a/charts/ssl-exporter/templates/tests/test-connection.yaml b/charts/ssl-exporter/templates/tests/test-connection.yaml new file mode 100644 index 0000000..e704a10 --- /dev/null +++ b/charts/ssl-exporter/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "ssl-exporter.fullname" . }}-test-connection" + labels: + {{- include "ssl-exporter.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "ssl-exporter.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/charts/ssl-exporter/values.yaml b/charts/ssl-exporter/values.yaml new file mode 100644 index 0000000..1404931 --- /dev/null +++ b/charts/ssl-exporter/values.yaml @@ -0,0 +1,136 @@ +# Default values for ssl-exporter. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: ribbybibby/ssl-exporter + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +logLevel: info + +rbac: + enabled: true + +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: 100 + +securityContext: + capabilities: + drop: + - ALL + readOnlyRootFilesystem: true + runAsNonRoot: true + runAsUser: 1000 + +service: + type: ClusterIP + port: 9219 + +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 + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +extraVolumeMounts: [] +# - name: mysecret +# mountPath: /mysecret + +extraVolumes: [] +# - name: mysecret +# secret: +# secretName: mysecret-tls + +# query for calling the probe path, without the leading ? +# probeQuery: probe=file&target=/etc/ssl/ca.crt + +config: + enabled: false + data: | + modules: + https: + prober: https + https_insecure: + prober: https + tls_config: + insecure_skip_verify: true + https_proxy: + prober: https + https: + proxy_url: "socks5://localhost:8123" + https_timeout: + prober: https + timeout: 3s + tcp: + prober: tcp + tcp_servername: + prober: tcp + tls_config: + server_name: example.com + tcp_client_auth: + prober: tcp + tls_config: + ca_file: /etc/tls/ca.crt + cert_file: /etc/tls/tls.crt + key_file: /etc/tls/tls.key + tcp_smtp_starttls: + prober: tcp + tcp: + starttls: smtp + file: + prober: file + kubernetes: + prober: kubernetes + kubernetes_kubeconfig: + prober: kubernetes + kubernetes: + kubeconfig: /root/.kube/config + kubeconfig: + prober: kubeconfig