diff --git a/charts/stable/ghost/Chart.yaml b/charts/stable/ghost/Chart.yaml new file mode 100644 index 00000000..4bfb1c38 --- /dev/null +++ b/charts/stable/ghost/Chart.yaml @@ -0,0 +1,25 @@ +apiVersion: v2 +appVersion: 4.27.2 +description: Ghost is a blogging and publishing software +name: ghost +version: 1.0.0 +kubeVersion: ">=1.19.0-0" +keywords: +- ghost +- blogging +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/ghost +icon: https://ghost.org/images/logos/logo-black-1.png +sources: +- https://github.com/TryGhost/Ghost +- https://github.com/TryGhost/Ghost-CLI +maintainers: +- name: samip5 + email: sm+k8s-at-home+git@samip.fi +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 4.2.0 +- name: mariadb + version: 10.1.0 + repository: https://charts.bitnami.com/bitnami + condition: mariadb.enabled diff --git a/charts/stable/ghost/README.md b/charts/stable/ghost/README.md new file mode 100644 index 00000000..6bb9b753 --- /dev/null +++ b/charts/stable/ghost/README.md @@ -0,0 +1,131 @@ +# ghost + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 4.27.2](https://img.shields.io/badge/AppVersion-4.27.2-informational?style=flat-square) + +Ghost is a blogging and publishing software + +**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.19.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | mariadb | 10.1.0 | +| https://library-charts.k8s-at-home.com | common | 4.2.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install ghost k8s-at-home/ghost +``` + +## Installing the Chart + +To install the chart with the release name `ghost` + +```console +helm install ghost k8s-at-home/ghost +``` + +## Uninstalling the Chart + +To uninstall the `ghost` deployment + +```console +helm uninstall ghost +``` + +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 ghost \ + --set env.TZ="America/New York" \ + k8s-at-home/ghost +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install ghost k8s-at-home/ghost -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.NODE_ENV | string | `"production"` | | +| env.database__client | string | `"mysql"` | | +| env.database__connection__database | string | `"ghost"` | | +| env.database__connection__host | string | `"mariadb"` | | +| env.database__connection__password | string | `"ghost"` | | +| env.database__connection__user | string | `"ghost"` | | +| env.url | string | `"http://some-ghost.example.com"` | | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"ghost"` | image repository | +| image.tag | string | `"4.27.2"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| mariadb.architecture | string | `"standalone"` | | +| mariadb.auth.database | string | `"ghost"` | | +| mariadb.auth.password | string | `"ghost"` | | +| mariadb.auth.rootPassword | string | `"ghost-rootpass"` | | +| mariadb.auth.username | string | `"ghost"` | | +| mariadb.enabled | bool | `false` | | +| mariadb.primary.persistance.enabled | bool | `false` | | +| 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 + +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]: #1309 + +## 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/ghost/README.md.gotmpl b/charts/stable/ghost/README.md.gotmpl new file mode 100644 index 00000000..358abe31 --- /dev/null +++ b/charts/stable/ghost/README.md.gotmpl @@ -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" . }} +{{ "" }} diff --git a/charts/stable/ghost/README_CHANGELOG.md.gotmpl b/charts/stable/ghost/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..6159fc7c --- /dev/null +++ b/charts/stable/ghost/README_CHANGELOG.md.gotmpl @@ -0,0 +1,28 @@ + +{{- 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]: #1309 +{{- end -}} diff --git a/charts/stable/ghost/README_CONFIG.md.gotmpl b/charts/stable/ghost/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/ghost/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/ghost/ci/ct-values.yaml b/charts/stable/ghost/ci/ct-values.yaml new file mode 100644 index 00000000..5c573b50 --- /dev/null +++ b/charts/stable/ghost/ci/ct-values.yaml @@ -0,0 +1,13 @@ +env: + url: "http://ghost.k8s-at-home.com" + database__connection__host: ghost-mariadb + +ingress: + main: + enabled: true + +fullnameOverride: ghost + +mariadb: + enabled: true + fullnameOverride: ghost-mariadb diff --git a/charts/stable/ghost/templates/NOTES.txt b/charts/stable/ghost/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/ghost/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/ghost/templates/common.yaml b/charts/stable/ghost/templates/common.yaml new file mode 100644 index 00000000..314a1995 --- /dev/null +++ b/charts/stable/ghost/templates/common.yaml @@ -0,0 +1,17 @@ +{{/* Make sure all variables are set properly */}} +{{- include "common.values.setup" . }} + +{{/* Append the hardcoded settings */}} +{{- define "ghost.hardcodedValues" -}} + +persistence: + {{- if not .Values.persistence.content.enabled }} + content: + enabled: "true" + type: "emptyDir" + {{- end }} +{{- end -}} +{{- $_ := mergeOverwrite .Values (include "ghost.hardcodedValues" . | fromYaml) -}} + +{{/* Render the templates */}} +{{ include "common.all" . }} diff --git a/charts/stable/ghost/values.yaml b/charts/stable/ghost/values.yaml new file mode 100644 index 00000000..fa9a08ef --- /dev/null +++ b/charts/stable/ghost/values.yaml @@ -0,0 +1,57 @@ +# +# 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: ghost + # -- image tag + tag: 4.27.2 + # -- image pull policy + pullPolicy: IfNotPresent + +# See https://ghost.org/docs/config/#running-ghost-with-config-env-variables +env: + url: "http://some-ghost.example.com" + database__client: mysql + database__connection__host: mariadb + database__connection__user: ghost + database__connection__password: ghost + database__connection__database: ghost + NODE_ENV: production + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 2368 + +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: + content: + enabled: false + mountPath: /var/lib/ghost/content + +mariadb: + enabled: false + architecture: standalone + auth: + database: ghost + username: ghost + password: ghost + rootPassword: ghost-rootpass + primary: + persistance: + enabled: false