Merge pull request #485 from shieldworks/topic/abhisheks2/302

#302: Introducing initial helm chart for aegis

helm-charts/.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/

helm-charts/Chart.yaml

@@ -0,0 +1,42 @@
+apiVersion: v2
+name: aegis
+description: Helm chart for aegis
+
+# 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
+sources:
+- https://github.com/shieldworks/aegis
+
+# 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.18.1"
+home: https://aegis.ist/
+icon: https://raw.githubusercontent.com/shieldworks/aegis/main/assets/aegis-banner.png
+keywords:
+ - secrets
+
+dependencies:
+ - name: spire
+ repository: file://charts/spire
+ version: 0.1.0
+ condition: global.deploySpire
+ - name: safe
+ repository: file://charts/safe
+ version: 0.18.1
+ - name: sentinel
+ repository: file://charts/sentinel
+ version: 0.18.1

helm-charts/README.md

@@ -0,0 +1,46 @@
+# Aegis Helm Chart
+
+Aegis keeps your secrets secret. With Aegis, you can rest assured that your sensitive data is always secure and protected. Aegis is perfect for securely storing arbitrary configuration information at a central location and securely dispatching it to workloads.
+
+## Installation
+
+To use Aegis, follow the steps below:
+
+1. Add Aegis Helm repository:
+
+ ```bash
+ helm repo add aegis https://shieldworks.github.io/aegis/
+ ```
+
+2. Update helm repository:
+
+ ```bash
+ helm repo update
+ ```
+
+3. Install Aegis using Helm:
+
+ ```bash
+ helm install aegis aegis/aegis --version 0.1.0
+ ```
+
+## Options
+
+The following options can be passed to the `helm install` command to set global variables:
+
+- `--set global.deploySpire=<true/false>`: This flag can be passed to install or skip Spire.
+- `--set global.baseImage=<distroless/distroless-fips/photon/photos-fips>`: This flag can be passed to install Aegis with the given baseImage Docker image.
+
+Default values are `true` and `distroless` for `global.deploySpire` and `global.baseImage` respectively.
+
+Here's an example command with the above options:
+
+```bash
+helm install aegis aegis/helm-charts --version 0.1.0 --set global.deploySpire=true --set global.baseImage=distroless
+```
+
+Make sure to replace `<true/false>` and `<distroless/distroless-fips/photon/photos-fips>` with the desired values.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

helm-charts/charts/safe/.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/

helm-charts/charts/safe/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: safe
+description: Helm chart for aegis-safe
+
+# 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.18.1"

helm-charts/charts/safe/templates/Deployment.yaml

@@ -0,0 +1,100 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: {{ include "safe.fullname" . }}
+ namespace: {{ .Values.global.aegis.namespace }}
+ labels:
+ {{- include "safe.labels" . | nindent 4 }}
+spec:
+ {{- if not .Values.autoscaling.enabled }}
+ replicas: {{ .Values.replicaCount }}
+ {{- end }}
+ selector:
+ matchLabels:
+ {{- include "safe.selectorLabels" . | nindent 6 }}
+ template:
+ metadata:
+ {{- with .Values.podAnnotations }}
+ annotations:
+ {{- toYaml . | nindent 8 }}
+ {{- end }}
+ labels:
+ {{- include "safe.selectorLabels" . | nindent 8 }}
+ spec:
+ {{- with .Values.imagePullSecrets }}
+ imagePullSecrets:
+ {{- toYaml . | nindent 8 }}
+ {{- end }}
+ serviceAccountName: {{ include "safe.serviceAccountName" . }}
+ securityContext:
+ {{- toYaml .Values.podSecurityContext | nindent 8 }}
+ containers:
+ - name: main
+ image: "{{ .Values.global.registry }}/{{- include "safe.repository" .}}:{{ .Values.global.images.safe.tag }}"
+ imagePullPolicy: {{ .Values.global.images.safe.pullPolicy }}
+ ports:
+ - containerPort: 8443
+ volumeMounts:
+ - name: spire-agent-socket
+ mountPath: /spire-agent-socket
+ readOnly: true
+ - name: aegis-data
+ mountPath: /data
+ - name: aegis-age
+ mountPath: /key
+ readOnly: true
+ #
+ # You can configure Aegis Safe by providing environment variables.
+ #
+ # See https://aegis.ist/docs/configuration for more information about
+ # these environment variables.
+ #
+ # When you don’t explicitly provide env vars here, Aegis Safe will assume
+ # the default values outlined in the given link above.
+ #
+ env:
+ {{- range .Values.environments }}
+ - name: {{ .name }}
+ value: {{ .value | quote }}
+ {{- end }}
+ - name: AEGIS_SENTINEL_SVID_PREFIX
+ value: "spiffe://aegis.ist/workload/aegis-sentinel/ns/{{ .Values.global.aegis.namespace }}/sa/aegis-sentinel/n/"
+ - name: AEGIS_SAFE_SVID_PREFIX
+ value: "spiffe://aegis.ist/workload/aegis-safe/ns/{{ .Values.global.aegis.namespace }}/sa/aegis-safe/n/"
+ - name: AEGIS_PROBE_LIVENESS_PORT
+ value: ":{{ .Values.livenessPort }}"
+ - name: AEGIS_PROBE_READINESS_PORT
+ value: ":{{ .Values.readynessPort }}"
+ livenessProbe:
+ httpGet:
+ path: /
+ port: {{ .Values.livenessPort }}
+ initialDelaySeconds: 1
+ periodSeconds: 10
+ readinessProbe:
+ httpGet:
+ path: /
+ port: {{ .Values.readynessPort }}
+ initialDelaySeconds: 1
+ periodSeconds: 10
+ resources:
+ {{- toYaml .Values.resources | nindent 12 }}
+ volumes:
+ # Using SPIFFE CSI Driver to bind to the SPIRE Agent Socket
+ # ref: https://github.com/spiffe/spiffe-csi
+ - name: spire-agent-socket
+ csi:
+ driver: "csi.spiffe.io"
+ readOnly: true
+ # `aegis-data` is used to persist the encrypted backups of the secrets.
+ - name: aegis-data
+ hostPath:
+ path: /var/local/aegis/data
+ type: DirectoryOrCreate
+ # `aegis-age` stores the encryption keys to restore secrets from aegis-data.
+ - name: aegis-age
+ secret:
+ secretName: {{ .Values.ageKeySecretName }}
+ items:
+ - key: KEY_TXT
+ path: key.txt

helm-charts/charts/safe/templates/_helpers.tpl

@@ -0,0 +1,80 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "safe.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 "safe.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 "safe.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "safe.labels" -}}
+helm.sh/chart: {{ include "safe.chart" . }}
+{{ include "safe.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "safe.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "safe.fullname" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+app.kubernetes.io/part-of: {{ .Values.global.aegis.namespace }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "safe.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "safe.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+Define image for aegis safe
+*/}}
+{{- define "safe.repository" -}}
+{{- if eq (lower $.Values.global.baseImage) "distroless" }}
+{{- .Values.global.images.safe.distrolessRepository }}
+{{- else if eq (lower $.Values.global.baseImage) "distroless-fips" }}
+{{- .Values.global.images.safe.distrolessFipsRepository }}
+{{- else if eq (lower $.Values.global.baseImage) "photon" }}
+{{- .Values.global.images.safe.photonRepository }}
+{{- else if eq (lower $.Values.global.baseImage) "photon-fips" }}
+{{- .Values.global.images.safe.photonFipsRepository }}
+{{- else }}
+{{- .Values.global.images.safe.distrolessRepository }}
+{{- end }}
+{{- end }}