Licensing support

.github/workflows/pr.yaml

@@ -70,9 +70,9 @@ jobs:
         cd $KUBEPLUS_HOME/platform-operator
         ./build-artifact.sh latest
 
-        #echo "Building kubeconfiggenerator..."
-        #cd $KUBEPLUS_HOME/deploy
-        #./build-artifact-kubeconfiggenerator.sh latest
+        echo "Building kubeconfiggenerator..."
+        cd $KUBEPLUS_HOME/deploy
+        ./build-artifact-kubeconfiggenerator.sh latest
         #echo "Building webhook_init_container..."
         #./build-artifact.sh latest
         #echo "Building resource cleaner..."
@@ -87,7 +87,7 @@ jobs:
         docker images
 
         echo "Installing KubePlus..."
-        helm install kubeplus ./deploy/kubeplus-chart --kubeconfig=kubeplus-saas-provider.json --set MUTATING_WEBHOOK=gcr.io/cloudark-kubeplus/pac-mutating-admission-webhook:latest --set PLATFORM_OPERATOR=gcr.io/cloudark-kubeplus/platform-operator:latest --set HELMER=gcr.io/cloudark-kubeplus/helm-pod:latest -n $KUBEPLUS_NS
+        helm install kubeplus ./deploy/kubeplus-chart --kubeconfig=kubeplus-saas-provider.json --set MUTATING_WEBHOOK=gcr.io/cloudark-kubeplus/pac-mutating-admission-webhook:latest --set PLATFORM_OPERATOR=gcr.io/cloudark-kubeplus/platform-operator:latest --set HELMER=gcr.io/cloudark-kubeplus/helm-pod:latest --set CRD_REGISTRATION_HELPER=gcr.io/cloudark-kubeplus/kubeconfiggenerator:latest  -n $KUBEPLUS_NS
 
         kubectl get pods -A
 

README.md

@@ -27,7 +27,7 @@ The KubePlus Operator does not need any admin-level permissions on a cluster for
 
 ### Resource utilization
 
-KubePlus provides controls to set per-namespace resource quotas. It also monitors usage of CPU, memory, storage, and network traffic at the application instance level. The collected metrics are available in different formats and can be pulled into Prometheus for historical usage tracking.
+KubePlus provides controls to set per-namespace resource quotas. It also monitors usage of CPU, memory, storage, and network traffic at the application instance level. The collected metrics are available in different formats and can be pulled into Prometheus for historical usage tracking. KubePlus also supports ability to define licenses for the CRDs. A license defines the number of application instances that can be created for that CRD, and an expiry date. KubePlus prevents creation of application instances if the license terms are not met.
 
 ### Upgrades
 
@@ -37,7 +37,8 @@ A new version of an application can be deployed by updating the application Helm
 
 ### Customization
 
-The spec properties of the Kubernetes CRD wrapping the application Helm chart are the fields defined in the chart’s values.yaml file. Application deployments can be customized by specifying different values for these spec properties.
+The spec properties of the Kubernetes CRD wrapping the application Helm chart are the fields defined in the chart’s values.yaml file. Application deployments can be customized by specifying different values for these spec properties. 
+
 
 ## Demo
 

deploy/kubeconfiggenerator.py

@@ -5,6 +5,7 @@
 import os
 import yaml
 import time
+from datetime import date
 
 from logging.config import dictConfig
 
@@ -1181,6 +1182,66 @@ def create_network_policy():
     return err_string
 
 
+@app.route("/checklicense")
+def check_license():
+    app.logger.info("Inside checklicense..")
+    namespace = request.args.get("namespace").strip()
+    kind = request.args.get("kind").strip()
+    app.logger.info("Namespace:" + namespace + " kind:" + kind)
+    license_cfgmap = kind.lower() + "-license"
+    app.logger.info("License configmap:" + license_cfgmap)
+    cmd = "kubectl get configmap " + license_cfgmap + " -n " + namespace + " -o json "
+    out, err = run_command(cmd)
+    if "NotFound" in err:
+        app.logger.info(str(err))
+        app.logger.info("License not defined. No checks are needed.")
+        return ""
+
+    json_op = json.loads(out)
+    allowed_instances = ""
+    expiry = ""
+    if "allowed_instances" in json_op["metadata"]["annotations"]:
+        allowed_instances = json_op["metadata"]["annotations"]["allowed_instances"]
+        app.logger.info("Allowed instances:" + allowed_instances)
+    if "expiry" in json_op["metadata"]["annotations"]:
+        expiry = json_op["metadata"]["annotations"]["expiry"]
+        app.logger.info("Expiry:" + expiry)
+
+    msg = ""
+
+    if allowed_instances != "":
+        cmd1 = "kubectl get " + kind
+        out1, err1 = run_command(cmd1)
+        created_instances = 0
+        for line in out1.split("\n"):
+            line = line.strip()
+            app.logger.info("Line:" + line + "\n")
+            if "NAME" not in line and "AGE" not in line and line != "":
+                created_instances = created_instances + 1
+        app.logger.info("Already created instances:" + str(created_instances))
+
+        if created_instances >= int(allowed_instances):
+            msg = msg + "Allowed number of instances reached."
+
+    if expiry != "":
+        parts = expiry.split("/")
+        if len(parts) == 3 :
+            month = int(parts[0].strip())
+            day = int(parts[1].strip())
+            year = int(parts[2].strip())
+
+            expiry_date = date(year, month, day)
+            today = date.today()
+            app.logger.info("Expiry date:" + str(expiry_date))
+            app.logger.info("Today:" + str(today))
+            if today > expiry_date:
+                msg = msg + " License expired (expiry date):" + str(expiry) + "."
+
+    app.logger.info("License check message:" + msg)
+
+    return msg
+
+
 @app.route("/resource_quota")
 def create_resource_quota():
     app.logger.info("Inside create_resource_quota..")

