chore: Make v1beta1 CRD have it's own version of spec and status (#2637)

* split kyma status

* make v1beta1 immutable

Author: ruanxin

api/v1beta1/kyma_types.go

@@ -18,8 +18,6 @@ package v1beta1
 
 import (
 	apimetav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-
-	"github.com/kyma-project/lifecycle-manager/api/v1beta2"
 )
 
 // +genclient
@@ -35,8 +33,8 @@ type Kyma struct {
 	apimetav1.TypeMeta   `json:",inline"`
 	apimetav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   KymaSpec           `json:"spec,omitempty"`
-	Status v1beta2.KymaStatus `json:"status,omitempty"`
+	Spec   KymaSpec   `json:"spec,omitempty"`
+	Status KymaStatus `json:"status,omitempty"`
 }
 
 // Sync defines settings used to apply the kyma synchronization to other clusters. This is defaulted to false
@@ -49,7 +47,7 @@ type Sync struct {
 
 	// +kubebuilder:default:=secret
 	// Strategy determines the way to look up the remotely synced kubeconfig, by default it is fetched from a secret
-	Strategy v1beta2.SyncStrategy `json:"strategy,omitempty"`
+	Strategy SyncStrategy `json:"strategy,omitempty"`
 
 	// The target namespace, if empty the namespace is reflected from the control plane
 	// Note that cleanup is currently not supported if you are switching the namespace, so you will
@@ -67,6 +65,10 @@ type Sync struct {
 	ModuleCatalog bool `json:"moduleCatalog,omitempty"`
 }
 
+// SyncStrategy determines how the Remote Cluster is synchronized with the Control Plane. This can influence secret
+// lookup, or other behavioral patterns when interacting with the remote cluster.
+type SyncStrategy string
+
 // KymaSpec defines the desired state of Kyma.
 type KymaSpec struct {
 	// Channel specifies the desired Channel of the Installation, usually targeting different module versions.
@@ -80,13 +82,105 @@ type KymaSpec struct {
 	SkipMaintenanceWindows bool `json:"skipMaintenanceWindows,omitempty"`
 
 	// Modules specifies the list of modules to be installed
-	Modules []v1beta2.Module `json:"modules,omitempty"`
+	Modules []Module `json:"modules,omitempty"`
 
 	// Active Synchronization Settings
 	// +optional
 	Sync Sync `json:"sync,omitempty"`
 }
 
+// KymaStatus defines the observed state of Kyma.
+type KymaStatus struct {
+	// State signifies current state of Kyma.
+	// Value can be one of ("Ready", "Processing", "Error", "Deleting").
+	State State `json:"state,omitempty"`
+
+	// List of status conditions to indicate the status of a ServiceInstance.
+	// +optional
+	// +listType=map
+	// +listMapKey=type
+	Conditions []apimetav1.Condition `json:"conditions,omitempty"`
+
+	// Contains essential information about the current deployed module
+	Modules []ModuleStatus `json:"modules,omitempty"`
+
+	// Active Channel
+	// +optional
+	ActiveChannel string `json:"activeChannel,omitempty"`
+
+	LastOperation `json:"lastOperation,omitempty"`
+}
+
+type ModuleStatus struct {
+	// Name defines the name of the Module in the Spec that the status is used for.
+	// It can be any kind of Reference format supported by Module.Name.
+	Name string `json:"name"`
+
+	// FQDN is the fully qualified domain name of the module.
+	// In the ModuleTemplate it is located in .spec.descriptor.component.name of the ModuleTemplate
+	// FQDN is used to calculate Namespace and Name of the Manifest for tracking.
+	FQDN string `json:"fqdn,omitempty"`
+
+	// Channel tracks the active Channel of the Module. In Case it changes, the new Channel will have caused
+	// a new lookup to be necessary that maybe picks a different ModuleTemplate, which is why we need to reconcile.
+	Channel string `json:"channel,omitempty"`
+
+	// Channel tracks the active Version of the Module.
+	Version string `json:"version,omitempty"`
+
+	// Message is a human-readable message indicating details about the State.
+	Message string `json:"message,omitempty"`
+
+	// State of the Module in the currently tracked Generation
+	State State `json:"state"`
+
+	// Manifest contains the Information of a related Manifest
+	Manifest *TrackingObject `json:"manifest,omitempty"`
+
+	// Resource contains information about the created module CR.
+	Resource *TrackingObject `json:"resource,omitempty"`
+
+	// It contains information about the last parsed ModuleTemplate in Context of the Installation.
+	// This will update when Channel or the ModuleTemplate is changed.
+	// +optional
+	Template *TrackingObject `json:"template,omitempty"`
+}
+
+// TrackingObject contains TypeMeta and PartialMeta to allow a generation based object tracking.
+// It purposefully does not use ObjectMeta as the generation of controller-runtime for crds would not validate
+// the generation fields even when embedding ObjectMeta.
+type TrackingObject struct {
+	apimetav1.TypeMeta `json:",inline"`
+	PartialMeta        `json:"metadata,omitempty"`
+}
+
+// PartialMeta is a subset of ObjectMeta that contains relevant information to track an Object.
+// see https://github.com/kubernetes/apimachinery/blob/v0.26.1/pkg/apis/meta/v1/types.go#L111
+type PartialMeta struct {
+	// Name must be unique within a namespace. Is required when creating resources, although
+	// some resources may allow a client to request the generation of an appropriate name
+	// automatically. Name is primarily intended for creation idempotence and configuration
+	// definition.
+	// Cannot be updated.
+	// More info: http://kubernetes.io/docs/user-guide/identifiers#names
+	// +optional
+	Name string `json:"name"`
+	// Namespace defines the space within which each name must be unique. An empty namespace is
+	// equivalent to the "default" namespace, but "default" is the canonical representation.
+	// Not all objects are required to be scoped to a namespace - the value of this field for
+	// those objects will be empty.
+	//
+	// Must be a DNS_LABEL.
+	// Cannot be updated.
+	// More info: http://kubernetes.io/docs/user-guide/namespaces
+	// +optional
+	Namespace string `json:"namespace"`
+	// A sequence number representing a specific generation of the desired state.
+	// Populated by the system. Read-only.
+	// +optional
+	Generation int64 `json:"generation,omitempty"`
+}
+
 // +kubebuilder:object:root=true
 
 // KymaList contains a list of Kyma.
@@ -96,6 +190,64 @@ type KymaList struct {
 	Items              []Kyma `json:"items"`
 }
 
+// Module defines the components to be installed.
+type Module struct {
+	// Name is a unique identifier of the module.
+	// It is used to resolve a ModuleTemplate for creating a set of resources on the cluster.
+	//
+	// Name can only be the ModuleName label value of the module-template, e.g. operator.kyma-project.io/module-name=my-module
+	Name string `json:"name"`
+
+	// ControllerName is able to set the controller used for reconciliation of the module. It can be used
+	// together with Cache Configuration on the Operator responsible for the templated Modules to split
+	// workload.
+	ControllerName string `json:"controller,omitempty"`
+
+	// Channel is the desired channel of the Module. If this changes or is set, it will be used to resolve a new
+	// ModuleTemplate based on the new resolved resources.
+	// +kubebuilder:validation:Pattern:=^[a-z]+$
+	// +kubebuilder:validation:MaxLength:=32
+	// +kubebuilder:validation:MinLength:=3
+	Channel string `json:"channel,omitempty"`
+
+	// Version is the desired version of the Module. If this changes or is set, it will be used to resolve a new
+	// ModuleTemplate based on this specific version.
+	// The Version and Channel are mutually exclusive options.
+	// The regular expression come from here: https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+	// json:"-" to disable installation of specific versions until decided to roll this out
+	// see https://github.com/kyma-project/lifecycle-manager/issues/1847
+	Version string `json:"-"`
+
+	// RemoteModuleTemplateRef is deprecated and will no longer have any functionality.
+	// It will be removed in the upcoming API version.
+	RemoteModuleTemplateRef string `json:"remoteModuleTemplateRef,omitempty"`
+
+	// +kubebuilder:default:=CreateAndDelete
+	CustomResourcePolicy `json:"customResourcePolicy,omitempty"`
+
+	// Managed is determining whether the module is managed or not. If the module is unmanaged, the user is responsible
+	// for the lifecycle of the module.
+	// +kubebuilder:default:=true
+	Managed bool `json:"managed"`
+}
+
+// CustomResourcePolicy determines how a ModuleTemplate should be parsed. When CustomResourcePolicy is set to
+// CustomResourcePolicyCreateAndDelete, the Manifest will receive instructions to create it on installation with
+// the default values provided in ModuleTemplate, and to remove it when the module or Kyma is deleted.
+// +kubebuilder:validation:Enum=CreateAndDelete;Ignore
+type CustomResourcePolicy string
+
+const (
+	// CustomResourcePolicyCreateAndDelete causes the Manifest to contain the default data provided in ModuleTemplate.
+	// While Updates from the Data are never propagated, the resource is deleted on module removal.
+	CustomResourcePolicyCreateAndDelete = "CreateAndDelete"
+	// CustomResourcePolicyIgnore does not pass the Data from ModuleTemplate.
+	// This ensures the user of the module is able to initialize the Module without any default configuration.
+	// This is useful if another controller should manage module configuration as data and not be auto-initialized.
+	// It can also be used to initialize controllers without interacting with them.
+	CustomResourcePolicyIgnore = "Ignore"
+)
+
 //nolint:gochecknoinits // registers Kyma CRD on startup
 func init() {
 	SchemeBuilder.Register(&Kyma{}, &KymaList{})

api/v1beta1/last_operation.go

@@ -0,0 +1,12 @@
+package v1beta1
+
+import (
+	apimetav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// LastOperation defines the last operation from the control-loop.
+// +k8s:deepcopy-gen=true
+type LastOperation struct {
+	Operation      string         `json:"operation"`
+	LastUpdateTime apimetav1.Time `json:"lastUpdateTime,omitempty"`
+}

api/v1beta1/manifest_types.go

@@ -18,9 +18,8 @@ package v1beta1
 
 import (
 	apimetav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-
-	"github.com/kyma-project/lifecycle-manager/api/shared"
-	"github.com/kyma-project/lifecycle-manager/api/v1beta2"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	machineryruntime "k8s.io/apimachinery/pkg/runtime"
 )
 
 // +kubebuilder:object:root=true
@@ -35,10 +34,74 @@ type Manifest struct {
 	apimetav1.TypeMeta   `json:",inline"`
 	apimetav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   v1beta2.ManifestSpec `json:"spec,omitempty"`
-	Status shared.Status        `json:"status,omitempty"`
+	Spec   ManifestSpec `json:"spec,omitempty"`
+	Status Status       `json:"status,omitempty"`
+}
+
+// ManifestSpec defines the desired state of Manifest.
+type ManifestSpec struct {
+	// Remote indicates if Manifest should be installed on a remote cluster
+	Remote bool `json:"remote"`
+
+	// Version specifies current Resource version
+	// +optional
+	Version string `json:"version,omitempty"`
+
+	// Config specifies OCI image configuration for Manifest
+	Config *ImageSpec `json:"config,omitempty"`
+
+	// Install specifies a list of installations for Manifest
+	Install InstallInfo `json:"install"`
+
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +kubebuilder:validation:XEmbeddedResource
+	// +nullable
+	// Resource specifies a resource to be watched for state updates
+	Resource *unstructured.Unstructured `json:"resource,omitempty"`
+
+	// +kubebuilder:default:=CreateAndDelete
+	CustomResourcePolicy `json:"customResourcePolicy,omitempty"`
+}
+
+// InstallInfo defines installation information.
+type InstallInfo struct {
+	// Source in the ImageSpec format
+	// +kubebuilder:pruning:PreserveUnknownFields
+	Source machineryruntime.RawExtension `json:"source"`
+
+	// Name specifies a unique install name for Manifest
+	Name string `json:"name"`
+}
+
+// ImageSpec defines OCI Image specifications.
+// +k8s:deepcopy-gen=true
+type ImageSpec struct {
+	// Repo defines the Image repo
+	Repo string `json:"repo,omitempty"`
+
+	// Name defines the Image name
+	Name string `json:"name,omitempty"`
+
+	// Ref is either a sha value, tag or version
+	Ref string `json:"ref,omitempty"`
+
+	// Type specifies the type of installation specification
+	// that could be provided as part of a custom resource.
+	// This time is used in codec to successfully decode from raw extensions.
+	// +kubebuilder:validation:Enum=helm-chart;oci-ref;"kustomize";""
+	Type RefTypeMetadata `json:"type,omitempty"`
+
+	// Deprecated: Field will be removed soon and is not supported anymore.
+	CredSecretSelector *apimetav1.LabelSelector `json:"credSecretSelector,omitempty"`
 }
 
+type RefTypeMetadata string
+
+const (
+	OciRefType RefTypeMetadata = "oci-ref"
+	OciDirType RefTypeMetadata = "oci-dir"
+)
+
 // +kubebuilder:object:root=true
 
 // ManifestList contains a list of Manifest.

api/v1beta1/moduletemplate_types.go

@@ -20,8 +20,6 @@ import (
 	apimetav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	machineryruntime "k8s.io/apimachinery/pkg/runtime"
-
-	"github.com/kyma-project/lifecycle-manager/api/v1beta2"
 )
 
 // ModuleTemplate is a representation of a Template used for creating Module Instances within the Module Lifecycle.
@@ -84,13 +82,24 @@ type ModuleTemplateSpec struct {
 	// hint by downstream controllers to determine which client implementation to use for working with the Module
 	Target Target `json:"target"`
 
-	CustomStateCheck []*v1beta2.CustomStateCheck `json:"customStateCheck,omitempty"`
+	CustomStateCheck []*CustomStateCheck `json:"customStateCheck,omitempty"`
 
 	// RequiresDowntime indicates whether the module requires downtime in support of maintenance windows during module upgrades.
 	// +optional
 	RequiresDowntime bool `json:"requiresDowntime,omitempty"`
 }
 
+type CustomStateCheck struct {
+	// JSONPath specifies the JSON path to the state variable in the Module CR
+	JSONPath string `json:"jsonPath" yaml:"jsonPath"`
+
+	// Value is the value at the JSONPath for which the Module CR state should map with MappedState
+	Value string `json:"value" yaml:"value"`
+
+	// MappedState is the Kyma CR State
+	MappedState State `json:"mappedState" yaml:"mappedState"`
+}
+
 // +kubebuilder:object:root=true
 
 // ModuleTemplateList contains a list of ModuleTemplate.

api/v1beta1/resource.go

@@ -0,0 +1,28 @@
+package v1beta1
+
+import (
+	"strings"
+
+	apimetav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+// +k8s:deepcopy-gen=true
+type Resource struct {
+	Name                       string `json:"name"`
+	Namespace                  string `json:"namespace"`
+	apimetav1.GroupVersionKind `json:",inline"`
+}
+
+func (r Resource) ToUnstructured() *unstructured.Unstructured {
+	obj := unstructured.Unstructured{}
+	obj.SetGroupVersionKind(schema.GroupVersionKind(r.GroupVersionKind))
+	obj.SetName(r.Name)
+	obj.SetNamespace(r.Namespace)
+	return &obj
+}
+
+func (r Resource) ID() string {
+	return strings.Join([]string{r.Namespace, r.Name, r.Group, r.Version, r.Kind}, "/")
+}