initial structure

.github/ct-install-config/ct-install.yaml

@@ -5,4 +5,7 @@ chart-yaml-schema: .github/ct-install-config/chart_schema.yaml
 chart-dirs:
   - library
   - charts
-excluded-charts: []
+# TODO: Remove
+excluded-charts:
+  - common/1.0.0
+  - common-test

.github/ct-install-config/ct-lint.yaml

@@ -4,4 +4,7 @@ helm-extra-args: --timeout 600s --debug
 chart-yaml-schema: .github/ct-install-config/chart_schema.yaml
 chart-dirs:
   - library
-excluded-charts: []
+# TODO: Remove
+excluded-charts:
+  - common/1.0.0
+  - common-test

helm_template_common.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-chart_path=library/common-test
+chart_path=library/common-testing
 
 if [ ! $1 == "template" ]; then
   if [ $1 == "-f" ] && [ ! -z $2 ]; then

library/common-testing/Chart.yaml

@@ -0,0 +1,16 @@
+name: common-test
+version: 1.0.0
+apiVersion: v2
+appVersion: v1.0.0
+kubeVersion: '>=1.16.0-0'
+description: A chart for the common library chart-testing
+home: http://localhost
+type: application
+icon: https://localhost/icon
+dependencies:
+  - name: common
+    repository: file://../common/1.0.1
+    version: ~1.0.1
+maintainers:
+  - name: truenas
+    url: https://www.truenas.com/

library/common-testing/templates/NOTES.txt

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

library/common/1.0.1/Chart.yaml

@@ -0,0 +1,9 @@
+apiVersion: v2
+name: common
+description: A library chart for iX Official Catalog
+type: library
+version: 1.0.1
+appVersion: v1
+maintainers:
+  - name: truenas
+    url: https://www.truenas.com/

library/common/1.0.1/README.md

@@ -0,0 +1,15 @@
+# Common Library
+
+## Naming Scheme
+
+- ConfigMap: `$FullName-$ConfigMapName`
+- Secret: `$FullName-$SecretName`
+- ServiceAccount: `$FullName-$ServiceAccountName`
+- RBAC: `$FullName-$RBACName`
+- Service:
+  - Primary: `$FullName`
+  - Others: `$FullName-$ServiceName`
+- Pods:
+  - Primary: `$FullName`
+  - Others: `$FullName-$PodName`
+- Containers: `$ContainerName`

library/common/1.0.1/docs/configmaps.md

@@ -0,0 +1,49 @@
+# ConfigMap
+
+| Key                                    |   Type    | Required | Helm Template | Default | Description                          |
+| :------------------------------------- | :-------: | :------: | :-----------: | :-----: | :----------------------------------- |
+| configmaps                              |  `dict`   |    ❌    |      ❌       |  `{}`   | Define the configMaps as dicts       |
+| configmaps.[configmap-name]             |  `dict`   |    ✅    |      ❌       |  `{}`   | Holds configMap definition           |
+| configmaps.[configmap-name].enabled     | `boolean` |    ✅    |      ❌       | `false` | Enables or Disables the configMap    |
+| configmaps.[configmap-name].labels      |  `dict`   |    ❌    |      ✅       |  `{}`   | Additional labels for configmap      |
+| configmaps.[configmap-name].annotations |  `dict`   |    ❌    |      ✅       |  `{}`   | Additional annotations for configmap |
+| configmaps.[configmap-name].data        |  `dict`   |    ✅    |      ✅       |  `{}`   | Define the data of the configmap     |
+
+---
+
+Appears in:
+
+- `.Values.configmaps`
+
+---
+
+Naming scheme:
+
+- `$FullName-$ConfigmapName`
+
+---
+
+Examples:
+
+```yaml
+configmaps:
+
+  configmap-name:
+    enabled: true
+    labels:
+      key: value
+      keytpl: "{{ .Values.some.value }}"
+    annotations:
+      key: value
+      keytpl: "{{ .Values.some.value }}"
+      data:
+        key: value
+
+  other-configmap-name:
+    enabled: true
+      data:
+        key: |
+          text value
+
+
+```

library/common/1.0.1/templates/classes/_configmap.tpl

