NAS-123063 / 23.10 / Add homepage to community train (#1378)

* add `homepage` to `community` train

* add templates and UI

* update icon

* remove unused values

* fix metadata

* also fix readme's

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

@@ -0,0 +1,6 @@
+dependencies:
+- name: common
+  repository: file://../../../common
+  version: 1.0.12
+digest: sha256:debd30721d09ae8293b1cbdd9d0115981d40b47908be3035fc3cf657c9d5eedb
+generated: "2023-07-17T18:24:32.256341435+03:00"

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

@@ -0,0 +1,25 @@
+name: homepage
+description: Homepage is a modern, secure, highly customizable application dashboard.
+annotations:
+  title: Homepage
+type: application
+version: 1.0.0
+apiVersion: v2
+appVersion: 0.6.21
+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.12
+home: https://gethomepage.dev/
+icon: https://gethomepage.dev/favicon.svg
+sources:
+  - https://gethomepage.dev/
+  - https://github.com/truenas/charts/tree/master/community/homepage
+  - https://github.com/benphelps/homepage
+keywords:
+  - dashboard

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

@@ -0,0 +1,8 @@
+# Homepage
+
+[Homepage](https://github.com/benphelps/homepage) is a modern, secure, highly customizable application dashboard.
+
+> When application is installed, a container will be launched with **root** privileges.
+> This is required in order to apply the correct permissions to the `Homepage` directories.
+> Afterward, the `Homepage` container will run as a **non**-root user (`1000`).
+> All mounted storage(s) will be `chown`ed only if the parent directory does not match the configured user.

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

@@ -0,0 +1,8 @@
+# Homepage
+
+[Homepage](https://github.com/benphelps/homepage) is a modern, secure, highly customizable application dashboard.
+
+> When application is installed, a container will be launched with **root** privileges.
+> This is required in order to apply the correct permissions to the `Homepage` directories.
+> Afterward, the `Homepage` container will run as a **non**-root user (`1000`).
+> All mounted storage(s) will be `chown`ed only if the parent directory does not match the configured user.

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

@@ -0,0 +1,7 @@
+homepageNetwork:
+  webPort: 31000
+
+homepageStorage:
+  config:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/config

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

@@ -0,0 +1,21 @@
+homepageConfig:
+  additionalEnvs:
+    - name: HOMEPAGE_VAR_SOMETHING
+      value: some-value
+    - name: HOMEPAGE_FILE_SOMETHING
+      value: /some/path
+
+homepageNetwork:
+  webPort: 31000
+
+homepageStorage:
+  config:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/config
+  additionalStorages:
+  - type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/data1
+    mountPath: /data1
+  - type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/data2
+    mountPath: /data2

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

@@ -0,0 +1,8 @@
+homepageNetwork:
+  webPort: 30000
+  hostNetwork: true
+
+homepageStorage:
+  config:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/config

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

@@ -0,0 +1,12 @@
+icon_url: https://gethomepage.dev/favicon.svg
+categories:
+  - productivity
+screenshots:
+  - https://github.com/benphelps/homepage/blob/main/images/1.png
+  - https://github.com/benphelps/homepage/blob/main/images/2.png
+  - https://github.com/benphelps/homepage/blob/main/images/3.png
+  - https://github.com/benphelps/homepage/blob/main/images/4.png
+  - https://github.com/benphelps/homepage/blob/main/images/5.png
+  - https://github.com/benphelps/homepage/blob/main/images/6.png
+tags:
+  - dashboard

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

@@ -0,0 +1,8 @@
+runAsContext:
+  - userName: homepage
+    groupName: homepage
+    gid: 1000
+    uid: 1000
+    description: Homepage runs as a non-root user.
+capabilities: []
+hostMounts: []

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

@@ -0,0 +1,208 @@
+groups:
+  - name: Homepage Configuration
+    description: Configure Homepage
+  - name: Network Configuration
+    description: Configure Network for Homepage
+  - name: Storage Configuration
+    description: Configure Storage for Homepage
+  - name: Resources Configuration
+    description: Configure Resources for Homepage
+
+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: homepageConfig
+    label: ""
+    group: Homepage Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: additionalEnvs
+          label: Additional Environment Variables
+          description: Configure additional environment variables for Homepage.
+          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: homepageNetwork
+    label: ""
+    group: Network Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: webPort
+          label: Web Port
+          description: The port for the Homepage Web UI.
+          schema:
+            type: int
+            default: 30054
+            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: homepageStorage
+    label: ""
+    group: Storage Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: config
+          label: Homepage Config Storage
+          description: The path to store Homepage 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: "config"
+                  $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 Homepage.
+          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 Homepage.
+                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 Homepage.
+                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/homepage/templates/NOTES.txt

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

library/ix-dev/community/homepage/templates/_homepage.tpl

@@ -0,0 +1,51 @@
+{{- define "homepage.workload" -}}
+workload:
+  homepage:
+    enabled: true
+    primary: true
+    type: Deployment
+    podSpec:
+      hostNetwork: {{ .Values.homepageNetwork.hostNetwork }}
+      containers:
+        homepage:
+          enabled: true
+          primary: true
+          imageSelector: image
+          # While it seems that any uid/gid can be used
+          # There was permission errors when trying to cache things.
+          securityContext:
+            runAsUser: 1000
+            runAsGroup: 1000
+            readOnlyRootFilesystem: false
+          env:
+            PORT: {{ .Values.homepageNetwork.webPort }}
+          {{ with .Values.homepageConfig.additionalEnvs }}
+          envList:
+            {{ range $env := . }}
+            - name: {{ $env.name }}
+              value: {{ $env.value }}
+            {{ end }}
+          {{ end }}
+          probes:
+            liveness:
+              enabled: true
+              type: http
+              port: "{{ .Values.homepageNetwork.webPort }}"
+              path: /api/healthcheck
+            readiness:
+              enabled: true
+              type: http
+              port: "{{ .Values.homepageNetwork.webPort }}"
+              path: /api/healthcheck
+            startup:
+              enabled: true
+              type: http
+              port: "{{ .Values.homepageNetwork.webPort }}"
+              path: /api/healthcheck
+      initContainers:
+      {{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions"
+                                                        "UID" 1000
+                                                        "GID" 1000
+                                                        "mode" "check"
+                                                        "type" "init") | nindent 8 }}
+{{- end -}}

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

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

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

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

library/ix-dev/community/homepage/templates/_rbac.tpl

@@ -0,0 +1,49 @@
+{{- define "homepage.rbac" -}}
+serviceAccount:
+  homepage:
+    enabled: true
+    primary: true
+    targetSelector:
+      - homapage
+
+rbac:
+  homepage:
+    enabled: true
+    primary: true
+    clusterWide: true
+    serviceAccounts:
+      - homepage
+    rules:
+      - apiGroups:
+          - ""
+        resources:
+          - namespaces
+          - pods
+          - nodes
+        verbs:
+          - get
+          - list
+      - apiGroups:
+          - extensions
+          - networking.k8s.io
+        resources:
+          - ingresses
+        verbs:
+          - get
+          - list
+      - apiGroups:
+          - traefik.containo.us
+        resources:
+          - ingressroutes
+        verbs:
+          - get
+          - list
+      - apiGroups:
+          - metrics.k8s.io
+        resources:
+          - nodes
+          - pods
+        verbs:
+          - get
+          - list
+{{- end -}}

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

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

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

@@ -0,0 +1,15 @@
+{{- include "ix.v1.common.loader.init" . -}}
+
+{{/* Merge the templates with Values */}}
+{{- $_ := mustMergeOverwrite .Values (include "homepage.workload" $ | fromYaml) -}}
+{{- $_ := mustMergeOverwrite .Values (include "homepage.persistence" $ | fromYaml) -}}
+{{- $_ := mustMergeOverwrite .Values (include "homepage.service" $ | fromYaml) -}}
+{{/* FIXME: https://github.com/benphelps/homepage/pull/1627
+Currently it fills logs with errors failing to retrieve ingresses / traefik ingresses
+{{- $_ := mustMergeOverwrite .Values (include "homepage.rbac" $ | fromYaml) -}}
+*/}}
+
+{{/* Create the configmap for portal manually*/}}
+{{- include "homepage.portal" $ -}}
+
+{{- include "ix.v1.common.loader.apply" . -}}

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

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

library/ix-dev/community/homepage/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'v\d+\.\d+\.\d+')
+
+
+def newer_mapping(image_tags):
+    key = list(image_tags.keys())[0]
+    tags = {t.strip('v'): 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/homepage/values.yaml

@@ -0,0 +1,22 @@
+image:
+  repository: ghcr.io/benphelps/homepage
+  pullPolicy: IfNotPresent
+  tag: v0.6.21
+
+resources:
+  limits:
+    cpu: 4000m
+    memory: 8Gi
+
+homepageConfig:
+  additionalEnvs: []
+
+homepageNetwork:
+  webPort: 30054
+  hostNetwork: false
+
+homepageStorage:
+  config:
+    type: ixVolume
+    datasetName: config
+  additionalStorages: []