From a389c0ed86b98d83a1fccb58ef1d0c6fc71ddbbb Mon Sep 17 00:00:00 2001 From: Tamas Varga Date: Fri, 11 Mar 2022 14:12:25 +0100 Subject: [PATCH] [signalclirestapi] Add incubator chart signal-cli-rest-api (#1449) * [signalclirestapi] New incubator chart for signal-cli-rest-api Signed-off-by: Tamas Varga * [signalclirestapi] Update README.md with signal-cli-rest-api specific env variable Signed-off-by: Tamas Varga * [signalclirestapi] Fix appversion and version. Remove image.tag from values.yaml Signed-off-by: Tamas Varga * [signalclirestapi] Add image.tag to values.yaml, but leave it empty as it will default to appVersion Signed-off-by: Tamas Varga Co-authored-by: Devin Buhl --- .../incubator/signal-cli-rest-api/.helmignore | 26 ++++ .../incubator/signal-cli-rest-api/Chart.yaml | 25 ++++ .../incubator/signal-cli-rest-api/README.md | 116 ++++++++++++++++++ .../README_CONFIG.md.gotmpl | 9 ++ .../signal-cli-rest-api/templates/NOTES.txt | 1 + .../signal-cli-rest-api/templates/common.yaml | 1 + .../incubator/signal-cli-rest-api/values.yaml | 50 ++++++++ 7 files changed, 228 insertions(+) create mode 100644 charts/incubator/signal-cli-rest-api/.helmignore create mode 100644 charts/incubator/signal-cli-rest-api/Chart.yaml create mode 100644 charts/incubator/signal-cli-rest-api/README.md create mode 100644 charts/incubator/signal-cli-rest-api/README_CONFIG.md.gotmpl create mode 100644 charts/incubator/signal-cli-rest-api/templates/NOTES.txt create mode 100644 charts/incubator/signal-cli-rest-api/templates/common.yaml create mode 100644 charts/incubator/signal-cli-rest-api/values.yaml diff --git a/charts/incubator/signal-cli-rest-api/.helmignore b/charts/incubator/signal-cli-rest-api/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/incubator/signal-cli-rest-api/.helmignore @@ -0,0 +1,26 @@ +# 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 +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/incubator/signal-cli-rest-api/Chart.yaml b/charts/incubator/signal-cli-rest-api/Chart.yaml new file mode 100644 index 00000000..9a0d009b --- /dev/null +++ b/charts/incubator/signal-cli-rest-api/Chart.yaml @@ -0,0 +1,25 @@ +apiVersion: v2 +version: 1.0.0 +description: Dockerized Signal Messenger REST API +name: signal-cli-rest-api +appVersion: "0.57" +kubeVersion: ">=1.16.0-0" +keywords: + - signal-cli-rest-api + - signal-messenger + - signal +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/signal-cli-rest-api +icon: https://signal-cli-rest-api.org/icon +sources: + - https://github.com/bbernhard/signal-cli-rest-api +maintainers: + - name: vargat + url: https://github.com/tamasv +dependencies: + - name: common + repository: https://library-charts.k8s-at-home.com + version: 4.3.0 +annotations: + artifacthub.io/changes: | + - kind: added + description: Initial version diff --git a/charts/incubator/signal-cli-rest-api/README.md b/charts/incubator/signal-cli-rest-api/README.md new file mode 100644 index 00000000..56cefc9f --- /dev/null +++ b/charts/incubator/signal-cli-rest-api/README.md @@ -0,0 +1,116 @@ +# signal-cli-rest-api + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) + +signal-cli-rest-api helm package + +**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)** + +## Source Code + +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://library-charts.k8s-at-home.com | common | 4.0.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install signal-cli-rest-api k8s-at-home/signal-cli-rest-api +``` + +## Installing the Chart + +To install the chart with the release name `signal-cli-rest-api` + +```console +helm install signal-cli-rest-api k8s-at-home/signal-cli-rest-api +``` + +## Uninstalling the Chart + +To uninstall the `signal-cli-rest-api` deployment + +```console +helm uninstall signal-cli-rest-api +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install signal-cli-rest-api \ + --set env.TZ="America/New York" \ + k8s-at-home/signal-cli-rest-api +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install signal-cli-rest-api k8s-at-home/signal-cli-rest-api -f values.yaml +``` + +## Custom configuration + +N/A + +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | See below | environment variables. See more environment variables in the [signal-cli-rest-api documentation](https://signal-cli-rest-api.org/docs). | +| env.TZ | string | `"UTC"` | Set the container timezone | +| env.MODE | string | `"native"` | Set the Execution mode. See https://github.com/bbernhard/signal-cli-rest-api#execution-modes | +| env.AUTO_RECEIVE_SCHEDULE | string | `"0 22 * * *"` | Set the Auto receive schedule. See https://github.com/bbernhard/signal-cli-rest-api#auto-receive-schedule | +| env.SIGNAL_CLI_CONFIG_DIR | string | `"/home/.local/share/signal-cli"` | Set the config directory for the application. See https://github.com/bbernhard/signal-cli-rest-api#advanced-settings | +| env.SIGNAL_CLI_UID | string | `"1000"` | Specifies the uid of the signal-api user inside the docker container. Defaults to 1000 | +| env.SIGNAL_CLI_GID | string | `"1000"` | Specifies the gid of the signal-api group inside the docker container. Defaults to 1000 | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"signal-cli-rest-api/signal-cli-rest-api"` | image repository | +| image.tag | string | `"1.0.0"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | +| service | object | See values.yaml | Configures service settings for the chart. | + +## Changelog + +### Version 1.0.0 + +#### Added + +- Initial version + +#### Changed + +N/A + +#### Fixed + +N/A + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/incubator/signal-cli-rest-api/README_CONFIG.md.gotmpl b/charts/incubator/signal-cli-rest-api/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/incubator/signal-cli-rest-api/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/incubator/signal-cli-rest-api/templates/NOTES.txt b/charts/incubator/signal-cli-rest-api/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/incubator/signal-cli-rest-api/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/incubator/signal-cli-rest-api/templates/common.yaml b/charts/incubator/signal-cli-rest-api/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/incubator/signal-cli-rest-api/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/incubator/signal-cli-rest-api/values.yaml b/charts/incubator/signal-cli-rest-api/values.yaml new file mode 100644 index 00000000..37d2afd4 --- /dev/null +++ b/charts/incubator/signal-cli-rest-api/values.yaml @@ -0,0 +1,50 @@ +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml +# + +image: + # -- image repository + repository: bbernhard/signal-cli-rest-api + # -- image tag + tag: + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [signal-cli-rest-api documentation](https://github.com/bbernhard/signal-cli-rest-api). +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + # -- Set the Execution mode. See https://github.com/bbernhard/signal-cli-rest-api#execution-modes + MODE: native + # -- Set the Auto receive schedule. See https://github.com/bbernhard/signal-cli-rest-api#auto-receive-schedule + # AUTO_RECEIVE_SCHEDULE="0 22 * * *" + # -- Set the config directory for the application. See https://github.com/bbernhard/signal-cli-rest-api#advanced-settings + # SIGNAL_CLI_CONFIG_DIR: "/home/.local/share/signal-cli" + # -- Specifies the uid of the signal-api user inside the docker container. Defaults to 1000 + # SIGNAL_CLI_UID: 1000 + # -- Specifies the gid of the signal-api group inside the docker container. Defaults to 1000 + # SIGNAL_CLI_GID: 1000 +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 8080 + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false + +# -- Configure persistence settings for the chart under this key. +# @default -- See values.yaml +persistence: + config: + enabled: false + mountPath: /home/.local/share/signal-cli