zarf

command module

v0.25.0-rc1 Latest Latest Go to latest Published: Mar 4, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

README ¶

Zarf - DevSecOps for Air Gap

	Build Status
Zarf
Zarf Documentation

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.

📦 Out of the Box Features

Automate Kubernetes deployments in disconnected environments
Automate Software Bill of Materials (SBOM) generation
Provide a web dashboard for viewing SBOM output
Deploy a new cluster while fully disconnected with K3s or into any existing cluster using a kube config
Builtin logging stack with Loki
Builtin git server with Gitea
Builtin 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 Kuberenetes resources without network routing, DNS, TLS or Ingress configuration required

🛠️ Configurable Features

Customizable packages variables with defaults and user prompting
Composable packages to include multiple sub-packages/components
Filters to select the correct architectures/operating systems for packages

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

Demo

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

Getting Started

To try Zarf out for yourself, visit the "Try It Now" section on our website, and if you want to learn more about Zarf and its use cases visit docs.zarf.dev.

From the docs you can learn more about installation, using the CLI, making packages, and the Zarf package schema.

Using Zarf in Github workflows? Check out the setup-zarf](https://github.com/defenseunicorns/setup-zarf) action. Install any version of Zarf and its init package with zero added dependencies.

Developing

To contribute, please see our Contributor Guide. Below is an architectural diagram showing the basics of how Zarf functions which you can read more about here.

Architecture Diagram

Source DrawIO

Special Thanks

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
cli module
src
cmd Package cmd contains the CLI commands for Zarf contains the CLI commands for Zarf.	Package cmd contains the CLI commands for Zarf contains the CLI commands for Zarf.
cmd/tools Package tools contains the CLI commands for Zarf.	Package tools contains the CLI commands for 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>".
extensions/bigbang Package bigbang contains the logic for installing Big Bang and Flux	Package bigbang contains the logic for installing Big Bang and Flux
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 agent.	Package http provides a http server for the agent.
internal/agent/operations Package operations provides functions for the mutating webhook.	Package operations provides functions for the mutating webhook.
internal/api Package api provides the UI API server.	Package api provides the UI API server.
internal/api/auth Package auth provides an endpoint for authenticating against the Zarf UI server.	Package auth provides an endpoint for authenticating against the Zarf UI server.
internal/api/cluster Package cluster contains Zarf-specific cluster management functions.	Package cluster contains Zarf-specific cluster management functions.
internal/api/common Package common provides common functions for the api.	Package common provides common functions for the api.
internal/api/components Package components provides api functions for managing Zarf components.	Package components provides api functions for managing Zarf components.
internal/api/packages Package packages provides api functions for managing Zarf packages.	Package packages provides api functions for managing Zarf packages.
internal/cluster Package cluster contains Zarf-specific cluster management functions.	Package cluster contains Zarf-specific cluster management functions.
internal/packager/git Package git contains functions for interacting with git repositories.	Package git contains functions for interacting with git repositories.
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/packager/validate Package validate provides Zarf package validation functions.	Package validate provides Zarf package validation functions.
pkg/k8s Package k8s provides a client for interacting with a Kubernetes cluster.	Package k8s provides a client for interacting with a Kubernetes cluster.
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/deprecated Package deprecated handles package deprecations and migrations	Package deprecated handles package deprecations and migrations
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/utils Package utils provides generic helper functions.	Package utils provides generic helper functions.
pkg/utils/exec Package exec provides a wrapper around the os/exec package	Package exec provides a wrapper around the os/exec package
test/e2e Package test provides e2e tests for Zarf.	Package test provides e2e tests for Zarf.
test/external-test Package external_test provides a test for the external init flow.	Package external_test provides a test for the external init flow.
test/mocks Package mocks contains all the mocks used in Zarf tests.	Package mocks contains all the mocks used in Zarf tests.
types Package types contains all the types used by Zarf.	Package types contains all the types used by Zarf.
types/extensions Package extensions contains the types for all official extensions.	Package extensions contains the types for all official extensions.
test
e2e Module