v1alpha1

type ActionProgress struct {
	// RunningPhase represents which phase of the action is being run
	RunningPhase string `json:"runningPhase,omitempty"`
	// PercentCompleted is computed by assessing the number of completed phases
	// against the the total number of phases.
	PercentCompleted string `json:"percentCompleted,omitempty"`
	// LastTransitionTime represents the last date time when the progress status
	// was received.
	LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`
}

type ActionSet struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`
	// Spec defines the specification for the actionset.
	// The specification includes a list of Actions to be performed. Each Action includes details
	// about the referenced Blueprint and other objects used to perform the defined action.
	Spec *ActionSetSpec `json:"spec,omitempty"`
	// Status refers to the current status of the Kanister actions.
	Status *ActionSetStatus `json:"status,omitempty"`
}

type ActionSetList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	// Items is the list of actionsets.
	Items []*ActionSet `json:"items"`
}

type ActionSetSpec struct {
	// Actions represents a list of Actions that need to be performed by the actionset.
	Actions []ActionSpec `json:"actions,omitempty"`
}

type ActionSetStatus struct {
	// State represents the current state of the actionset.
	// There are four possible values: "Pending", "Running", "Failed", and "Complete".
	State State `json:"state"`
	// Actions list represents the latest available observations of the current state of all the actions.
	Actions []ActionStatus `json:"actions,omitempty"`
	// Error contains the detailed error message of an actionset failure.
	Error Error `json:"error,omitempty"`
	// Progress provides information on the progress of a running actionset.
	// This includes the percentage of completion of an actionset and the phase that is
	// currently being executed.
	Progress ActionProgress `json:"progress,omitempty"`
}

type ActionSpec struct {
	// Name is the action we'll perform. For example: `backup` or `restore`.
	Name string `json:"name"`
	// Object refers to the thing we'll perform this action on.
	Object ObjectReference `json:"object"`
	// Blueprint with instructions on how to execute this action.
	Blueprint string `json:"blueprint,omitempty"`
	// Artifacts will be passed as inputs into this phase.
	Artifacts map[string]Artifact `json:"artifacts,omitempty"`
	// ConfigMaps that we'll get and pass into the blueprint.
	ConfigMaps map[string]ObjectReference `json:"configMaps,omitempty"`
	// Secrets that we'll get and pass into the blueprint.
	Secrets map[string]ObjectReference `json:"secrets,omitempty"`
	// Profile is use to specify the location where store artifacts and the
	// credentials authorized to access them.
	Profile *ObjectReference `json:"profile,omitempty"`
	// RepositoryServer is used to specify the CR reference
	// of the kopia repository server
	RepositoryServer *ObjectReference `json:"repositoryServer,omitempty"`
	// PodOverride is used to specify pod specs that will override the
	// default pod specs
	PodOverride JSONMap `json:"podOverride,omitempty"`
	// Options will be used to specify additional values
	// to be used in the Blueprint.
	Options map[string]string `json:"options,omitempty"`
	// PreferredVersion will be used to select the preferred version of Kanister functions
	// to be executed for this action
	PreferredVersion string `json:"preferredVersion"`
}

type ActionStatus struct {
	// Name is the action we'll perform. For example: `backup` or `restore`.
	Name string `json:"name"`
	// Object refers to the thing we'll perform this action on.
	Object ObjectReference `json:"object"`
	// Blueprint with instructions on how to execute this action.
	Blueprint string `json:"blueprint"`
	// Phases are sub-actions an are executed sequentially.
	Phases []Phase `json:"phases,omitempty"`
	// Artifacts created by this phase.
	Artifacts map[string]Artifact `json:"artifacts,omitempty"`
	// DeferPhase is the phase that is executed at the end of an action
	// irrespective of the status of other phases in the action
	DeferPhase Phase `json:"deferPhase,omitempty"`
}

type Artifact struct {
	// KeyValue represents key-value pair artifacts produced by the action.
	KeyValue map[string]string `json:"keyValue,omitempty"`
	// KopiaSnapshot captures the kopia snapshot information
	// produced as a JSON string by kando command in phases of an action.
	KopiaSnapshot string `json:"kopiaSnapshot,omitempty"`
}

