Skip to content

Commit

Permalink
Updated the ship chart to include a .helmignore and NOTES.txt file. A…
Browse files Browse the repository at this point in the history
…dded the traefik-dashboard and traefik-helpers charts
  • Loading branch information
glenndehaan committed Feb 13, 2023
1 parent 0a897c5 commit 7043b10
Show file tree
Hide file tree
Showing 26 changed files with 651 additions and 1 deletion.
23 changes: 23 additions & 0 deletions charts/ship/.helmignore
Original file line number Diff line number Diff line change
@@ -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/
2 changes: 1 addition & 1 deletion charts/ship/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ 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.1
version: 1.0.2

# 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
Expand Down
24 changes: 24 additions & 0 deletions charts/ship/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Please wait a few seconds until the {{ .Chart.Name }} chart is fully installed.

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 "traefik-dashboard.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 "traefik-dashboard.fullname" . }}'
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "traefik-dashboard.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 "traefik-dashboard.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 }}
23 changes: 23 additions & 0 deletions charts/traefik-dashboard/.helmignore
Original file line number Diff line number Diff line change
@@ -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/
35 changes: 35 additions & 0 deletions charts/traefik-dashboard/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
apiVersion: v2
name: traefik-dashboard
description: A Helm chart to expose the Traefik Dashboard
home: https://github.com/glenndehaan/charts
keywords:
- kubernetes
- traefik
- dashboard
maintainers:
- email: glenn@dehaan.cloud
name: glenndehaan
url: https://glenndehaan.com
sources:
- https://github.com/glenndehaan/charts

# 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.0.0"
36 changes: 36 additions & 0 deletions charts/traefik-dashboard/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# traefik-dashboard

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)

A Helm chart to expose the Traefik Dashboard

**Homepage:** <https://github.com/glenndehaan/charts>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| glenndehaan | <glenn@dehaan.cloud> | <https://glenndehaan.com> |

## Source Code

* <https://github.com/glenndehaan/charts>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| certManager.enabled | bool | `false` | Toggles if a cert-manager certificate should be generated |
| certManager.issuerRef | object | `{}` | Cert-manager issuer reference |
| fullnameOverride | string | `""` | String to fully override names.fullname |
| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations. |
| ingress.entryPoints[0] | string | `"websecure"` | Default entrypoint Traefik listens on |
| ingress.host | string | `"chart-example.local"` | Default host for the ingress record |
| ingress.middlewares | list | `[]` | Traefik middlewares to include |
| ingress.tls | object | `{"enabled":true,"options":{}}` | Default TLS options |
| ingress.tls.enabled | bool | `true` | Toggles the TLS |
| ingress.tls.options | object | `{}` | Optional Traefik TLS options |
| nameOverride | string | `""` | String to partially override names.fullname |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
4 changes: 4 additions & 0 deletions charts/traefik-dashboard/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Please wait a few seconds until the {{ .Chart.Name }} chart is fully installed.
After installation is complete, you can view the Treafik dashboard here:

{{ .Values.ingress.host }}
62 changes: 62 additions & 0 deletions charts/traefik-dashboard/templates/_helpers.tpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
{{/*
Expand the name of the chart.
*/}}
{{- define "traefik-dashboard.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 "traefik-dashboard.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 "traefik-dashboard.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
{{- end }}

{{/*
Common labels
*/}}
{{- define "traefik-dashboard.labels" -}}
helm.sh/chart: {{ include "traefik-dashboard.chart" . }}
{{ include "traefik-dashboard.selectorLabels" . }}
{{- if .Chart.AppVersion }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
{{- end }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- end }}

{{/*
Selector labels
*/}}
{{- define "traefik-dashboard.selectorLabels" -}}
app.kubernetes.io/name: {{ include "traefik-dashboard.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{- end }}

{{/*
Create the name of the service account to use
*/}}
{{- define "traefik-dashboard.serviceAccountName" -}}
{{- if .Values.serviceAccount.create }}
{{- default (include "traefik-dashboard.fullname" .) .Values.serviceAccount.name }}
{{- else }}
{{- default "default" .Values.serviceAccount.name }}
{{- end }}
{{- end }}
16 changes: 16 additions & 0 deletions charts/traefik-dashboard/templates/certificate.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{{- if .Values.certManager.enabled }}
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
name: {{ include "traefik-dashboard.fullname" . }}
labels:
{{- include "traefik-dashboard.labels" . | nindent 4 }}
spec:
secretName: {{ include "traefik-dashboard.fullname" . }}-tls
{{- with .Values.certManager.issuerRef }}
issuerRef:
{{- toYaml . | nindent 4 }}
{{- end }}
dnsNames:
- "{{ .Values.ingress.host }}"
{{- end }}
37 changes: 37 additions & 0 deletions charts/traefik-dashboard/templates/ingress.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
apiVersion: traefik.containo.us/v1alpha1
kind: IngressRoute
metadata:
name: {{ include "traefik-dashboard.fullname" . }}
labels:
{{- include "traefik-dashboard.labels" . | nindent 4 }}
{{- with .Values.ingress.annotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
{{- if .Values.ingress.tls.enabled }}
tls:
secretName: {{ include "traefik-dashboard.fullname" . }}-tls
{{- with .Values.ingress.tls.options }}
options:
{{- toYaml . | nindent 6 }}
{{- end }}
domains:
- main: {{ .Values.ingress.host }}
{{- end }}
{{- with .Values.ingress.entryPoints }}
entryPoints:
{{- toYaml . | nindent 4 }}
{{- end }}
routes:
- match: 'Host(`{{ .Values.ingress.host }}`)'
kind: Rule
{{- if .Values.ingress.middlewares }}
middlewares:
{{- range .Values.ingress.middlewares }}
- name: {{ .name | quote }}
{{- end }}
{{- end }}
services:
- name: api@internal
kind: TraefikService
36 changes: 36 additions & 0 deletions charts/traefik-dashboard/values.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Default values for traefik-dashboard.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

# -- String to partially override names.fullname
nameOverride: ""
# -- String to fully override names.fullname
fullnameOverride: ""

ingress:
entryPoints:
# -- Default entrypoint Traefik listens on
- websecure
# -- Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations.
annotations: {}
# kubernetes.io/ingress.class: nginx
# kubernetes.io/tls-acme: "true"
# -- Default host for the ingress record
host: chart-example.local
# -- Traefik middlewares to include
middlewares: []
# - name: ip-whitelist
# -- Default TLS options
tls:
# -- Toggles the TLS
enabled: true
# -- Optional Traefik TLS options
options: {}

certManager:
# -- Toggles if a cert-manager certificate should be generated
enabled: false
# -- Cert-manager issuer reference
issuerRef: {}
# name: acme-issuer
# kind: ClusterIssuer
23 changes: 23 additions & 0 deletions charts/traefik-helpers/.helmignore
Original file line number Diff line number Diff line change
@@ -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/
37 changes: 37 additions & 0 deletions charts/traefik-helpers/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
apiVersion: v2
name: traefik-helpers
description: A Helm chart with useful Traefik middlewares, helpers and default configuration
home: https://github.com/glenndehaan/charts
keywords:
- kubernetes
- traefik
- middlewares
- helpers
- config
maintainers:
- email: glenn@dehaan.cloud
name: glenndehaan
url: https://glenndehaan.com
sources:
- https://github.com/glenndehaan/charts

# 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.0.0"
Loading

0 comments on commit 7043b10

Please sign in to comment.