@@ -0,0 +1,6 @@
+{{/* Configmap Class */}}
+{{/* Call this template:
+
+*/}}
+{{- define "ix.v1.common.class.configmap" -}}
+{{- end -}}

library/common/1.0.1/templates/lib/chart/_names.tpl

@@ -0,0 +1,23 @@
+{{/* Contains functions for generating names */}}
+
+{{/* Returns the name of the Chart */}}
+{{- define "ix.common.lib.chart.names.name" -}}
+
+  {{- .Chart.Name | trunc 63 | trimSuffix "-" -}}
+
+{{- end -}}
+
+{{/* Returns the fullname of the Chart */}}
+{{- define "ix.common.lib.chart.names.fullname" -}}
+
+  {{- $name := include "ix.common.lib.chart.names.name" . -}}
+
+  {{- if contains $name .Release.name -}}
+    {{- $name = .Release.Name -}}
+  {{- else -}}
+    {{- $name = printf "%s-%s" .Release.Name $name -}}
+  {{- end -}}
+
+  {{- $name | trunc 63 | trimSuffix "-" -}}
+
+{{- end -}}

library/common/1.0.1/templates/lib/chart/_notes.tpl

@@ -0,0 +1,19 @@
+{{- define "ix.v1.common.lib.chart.notes" -}}
+
+  {{- include "ix.v1.common.lib.chart.header" . -}}
+
+  {{- include "ix.v1.common.lib.chart.custom" . -}}
+
+  {{- include "ix.v1.common.lib.chart.footer" . -}}
+
+{{- end -}}
+
+{{- define "ix.v1.common.lib.chart.header" -}}
+  {{- tpl $.Values.common.notes.header $ | nindent 0 }}
+{{- end -}}
+{{- define "ix.v1.common.lib.chart.custom" -}}
+  {{- tpl $.Values.common.notes.header $ | nindent 0 }}
+{{- end -}}
+{{- define "ix.v1.common.lib.chart.footer" -}}
+  {{- tpl $.Values.common.notes.header $ | nindent 0 }}
+{{- end -}}

library/common/1.0.1/templates/loader/_all.tpl

@@ -0,0 +1,8 @@
+{{/* Main entrypoint for the library */}}
+{{- define "ix.v1.common.loader.all" -}}
+
+  {{- include "ix.v1.common.loader.init" . -}}
+
+  {{- include "ix.v1.common.loader.apply" . -}}
+
+{{- end -}}

library/common/1.0.1/templates/loader/_apply.tpl

@@ -0,0 +1,7 @@
+{{/* Loads all spawners */}}
+
+{{- define "ix.v1.common.loader.apply" -}}
+  {{/* Render configmap(s) */}}
+  {{- include "ix.v1.common.spawner.configmaps" . | nindent 0 -}}
+
+{{- end -}}

library/common/1.0.1/templates/loader/_init.tpl

@@ -0,0 +1,8 @@
+{{/* Initialiaze values of the chart */}}
+
+{{- define "ix.v1.common.loader.init" -}}
+
+  {{/* Merge chart values and the common chart defaults */}}
+  {{- include "ix.v1.common.values.init" . -}}
+
+{{- end -}}

library/common/1.0.1/templates/spawner/_configmap.tpl

@@ -0,0 +1,24 @@
+{{/* Configmap Spawwner */}}
+{{/* Call this template:
+{{ include "ix.v1.common.spawner.configmaps" . -}}
+*/}}
+
+{{- define "ix.v1.common.spawner.configmaps" -}}
+
+  {{- range $name, $configmap := .Values.configmaps -}}
+
+    {{- if $configmap.enabled -}}
+
+      {{/* Create a copy of the configmap */}}
+      {{- $objectData := (mustDeepCopy $configmap) -}}
+
+      {{/* Set the name of the configmap */}}
+      {{- $_ := set $objectData "name" (printf "%s-%s" (include "ix.common.lib.chart.names.fullname" $) $name) -}}
+      {{/* Call class to create the object */}}
+      {{- include "ix.v1.common.class.configmap" (dict "objectData" $objectData "rootCtx" $) -}}
+
+    {{- end -}}
+
+  {{- end -}}
+
+{{- end -}}

library/common/1.0.1/templates/spawner/_controller.tpl