type Blueprint struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`
	// Actions is the list of actions constructing the Blueprint.
	Actions map[string]*BlueprintAction `json:"actions,omitempty"`
}

type BlueprintAction struct {
	// Name contains the name of the action.
	Name string `json:"name"`
	// Kind contains the resource on which this action has to be performed.
	Kind string `json:"kind"`
	// ConfigMapNames is used to specify the config map names that can be used later in the action phases.
	ConfigMapNames []string `json:"configMapNames,omitempty"`
	// List of Kubernetes secret names used in action phases.
	SecretNames []string `json:"secretNames,omitempty"`
	// InputArtifactNames is the list of Artifact names that were set from previous action and can be consumed in the current action.
	InputArtifactNames []string `json:"inputArtifactNames,omitempty"`
	// OutputArtifacts is the map of rendered artifacts produced by the BlueprintAction.
	OutputArtifacts map[string]Artifact `json:"outputArtifacts,omitempty"`
	// Phases is the list of BlueprintPhases which are invoked in order when executing this action.
	Phases []BlueprintPhase `json:"phases,omitempty"`
	// DeferPhase is invoked after the execution of Phases that are defined for an action.
	// A DeferPhase is executed regardless of the statuses of the other phases of the action.
	// A DeferPhase can be used for cleanup operations at the end of an action.
	DeferPhase *BlueprintPhase `json:"deferPhase,omitempty"`
}

type BlueprintList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	// Items is the list of Blueprints.
	Items []*Blueprint `json:"items"`
}

type BlueprintPhase struct {
	// Func is the name of a registered Kanister function.
	Func string `json:"func"`
	// Name contains name of the phase.
	Name string `json:"name"`
	// ObjectRefs represents a map of references to the Kubernetes objects that
	// can later be used in the `Args` of the function.
	ObjectRefs map[string]ObjectReference `json:"objects,omitempty"`
	// Args represents a map of named arguments that the controller will pass to the Kanister function.
	Args map[string]interface{} `json:"args"`
}

type CacheSizeSettings struct {
	// Metadata size should be in specified in MB
	Metadata *int `json:"metadata,omitempty"`
	// Content size should be in specified in MB
	Content *int `json:"content,omitempty"`
}

type Configuration struct {
	// CacheDirectory is an optional field to specify kopia cache directory
	CacheDirectory string `json:"cacheDirectory,omitempty"`
	// LogDirectory is an optional field to specify kopia log directory
	LogDirectory string `json:"logDirectory,omitempty"`
	// ConfigFilePath is an optional field to specify kopia config file path
	ConfigFilePath string `json:"configFilePath,omitempty"`
}

type Credential struct {
	// Type represents the information about how the credentials are provided for the respective object storage.
	Type CredentialType `json:"type"`
	// KeyPair represents the key-value map used for the Credential of Type KeyPair.
	KeyPair *KeyPair `json:"keyPair,omitempty"`
	// Secret represents the Kubernetes Secret Object used for the Credential of Type Secret.
	Secret *ObjectReference `json:"secret,omitempty"`
	// KopiaServerSecret represents the secret being used by Credential of Type Kopia.
	KopiaServerSecret *KopiaServerSecret `json:"kopiaServerSecret,omitempty"`
}

type CredentialType string

type Error struct {
	// Message is the actual error message that is displayed in case of errors.
	Message string `json:"message"`
}

type JSONMap sp.JSONMap

type KeyPair struct {
	// IDField specifies the corresponding key in the secret where the AWS Key ID value is stored.
	IDField string `json:"idField"`
	// SecretField specifies the corresponding key in the secret where the AWS Secret Key value is stored.
	SecretField string `json:"secretField"`
	// Secret represents a Kubernetes Secret object storing the KeyPair credentials.
	Secret ObjectReference `json:"secret"`
}

type KopiaServerSecret struct {
	// Username represents the username used to connect to the Kopia Server.
	Username string `json:"username,omitempty"`
	// Hostname represents the hostname used to connect to the Kopia Server.
	Hostname string `json:"hostname,omitempty"`
	// UserPassphrase is the user password used to connect to the Kopia Server.
	UserPassphrase *KopiaServerSecretRef `json:"userPassphrase,omitempty"`
	// TLSCert is the certificate used to connect to the Kopia Server.
	TLSCert *KopiaServerSecretRef `json:"tlsCert,omitempty"`
	// ConnectOptions represents a map of options which can be used to connect to the Kopia Server.
	ConnectOptions map[string]int `json:"connectOptions,omitempty"`
}

type KopiaServerSecretRef struct {
	// Key represents the corresponding key in the secret where the required
	// credential or certificate value is stored.
	Key string `json:"key"`
	// Secret is the K8s secret object where the creds related to the Kopia Server are stored.
	Secret *ObjectReference `json:"secret"`
}

type Location struct {
	// Type specifies the kind of object storage that would be used to upload the
	// backup objects. Currently supported values are: "GCS", "S3Compliant",
	// and "Azure".
	Type LocationType `json:"type"`
	// Bucket represents the bucket on the object storage where the backup is uploaded.
	Bucket string `json:"bucket"`
	// Endpoint specifies the endpoint where the object storage is accessible at.
	Endpoint string `json:"endpoint"`
	// Prefix is the string that would be prepended to the object path in the
	// bucket where the backup objects are uploaded.
	Prefix string `json:"prefix"`
	// Region represents the region of the bucket specified above.
	Region string `json:"region"`
}

type LocationType string

type ObjectReference struct {
	// API version of the referent.
	APIVersion string `json:"apiVersion"`
	// API Group of the referent.
	Group string `json:"group"`
	// Resource name of the referent.
	Resource string `json:"resource"`
	// Kind of the referent.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	Kind string `json:"kind"`
	// Name of the referent.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#names
	Name string `json:"name"`
	// Namespace of the referent.
	// More info: http://kubernetes.io/docs/user-guide/namespaces
	Namespace string `json:"namespace,omitempty"`
}

type Phase struct {
	// Name represents the name of the Blueprint phase.
	Name string `json:"name"`
	// State represents the current state of execution of the Blueprint phase.
	State State `json:"state"`
	// Output is the map of output artifacts produced by the Blueprint phase.
	Output map[string]interface{} `json:"output,omitempty"`
	// Progress represents the phase execution progress.
	Progress PhaseProgress `json:"progress,omitempty"`
}

type PhaseProgress struct {
	// ProgressPercent represents the execution progress in percentage.
	ProgressPercent string `json:"progressPercent,omitempty"`
	// SizeUploadedB represents the size of data uploaded in Bytes at a given time during phase execution.
	// This field will be empty for phases which do not involve data movement.
	SizeUploadedB int64 `json:"sizeUploadedB,omitempty"`
	// EstimatedUploadSizeB represents the total estimated size of data in Bytes
	// that will be uploaded during the phase execution.
	// This field will be empty for phases which do not involve data movement.
	EstimatedUploadSizeB int64 `json:"estinatedUploadSizeB,omitempty"`
	// EstimatedTimeSeconds is the estimated time required in seconds to upload the
	// remaining data estimated with EstimatedUploadSizeB.
	// This field will be empty for phases which do not involve data movement.
	EstimatedTimeSeconds int64 `json:"estinatedTimeSeconds,omitempty"`
	// LastTransitionTime represents the last date time when the progress status
	// was received.
	LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`
}

