Add resource calculator support for kubedb ops requests (#266)

Signed-off-by: Imtiaz Uddin <[email protected]>

Author: Imtiaz246

go.mod

@@ -46,8 +46,8 @@ require (
 	kmodules.xyz/custom-resources v0.25.2
 	kmodules.xyz/go-containerregistry v0.0.11
 	kmodules.xyz/monitoring-agent-api v0.25.4
-	kmodules.xyz/resource-metadata v0.17.26-0.20231009112556-f90c55e7954d
-	kmodules.xyz/resource-metrics v0.25.3
+	kmodules.xyz/resource-metadata v0.17.26
+	kmodules.xyz/resource-metrics v0.25.5
 	kmodules.xyz/sets v0.25.0
 	kubeops.dev/scanner v0.0.15
 	kubepack.dev/lib-helm v0.7.3
@@ -196,11 +196,11 @@ require (
 	go.uber.org/atomic v1.10.0 // indirect
 	go.uber.org/multierr v1.8.0 // indirect
 	go.uber.org/zap v1.23.0 // indirect
-	golang.org/x/crypto v0.13.0 // indirect
-	golang.org/x/net v0.15.0 // indirect
+	golang.org/x/crypto v0.14.0 // indirect
+	golang.org/x/net v0.17.0 // indirect
 	golang.org/x/oauth2 v0.7.0 // indirect
-	golang.org/x/sys v0.12.0 // indirect
-	golang.org/x/term v0.12.0 // indirect
+	golang.org/x/sys v0.13.0 // indirect
+	golang.org/x/term v0.13.0 // indirect
 	golang.org/x/text v0.13.0 // indirect
 	golang.org/x/time v0.3.0 // indirect
 	golang.org/x/tools v0.7.0 // indirect

go.sum

@@ -1395,8 +1395,8 @@ golang.org/x/crypto v0.0.0-20211215153901-e495a2d5b3d3/go.mod h1:IxCIyHEi3zRg3s0
 golang.org/x/crypto v0.0.0-20220131195533-30dcbda58838/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/crypto v0.0.0-20220315160706-3147a52a75dd/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
-golang.org/x/crypto v0.13.0 h1:mvySKfSWJ+UKUii46M40LOvyWfN0s2U+46/jDd0e6Ck=
-golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc=
+golang.org/x/crypto v0.14.0 h1:wBqGXzWJW6m1XrIKlAH0Hs1JJ7+9KBwnIO8v66Q9cHc=
+golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8=
@@ -1506,8 +1506,8 @@ golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su
 golang.org/x/net v0.0.0-20220325170049-de3da57026de/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
 golang.org/x/net v0.0.0-20220425223048-2871e0cb64e4/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
 golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
-golang.org/x/net v0.15.0 h1:ugBLEUaxABaB5AJqW9enI0ACdci2RUd4eP51NTBvuJ8=
-golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
+golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM=
+golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
@@ -1673,15 +1673,15 @@ golang.org/x/sys v0.0.0-20220708085239-5a0f0661e09d/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.12.0 h1:CM0HF96J0hcLAwsHPJZjfdNzs0gftsLfgKt57wWHJ0o=
-golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE=
+golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
-golang.org/x/term v0.12.0 h1:/ZfYdc3zq+q02Rv9vGqTeSItdzZTSNDmfTi0mBAuidU=
-golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU=
+golang.org/x/term v0.13.0 h1:bb+I9cTfFazGW51MZqBVmZy7+JEJMouUHTUSKVQLBek=
+golang.org/x/term v0.13.0/go.mod h1:LTmsnFJwVN6bCy1rVCoS+qHT1HhALEFxKncY3WNNh4U=
 golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
@@ -2141,10 +2141,10 @@ kmodules.xyz/monitoring-agent-api v0.25.4 h1:OwkvtV23QhUy3f7o9lxPWaAW3jiJMGAMPPR
 kmodules.xyz/monitoring-agent-api v0.25.4/go.mod h1:3LhrLDGQKQXhxYcjA/WNaO4HPpopYQzOutsEp2i3008=
 kmodules.xyz/offshoot-api v0.25.4 h1:IjJNvkphcdYUG8XO/pBwXpuP8W+jxAWJZ3yH8vgI/as=
 kmodules.xyz/offshoot-api v0.25.4/go.mod h1:PUk4EuJFhhyQykCflHj7EgXcljGIqs9vi0IN0RpxtY4=
-kmodules.xyz/resource-metadata v0.17.26-0.20231009112556-f90c55e7954d h1:E0SkGh/coySTCdes4ZLw9kBT+RaVMjNhzm6mycxhK7g=
-kmodules.xyz/resource-metadata v0.17.26-0.20231009112556-f90c55e7954d/go.mod h1:tyLxzAVkhlL3/jFdcQcX1RZ8i8h9bs+AJur5RcuaW40=
-kmodules.xyz/resource-metrics v0.25.3 h1:g9EjNfYRrUSnbA4r+bUQefQ5Ban6I6rpKjnB3ER+Yew=
-kmodules.xyz/resource-metrics v0.25.3/go.mod h1:H7YLdUQJXUSzf5cNI4IYWU4Wsmrua/jpw7gqDnE3BwM=
+kmodules.xyz/resource-metadata v0.17.26 h1:4wHVycXqnBIy+Tabo4CF1N1SQAQvHkEHFhNKw7FwJV8=
+kmodules.xyz/resource-metadata v0.17.26/go.mod h1:J1Pcm+DebjntCzzHw+e3ZKsO7pdAD7ZvriVY/+BMciU=
+kmodules.xyz/resource-metrics v0.25.5 h1:hQu6r2VtkmeiO7tpR5uYDWj7u7mKloaGZ1j8dH30b24=
+kmodules.xyz/resource-metrics v0.25.5/go.mod h1:y7pDmTWuVLNGSjwckKCwJFhCgi5fhbwS7PAcH2rmGcY=
 kmodules.xyz/sets v0.25.0 h1:belY/3trp/M/CKc1TEteA40jb2uCIdwKHhjpvrIxG+8=
 kmodules.xyz/sets v0.25.0/go.mod h1:ICWmplgCsxniWkImSBGlJrLT9npqOXKhX/Bwbc7bmEw=
 kubeops.dev/scanner v0.0.15 h1:u9hM2096LEa+BPlI/p7tcqvOv7A9fAFEw8AOEGHP5GY=

pkg/registry/meta/resourcecalculator/opsreq.go

@@ -0,0 +1,112 @@
+/*
+Copyright AppsCode Inc. and Contributors.
+
+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 resourcecalculator
+
+import (
+	"context"
+	"errors"
+	"strings"
+
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/types"
+	opsv1alpha1 "kmodules.xyz/resource-metrics/ops.kubedb.com/v1alpha1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+// ReferencedObjInfo indicates the information about the referenced database
+// object by the kubedb OpsRequest object
+type ReferencedObjInfo struct {
+	group     string
+	version   string
+	kind      string
+	name      string
+	namespace string
+}
+
+const (
+	DBGroup   = "kubedb.com"
+	DBVersion = "v1alpha2"
+)
+
+// wrapReferencedDBResourceWithOpsReqObject get the DB resource reference by the OpsRequest
+// object and wrap the DB object within it as 'referencedDB'
+func wrapReferencedDBResourceWithOpsReqObject(kc client.Client, u *unstructured.Unstructured) error {
+	opsReqObj := u.UnstructuredContent()
+	opsPathMapper, err := opsv1alpha1.LoadOpsPathMapper(u.UnstructuredContent())
+	if err != nil {
+		return err
+	}
+	refObjPath := opsPathMapper.GetReferencedDbObjectPath()
+	refObjNamePath := make([]string, len(refObjPath))
+	copy(refObjNamePath, refObjPath)
+	refObjNamePath[len(refObjNamePath)-1] = "name"
+
+	refObjInfo, err := getOpsRequestReferencedDbObjectInfo(u, refObjNamePath)
+	if err != nil {
+		return err
+	}
+	refDb, err := getReferencedDBResource(kc, refObjInfo)
+	if err != nil {
+		return err
+	}
+	err = unstructured.SetNestedMap(opsReqObj, refDb.UnstructuredContent(), refObjPath...)
+	if err != nil {
+		return err
+	}
+	u.Object = opsReqObj
+
+	return nil
+}
+
+// getOpsRequestReferencedDbObjectInfo extracts the referenced database information from OpsRequest object
+func getOpsRequestReferencedDbObjectInfo(u *unstructured.Unstructured, refObjNamePath []string) (*ReferencedObjInfo, error) {
+	refDbName, ok, err := unstructured.NestedString(u.UnstructuredContent(), refObjNamePath...)
+	if err != nil {
+		return nil, err
+	}
+	if !ok {
+		return nil, errors.New("referenced database name not found")
+	}
+	ns := u.GetNamespace()
+	kind := strings.TrimSuffix(u.GetKind(), "OpsRequest")
+
+	return &ReferencedObjInfo{
+		group:     DBGroup,
+		version:   DBVersion,
+		kind:      kind,
+		name:      refDbName,
+		namespace: ns,
+	}, nil
+}
+
+// getReferencedDBResource get the database object referenced by the OpsRequest object and returns it
+func getReferencedDBResource(kc client.Client, ri *ReferencedObjInfo) (*unstructured.Unstructured, error) {
+	dbRes := &unstructured.Unstructured{}
+	dbRes.SetGroupVersionKind(schema.GroupVersionKind{
+		Group:   ri.group,
+		Version: ri.version,
+		Kind:    ri.kind,
+	})
+
+	err := kc.Get(context.TODO(), types.NamespacedName{Name: ri.name, Namespace: ri.namespace}, dbRes)
+	if err != nil {
+		return nil, err
+	}
+
+	return dbRes, nil
+}

pkg/registry/meta/resourcecalculator/quota.go

@@ -0,0 +1,194 @@
+/*
+Copyright AppsCode Inc. and Contributors.
+
+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 resourcecalculator
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"strings"
+
+	core "k8s.io/api/core/v1"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	clustermeta "kmodules.xyz/client-go/cluster"
+	"kmodules.xyz/resource-metadata/apis/management/v1alpha1"
+	rsapi "kmodules.xyz/resource-metadata/apis/meta/v1alpha1"
+	"kmodules.xyz/resource-metrics/api"
+	opsv1alpha1 "kmodules.xyz/resource-metrics/ops.kubedb.com/v1alpha1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+func quota(obj map[string]interface{}, pq *v1alpha1.ProjectQuota) (*rsapi.QuotaDecision, error) {
+	qd := &rsapi.QuotaDecision{
+		Decision:   rsapi.DecisionAllow,
+		Violations: make([]string, 0),
+	}
+	if pq == nil {
+		qd.Decision = rsapi.DecisionNoOpinion
+		return qd, nil
+	}
+
+	gvk := getGVK(obj)
+	if gvk.Group == "ops.kubedb.com" {
+		opsPathMapper, err := opsv1alpha1.LoadOpsPathMapper(obj)
+		if err != nil {
+			return nil, err
+		}
+		dbObj, err := extractReferencedObject(obj, opsPathMapper.GetReferencedDbObjectPath()...)
+		if err != nil {
+			return nil, err
+		}
+		if err := deductRefDbObjResourceUsageFromProjectQuota(dbObj, pq); err != nil {
+			return nil, err
+		}
+		gvk = getGVK(dbObj)
+	}
+
+	c, err := api.Load(obj)
+	if err != nil {
+		return nil, err
+	}
+	dbRequests, err := c.AppResourceRequests(obj)
+	if err != nil {
+		return nil, err
+	}
+	dbLimits, err := c.AppResourceLimits(obj)
+	if err != nil {
+		return nil, err
+	}
+	dbDemand := mergeRequestsLimits(dbRequests, dbLimits)
+
+	for _, quota := range pq.Status.Quotas {
+		if quota.Result != v1alpha1.ResultSuccess {
+			continue
+		}
+		if quota.Group == gvk.Group {
+			if quota.Kind != "" && quota.Kind != gvk.Kind {
+				continue
+			}
+			newUsed := api.AddResourceList(quota.Used, dbDemand)
+			for rk, newUsed := range newUsed {
+				hard, found := quota.Hard[rk]
+				if !found {
+					continue
+				}
+				if newUsed.Cmp(hard) > 0 {
+					dd := dbDemand[rk]
+					du := quota.Used[rk]
+					dh := quota.Hard[rk]
+
+					qd.Decision = rsapi.DecisionDeny
+					qd.Violations = append(qd.Violations,
+						fmt.Sprintf("Project quota exceeded. Requested: %s=%s, Used: %s=%s, Limited: %s=%s", rk, dd.String(), rk, du.String(), rk, dh.String()))
+				}
+			}
+		}
+	}
+
+	return qd, nil
+}
+
+func deductRefDbObjResourceUsageFromProjectQuota(dbObj map[string]interface{}, pq *v1alpha1.ProjectQuota) error {
+	c, err := api.Load(dbObj)
+	if err != nil {
+		return err
+	}
+	dbRequests, err := c.AppResourceRequests(dbObj)
+	if err != nil {
+		return err
+	}
+	dbLimits, err := c.AppResourceLimits(dbObj)
+	if err != nil {
+		return err
+	}
+	dbDemand := mergeRequestsLimits(dbRequests, dbLimits)
+
+	gvk := getGVK(dbObj)
+	for i, quota := range pq.Status.Quotas {
+		if quota.Result != v1alpha1.ResultSuccess {
+			continue
+		}
+		if quota.Group == gvk.Group {
+			if quota.Kind != "" && quota.Kind != gvk.Kind {
+				continue
+			}
+			quota.Used = api.SubtractResourceList(quota.Used, dbDemand)
+		}
+		pq.Status.Quotas[i].Used = quota.Used
+	}
+
+	return nil
+}
+
+func mergeRequestsLimits(requests, limits core.ResourceList) core.ResourceList {
+	rl := make(core.ResourceList)
+	for k, r := range requests {
+		_, _, found := strings.Cut(k.String(), ".")
+		if !found {
+			rl["requests."+k] = r
+		} else {
+			rl[k] = r
+		}
+	}
+	for k, l := range limits {
+		_, _, found := strings.Cut(k.String(), ".")
+		if !found {
+			rl["limits."+k] = l
+		} else {
+			rl[k] = l
+		}
+	}
+
+	return rl
+}
+
+func getProjectQuota(kc client.Client, ns string) (*v1alpha1.ProjectQuota, error) {
+	projectId, _, err := clustermeta.GetProjectId(kc, ns)
+	if err != nil {
+		return nil, err
+	}
+	var pj v1alpha1.ProjectQuota
+	err = kc.Get(context.TODO(), client.ObjectKey{Name: projectId}, &pj)
+	if err != nil {
+		if apierrors.IsNotFound(err) {
+			return nil, nil
+		}
+		return nil, err
+	}
+	return &pj, nil
+}
+
+func getGVK(obj map[string]interface{}) schema.GroupVersionKind {
+	var unObj unstructured.Unstructured
+	unObj.SetUnstructuredContent(obj)
+
+	return unObj.GroupVersionKind()
+}
+
+func extractReferencedObject(opsObj map[string]interface{}, refDbPath ...string) (map[string]interface{}, error) {
+	if len(refDbPath) == 0 {
+		refDbPath = []string{"spec", "databaseRef", "referencedDB"}
+	}
+	dbObj, found, _ := unstructured.NestedMap(opsObj, refDbPath...)
+	if !found {
+		return nil, errors.New("referenced db object not found")
+	}
+
+	return dbObj, nil
+}