examples/multitenancy/hello-world/hs2.yaml

@@ -3,5 +3,6 @@ kind: HelloWorldService
 metadata:
   name: hs2
 spec:
-  greeting: Hello1 hello hello
+  greeting: Hello hello hello - hs2
+  replicas: 1 
 

mutating-webhook/utils.go

@@ -814,10 +814,10 @@ func GetPlural(kind, group string) []byte {
 }
 
 func CheckResource(kind, plural string) []byte {
-	fmt.Printf("Inside CheckResource...\n")
+	//fmt.Printf("Inside CheckResource...\n")
 	args := fmt.Sprintf("kind=%s&plural=%s", kind, plural)
 	url1 := fmt.Sprintf("http://%s:%s/apis/kubeplus/checkResource?%s", serviceHost, servicePort, args)
-	fmt.Printf("Url:%s\n", url1)
+	//fmt.Printf("Url:%s\n", url1)
 	body := queryKubeDiscoveryService(url1)
 	return body
 }
@@ -862,14 +862,25 @@ func QueryDeployEndpoint(platformworkflow, customresource, namespace, overrides,
         CreateOverrides(platformworkflow, customresource)
 
 	args := fmt.Sprintf("platformworkflow=%s&customresource=%s&namespace=%s&overrides=%s&cpu_req=%s&cpu_lim=%s&mem_req=%s&mem_lim=%s&labels=%s", platformworkflow, customresource, namespace, encodedOverrides, cpu_req, cpu_lim, mem_req, mem_lim,labels)
-	fmt.Printf("Inside QueryDeployEndpoint...\n")
+	//fmt.Printf("Inside QueryDeployEndpoint...\n")
 	var url1 string
 	url1 = fmt.Sprintf("http://%s:%s/apis/kubeplus/deploy?%s", serviceHost, servicePort, args)
-	fmt.Printf("Url:%s\n", url1)
+	//fmt.Printf("Url:%s\n", url1)
 	body := queryKubeDiscoveryService(url1)
 	return body
 }
 
