Initial NEMO PoC

Author: RobGeada

PROJECT

@@ -23,7 +23,6 @@ resources:
 - api:
     crdVersion: v1
     namespaced: true
-  controller: false
   domain: opendatahub.io
   group: trustyai
   kind: TrustyAIService
@@ -51,4 +50,13 @@ resources:
   kind: GuardrailsOrchestrator
   path: github.com/trustyai-explainability/trustyai-service-operator/api/gorch/v1alpha1
   version: v1alpha1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: opendatahub.io
+  group: trustyai
+  kind: NemoGuardrails
+  path: github.com/trustyai-explainability/trustyai-service-operator/api/v1alpha1
+  version: v1alpha1
 version: "3"

api/common/condition.go

@@ -0,0 +1,27 @@
+package common
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+type Condition struct {
+	Type string `json:"type" description:"type of condition ie. Available|Progressing|Degraded."`
+
+	Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`
+
+	// +optional
+	Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"`
+
+	// +optional
+	Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"`
+
+	// +optional
+	LastTransitionTime metav1.Time `json:"lastTransitionTime" description:"last time the condition transit from one status to another"`
+}
+
+// DeepCopyInto copies all properties of this object into another object of the same type.
+func (in *Condition) DeepCopyInto(out *Condition) {
+	*out = *in
+	in.LastTransitionTime.DeepCopyInto(&out.LastTransitionTime)
+}

api/gorch/v1alpha1/guardrailsorchestrator_types.go

@@ -17,8 +17,7 @@ limitations under the License.
 package v1alpha1
 
 import (
-	corev1 "k8s.io/api/core/v1"
-
+	"github.com/trustyai-explainability/trustyai-service-operator/api/common"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -32,7 +31,7 @@ type GuardrailsOrchestratorSpec struct {
 
 	// Number of replicas
 	Replicas int32 `json:"replicas"`
-	// Name of configmap containing generator,detector,and chunker arguments
+	// Name of configmap containing generator, detector, and chunker arguments
 	OrchestratorConfig *string `json:"orchestratorConfig"`
 	// Boolean flag to enable/disable built-in detectors
 	// +optional
@@ -73,29 +72,12 @@ type OtelExporter struct {
 	OTLPExport string `json:"otlpExport,omitempty"`
 }
 
-type ConditionType string
-
-type Condition struct {
-	Type ConditionType `json:"type" description:"type of condition ie. Available|Progressing|Degraded."`
-
-	Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`
-
-	// +optional
-	Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"`
-
-	// +optional
-	Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"`
-
-	// +optional
-	LastTransitionTime metav1.Time `json:"lastTransitionTime" description:"last time the condition transit from one status to another"`
-}
-
 type GuardrailsOrchestratorStatus struct {
 	Phase string `json:"phase,omitempty"`
 
 	// Conditions describes the state of the GuardrailsOrchestrator resource.
 	// +optional
-	Conditions []Condition `json:"conditions,omitempty"`
+	Conditions []common.Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true

api/gorch/v1alpha1/zz_generated.deepcopy.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 trustyai v1alpha1 API group
+// +kubebuilder:object:generate=true
+// +groupName=trustyai.opendatahub.io
+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: "trustyai.opendatahub.io", 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
+)

api/nemo/v1alpha1/groupversion_info.go

@@ -0,0 +1,70 @@
+/*
+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
+
+import (
+	"github.com/trustyai-explainability/trustyai-service-operator/api/common"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
+
+// NemoGuardrailsSpec defines the desired state of NemoGuardrails
+type NemoGuardrailsSpec struct {
+	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+
+	// NemoConfig should be the name of the configmap containing the NeMO server configuration
+	NemoConfig string `json:"nemoConfig,omitempty"`
+}
+
+// NemoGuardrailStatus defines the observed state of NemoGuardrails
+type NemoGuardrailStatus struct {
+	Phase string `json:"phase,omitempty"`
+
+	// Conditions describes the state of the NemoGuardrails resource.
+	// +optional
+	Conditions []common.Condition `json:"conditions,omitempty"`
+	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// NemoGuardrails is the Schema for the nemoguardrails API
+type NemoGuardrails struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   NemoGuardrailsSpec  `json:"spec,omitempty"`
+	Status NemoGuardrailStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// NemoGuardrailsList contains a list of NemoGuardrails
+type NemoGuardrailsList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []NemoGuardrails `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&NemoGuardrails{}, &NemoGuardrailsList{})
+}