From fd6ffb766c42144b5b893ca53d88a27ef30b47b3 Mon Sep 17 00:00:00 2001 From: Brandon Clifford Date: Sun, 14 Aug 2022 20:32:28 -0600 Subject: [PATCH] [photoview] Add new chart for Photoview Signed-off-by: Brandon Clifford --- charts/stable/photoview/.helmignore | 26 ++++ charts/stable/photoview/Chart.yaml | 30 +++++ charts/stable/photoview/README.md | 123 ++++++++++++++++++ .../stable/photoview/README_CONFIG.md.gotmpl | 9 ++ charts/stable/photoview/templates/NOTES.txt | 1 + charts/stable/photoview/templates/common.yaml | 1 + charts/stable/photoview/values.yaml | 83 ++++++++++++ 7 files changed, 273 insertions(+) create mode 100644 charts/stable/photoview/.helmignore create mode 100644 charts/stable/photoview/Chart.yaml create mode 100644 charts/stable/photoview/README.md create mode 100644 charts/stable/photoview/README_CONFIG.md.gotmpl create mode 100644 charts/stable/photoview/templates/NOTES.txt create mode 100644 charts/stable/photoview/templates/common.yaml create mode 100644 charts/stable/photoview/values.yaml diff --git a/charts/stable/photoview/.helmignore b/charts/stable/photoview/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/photoview/.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/photoview/Chart.yaml b/charts/stable/photoview/Chart.yaml new file mode 100644 index 00000000..bc564493 --- /dev/null +++ b/charts/stable/photoview/Chart.yaml @@ -0,0 +1,30 @@ +--- +apiVersion: v2 +appVersion: "2.3" +description: Photoview is a simple and user-friendly photo gallery that's made for photographers and aims to provide an easy and fast way to navigate directories, with thousands of high-resolution photos. +name: photoview +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: + - photos + - photoview + - pictures +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/photoview +icon: https://github.com/photoview/photoview/blob/master/screenshots/photoview-logo.svg +sources: + - https://github.com/photoview/photoview +maintainers: + - name: brandon099 + email: brandon@clifford.sh +dependencies: + - name: common + repository: https://library-charts.k8s-at-home.com + version: 4.5.2 + - name: mariadb + version: 11.0.14 + repository: https://charts.bitnami.com/bitnami + condition: mariadb.enabled +annotations: + artifacthub.io/changes: | + - kind: added + description: Initial version diff --git a/charts/stable/photoview/README.md b/charts/stable/photoview/README.md new file mode 100644 index 00000000..b7136108 --- /dev/null +++ b/charts/stable/photoview/README.md @@ -0,0 +1,123 @@ +# photoview + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 2.3](https://img.shields.io/badge/AppVersion-2.3-informational?style=flat-square) + +Photoview is a simple and user-friendly photo gallery that's made for photographers and aims to provide an easy and fast way to navigate directories, with thousands of high-resolution photos. + +**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 | 11.0.14 | +| https://library-charts.k8s-at-home.com | common | 4.5.2 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install photoview k8s-at-home/photoview +``` + +## Installing the Chart + +To install the chart with the release name `photoview` + +```console +helm install photoview k8s-at-home/photoview +``` + +## Uninstalling the Chart + +To uninstall the `photoview` deployment + +```console +helm uninstall photoview +``` + +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 photoview \ + --set env.TZ="America/New York" \ + k8s-at-home/photoview +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install photoview k8s-at-home/photoview -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 [photoview documentation](https://photoview.org/docs). | +| env.PHOTOVIEW_DATABASE_DRIVER | string | `"sqlite"` | Database Driver; options are "mysql", "postgres", and "sqlite" | +| env.PHOTOVIEW_DISABLE_FACE_RECOGNITION | bool | `false` | Disable Facial Recongition | +| env.PHOTOVIEW_DISABLE_RAW_PROCESSING | bool | `false` | Disable processing of RAW format photos using Darktable-cli | +| env.PHOTOVIEW_DISABLE_VIDEO_ENCODING | bool | `false` | Disable Video encoding via FFMPEG | +| env.PHOTOVIEW_MEDIA_CACHE | string | `"/app/cache"` | Cache directory to store optimized versions of photos for UI | +| env.PHOTOVIEW_MYSQL_URL | string | `"photoview:photoview@tcp(photoview-mariadb)/photoview"` | MySQL database connection string | +| env.PHOTOVIEW_SQLITE_PATH | string | `"/app/photoview.db"` | Sqlite DB path, if using Sqlite as the DB driver | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"viktorstrate/photoview"` | image repository | +| image.tag | string | chart.appVersion | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| mariadb | object | See values.yaml | Enable and configure mariadb database subchart under this key. For more options see [mariadb chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/mariadb) | +| 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 + +### Older versions + +A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/photoview?modal=changelog) + +## 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 v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1) diff --git a/charts/stable/photoview/README_CONFIG.md.gotmpl b/charts/stable/photoview/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/photoview/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/photoview/templates/NOTES.txt b/charts/stable/photoview/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/photoview/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/photoview/templates/common.yaml b/charts/stable/photoview/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/stable/photoview/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/stable/photoview/values.yaml b/charts/stable/photoview/values.yaml new file mode 100644 index 00000000..1feb9781 --- /dev/null +++ b/charts/stable/photoview/values.yaml @@ -0,0 +1,83 @@ +# +# 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: viktorstrate/photoview + # -- image tag + # @default -- chart.appVersion + tag: + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [photoview documentation](https://photoview.org/docs). +# @default -- See below +env: + # -- Database Driver; options are "mysql", "postgres", and "sqlite" + PHOTOVIEW_DATABASE_DRIVER: sqlite + # -- Cache directory to store optimized versions of photos for UI + PHOTOVIEW_MEDIA_CACHE: /app/cache + # -- MySQL database connection string + PHOTOVIEW_MYSQL_URL: photoview:photoview@tcp(photoview-mariadb)/photoview + # -- Sqlite DB path, if using Sqlite as the DB driver + PHOTOVIEW_SQLITE_PATH: /app/photoview.db + # -- Disable Facial Recongition + PHOTOVIEW_DISABLE_FACE_RECOGNITION: false + # -- Disable Video encoding via FFMPEG + PHOTOVIEW_DISABLE_VIDEO_ENCODING: false + # -- Disable processing of RAW format photos using Darktable-cli + PHOTOVIEW_DISABLE_RAW_PROCESSING: false + + # Optional: To enable map related features, you need to create a mapbox token. + # A token can be generated for free here https://account.mapbox.com/access-tokens/ + # It's a good idea to limit the scope of the token to your own domain, to prevent others from using it. + # MAPBOX_TOKEN= + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 80 + +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: + mediaCache: + enabled: false + mountPath: /app/cache + # storageClass: "" + photos: + enabled: false + mountPath: /photos + sqlite: + enabled: false + mountPath: /sqlite + # storageClass: "" + +# -- Enable and configure mariadb database subchart under this key. +# For more options see [mariadb chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/mariadb) +# @default -- See values.yaml +mariadb: + enabled: false + architecture: standalone + auth: + database: photoview + username: photoview + password: photoview + rootPassword: photoview + primary: + persistence: + enabled: false + # storageClass: ""