From 7e323906147670b663de31185f5a9f55ce3704e7 Mon Sep 17 00:00:00 2001 From: Leo Q Date: Tue, 12 Oct 2021 12:59:54 +0800 Subject: [PATCH] add tinyproxy exporter (#7) * add tinyproxy exporter * add home in chart.yaml * add maintainers * lint --- charts/tinyproxy-exporter/.helmignore | 23 ++++ charts/tinyproxy-exporter/Chart.yaml | 27 ++++ charts/tinyproxy-exporter/README.md | 5 + charts/tinyproxy-exporter/templates/NOTES.txt | 22 ++++ .../tinyproxy-exporter/templates/_helpers.tpl | 62 +++++++++ .../templates/deployment.yaml | 54 ++++++++ .../tinyproxy-exporter/templates/ingress.yaml | 61 +++++++++ .../templates/prometheusrule.yaml | 20 +++ .../tinyproxy-exporter/templates/service.yaml | 15 +++ .../templates/serviceaccount.yaml | 12 ++ .../templates/servicemonitor.yaml | 48 +++++++ .../templates/tests/test-connection.yaml | 15 +++ charts/tinyproxy-exporter/values.yaml | 118 ++++++++++++++++++ 13 files changed, 482 insertions(+) create mode 100644 charts/tinyproxy-exporter/.helmignore create mode 100644 charts/tinyproxy-exporter/Chart.yaml create mode 100644 charts/tinyproxy-exporter/README.md create mode 100644 charts/tinyproxy-exporter/templates/NOTES.txt create mode 100644 charts/tinyproxy-exporter/templates/_helpers.tpl create mode 100644 charts/tinyproxy-exporter/templates/deployment.yaml create mode 100644 charts/tinyproxy-exporter/templates/ingress.yaml create mode 100644 charts/tinyproxy-exporter/templates/prometheusrule.yaml create mode 100644 charts/tinyproxy-exporter/templates/service.yaml create mode 100644 charts/tinyproxy-exporter/templates/serviceaccount.yaml create mode 100644 charts/tinyproxy-exporter/templates/servicemonitor.yaml create mode 100644 charts/tinyproxy-exporter/templates/tests/test-connection.yaml create mode 100644 charts/tinyproxy-exporter/values.yaml diff --git a/charts/tinyproxy-exporter/.helmignore b/charts/tinyproxy-exporter/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/tinyproxy-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/tinyproxy-exporter/Chart.yaml b/charts/tinyproxy-exporter/Chart.yaml new file mode 100644 index 0000000..9b19170 --- /dev/null +++ b/charts/tinyproxy-exporter/Chart.yaml @@ -0,0 +1,27 @@ +apiVersion: v2 +name: tinyproxy-exporter +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" +home: "https://github.com/igzivkov/tinyproxy_exporter" +maintainers: +- name: LeoQuote diff --git a/charts/tinyproxy-exporter/README.md b/charts/tinyproxy-exporter/README.md new file mode 100644 index 0000000..dd8caf1 --- /dev/null +++ b/charts/tinyproxy-exporter/README.md @@ -0,0 +1,5 @@ +# tinyproxy-exporter + +exporter: https://github.com/igzivkov/tinyproxy_exporter + +support multiple proxy in one single chart diff --git a/charts/tinyproxy-exporter/templates/NOTES.txt b/charts/tinyproxy-exporter/templates/NOTES.txt new file mode 100644 index 0000000..79b3cb3 --- /dev/null +++ b/charts/tinyproxy-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 "tinyproxy-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 "tinyproxy-exporter.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "tinyproxy-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 "tinyproxy-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/tinyproxy-exporter/templates/_helpers.tpl b/charts/tinyproxy-exporter/templates/_helpers.tpl new file mode 100644 index 0000000..460c40a --- /dev/null +++ b/charts/tinyproxy-exporter/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "tinyproxy-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 "tinyproxy-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 "tinyproxy-exporter.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "tinyproxy-exporter.labels" -}} +helm.sh/chart: {{ include "tinyproxy-exporter.chart" . }} +{{ include "tinyproxy-exporter.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "tinyproxy-exporter.selectorLabels" -}} +app.kubernetes.io/name: {{ include "tinyproxy-exporter.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "tinyproxy-exporter.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "tinyproxy-exporter.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/tinyproxy-exporter/templates/deployment.yaml b/charts/tinyproxy-exporter/templates/deployment.yaml new file mode 100644 index 0000000..81ac3a4 --- /dev/null +++ b/charts/tinyproxy-exporter/templates/deployment.yaml @@ -0,0 +1,54 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "tinyproxy-exporter.fullname" . }} + labels: + {{- include "tinyproxy-exporter.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + {{- include "tinyproxy-exporter.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "tinyproxy-exporter.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "tinyproxy-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: + - "-t" + - "{{ .Values.tinyproxy.address }}" + ports: + - name: http + containerPort: 9240 + protocol: TCP + 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/tinyproxy-exporter/templates/ingress.yaml b/charts/tinyproxy-exporter/templates/ingress.yaml new file mode 100644 index 0000000..8e1af20 --- /dev/null +++ b/charts/tinyproxy-exporter/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "tinyproxy-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 "tinyproxy-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 }} diff --git a/charts/tinyproxy-exporter/templates/prometheusrule.yaml b/charts/tinyproxy-exporter/templates/prometheusrule.yaml new file mode 100644 index 0000000..0510b39 --- /dev/null +++ b/charts/tinyproxy-exporter/templates/prometheusrule.yaml @@ -0,0 +1,20 @@ +{{- if .Values.prometheusRule.enabled }} +apiVersion: monitoring.coreos.com/v1 +kind: PrometheusRule +metadata: + name: {{ template "tinyproxy-exporter.fullname" . }} +{{- with .Values.prometheusRule.namespace }} + namespace: {{ . }} +{{- end }} + labels: +{{ include "tinyproxy-exporter.labels" . | indent 4 }} +{{- with .Values.prometheusRule.additionalLabels }} +{{ toYaml . | indent 4 }} +{{- end }} +spec: +{{- with .Values.prometheusRule.rules }} + groups: + - name: {{ template "tinyproxy-exporter.name" $ }} + rules: {{ tpl (toYaml .) $ | nindent 8 }} +{{- end }} +{{- end }} \ No newline at end of file diff --git a/charts/tinyproxy-exporter/templates/service.yaml b/charts/tinyproxy-exporter/templates/service.yaml new file mode 100644 index 0000000..63f7aea --- /dev/null +++ b/charts/tinyproxy-exporter/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "tinyproxy-exporter.fullname" . }} + labels: + {{- include "tinyproxy-exporter.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "tinyproxy-exporter.selectorLabels" . | nindent 4 }} diff --git a/charts/tinyproxy-exporter/templates/serviceaccount.yaml b/charts/tinyproxy-exporter/templates/serviceaccount.yaml new file mode 100644 index 0000000..ebbaf54 --- /dev/null +++ b/charts/tinyproxy-exporter/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "tinyproxy-exporter.serviceAccountName" . }} + labels: + {{- include "tinyproxy-exporter.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/charts/tinyproxy-exporter/templates/servicemonitor.yaml b/charts/tinyproxy-exporter/templates/servicemonitor.yaml new file mode 100644 index 0000000..61c08c4 --- /dev/null +++ b/charts/tinyproxy-exporter/templates/servicemonitor.yaml @@ -0,0 +1,48 @@ +{{- if $.Values.serviceMonitor }} +{{- if and ( .Capabilities.APIVersions.Has "monitoring.coreos.com/v1" ) ( .Values.serviceMonitor.enabled ) }} +apiVersion: monitoring.coreos.com/v1 +kind: ServiceMonitor +metadata: +{{- if .Values.serviceMonitor.labels }} + labels: +{{ toYaml .Values.serviceMonitor.labels | indent 4}} +{{- end }} + name: {{ template "tinyproxy-exporter.fullname" . }} +{{- if .Values.serviceMonitor.namespace }} + namespace: {{ .Values.serviceMonitor.namespace }} +{{- end }} +spec: + endpoints: + - targetPort: {{ .Values.service.port }} +{{- if .Values.serviceMonitor.interval }} + interval: {{ .Values.serviceMonitor.interval }} +{{- end }} +{{- if .Values.serviceMonitor.telemetryPath }} + path: {{ .Values.serviceMonitor.telemetryPath }} +{{- end }} +{{- if .Values.serviceMonitor.timeout }} + scrapeTimeout: {{ .Values.serviceMonitor.timeout }} +{{- end }} +{{- if .Values.serviceMonitor.metricRelabelings }} + metricRelabelings: +{{ toYaml .Values.serviceMonitor.metricRelabelings | indent 4 }} +{{- end }} +{{- if .Values.serviceMonitor.relabelings }} + relabelings: +{{ toYaml .Values.serviceMonitor.relabelings | indent 4 }} +{{- end }} + jobLabel: {{ template "tinyproxy-exporter.fullname" . }} + namespaceSelector: + matchNames: + - {{ .Release.Namespace }} + selector: + matchLabels: +{{- include "tinyproxy-exporter.selectorLabels" . | nindent 6 }} +{{- if .Values.serviceMonitor.targetLabels }} + targetLabels: +{{- range .Values.serviceMonitor.targetLabels }} + - {{ . }} +{{- end }} +{{- end }} +{{- end }} +{{- end }} diff --git a/charts/tinyproxy-exporter/templates/tests/test-connection.yaml b/charts/tinyproxy-exporter/templates/tests/test-connection.yaml new file mode 100644 index 0000000..9ebb23e --- /dev/null +++ b/charts/tinyproxy-exporter/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "tinyproxy-exporter.fullname" . }}-test-connection" + labels: + {{- include "tinyproxy-exporter.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "tinyproxy-exporter.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/charts/tinyproxy-exporter/values.yaml b/charts/tinyproxy-exporter/values.yaml new file mode 100644 index 0000000..9fe5471 --- /dev/null +++ b/charts/tinyproxy-exporter/values.yaml @@ -0,0 +1,118 @@ +# Default values for tinyproxy-exporter. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +tinyproxy: + address: "10.1.136.37:8881" + + +replicaCount: 1 + +image: + repository: ghcr.io/leoquote/tinyproxy_exporter + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "master" + +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. + # 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: 9240 + +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: {} + + +serviceMonitor: + # When set true then use a ServiceMonitor to configure scraping + enabled: false + # Set the namespace the ServiceMonitor should be deployed + # namespace: monitoring + # Set how frequently Prometheus should scrape + # interval: 30s + # Set path to redis-exporter telemtery-path + # telemetryPath: /metrics + # Set labels for the ServiceMonitor, use this to define your scrape label for Prometheus Operator + # labels: + # Set timeout for scrape + # timeout: 10s + # Set relabel_configs as per https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config + # relabelings: [] + # Set of labels to transfer on the Kubernetes Service onto the target. + # targetLabels: [] + # metricRelabelings: [] + +## Custom PrometheusRules to be defined +## The value is evaluated as a template, so, for example, the value can depend on .Release or .Chart +## ref: https://github.com/coreos/prometheus-operator#customresourcedefinitions +prometheusRule: + enabled: false + additionalLabels: {} + namespace: "" + rules: [] + ## These are just examples rules, please adapt them to your needs. + ## Make sure to constraint the rules to the current service. + # - alert: ProxyDown + # expr: tinyproxy_connections_open{service="{{ template "tinyproxy-exporter.fullname" . }}"} == 0 + # for: 2m + # labels: + # severity: error + # annotations: + # summary: Redis instance {{ "{{ $labels.instance }}" }} down + # description: Redis instance {{ "{{ $labels.instance }}" }} is down.