container

type Configuration struct {
	metav1.TypeMeta `json:",inline"`

	// Identity identity describes the unique identity of the deployer.
	// +optional
	Identity string `json:"identity,omitempty"`

	// OCI configures the oci client of the controller
	// +optional
	OCI *config.OCIConfiguration `json:"oci,omitempty"`

	// TargetSelector describes all selectors the deployer should depend on.
	TargetSelector []lsv1alpha1.TargetSelector `json:"targetSelector,omitempty"`

	// Namespace defines the namespace where the pods should be executed.
	Namespace string `json:"namespace"`

	// DefaultImage configures the default images that is used if the DeployItem
	// does not specify one.
	DefaultImage ContainerSpec `json:"defaultImage"`

	// InitContainerImage defines the image that is used to init the container.
	// This container bootstraps the necessary directories and files.
	InitContainer ContainerSpec `json:"initContainer"`

	// SidecarContainerImage defines the image that is used as a
	// sidecar to the defined main container.
	// The sidecar container is responsible to collect the exports and the state of the main container.
	WaitContainer ContainerSpec `json:"waitContainer"`

	// GarbageCollection configures the container deployer garbage collector.
	GarbageCollection GarbageCollection `json:"garbageCollection"`

	// DebugOptions configure additional debug options.
	DebugOptions *DebugOptions `json:"debug,omitempty"`

	// HPAConfiguration contains the configuration for horizontal pod autoscaling.
	HPAConfiguration *HPAConfiguration `json:"hpa,omitempty"`

	// Controller contains configuration concerning the controller framework.
	Controller Controller `json:"controller,omitempty"`

	// +optional
	UseOCMLib bool `json:"useOCMLib,omitempty"`
}

type ContainerSpec struct {
	// Docker image name.
	// More info: https://kubernetes.io/docs/concepts/containers/images
	// The image will be defaulted by the container deployer to the configured default.
	Image string `json:"image,omitempty"`
	// Entrypoint array. Not executed within a shell.
	// The docker image's ENTRYPOINT is used if this is not provided.
	// Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
	// cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax
	// can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,
	// regardless of whether the variable exists or not.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
	// +optional
	Command []string `json:"command,omitempty"`
	// Arguments to the entrypoint.
	// The docker image's CMD is used if this is not provided.
	// Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
	// cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax
	// can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,
	// regardless of whether the variable exists or not.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
	// +optional
	Args []string `json:"args,omitempty"`
	// Image pull policy.
	// One of Always, Never, IfNotPresent.
	// Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
	// +optional
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
}

type ContainerStatus struct {
	// A human readable message indicating details about why the pod is in this condition.
	// +optional
	Message string `json:"message,omitempty"`
	// A brief CamelCase message indicating details about why the pod is in this state.
	// e.g. 'Evicted'
	// +optional
	Reason string `json:"reason,omitempty"`
	// Details about the container's current condition.
	// +optional
	State corev1.ContainerState `json:"state,omitempty"`
	// The image the container is running.
	// More info: https://kubernetes.io/docs/concepts/containers/images
	Image string `json:"image"`
	// ImageID of the container's image.
	ImageID string `json:"imageID"`
	// ExitCode of the main container.
	// +optional
	ExitCode *int32 `json:"exitCode,omitempty"`
}

type Controller struct {
	lsconfigv1alpha1.CommonControllerConfig
}

type DebugOptions struct {
	// KeepPod will only remove the finalizer on the pod but will not delete the pod.
	KeepPod bool `json:"keepPod,omitempty"`
}

type GarbageCollection struct {
	// Disable disables the garbage collector and the resources clean-up.
	Disable bool `json:"disable"`
	// Worker defines the number of parallel garbage collection routines.
	// Defaults to 5.
	Worker int `json:"worker"`
	// RequeueTime specifies the duration after which the object, which is not yet ready to be garbage collected, is requeued.
	// Defaults to 3600.
	RequeueTimeSeconds int `json:"requeueTimeSeconds"`
}

type HPAConfiguration struct {
	MaxReplicas int32 `json:"maxReplicas,omitempty"`
}

type OperationType string

type PodStatus struct {
	// PodName is the name of the created pod.
	PodName string `json:"podName"`
	// LastRun is the time when the pod was executed the last time.
	LastRun *metav1.Time `json:"lastRun,omitempty"`
	// LastSuccessfulJobID is set to the current JobID when the pod successfully finished.
	// If the pod has not yet finished, this field will be nil.
	LastSuccessfulJobID *string `json:"lastSuccessfulJobID,omitempty"`
	// ContainerStatus contains the status of the pod that
	// executes the configured container.
	ContainerStatus ContainerStatus `json:"containerStatus"`
	// InitContainerStatus contains the status of the init container.
	InitContainerStatus ContainerStatus `json:"initContainerStatus"`
	// WaitContainerStatus contains the status of the wait container.
	WaitContainerStatus ContainerStatus `json:"waitContainerStatus"`
}

type ProviderConfiguration struct {
	metav1.TypeMeta `json:",inline"`

	// Docker image name.
	// More info: https://kubernetes.io/docs/concepts/containers/images
	// The image will be defaulted by the container deployer to the configured default.
	// +optional
	Image string `json:"image,omitempty"`
	// Entrypoint array. Not executed within a shell.
	// The docker image's ENTRYPOINT is used if this is not provided.
	// Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
	// cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax
	// can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,
	// regardless of whether the variable exists or not.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
	// +optional
	Command []string `json:"command,omitempty"`
	// Arguments to the entrypoint.
	// The docker image's CMD is used if this is not provided.
	// Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
	// cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax
	// can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,
	// regardless of whether the variable exists or not.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
	// +optional
	Args []string `json:"args,omitempty"`
	// ImportValues contains the import values for the container.
	// +optional
	ImportValues json.RawMessage `json:"importValues,omitempty"`
	// Blueprint is the resolved reference to the Blueprint definition
	// +optional
	Blueprint *lsv1alpha1.BlueprintDefinition `json:"blueprint,omitempty"`
	// ComponentDescriptor is the resolved reference to the ComponentDescriptor defnition
	// +optional
	ComponentDescriptor *lsv1alpha1.ComponentDescriptorDefinition `json:"componentDescriptor,omitempty"`
	// RegistryPullSecrets defines a list of registry credentials that are used to
	// pull blueprints and component descriptors from the respective registry.
	// For more info see: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
	// Note that the type information is used to determine the secret key and the type of the secret.
	// +optional
	RegistryPullSecrets []lsv1alpha1.ObjectReference `json:"registryPullSecrets,omitempty"`
	// ContinuousReconcile contains the schedule for continuous reconciliation.
	// +optional
	ContinuousReconcile *cr.ContinuousReconcileSpec `json:"continuousReconcile,omitempty"`
}

type ProviderStatus struct {
	metav1.TypeMeta `json:",inline"`
	// LastOperation defines the last run operation of the pod.
	// The operation can be either reconcile or deletion.
	LastOperation string `json:"lastOperation"`
	// PodStatus indicated the status of the executed pod.
	PodStatus *PodStatus `json:"podStatus,omitempty"`
}