From c8f75feb1dff4496cc73a8f7b287c52cc880dade Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?n=CE=B9c=D0=BDola=D1=95=20w=CE=B9lde?= Date: Thu, 22 Apr 2021 10:23:30 -0700 Subject: [PATCH] [bookstack] New chart (#817) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add bookstack Signed-off-by: Nicholas Wilde * Changed version to 0.1.0 Signed-off-by: Nicholas Wilde * Update README.md * - Moved to stable - Uncommented persistance - Added commented DB env variables. - Changed tag to version-v21.04.2 Signed-off-by: Nicholas Wilde Co-authored-by: ᗪєνιη ᗷυнʟ --- charts/stable/bookstack/.helmignore | 26 ++++ charts/stable/bookstack/Chart.yaml | 30 ++++ charts/stable/bookstack/README.md | 117 ++++++++++++++ charts/stable/bookstack/README.md.gotmpl | 145 ++++++++++++++++++ .../bookstack/README_CHANGELOG.md.gotmpl | 27 ++++ .../stable/bookstack/README_CONFIG.md.gotmpl | 9 ++ charts/stable/bookstack/templates/NOTES.txt | 1 + charts/stable/bookstack/templates/common.yaml | 1 + charts/stable/bookstack/values.yaml | 50 ++++++ 9 files changed, 406 insertions(+) create mode 100644 charts/stable/bookstack/.helmignore create mode 100644 charts/stable/bookstack/Chart.yaml create mode 100644 charts/stable/bookstack/README.md create mode 100644 charts/stable/bookstack/README.md.gotmpl create mode 100644 charts/stable/bookstack/README_CHANGELOG.md.gotmpl create mode 100644 charts/stable/bookstack/README_CONFIG.md.gotmpl create mode 100644 charts/stable/bookstack/templates/NOTES.txt create mode 100644 charts/stable/bookstack/templates/common.yaml create mode 100644 charts/stable/bookstack/values.yaml diff --git a/charts/stable/bookstack/.helmignore b/charts/stable/bookstack/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/bookstack/.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/stable/bookstack/Chart.yaml b/charts/stable/bookstack/Chart.yaml new file mode 100644 index 00000000..2dc50337 --- /dev/null +++ b/charts/stable/bookstack/Chart.yaml @@ -0,0 +1,30 @@ +--- +apiVersion: v2 +appVersion: v21.04.2 +description: A simple, self-hosted, easy-to-use platform for organising and storing information. +name: bookstack +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: + - bookstack + - book + - stack + - organizer + - server + - hosted +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/bookstack +icon: https://avatars3.githubusercontent.com/u/20912696?s=400&v=4?sanitize=true +sources: + - https://www.bookstackapp.com/ + - https://hub.docker.com/r/linuxserver/bookstack +maintainers: + - name: nicholaswilde + email: ncwilde43@gmail.com +dependencies: + - name: common + repository: https://library-charts.k8s-at-home.com + version: 2.3.1 + - name: mariadb + version: 9.3.7 + repository: https://charts.bitnami.com/bitnami + condition: mariadb.enabled diff --git a/charts/stable/bookstack/README.md b/charts/stable/bookstack/README.md new file mode 100644 index 00000000..87719f21 --- /dev/null +++ b/charts/stable/bookstack/README.md @@ -0,0 +1,117 @@ +# bookstack + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: v21.04.2](https://img.shields.io/badge/AppVersion-v21.04.2-informational?style=flat-square) + +A simple, self-hosted, easy-to-use platform for organising and storing information. + +**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://charts.bitnami.com/bitnami | mariadb | 9.3.7 | +| https://library-charts.k8s-at-home.com | common | 2.3.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install bookstack k8s-at-home/bookstack +``` + +## Installing the Chart + +To install the chart with the release name `bookstack` + +```console +helm install bookstack k8s-at-home/bookstack +``` + +## Uninstalling the Chart + +To uninstall the `bookstack` deployment + +```console +helm uninstall bookstack +``` + +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 bookstack \ + --set env.TZ="America/New York" \ + k8s-at-home/bookstack +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install bookstack k8s-at-home/bookstack -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 | `"ghcr.io/linuxserver/bookstack"` | | +| image.tag | string | `"version-v21.04.2"` | | +| ingress.enabled | bool | `false` | | +| mariadb.architecture | string | `"standalone"` | | +| mariadb.auth.database | string | `"bookstack"` | | +| mariadb.auth.password | string | `"bookstack"` | | +| mariadb.auth.username | string | `"bookstack"` | | +| mariadb.enabled | bool | `false` | | +| mariadb.primary.persistence.enabled | bool | `false` | | +| persistence.config.emptyDir.enabled | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.config.mountPath | string | `"/config"` | | +| service.port.port | int | `80` | | +| 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 + +## 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/stable/bookstack/README.md.gotmpl b/charts/stable/bookstack/README.md.gotmpl new file mode 100644 index 00000000..c21f99b3 --- /dev/null +++ b/charts/stable/bookstack/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- 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" . }} diff --git a/charts/stable/bookstack/README_CHANGELOG.md.gotmpl b/charts/stable/bookstack/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..99c5085f --- /dev/null +++ b/charts/stable/bookstack/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- 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 + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/stable/bookstack/README_CONFIG.md.gotmpl b/charts/stable/bookstack/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/bookstack/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/stable/bookstack/templates/NOTES.txt b/charts/stable/bookstack/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/bookstack/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/bookstack/templates/common.yaml b/charts/stable/bookstack/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/stable/bookstack/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/stable/bookstack/values.yaml b/charts/stable/bookstack/values.yaml new file mode 100644 index 00000000..fe48a734 --- /dev/null +++ b/charts/stable/bookstack/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: + repository: ghcr.io/linuxserver/bookstack + pullPolicy: IfNotPresent + tag: version-v21.04.2 + +strategy: + type: Recreate + +# See more environment variables in the bookstack documentation +# https://hub.docker.com/r/linuxserver/bookstack +env: {} + # TZ: + # DB_HOST: + # DB_USER: + # DB_PASS: + # DB_DATABASE: + +service: + port: + port: 80 + +ingress: + enabled: false + +persistence: + config: + enabled: false + emptyDir: + enabled: false + mountPath: /config + +# Enabled mariadb +# ... for more options see https://github.com/bitnami/charts/tree/master/bitnami/mariadb +mariadb: + enabled: false + architecture: standalone + auth: + database: bookstack + username: bookstack + password: bookstack + primary: + persistence: + enabled: false