cluster

type ZarfCluster struct {
	APIVersion      string                  `json:"apiVersion,omitempty" jsonschema:"enum=zarf.dev/v1alpha1"`
	Kind            v1alpha1.ZarfDistroKind `json:"kind" jsonschema:"enum=ZarfCluster"`
	Metadata        ZarfClusterMetadata     `json:"metadata"`
	Spec            ZarfClusterSpec         `json:"spec"`
	RuntimeMetadata ZarfRuntimeMeta         `json:"-"`
}

type ZarfClusterConfig struct {
	LoadBalancer string                         `json:"loadbalancer" jsonschema:"format=hostname"`
	Registries   []ZarfClusterRegistries        `json:"registries,omitempty"`
	Profiles     map[string]ZarfClusterProfiles `json:"profiles,omitempty"`
}

type ZarfClusterFiles struct {
	Name                 string `json:"name"`
	Source               string `json:"src,omitempty"`
	Destination          string `json:"dst,omitempty"`
	DestinationDirectory string `json:"dstDir,omitempty"`
	Permission           string `json:"perm,omitempty"`
	User                 string `json:"user,omitempty" jsonschema:"example=root"`
	Group                string `json:"group,omitempty" jsonschema:"example=root"`
	Data                 string `json:"data,omitempty"`
}

type ZarfClusterMetadata struct {
	// Name acts as the name of the cluster if you allow cargoship to add it to the kubeconfig
	Name string `json:"name" jsonschema:"pattern=^[a-z0-9][a-z0-9\\-]*$"`
}

type ZarfClusterProfiles struct {
	Host   ZarfHostConfig `json:"host,omitempty"`
	Engine ZarfHostEngine `json:"engine,omitempty"`
}

type ZarfClusterRegistries struct {
	// Name of the registry
	Name string `json:"name"`
	// Authentication for the registry
	Authentication ZarfClusterRegistryAuth `json:"auth,omitempty"`
	// Proxy for the registry
	Proxy ZarfClusterRegistryProxy `json:"proxy"`
}

type ZarfClusterRegistryAuth struct {
	// Username for the remote registry
	Username string `json:"user,omitempty"`
	// Password for the remote registry
	Password string `json:"pass,omitempty"`
	// Token for the remote registry
	Token string `json:"token,omitempty"`
}

type ZarfClusterRegistryProxy struct {
	// URL to the registry that will engine will now pull from
	URL string `json:"url"`
}

type ZarfClusterSpec struct {
	Config ZarfClusterConfig `json:"config"`
	Hosts  ZarfHosts         `json:"hosts" jsonschema:"minItems=1"`
}

type ZarfFirewallPolicyConfig struct {
	XMLName xml.Name           `xml:"policy" json:"-"`
	Short   string             `xml:"short,omitempty" json:"-"`
	Target  string             `xml:"target,attr,omitempty" json:"target" jsonschema:"enum=CONTINUE,enum=ACCEPT,enum=REJECT,enum=DROP"`
	Ingress ZarfFirewallZone   `xml:"ingress-zone"`
	Egress  ZarfFirewallZone   `xml:"egress-zone"`
	Ports   []ZarfFirewallPort `xml:"port,omitempty" json:"ports,omitempty"`
}

type ZarfFirewallPort struct {
	// Protocol the type of allowed traffic
	Protocol string `xml:"protocol,attr" json:"protocol" jsonschema:"enum=tcp,enum=udp,enum=sctp,enum=dccp"`
	// Port the port number, or range, that will be opened
	Port string `xml:"port,attr" json:"port" jsonschema:"oneof_type=string;integer"`
}

type ZarfFirewallZone struct {
	Name string `xml:"name,attr" jsonschema:"example=trusted,example=public"`
}

type ZarfHost struct {
	// Connection is a Struct you can embed into your application's "Host" types
	// to give them multi-protocol connectivity.
	rig.Connection `json:",inline"`
	// Environment a map of environment variables that will be populated on the host system
	Environment map[string]string `json:"environment,omitempty"`
	// Files that will be uploaded to a host
	Files []ZarfClusterFiles `json:"files,omitempty"`
	// Hostname overrides the name of the node
	Hostname string `json:"hostname,omitempty"`
	// PrivateAddress override the given private address
	PrivateAddress string `json:"privateAddress,omitempty"`
	// PrivateInterface override the given private interface
	PrivateInterface string `json:"privateInterface,omitempty"`
	// Profile is the name of the profile that should be used in the config
	Profile string `json:"profile,omitempty"`
	// Role of this node will be applied when adding nodes to the cluster;
	// options are either controller or worker.
	Role string `json:"role" jsonschema:"required,enum=controller,enum=worker"`
	// Host config for the various nodes
	Host ZarfHostConfig `json:"host,omitempty"`
	// Host config for the various nodes
	Engine ZarfHostEngine `json:"engine,omitempty"`
	// Configurer defines the per-host operations required for managing a host
	Configurer os.Configurer `json:"-"`
	// Metadata runtime discovered values
	Metadata ZarfHostMetadata `json:"-"`
}

type ZarfHostConfig struct {
	// Policy firewalld policies to allow traffic from one interface to another
	Policy map[string]ZarfFirewallPolicyConfig `json:"policy,omitempty"`
	// Ports are a list of ports and protocols that will be opened on a specfic node
	Ports []ZarfHostPort `json:"ports,omitempty" xml:"port"`
}

type ZarfHostEngine struct {
	// NodeLabels a map of node labels variables
	NodeLabels map[string]string `json:"labels,omitempty"`
	// NodeTaints that will be applied to the distro specific config that will be applied to the node
	NodeTaints []string `json:"taints,omitempty"`
}

type ZarfHostMetadata struct {
	Arch           string
	BinaryTempFile []string
	DistroVersion  string
	EngineUploaded bool
	ExistingConfig string
	Hostname       string
	Install        func(context.Context, *ZarfHost) error
	// Installed is a distro engine is already installed onto a host
	Installed bool
	// IsLeader if the host is a control-plane node
	IsLeader bool
	// MachineID is used by the distro engine to identify a node
	MachineID string
	// ModulesAdded is an indication if a new kernel module was added to the host system
	ModulesAdded bool
	// NeedsUpgrade if the host needs the distro engine upgraded
	NeedsUpgrade bool
	NewConfig    string
	// Ready indicates if the distro service is up and running
	Ready bool
}

type ZarfHostPort struct {
	// Protocol the type of allowed traffic
	Protocol string `json:"protocol" xml:"protocol,attr" jsonschema:"enum=tcp,enum=udp"`
	// Port the port number, or range, that will be opened
	Port string `json:"port" xml:"port,attr" jsonschema:"oneof_type=string;integer"`
}

type ZarfHosts []*ZarfHost

type ZarfRuntimeMeta struct {
	ControllerTLS   []string
	ControllerToken string
	AgentToken      string
	LoadBalancer    string
	Leader          *ZarfHost
}