v1beta2

type CacheAzureConfig struct {
	// Credentials secret contains 'accountName' and 'privateKey'
	// used to authenticate against Azure blob storage
	Credentials string `json:"credentials,omitempty"`
	// Name of the Azure container in which the cache will be stored
	ContainerName string `json:"container,omitempty"`
	// The domain name of the Azure blob storage
	// e.g. blob.core.windows.net
	StorageDomain string `json:"storageDomain,omitempty"`
}

type CacheGCSConfig struct {
	// contains the GCS 'access-id' and 'private-key'
	Credentials string `json:"credentials,omitempty"`
	// Takes GCS credentials file, 'keys.json'
	CredentialsFile string `json:"credentialsFile,omitempty"`
	// Name of the bucket in which the cache will be stored
	BucketName string `json:"bucket,omitempty"`
}

type CacheS3Config struct {
	Server string `json:"server,omitempty"`
	// Name of the secret containing the
	// 'accesskey' and 'secretkey' used to access the object storage
	Credentials string `json:"credentials,omitempty"`
	// Name of the bucket in which the cache will be stored
	BucketName string `json:"bucket,omitempty"`
	// Name of the S3 region in use
	BucketLocation string `json:"location,omitempty"`
	// Use insecure connections or HTTP
	Insecure bool `json:"insecure,omitempty"`
}

type KubernetesSpecPatch struct {
	// Name is the name given to the custom Pod Spec
	Name string `json:"name"`
	// Path to the file that defines the changes to apply to the final PodSpec object before it is generated.
	// The file must be a JSON or YAML file.
	// You cannot set the patch_path and patch in the same pod_spec configuration, otherwise an error occurs.
	PatchFile string `json:"patchFile,omitempty"`
	// A JSON or YAML format string that describes the changes which must be applied
	// to the final PodSpec object before it is generated.
	// You cannot set the patch_path and patch in the same pod_spec configuration, otherwise an error occurs.
	Patch string `json:"patch,omitempty"`
	// The strategy the runner uses to apply the specified changes to the PodSpec object generated by GitLab Runner.
	// The accepted values are merge, json, and strategic (default value).
	PatchType KubernetesSpecPatchType `json:"patchType"`
}

type KubernetesSpecPatchType string

type Runner struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of a GitLab Runner instance
	Spec RunnerSpec `json:"spec,omitempty"`
	// Most recently observed status of the GitLab Runner.
	// It is read-only to the user
	Status RunnerStatus `json:"status,omitempty"`
}

type RunnerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Runner `json:"items"`
}

