From 5ff68c2154567640b6af0849dbe8a40b0b5b115c Mon Sep 17 00:00:00 2001 From: Eagleman7 Date: Tue, 2 Feb 2021 23:08:19 +0100 Subject: [PATCH 1/4] protonmail-bridge --- charts/protonmail-bridge/Chart.yaml | 18 ++++ charts/protonmail-bridge/OWNERS | 8 ++ charts/protonmail-bridge/README.md | 86 +++++++++++++++++++ charts/protonmail-bridge/templates/NOTES.txt | 1 + .../protonmail-bridge/templates/common.yaml | 1 + charts/protonmail-bridge/values.yaml | 19 ++++ 6 files changed, 133 insertions(+) create mode 100644 charts/protonmail-bridge/Chart.yaml create mode 100644 charts/protonmail-bridge/OWNERS create mode 100644 charts/protonmail-bridge/README.md create mode 100644 charts/protonmail-bridge/templates/NOTES.txt create mode 100644 charts/protonmail-bridge/templates/common.yaml create mode 100644 charts/protonmail-bridge/values.yaml diff --git a/charts/protonmail-bridge/Chart.yaml b/charts/protonmail-bridge/Chart.yaml new file mode 100644 index 0000000000..4d4cabb6d9 --- /dev/null +++ b/charts/protonmail-bridge/Chart.yaml @@ -0,0 +1,18 @@ +apiVersion: v2 +appVersion: 1.5.7-1 +description: Container for protonmail bridge to work on the network. +name: protonmail-bridge +version: 1.0.0 +keywords: + - protonmail + - protonmail-bridge +sources: + - https://github.com/shenxn/protonmail-bridge-docker + - https://hub.docker.com/r/shenxn/protonmail-bridge +maintainers: + - name: Eagleman7 + email: my@email.com +dependencies: + - name: common + repository: https://k8s-at-home.com/charts/ + version: 2.2.1 \ No newline at end of file diff --git a/charts/protonmail-bridge/OWNERS b/charts/protonmail-bridge/OWNERS new file mode 100644 index 0000000000..2f1d2fb2e0 --- /dev/null +++ b/charts/protonmail-bridge/OWNERS @@ -0,0 +1,8 @@ +approvers: +- billimek +- onedr0p +- bjw-s +reviewers: +- billimek +- onedr0p +- bjw-s \ No newline at end of file diff --git a/charts/protonmail-bridge/README.md b/charts/protonmail-bridge/README.md new file mode 100644 index 0000000000..f6e30b5f17 --- /dev/null +++ b/charts/protonmail-bridge/README.md @@ -0,0 +1,86 @@ +# Protonmail-bridge + +This is a helm chart for [Protonmail-bridge](https://github.com/shenxn/protonmail-bridge-docker). + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** + +## TL;DR; + +```shell +$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ +$ helm install k8s-at-home/protonmail-bridge +``` + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +helm install --name my-release k8s-at-home/protonmail-bridge +``` + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```console +helm delete my-release --purge +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration +Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/protonmail-bridge/values.yaml) +file. It has several commented out suggested values. +Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +```console +helm install protonmail-bridge \ + --set env.TZ="America/New_York" \ + k8s-at-home/protonmail-bridge +``` +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the +chart. For example, +```console +helm install protonmail-bridge k8s-at-home/protonmail-bridge --values values.yaml +``` + +```yaml +image: + tag: ... +``` + +Get the name of your deployed pod kubectl get pods +Run interactively on the pod (setup only) kubectl exec --stdin --tty protonmail-bridge-deployment-6c79fd7f84-ftwcw -- /bin/bash +Once logged in, execute the init command bash /protonmail/entrypoint.sh init +You should now see the CLI for protonmail-bridge, authenticate with login +(optional) if you're like me and use split address mode, change mode and info are good for printing the details. +Copy your SMTP server info (or IMAP, your choice) +delete the active pod so a new one gets created (which will properly fire up with your persisted settings) + +--- +**NOTE** + +If you get +```console +Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` +``` +it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. + +--- + +## Upgrading an existing Release to a new major version + +A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. + +### Upgrading from 3.x.x to 4.x.x + +Due to migrating to a centralized common library some values in `values.yaml` have changed. + +Examples: + +* `service.port` has been moved to `service.port.port`. +* `persistence.type` has been moved to `controllerType`. + +Refer to the library values.yaml for more configuration options. diff --git a/charts/protonmail-bridge/templates/NOTES.txt b/charts/protonmail-bridge/templates/NOTES.txt new file mode 100644 index 0000000000..a4b771eb76 --- /dev/null +++ b/charts/protonmail-bridge/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} \ No newline at end of file diff --git a/charts/protonmail-bridge/templates/common.yaml b/charts/protonmail-bridge/templates/common.yaml new file mode 100644 index 0000000000..0964ad20c2 --- /dev/null +++ b/charts/protonmail-bridge/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} \ No newline at end of file diff --git a/charts/protonmail-bridge/values.yaml b/charts/protonmail-bridge/values.yaml new file mode 100644 index 0000000000..f7dd274293 --- /dev/null +++ b/charts/protonmail-bridge/values.yaml @@ -0,0 +1,19 @@ +# Default values for Protonmail-bridge. + +image: + repository: shenxn/protonmail-bridge + tag: 1.5.7-1 + pullPolicy: IfNotPresent + +strategy: + type: Recreate + +service: + port: + port: 25 + name: smtp-service + +persistence: + config: + enabled: true + mountPath: /root \ No newline at end of file From 16b985840a4593e8ebb293f0ccd2df608200a760 Mon Sep 17 00:00:00 2001 From: Eagleman7 Date: Tue, 2 Feb 2021 23:16:40 +0100 Subject: [PATCH 2/4] Update Chart.yaml --- charts/protonmail-bridge/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/protonmail-bridge/Chart.yaml b/charts/protonmail-bridge/Chart.yaml index 4d4cabb6d9..c2f18f7b7c 100644 --- a/charts/protonmail-bridge/Chart.yaml +++ b/charts/protonmail-bridge/Chart.yaml @@ -15,4 +15,4 @@ maintainers: dependencies: - name: common repository: https://k8s-at-home.com/charts/ - version: 2.2.1 \ No newline at end of file + version: 2.2.1 From 0c9dd674b87797947a29636aad6cc962bc2711b1 Mon Sep 17 00:00:00 2001 From: Eagleman7 Date: Tue, 2 Feb 2021 23:17:49 +0100 Subject: [PATCH 3/4] Update values.yaml --- charts/protonmail-bridge/values.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/protonmail-bridge/values.yaml b/charts/protonmail-bridge/values.yaml index f7dd274293..0a246f4057 100644 --- a/charts/protonmail-bridge/values.yaml +++ b/charts/protonmail-bridge/values.yaml @@ -16,4 +16,4 @@ service: persistence: config: enabled: true - mountPath: /root \ No newline at end of file + mountPath: /root From 4f6dc9bc53f4262e025c7a61b606cbe17e6c189b Mon Sep 17 00:00:00 2001 From: Eagleman7 Date: Tue, 2 Feb 2021 23:17:59 +0100 Subject: [PATCH 4/4] Create values.yaml