type Profile struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`
	// Location provides the information about the object storage that is going to be used by Kanister to upload the backup objects.
	Location Location `json:"location"`
	// Credential represents the credentials associated with the Location.
	Credential Credential `json:"credential"`
	// SkipSSLVerify is a boolean that specifies whether skipping SSL verification
	// is allowed when operating with the Location.
	// If omitted from the CR definition, it defaults to false
	SkipSSLVerify bool `json:"skipSSLVerify"`
}

type ProfileList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	// Items represents a list of Profiles.
	Items []*Profile `json:"items"`
}

type Repository struct {
	// Path for the repository, it will be a relative sub path
	// within the path prefix specified in the location
	// More info: https://kopia.io/docs/reference/command-line/common/#commands-to-manipulate-repository
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
	RootPath string `json:"rootPath"`
	// If specified, these values will be used by the controller to
	// override default username when connecting to the
	// repository from the server.
	Username string `json:"username,omitempty"`
	// If specified, these values will be used by the controller to
	// override default hostname when connecting to the
	// repository from the server.
	Hostname string `json:"hostname,omitempty"`
	// PasswordSecretRef has the password required to connect to kopia repository
	PasswordSecretRef corev1.SecretReference `json:"passwordSecretRef"`
	CacheSizeSettings CacheSizeSettings      `json:"cacheSizeSettings,omitempty"`
	Configuration     Configuration          `json:"configuration,omitempty"`
}

type RepositoryServer struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Spec defines the spec of repository server.
	// It has all the details required to start the kopia repository server
	Spec RepositoryServerSpec `json:"spec"`
	// Status refers to the current status of the repository server.
	Status RepositoryServerStatus `json:"status,omitempty"`
}

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

type RepositoryServerProgress string

type RepositoryServerSpec struct {
	// Storage references the backend store where a repository already exists
	// and the credential necessary to connect to the backend store
	Storage Storage `json:"storage"`
	// Repository has the details required by the repository server
	// to connect to kopia repository
	Repository Repository `json:"repository"`
	// Server has the details of all the secrets required to start
	// the kopia repository server
	Server Server `json:"server"`
}

type RepositoryServerStatus struct {
	Conditions []metav1.Condition       `json:"conditions,omitempty"`
	ServerInfo ServerInfo               `json:"serverInfo,omitempty"`
	Progress   RepositoryServerProgress `json:"progress,omitempty"`
}

type Server struct {
	UserAccess UserAccess `json:"userAccess"`
	// AdminSecretRef has the username and password required to start the
	// kopia repository server
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
	AdminSecretRef corev1.SecretReference `json:"adminSecretRef"`
	// TLSSecretRef has the certificates required for kopia repository
	// client server connection
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
	TLSSecretRef corev1.SecretReference `json:"tlsSecretRef"`
}

type ServerInfo struct {
	PodName     string `json:"podName,omitempty"`
	ServiceName string `json:"serviceName,omitempty"`
}

type State string

type Storage struct {
	// SecretRef has the details of the object storage (location)
	// where the kopia would backup the data
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
	SecretRef corev1.SecretReference `json:"secretRef"`
	// CredentialSecretRef stores the credentials required
	// to connect to the object storage specified in `SecretRef` field
	CredentialSecretRef corev1.SecretReference `json:"credentialSecretRef"`
}

type UserAccess struct {
	// UserAccessSecretRef stores the list of hostname and passwords used by kopia clients
	// to connect to kopia repository server
	UserAccessSecretRef corev1.SecretReference `json:"userAccessSecretRef"`
	// Username is the user required by client to connect to kopia repository server
	Username string `json:"username"`
}