config

type ComponentConfig struct {
	// Name is the name of the component.
	// This field is primarily used for logging.
	Name string `json:"name"`

	// Sources is an optional list of component YAML to apply to the management
	// cluster.
	// This field may be omitted when wanting only to block progress via one or
	// more Waiters.
	Sources []ComponentSource `json:"sources,omitempty"`

	// Waiters is an optional list of checks to perform in order to determine
	// whether or not the installed components are ready.
	Waiters []ComponentWaiter `json:"waiters,omitempty"`
}

type ComponentGenerator interface {
	// GetName returns the name of the component.
	GetName() string
	// Manifests return the YAML bundle.
	Manifests(context.Context) ([]byte, error)
}

type ComponentReplacement struct {
	// Old is the pattern to replace.
	// A regular expression may be used.
	Old string `json:"old"`
	// New is the string used to replace the old pattern.
	// An empty string is valid.
	New string `json:"new,omitempty"`
}

type ComponentSource struct {
	// Name is used for logging when a component has multiple sources.
	Name string `json:"name,omitempty"`

	// Value is the source of the component's YAML.
	// May be a URL or a kustomization root (specified by Type).
	// If a Type=url then Value may begin with file://, http://, or https://.
	// If a Type=kustomize then Value may be any valid go-getter URL. For
	// more information please see https://github.com/hashicorp/go-getter#url-format.
	Value string `json:"value"`

	// Type describes how to process the source of the component's YAML.
	//
	// Defaults to "kustomize".
	Type ComponentSourceType `json:"type,omitempty"`

	// Replacements is a list of patterns to replace in the component YAML
	// prior to application.
	Replacements []ComponentReplacement `json:"replacements,omitempty"`
}

type ComponentSourceType string

type ComponentWaiter struct {
	// Value varies depending on the specified Type.
	// Please see the documentation for the different WaiterType constants to
	// understand the valid values for this field.
	Value string `json:"value"`

	// Type describes the type of check to perform.
	//
	// Defaults to "pods".
	Type ComponentWaiterType `json:"type,omitempty"`
}

type ComponentWaiterType string

type ContainerImage struct {
	// Name is the fully qualified name of the image.
	Name string
}

type Files struct {
	// SourcePath path of the file.
	SourcePath string `json:"sourcePath"`

	// TargetName name of the file copied into the local repository. if empty, the source name
	// Will be preserved
	TargetName string `json:"targetName,omitempty"`
}

type LoadMetal3CtlConfigInput struct {
	ConfigData []byte
}

type Metal3CtlConfig struct {
	// Name is the name of the management cluster.
	ManagementClusterName string `json:"managementClusterName,omitempty"`

	// Path to kubeconfig of the mgmt cluster.
	Kubeconfig string `json:"kubeconfig,omitempty"`

	// Path to where all the generated artifacts will be stored.
	ArtifactsPath string `json:"artifactsPath,omitempty"`

	// Images is a list of container images to load into the mgmt cluster.
	Images []ContainerImage `json:"images,omitempty"`

	// CAPIProviders is a list of cluster-api providers to be configured in the local repository that will then be created on the mgmt cluster.
	// It is required to provide following providers
	// - cluster-api
	// - bootstrap kubeadm
	// - control-plane kubeadm
	// - cluster-api-provider--metal3
	CAPIProviders []ProviderConfig `json:"capiProviders,omitempty"`

	// baremetal-operator configuration
	BMOProvider ProviderConfig `json:"bmoProvider,omitempty"`

	// Variables to be added to the clusterctl config file
	// Please not that clusterctl read variables from the os environment variables as well, so you can avoid to hard code
	// sensitive data in the config file.
	Variables map[string]string `json:"variables,omitempty"`
}

type ProviderConfig struct {
	// Name is the name of the provider.
	Name string `json:"name"`

	// Type is the type of the provider.
	Type string `json:"type"`

	// Versions is a list of component YAML to be added to the local repository, one for each release.
	// Please note that the first source will be used as a default release for this provider.
	Versions []ComponentSource `json:"versions,omitempty"`

	// Files is a list of files to be copied into the local repository for the default release of this provider.
	Files []Files `json:"files,omitempty"`

	// Waiters is list of waiters to be used to check if the installed provider are ready.
	Waiters []ProviderWaiter `json:"waiters,omitempty"`
}

type ProviderWaiter struct {
	// Type describes the type of check to perform.
	// Defaults to "deployment".
	Type ProviderWaiterType `json:"type,omitempty"`

	// Namespace varies depending on the specified Type.
	// Please see the documentation for the different WaiterType constants to
	// understand the valid values for this field.
	Namespace string `json:"namespace,omitempty"`

	// DefaultNamespace varies depending on the specified Type.
	// Please see the documentation for the different WaiterType constants to
	// understand the valid values for this field.
	DefaultNamespace string `json:"defaultNamespace,omitempty"`

	// Name varies depending on the specified Type.
	// Please see the documentation for the different WaiterType constants to
	// understand the valid values for this field.
	Name string `json:"name"`
}

type ProviderWaiterType string