mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-23 23:49:12 +00:00
[signalclirestapi] Add incubator chart signal-cli-rest-api (#1449)
* [signalclirestapi] New incubator chart for signal-cli-rest-api Signed-off-by: Tamas Varga <tamas@varga.lu> * [signalclirestapi] Update README.md with signal-cli-rest-api specific env variable Signed-off-by: Tamas Varga <tamas@varga.lu> * [signalclirestapi] Fix appversion and version. Remove image.tag from values.yaml Signed-off-by: Tamas Varga <tamas@varga.lu> * [signalclirestapi] Add image.tag to values.yaml, but leave it empty as it will default to appVersion Signed-off-by: Tamas Varga <tamas@varga.lu> Co-authored-by: Devin Buhl <onedr0p@users.noreply.github.com>
This commit is contained in:
parent
dddd47c090
commit
a389c0ed86
26
charts/incubator/signal-cli-rest-api/.helmignore
Normal file
26
charts/incubator/signal-cli-rest-api/.helmignore
Normal file
@ -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
|
25
charts/incubator/signal-cli-rest-api/Chart.yaml
Normal file
25
charts/incubator/signal-cli-rest-api/Chart.yaml
Normal file
@ -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
|
116
charts/incubator/signal-cli-rest-api/README.md
Normal file
116
charts/incubator/signal-cli-rest-api/README.md
Normal file
@ -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
|
||||||
|
|
||||||
|
* <https://github.com/signal-cli-rest-api/signal-cli-rest-api-docker>
|
||||||
|
|
||||||
|
## 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)
|
@ -0,0 +1,9 @@
|
|||||||
|
{{- define "custom.custom.configuration.header" -}}
|
||||||
|
## Custom configuration
|
||||||
|
{{- end -}}
|
||||||
|
|
||||||
|
{{- define "custom.custom.configuration" -}}
|
||||||
|
{{ template "custom.custom.configuration.header" . }}
|
||||||
|
|
||||||
|
N/A
|
||||||
|
{{- end -}}
|
1
charts/incubator/signal-cli-rest-api/templates/NOTES.txt
Normal file
1
charts/incubator/signal-cli-rest-api/templates/NOTES.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
{{- include "common.notes.defaultNotes" . -}}
|
@ -0,0 +1 @@
|
|||||||
|
{{ include "common.all" . }}
|
50
charts/incubator/signal-cli-rest-api/values.yaml
Normal file
50
charts/incubator/signal-cli-rest-api/values.yaml
Normal file
@ -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
|
Loading…
Reference in New Issue
Block a user