v1alpha1

type AccessToken struct {
	// SecretRef references the secret the access token is stored in
	SecretRef string `json:"secretRef,omitempty"`
}

type BootstrapToken struct {
	// Token is the actual token to register the cluster
	Token string `json:"token,omitempty"`
	// ValidUntil timespan how long the token is valid. If the token is
	// used after this timestamp it will be rejected.
	ValidUntil metav1.Time `json:"validUntil,omitempty"`
	// TokenValid indicates if the token is still valid or was already used.
	TokenValid bool `json:"tokenValid,omitempty"`
}

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

	Spec   ClusterSpec   `json:"spec,omitempty"`
	Status ClusterStatus `json:"status,omitempty"`
}

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

type ClusterSpec struct {
	// DisplayName of cluster which could be different from metadata.name. Allows cluster renaming should it be needed.
	DisplayName string `json:"displayName,omitempty"`
	// GitRepoURL git repository storing the cluster configuration catalog. If this is set, no gitRepoTemplate is needed.
	GitRepoURL string `json:"gitRepoURL,omitempty"`
	// SSH GitHostKeys of the git server
	GitHostKeys string `json:"gitHostKeys,omitempty"`
	// GitRepoTemplate template for managing the GitRepo object.
	GitRepoTemplate *GitRepoTemplate `json:"gitRepoTemplate,omitempty"`
	// TenantRef reference to Tenant object the cluster belongs to.
	TenantRef corev1.LocalObjectReference `json:"tenantRef,omitempty"`
	// TenantGitRepoRevision allows to configure the revision of the tenant configuration to use. It can be any git tree-ish reference. The revision from the tenant will be inherited if left empty.
	TenantGitRepoRevision string `json:"tenantGitRepoRevision,omitempty"`
	// GlobalGitRepoRevision allows to configure the revision of the global configuration to use. It can be any git tree-ish reference. The revision from the tenant will be inherited if left empty.
	GlobalGitRepoRevision string `json:"globalGitRepoRevision,omitempty"`
	// TokenLifetime set the token lifetime
	TokenLifeTime string `json:"tokenLifeTime,omitempty"`
	// Facts are key/value pairs for statically configured facts
	Facts Facts `json:"facts,omitempty"`
	// DeletionPolicy defines how the external resources should be treated upon CR deletion.
	// Retain: will not delete any external resources
	// Delete: will delete the external resources
	// Archive: will archive the external resources, if it supports that
	// +kubebuilder:validation:Enum=Delete;Retain;Archive
	DeletionPolicy DeletionPolicy `json:"deletionPolicy,omitempty"`
	// CreationPolicy defines how the external resources should be treated upon CR creation.
	// Create: will only create a new external resource and will not manage already existing resources
	// Adopt:  will create a new external resource or will adopt and manage an already existing resource
	// +kubebuilder:validation:Enum=Create;Adopt
	CreationPolicy CreationPolicy `json:"creationPolicy,omitempty"`
	// EnableCompilePipeline determines whether the gitops compile pipeline should be set up for this cluster
	EnableCompilePipeline bool `json:"enableCompilePipeline,omitempty"`
}

type ClusterStatus struct {
	// BootstrapTokenValid validity of the bootstrap token, set by the Lieutenant API.
	BootstrapToken *BootstrapToken `json:"bootstrapToken,omitempty"`
	// Facts are key/value pairs for dynamically fetched facts
	Facts Facts `json:"facts,omitempty"`
	// CompileMeta contains information about the last compilation with Commodore.
	CompileMeta CompileMeta `json:"compileMeta,omitempty"`
}

type CompileMeta struct {
	// LastCompile is the time of the last successful compilation.
	LastCompile metav1.Time `json:"lastCompile,omitempty"`
	// CommodoreBuildInfo is the freeform build information reported by the Commodore binary used for the last compilation.
	CommodoreBuildInfo map[string]string `json:"commodoreBuildInfo,omitempty"`
	// Global contains the information of the global configuration used for the last compilation.
	Global CompileMetaVersionInfo `json:"global,omitempty"`
	// Tenant contains the information of the tenant configuration used for the last compilation.
	Tenant CompileMetaVersionInfo `json:"tenant,omitempty"`
	// Packages contains the information of the packages used for the last compilation.
	Packages map[string]CompileMetaVersionInfo `json:"packages,omitempty"`
	// Instances contains the information of the component instances used for the last compilation.
	// The key is the name of the component instance.
	Instances map[string]CompileMetaInstanceVersionInfo `json:"instances,omitempty"`
}

