From 537334364ac75cea5dce2555b93a59f6efa88d61 Mon Sep 17 00:00:00 2001 From: Fleur Kelpin Date: Fri, 7 Sep 2018 18:10:12 +0200 Subject: [PATCH] doc: Clean up vault documentation --- README.md | 3 +- molgenis-vault/resources/vault.yaml | 1 + molgenis-vault/templates/NOTES.txt | 14 ++++++- molgenis-vault/templates/abs-secret.yaml | 1 + .../templates/backup-configmap.yaml | 1 + molgenis-vault/templates/ingress.yaml | 38 ------------------- 6 files changed, 18 insertions(+), 40 deletions(-) delete mode 100644 molgenis-vault/templates/ingress.yaml diff --git a/README.md b/README.md index a9f0db7..ce8c869 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,8 @@ This repository is serves also as a catalogue for Rancher. We have serveral apps - [Jenkins](molgenis-jenkins/README.md) - [NEXUS](molgenis-nexus/README.md) - [HTTPD](molgenis-httpd/README.md) -- [MOLNIGES preview](molgenis-preview/README.md) +- [MOLGENIS preview](molgenis-preview/README.md) +- [MOLGENIS vault](molgenis-vault/README.md) ### Useful commands You can you need to know to easily develop and deploy helm-charts diff --git a/molgenis-vault/resources/vault.yaml b/molgenis-vault/resources/vault.yaml index a4158b8..fa1c83b 100644 --- a/molgenis-vault/resources/vault.yaml +++ b/molgenis-vault/resources/vault.yaml @@ -1,3 +1,4 @@ +# Use kubectl create -f vault.yaml to manually create a vault apiVersion: "vault.security.coreos.com/v1alpha1" kind: "VaultService" metadata: diff --git a/molgenis-vault/templates/NOTES.txt b/molgenis-vault/templates/NOTES.txt index ae4cce7..5df45af 100644 --- a/molgenis-vault/templates/NOTES.txt +++ b/molgenis-vault/templates/NOTES.txt @@ -1 +1,13 @@ -Good luck! \ No newline at end of file +Vault operator created + +Next steps: + +* Manually create a vault using resources/vault.yaml +* Manually restore a backup using resources/backup.yaml +* Unseal the vault pods + +{{ if .Values.backupJob.enable }} +!! Make sure to check if the backups succeed !! +{{ else }} +!!!!!! NO BACKUPS CONFIGURED !!!!!! +{{ end }} \ No newline at end of file diff --git a/molgenis-vault/templates/abs-secret.yaml b/molgenis-vault/templates/abs-secret.yaml index 519c814..66c94b7 100644 --- a/molgenis-vault/templates/abs-secret.yaml +++ b/molgenis-vault/templates/abs-secret.yaml @@ -1,3 +1,4 @@ +# Secret to access microsoft azure block store apiVersion: v1 kind: Secret metadata: diff --git a/molgenis-vault/templates/backup-configmap.yaml b/molgenis-vault/templates/backup-configmap.yaml index 89f5404..94f862e 100644 --- a/molgenis-vault/templates/backup-configmap.yaml +++ b/molgenis-vault/templates/backup-configmap.yaml @@ -1,3 +1,4 @@ +# configmap to use as a template for backup cron jobs apiVersion: v1 kind: ConfigMap metadata: diff --git a/molgenis-vault/templates/ingress.yaml b/molgenis-vault/templates/ingress.yaml deleted file mode 100644 index 020b7a4..0000000 --- a/molgenis-vault/templates/ingress.yaml +++ /dev/null @@ -1,38 +0,0 @@ -{{- if .Values.ingress.enabled -}} -{{- $fullName := include "molgenis-vault.fullname" . -}} -{{- $ingressPath := .Values.ingress.path -}} -apiVersion: extensions/v1beta1 -kind: Ingress -metadata: - name: {{ $fullName }} - labels: - app: {{ template "molgenis-vault.name" . }} - chart: {{ template "molgenis-vault.chart" . }} - release: {{ .Release.Name }} - heritage: {{ .Release.Service }} -{{- with .Values.ingress.annotations }} - annotations: -{{ toYaml . | indent 4 }} -{{- end }} -spec: -{{- if .Values.ingress.tls }} - tls: - {{- range .Values.ingress.tls }} - - hosts: - {{- range .hosts }} - - {{ . }} - {{- end }} - secretName: {{ .secretName }} - {{- end }} -{{- end }} - rules: - {{- range .Values.ingress.hosts }} - - host: {{ . }} - http: - paths: - - path: {{ $ingressPath }} - backend: - serviceName: {{ $fullName }} - servicePort: http - {{- end }} -{{- end }}