zarf command - github.com/zarf-dev/zarf

README ¶

Zarf - DevSecOps for Air Gap

Zarf eliminates the complexity of air gap software delivery for Kubernetes clusters and cloud-native workloads using a declarative packaging strategy to support DevSecOps in offline and semi-connected environments.

Why Use Zarf

💸 Free and Open-Source. Zarf will always be free to use and maintained by the open-source community.
⭐️ Zero Dependencies. As a statically compiled binary, the Zarf CLI has zero dependencies to run on any machine.
🔓 No Vendor Lock. There is no proprietary software that locks you into using Zarf. If you want to remove it, you can still use your Helm charts to deploy your software manually.
💻 OS Agnostic. Zarf supports numerous operating systems. A full matrix of supported OSes, architectures, and feature sets is coming soon.
📦 Highly Distributable. Integrate and deploy software from multiple secure development environments, including edge, embedded systems, secure cloud, data centers, and even local environments.
🚀 Develop Connected, Deploy Disconnected. Teams can build and configure individual applications or entire DevSecOps environments while connected to the internet. Once created, they can be packaged and shipped to a disconnected environment to be deployed.
💿 Single File Deployments. Zarf allows you to package the parts of the internet your app needs into a single compressed file to be installed without connectivity.
♻️ Declarative Deployments. Zarf packages define the precise state for your application, enabling it to be deployed the same way every time.
🦖 Inherit Legacy Code. Zarf packages can wrap legacy code and projects - allowing them to be deployed to modern DevSecOps environments.

📦 Out of the Box Features

Automate Kubernetes deployments in disconnected environments
Automate Software Bill of Materials (SBOM) generation
Build and publish packages as OCI image artifacts
Provide a web dashboard for viewing SBOM output
Create and verify package signatures with cosign
Publish, pull, and deploy packages from an OCI registry
Powerful component lifecycle actions
Deploy a new cluster while fully disconnected with K3s or into any existing cluster using a kube config
Built-in Git server with Gitea
Built-in Docker registry
Builtin K9s Dashboard for managing a cluster from the terminal
Mutating Webhook to automatically update Kubernetes pod's image path and pull secrets as well as Flux Git Repository URLs and secret references
Builtin command to find images and resources from a Helm chart
Tunneling capability to connect to Kubernetes resources without network routing, DNS, TLS or Ingress configuration required

🛠️ Configurable Features

Customizable variables and package templates with defaults and user prompting
Composable packages to include multiple sub-packages/components
Component-level OS/architecture filtering

Demo

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

✅ Getting Started

Follow the instructions at https://docs.zarf.dev/getting-started/.

To discover more about Zarf and explore its features, please visit docs.zarf.dev. The documentation offers in-depth insights on:

Using Zarf in GitHub workflows? Check out the setup-zarf action. Install any version of Zarf and its init package with zero added dependencies.

🫶 Our Community

Join us on the Kubernetes Slack in the #zarf channel or the #zarf-dev channel! Our active community of developers, users, and contributors are available to answer questions, share examples, and find new ways use Zarf together!

We are so grateful to our Zarf community for contributing bug fixes and collaborating on new features:

Made with contrib.rocks.

💻 Contributing

Check out our Contributor Guide to learn more about how to set up your development environment and begin contributing. We also recommend checking out our architectural diagram.

To dive deeper into the tech, you can read the Nerd Notes in our Docs.

Architecture Diagram

⭐️ Special Thanks

Early Zarf research and prototypes were developed jointly with United States Naval Postgraduate School research you can read here.

We would also like to thank the following awesome libraries and projects without which Zarf would not be possible!

Documentation ¶

Overview ¶

Package main is the entrypoint for the Zarf binary.

Source Files ¶

View all Source files

