v0.21.1

Features

• Add new "prepare" stage for components scripts to perform actions on zarf package create by @jeff-mccoy in #660

  components:
    - name: prepare
      scripts:
        # Note this file will be created in this directory, regardless of where the package create command is called from
        prepare:
          - "touch test-prepare.txt"

Development

• Move to official github action for project issue automation by @renovate in #653

Dependencies

• Update module sigs.k8s.io/kustomize/api to v0.12.1 by @renovate in #656
• Update module github.com/sigstore/cosign to v1.10.1 by @renovate in #659
• Update module go to 1.19 by @renovate in #657
• Update module github.com/derailed/k9s to v0.26.3 by @renovate in #658

Full Changelog: v0.21.0...v0.21.1

v0.21.0

https://www.youtube.com/watch?v=WnOYlFVVKDE

⚠️ Breaking changes

• Move variable declaration from component to package level by @Racer159 in #621
• Remove pod-only data injection targets (now requires container in target) by @jeff-mccoy in #644

Features

• Full Linux ARM support by @jeff-mccoy in #651

• Package create & deploy variable overrides by @Racer159 in #621. This will allow new ways to template a Zarf Package during creation as seen in packages/zarf-agent/zarf.yaml. Additionally, constants and variables expand on the existing variables that existed at the component level and allow users to specify values at package deploy as well as prompt the user if they did not provide a value via a --set flag.

  Various examples found in examples/package-variables

  kind: ZarfPackageConfig
  metadata:
    name: package-variables
    description: "Test component to demonstrate package variables feature"
  
  # Demonstrates injecting custom constants into a K8s resource, e.g. ###ZARF_CONST_DINGO###
  constants:
    - name: "DINGO"
      value: "howl"
  
  # Demonstrates injecting custom variables into a K8s resource, e.g. ###ZARF_VAR_DOG###
  variables:
    - name: "WOLF"
    - name: "DOG"
      default: "woof"
    - name: "CAT"
      prompt: true
    - name: "FOX"
      default: "###ZARF_PKG_VAR_CONFIG_MAP###"
      prompt: true
  
  components:
    # Note that you must specify the ACTION and CONFIG_MAP i.e. `--set ACTION=template --set CONFIG_MAP=simple-configmap.yaml` during package create
    - name: variable-example
      description: "This component will ###ZARF_PKG_VAR_ACTION### variables within ###ZARF_PKG_VAR_CONFIG_MAP### during deploy"
      required: true
      manifests:
        - name: variable-example-configmap
          files:
            - "###ZARF_PKG_VAR_CONFIG_MAP###"

  A user being prompted for variable values on package deploy:
  

• Data injection compression & log output by @jeff-mccoy in #644

    dataInjections:
      # Injection in the root directory using data-loader init container
      - source: sample-data
        target:
          namespace: demo
          selector: app=data-injection
          container: data-loader
          path: /test
        compress: true

Fixes

• Fix Misspellings Across Repository by @elisoncrum in #641
• Fixes some data injection race conditions and stability concerns on larger datasets by @jeff-mccoy in #644

Development

• Always build & test Zarf Agent during pull requests; publish latest Zarf Agent on release by @jeff-mccoy in #651
• Correctly cleanup temp directory test by @jeff-mccoy in #654
• Change from kubectl exec -> kubectl logs for data injection test by @jeff-mccoy in #647

Docs

• Update contributor & testing guides by @jeff-mccoy in #642

Dependencies

• Update module github.com/google/go-containerregistry to v0.11.0 by @renovate in #633
• Update module helm.sh/helm/v3 to v3.9.2 by @renovate in #636
• Update golang.org/x/crypto digest to 630584e by @renovate in #639
• Update module github.com/pterm/pterm to v0.12.45 by @renovate in #637
• Update sigstore/cosign-installer action to v2.5.0 by @renovate in #645
• Update module github.com/sigstore/cosign to v1.10.0 by @renovate in #638
• Update module sigs.k8s.io/kustomize/kyaml to v0.13.8 by @renovate in #649
• Update module github.com/testifysec/go-witness to v0.1.12 by @renovate in #652
• Update module sigs.k8s.io/kustomize/api to v0.12.0 by @renovate in #650

New Contributors

• @elisoncrum made their first contribution in #641

Full Changelog: v0.20.0...v0.21.0

v0.20.0

Video update below:

⚠️ Breaking changes

• Remove shorthand zarf <package>|<zarf.yaml> and require package deploy or package create. Also warn users on attempt to use deprecated commands by @jeff-mccoy in #587 and #628

  Previous Shorthand	New Command
  zarf zarf-package-demo-amd64.tar.zst	zarf package deploy zarf-package-demo-amd64.tar.zst
  zarf zarf.yaml	zarf package create

  

• No longer automatically save git or docker credentials locally to support dynamic port binding by @jeff-mccoy in #586

Features

• Increase image push and git push reliability by adding retry logic and enabling dynamic port binding for tunnels during zarf package deploy operations by @jeff-mccoy in #586
  • This removes the need to reserve specific local ports to use Zarf or experience issues from stalled tunnel connections keeping the port bound
