README
¶
Zarf Distro
This tool is designed for two purposes
- Create an offline kubernetes distro tar ball
- Boot strap a cluster
Inspiration
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
src
|
|
|
api
Package api for core logic shared between the api resources
|
Package api for core logic shared between the api resources |
|
api/zarf.dev/v1alpha1
Package v1alpha1 is for the shared File logic across both the cluster and distro api's
|
Package v1alpha1 is for the shared File logic across both the cluster and distro api's |
|
api/zarf.dev/v1alpha1/cluster
Package cluster is for the api representation of Cluster
|
Package cluster is for the api representation of Cluster |
|
api/zarf.dev/v1alpha1/distro
Package distro is for the api representation of Distro Package
|
Package distro is for the api representation of Distro Package |
|
cmd
Package cmd is where the commands for cargoship
|
Package cmd is where the commands for cargoship |
|
config
Package config is a holder of commonly used multiple times
|
Package config is a holder of commonly used multiple times |
|
config/lang
Package lang holds the cli helping text
|
Package lang holds the cli helping text |
|
internal/clustercfg
Package clustercfg is used to parse an byte array and returns a ZarfCluster
|
Package clustercfg is used to parse an byte array and returns a ZarfCluster |
|
internal/distrocfg
Package distrocfg is used to parse an byte array and returns a ZarfDistro
|
Package distrocfg is used to parse an byte array and returns a ZarfDistro |
|
internal/gen-docs
command
package main is used to generate the markdown docs for the cli
|
package main is used to generate the markdown docs for the cli |
|
internal/riglogger
Package riglogger add settings that overrides the rig.Logger
|
Package riglogger add settings that overrides the rig.Logger |
|
internal/schema
command
package main is used to generate the json schema for various objects
|
package main is used to generate the json schema for various objects |
|
pkg/action
Package action are various actions used by the package
|
Package action are various actions used by the package |
|
pkg/distro
Package distro is used for creating/deploying distro package
|
Package distro is used for creating/deploying distro package |
|
pkg/node
Package node is used for status related functions
|
Package node is used for status related functions |
|
pkg/packager
Package packager for interacting with a packages distro config
|
Package packager for interacting with a packages distro config |
|
pkg/packager/layout
Package layout is used to defining the distro package files
|
Package layout is used to defining the distro package files |
|
pkg/packager/load
Package load for loading a given package
|
Package load for loading a given package |
|
pkg/phase
Package phase is all the various phases used for bootstrapping a cluster.
|
Package phase is all the various phases used for bootstrapping a cluster. |
|
pkg/retry
Package retry provides simple retry wrappers for functions that return an error
|
Package retry provides simple retry wrappers for functions that return an error |
|
pkg/utils
Package utils is for commonly used functions
|
Package utils is for commonly used functions |
|
types
Package types is a little bit of a hacky way to generate the cargo-ship-config jsonschema
|
Package types is a little bit of a hacky way to generate the cargo-ship-config jsonschema |
|
types/distrocfg
Package distrocfg defines the standard interface that all distro config settings
|
Package distrocfg defines the standard interface that all distro config settings |
|
types/distrocfg/registry
Package registry is used to register a distro
|
Package registry is used to register a distro |
|
types/os
Package os is for running commands on a remote host
|
Package os is for running commands on a remote host |
|
types/os/linux
Package linux is implementing the interface github.com/colonel-byte/cargoship/src/types/os.Configurer for Linux based hosts
|
Package linux is implementing the interface github.com/colonel-byte/cargoship/src/types/os.Configurer for Linux based hosts |
|
types/os/linux/enterpriselinux
Package enterpriselinux is implementing the interface github.com/colonel-byte/cargoship/src/types/os.Configurer for Enterprise Linux hosts
|
Package enterpriselinux is implementing the interface github.com/colonel-byte/cargoship/src/types/os.Configurer for Enterprise Linux hosts |
Click to show internal directories.
Click to hide internal directories.