Directories
¶
| Path | Synopsis |
|---|---|
|
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. |
|
common
Package common handles command configuration across all commands
|
Package common handles command configuration across all commands |
|
tools
Package tools contains the CLI commands for Zarf.
|
Package tools contains the CLI commands for Zarf. |
|
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 |
|
Package config stores the global configuration and constants.
|
Package config stores the global configuration and constants. |
|
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. |
|
agent/hooks
Package hooks contains the mutation hooks for the Zarf agent.
|
Package hooks contains the mutation hooks for the Zarf agent. |
|
agent/http
Package http provides a http server for the webhook and proxy.
|
Package http provides a http server for the webhook and proxy. |
|
agent/operations
Package operations provides functions for the mutating webhook.
|
Package operations provides functions for the mutating webhook. |
|
agent/state
Package state provides helpers for interacting with the Zarf agent state.
|
Package state provides helpers for interacting with the Zarf agent state. |
|
api
Package api provides the UI API server.
|
Package api provides the UI API server. |
|
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. |
|
api/cluster
Package cluster contains Zarf-specific cluster management functions.
|
Package cluster contains Zarf-specific cluster management functions. |
|
api/common
Package common provides common functions for the api.
|
Package common provides common functions for the api. |
|
api/components
Package components provides api functions for managing Zarf components.
|
Package components provides api functions for managing Zarf components. |
|
api/packages
Package packages provides api functions for managing Zarf packages.
|
Package packages provides api functions for managing Zarf packages. |
|
cluster
Package cluster contains Zarf-specific cluster management functions.
|
Package cluster contains Zarf-specific cluster management functions. |
|
packager/git
Package git contains functions for interacting with git repositories.
|
Package git contains functions for interacting with git repositories. |
|
packager/helm
Package helm contains operations for working with helm charts.
|
Package helm contains operations for working with helm charts. |
|
packager/images
Package images provides functions for building and pushing images.
|
Package images provides functions for building and pushing images. |
|
packager/kustomize
Package kustomize provides functions for building kustomizations.
|
Package kustomize provides functions for building kustomizations. |
|
packager/sbom
Package sbom contains tools for generating SBOMs.
|
Package sbom contains tools for generating SBOMs. |
|
packager/template
Package template provides functions for templating yaml files.
|
Package template provides functions for templating yaml files. |
|
packager/validate
Package validate provides Zarf package validation functions.
|
Package validate provides Zarf package validation 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. |
|
k8s
Package k8s provides a client for interacting with a Kubernetes cluster.
|
Package k8s provides a client for interacting with a Kubernetes cluster. |
|
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. |
|
oci
Package oci contains functions for interacting with Zarf packages stored in OCI registries.
|
Package oci contains functions for interacting with Zarf packages stored in OCI registries. |
|
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. |
|
packager/deprecated
Package deprecated handles package deprecations and migrations
|
Package deprecated handles package deprecations and migrations |
|
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. |
|
transform
Package transform provides helper functions to transform URLs to airgap equivalents
|
Package transform provides helper functions to transform URLs to airgap equivalents |
|
utils
Package utils provides generic utility functions.
|
Package utils provides generic utility functions. |
|
utils/exec
Package exec provides a wrapper around the os/exec package
|
Package exec provides a wrapper around the os/exec package |
|
utils/helpers
Package helpers provides generic helper functions with no external imports
|
Package helpers provides generic helper functions with no external imports |
|
Package test provides e2e tests for Zarf.
|
Package test provides e2e tests for Zarf. |
|
external
Package external provides a test for interacting with external resources
|
Package external provides a test for interacting with external resources |
|
mocks
Package mocks contains all the mocks used in Zarf tests.
|
Package mocks contains all the mocks used in Zarf tests. |
|
Package types contains all the types used by Zarf.
|
Package types contains all the types used by Zarf. |
|
extensions
Package extensions contains the types for all official extensions.
|
Package extensions contains the types for all official extensions. |
Click to show internal directories.
Click to hide internal directories.