@@ -0,0 +1,24 @@
+{{/* Configmap Spawwner */}}
+{{/* Call this template:
+{{ include "ix.v1.common.spawner.configmaps" . -}}
+*/}}
+
+{{- define "ix.v1.common.spawner.configmaps" -}}
+
+  {{- range $name, $configmap := .Values.configmaps -}}
+
+    {{- if $configmap.enabled -}}
+
+      {{/* Create a copy of the configmap */}}
+      {{- $objectData := (mustDeepCopy $configmap) -}}
+
+      {{/* Set the name of the configmap */}}
+      {{- $_ := set $objectData "name" (printf "%s-%s" (include "ix.common.lib.chart.names.fullname" $) $name) -}}
+      {{/* Call class to create the object */}}
+      {{- include "ix.v1.common.class.configmap" (dict "objectData" $objectData "rootCtx" $) -}}
+
+    {{- end -}}
+
+  {{- end -}}
+
+{{- end -}}

library/common/1.0.1/templates/values/_init.tpl

@@ -0,0 +1,14 @@
+{{/* Merge chart values and the common chart defaults */}}
+{{/* The ".common" is the name of the library */}}
+{{/* Call this template:
+{{ include "ix.v1.common.values.init" }}
+*/}}
+
+{{- define "ix.v1.common.values.init" -}}
+  {{- if .Values.common -}}
+    {{- $commonValues := mustDeepCopy .Values.common -}}
+    {{- $chartValues := mustDeepCopy (omit .Values "common") -}}
+    {{- $mergedValues := mustMergeOverwrite $commonValues $chartValues -}}
+    {{- $_ := set . "Values" (mustDeepCopy $mergedValues) -}}
+  {{- end -}}
+{{- end -}}

library/common/1.0.1/values.yaml

