docs(values,templating): add reference and best practices pages #13051
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Test Cross-Cluster | |
| on: | |
| pull_request: | |
| paths-ignore: | |
| - "**.md" | |
| - "**.jpg" | |
| - "**.png" | |
| - "**.gif" | |
| - "**.svg" | |
| - "adr/**" | |
| - "docs/**" | |
| - "CODEOWNERS" | |
| merge_group: | |
| paths-ignore: | |
| - "**.md" | |
| - "**.jpg" | |
| - "**.png" | |
| - "**.gif" | |
| - "**.svg" | |
| - "adr/**" | |
| - "docs/**" | |
| - "CODEOWNERS" | |
| permissions: | |
| contents: read | |
| # Abort prior jobs in the same workflow / PR | |
| concurrency: | |
| group: e2e-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| # Build the binary and init package | |
| build-e2e: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| - name: Setup golang | |
| uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 # v6.0.0 | |
| with: | |
| go-version-file: go.mod | |
| - name: Build binary and zarf packages | |
| uses: ./.github/actions/packages | |
| # Upload the contents of the build directory for later stages to use | |
| - name: Upload build artifacts | |
| uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 | |
| with: | |
| name: build-artifacts | |
| path: build/ | |
| retention-days: 1 | |
| validate-without-cluster: | |
| runs-on: ubuntu-latest | |
| needs: build-e2e | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| - name: Download build artifacts | |
| uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 | |
| with: | |
| name: build-artifacts | |
| path: build/ | |
| - name: Setup golang | |
| uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 # v6.0.0 | |
| with: | |
| go-version-file: go.mod | |
| - name: Make Zarf executable | |
| run: | | |
| chmod +x build/zarf | |
| # Before we run the regular tests we need to aggressively cleanup files to reduce disk pressure | |
| - name: Cleanup files | |
| uses: ./.github/actions/cleanup-files | |
| - name: Run tests | |
| run: | | |
| make test-e2e-without-cluster ARCH=amd64 | |
| # Run the tests on k3d | |
| validate-k3d: | |
| runs-on: ubuntu-latest | |
| needs: build-e2e | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| - name: Download build artifacts | |
| uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 | |
| with: | |
| name: build-artifacts | |
| path: build/ | |
| - name: Setup golang | |
| uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 # v6.0.0 | |
| with: | |
| go-version-file: go.mod | |
| - name: Setup K3d | |
| uses: ./.github/actions/k3d | |
| - name: Make Zarf executable | |
| run: | | |
| chmod +x build/zarf | |
| # Before we run the regular tests we need to aggressively cleanup files to reduce disk pressure | |
| - name: Cleanup files | |
| uses: ./.github/actions/cleanup-files | |
| - name: Run tests | |
| run: | | |
| make test-e2e-with-cluster ARCH=amd64 | |
| - name: get cluster info | |
| uses: ./.github/actions/debug-cluster | |
| if: always() | |
| # Run the tests on k3s | |
| validate-k3s: | |
| runs-on: ubuntu-latest | |
| needs: build-e2e | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| - name: Download build artifacts | |
| uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 | |
| with: | |
| name: build-artifacts | |
| path: build/ | |
| - name: Setup golang | |
| uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 # v6.0.0 | |
| with: | |
| go-version-file: go.mod | |
| - name: Make Zarf executable | |
| run: | | |
| chmod +x build/zarf | |
| # Before we run the regular tests we need to aggressively cleanup files to reduce disk pressure | |
| - name: Cleanup files | |
| uses: ./.github/actions/cleanup-files | |
| - name: Run tests | |
| # NOTE: "PATH=$PATH" preserves the default user $PATH. This is needed to maintain the version of go installed | |
| # in a previous step. This test run will use Zarf to create a K3s cluster, and a brand new cluster will be | |
| # used for each test | |
| run: | | |
| sudo env "PATH=$PATH" CI=true APPLIANCE_MODE=true make test-e2e-with-cluster ARCH=amd64 | |
| # Run the tests on kind | |
| validate-kind-arm64: | |
| runs-on: ubuntu-24.04-arm | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| - name: Setup golang | |
| uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 # v6.0.0 | |
| with: | |
| go-version-file: go.mod | |
| - name: Build zarf binary | |
| run: | | |
| make build-cli-linux-arm | |
| mv build/zarf-arm build/zarf | |
| - name: Build init package | |
| run: make init-package ARCH=arm64 | |
| - name: Setup Kind | |
| run: | | |
| kind delete cluster && kind create cluster | |
| kubectl scale deploy -n kube-system coredns --replicas=1 | |
| # Before we run the regular tests we need to aggressively cleanup files to reduce disk pressure | |
| - name: Cleanup files | |
| uses: ./.github/actions/cleanup-files | |
| - name: Run tests | |
| run: | | |
| make test-e2e-with-cluster ARCH=arm64 | |
| - name: get cluster info | |
| uses: ./.github/actions/debug-cluster | |
| if: always() | |
| # Run the tests on minikube | |
| validate-minikube: | |
| runs-on: ubuntu-latest | |
| needs: build-e2e | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| - name: Download build artifacts | |
| uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 | |
| with: | |
| name: build-artifacts | |
| path: build/ | |
| - name: Setup golang | |
| uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 # v6.0.0 | |
| with: | |
| go-version-file: go.mod | |
| - name: Setup Minikube | |
| run: minikube start --driver=docker | |
| - name: Make Zarf executable | |
| run: | | |
| chmod +x build/zarf | |
| # Before we run the regular tests we need to aggressively cleanup files to reduce disk pressure | |
| - name: Cleanup files | |
| uses: ./.github/actions/cleanup-files | |
| - name: Run tests | |
| run: | | |
| make test-e2e-with-cluster ARCH=amd64 | |
| - name: get cluster info | |
| uses: ./.github/actions/debug-cluster | |
| if: always() |