type CompileMetaInstanceVersionInfo struct {
	CompileMetaVersionInfo `json:",inline"`

	// Component is the name of a component instance.
	Component string `json:"component,omitempty"`
}

type CompileMetaVersionInfo struct {
	// URL is the URL of the git repository.
	URL string `json:"url,omitempty"`
	// GitSHA is the git commit SHA of the used commit.
	GitSHA string `json:"gitSha,omitempty"`
	// Version is the version of the configuration.
	// Can point to a tag, branch or any other git reference.
	Version string `json:"version,omitempty"`
	// Path is the path inside the git repository where the configuration is stored.
	Path string `json:"path,omitempty"`
}

type CompilePipelineSpec struct {
	// Enabled enables or disables the compile pipeline for this tenant
	Enabled bool `json:"enabled,omitempty"`
	// Pipelines contains a map of filenames and file contents, specifying files which are added to the GitRepoTemplate in order to set up the automatically configured compile pipeline
	PipelineFiles map[string]string `json:"pipelineFiles,omitempty"`
}

type CompilePipelineStatus struct {
	// Clusters contains the list of all clusters for which the automatically configured compile pipeline is enabled
	Clusters []string `json:"clusters,omitempty"`
}

type CreationPolicy string

type DeletionPolicy string

type DeployKey struct {
	// Type defines what type the key is (rsa, ed25519, etc...)
	Type string `json:"type,omitempty"`
	// Key is the actual key
	Key string `json:"key,omitempty"`
	// WriteAccess if the key has RW access or not
	WriteAccess bool `json:"writeAccess,omitempty"`
}

type EnvVar struct {
	// Name of the environment variable
	// +required
	Name string `json:"name"`
	// Value of the environment variable
	// +optional
	Value string `json:"value,omitempty"`

	// ValueFrom is a reference to an object that contains the value of the environment variable
	// +optional
	ValueFrom *EnvVarSource `json:"valueFrom,omitempty"`

	// GitlabOptions contains additional options for GitLab CI variables
	// +optional
	GitlabOptions EnvVarGitlabOptions `json:"gitlabOptions,omitempty"`
}

type EnvVarGitlabOptions struct {
	// Description is a description of the CI variable.
	// +optional
	Description string `json:"description,omitempty"`
	// Protected will expose the variable only in protected branches and tags.
	// +optional
	Protected bool `json:"protected,omitempty"`
	// Masked will mask the variable in the job logs.
	// +optional
	Masked bool `json:"masked,omitempty"`
	// Raw will prevent the variable from being expanded.
	// +optional
	Raw bool `json:"raw,omitempty"`
}

type EnvVarSource struct {
	// Selects a key of a secret in the pod's namespace
	// +optional
	SecretKeyRef *corev1.SecretKeySelector `json:"secretKeyRef,omitempty"`
}

type Facts map[string]string

type GitPhase string

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

	Spec   GitRepoSpec   `json:"spec,omitempty"`
	Status GitRepoStatus `json:"status,omitempty"`
}

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

type GitRepoSpec struct {
	GitRepoTemplate `json:",inline"`
	// TenantRef references the tenant this repo belongs to
	TenantRef corev1.LocalObjectReference `json:"tenantRef,omitempty"`
}

type GitRepoStatus struct {
	// Updated by Operator with current phase. The GitPhase enum will be used for application logic
	// as using it directly would only print an integer.
	Phase *GitPhase `json:"phase,omitempty"`
	// Type autodiscovered Git repo type. Same behaviour for the enum as with the Phase.
	Type GitType `json:"type,omitempty"`
	// URL computed Git repository URL
	URL string `json:"url,omitempty"`
	// SSH HostKeys of the git server
	HostKeys string `json:"hostKeys,omitempty"`
	// LastAppliedCIVariables contains the last applied CI variables as a json string
	LastAppliedCIVariables string `json:"lastAppliedCIVariables,omitempty"`
}

