Documentation
¶
Overview ¶
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
Index ¶
Constants ¶
const ( // LoggingLevelDefault path in config LoggingLevelDefault = "info" // DistroCreateOutput path in config DistroCreateOutput = "distro.create.output" // DistroOCIConcurrency path in config DistroOCIConcurrency = "distro.oci_concurrency" // DistroCreateRegistryOverride path in config DistroCreateRegistryOverride = "distro.create.registry_override" // DistroCreateSkipSbom path in config DistroCreateSkipSbom = "distro.create.skip_sbom" // DistroConcurrency path in config DistroConcurrency = "distro.concurrency" // DistroWorkerConcurrency path in config DistroWorkerConcurrency = "distro.worker_concurrency" // DistroFAPolicy path in config DistroFAPolicy = "distro.fapolicy" // DistroUpdateHost path in config DistroUpdateHost = "distro.host_update" // DistroUpdateFirewall path in config DistroUpdateFirewall = "distro.firewall_update" // DistroResetDistro path in config DistroResetDistro = "distro.reset.distro" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApplyOptions ¶
type ApplyOptions struct{}
ApplyOptions holds the values for the `.distro.apply` section of the config file
type DistroConfig ¶
type DistroConfig struct {
//keep-sorted start
// CachePath is the folder where oras artifacts are stored
CachePath string `json:"zarf_cache,omitempty"`
// DistroOpts are various options used by the command
DistroOpts DistroOptions `json:"distro,omitempty"`
// LogFormat how the logs are displayed well running
LogFormat string `json:"log_format,omitempty" jsonschema:"enum=console,enum=json,enum=dev,default=console"`
// LogLevel the level of logs that will be displayed
LogLevel string `json:"log_level,omitempty" jsonschema:"enum=warn,enum=info,enum=debug,enum=trace,default=info"`
// TempDirectory the directory where we store stuff before deleting them
TempDirectory string `json:"tmp_dir,omitempty" jsonschema:"default=/tmp"`
// Timeout the longest we will run long ran tasks before failing
Timeout string `json:"timeout,omitempty" jsonschema:"default=20m"`
}
DistroConfig holds the values for the `.`, or root, section of the config file
type DistroCreateOptions ¶
type DistroCreateOptions struct {
//keep-sorted start
// Output the folder that we will create the distro tar balls in
Output string `json:"output,omitempty"`
// SkipSBOM whether we will scan the images or files
SkipSBOM bool `json:"skip_sbom,omitempty"`
}
DistroCreateOptions holds the values for the `.distro.create` section of the config file
type DistroDeployOptions ¶
type DistroDeployOptions struct {
// Retries how many times we will try to push a package
Retries int `json:"retries,omitempty"`
}
DistroDeployOptions holds the values for the `.distro.deploy` section of the config file
type DistroOptions ¶
type DistroOptions struct {
// CreateOpts are options used by the create subcommand
CreateOpts DistroCreateOptions `json:"create,omitempty"`
// DeployOpts are options used by the deploy subcommand
DeployOpts DistroDeployOptions `json:"deploy,omitempty"`
// ApplyOpts are options used by the apply subcommand
ApplyOpts ApplyOptions `json:"apply,omitempty"`
// ResetOptions are options used by the reset subcommand
ResetOpts ResetOptions `json:"reset,omitempty"`
// OCIConcurrency is how many concurrent oci artifacts that will be pushed at a time
OCIConcurrency int `json:"oci_concurrency,omitempty"`
// Concurrency how many nodes we will try to interact with at a time, 0 means that all nodes will be done at once
Concurrency int `json:"concurrency,omitempty" jsonschema:"minimum=0"`
// FAPolicyd whether we will update hosts with fapolicyd
FAPolicyd bool `json:"fapolicy,omitempty" jsonschema:"default=true"`
// FirewallUpdate whether we will update the host firewall
FirewallUpdate bool `json:"firewall_update,omitempty" jsonschema:"default=true"`
// HostUpdate whether we will update the etc host file
HostUpdate bool `json:"host_update,omitempty" jsonschema:"default=true"`
// WorkerConcurrency number of worker nodes that will be upgraded at once
WorkerConcurrency int `json:"worker_concurrency,omitempty" jsonschema:"minimum=0"`
}
DistroOptions holds the values for the `.distro` section of the config file
type ResetOptions ¶
type ResetOptions struct {
// Distro that is used to determine how to remove files
Distro string `json:"distro,omitempty" jsonschema:"enum=rke2,enum=k3s"`
}
ResetOptions holds the values for the `.distro.reset` section of the config file
Directories
¶
| Path | Synopsis |
|---|---|
|
Package distrocfg defines the standard interface that all distro config settings
|
Package distrocfg defines the standard interface that all distro config settings |
|
registry
Package registry is used to register a distro
|
Package registry is used to register a distro |
|
Package os is for running commands on a remote host
|
Package os is for running commands on a remote host |
|
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 |
|
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 |