Helm charts

.github/chart_schema.yaml

@@ -0,0 +1,37 @@
+name: str()
+home: str(required=False)
+version: str()
+apiVersion: str()
+appVersion: any(str(), num(), required=False)
+description: str(required=False)
+keywords: list(str(), required=False)
+sources: list(str(), required=False)
+maintainers: list(include('maintainer'), required=False)
+dependencies: list(include('dependency'), required=False)
+icon: str(required=False)
+engine: str(required=False)
+condition: str(required=False)
+tags: str(required=False)
+deprecated: bool(required=False)
+kubeVersion: str(required=False)
+annotations: map(str(), str(), required=False)
+type: str(required=False)
+---
+maintainer:
+  name: str()
+  email: str(required=False)
+  url: str(required=False)
+---
+dependency:
+  name: str()
+  version: str()
+  repository: str(required=False)
+  condition: str(required=False)
+  tags: list(str(), required=False)
+  enabled: bool(required=False)
+  import-values: any(list(str()), list(include('import-value')), required=False)
+  alias: str(required=False)
+---
+import-value:
+  child: str()
+  parent: str()

.github/lintconf.yaml

@@ -0,0 +1,42 @@
+---
+rules:
+  braces:
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  brackets:
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  colons:
+    max-spaces-before: 0
+    max-spaces-after: 1
+  commas:
+    max-spaces-before: 0
+    min-spaces-after: 1
+    max-spaces-after: 1
+  comments:
+    require-starting-space: true
+    min-spaces-from-content: 2
+  document-end: disable
+  document-start: disable           # No --- to start a file
+  empty-lines:
+    max: 2
+    max-start: 0
+    max-end: 0
+  hyphens:
+    max-spaces-after: 1
+  indentation:
+    spaces: consistent
+    indent-sequences: whatever      # - list indentation will handle both indentation and without
+    check-multi-line-strings: false
+  key-duplicates: enable
+  line-length: disable              # Lines can be any length
+  new-line-at-end-of-file: enable
+  new-lines:
+    type: unix
+  trailing-spaces: enable
+  truthy:
+    level: warning

.github/workflows/publish-chart.yaml

