Documentation
¶
Overview ¶
Package api defines types shared across cargoship's API groups.
Package api holds core logic shared by the API resource packages.
Index ¶
Constants ¶
const BuildTimestampFormat = time.RFC1123Z
BuildTimestampFormat is the timestamp layout used in log output.
Variables ¶
var ErrUnknownArch = fmt.Errorf("invalid platform operating system architecture")
ErrUnknownArch is returned for a CPU architecture cargoship does not support.
Functions ¶
func FormatArches ¶ added in v0.20.0
FormatArches renders architectures as a comma separated list, for error messages and logs.
Types ¶
type Arch ¶ added in v0.20.0
type Arch string
Arch names a CPU architecture a package can target.
const ( // ArchAMD64 is the x86-64, 64-bit AMD, architecture. ArchAMD64 Arch = "amd64" // ArchARM64 is the 64-bit ARM architecture. ArchARM64 Arch = "arm64" // ArchRISCV is the 64-bit RISC-V architecture. ArchRISCV Arch = "riscv64" )
These are the CPU architectures cargoship supports targeting.
func ParseArch ¶ added in v0.20.0
ParseArch converts a raw architecture string into an Arch, rejecting anything cargoship does not support. Use it at the boundaries where an architecture arrives as free text, such as a command line flag or the output of uname on a remote host.
func (Arch) JSONSchemaExtend ¶ added in v0.20.0
func (Arch) JSONSchemaExtend(s *jsonschema.Schema)
JSONSchemaExtend lists the supported architectures as the enum for a single architecture, so the schema and Validate stay in step with the arches list.
type Arches ¶ added in v0.20.0
type Arches []Arch
Arches is a list of CPU architectures.
func (Arches) JSONSchemaExtend ¶ added in v0.20.0
func (Arches) JSONSchemaExtend(s *jsonschema.Schema)
JSONSchemaExtend applies the supported architecture enum to each item in the list and requires the entries to be unique.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
zarf.dev
|
|
|
v1alpha1
Package v1alpha1 defines file types shared by the cluster and distro APIs.
|
Package v1alpha1 defines file types shared by the cluster and distro APIs. |
|
v1alpha1/cluster
Package cluster defines the API types for a cluster configuration.
|
Package cluster defines the API types for a cluster configuration. |
|
v1alpha1/distro
Package distro defines the API types for a distro package.
|
Package distro defines the API types for a distro package. |