• Add component filtering based on cluster architecture and local operating system on zarf package deploy by @jeff-mccoy in #591
• Add zarf connect list for connect service lookup by @jeff-mccoy in #615
  
• Add tmpdir command flag and refactor CommonOptions by @Racer159 in #600
• Converts E2E tests to user journey tests & adds --no-progress flag for cleaner CI logs by @jeff-mccoy in #581
• Directly open to useful logs in Grafana on zarf connect logging by @jeff-mccoy in #615
  

• Add support for package deploy via cosign sget by @YrrepNoj in #550
  
• Add init package downloader by @jeff-mccoy in #506
  
• Better CLI Help Messages by @YrrepNoj in #505
• Support insecure docker registries during package creation by @jeff-mccoy in #500

  zarf package create --insecure

• Enable Zarf install via Homebrew for Mac and use GoReleaser for GitHub release workflow by @YrrepNoj in #498

  brew tap defenseunicorns/tap
  brew install zarf

• Add helm release name property to zarf chart by @dsmithbauer in #480

  - name: nginx-2
      charts:
      - name: nginx
          namespace: nginx
          url: https://charts.bitnami.com/bitnami
          version: 11.1.5
  
          # custom release name for this helm chart
          releaseName: nginx-2

  examples/helm-with-different-releaseName-values

Fixes

• Update gitea PATCH request to include 'login_name' key by @YrrepNoj in #603
• Refactor composed package logic to handle nested composes by @YrrepNoj in #588
• Fix registry user in credentials output by @rodneyxr in #578
• Fix zarf agent flux mutation by @jeff-mccoy in #572
• Produce better debug messages with JSON encoding instead of byte array dumps by @jeff-mccoy in #511
  

• Fully remove zarf secrets from all namespaces by @jeff-mccoy in #558
• Update target location for ekcstl for Darwin amd64 builds by @YrrepNoj in #516
• Injector stability improvements by @jeff-mccoy in #510

Packages & Examples

• Update bigbang and flux resources to release 1.37.0 by @brandtkeller in #609

• Upgrade K3s package to v1.24.1+k3s1 by @RothAndrew in #543
• fix kustomize path for big-bang core package by @jeff-mccoy in #508
• Golang and Helm chart dependency updates by @jeff-mccoy in #495

Docs

• Migrate https://docs.zarf.dev/ docs into this repo by @YrrepNoj in #590
• Fix dead link on getting started site by @mike-winberry in #596
• Add dashboard docs for sbom and k9s by @YrrepNoj in #598
• Basic Zarf walkthrough documentation by @YrrepNoj in #597
• Update docs and add prereq for zarf-registry by @Racer159 in #605
• RENAME .images folder in packages/big-bang-core by @mike-winberry in #612
• Update contributing.md testing instructions by @Racer159 in #619
• Fix link in docs by @UncleGedd in #623
• Update contrib docs with CONTRIBUTING.md by @Racer159 in #630

• Fixed broken bigbang link in examples README. by @mike-winberry in #547
• Add Homebrew instructions to docs by @ntwkninja in #503

Development

• Generate docs from zarf schema json by @Racer159 in #614
• Ignore non-code changes in CI for PRs to simplify docs updates by @jeff-mccoy in #599

• Configure Renovate by @renovate in #509
• • Fix goreleaser version by @jeff-mccoy in #507
• Update linter to only report new issues by @YrrepNoj in #504
• Add sign-off label to banned labels list to prevent merge by @YrrepNoj in #491
• Hidden tool command for generating docs by @YrrepNoj in #490

Dependencies

• Update module github.com/google/go-containerregistry to v0.10.0 by @renovate in #554
• Update module github.com/stretchr/testify to v1.7.5 by @renovate in #545
• Update module github.com/derailed/k9s to v0.25.20 by @renovate in #571
• Update module github.com/stretchr/testify to v1.8.0 by @renovate in #574
• Update sigstore/cosign-installer action to v2.4.1 by @renovate in #582
• Update golang.org/x/crypto digest to 0559593 by @renovate in #553
• Update module github.com/derailed/k9s to v0.25.21 by @renovate in #579
• Update module k8s.io/klog/v2 to v2.70.1 by @renovate in #594
• Update module helm.sh/helm/v3 to v3.9.1 by @renovate in #620
• Update kubernetes packages to v0.24.3 by @renovate in #622
• Update module github.com/derailed/k9s to v0.26.0 by @renovate in #629

• Update module github.com/pterm/pterm to v0.12.42 by @renovate in #548
• Update module github.com/spf13/cobra to v1.5.0 by @renovate in #549
• Update goreleaser build path by @jeff-mccoy in #567
• Update module github.com/derailed/k9s to v0.25.19 by @renovate in #568
• Update module github.com/AlecAivazis/survey/v2 to v2.3.5 by @renovate in #524
• Upda...

v0.19.6

Features

• Add support for package deploy via cosign sget by @YrrepNoj in #550
  

Known Issues

