Skip to content

Commit

Permalink
Merge pull request #21 from geek-cookbook/add-webhook-receiver
Browse files Browse the repository at this point in the history
  • Loading branch information
funkypenguin authored Jun 11, 2023
2 parents ac94bcf + d198f69 commit 9e557a6
Show file tree
Hide file tree
Showing 8 changed files with 259 additions and 0 deletions.
26 changes: 26 additions & 0 deletions charts/stable/webhook-receiver/.helmignore
Original file line number Diff line number Diff line change
@@ -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
28 changes: 28 additions & 0 deletions charts/stable/webhook-receiver/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
apiVersion: v2
appVersion: 2.8.1
description: webhook-receiver monitors IRC announce channels to get releases as soon as they are available with good filtering
name: webhook-receiver
version: 0.0.1
kubeVersion: ">=1.16.0-0"
keywords:
- webhook-receiver
- torrrent
home: https://github.com/geek-cookbook/charts/tree/master/charts/stable/webhook-receiver
icon: https://avatars.githubusercontent.com/u/88781313?s=200&v=4
sources:
- https://github.com/webhook-receiver/webhook-receiver
- https://github.com/geek-cookbook/container-images
maintainers:
- name: funkypenguin
email: [email protected]
dependencies:
- name: common
repository: https://library-charts.k8s-at-home.com
version: 4.5.2
annotations:
artifacthub.io/changes: |-
- kind: changed
description: Updated appVersion to v1.10.0
- kind: changed
description: Upgraded `common` chart dependency to version 4.5.2
117 changes: 117 additions & 0 deletions charts/stable/webhook-receiver/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# webhook-receiver

![Version: 1.1.2](https://img.shields.io/badge/Version-1.1.2-informational?style=flat-square) ![AppVersion: v0.23.0](https://img.shields.io/badge/AppVersion-v0.23.0-informational?style=flat-square)

webhook-receiver monitors IRC announce channels to get releases as soon as they are available with good filtering

**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/geek-cookbook/charts/issues/new/choose)**

## Source Code

* <https://github.com/webhook-receiver/webhook-receiver>
* <https://github.com/geek-cookbook/container-images>

## Requirements

Kubernetes: `>=1.16.0-0`

## Dependencies

| Repository | Name | Version |
|------------|------|---------|
| https://library-charts.k8s-at-home.com | common | 4.5.2 |

## TL;DR

```console
helm repo add geek-cookbook https://geek-cookbook.github.io/charts/
helm repo update
helm install webhook-receiver geek-cookbook/webhook-receiver
```

## Installing the Chart

To install the chart with the release name `webhook-receiver`

```console
helm install webhook-receiver geek-cookbook/webhook-receiver
```

## Uninstalling the Chart

To uninstall the `webhook-receiver` deployment

```console
helm uninstall webhook-receiver
```

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/geek-cookbook/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/geek-cookbook/library-charts/tree/main/charts/stable/common).

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.

```console
helm install webhook-receiver \
--set env.TZ="America/New York" \
geek-cookbook/webhook-receiver
```

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

```console
helm install webhook-receiver geek-cookbook/webhook-receiver -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/geek-cookbook/library-charts/tree/main/charts/stable/common)

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config | string | `"# config.toml\n\n# Hostname / IP\n#\n# Default: \"localhost\"\n#\nhost = \"0.0.0.0\"\n\n# Port\n#\n# Default: 7474\n#\nport = 7474\n\n# Base url\n# Set custom baseUrl eg /webhook-receiver/ to serve in subdirectory.\n# Not needed for subdomain, or by accessing with the :port directly.\n#\n# Optional\n#\n#baseUrl = \"/webhook-receiver/\"\n\n# webhook-receiver logs file\n# If not defined, logs to stdout\n#\n# Optional\n#\n#logPath = \"log/webhook-receiver.log\"\n\n# Log level\n#\n# Default: \"DEBUG\"\n#\n# Options: \"ERROR\", \"DEBUG\", \"INFO\", \"WARN\"\n#\nlogLevel = \"INFO\"\n\n# Session secret\n#\nsessionSecret = \"secret-session-key\"\n\n# Custom definitions\n#\n#customDefinitions = \"test/definitions\"\n"` | |
| env | object | See below | environment variables. See [image docs](https://docs.geek-cookbook.com/our-container-images/configuration/) for more details. |
| env.TZ | string | `"UTC"` | Set the container timezone |
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
| image.repository | string | `"ghcr.io/webhook-receiver/webhook-receiver"` | image repository |
| image.tag | string | `nil` | |
| 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.1.2

#### Added

N/A

#### Changed

* Upgraded `common` chart dependency to version 4.5.2

#### Fixed

N/A

### Older versions

A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/geek-cookbook/webhook-receiver?modal=changelog)

## Support

- See the [Docs](https://geek-cookbook.funkypenguin.co.nz/)
- Open an [issue](https://github.com/geek-cookbook/charts/issues/new/choose)
- Ask a [question](https://github.com/geek-cookbook/organization/discussions)
- Join our [Discord](http://chat.funkypenguin.co.nz) community

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/geek-cookbook/helm-docs/releases/v0.1.1)
9 changes: 9 additions & 0 deletions charts/stable/webhook-receiver/README_CONFIG.md.gotmpl
Original file line number Diff line number Diff line change
@@ -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 change: 1 addition & 0 deletions charts/stable/webhook-receiver/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{- include "common.notes.defaultNotes" . -}}
19 changes: 19 additions & 0 deletions charts/stable/webhook-receiver/templates/common.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{{/* Make sure all variables are set properly */}}
{{- include "common.values.setup" . }}

{{/* Append the hardcoded settings */}}
{{- define "webhook-receiver.harcodedValues" -}}
persistence:
webhook-receiver-config:
enabled: true
mountPath: "/etc/webhooks/hooks.yaml"
subPath: "hooks.yaml"
type: "custom"
volumeSpec:
configMap:
name: {{ include "common.names.fullname" . }}-config
{{- end -}}
{{- $_ := mergeOverwrite .Values (include "webhook-receiver.harcodedValues" . | fromYaml) -}}

{{/* Render the templates */}}
{{ include "common.all" . }}
11 changes: 11 additions & 0 deletions charts/stable/webhook-receiver/templates/configmap.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{{- include "common.values.setup" . -}}
---
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ include "common.names.fullname" . }}-config
labels:
{{- include "common.labels" . | nindent 4 }}
data:
hooks.yaml: |
{{- .Values.config | nindent 4 }}
48 changes: 48 additions & 0 deletions charts/stable/webhook-receiver/values.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#
# IMPORTANT NOTE
#
# This chart inherits from our common library chart. You can check the default values/options here:
# https://github.com/geek-cookbook/library-charts/tree/main/charts/stable/common/values.yaml
#

image:
# -- image repository
repository: ghcr.io/geek-cookbook/webhook-receiver
# @default -- chart.appVersion
tag:
# -- image pull policy
pullPolicy: IfNotPresent

# -- environment variables. See [image docs](https://docs.geek-cookbook.com/our-container-images/configuration/) for more details.
# @default -- See below
env:
# -- Set the container timezone
TZ: UTC

# See https://raw.githubusercontent.com/webhook-receiver/webhook-receiver/develop/config.toml
config: |
id: date
execute-command: /usr/bin/date
response-message: Online
include-command-output-in-response: true
# -- Configures service settings for the chart.
# @default -- See values.yaml
service:
main:
ports:
http:
port: 9000

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

0 comments on commit 9e557a6

Please sign in to comment.