type RunnerSpec struct {
	// The fully qualified domain name for the GitLab instance.
	// For example, https://gitlab.example.com
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="GitLab URL",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	GitLab string `json:"gitlabUrl"`

	// Name of secret containing the 'runner-registration-token' key used to register the runner
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Registration Token",xDescriptors="urn:alm:descriptor:com.tectonic.ui:selector:core:v1:Secret"
	RegistrationToken string `json:"token"`

	// List of comma separated tags to be applied to the runner
	// More info: https://docs.gitlab.com/ee/ci/runners/#use-tags-to-limit-the-number-of-jobs-using-the-runner
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Tags",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	Tags string `json:"tags,omitempty"`

	// Option to limit the number of jobs globally that can run concurrently.
	// The operator sets this to 10, if not specified
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Concurrent",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	Concurrent *int32 `json:"concurrent,omitempty"`

	// Option to set the log level for the runner.
	// Valid values are "debug", "info", "warn", "error", "fatal", "panic"
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Log Level",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	LogLevel *string `json:"logLevel,omitempty"`

	// Specifies the log format. Options are `runner`, `text`, and `json`. The default value is `runner`, which contains ANSI escape codes for coloring.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Log Format",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	LogFormat *string `json:"logFormat,omitempty"`

	// Option to set the metrics listen address for the runner.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Metrics Listen Address",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	ListenAddr *string `json:"listenAddr,omitempty"`

	// Enables tracking of all system level errors to Sentry.
	// If not specified, error tracking with Sentry will be disabled.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Sentry DSN",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	SentryDSN *string `json:"sentryDsn,omitempty"`

	// The maximum duration a TLS keepalive connection to the GitLab server should remain open before reconnecting. The default value is `15m` for 15 minutes. If set to `0` or lower, the connection persists as long as possible.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Connection Max Age",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	ConnectionMaxAge *string `json:"connectionMaxAge,omitempty"`

	// Number of seconds until the forceful shutdown operation times out and exits the process. The default value is `30`. If set to `0` or lower, the default value is used.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Shutdown Timeout",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	ShutdownTimeout *int32 `json:"shutdownTimeout,omitempty"`

	// Option to define the number of seconds between checks for new jobs.
	// This is set to a default of 30s by operator if not set
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Check Interval",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	CheckInterval *int32 `json:"interval,omitempty"`

	// Specify whether the runner should be locked to a specific project. Defaults to false.
	Locked bool `json:"locked,omitempty"`

	// Specify if jobs without tags should be run.
	// If not specified, runner will default to true if no tags were specified.
	// In other case it will default to false.
	RunUntagged *bool `json:"runUntagged,omitempty"`

	// Specify whether the runner should only run protected branches. Defaults to false.
	Protected bool `json:"protected,omitempty"`

	// If specified, overrides the default URL used to clone or fetch the Git ref
	CloneURL string `json:"cloneURL,omitempty"`

	// Accepts configmap name. Provides user mechanism to inject environment
	// variables in the GitLab Runner pod via the key value pairs in the ConfigMap
	Environment string `json:"env,omitempty"`

	// If specified, overrides the default GitLab Runner image. Default is the Runner image the operator was bundled with.
	RunnerImage string `json:"runnerImage,omitempty"`

	// If specified, overrides the default GitLab Runner helper image
	HelperImage string `json:"helperImage,omitempty"`

	// If specified, overrides the namespace where job pods are created
	Namespace string `json:"namespace,omitempty"`

	// The name of the default image to use to run
	// build jobs, when none is specified
	BuildImage string `json:"buildImage,omitempty"`

	// Type of cache used for Runner artifacts
	// Options are: gcs, s3, azure
	// +kubebuilder:validations:Enum=s3;gcs;azure
	CacheType string `json:"cacheType,omitempty"`

	// Path defines the Runner Cache path
	CachePath string `json:"cachePath,omitempty"`

	// Name of tls secret containing the custom certificate
	// authority (CA) certificates
	CertificateAuthority string `json:"ca,omitempty"`

	// Enable sharing of cache between Runners
	CacheShared bool `json:"cacheShared,omitempty"`

	// options used to setup S3
	// object store as GitLab Runner Cache
	S3 *CacheS3Config `json:"s3,omitempty"`
	// options used to setup GCS (Google
	// Container Storage) as GitLab Runner Cache
	GCS *CacheGCSConfig `json:"gcs,omitempty"`
	// options used to setup Azure blob
	// storage as GitLab Runner Cache
	Azure *CacheAzureConfig `json:"azure,omitempty"`

	// allow user to override service account
	// used by GitLab Runner
	ServiceAccount string `json:"serviceaccount,omitempty"`

	// allow user to provide configmap name
	// containing the user provided config.toml
	Configuration string `json:"config,omitempty"`

	// ImagePullPolicy sets the Image pull policy.
	// One of Always, Never, IfNotPresent.
	// Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
	// More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`

	// PodSpec manipulates the GitLab Runner Manager's pod by applying [KubernetesSpecPatch]es to it.
	// PodSpec patches will be applied after [DeploymentSpec] patches.
	PodSpec []KubernetesSpecPatch `json:"podSpec,omitempty"`
	// DeploymentSpec manipulates the GitLab Runner Manager's deployment by applying [KubernetesSpecPatch]es to it.
	// DeploymentSpec patches will be applied before [PodSpec] patches.
	DeploymentSpec []KubernetesSpecPatch `json:"deploymentSpec,omitempty"`
}

type RunnerStatus struct {
	// Reports status of the GitLab Runner instance
	// +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Phase",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	Phase string `json:"phase,omitempty"`

	// Reports status of GitLab Runner registration
	// +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Registration",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	Registration string `json:"registration,omitempty"`

	// Additional information of GitLab Runner registration
	// +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Message",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
	Message string `json:"message,omitempty"`
}