From 2ca1ec5637bf58488dc4f7084bd8b8cbf87e3698 Mon Sep 17 00:00:00 2001 From: Antoine Pultier <45740+fungiboletus@users.noreply.github.com> Date: Tue, 7 Feb 2023 18:57:15 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=8C=88=20The=20helm=20chart=20is=20releas?= =?UTF-8?q?ed=20!?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/release-charts.yaml | 34 +++++++ README.md | 19 +++- charts/www-redirector/.helmignore | 23 +++++ charts/www-redirector/Chart.yaml | 24 +++++ charts/www-redirector/README.md | 55 ++++++++++++ charts/www-redirector/templates/_helpers.tpl | 62 +++++++++++++ .../www-redirector/templates/deployment.yaml | 64 +++++++++++++ charts/www-redirector/templates/hpa.yaml | 28 ++++++ charts/www-redirector/templates/ingress.yaml | 61 +++++++++++++ charts/www-redirector/templates/service.yaml | 15 ++++ .../templates/serviceaccount.yaml | 12 +++ charts/www-redirector/values.yaml | 89 +++++++++++++++++++ 12 files changed, 482 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/release-charts.yaml create mode 100644 charts/www-redirector/.helmignore create mode 100644 charts/www-redirector/Chart.yaml create mode 100644 charts/www-redirector/README.md create mode 100644 charts/www-redirector/templates/_helpers.tpl create mode 100644 charts/www-redirector/templates/deployment.yaml create mode 100644 charts/www-redirector/templates/hpa.yaml create mode 100644 charts/www-redirector/templates/ingress.yaml create mode 100644 charts/www-redirector/templates/service.yaml create mode 100644 charts/www-redirector/templates/serviceaccount.yaml create mode 100644 charts/www-redirector/values.yaml diff --git a/.github/workflows/release-charts.yaml b/.github/workflows/release-charts.yaml new file mode 100644 index 0000000..4574d50 --- /dev/null +++ b/.github/workflows/release-charts.yaml @@ -0,0 +1,34 @@ +name: Release Charts + +on: + push: + branches: + - main + +jobs: + release: + # depending on default permission settings for your org (contents being read-only or read-write for workloads), you will have to add permissions + # see: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token + permissions: + contents: write + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Configure Git + run: | + git config user.name "$GITHUB_ACTOR" + git config user.email "$GITHUB_ACTOR@users.noreply.github.com" + + - name: Install Helm + uses: azure/setup-helm@v3 + with: + version: v3.11.0 + + - name: Run chart-releaser + uses: helm/chart-releaser-action@v1.5.0 + env: + CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/README.md b/README.md index c8d046c..dcac6b0 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,28 @@ # www-redirector -This is a tiny HTTP server that redirects all requests permanently to a another server. +This is a tiny HTTP server that redirects all requests permanently to another server. ## Configuration Use the `REDIRECT_URL` environment variable to set the URL to redirect to. The path and query string of the request will be appended to the URL. +## Sotware Container Image + +``` +ghcr.io/sintef/www-redirector +``` + +### Helm Chart + +A Helm chart is available in the [charts/www-redirector](charts/www-redirector/) directory. + ## Why -Sometimes it is simpler to have a tiny HTTP server to handle redirects than to configure a web server to do the redirects. -You could do the same thing using any web server, such as Caddy or Nginx. +Sometimes it is fun to over engineer things. + +It can also be simpler to use a tiny HTTP server to handle redirects compared to configuring a web server to do the redirects correctly. Especially when you are using an Kubernetes ingress controller or some load balancers and you don't feel like spending hours to figure out how to configure them correctly. -This is just a tiny server written mostly for fun. +You could do the same thing using any web server, such as Caddy or Nginx. But the 50 lines of rust code work too. ## License diff --git a/charts/www-redirector/.helmignore b/charts/www-redirector/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/www-redirector/.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/www-redirector/Chart.yaml b/charts/www-redirector/Chart.yaml new file mode 100644 index 0000000..70451d3 --- /dev/null +++ b/charts/www-redirector/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: www-redirector +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: "0.1.0" diff --git a/charts/www-redirector/README.md b/charts/www-redirector/README.md new file mode 100644 index 0000000..cd29a59 --- /dev/null +++ b/charts/www-redirector/README.md @@ -0,0 +1,55 @@ +# www-redirector chart + +A helm chart for [www-redirector](https://github.com/SINTEF/www-redirector). + +## Usage + +Install the helm chart repository: + +```bash +helm repo add www-redirector https://sintef.github.io/www-redirector +``` + +Install the chart: + +```bash +helm install www-redirector --set redirectUrl=https://example.net www-redirector/www-redirector +``` + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| redirectUrl | string | `"https://example.net"` | The URL to redirect to, the path and query string are appended to this URL. | +| affinity | object | `{}` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"ghcr.io/sintef/www-redirector"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.port | int | `8080` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| tolerations | list | `[]` | | + +---------------------------------------------- diff --git a/charts/www-redirector/templates/_helpers.tpl b/charts/www-redirector/templates/_helpers.tpl new file mode 100644 index 0000000..87bcf47 --- /dev/null +++ b/charts/www-redirector/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "www-redirector.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 "www-redirector.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 "www-redirector.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "www-redirector.labels" -}} +helm.sh/chart: {{ include "www-redirector.chart" . }} +{{ include "www-redirector.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "www-redirector.selectorLabels" -}} +app.kubernetes.io/name: {{ include "www-redirector.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "www-redirector.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "www-redirector.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/www-redirector/templates/deployment.yaml b/charts/www-redirector/templates/deployment.yaml new file mode 100644 index 0000000..8f20b43 --- /dev/null +++ b/charts/www-redirector/templates/deployment.yaml @@ -0,0 +1,64 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "www-redirector.fullname" . }} + labels: + {{- include "www-redirector.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "www-redirector.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "www-redirector.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "www-redirector.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 }} + env: + - name: REDIRECT_URL + value: {{ .Values.redirectUrl | quote }} + 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/charts/www-redirector/templates/hpa.yaml b/charts/www-redirector/templates/hpa.yaml new file mode 100644 index 0000000..a90da0b --- /dev/null +++ b/charts/www-redirector/templates/hpa.yaml @@ -0,0 +1,28 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2beta1 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "www-redirector.fullname" . }} + labels: + {{- include "www-redirector.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "www-redirector.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/charts/www-redirector/templates/ingress.yaml b/charts/www-redirector/templates/ingress.yaml new file mode 100644 index 0000000..156f78d --- /dev/null +++ b/charts/www-redirector/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "www-redirector.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 "www-redirector.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/www-redirector/templates/service.yaml b/charts/www-redirector/templates/service.yaml new file mode 100644 index 0000000..f8d9759 --- /dev/null +++ b/charts/www-redirector/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "www-redirector.fullname" . }} + labels: + {{- include "www-redirector.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "www-redirector.selectorLabels" . | nindent 4 }} diff --git a/charts/www-redirector/templates/serviceaccount.yaml b/charts/www-redirector/templates/serviceaccount.yaml new file mode 100644 index 0000000..ffdeafb --- /dev/null +++ b/charts/www-redirector/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "www-redirector.serviceAccountName" . }} + labels: + {{- include "www-redirector.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/charts/www-redirector/values.yaml b/charts/www-redirector/values.yaml new file mode 100644 index 0000000..02b7ce2 --- /dev/null +++ b/charts/www-redirector/values.yaml @@ -0,0 +1,89 @@ +# Default values for www-redirector. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +# -- The URL to redirect to, the path and query string are appended to this URL. +redirectUrl: https://example.net + +replicaCount: 1 + +image: + repository: ghcr.io/sintef/www-redirector + 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: {}