introduce VMAnomalyModel

Author: AndrewChubatiuk

PROJECT

@@ -249,4 +249,16 @@ resources:
   webhooks:
     validation: true
     webhookVersion: v1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: victoriametrics.com
+  group: operator
+  kind: VMAnomalyModel
+  path: github.com/VictoriaMetrics/operator/api/operator/v1
+  version: v1
+  webhooks:
+    validation: true
+    webhookVersion: v1
 version: "3"

api/operator/v1/vmanomaly_types.go

@@ -94,6 +94,18 @@ type VMAnomalySpec struct {
 	// Monitoring configures how expose anomaly metrics
 	// See https://docs.victoriametrics.com/anomaly-detection/components/monitoring/
 	Monitoring *VMAnomalyMonitoringSpec `json:"monitoring,omitempty"`
+	// ModelSelector defines VMAnomalyModels to be selected for anomaly detection.
+	// Works in combination with ModelNamespaceSelector.
+	// ModelNamespaceSelector nil - only objects at VMAnomaly namespace.
+	// Selector nil - only objects at ModelNamespaceSelector namespaces.
+	// +optional
+	ModelSelector *metav1.LabelSelector `json:"modelSelector,omitempty"`
+	// ModelNamespaceSelector Namespaces to be selected for VMAnomalyModel discovery.
+	// Works in combination with ModelSelector.
+	// ModelNamespaceSelector nil - only objects at VMAnomaly namespace.
+	// Selector nil - only objects at ModelNamespaceSelector namespaces.
+	// +optional
+	ModelNamespaceSelector *metav1.LabelSelector `json:"modelNamespaceSelector,omitempty"`
 	// License allows to configure license key to be used for enterprise features.
 	// Using license key is supported starting from VictoriaMetrics v1.94.0.
 	// See [here](https://docs.victoriametrics.com/enterprise)
@@ -103,6 +115,7 @@ type VMAnomalySpec struct {
 	// +optional
 	ServiceAccountName                          string `json:"serviceAccountName,omitempty"`
 	vmv1beta1.CommonDefaultableParams           `json:",inline,omitempty"`
+	vmv1beta1.CommonConfigReloaderParams        `json:",inline,omitempty"`
 	vmv1beta1.CommonApplicationDeploymentParams `json:",inline,omitempty"`
 }
 
@@ -340,6 +353,11 @@ func (cr *VMAnomaly) GetServiceAccountName() string {
 	return cr.Spec.ServiceAccountName
 }
 
+// AsCRDOwner implements interface
+func (*VMAnomaly) AsCRDOwner() []metav1.OwnerReference {
+	return vmv1beta1.GetCRDAsOwner(vmv1beta1.Anomaly)
+}
+
 // IsOwnsServiceAccount checks if ServiceAccountName is set explicitly
 func (cr *VMAnomaly) IsOwnsServiceAccount() bool {
 	return cr.Spec.ServiceAccountName == ""
@@ -454,6 +472,10 @@ func (cr *VMAnomaly) UnmarshalJSON(src []byte) error {
 	return nil
 }
 
+func (cr *VMAnomaly) GetClusterRoleName() string {
+	return fmt.Sprintf("monitoring:%s:vmanomaly-%s", cr.Namespace, cr.Name)
+}
+
 // UnmarshalJSON implements json.Unmarshaler interface
 func (cr *VMAnomalySpec) UnmarshalJSON(src []byte) error {
 	type pcr VMAnomalySpec
@@ -464,6 +486,16 @@ func (cr *VMAnomalySpec) UnmarshalJSON(src []byte) error {
 	return nil
 }
 
+// IsUnmanaged checks if object should managed any config objects
+func (cr *VMAnomaly) IsUnmanaged() bool {
+	return cr.IsModelUnmanaged()
+}
+
+// IsModelUnmanaged checks if object should managed model config objects
+func (cr *VMAnomaly) IsModelUnmanaged() bool {
+	return cr.Spec.ModelSelector == nil && cr.Spec.ModelNamespaceSelector == nil
+}
+
 // +kubebuilder:object:root=true
 
 // VMAnomalyList contains a list of VMAnomaly.

api/operator/v1/vmanomalymodel_types.go

@@ -0,0 +1,82 @@
+/*
+
+
+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 v1
+
+import (
+	"encoding/json"
+	"fmt"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+
+	vmv1beta1 "github.com/VictoriaMetrics/operator/api/operator/v1beta1"
+)
+
+// VMAnomalyModelSpec defines the desired state of VMAnomalyModel.
+type VMAnomalyModelSpec struct {
+	// ParsingError contents error with context if operator was failed to parse json object from kubernetes api server
+	ParsingError string `json:"-" yaml:"-"`
+	// Class defines anomaly detection model class
+	Class string `json:"class" yaml:"class"`
+	// Params defines anomaly detection model params
+	Params runtime.RawExtension `json:"params,omitempty" yaml:"params,omitempty"`
+}
+
+// UnmarshalJSON implements json.Unmarshaler interface
+func (cr *VMAnomalyModelSpec) UnmarshalJSON(src []byte) error {
+	type pcr VMAnomalyModelSpec
+	if err := json.Unmarshal(src, (*pcr)(cr)); err != nil {
+		cr.ParsingError = fmt.Sprintf("cannot parse spec: %s, err: %s", string(src), err)
+		return nil
+	}
+	return nil
+}
+
+// VMAnomalyModelStatus defines the observed state of VMAnomalyModel.
+type VMAnomalyModelStatus struct {
+	vmv1beta1.StatusMetadata `json:",inline"`
+}
+
+// GetStatusMetadata returns metadata for object status
+func (cr *VMAnomalyModel) GetStatusMetadata() *vmv1beta1.StatusMetadata {
+	return &cr.Status.StatusMetadata
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+
+// VMAnomalyModel is the Schema for the vmanomalymodels API.
+type VMAnomalyModel struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   VMAnomalyModelSpec   `json:"spec,omitempty"`
+	Status VMAnomalyModelStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// VMAnomalyModelList contains a list of VMAnomalyModel.
+type VMAnomalyModelList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []VMAnomalyModel `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&VMAnomalyModel{}, &VMAnomalyModelList{})
+}

api/operator/v1/zz_generated.deepcopy.go

@@ -14,6 +14,7 @@ type CRDName int
 
 const (
 	Agent CRDName = iota
+	Anomaly
 )
 
 func (c CRDName) String() string {
@@ -40,6 +41,8 @@ func Init(ctx context.Context, rclient client.Client) error {
 		switch item.Name {
 		case "vmagents.operator.victoriametrics.com":
 			n = Agent
+		case "vmanomalies.operator.victoriametrics.com":
+			n = Anomaly
 		default:
 			continue
 		}

api/operator/v1beta1/owner.go

@@ -22,6 +22,7 @@ resources:
 - bases/operator.victoriametrics.com_vlsingles.yaml
 - bases/operator.victoriametrics.com_vlclusters.yaml
 - bases/operator.victoriametrics.com_vmanomalies.yaml
+- bases/operator.victoriametrics.com_vmanomalymodels.yaml
 patches:
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix.
 # patches here are for enabling the conversion webhook for each CRD