• The mutating webhook agent was updated to support UPDATE operations as well as CREATE, but there is a bug in it that you'll see as error message operation UPDATE is not registered or Unable to bind the webhook handler. If this issue is affecting you, you can use this patch:

  zarf package deploy sget://defenseunicorns/zarf-package-agent-hotfix:amd64
  kubectl -n flux-system rollout restart deployment/source-controller

  See #610 (comment) for complete details.

Fixes

• Fully remove zarf secrets from all namespaces by @jeff-mccoy in #558
• Make the agent mutate on update as well as create by @RothAndrew in #565
• Fixed broken bigbang link in examples README. by @mike-winberry in #547

Changes

• Update module github.com/pterm/pterm to v0.12.42 by @renovate in #548
• Update module github.com/spf13/cobra to v1.5.0 by @renovate in #549
• Update goreleaser build path by @jeff-mccoy in #567
• Update module github.com/derailed/k9s to v0.25.19 by @renovate in #568

Full Changelog: v0.19.5...v0.19.6

v0.19.5

Fixes

• Upgrade K3s package to v1.24.1+k3s1 by @RothAndrew in #543
• Update target location for ekcstl for Darwin amd64 builds by @YrrepNoj in #516

Changes

• Configure Renovate by @renovate in #509
• Update module github.com/AlecAivazis/survey/v2 to v2.3.5 by @renovate in #524
• Update module github.com/docker/cli to v20.10.17 by @renovate in #525
• Update module github.com/stretchr/testify to v1.7.2 by @renovate in #528
• Update helm/kind-action action to v1.3.0 by @renovate in #531
• Update module github.com/testifysec/go-witness to v0.1.11 by @renovate in #530
• Update leonsteinhaeuser/project-beta-automations action to v1.2.1 by @renovate in #532
• Update actions/checkout action to v3 by @renovate in #536
• Update actions/setup-go action to v3 by @renovate in #537
• Update sigstore/cosign-installer action to v2.4.0 by @renovate in #534
• Update docker/login-action action to v2 by @renovate in #541
• Update actions/upload-artifact action to v3 by @renovate in #540
• Update module github.com/sigstore/cosign to v1.9.0 by @renovate in #533

New Contributors

• @renovate made their first contribution in #509

Full Changelog: v0.19.4...v0.19.5

v0.19.4

Changes

• fix kustomize path for big-bang core package by @jeff-mccoy in #508
• Injector stability improvements by @jeff-mccoy in #510

Full Changelog: v0.19.3...v0.19.4

v0.19.3

Features

• Add init package downloader by @jeff-mccoy in #506
  

Fixes

• Fix goreleaser version by @jeff-mccoy in #507

Changes

• Update linter to only report new issues by @YrrepNoj in #504
• Better CLI Help Messages by @YrrepNoj in #505
• Add Homebrew instructions to docs by @ntwkninja in #503

New Contributors

• @ntwkninja made their first contribution in #503

Full Changelog: v0.19.2...v0.19.3

v0.19.2

Features

• Support insecure docker registries during package creation by @jeff-mccoy in #500

  zarf package create --insecure

• Enable Zarf install via Homebrew for Mac and use GoReleaser for GitHub release workflow by @YrrepNoj in #498

  brew tap defenseunicorns/tap
  brew install zarf

Full Changelog: v0.19.1...v0.19.2

v0.19.1

Features

• Add helm release name property to zarf chart by @dsmithbauer in #480

  - name: nginx-2
    charts:
      - name: nginx
        namespace: nginx
        url: https://charts.bitnami.com/bitnami
        version: 11.1.5
  
        # custom release name for this helm chart
        releaseName: nginx-2

  examples/helm-with-different-releaseName-values

Changes

• Hidden tool command for generating docs by @YrrepNoj in #490
• Add sign-off label to banned labels list to prevent merge by @YrrepNoj in #491
• Golang and Helm chart dependency updates by @jeff-mccoy in #495

New Contributors

• @dsmithbauer made their first contribution in #480

Full Changelog: v0.19.0...v0.19.1

v0.19.0

Features

• Zarf Agent mutating webhook by @jeff-mccoy in #306
  Users no longer need to manually change image paths for any type of deployment, including those done by 3rd-party gitops tools. Also supports auto-updating Flux GitRepository URLs.
  Zarf Agent Architectural Decision Record

• Add support for custom Zarf variables in k8s resources by @jeff-mccoy in #474

  - name: variable-example
    variables:
      dog: "woof"
      cat: "meow"

  examples/component-variables

• Implement component choice groups by @jeff-mccoy in #488

  - name: first-choice
    group: example-choice
  
  - name: second-choice
    group: example-choice
    default: true

  examples/component-choice

Fixes

• Use registry secrets by @vyta in #478
• Resolve env variable secrets in the docker registry helm chart by @jeff-mccoy in #473
• Fallback to host-provided git on clone failure during package create by @jeff-mccoy in #471

Changes

• Add flag --skip-sbom to package create to speed up dev packages by @jeff-mccoy in #470
• Add nav links to main example README by @YrrepNoj in #469
• Add Zarf Agent Github Action by @jeff-mccoy in #481

New Contributors

• @vyta made their first contribution in #478

Full Changelog: v0.18.0...v0.19.0