build(helm): Set up Spider Huntsman Helm chart scaffolding and linting. (#383)

Author: 20001020ycx

.github/workflows/code-linting-checks.yaml

@@ -38,6 +38,7 @@ jobs:
     steps:
       - uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd"  # v6.0.2
         with:
+          fetch-depth: 0
           submodules: "recursive"
 
       - uses: "./tools/yscope-dev-utils/exports/github/actions/install-python"
@@ -53,6 +54,8 @@ jobs:
 
       - run: "task lint:yml-check"
 
+      - run: "task lint:check-helm"
+
   lint-cpp:
     needs: "filter-relevant-changes"
     if: >-

requirements-dev.txt

@@ -8,6 +8,7 @@ gersemi>=0.16.2
 mypy>=1.12.0
 ruff>=0.4.4
 tombi>=0.4.35
+yamale>=6.1.0
 yamllint>=1.35.1
 
 # Test dependencies

taskfile.yaml

@@ -1,5 +1,7 @@
 version: "3"
 
+set: ["pipefail"]
+
 includes:
   build: "taskfiles/build.yaml"
   deps: "taskfiles/deps.yaml"

taskfiles/lint.yaml

@@ -15,6 +15,7 @@ tasks:
 
       - task: "cmake-check"
       - task: "cpp-check"
+      - task: "check-helm"
       - task: "py-check"
       - task: "toml-check"
       - task: "yml-check"
@@ -25,6 +26,7 @@ tasks:
 
       - task: "cmake-fix"
       - task: "cpp-fix"
+      - task: "fix-helm"
       - task: "py-fix"
       - task: "toml-fix"
       - task: "yml-fix"
@@ -122,6 +124,22 @@ tasks:
             - "{{.G_EXAMPLES_WOLF_DIR}}"
           VENV_DIR: "{{.G_LINT_VENV_DIR}}"
 
+  helm:
+    aliases:
+      - "check-helm"
+      - "fix-helm"
+    deps:
+      - "toolchains:helm"
+      - "venv"
+    cmds:
+      - |-
+        . "{{.G_LINT_VENV_DIR}}/bin/activate"
+        . "{{.G_HELM_TOOLCHAIN_ENV_FILE}}"
+        ct lint \
+          --chart-dirs="tools/deployment" \
+          --chart-yaml-schema="{{.G_HELM_TOOLCHAIN_DIR}}/etc/chart_schema.yaml" \
+          --lint-conf="tools/yscope-dev-utils/exports/lint-configs/.yamllint.yml"
+
   py-check:
     cmds:
       - task: "spider-py-check"

taskfiles/toolchains.yaml

@@ -1,9 +1,12 @@
 version: "3"
 
 includes:
+  remote: "../tools/yscope-dev-utils/exports/taskfiles/utils/remote.yaml"
   utils: "../tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
 
 vars:
+  G_HELM_TOOLCHAIN_DIR: "{{.G_BUILD_DIR}}/toolchains/helm"
+  G_HELM_TOOLCHAIN_ENV_FILE: "{{.G_HELM_TOOLCHAIN_DIR}}/env"
   G_RUST_TOOLCHAIN_DIR: "{{.G_BUILD_DIR}}/toolchains/rust"
   G_RUST_TOOLCHAIN_ENV_FILE: "{{.G_RUST_TOOLCHAIN_DIR}}/env"
 
@@ -15,6 +18,44 @@ vars:
   G_RUST_TOOLCHAIN_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/toolchains-rust.md5"
 
 tasks:
+  helm:
+    vars:
+      CHART_TESTING_VERSION: "3.14.0"
+      HELM_VERSION: "v4.2.3"
+    run: "once"
+    cmds:
+      - "mkdir -p '{{.G_HELM_TOOLCHAIN_DIR}}'"
+      - task: "remote:download-and-extract-tar"
+        vars:
+          OUTPUT_DIR: "{{.G_HELM_TOOLCHAIN_DIR}}"
+          URL: "https://github.com/helm/chart-testing/releases/download/v{{.CHART_TESTING_VERSION}}\
+          /chart-testing_{{.CHART_TESTING_VERSION}}_{{OS}}_{{ARCH}}.tar.gz"
+          FILE_SHA256: >-
+            {{- if and (eq OS "linux") (eq ARCH "amd64") -}}
+              d16f0583616885423826241164ce1f6589c6fe5332fa74f374ebd2bd3cb3fe1f
+            {{- else if and (eq OS "linux") (eq ARCH "arm64") -}}
+              7b035bbbd0768fba33983e81c15445e33e9c8281d329100852a342ecfd0b16b7
+            {{- else if and (eq OS "darwin") (eq ARCH "arm64") -}}
+              db10dbbb42b110c7a5da5a3202908f32ad2ca6ad600d423426dc7886d09aad07
+            {{- else -}}
+              unsupported
+            {{- end }}
+          INCLUDE_PATTERNS: ["ct", "etc/chart_schema.yaml"]
+          NUM_COMPONENTS_TO_STRIP: "0"
+      - |-
+        export PATH="{{.G_HELM_TOOLCHAIN_DIR}}:$PATH"
+        export HELM_INSTALL_DIR="{{.G_HELM_TOOLCHAIN_DIR}}"
+        curl --proto "=https" --tlsv1.2 --silent --show-error --fail \
+        https://raw.githubusercontent.com/helm/helm/{{.HELM_VERSION}}/scripts/get-helm-4 \
+        | bash -s -- --no-sudo --version "{{.HELM_VERSION}}"
+
+      # Create an environment file to configure the custom Helm toolchain location.
+      - |-
+        cat <<"EOF" > "{{.G_HELM_TOOLCHAIN_ENV_FILE}}"
+        #!/bin/sh
+        export PATH="{{.G_HELM_TOOLCHAIN_DIR}}:$PATH"
+        EOF
+
   rust:
     # We use a label to uniquely identify this task and its checksum under `.task/checksums/`.
     label: "toolchains-rust"

tools/deployment/spider-helm/.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
+.bzr/
+.bzrignore
+.git/
+.gitignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.bak
+*.orig
+*.swp
+*.tmp
+*~
+# Various IDEs
+*.tmproj
+.idea/
+.project
+.vscode/

tools/deployment/spider-helm/Chart.yaml

@@ -0,0 +1,11 @@
+apiVersion: "v2"
+name: "spider"
+description: "A Helm chart for the Spider Huntsman deployment"
+type: "application"
+version: "0.1.0"
+appVersion: "0.1.0"
+home: "https://github.com/y-scope/spider"
+sources: ["https://github.com/y-scope/spider"]
+maintainers: [{name: "y-scope", email: "dev@yscope.com", url: "https://yscope.com"}]
+keywords:
+  - "distributed-scheduler"

tools/deployment/spider-helm/values.yaml

@@ -0,0 +1 @@
+