diff --git a/library/ix-dev/community/homepage/Chart.lock b/library/ix-dev/community/homepage/Chart.lock new file mode 100644 index 0000000000..f129f62d7e --- /dev/null +++ b/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" diff --git a/library/ix-dev/community/homepage/Chart.yaml b/library/ix-dev/community/homepage/Chart.yaml new file mode 100644 index 0000000000..b8107e6853 --- /dev/null +++ b/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 diff --git a/library/ix-dev/community/homepage/README.md b/library/ix-dev/community/homepage/README.md new file mode 100644 index 0000000000..a2237c4ecd --- /dev/null +++ b/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. diff --git a/library/ix-dev/community/homepage/app-readme.md b/library/ix-dev/community/homepage/app-readme.md new file mode 100644 index 0000000000..a2237c4ecd --- /dev/null +++ b/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. diff --git a/library/ix-dev/community/homepage/charts/common-1.0.12.tgz b/library/ix-dev/community/homepage/charts/common-1.0.12.tgz new file mode 100644 index 0000000000..e2f3f00b87 Binary files /dev/null and b/library/ix-dev/community/homepage/charts/common-1.0.12.tgz differ diff --git a/library/ix-dev/community/homepage/ci/basic-values.yaml b/library/ix-dev/community/homepage/ci/basic-values.yaml new file mode 100644 index 0000000000..129b0d45fc --- /dev/null +++ b/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 diff --git a/library/ix-dev/community/homepage/ci/extra-values.yaml b/library/ix-dev/community/homepage/ci/extra-values.yaml new file mode 100644 index 0000000000..9c1442600e --- /dev/null +++ b/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 diff --git a/library/ix-dev/community/homepage/ci/hostNet-values.yaml b/library/ix-dev/community/homepage/ci/hostNet-values.yaml new file mode 100644 index 0000000000..f0c4e669b5 --- /dev/null +++ b/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 diff --git a/library/ix-dev/community/homepage/item.yaml b/library/ix-dev/community/homepage/item.yaml new file mode 100644 index 0000000000..7debf072f7 --- /dev/null +++ b/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 diff --git a/library/ix-dev/community/homepage/metadata.yaml b/library/ix-dev/community/homepage/metadata.yaml new file mode 100644 index 0000000000..d5c45c1ec5 --- /dev/null +++ b/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: [] diff --git a/library/ix-dev/community/homepage/questions.yaml b/library/ix-dev/community/homepage/questions.yaml new file mode 100644 index 0000000000..a7e811e718 --- /dev/null +++ b/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.
+ 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.
+ 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.
+ 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
+ - Plain Integer - eg. 1
+ - Float - eg. 0.5
+ - 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
+ - Suffixed with E/P/T/G/M/K - eg. 1G
+ - Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi
+ - Plain Integer in bytes - eg. 1024
+ - Exponent - eg. 134e6 + default: "8Gi" + required: true diff --git a/library/ix-dev/community/homepage/templates/NOTES.txt b/library/ix-dev/community/homepage/templates/NOTES.txt new file mode 100644 index 0000000000..ba4e01146c --- /dev/null +++ b/library/ix-dev/community/homepage/templates/NOTES.txt @@ -0,0 +1 @@ +{{ include "ix.v1.common.lib.chart.notes" $ }} diff --git a/library/ix-dev/community/homepage/templates/_homepage.tpl b/library/ix-dev/community/homepage/templates/_homepage.tpl new file mode 100644 index 0000000000..68ddaa7139 --- /dev/null +++ b/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 -}} diff --git a/library/ix-dev/community/homepage/templates/_persistence.tpl b/library/ix-dev/community/homepage/templates/_persistence.tpl new file mode 100644 index 0000000000..b228e30015 --- /dev/null +++ b/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 -}} diff --git a/library/ix-dev/community/homepage/templates/_portal.tpl b/library/ix-dev/community/homepage/templates/_portal.tpl new file mode 100644 index 0000000000..4ac167b297 --- /dev/null +++ b/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 -}} diff --git a/library/ix-dev/community/homepage/templates/_rbac.tpl b/library/ix-dev/community/homepage/templates/_rbac.tpl new file mode 100644 index 0000000000..2dca724f52 --- /dev/null +++ b/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 -}} diff --git a/library/ix-dev/community/homepage/templates/_service.tpl b/library/ix-dev/community/homepage/templates/_service.tpl new file mode 100644 index 0000000000..af55663596 --- /dev/null +++ b/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 -}} diff --git a/library/ix-dev/community/homepage/templates/common.yaml b/library/ix-dev/community/homepage/templates/common.yaml new file mode 100644 index 0000000000..0036c0031e --- /dev/null +++ b/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" . -}} diff --git a/library/ix-dev/community/homepage/upgrade_info.json b/library/ix-dev/community/homepage/upgrade_info.json new file mode 100644 index 0000000000..767388094a --- /dev/null +++ b/library/ix-dev/community/homepage/upgrade_info.json @@ -0,0 +1 @@ +{"filename": "values.yaml", "keys": ["image"]} diff --git a/library/ix-dev/community/homepage/upgrade_strategy b/library/ix-dev/community/homepage/upgrade_strategy new file mode 100755 index 0000000000..5718e19a44 --- /dev/null +++ b/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))) diff --git a/library/ix-dev/community/homepage/values.yaml b/library/ix-dev/community/homepage/values.yaml new file mode 100644 index 0000000000..6958a216cc --- /dev/null +++ b/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: []