feat: introduces OSSM plugin for KfDef

.gitignore

@@ -52,6 +52,15 @@ components/gcp-click-to-deploy/src/user_config/**
 **/reg_tmp
 scripts/gke/build/**
 
+# test artifacts
+**/ginkgo-test-results.xml
+
+## test binary, build with `go test -c`
+*.test
+
+## output of the go coverage tools
+*.out
+
 # test data
 tests/data/test-data.tar.gz
 # Ignore downloaded odh manifests

Makefile

@@ -115,6 +115,11 @@ vet: ## Run go vet against code.
 test: manifests generate fmt vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out
 
+.PHONY: test-ossm
+test-ossm: manifests generate fmt vet envtest ## Run tests.
+	go test ./pkg/kfapp/ossm/... -coverprofile cover.out
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./tests/integration/... -coverprofile cover.out
+
 ##@ Build
 
 .PHONY: build

apis/apps/group.go

@@ -163,6 +163,7 @@ const (
 	GCP              = "gcp"
 	MINIKUBE         = "minikube"
 	EXISTING_ARRIKTO = "existing_arrikto"
+	OSSM             = "ossm"
 )
 
 // PackageManagers

apis/kfdef.apps.kubeflow.org/v1/kfdef_types.go

@@ -89,6 +89,8 @@ type Plugin struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
+	// +optional
+	// +kubebuilder:pruning:PreserveUnknownFields
 	Spec *runtime.RawExtension `json:"spec,omitempty"`
 }
 

apis/ossm.plugins.kubeflow.org/v1alpha1/groupversion_info.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2023.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package v1alpha1 contains API Schema definitions for the gcp.plugins.kubeflow.org v1alpha1 API group
+// +kubebuilder:object:generate=true
+// +groupName=ossm.plugins.kubeflow.org
+package v1alpha1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+var (
+	// GroupVersion is group version used to register these objects
+	GroupVersion = schema.GroupVersion{Group: "ossm.plugins.kubeflow.org", Version: "v1alpha1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+
+	// AddToScheme adds the types in this group-version to the given scheme.
+	AddToScheme = SchemeBuilder.AddToScheme
+)

apis/ossm.plugins.kubeflow.org/v1alpha1/ossm_types.go

@@ -0,0 +1,154 @@
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// +k8s:openapi-gen=true
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+type OssmPlugin struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   OssmPluginSpec   `json:"spec,omitempty"`
+	Status OssmPluginStatus `json:"status,omitempty"`
+}
+
+// OssmPluginSpec defines configuration needed for Openshift Service Mesh
+// for integration with Opendatahub.
+type OssmPluginSpec struct {
+	// Mesh holds configuration of Service Mesh used by Opendatahub.
+	Mesh MeshSpec `json:"mesh,omitempty"`
+	// Auth holds configuration of authentication and authorization services
+	// used by Service Mesh in Opendatahub.
+	Auth AuthSpec `json:"auth,omitempty"`
+}
+
+// InstallationMode defines how the plugin should handle OpenShift Service Mesh installation.
+// If not specified `pre-installed` is assumed.
+type InstallationMode string
+
+var (
+	// PreInstalled indicates that KfDef plugin for Openshift Service Mesh will use existing
+	// installation and patch Service Mesh Control Plane.
+	PreInstalled InstallationMode = "pre-installed"
+
+	// Minimal results in installing Openshift Service Mesh Control Plane
+	// in defined namespace with minimal required configuration.
+	Minimal InstallationMode = "minimal"
+)
+
+// MeshSpec holds information on how Service Mesh should be configured.
+type MeshSpec struct {
+	// Name is a name Service Mesh Control Plan. Defaults to "basic".
+	Name string `json:"name,omitempty"`
+	// Namespace is a namespace where Service Mesh is deployed. Defaults to "istio-system".
+	Namespace string `json:"namespace,omitempty"`
+	// InstallationMode defines how the plugin should handle OpenShift Service Mesh installation.
+	// If not specified `pre-installed` is assumed.
+	// +kubebuilder:validation:Enum=minimal;pre-installed
+	InstallationMode InstallationMode `json:"installationMode,omitempty"`
+	// Certificate allows to define how to use certificates for the Service Mesh communication.
+	Certificate CertSpec `json:"certificate,omitempty"`
+}
+
+type CertSpec struct {
+	// Name of the certificate to be used by Service Mesh.
+	Name string `json:"name,omitempty"`
+	// Generate indicates if the certificate should be generated. If set to false
+	// it will assume certificate with the given name is made available as a secret
+	// in Service Mesh namespace.
+	Generate bool `json:"generate,omitempty"`
+}
+
+type AuthSpec struct {
+	// Name of the authorization provider used for Service Mesh.
+	Name string `json:"name,omitempty"`
+	// Namespace where it is deployed.
+	Namespace string `json:"namespace,omitempty"`
+	// Authorino holds configuration of Authorino service used as external authorization provider.
+	Authorino AuthorinoSpec `json:"authorino,omitempty"`
+}
+
+type AuthorinoSpec struct {
+	// Name specifies how external authorization provider should be called.
+	Name string `json:"name,omitempty"`
+	// Audiences is a list of the identifiers that the resource server presented
+	// with the token identifies as. Audience-aware token authenticators will verify
+	// that the token was intended for at least one of the audiences in this list.
+	// If no audiences are provided, the audience will default to the audience of the
+	// Kubernetes apiserver (kubernetes.default.svc).
+	Audiences []string `json:"audiences,omitempty"`
+	// Label narrows amount of AuthConfigs to process by Authorino service.
+	Label string `json:"label,omitempty"`
+	// Image allows to define a custom container image to be used when deploying Authorino's instance.
+	Image string `json:"image,omitempty"`
+}
+
+// OssmPluginStatus defines the observed state of OssmPlugin
+type OssmPluginStatus struct {
+	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+	// TODO model conditions
+}
+
+//+kubebuilder:object:root=true
+
+// OssmPluginList contains a list of OssmPlugins
+type OssmPluginList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []OssmPlugin `json:"items"`
+}
+
+// OssmResourceTracker is a cluster-scoped resource for tracking objects
+// created by Ossm plugin. It's primarily used as owner reference
+// for resources created across namespaces so that they can be
+// garbage collected by Kubernetes when they're not needed anymore.
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:scope=Cluster
+type OssmResourceTracker struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   OssmResourceTrackerSpec   `json:"spec,omitempty"`
+	Status OssmResourceTrackerStatus `json:"status,omitempty"`
+}
+
+func (o *OssmResourceTracker) ToOwnerReference() metav1.OwnerReference {
+	return metav1.OwnerReference{
+		APIVersion: o.APIVersion,
+		Kind:       o.Kind,
+		Name:       o.Name,
+		UID:        o.UID,
+	}
+}
+
+// OssmResourceTrackerSpec defines the desired state of OssmResourceTracker
+type OssmResourceTrackerSpec struct {
+}
+
+// OssmResourceTrackerStatus defines the observed state of OssmResourceTracker
+type OssmResourceTrackerStatus struct {
+}
+
+// +kubebuilder:object:root=true
+
+// OssmResourceTrackerList contains a list of OssmResourceTracker
+type OssmResourceTrackerList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []OssmResourceTracker `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(
+		&OssmPlugin{},
+		&OssmPluginList{},
+		&OssmResourceTracker{},
+		&OssmResourceTrackerList{},
+	)
+}