v0.13.1

[RothAndrew]

⚠️ Contains breaking changes

Until we finish migrating from Repo1 to GitHub the release artifacts can be found HERE.

What's Changed

⚠️ BREAKING: The private container registry that zarf init deploys now requires auth

Packages will need to include imagePullSecrets: in their pod manifests and a corresponding regcred. See the Kubernetes documentation for more information. Using the special string ###ZARF_DOCKERAUTH### in your manifests will be automatically picked up by Zarf during package deploy and replaced with a properly formatted auth string, which is the base64 encoded username:password

Here's an example of a valid Secret manifest for images that originated from Registry1 or DockerHub (K3s automatically redirects them to the private registry):

apiVersion: v1
kind: Secret
type: kubernetes.io/dockerconfigjson
metadata:
  name: private-registry
  namespace: my-cool-app
stringData:
  .dockerconfigjson: |
    {
      "auths": {
        "registry1.dso.mil": {
          "auth":"###ZARF_DOCKERAUTH###"
        },
        "docker.io": {
          "auth":"###ZARF_DOCKERAUTH###"
        }
      }
    }

Deploy remote packages

Now you can run zarf package deploy on remote packages.

Example:

# Naughty way
zarf package deploy https://example.com/some-package.tar.zst --insecure

# Good way
zarf package deploy https://example.com/some-package.tar.zst --shasum 15h1oi2h5ni1o2y5iunb1t25bui1t25gnu12n5

Full Changelog

Note: The v0.13.0 release was aborted due to a missing credential in the release pipeline. This release replaces v0.13.0 with the only change being referencing the new credential in the release pipeline yaml. We do it this way because we believe artifacts should be immutable.

• Terratest e2e test #93 - Add E2E test framework with Terratest
• feat: examples vagrant auto 'sudo su' #91 - Simplify the Vagrant workflow when running the examples
• GitHub Actions CI Pipeline Baseline #94 - Add framework for GitHub Actions with pull request chatops dispatching
• Add the Terratest E2E test work to the CI pipeline #95 - Integrate the E2E tests with the GitHub Actions pipeline
• Add CONTRIBUTING.md #103 - Add Contributor Guide
• Fix Big Bang example NetworkPolicy CIDRs #104 - Roll back changes to the Big Bang example NetworkPolicy CIDRs for better demo compatibility
• Prep the GitHub Actions setup for handling more than one E2E test #106 & Add a 2nd E2E test #110 - Add more E2E tests
• Pre-commit and linting #112 - Add pre-commit hooks
• README revamp #98 - Beginnings of an overhaul on the repo's documentation
• Add Zarf Version to CLI options #116 - Add zarf version command
• make build-test doesn't work properly on mac m1 #117 - Fix the Makefiles for compatibility with M1 Macs
• Update kubescape version in Big Bang Core example #111 - Update the version of kubescape in the Big Bang Core example
• docs: game example README --> "Get Started" doc #124 - Add "Get Started" documentation for running the Doom game example
• Update Helm to v3.7.0 #126 - Update Helm library to v3.7.0
• Deploying nonexistent components #107 - Add check to make sure all components passed in --components flag exist
• Docs/130 zarf components #135 - Add Zarf Components documentation
• Validate user provided hostnames do not contain any illegal characters #128 - Add check for illegal characters in entered hostnames
• Add flag for setting log levels and log errors for debugging. #139 - Add flag for setting the log level
• Unify to one go.mod so VS Code is happy #147 - Unify to one go.mod to make VS Code happy
• Run pre-commit run -a on the whole codebase #151 - Run pre-commit run -a an the codebase
• Add ability to deploy remote packages #143 - Add ability to deploy remote packages
• docs: Add Logging example README #157 - Add Logging documentation
• Remove unnecessary logging package and set log level in root #156 - Remove unnecessary logging package and set log level in root
• Update GitHub Actions pipeline to use the new robot account for Registry1 #158 - Update GitHub Actions pipeline to use the new robot account for Registry1
• Add authentication to utility registry #144 - Add authentication to utility registry
• Fix the GitLab release pipeline #160 - Fix the GitLab release pipeline

---

This discussion was created from the release v0.13.1.