main.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
hack
schema Module
src
api/v1alpha1 Package v1alpha1 holds the definition of the v1alpha1 Zarf Package	Package v1alpha1 holds the definition of the v1alpha1 Zarf Package
api/v1beta1 Package v1beta1 holds the definition of the v1beta1 Zarf Package	Package v1beta1 holds the definition of the v1beta1 Zarf Package
cmd Package cmd contains the CLI commands for Zarf.	Package cmd contains the CLI commands for Zarf.
cmd/common Package common handles command configuration across all commands	Package common handles command configuration across all commands
cmd/say Package say prints out the adorable creature we all know and love.	Package say prints out the adorable creature we all know and love.
cmd/tools Package tools contains the CLI commands for Zarf.	Package tools contains the CLI commands for Zarf.
cmd/tools/helm Package helm is a copy of the main package from helm to include a subset of the helm CLI in Zarf	Package helm is a copy of the main package from helm to include a subset of the helm CLI in Zarf
config Package config stores the global configuration and constants.	Package config stores the global configuration and constants.
config/lang Package lang contains the language strings for english used by Zarf Alternative languages can be created by duplicating this file and changing the build tag to "//go:build alt_language && <language>".	Package lang contains the language strings for english used by Zarf Alternative languages can be created by duplicating this file and changing the build tag to "//go:build alt_language && <language>".
internal/agent Package agent holds the mutating webhook server.	Package agent holds the mutating webhook server.
internal/agent/hooks Package hooks contains the mutation hooks for the Zarf agent.	Package hooks contains the mutation hooks for the Zarf agent.
internal/agent/http Package http provides a http server for the webhook and proxy.	Package http provides a http server for the webhook and proxy.
internal/agent/http/admission Package admission provides an HTTP handler for a Kubernetes admission webhook.	Package admission provides an HTTP handler for a Kubernetes admission webhook.
internal/agent/operations Package operations provides functions for the mutating webhook.	Package operations provides functions for the mutating webhook.
internal/dns Package dns contains DNS related functionality.	Package dns contains DNS related functionality.
internal/git Package git contains functions for interacting with git repositories.	Package git contains functions for interacting with git repositories.
internal/gitea Package gitea contains Gitea client specific functionality.	Package gitea contains Gitea client specific functionality.
internal/healthchecks Package healthchecks run kstatus style health checks on a list of objects	Package healthchecks run kstatus style health checks on a list of objects
internal/packager/helm Package helm contains operations for working with helm charts.	Package helm contains operations for working with helm charts.
internal/packager/images Package images provides functions for building and pushing images.	Package images provides functions for building and pushing images.
internal/packager/kustomize Package kustomize provides functions for building kustomizations.	Package kustomize provides functions for building kustomizations.
internal/packager/sbom Package sbom contains tools for generating SBOMs.	Package sbom contains tools for generating SBOMs.
internal/packager/template Package template provides functions for templating yaml files.	Package template provides functions for templating yaml files.
internal/packager2 Package packager2 contains functions for inspecting packages.	Package packager2 contains functions for inspecting packages.
internal/packager2/layout Package layout contains functions for inteacting the Zarf packages.	Package layout contains functions for inteacting the Zarf packages.
pkg/cluster Package cluster contains Zarf-specific cluster management functions.	Package cluster contains Zarf-specific cluster management functions.
pkg/interactive Package interactive contains functions for interacting with the user via STDIN.	Package interactive contains functions for interacting with the user via STDIN.
pkg/layout Package layout contains functions for interacting with Zarf's package layout on disk.	Package layout contains functions for interacting with Zarf's package layout on disk.
pkg/lint Package lint contains functions for verifying zarf yaml files are valid	Package lint contains functions for verifying zarf yaml files are valid
pkg/logger Package logger implements a log/slog based logger in Zarf.	Package logger implements a log/slog based logger in Zarf.
pkg/message Package message provides a rich set of functions for displaying messages to the user.	Package message provides a rich set of functions for displaying messages to the user.
pkg/packager Package packager contains functions for interacting with, managing and deploying Zarf packages.	Package packager contains functions for interacting with, managing and deploying Zarf packages.
pkg/packager/actions Package actions contains functions for running component actions within Zarf packages.	Package actions contains functions for running component actions within Zarf packages.
pkg/packager/composer Package composer contains functions for composing components within Zarf packages.	Package composer contains functions for composing components within Zarf packages.
pkg/packager/creator Package creator contains functions for creating Zarf packages.	Package creator contains functions for creating Zarf packages.
pkg/packager/deprecated Package deprecated handles package deprecations and migrations	Package deprecated handles package deprecations and migrations
pkg/packager/filters Package filters contains core implementations of the ComponentFilterStrategy interface.	Package filters contains core implementations of the ComponentFilterStrategy interface.
pkg/packager/sources Package sources contains core implementations of the PackageSource interface.	Package sources contains core implementations of the PackageSource interface.
pkg/pki Package pki provides a simple way to generate a CA and signed server keypair.	Package pki provides a simple way to generate a CA and signed server keypair.
pkg/transform Package transform provides helper functions to transform URLs to airgap equivalents	Package transform provides helper functions to transform URLs to airgap equivalents
pkg/utils Package utils provides generic utility functions.	Package utils provides generic utility functions.
pkg/utils/exec Package exec provides a wrapper around the os/exec package	Package exec provides a wrapper around the os/exec package
pkg/variables Package variables contains functions for interacting with variables	Package variables contains functions for interacting with variables
pkg/zoci Package zoci contains functions for interacting with Zarf packages stored in OCI registries.	Package zoci contains functions for interacting with Zarf packages stored in OCI registries.
test Package test provides e2e tests for Zarf.	Package test provides e2e tests for Zarf.
test/external Package external provides a test for interacting with external resources	Package external provides a test for interacting with external resources
test/testutil Package testutil provides global testing helper functions	Package testutil provides global testing helper functions
types Package types contains all the types used by Zarf.	Package types contains all the types used by Zarf.
api Module