config

type AggregatorConfig struct {
	// WharfAPIURL is the URL used to connect to Wharf API.
	//
	// Added in v0.8.0.
	WharfAPIURL string
	// WorkerAPIExternalPort is the port used to connect to a Wharf worker.
	//
	// Added in v0.8.0.
	WorkerAPIExternalPort int16
}

type CORSConfig struct {
	// AllowAllOrigins enables CORS and allows all hostnames and URLs in the
	// HTTP request origins when set to true. Practically speaking, this
	// results in the HTTP header "Access-Control-Allow-Origin" set to "*".
	//
	// Added in v0.8.0.
	AllowAllOrigins bool
	// AllowOrigins enables CORS and allows the list of origins in the
	// HTTP request origins when set. Practically speaking, this
	// results in the HTTP header "Access-Control-Allow-Origin".
	//
	// Added in v0.8.0.
	AllowOrigins []string
}

type Config struct {
	// K8s holds Kubernetes-specific settings.
	//
	// Added in v0.8.0.
	K8s K8sConfig
	// Worker holds settings specific to the wharf-cmd-worker.
	//
	// Added in v0.8.0.
	Worker WorkerConfig
	// Provisioner holds settings specific to the wharf-cmd-provisioner.
	//
	// Added in v0.8.0.
	Provisioner ProvisionerConfig
	// Aggregator holds settings specific to the wharf-cmd-aggregator.
	//
	// Added in v0.8.0.
	Aggregator AggregatorConfig
	// Watchdog holds settings specific to the wharf-cmd-watchdog.
	//
	// Added in v0.8.0.
	Watchdog WatchdogConfig

	// InstanceID may be an arbitrary string that is used to identify different
	// Wharf installations from each other. Needed when you use multiple Wharf
	// installations in the same environment, such as the same Kubernetes
	// namespace, to let Wharf know which builds belong to which Wharf
	// installation.
	//
	// Added in v0.8.0.
	InstanceID string
}

type DockerStepConfig struct {
	// Image is the image for the kaniko executor to use.
	//
	// Added in v0.8.0.
	Image string
	// ImageTag is the image tag to use for the image.
	//
	// Added in v0.8.0.
	ImageTag string
}

type HTTPConfig struct {
	// CORS holds settings regarding HTTP CORS (Cross-Origin Resource Sharing).
	//
	// Added in v0.8.0.
	CORS CORSConfig
	// BindAddress is the IP-address and port, separated by a colon, to bind
	// the HTTP server to. An IP-address of 0.0.0.0 will bind to all
	// IP-addresses.
	//
	// Added in v0.8.0.
	BindAddress string
}

type HelmStepConfig struct {
	// Image is the image to use in the helm step.
	//
	// There's no config value for the Docker image tag to use, as that comes
	// from the helmVersion field in the helm step type from the .wharf-ci.yml
	// file.
	//
	// Added in v0.8.0.
	Image string
}

type K8sConfig struct {
	// Context is the context used when talking to kubernetes.
	//
	// Added in v0.8.0.
	Context string
	// Namespace is the kubernetes namespace to talk to.
	//
	// Added in v0.8.0.
	Namespace string
}

type K8sConfigMapKeySelector struct {
	// Name of the referent.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
	Name string
	// The key to select.
	Key string
	// Specify whether the ConfigMap or its key must be defined
	Optional *bool
}

type K8sContainerConfig struct {
	// Image is the base path for the image to use for a container.
	//
	// Added in v0.8.0.
	Image string
	// ImageTag is the version tag to use for a container.
	//
	// Added in v0.8.0.
	ImageTag string
	// ImagePullPolicy is the image pull policy to use for a container.
	//
	// "Always"
	//   Attempts to pull the latest image.
	//   Container will fail if the pull fails.
	//
	// "Never"
	//   Never pulls an image, i.e. only uses a local image.
	//   Container will fail if the image isn't present
	//
	// "IfNotPresent"
	//   Pulls if the image isn't present on disk.
	//   Container will fail if the image isn't present and the pull fails.
	//
	// Added in v0.8.0.
	ImagePullPolicy v1.PullPolicy
}

type K8sEnvVar struct {
	// Name of the environment variable. Must be a C_IDENTIFIER.
	Name string

	// Variable references $(VAR_NAME) are expanded
	// using the previously defined environment variables in the container and
	// any service environment variables. If a variable cannot be resolved,
	// the reference in the input string will be unchanged. Double $$ are reduced
	// to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
	// "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
	// Escaped references will never be expanded, regardless of whether the variable
	// exists or not.
	// Defaults to "".
	Value string
	// Source for the environment variable's value. Cannot be used if value is not empty.
	ValueFrom *K8sEnvVarSource
}

