diff --git a/charts/demo-admin/.helmignore b/charts/demo-admin/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/demo-admin/.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/demo-admin/Chart.yaml b/charts/demo-admin/Chart.yaml new file mode 100644 index 0000000..000c66f --- /dev/null +++ b/charts/demo-admin/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: nuts-registry-admin-demo-chart +description: A NUTS demo adin 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.0.1 + +# 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.0.1" diff --git a/charts/demo-admin/README.md b/charts/demo-admin/README.md new file mode 100644 index 0000000..d558ee9 --- /dev/null +++ b/charts/demo-admin/README.md @@ -0,0 +1,74 @@ +# Helm Chart for NUTS demo-admin +This chart allows the ease of running NUTS demo-admin on a Kubernetes cluster. +All the NUTS demo-admin information is persisted on [Persisted Volumes](https://kubernetes. +io/docs/concepts/storage/persistent-volumes/). + +## Configure your NUTS node +All the configurable properties can be found at [./values.yaml](./values.yaml). + +The configuration contains default Helm properties. In addition to these values, +there are `demo-admin` config properties. This contains 3 sections: + +| Section | Description | +|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `admin.config` | Represents the `/app/server.config.yaml` file. All configurable properties can be found in the
main [README](../../README.md#Configuration). The properties are loaded into a `ConfigMap` and mounted as `/app/server.config.yaml` inside the Pod(s). | +| `admin.data` | Contains configurable properties for the `PersistedVolume` that will be created. This will be used to write all NUTS demo-admin data to. | + +### Special properties +NUTS demo-adminn allows binding to specific interfaces on the host machines. In the case of Kubernetes, this is already +taken care +of. However, we do need to expose the `http` and `gRPC` ports. This is extracted from the following properties: + +| Property | Value (default) | +|--------------------------------------------------------------|-----------------| +| `admin.config.port` (must align with `service.internalPort`) | :1303 | + + +### Overriding values +#### From Source +The properties can be manually changed in the [./values.yaml](./values.yaml), or they can be overwritten whilst running +`helm install` via the `--set x=y` parameter. + +#### From the NUTS Helm Repo + +The default values can be viewed with the following command: +```shell +helm show values nuts-repo/nuts-admin-demo-chart +``` + +You can then override any of these settings in a YAML formatted file, and then pass that file during [installation](#from-the-nuts-helm-repo-1). + +## Installing NUTS admin-demo +### From Source + +Execute the following command from the root of the chart folder. Replace `` with the name you +wish to give this Helm installation. +``` +helm install . +``` +### From the NUTS Helm Repo + +Add the NUTS helm Repo with the following command: +```shell +helm repo add nuts-repo https://nuts-foundation.github.io/nuts-registry-admin-demo/ +``` +This should list available releases with the following command: +```shell +helm search repo nuts-registry-admin-demo +``` + +After this, the desired version can be installed with the following command: +```shell +helm repo update # Make sure we get the latest list of charts +helm install -f values.yaml nuts-repo/nuts-registry-admin-demo-chart +``` + +Note that the `values.yaml` in the above command is the result from the [configuration step](#from-the-nuts-helm-repo). + +## Uninstalling NUTS +As the `PersistedVolume` can contain crucial data (like the private keys), by default, the uninstall command will not remove it and its +`PersistedVolumeClaim`. If you're sure it can be deleted, this can be done with the following command: +```shell +kubectl delete pvc nuts- nuts-registry-admin-demo-data-pvc +kubectl delete pv nuts- nuts-registry-admin-demo-data-pv +``` diff --git a/charts/demo-admin/templates/NOTES.txt b/charts/demo-admin/templates/NOTES.txt new file mode 100644 index 0000000..3873fd6 --- /dev/null +++ b/charts/demo-admin/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 "chart.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 "chart.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "chart.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 "chart.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:{{ .Values.service.internalPort }}/status to view the node status" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME {{ .Values.service.internalPort }}:$CONTAINER_PORT +{{- end }} diff --git a/charts/demo-admin/templates/_helpers.tpl b/charts/demo-admin/templates/_helpers.tpl new file mode 100644 index 0000000..9dcea4c --- /dev/null +++ b/charts/demo-admin/templates/_helpers.tpl @@ -0,0 +1,73 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "chart.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 "chart.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 "chart.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "chart.labels" -}} +helm.sh/chart: {{ include "chart.chart" . }} +{{ include "chart.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "chart.selectorLabels" -}} +app.kubernetes.io/name: {{ include "chart.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "chart.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "chart.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} + +{{/* +NUTS Port helpers +*/}} +{{- define "grpcPort" -}} +{{- if .Values.nuts.config.network.grpcaddr }} +{{- regexReplaceAll ".*:([0-9]+)" .Values.nuts.config.network.grpcaddr "${1}" }} +{{- else }} +{{- default 5555}} +{{- end }} +{{- end }} \ No newline at end of file diff --git a/charts/demo-admin/templates/deployment.yaml b/charts/demo-admin/templates/deployment.yaml new file mode 100644 index 0000000..7e8a2e4 --- /dev/null +++ b/charts/demo-admin/templates/deployment.yaml @@ -0,0 +1,84 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "chart.fullname" . }} + labels: + {{- include "chart.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "chart.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "chart.selectorLabels" . | nindent 8 }} + spec: + volumes: + - name: nuts-registry-admin-demo-config + configMap: + name: nuts-registry-admin-demo-config + - name: nuts-registry-admin-demo-data-pv + persistentVolumeClaim: + claimName: nuts-registry-admin-demo-data-pvc + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "chart.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: NUTS_CONFIGFILE + value: "/app/server.config.yaml" + volumeMounts: + - name: nuts-registry-admin-demo-config + mountPath: /app/server.config.yaml + subPath: server.config.yaml + readOnly: true + - name: nuts-registry-admin-demo-data-pv + mountPath: /app/data + ports: + - name: http + containerPort: {{ .Values.service.internalPort | default 1303 }} + protocol: TCP + livenessProbe: + httpGet: + path: /status + port: http + readinessProbe: + httpGet: + path: /status + port: http + startupProbe: + httpGet: + path: /status + port: http + failureThreshold: 300 + periodSeconds: 10 + 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/demo-admin/templates/hpa.yaml b/charts/demo-admin/templates/hpa.yaml new file mode 100644 index 0000000..548ee03 --- /dev/null +++ b/charts/demo-admin/templates/hpa.yaml @@ -0,0 +1,28 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2beta1 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "chart.fullname" . }} + labels: + {{- include "chart.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "chart.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/demo-admin/templates/ingress.yaml b/charts/demo-admin/templates/ingress.yaml new file mode 100644 index 0000000..63c1311 --- /dev/null +++ b/charts/demo-admin/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "chart.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 "chart.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/demo-admin/templates/nuts-demo-admin-configmap.yaml b/charts/demo-admin/templates/nuts-demo-admin-configmap.yaml new file mode 100644 index 0000000..5e79138 --- /dev/null +++ b/charts/demo-admin/templates/nuts-demo-admin-configmap.yaml @@ -0,0 +1,7 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: nuts-registry-admin-demo-config +data: + server.config.yaml: | + {{- toYaml .Values.admin.config | nindent 4 }} diff --git a/charts/demo-admin/templates/nuts-demo-admin-data-pv.yaml b/charts/demo-admin/templates/nuts-demo-admin-data-pv.yaml new file mode 100644 index 0000000..7580245 --- /dev/null +++ b/charts/demo-admin/templates/nuts-demo-admin-data-pv.yaml @@ -0,0 +1,34 @@ +{{ if .Values.admin.data.persistedVolume.enabled }} +apiVersion: v1 +kind: PersistentVolume +metadata: + name: nuts-registry-admin-demo-data-pv + labels: + type: local + annotations: + "helm.sh/resource-policy": keep +spec: + persistentVolumeReclaimPolicy: Retain + storageClassName: {{ .Values.admin.data.persistedVolume.storageClassName | default "" }} + capacity: + storage: {{ .Values.admin.data.persistedVolume.capacity | default "100Mi" }} + accessModes: {{ required "Please define `nuts.data.persistedVolume.accessModes` in `values.yaml`" .Values.admin.data.persistedVolume.accessModes }} + hostPath: + path: {{ .Values.admin.data.persistedVolume.mountPath }} +--- +{{ end }} +{{ if .Values.admin.data.persistedVolumeClaim.enabled }} +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: nuts-registry-admin-demo-data-pvc + annotations: + "helm.sh/resource-policy": keep +spec: + storageClassName: {{ .Values.admin.data.persistedVolumeClaim.storageClassName | default "" }} + accessModes: {{ required "Please define `nuts.data.persistedVolumeClaim.accessModes` in `values.yaml`" .Values.admin.data.persistedVolumeClaim.accessModes }} + resources: + requests: + storage: {{ .Values.admin.data.persistedVolumeClaim.capacity | default "100Mi" }} +--- +{{ end }} diff --git a/charts/demo-admin/templates/service.yaml b/charts/demo-admin/templates/service.yaml new file mode 100644 index 0000000..dfc5b3a --- /dev/null +++ b/charts/demo-admin/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "chart.fullname" . }} + labels: + {{- include "chart.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "chart.selectorLabels" . | nindent 4 }} diff --git a/charts/demo-admin/templates/serviceaccount.yaml b/charts/demo-admin/templates/serviceaccount.yaml new file mode 100644 index 0000000..26a57fa --- /dev/null +++ b/charts/demo-admin/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "chart.serviceAccountName" . }} + labels: + {{- include "chart.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/charts/demo-admin/templates/tests/test-connection.yaml b/charts/demo-admin/templates/tests/test-connection.yaml new file mode 100644 index 0000000..8dfed87 --- /dev/null +++ b/charts/demo-admin/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "chart.fullname" . }}-test-connection" + labels: + {{- include "chart.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "chart.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/charts/demo-admin/values.yaml b/charts/demo-admin/values.yaml new file mode 100644 index 0000000..5f06877 --- /dev/null +++ b/charts/demo-admin/values.yaml @@ -0,0 +1,110 @@ +# Default values for chart. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: nutsfoundation/nuts-registry-admin-demo + 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: 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 + internalPort: 1303 + port: 1303 + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: admin-demo.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: {} + +admin: + config: + # Everything below `nuts.config` will be placed into the `nuts.yaml` config file of the Pods + credentials: + username: "demo@nuts.nl" + password: "demo" + port: 1303 + nutsNodeAddr: "http://localhost:1323" + branding: + logo: "logo.png" + + # Config for the NUTS data mount inside Kubernetes + data: + persistedVolume: + enabled: true + capacity: 100Mi + mountPath: /app/data + accessModes: + - ReadWriteOnce + storageClassName: "" + persistedVolumeClaim: + enabled: true + capacity: 100Mi + storageClassName: "" + accessModes: + - ReadWriteOnce