+func CheckLicense(kind, webhook_namespace string) string {
+	//fmt.Printf("Inside CheckLicense...\n")
+	args := fmt.Sprintf("kind=%s&namespace=%s", kind, webhook_namespace)
+	var url1 string
+	url1 = fmt.Sprintf("http://%s:%s/checklicense?%s", serviceHost, verificationServicePort, args)
+	//fmt.Printf("Url:%s\n", url1)
+	body := queryKubeDiscoveryService(url1)
+	bodyString := string(body)
+	return bodyString
+}
+
 func DryRunChart(platformworkflow, namespace string) []byte {
 	args := fmt.Sprintf("platformworkflow=%s&namespace=%s&dryrun=true", platformworkflow, namespace)
 	fmt.Printf("Inside DryRunChart...\n")
@@ -892,25 +903,25 @@ func TestChartDeployment(kind, namespace, chartName, chartURL string) []byte {
 }
 
 func CreateOverrides(platformworkflow, customresource string) []byte {
-	fmt.Printf("Inside CreateOverrides...\n")
+	//fmt.Printf("Inside CreateOverrides...\n")
 	args := fmt.Sprintf("platformworkflow=%s&customresource=%s", platformworkflow, customresource)
 	var url1 string
 	url1 = fmt.Sprintf("http://%s:%s/overrides?%s", serviceHost, verificationServicePort, args)
-	fmt.Printf("Url:%s\n", url1)
+	//fmt.Printf("Url:%s\n", url1)
 	body := queryKubeDiscoveryService(url1)
 	return body
 }
 
 func CheckClusterCapacity(cpuRequests, cpuLimits, memRequests, memLimits string) (bool, string) {
-	fmt.Printf("Inside CheckClusterCapacity...\n")
+	//fmt.Printf("Inside CheckClusterCapacity...\n")
 	var url1 string
 	url1 = fmt.Sprintf("http://%s:%s/cluster_capacity", serviceHost, verificationServicePort)
-	fmt.Printf("Url:%s\n", url1)
+	//fmt.Printf("Url:%s\n", url1)
 	body := queryKubeDiscoveryService(url1)
 
 	var clusterCapacity ClusterCapacity
         json.Unmarshal(body, &clusterCapacity)
-	fmt.Printf("Cluster Capacity:%v\n", clusterCapacity)
+	//fmt.Printf("Cluster Capacity:%v\n", clusterCapacity)
 
 	bodyString := string(body)
 	//jsonresp := bodyString.(map[string]string) 
@@ -926,9 +937,9 @@ func CheckClusterCapacity(cpuRequests, cpuLimits, memRequests, memLimits string)
 	memParts := strings.Split(parts[1],":")
 	totalAllocatableMemoryGB, _ := strconv.ParseFloat(strings.TrimSpace(memParts[1]), 64)
 
-	fmt.Printf("Total Allocatable CPU:%d\n", totalAllocatableCPU)
+	/*fmt.Printf("Total Allocatable CPU:%d\n", totalAllocatableCPU)
 	fmt.Printf("Total Allocatable Memory:%f\n", totalAllocatableMemoryGB)
-
+	*/
 	cpuRequestsI, _ := strconv.Atoi(strings.TrimSpace(strings.ReplaceAll(cpuRequests, "m", "")))
 	cpuLimitsI, _ := strconv.Atoi(strings.TrimSpace(strings.ReplaceAll(cpuLimits, "m", "")))
 
@@ -962,23 +973,23 @@ func GetExistingResourceCompositions() []byte {
 }
 
 func CheckChartExists(chartURL string) []byte {
-	fmt.Printf("Inside CheckChartExists...\n")
+	//fmt.Printf("Inside CheckChartExists...\n")
 	encodedChartURL := url.QueryEscape(chartURL)
 	args := fmt.Sprintf("chartURL=%s", encodedChartURL)
 	var url1 string
 	url1 = fmt.Sprintf("http://%s:%s/checkchartexists?%s", serviceHost, verificationServicePort, args)
-	fmt.Printf("Url:%s\n", url1)
+	//fmt.Printf("Url:%s\n", url1)
 	body := queryKubeDiscoveryService(url1)
 	return body
 }
 
 func LintChart(chartURL string) []byte {
-	fmt.Printf("Inside LintChart...\n")
+	//fmt.Printf("Inside LintChart...\n")
 	encodedChartURL := url.QueryEscape(chartURL)
 	args := fmt.Sprintf("chartURL=%s", encodedChartURL)
 	var url1 string
 	url1 = fmt.Sprintf("http://%s:%s/dryrunchart?%s", serviceHost, verificationServicePort, args)
-	fmt.Printf("Url:%s\n", url1)
+	//fmt.Printf("Url:%s\n", url1)
 	body := queryKubeDiscoveryService(url1)
 	return body
 }
@@ -1015,10 +1026,10 @@ func QueryCompositionEndpoint(kind, namespace, crdKindName string) []byte {
 
 func GetValuesYaml(platformworkflow, namespace string) []byte {
 	args := fmt.Sprintf("platformworkflow=%s&namespace=%s", platformworkflow, namespace)
-	fmt.Printf("Inside GetValuesYaml...\n")
+	//fmt.Printf("Inside GetValuesYaml...\n")
 	var url1 string
 	url1 = fmt.Sprintf("http://%s:%s/apis/kubeplus/getchartvalues?%s", serviceHost, servicePort, args)
-	fmt.Printf("Url:%s\n", url1)
+	//fmt.Printf("Url:%s\n", url1)
 	body := queryKubeDiscoveryService(url1)
 	return body
 }
@@ -1052,7 +1063,7 @@ func getServiceEndpoint(servicename string) (string, string) {
 
 // Rename this function to a more generic name since we use it to trigger Custom Resource deployment as well.
 func queryKubeDiscoveryService(url1 string) []byte {
-	fmt.Printf("..inside queryKubeDiscoveryService")
+	//fmt.Printf("..inside queryKubeDiscoveryService")
 	u, err := url.Parse(url1)
 	//fmt.Printf("URL:%s\n",u)
 	if err != nil {
@@ -1074,9 +1085,9 @@ func queryKubeDiscoveryService(url1 string) []byte {
 	defer resp.Body.Close()
 	resp_body, _ := ioutil.ReadAll(resp.Body)
 
-	fmt.Println("Response status:%s\n",resp.Status)
-	fmt.Println("Response body:%s\n",string(resp_body))
-	fmt.Println("Exiting queryKubeDiscoveryService")
+	//fmt.Println("Response status:%s\n",resp.Status)
+	//fmt.Println("Response body:%s\n",string(resp_body))
+	//fmt.Println("Exiting queryKubeDiscoveryService")
 	return resp_body
 }