Compare commits

...

2 Commits

Author SHA1 Message Date
nιcнolaѕ wιlde
b842379fef Add shlink chart (#908)
Signed-off-by: Nicholas Wilde <ncwilde43@gmail.com>

Co-authored-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev>
2021-05-11 14:54:29 +02:00
nιcнolaѕ wιlde
8b92339f42 Added incomplete-pr workflow (#907)
Signed-off-by: Nicholas Wilde <ncwilde43@gmail.com>
2021-05-11 14:19:45 +02:00
10 changed files with 444 additions and 0 deletions

20
.github/workflows/incomplete-pr.yaml vendored Normal file
View File

@@ -0,0 +1,20 @@
---
name: 'Incomplete PR'
on:
issues:
types: [labeled, unlabeled, reopened]
jobs:
support:
runs-on: ubuntu-20.04
steps:
- uses: dessant/support-requests@v2
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
support-label: 'kind:incomplete-pr'
issue-comment: >
:wave: @{issue-author}, thanks for taking the time to submit this PR. 🙏🏽 Would you mind updating the `version` in `Chart.yaml` per [semver](http://semver.org/) and then update `README_CHANGELOG.md.gotmpl` and run `./hack/gen-helm-docs.sh stable <chart>` again?
close-issue: false
lock-issue: false

View 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

View File

@@ -0,0 +1,28 @@
apiVersion: v2
appVersion: 2.6.2
description: A self-hosted and PHP-based URL shortener application with CLI and REST interfaces
name: shlink
version: 1.0.0
kubeVersion: ">=1.16.0-0"
keywords:
- shlink
- url-shortener
home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/shlink
icon: https://avatars.githubusercontent.com/u/20341790?s=200&v=4
sources:
- https://github.com/shlinkio/shlink
maintainers:
- name: nicholaswilde
email: ncwilde43@gmail.com
dependencies:
- name: common
repository: https://library-charts.k8s-at-home.com
version: 2.5.0
- name: postgresql
version: 10.4.0
repository: https://charts.bitnami.com/bitnami
condition: postgresql.enabled
- name: mariadb
version: 9.3.9
repository: https://charts.bitnami.com/bitnami
condition: mariadb.enabled

View File

@@ -0,0 +1,128 @@
# shlink
![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 2.6.2](https://img.shields.io/badge/AppVersion-2.6.2-informational?style=flat-square)
A self-hosted and PHP-based URL shortener application with CLI and REST interfaces
**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/shlinkio/shlink>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://charts.bitnami.com/bitnami | mariadb | 9.3.9 |
| https://charts.bitnami.com/bitnami | postgresql | 10.4.0 |
| https://library-charts.k8s-at-home.com | common | 2.5.0 |
## TL;DR
```console
helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install shlink k8s-at-home/shlink
```
## Installing the Chart
To install the chart with the release name `shlink`
```console
helm install shlink k8s-at-home/shlink
```
## Uninstalling the Chart
To uninstall the `shlink` deployment
```console
helm uninstall shlink
```
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 shlink \
--set env.TZ="America/New York" \
k8s-at-home/shlink
```
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
helm install shlink k8s-at-home/shlink -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 | `{}` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"shlinkio/shlink"` | |
| image.tag | string | `"2.6.2"` | |
| ingress.enabled | bool | `false` | |
| mariadb.architecture | string | `"standalone"` | |
| mariadb.auth.database | string | `"shlink"` | |
| mariadb.auth.password | string | `"shlink-pass"` | |
| mariadb.auth.rootPassword | string | `"shlinkrootpass"` | |
| mariadb.auth.username | string | `"shlink"` | |
| mariadb.enabled | bool | `false` | |
| mariadb.primary.persistence.enabled | bool | `false` | |
| persistence.data.emptyDir.enabled | bool | `false` | |
| persistence.data.enabled | bool | `false` | |
| persistence.data.mountPath | string | `"/etc/shlink/data"` | |
| persistence.params.emptyDir.enabled | bool | `false` | |
| persistence.params.enabled | bool | `false` | |
| persistence.params.mountPath | string | `"/etc/shlink/config/params"` | |
| postgresql.enabled | bool | `false` | |
| postgresql.persistence.enabled | bool | `false` | |
| postgresql.postgresqlDatabase | string | `"shlink"` | |
| postgresql.postgresqlPassword | string | `"shlink-pass"` | |
| postgresql.postgresqlUsername | string | `"shlink"` | |
| service.port.port | int | `8080` | |
| strategy.type | string | `"Recreate"` | |
## Changelog
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog).
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
### [1.0.0]
#### Added
- Initial version
[1.0.0]: #100
## 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)

View File

@@ -0,0 +1,146 @@
{{- define "custom.repository.organization" -}}
k8s-at-home
{{- end -}}
{{- define "custom.repository.url" -}}
https://github.com/k8s-at-home/charts
{{- end -}}
{{- define "custom.helm.url" -}}
https://k8s-at-home.com/charts/
{{- end -}}
{{- define "custom.helm.path" -}}
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
{{- end -}}
{{- define "custom.notes" -}}
**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)**
{{- end -}}
{{- define "custom.requirements" -}}
## Requirements
{{ template "chart.kubeVersionLine" . }}
{{- end -}}
{{- define "custom.dependencies" -}}
## Dependencies
{{ template "chart.requirementsTable" . }}
{{- end -}}
{{- define "custom.install.tldr" -}}
## TL;DR
```console
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
helm repo update
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
```
{{- end -}}
{{- define "custom.install" -}}
## Installing the Chart
To install the chart with the release name `{{ template "chart.name" . }}`
```console
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
```
{{- end -}}
{{- define "custom.uninstall" -}}
## Uninstalling the Chart
To uninstall the `{{ template "chart.name" . }}` deployment
```console
helm uninstall {{ template "chart.name" . }}
```
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
{{- end -}}
{{- define "custom.configuration.header" -}}
## Configuration
{{- end -}}
{{- define "custom.configuration.readValues" -}}
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).
{{- end -}}
{{- define "custom.configuration.example.set" -}}
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
```console
helm install {{ template "chart.name" . }} \
--set env.TZ="America/New York" \
{{ template "custom.helm.path" . }}
```
{{- end -}}
{{- define "custom.configuration.example.file" -}}
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
```
{{- end -}}
{{- define "custom.valuesSection" -}}
## 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)
{{ template "chart.valuesTable" . }}
{{- end -}}
{{- define "custom.support" -}}
## 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
{{- end -}}
{{ template "chart.header" . }}
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
{{ template "chart.description" . }}
{{ template "custom.notes" . }}
{{ template "chart.sourcesSection" . }}
{{ template "custom.requirements" . }}
{{ template "custom.dependencies" . }}
{{ template "custom.install.tldr" . }}
{{ template "custom.install" . }}
{{ template "custom.uninstall" . }}
{{ template "custom.configuration.header" . }}
{{ template "custom.configuration.readValues" . }}
{{ template "custom.configuration.example.set" . }}
{{ template "custom.configuration.example.file" . }}
{{ template "custom.custom.configuration" . }}
{{ template "custom.valuesSection" . }}
{{ template "custom.changelog" . }}
{{ template "custom.support" . }}
{{ template "helm-docs.versionFooter" . }}
{{ "" }}

View File

@@ -0,0 +1,19 @@
{{- define "custom.changelog.header" -}}
## Changelog
{{- end -}}
{{- define "custom.changelog" -}}
{{ template "custom.changelog.header" . }}
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog).
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
### [1.0.0]
#### Added
- Initial version
[1.0.0]: #100
{{- end -}}

View File

@@ -0,0 +1,9 @@
{{- define "custom.custom.configuration.header" -}}
## Custom configuration
{{- end -}}
{{- define "custom.custom.configuration" -}}
{{ template "custom.custom.configuration.header" . }}
N/A
{{- end -}}

View File

@@ -0,0 +1 @@
{{- include "common.notes.defaultNotes" . -}}

View File

@@ -0,0 +1 @@
{{ include "common.all" . }}

View File

@@ -0,0 +1,66 @@
#
# 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:
repository: shlinkio/shlink
pullPolicy: IfNotPresent
tag: 2.6.2
strategy:
type: Recreate
# See more environment variables in the shlink documentation
# https://shlink.io/documentation/install-docker-image/
env: {}
# SHORT_DOMAIN_HOST: "doma.in"
# SHORT_DOMAIN_SCHEMA: "https"
# GEOLITE_LICENSE_KEY: "kjh23ljkbndskj345"
service:
port:
port: 8080
ingress:
enabled: false
persistence:
params:
enabled: false
emptyDir:
enabled: false
mountPath: /etc/shlink/config/params
data:
enabled: false
emptyDir:
enabled: false
mountPath: /etc/shlink/data
# Enabled mariadb
# ... for more options see https://github.com/bitnami/charts/tree/master/bitnami/mariadb
mariadb:
enabled: false
architecture: standalone
auth:
database: shlink
username: shlink
password: shlink-pass
rootPassword: shlinkrootpass
primary:
persistence:
enabled: false
# storageClass: ""
# Enabled postgres
# ... for more options see https://github.com/bitnami/charts/tree/master/bitnami/postgresql
postgresql:
enabled: false
postgresqlUsername: shlink
postgresqlPassword: shlink-pass
postgresqlDatabase: shlink
persistence:
enabled: false
# storageClass: ""