NAS-122861 / 23.10 / add `homarr` to `community` train (#1341)

* add `homarr` to `community` train

* add `homarr` to `community` train

* add templates and values

* Update library/ix-dev/community/homarr/item.yaml

* Update library/ix-dev/community/homarr/Chart.yaml

library/ix-dev/community/homarr/Chart.lock

@@ -0,0 +1,6 @@
+dependencies:
+- name: common
+  repository: file://../../../common
+  version: 1.0.10
+digest: sha256:06709bd6d9a8dbb721eec437a52f8c24aeecefbbc57e6f8617e53b29570d5512
+generated: "2023-07-07T16:19:50.063524071+03:00"

library/ix-dev/community/homarr/Chart.yaml

@@ -0,0 +1,25 @@
+name: homarr
+description: Homarr is a sleek, modern dashboard that puts all of your apps and services at your fingertips.
+annotations:
+  title: Homarr
+type: application
+version: 1.0.0
+apiVersion: v2
+appVersion: '0.12.3'
+kubeVersion: '>=1.16.0-0'
+maintainers:
+  - name: truenas
+    url: https://www.truenas.com/
+    email: dev@ixsystems.com
+dependencies:
+  - name: common
+    repository: file://../../../common
+    version: 1.0.10
+home: https://homarr.dev/
+icon: https://homarr.dev/img/logo.svg
+sources:
+  - https://homarr.dev/
+  - https://github.com/truenas/charts/tree/master/community/homarr
+  - https://github.com/ajnart/homarr
+keywords:
+  - dashboard

library/ix-dev/community/homarr/README.md

@@ -0,0 +1,8 @@
+# Homarr
+
+[Homarr](https://github.com/ajnart/homarr) is a sleek, modern dashboard that puts all of your apps and services at your fingertips.
+
+> When application is installed, a container will be launched with **root** privileges.
+> This is required in order to apply the correct permissions to the `Homarr` directories.
+> Afterward, the `Homarr` container will run as a **non**-root user (Default: `568`).
+> All mounted storage(s) will be `chown`ed only if the parent directory does not match the configured user.

library/ix-dev/community/homarr/app-readme.md

@@ -0,0 +1,8 @@
+# Homarr
+
+[Homarr](https://github.com/ajnart/homarr) is a sleek, modern dashboard that puts all of your apps and services at your fingertips.
+
+> When application is installed, a container will be launched with **root** privileges.
+> This is required in order to apply the correct permissions to the `Homarr` directories.
+> Afterward, the `Homarr` container will run as a **non**-root user (Default: `568`).
+> All mounted storage(s) will be `chown`ed only if the parent directory does not match the configured user.

library/ix-dev/community/homarr/ci/basic-values.yaml

@@ -0,0 +1,14 @@
+homarrNetwork:
+  webPort: 31000
+
+homarrRunAs:
+  user: 1000
+  group: 1000
+
+homarrStorage:
+  configs:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/configs
+  icons:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/icons

library/ix-dev/community/homarr/ci/extra-values.yaml

@@ -0,0 +1,23 @@
+homarrConfig:
+  password: secret
+  additionalEnvs:
+    - name: DISABLE_EDIT_MODE
+      value: true
+
+homarrNetwork:
+  webPort: 31000
+
+homarrStorage:
+  configs:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/configs
+  icons:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/icons
+  additionalStorages:
+  - type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/data1
+    mountPath: /data1
+  - type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/data2
+    mountPath: /data2

library/ix-dev/community/homarr/ci/hostNet-values.yaml

@@ -0,0 +1,11 @@
+homarrNetwork:
+  webPort: 30000
+  hostNetwork: true
+
+homarrStorage:
+  configs:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/configs
+  icons:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/icons

library/ix-dev/community/homarr/item.yaml

@@ -0,0 +1,9 @@
+icon_url: https://homarr.dev/img/logo.svg
+categories:
+  - productivity
+screenshots:
+  - https://homarr.dev/assets/images/add-app-modal-151ae6d1969d242acde705b33d160c0b.webp
+  - https://homarr.dev/assets/images/widgets-select-type-28beaddc83c6aef18f715b034b4f38b6.webp
+  - https://homarr.dev/assets/images/app-integration-d80d859a281f8bef01dbf1e2d7f95b45.webp
+tags:
+  - dashboard

library/ix-dev/community/homarr/metadata.yaml

@@ -0,0 +1,8 @@
+runAsContext:
+  - userName: homarr
+    groupName: homarr
+    gid: 568
+    uid: 568
+    description: Homarr can run as any non-root user.
+capabilities: []
+hostMounts: []

library/ix-dev/community/homarr/questions.yaml

@@ -0,0 +1,288 @@
+groups:
+  - name: Homarr Configuration
+    description: Configure Homarr
+  - name: User and Group Configuration
+    description: Configure User and Group for Homarr
+  - name: Network Configuration
+    description: Configure Network for Homarr
+  - name: Storage Configuration
+    description: Configure Storage for Homarr
+  - name: Resources Configuration
+    description: Configure Resources for Homarr
+
+portals:
+  web_portal:
+    protocols:
+      - "$kubernetes-resource_configmap_portal_protocol"
+    host:
+      - "$kubernetes-resource_configmap_portal_host"
+    ports:
+      - "$kubernetes-resource_configmap_portal_port"
+    path: "$kubernetes-resource_configmap_portal_path"
+
+questions:
+  - variable: TZ
+    group: Homarr Configuration
+    label: Timezone
+    schema:
+      type: string
+      default: Etc/UTC
+      required: true
+      $ref:
+        - definitions/timezone
+
+  - variable: homarrConfig
+    label: ""
+    group: Homarr Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: password
+          label: Password (Optional)
+          description: Password for Homarr.
+          schema:
+            type: string
+            default: ""
+            private: true
+        - variable: additionalEnvs
+          label: Additional Environment Variables
+          description: Configure additional environment variables for Homarr.
+          schema:
+            type: list
+            default: []
+            items:
+              - variable: env
+                label: Environment Variable
+                schema:
+                  type: dict
+                  attrs:
+                    - variable: name
+                      label: Name
+                      schema:
+                        type: string
+                        required: true
+                    - variable: value
+                      label: Value
+                      schema:
+                        type: string
+                        required: true
+
+  - variable: homarrRunAs
+    label: ""
+    group: User and Group Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: user
+          label: User ID
+          description: The user id that Homarr will run as.
+          schema:
+            type: int
+            min: 2
+            default: 568
+            required: true
+        - variable: group
+          label: Group ID
+          description: The group id that Homarr will run as.
+          schema:
+            type: int
+            min: 2
+            default: 568
+            required: true
+
+  - variable: homarrNetwork
+    label: ""
+    group: Network Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: webPort
+          label: Web Port
+          description: The port for the Homarr Web UI.
+          schema:
+            type: int
+            default: 30052
+            min: 9000
+            max: 65535
+            required: true
+        - variable: hostNetwork
+          label: Host Network
+          description: |
+            Bind to the host network. It's recommended to keep this disabled.</br>
+          schema:
+            type: boolean
+            default: false
+
+  - variable: homarrStorage
+    label: ""
+    group: Storage Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: configs
+          label: Homarr Config Storage
+          description: The path to store Homarr Configuration.
+          schema:
+            type: dict
+            attrs:
+              - variable: type
+                label: Type
+                description: |
+                  ixVolume: Is dataset created automatically by the system.</br>
+                  Host Path: Is a path that already exists on the system.
+                schema:
+                  type: string
+                  required: true
+                  default: "ixVolume"
+                  enum:
+                    - value: "hostPath"
+                      description: Host Path (Path that already exists on the system)
+                    - value: "ixVolume"
+                      description: ixVolume (Dataset created automatically by the system)
+              - variable: datasetName
+                label: Dataset Name
+                schema:
+                  type: string
+                  show_if: [["type", "=", "ixVolume"]]
+                  required: true
+                  hidden: true
+                  immutable: true
+                  default: "configs"
+                  $ref:
+                    - "normalize/ixVolume"
+              - variable: hostPath
+                label: Host Path
+                schema:
+                  type: hostpath
+                  show_if: [["type", "=", "hostPath"]]
+                  immutable: true
+                  required: true
+        - variable: icons
+          label: Homarr Icon Storage
+          description: The path to store Homarr Icons.
+          schema:
+            type: dict
+            attrs:
+              - variable: type
+                label: Type
+                description: |
+                  ixVolume: Is dataset created automatically by the system.</br>
+                  Host Path: Is a path that already exists on the system.
+                schema:
+                  type: string
+                  required: true
+                  default: "ixVolume"
+                  enum:
+                    - value: "hostPath"
+                      description: Host Path (Path that already exists on the system)
+                    - value: "ixVolume"
+                      description: ixVolume (Dataset created automatically by the system)
+              - variable: datasetName
+                label: Dataset Name
+                schema:
+                  type: string
+                  show_if: [["type", "=", "ixVolume"]]
+                  required: true
+                  hidden: true
+                  immutable: true
+                  default: "icons"
+                  $ref:
+                    - "normalize/ixVolume"
+              - variable: hostPath
+                label: Host Path
+                schema:
+                  type: hostpath
+                  show_if: [["type", "=", "hostPath"]]
+                  immutable: true
+                  required: true
+        - variable: additionalStorages
+          label: Additional Storage
+          description: Additional storage for Homarr.
+          schema:
+            type: list
+            default: []
+            items:
+              - variable: storageEntry
+                label: Storage Entry
+                schema:
+                  type: dict
+                  attrs:
+                    - variable: type
+                      label: Type
+                      description: |
+                        ixVolume: Is dataset created automatically by the system.</br>
+                        Host Path: Is a path that already exists on the system.
+                      schema:
+                        type: string
+                        required: true
+                        default: "ixVolume"
+                        enum:
+                          - value: "hostPath"
+                            description: Host Path (Path that already exists on the system)
+                          - value: "ixVolume"
+                            description: ixVolume (Dataset created automatically by the system)
+                    - variable: mountPath
+                      label: Mount Path
+                      description: The path inside the container to mount the storage.
+                      schema:
+                        type: path
+                        required: true
+                    - variable: hostPath
+                      label: Host Path
+                      description: The host path to use for storage.
+                      schema:
+                        type: hostpath
+                        show_if: [["type", "=", "hostPath"]]
+                        required: true
+                    - variable: datasetName
+                      label: Dataset Name
+                      description: The name of the dataset to use for storage.
+                      schema:
+                        type: string
+                        show_if: [["type", "=", "ixVolume"]]
+                        required: true
+                        immutable: true
+                        default: "storage_entry"
+                        $ref:
+                          - "normalize/ixVolume"
+
+  - variable: resources
+    group: Resources Configuration
+    label: ""
+    schema:
+      type: dict
+      attrs:
+        - variable: limits
+          label: Limits
+          schema:
+            type: dict
+            attrs:
+              - variable: cpu
+                label: CPU
+                description: CPU limit for Homarr.
+                schema:
+                  type: string
+                  max_length: 6
+                  valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
+                  valid_chars_error: |
+                    Valid CPU limit formats are</br>
+                    - Plain Integer - eg. 1</br>
+                    - Float - eg. 0.5</br>
+                    - Milicpu - eg. 500m
+                  default: "4000m"
+                  required: true
+              - variable: memory
+                label: Memory
+                description: Memory limit for Homarr.
+                schema:
+                  type: string
+                  max_length: 12
+                  valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
+                  valid_chars_error: |
+                    Valid Memory limit formats are</br>
+                    - Suffixed with E/P/T/G/M/K - eg. 1G</br>
+                    - Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
+                    - Plain Integer in bytes - eg. 1024</br>
+                    - Exponent - eg. 134e6
+                  default: "8Gi"
+                  required: true

library/ix-dev/community/homarr/templates/NOTES.txt

@@ -0,0 +1 @@
+{{ include "ix.v1.common.lib.chart.notes" $ }}

library/ix-dev/community/homarr/templates/_homarr.tpl

@@ -0,0 +1,51 @@
+{{- define "homarr.workload" -}}
+workload:
+  homarr:
+    enabled: true
+    primary: true
+    type: Deployment
+    podSpec:
+      hostNetwork: {{ .Values.homarrNetwork.hostNetwork }}
+      containers:
+        homarr:
+          enabled: true
+          primary: true
+          imageSelector: image
+          securityContext:
+            runAsUser: {{ .Values.homarrRunAs.user }}
+            runAsGroup: {{ .Values.homarrRunAs.group }}
+          env:
+            PORT: {{ .Values.homarrNetwork.webPort }}
+            {{ with .Values.homarrConfig.password }}
+            PASSWORD: {{ . }}
+            {{ end }}
+          {{ with .Values.homarrConfig.additionalEnvs }}
+          envList:
+            {{ range $env := . }}
+            - name: {{ $env.name }}
+              value: {{ $env.value }}
+            {{ end }}
+          {{ end }}
+          probes:
+            liveness:
+              enabled: true
+              type: http
+              port: "{{ .Values.homarrNetwork.webPort }}"
+              path: /api/configs
+            readiness:
+              enabled: true
+              type: http
+              port: "{{ .Values.homarrNetwork.webPort }}"
+              path: /api/configs
+            startup:
+              enabled: true
+              type: http
+              port: "{{ .Values.homarrNetwork.webPort }}"
+              path: /api/configs
+      initContainers:
+      {{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions"
+                                                        "UID" .Values.homarrRunAs.user
+                                                        "GID" .Values.homarrRunAs.group
+                                                        "mode" "check"
+                                                        "type" "init") | nindent 8 }}
+{{- end -}}

library/ix-dev/community/homarr/templates/_persistence.tpl

@@ -0,0 +1,45 @@
+{{- define "homarr.persistence" -}}
+persistence:
+  configs:
+    enabled: true
+    type: {{ .Values.homarrStorage.configs.type }}
+    datasetName: {{ .Values.homarrStorage.configs.datasetName | default "" }}
+    hostPath: {{ .Values.homarrStorage.configs.hostPath | default "" }}
+    targetSelector:
+      homarr:
+        homarr:
+          mountPath: /app/data/configs
+        01-permissions:
+          mountPath: /mnt/directories/configs
+  icons:
+    enabled: true
+    type: {{ .Values.homarrStorage.icons.type }}
+    datasetName: {{ .Values.homarrStorage.icons.datasetName | default "" }}
+    hostPath: {{ .Values.homarrStorage.icons.hostPath | default "" }}
+    targetSelector:
+      homarr:
+        homarr:
+          mountPath: /app/data/icons
+        01-permissions:
+          mountPath: /mnt/directories/icons
+  tmp:
+    enabled: true
+    type: emptyDir
+    targetSelector:
+      homarr:
+        homarr:
+          mountPath: /tmp
+  {{- range $idx, $storage := .Values.homarrStorage.additionalStorages }}
+  {{ printf "homarr-%v" (int $idx) }}:
+    enabled: true
+    type: {{ $storage.type }}
+    datasetName: {{ $storage.datasetName | default "" }}
+    hostPath: {{ $storage.hostPath | default "" }}
+    targetSelector:
+      homarr:
+        homarr:
+          mountPath: {{ $storage.mountPath }}
+        01-permissions:
+          mountPath: /mnt/directories{{ $storage.mountPath }}
+  {{- end }}
+{{- end -}}

library/ix-dev/community/homarr/templates/_portal.tpl

@@ -0,0 +1,12 @@
+{{- define "homarr.portal" -}}
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: portal
+data:
+  path: "/"
+  port: {{ .Values.homarrNetwork.webPort | quote }}
+  protocol: http
+  host: $node_ip
+{{- end -}}

library/ix-dev/community/homarr/templates/_service.tpl

@@ -0,0 +1,15 @@
+{{- define "homarr.service" -}}
+service:
+  homarr:
+    enabled: true
+    primary: true
+    type: NodePort
+    targetSelector: homarr
+    ports:
+      webui:
+        enabled: true
+        primary: true
+        port: {{ .Values.homarrNetwork.webPort }}
+        nodePort: {{ .Values.homarrNetwork.webPort }}
+        targetSelector: homarr
+{{- end -}}

library/ix-dev/community/homarr/templates/common.yaml

@@ -0,0 +1,11 @@
+{{- include "ix.v1.common.loader.init" . -}}
+
+{{/* Merge the templates with Values */}}
+{{- $_ := mustMergeOverwrite .Values (include "homarr.workload" $ | fromYaml) -}}
+{{- $_ := mustMergeOverwrite .Values (include "homarr.persistence" $ | fromYaml) -}}
+{{- $_ := mustMergeOverwrite .Values (include "homarr.service" $ | fromYaml) -}}
+
+{{/* Create the configmap for portal manually*/}}
+{{- include "homarr.portal" $ -}}
+
+{{- include "ix.v1.common.loader.apply" . -}}

library/ix-dev/community/homarr/upgrade_info.json

@@ -0,0 +1 @@
+{"filename": "values.yaml", "keys": ["image"]}

library/ix-dev/community/homarr/upgrade_strategy

@@ -0,0 +1,31 @@
+#!/usr/bin/python3
+import json
+import re
+import sys
+
+from catalog_update.upgrade_strategy import semantic_versioning
+
+
+RE_STABLE_VERSION = re.compile(r'\d+\.\d+\.\d+')
+
+
+def newer_mapping(image_tags):
+    key = list(image_tags.keys())[0]
+    tags = {t: t for t in image_tags[key] if RE_STABLE_VERSION.fullmatch(t)}
+    version = semantic_versioning(list(tags))
+    if not version:
+        return {}
+
+    return {
+        'tags': {key: tags[version]},
+        'app_version': version,
+    }
+
+
+if __name__ == '__main__':
+    try:
+        versions_json = json.loads(sys.stdin.read())
+    except ValueError:
+        raise ValueError('Invalid json specified')
+
+    print(json.dumps(newer_mapping(versions_json)))

library/ix-dev/community/homarr/values.yaml

@@ -0,0 +1,30 @@
+image:
+  repository: ghcr.io/ajnart/homarr
+  pullPolicy: IfNotPresent
+  tag: '0.12.3'
+
+resources:
+  limits:
+    cpu: 4000m
+    memory: 8Gi
+
+homarrConfig:
+  password: ''
+  additionalEnvs: []
+
+homarrNetwork:
+  webPort: 30052
+  hostNetwork: false
+
+homarrRunAs:
+  user: 568
+  group: 568
+
+homarrStorage:
+  configs:
+    type: ixVolume
+    datasetName: configs
+  icons:
+    type: ixVolume
+    datasetName: icons
+  additionalStorages: []