diff --git a/charts/organizr/.helmignore b/charts/organizr/.helmignore new file mode 100644 index 00000000..46fd8996 --- /dev/null +++ b/charts/organizr/.helmignore @@ -0,0 +1,23 @@ +# 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 +# OWNERS file for Kubernetes +OWNERS diff --git a/charts/organizr/Chart.yaml b/charts/organizr/Chart.yaml index 7bc13305..5fbe7378 100644 --- a/charts/organizr/Chart.yaml +++ b/charts/organizr/Chart.yaml @@ -1,9 +1,8 @@ apiVersion: v2 -name: organizr -description: HTPC/Homelab Services Organizer - Written in PHP -type: application -version: 1.0.2 appVersion: latest +description: HTPC/Homelab Services Organizer +name: organizr +version: 2.0.0 keywords: - organizr home: https://github.com/k8s-at-home/charts/tree/master/charts/organizr @@ -12,20 +11,9 @@ sources: - https://github.com/causefx/Organizr - https://hub.docker.com/r/organizr/organizr maintainers: - - name: DirtyCajunRice - email: nick@cajun.pro - url: https://github.com/dirtycajunrice + - name: billimek + email: jeff@billimek.com dependencies: - - name: media-common + - name: common repository: https://k8s-at-home.com/charts/ - version: ^1.0.0 - alias: organizr -annotations: - artifacthub.io/links: | - - name: App Source - url: https://github.com/causefx/Organizr - - name: Default Docker Image - url: https://hub.docker.com/r/organizr/organizr - artifacthub.io/maintainers: | - - name: Nicholas St. Germain - email: nick@cajun.pro + version: ^1.0.4 diff --git a/charts/organizr/OWNERS b/charts/organizr/OWNERS index 2eb39f10..b90909f4 100644 --- a/charts/organizr/OWNERS +++ b/charts/organizr/OWNERS @@ -1,4 +1,4 @@ approvers: -- DirtyCajunRice +- billimek reviewers: -- DirtyCajunRice +- billimek diff --git a/charts/organizr/README.md b/charts/organizr/README.md index 46d0674f..6f2beeff 100644 --- a/charts/organizr/README.md +++ b/charts/organizr/README.md @@ -1,49 +1,52 @@ -# Organizr | HTPC/Homelab Services Organizer - Written in PHP -Umbrella chart that -* Uses [media-common](https://github.com/k8s-at-home/charts/tree/master/charts/media-common) as a base -* Adds docker image information leveraging the [official image](https://hub.docker.com/r/organizr/organizr/) -* Deploys [Organizr](https://github.com/causefx/Organizr) +# Organizr -## TL;DR -```console +This is a helm chart for [Organizr](https://github.com/causefx/Organizr). + +## TL;DR; + +```shell $ helm repo add k8s-at-home https://k8s-at-home.com/charts/ $ helm install k8s-at-home/organizr ``` ## Installing the Chart -To install the chart with the release name `organizr`: + +To install the chart with the release name `my-release`: + ```console -helm install organizr k8s-at-home/organizr +helm install --name my-release k8s-at-home/organizr ``` ## Uninstalling the Chart -To uninstall the `organizr` deployment: + +To uninstall/delete the `my-release` deployment: + ```console -helm uninstall organizr +helm delete my-release --purge ``` + The command removes all the Kubernetes components associated with the chart and deletes the release. ## Configuration -Read through the media-common [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/media-common/values.yaml) +Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/organizr/values.yaml) file. It has several commented out suggested values. +Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console helm install organizr \ - --set organizr.env.TZ="America/New York" \ + --set env.TZ="America/New York" \ k8s-at-home/organizr ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. -For example, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the +chart. For example, ```console helm install organizr k8s-at-home/organizr --values values.yaml ``` -These values will be nested as it is a dependency, for example ```yaml -organizr: - image: - tag: ... +image: + tag: ... ``` --- @@ -56,3 +59,18 @@ Error: rendered manifests contain a resource that already exists. Unable to cont it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. --- + +## Upgrading an existing Release to a new major version + +A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. + +### Upgrading from 1.x.x to 2.x.x + +Due to migrating to a centralized common library some values in `values.yaml` have changed. + +Examples: + +* `service.port` has been moved to `service.port.port`. +* `persistence.type` has been moved to `controllerType`. + +Refer to the library values.yaml for more configuration options. diff --git a/charts/organizr/ci/ct-values.yaml b/charts/organizr/ci/ct-values.yaml new file mode 100644 index 00000000..f6ccc628 --- /dev/null +++ b/charts/organizr/ci/ct-values.yaml @@ -0,0 +1,2 @@ +ingress: + enabled: true diff --git a/charts/organizr/templates/NOTES.txt b/charts/organizr/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/organizr/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/organizr/templates/common.yaml b/charts/organizr/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/organizr/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/organizr/values.yaml b/charts/organizr/values.yaml index 03207b3b..a473592c 100644 --- a/charts/organizr/values.yaml +++ b/charts/organizr/values.yaml @@ -1,10 +1,20 @@ -# Default values for organizr. +# Default values for Organizr. -organizr: - image: - organization: organizr - repository: organizr - pullPolicy: IfNotPresent - tag: latest - service: +image: + repository: organizr/organizr + pullPolicy: Always + tag: latest + +service: + port: port: 80 + +env: {} + # TZ: UTC + # PUID: 1001 + # PGID: 1001 + +persistence: + config: + enabled: true + emptyDir: true