type GitRepoTemplate struct {
	// APISecretRef reference to secret containing connection information
	APISecretRef corev1.SecretReference `json:"apiSecretRef,omitempty"`
	// DeployKeys optional list of SSH deploy keys. If not set, not deploy keys will be configured
	DeployKeys map[string]DeployKey `json:"deployKeys,omitempty"`
	// Path to Git repository
	Path string `json:"path,omitempty"`
	// RepoName name of Git repository
	RepoName string `json:"repoName,omitempty"`
	// RepoType specifies if a repo should be managed by the git controller. A value of 'unmanaged' means it's not manged by the controller
	// +kubebuilder:validation:Enum=auto;unmanaged
	RepoType RepoType `json:"repoType,omitempty"`
	// DisplayName of Git repository
	DisplayName string `json:"displayName,omitempty"`
	// TemplateFiles is a list of files that should be pushed to the repository
	// after its creation.
	TemplateFiles map[string]string `json:"templateFiles,omitempty"`
	// DeletionPolicy defines how the external resources should be treated upon CR deletion.
	// Retain: will not delete any external resources
	// Delete: will delete the external resources
	// Archive: will archive the external resources, if it supports that
	// +kubebuilder:validation:Enum=Delete;Retain;Archive
	DeletionPolicy DeletionPolicy `json:"deletionPolicy,omitempty"`
	// CreationPolicy defines how the external resources should be treated upon CR creation.
	// Create: will only create a new external resource and will not manage already existing resources
	// Adopt:  will create a new external resource or will adopt and manage an already existing resource
	// +kubebuilder:validation:Enum=Create;Adopt
	CreationPolicy CreationPolicy `json:"creationPolicy,omitempty"`
	// AccessToken contains configuration for storing an access token in a secret.
	// If set, the Lieutenant operator will store an access token into this secret, which can be used to access the Git repository.
	// The token is stored under the key "token".
	// In the case of GitLab, this would be a Project Access Token with read-write access to the repository.
	AccessToken AccessToken `json:"accessToken,omitempty"`
	// CIVariables is a list of key-value pairs that will be set as CI variables in the Git repository.
	//
	// The variables are not expanded like PodSpec environment variables.
	CIVariables []EnvVar `json:"ciVariables,omitempty"`
}

type GitType string

type RepoType string

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

	Spec   TenantSpec   `json:"spec,omitempty"`
	Status TenantStatus `json:"status,omitempty"`
}

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

type TenantSpec struct {
	// DisplayName is the display name of the tenant.
	DisplayName string `json:"displayName,omitempty"`
	// GitRepoURL git repository storing the tenant configuration. If this is set, no gitRepoTemplate is needed.
	GitRepoURL string `json:"gitRepoURL,omitempty"`
	// GitRepoRevision allows to configure the revision of the tenant configuration to use. It can be any git tree-ish reference. Defaults to HEAD if left empty.
	GitRepoRevision string `json:"gitRepoRevision,omitempty"`
	// GlobalGitRepoURL git repository storing the global configuration.
	GlobalGitRepoURL string `json:"globalGitRepoURL,omitempty"`
	// GlobalGitRepoRevision allows to configure the revision of the global configuration to use. It can be any git tree-ish reference. Defaults to HEAD if left empty.
	GlobalGitRepoRevision string `json:"globalGitRepoRevision,omitempty"`
	// GitRepoTemplate Template for managing the GitRepo object. If not set, no GitRepo object will be created.
	GitRepoTemplate *GitRepoTemplate `json:"gitRepoTemplate,omitempty"`
	// DeletionPolicy defines how the external resources should be treated upon CR deletion.
	// Retain: will not delete any external resources
	// Delete: will delete the external resources
	// Archive: will archive the external resources, if it supports that
	// +kubebuilder:validation:Enum=Delete;Retain;Archive
	DeletionPolicy DeletionPolicy `json:"deletionPolicy,omitempty"`
	// CreationPolicy defines how the external resources should be treated upon CR creation.
	// Create: will only create a new external resource and will not manage already existing resources
	// Adopt:  will create a new external resource or will adopt and manage an already existing resource
	// +kubebuilder:validation:Enum=Create;Adopt
	CreationPolicy CreationPolicy `json:"creationPolicy,omitempty"`
	// ClusterTemplate defines a template which will be used to set defaults for the clusters of this tenant.
	// The fields within this can use Go templating.
	// See https://syn.tools/lieutenant-operator/explanations/templating.html for details.
	ClusterTemplate *ClusterSpec `json:"clusterTemplate,omitempty"`
	// CompilePipeline contains the configuration for the automatically configured compile pipelines on this tenant
	CompilePipeline *CompilePipelineSpec `json:"compilePipeline,omitempty"`
}

type TenantStatus struct {
	// CompilePipeline contains the status of the automatically configured compile pipelines on this tenant
	CompilePipeline *CompilePipelineStatus `json:"compilePipeline,omitempty"`
}

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

	Spec TenantSpec `json:"spec,omitempty"`
}

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