@@ -0,0 +1,570 @@
+# -- Global values
+global:
+  # -- Set additional global labels
+  labels: {}
+  # -- Set additional global annotations
+  annotations: {}
+  # -- Scale Storage Class
+  scaleZFSStorageClass: '{{ printf "ix-storage-class-%v" .Release.Name}}'
+
+# TODO:
+fallbackDefaults:
+  # -- Define a storageClassName that will be used for all PVCs
+  # Can be overruled per PVC
+  storageClass:
+
+# -- Injected from SCALE middleware
+# Only for reference here
+ixExternalInterfacesConfiguration: []
+# -- Injected from SCALE middleware
+# Only for reference here
+ixExternalInterfacesConfigurationNames: []
+# -- Injected from SCALE middleware
+# Only for reference here
+ixCertificates: []
+# -- Injected from SCALE middleware
+# Only for reference here
+ixVolumes: []
+
+# -- Image values
+image:
+  # -- Image repository
+  repository: traefik/whoami
+  # -- Image tag
+  tag: latest
+  # -- Image pull policy
+  pullPolicy: IfNotPresent
+
+# -- ConfigMaps
+configmaps:
+  # -- ConfigMap name
+  conf-name:
+    # -- Enables the ConfigMap
+    enabled: false
+    # -- ConfigMap labels
+    labels: {}
+    # -- ConfigMap annotations
+    annotations: {}
+    # -- ConfigMap data
+    data:
+      # -- ConfigMap data
+      key: value
+
+# -- Secrets
+secrets:
+  # -- Secret name
+  secret-name:
+    # -- Enables the secret
+    enabled: false
+    # -- Secret labels
+    labels: {}
+    # -- Secret annotations
+    annotations: {}
+    # -- Secret data
+    data:
+      # -- Secret data (stringData)
+      key: value
+
+# -- Service Account:
+serviceAccount:
+  sa-name:
+    # -- Enables the service account
+    enabled: false
+    # -- Service account labels
+    labels: {}
+    # -- Service account annotations
+    annotations: {}
+    autoMountSAToken: true
+    # targetSelector: all
+    targetSelector:
+      - pod-name
+
+# -- RBAC
+rbac:
+  # -- Enables the RBAC
+  enabled: false
+  # -- RBAC labels
+  labels: {}
+  # -- RBAC annotations
+  annotations: {}
+  # -- ClusterWide
+  clusterWide: false
+  # -- Service account name
+  serviceAccounts:
+    - sa-name
+  # -- RBAC rules
+  rules:
+    - apiGroups:
+        - ""
+      resources:
+        - pods
+      verbs:
+        - get
+
+# -- Security Context
+securityContext:
+  # -- Container security context for all containers
+  # Can be overruled per container
+  container:
+    runAsNonRoot: true
+    runAsUser: 568
+    runAsGroup: 568
+    readOnlyRootFilesystem: true
+    allowPrivilegeEscalation: false
+    privileged: false
+    capabilities:
+      add: []
+      drop:
+        - ALL
+  # -- Pod security context for all pods
+  # Can be overruled per pod
+  pod:
+    fsGroup: 568
+    supplementalGroups: []
+    fsGroupChangePolicy: OnRootMismatch
+
+# -- Resources
+# Can be overruled per container
+resources:
+  limits:
+    cpu: 4000m
+    memory: 8Gi
+  requests:
+    cpu: 10m
+    memory: 50Mi
+
+# -- Options for all pods
+# Can be overruled per pod
+podOptions:
+  enableServiceLinks: false
+  hostNetwork: false
+  dnsPolicy: ClusterFirst
+  dnsConfig: {}
+  hostAliases: []
+  nodeSelector: {}
+  tolerations: []
+  schedulerName: ""
+  priorityClassName: ""
+  terminationGracePeriodSeconds: 30
+  # TODO: Add affinity
+  # TODO: Add topologySpreadConstraints
+
+# -- Timezone for all containers
+# Can be overruled per container
+TZ: UTC
+# -- PUID for all containers
+# Can be overruled per container
+PUID: 568
+# -- UMASK for all containers
+# Can be overruled per container
+UMASK: "002"
+NVIDIA_CAPS:
+  - all
+
+# -- Persistence
+persistence:
+  shared:
+    enabled: true
+    type: emptyDir
+    mountPath: /shared
+    targetSelector: all
+  varlogs:
+    enabled: true
+    type: emptyDir
+    mountPath: /var/logs
+    targetSelector: all
+  tmp:
+    enabled: true
+    type: emptyDir
+    mountPath: /tmp
+    targetSelector: all
+  devshm:
+    # TODO: Enable by default?
+    enabled: false
+    type: emptyDir
+    mountPath: /dev/shm
+    targetSelector: all
+  # -- Volume name
+  vol-name:
+    # -- Enables the volume
+    enabled: false
+    # -- Type of volume
+    type: type
+    # -- Volume Options
+
+    # -  ConfigMap, Secret
+    # Default Mode (ConfigMap, Secret)
+    defaultMode: "0600"
+    # Items (ConfigMap, Secret)
+    items:
+      - key: key
+        path: path
+
+    # - EmptyDir
+    # Medium
+    medium: Memory
+    # SizeLimit
+    size: 1Gi
+
+    # - HostPath
+    # Host Path
+    hostPath: /path/to/host
+    # Host Path Type
+    hostPathType: DirectoryOrCreate
+
+    # - NFS
+    # Server
+    server: nfs-server
+    # Path
+    path: /path/to/nfs
+
+    # - ixVolumes
+    # datasetName
+    datasetName: dataset-name
+    # Host Path Type
+    # hostPathType: DirectoryOrCreate
+
+    # - PVC
+    # labels (Only for PVC type)
+    labels: {}
+    # annotations (Only for PVC type)
+    annotations: {}
+    # Size
+    # size: 1Gi
+    # Retain
+    retain: false
+    # Storage Class
+    storageClassName: ""
+    # Existing Claim
+    existingClaim: ""
+    # VolumeName
+    volumeName: ""
+    # Access Modes
+    accessModes:
+      - ReadWriteOnce
+    # -- Options that apply to all volumeMounts
+    # Can be overruled per volumeMount under targetSelector
+    mountPath: /shared
+    readOnly: False
+    subPath: ""
+    mountPropagation: ""
+    # Where to define the volume and mount the volume
+    # targetSelector: all
+    targetSelector:
+      pod-name:
+        container-name:
+          mountPath: /shared
+          readOnly: False
+          subPath: ""
+          mountPropagation: ""
+
+# -- Services
+services:
+  # -- Service name
+  service-name:
+    # -- Enables the service
+    enabled: true
+    # -- Primary service
+    primary: true
+    # -- Pod to connect
+    targetSelector: pod-name
+    # -- Ports
+    ports:
+      port-name:
+        # -- Enable the port
+        enabled: true
+        # -- Primary port
+        primary: true
+        # -- Port
+        port:
+        # -- Protocol
+        protocol: HTTPS
+        # -- Target port
+        targetPort:
+        # -- Node port
+        nodePort:
+        # -- Container to assign the port
+        targetSelector: container-name
+
+# -- VolumeClaimTemplates (StatefulSet only)
+volumeClaimTemplates:
+  # -- VolumeClaimTemplate name
+  vct-name:
+    # -- Enables the VolumeClaimTemplate
+    enabled: true
+    # -- VolumeClaimTemplate labels
+    labels: {}
+    # -- VolumeClaimTemplate annotations
+    annotations: {}
+    # -- VolumeClaimTemplate access modes
+    accessModes:
+      - ReadWriteOnce
+    # -- VolumeClaimTemplate storage class
+    storageClassName: ""
+    # -- VolumeClaimTemplate size
+    size: 1Gi
+    # -- Options that apply to all volumeMounts
+    # Can be overruled per volumeMount under targetSelector
+    # -- VolumeClaimTemplate mount path
+    mountPath: /data
+    readOnly: false
+    subPath: ""
+    mountPropagation: ""
+    targetSelector:
+      pod-name:
+        container-name:
+          mountPath: /data
+          readOnly: False
+          subPath: ""
+          mountPropagation: ""
+
+# -- Image Pull Secrets
+imagePullSecrets:
+  # -- Image Pull Secret name
+  image-secret-name:
+    # -- Enables the Image Pull Secret
+    enabled: false
+    # -- Image Pull Secret Data
+    data:
+      # -- Registry
+      registry: ""
+      # -- Username
+      username: ""
+      # -- Password
+      password: ""
+      # -- Email
+      email: ""
+    # targetSelector: all
+    targetSelector:
+      - pod-name
+
+# -- SCALE GPU
+scaleGPU:
+  - gpu:
+      key: value
+    # Without targetSelector, the gpu will
+    # be applied to primary pods
+    targetSelector:
+      pod-name:
+        - container-name
+
+# -- SCALE External Interfaces
+scaleExternalInterfaces:
+  - hostInterface: ""
+    ipam:
+      type: ""
+    staticRoutes: []
+    staticIPConfigurations: []
+    # targetSelector: all
+    targetSelector:
+      - pod-name
+
+# -- SCALE Certificates
+scaleCerts:
+  # -- Certificate name
+  cert-name:
+    # -- Enables the certificate
+    enabled: false
+    # -- Certificate ID (Comes from SCALE)
+    id: 1
+    # -- Default Paths that will be used on all defined containers
+    # Can be overruled per container under targetSelector
+    certPath: ""
+    keyPath: ""
+    # -- Defining a selector is only needed
+    # if you want to mount the certificate file(s)
+    # It will be mounted as readOnly
+    targetSelector:
+      pod-name:
+        container-name:
+          certPath: ""
+          keyPath: ""
+
+# -- Devices
+devices:
+  # -- Device name
+  device-name:
+    # -- Enables the device
+    enabled: false
+    # -- Device host path
+    hostPath: /host/device/path
+    # -- Options that apply to all volumeMounts
+    # Can be overruled per volumeMount under targetSelector
+    mountPath: /shared
+    readOnly: False
+    subPath: ""
+    mountPropagation: ""
+    # Where to define the volume and mount the volume
+    # targetSelector: all
+    targetSelector:
+      pod-name:
+        container-name:
+          mountPath: /shared
+          readOnly: False
+          subPath: ""
+          mountPropagation: ""
+
+notes:
+  header: |
+    # Welcome to SCALE
+    Thank you for installing {{ .Chart.Name }}.
+  custom: ""
+  footer: |
+    # Documentation
+    # Bug reports
+
+# -- Controllers
+controllers:
+  # -- Controller name
+  controller-name:
+    # -- Enables the controller
+    enabled: false
+    # -- Controller type
+    type: Deployment
+    # -- Controller labels
+    labels: {}
+    # -- Controller annotations
+    annotations: {}
+    # -- Controller replicas (Deployment and StatefulSet only)
+    replicas: 1
+    # -- Controller revision history limit
+    revisionHistoryLimit: 10
+    # Strategy
+    strategy:
+      # -- Controller strategy type
+      type: RollingUpdate
+      # -- Controller strategy rolling update
+      rollingUpdate:
+        # -- Controller strategy rolling update max unavailable
+        maxUnavailable: 1
+        # -- Controller strategy rolling update max surge
+        maxSurge: 1
+        # -- Controller strategy rolling update partition (StatefulSet only)
+        partition: 0
+    # -- CronJob
+    # - CronJob schedule
+    schedule: ""
+    # - CronJob concurrency policy
+    concurrencyPolicy: ""
+    # - CronJob timezone
+    timezone: ""
+    # - CronJob failed jobs history limit
+    failedJobsHistoryLimit: 1
+    # - CronJob successful jobs history limit
+    successfulJobsHistoryLimit: 3
+    # - CronJob starting deadline seconds
+    startingDeadlineSeconds: 0
+
+    # -- Job
+    # - Job active deadline seconds
+    activeDeadlineSeconds: 0
+    # - Job backoff limit
+    backoffLimit: 6
+    # - Job completions
+    completions: 1
+    # - Job parallelism
+    parallelism: 1
+    # - Job ttl seconds after finished
+    ttlSecondsAfterFinished: 0
+    # - Job completion mode
+    completionMode: NonIndexed
+
+    # -- Pod Spec
+    podSpec:
+      # -- hostNetwork
+      hostNetwork: false
+      # -- enableServiceLinks
+      enableServiceLinks: true
+      # -- restartPolicy
+      restartPolicy: Always
+      # -- schedulerName
+      schedulerName: ""
+      # -- priorityClassName
+      priorityClassName: ""
+      # -- hostname
+      hostname: ""
+      # -- nodeselector
+      nodeSelector: {}
+      # -- tolerations
+      tolerations: []
+      # -- runtimeClassName
+      runtimeClassName: ""
+      # -- terminationGracePeriodSeconds
+      terminationGracePeriodSeconds: 30
+      # -- securityContext
+      securityContext:
+        fsGroup: 0
+        fsGroupChangePolicy: OnRootMismatch
+        supplementalGroups: []
+      # -- Containers
+      containers:
+        # -- Container name
+        container-name:
+          # -- Enables the container
+          enabled: true
+          # -- Container image
+          imageSelector: ""
+          tty: false
+          stdin: false
+          command: []
+          args: []
+          extraArgs: []
+          securityContext:
+            runAsNonRoot: true
+            runAsUser: 568
+            runAsGroup: 568
+            readOnlyRootFilesystem: true
+            allowPrivilegeEscalation: false
+            privileged: false
+            capabilities:
+              add: []
+              drop:
+                - ALL
+          lifecycle:
+            postStart:
+              command: []
+            preStop:
+              command: []
+          termination:
+            messagePath: ""
+            messagePolicy: ""
+          env: {}
+          envList: []
+          envFrom: []
+          resources:
+            limits:
+              cpu: 100m
+              memory: 128Mi
+            requests:
+              cpu: 100m
+              memory: 128Mi
+          probes:
+            liveness:
+              enabled: true
+              type: HTTP
+              port:
+              path:
+              httpHeaders: {}
+              command: []
+            readiness:
+              enabled: true
+              type: HTTP
+              port:
+              path:
+              httpHeaders: {}
+              command: []
+            startup:
+              enabled: true
+              type: HTTP
+              port:
+              path:
+              httpHeaders: {}
+              command: []
+      initContainers:
+        init-cont-name:
+          enabled: false
+          type: install
+          # ...containerSpec
+
+# TODO:
+portal: {}

run_common_tests.sh

@@ -4,7 +4,7 @@
 # -- You need to install this helm plugin
 # helm plugin install https://github.com/quintush/helm-unittest
 
-common_test_path="library/common-test"
+common_test_path="library/common-testing"
 
 function cleanup {
   if [ -d "$common_test_path/charts" ]; then