type K8sEnvVarSource struct {
	// Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
	// spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
	FieldRef *K8sObjectFieldSelector
	// Selects a resource of the container: only resources limits and requests
	// (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
	ResourceFieldRef *K8sResourceFieldSelector
	// Selects a key of a ConfigMap.
	ConfigMapKeyRef *K8sConfigMapKeySelector
	// Selects a key of a secret in the pod's namespace
	SecretKeyRef *K8sSecretKeySelector
}

type K8sLocalObjectReference struct {
	// Name of the referent.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
	Name string
}

type K8sObjectFieldSelector struct {
	// Version of the schema the FieldPath is written in terms of, defaults to "v1".
	APIVersion string
	// Path of the field to select in the specified API version.
	FieldPath string
}

type K8sResourceFieldSelector struct {
	// Container name: required for volumes, optional for env vars
	ContainerName string
	// Required: resource to select
	Resource string
	// Specifies the output format of the exposed resources, defaults to "1"
	Divisor string
}

type K8sSecretKeySelector struct {
	// Name of the referent.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
	Name string
	// The key of the secret to select from.  Must be a valid secret key.
	Key string
	// Specify whether the Secret or its key must be defined
	Optional *bool
}

type KubectlStepConfig struct {
	// Image is the image to use in the kubectl step.
	//
	// Added in v0.8.0.
	Image string
	// ImageTag is the image tag to use for the image.
	//
	// Added in v0.8.0.
	ImageTag string
}

type ProvisionerConfig struct {
	// HTTP holds settings for the wharf-cmd-provisioner's HTTP server
	// (gRPC & REST).
	//
	// Added in v0.8.0.
	HTTP HTTPConfig
	// K8s holds settings for how the wharf-cmd-provisioner acts towards
	// Kubernetes.
	//
	// Added in v0.8.0.
	K8s ProvisionerK8sConfig
}

type ProvisionerK8sConfig struct {
	// Worker holds settings for how the wharf-cmd-provisioner provisions
	// wharf-cmd-workers to Kubernetes.
	//
	// Added in v0.8.0.
	Worker ProvisionerK8sWorkerConfig
}

type ProvisionerK8sWorkerConfig struct {
	// ServiceAccountName is the service account name to use for the pod.
	//
	// Added in v0.8.0.
	ServiceAccountName string
	// InitContainer holds settings for the init container.
	//
	// Added in v0.8.0.
	InitContainer K8sContainerConfig
	// Container holds settings for the container.
	//
	// Added in v0.8.0.
	Container K8sContainerConfig
	// ImagePullSecrets is an optional list of references to secrets in the same
	// namespace to use for pulling either the wharf-cmd-worker init container
	// or app container.
	//
	// More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
	//
	// Added in v0.8.0.
	ImagePullSecrets []K8sLocalObjectReference
	// ConfigMapName is the name of a Kubernetes ConfigMap to mount into the
	// wharf-cmd-worker Pod. The ConfigMap can have the following keys, that
	// corresponds to their respective files:
	//
	//  wharf-cmd-config.yml
	//  wharf-vars.yml
	//
	// Sample ConfigMap manifest:
	//
	//  apiVersion: v1
	//  kind: ConfigMap
	//  metadata:
	//    name: wharf-cmd-worker-config
	//  data:
	//    wharf-cmd-config.yml: |
	//      instanceId: dev
	//    wharf-vars.yml: |
	//      vars:
	//        REG_SECRET: docker-registry
	//
	// With the above manifest created in the same namespace as where the
	// wharf-cmd-worker pods are created, you would then set this field to
	//
	//  wharf-cmd-worker-config
	//
	// Added in v0.8.0.
	ConfigMapName string
	// ExtraEnvs is an array of additional environment variables to set on the
	// wharf-cmd-worker Pod.
	//
	// Added in v0.8.0.
	ExtraEnvs []K8sEnvVar
	// ExtraArgs is an array of additional command-line arguments to add to the
	// wharf-cmd-worker Pod.
	//
	// Added in v0.8.0.
	ExtraArgs []string
}

type StepsConfig struct {
	// Docker holds settings for the docker step type. (Building docker images)
	//
	// Added in v0.8.0.
	Docker DockerStepConfig
	// Kubectl holds settings for the kubectl step type. (Applying Kubernetes
	// YAML manifests)
	//
	// Added in v0.8.0.
	Kubectl KubectlStepConfig
	// Helm holds settings for the helm step type. (Installing or upgrading
	// Helm releases)
	//
	// Added in v0.8.0.
	Helm HelmStepConfig
}

type WatchdogConfig struct {
	// WharfAPIURL is the URL used to connect to Wharf API.
	//
	// Added in v0.8.0.
	WharfAPIURL string
	// ProvisionerURL is the URL used to connect to the Wharf Cmd
	// provisioner.
	//
	// Added in v0.8.0.
	ProvisionerURL string
}

type WorkerConfig struct {
	// Steps holds settings specific to all different step types.
	//
	// Added in v0.8.0.
	Steps StepsConfig
}