@@ -0,0 +1,101 @@
+name: Lint, test and publish charts
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'charts/**'
+
+jobs:
+  helm-chart-testing:
+    name: chart-testing
+    runs-on: ubuntu-latest
+    environment: test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: v3.12.1
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+          check-latest: true
+
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@v2.6.0
+
+      - name: Helm registry login
+        run: |
+          helm registry login ghcr.io/scroll-tech/helm/scroll-sdk --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
+        env:
+          HELM_GITHUB_PASSWORD: "${{ secrets.HELM_GITHUB_PASSWORD }}"
+
+      #  List chart change except scroll-sdk
+      - name: Run chart-testing (list-changed)
+        id: list-changed
+        run: |
+          changed=$(ct list-changed --excluded-charts scroll-sdk --target-branch ${{ github.event.repository.default_branch }} )
+          if [[ -n "$changed" ]]; then
+            echo "changed=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Run chart-testing (lint)
+        if: steps.list-changed.outputs.changed == 'true'
+        run: ct lint --config ct.yaml --excluded-charts scroll-sdk --target-branch ${{ github.event.repository.default_branch }}
+
+  publish-ghcr:
+    name: publish-to-github
+    runs-on: ubuntu-latest
+    needs:
+      - helm-chart-testing
+    outputs:
+      charts: ${{ steps.list-changed.outputs.changed }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: dorny/paths-filter@v2
+        id: filter
+        with:
+          base: ${{ github.event.repository.default_branch }}
+          list-files: shell
+          filters: |
+            addedOrModified:
+              - added|modified: 'charts/**'
+
+      - name: Helm registry login
+        run: |
+          helm registry login ghcr.io/scroll-tech/helm/scroll-sdk --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
+        env:
+          HELM_GITHUB_PASSWORD: "${{ secrets.HELM_GITHUB_PASSWORD }}"
+
+      - name: Push chart to ghcr
+        if: steps.filter.outputs.addedOrModified == 'true'
+        env:
+          HELM_EXPERIMENTAL_OCI: 1
+        run: |
+          set -x
+          CHARTS=()
+          PATHS=(${{ steps.filter.outputs.addedOrModified_files }})
+          echo ${PATHS}
+          # Get only the chart paths
+          for i in "${PATHS[@]}"
+          do
+            chart=$(echo $i | awk -F "/" '{print $2}')
+          done
+          # Remove duplicates
+          CHARTS=( `for i in ${CHARTS[@]}; do echo $i; done | sort -u` )
+          echo "CHARTS: ${CHARTS[@]}"
+          for chart in ${CHARTS[@]}; do
+            helm dependencies build charts/$chart
+            helm package charts/$chart
+            export CHART_VERSION=$(grep 'version:' charts/$chart/Chart.yaml | head -n1 | awk '{ print $2 }')
+            helm push $chart-${CHART_VERSION}.tgz oci://ghcr.io/scroll-tech/scroll-sdk/helm
+          done

.github/workflows/publish-dev-chart.yaml

@@ -0,0 +1,103 @@
+name: Lint, test and publish dev charts
+
+on:
+  push:
+    paths:
+      - 'charts/**'
+
+env:
+  HELM_REGISTRY: ghcr.io/scroll-tech/scroll-sdk/helm/dev
+
+jobs:
+  helm-chart-testing-not-scroll-sdk:
+    name: chart-testing-without-scroll-sdk
+    runs-on: ubuntu-latest
+    environment: test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: v3.12.1
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+          check-latest: true
+
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@v2.6.0
+
+      - name: Helm registry login
+        run: |
+          helm registry login ghcr.io/scroll-tech/helm/scroll-sdk --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
+        env:
+          HELM_GITHUB_PASSWORD: "${{ secrets.HELM_GITHUB_PASSWORD }}"
+
+      #  List chart change except scroll-sdk
+      - name: Run chart-testing (list-changed)
+        id: list-changed
+        run: |
+          changed=$(ct list-changed --excluded-charts scroll-sdk --target-branch ${{ github.event.repository.default_branch }} )
+          if [[ -n "$changed" ]]; then
+            echo "changed=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Run chart-testing (lint)
+        if: steps.list-changed.outputs.changed == 'true'
+        run: ct lint --config ct.yaml --excluded-charts scroll-sdk --target-branch ${{ github.event.repository.default_branch }}
+
+  publish-ghcr-not-scroll-sdk:
+    name: publish-to-github-without-scroll-sdk
+    runs-on: ubuntu-latest
+    needs:
+      - helm-chart-testing-not-scroll-sdk
+    outputs:
+      charts: ${{ steps.list-changed.outputs.changed }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: dorny/paths-filter@v2
+        id: filter
+        with:
+          base: ${{ github.event.repository.default_branch }}
+          list-files: shell
+          filters: |
+            addedOrModified:
+              - added|modified: 'charts/**'
+
+      - name: Helm registry login
+        run: |
+          helm registry login ghcr.io/scroll-tech/helm/scroll-sdk --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
+        env:
+          HELM_GITHUB_PASSWORD: "${{ secrets.HELM_GITHUB_PASSWORD }}"
+
+      - name: Push chart to ghcr
+        if: steps.filter.outputs.addedOrModified == 'true'
+        env:
+          HELM_EXPERIMENTAL_OCI: 1
+        run: |
+          set -x
+          CHARTS=()
+          PATHS=(${{ steps.filter.outputs.addedOrModified_files }})
+          echo ${PATHS}
+          # Get only the chart paths
+          for i in "${PATHS[@]}"
+          do
+            chart=$(echo $i | awk -F "/" '{print $2}')
+          done
+          # Remove duplicates
+          CHARTS=( `for i in ${CHARTS[@]}; do echo $i; done | sort -u` )
+          echo "CHARTS: ${CHARTS[@]}"
+          for chart in ${CHARTS[@]}; do
+            helm dependencies build charts/$chart
+            helm package charts/$chart
+            export CHART_VERSION=$(grep 'version:' charts/$chart/Chart.yaml | head -n1 | awk '{ print $2 }')
+            helm push $chart-${CHART_VERSION}.tgz oci://${HELM_REGISTRY}
+          done

.gitignore

@@ -18,4 +18,11 @@ target/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#.idea/
+
+config.json
+keys/
+
+# Helm chart related
+*.lock
+*.tgz

charts/scroll-proving-sdk/Chart.yaml

@@ -0,0 +1,14 @@
+---
+apiVersion: v2
+description: Example chart for showing how to package a service built using the scroll-proving-sdk library
+name: scroll-proving-sdk
+version: 0.0.5
+appVersion: v0.1.0
+kubeVersion: ">=1.22.0-0"
+maintainers:
+  - name: scroll-tech
+    email: sebastien@scroll.io
+dependencies:
+  - name: common
+    repository: "oci://ghcr.io/scroll-tech/scroll-sdk/helm"
+    version: 1.5.1

charts/scroll-proving-sdk/README.md

@@ -0,0 +1,68 @@
+# scroll-proving-sdk
+
+![Version: 0.0.5](https://img.shields.io/badge/Version-0.0.5-informational?style=flat-square) ![AppVersion: v0.1.0](https://img.shields.io/badge/AppVersion-v0.1.0-informational?style=flat-square)
+
+Example chart for showing how to package a service built using the scroll-proving-sdk library
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| scroll-tech | <sebastien@scroll.io> |  |
+
+## Requirements
+
+Kubernetes: `>=1.22.0-0`
+
+| Repository | Name | Version |
+|------------|------|---------|
+| oci://ghcr.io/scroll-tech/scroll-sdk/helm | common | 1.5.1 |
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| command[0] | string | `"/bin/sh"` |  |
+| command[1] | string | `"-c"` |  |
+| command[2] | string | `"exec cloud --config /sdk_prover/config.json"` |  |
+| defaultProbes.custom | bool | `true` |  |
+| defaultProbes.enabled | bool | `true` |  |
+| defaultProbes.spec.httpGet.path | string | `"/"` |  |
+| defaultProbes.spec.httpGet.port | int | `80` |  |
+| global.fullnameOverride | string | `"scroll-proving-sdk"` |  |
+| global.nameOverride | string | `"scroll-proving-sdk"` |  |
+| image.pullPolicy | string | `"Always"` |  |
+| image.repository | string | `"scrolltech/sdk-cloud-prover"` |  |
+| image.tag | string | `"sindri-v0.0.1"` |  |
+| persistence.config.enabled | bool | `true` |  |
+| persistence.config.mountPath | string | `"/sdk_prover/"` |  |
+| persistence.config.name | string | `"scroll-proving-sdk-config"` |  |
+| persistence.config.type | string | `"configMap"` |  |
+| persistence.keys.accessMode | string | `"ReadWriteOnce"` |  |
+| persistence.keys.enabled | bool | `true` |  |
+| persistence.keys.mountPath | string | `"/keys/"` |  |
+| persistence.keys.size | string | `"10Mi"` |  |
+| persistence.keys.type | string | `"pvc"` |  |
+| probes.liveness.<<.custom | bool | `true` |  |
+| probes.liveness.<<.enabled | bool | `true` |  |
+| probes.liveness.<<.spec.httpGet.path | string | `"/"` |  |
+| probes.liveness.<<.spec.httpGet.port | int | `80` |  |
+| probes.readiness.<<.custom | bool | `true` |  |
+| probes.readiness.<<.enabled | bool | `true` |  |
+| probes.readiness.<<.spec.httpGet.path | string | `"/"` |  |
+| probes.readiness.<<.spec.httpGet.port | int | `80` |  |
+| probes.startup.<<.custom | bool | `true` |  |
+| probes.startup.<<.enabled | bool | `true` |  |
+| probes.startup.<<.spec.httpGet.path | string | `"/"` |  |
+| probes.startup.<<.spec.httpGet.port | int | `80` |  |
+| resources.limits.cpu | string | `"100m"` |  |
+| resources.limits.memory | string | `"500Mi"` |  |
+| resources.requests.cpu | string | `"50m"` |  |
+| resources.requests.memory | string | `"100Mi"` |  |
+| scrollConfig | string | `"{}\n"` |  |
+| service.main.enabled | bool | `true` |  |
+| service.main.ports.http.enabled | bool | `true` |  |
+| service.main.ports.http.port | int | `80` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)