[SDO-2649] Kubernetes Optimizer Project

.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Release Charts
 on:
   push:
     branches:
-      - main
+      - gmudumbai/sdo-2649-k8s-optimizer
 
 jobs:
   release:
@@ -22,6 +22,8 @@ jobs:
           git config user.name "$GITHUB_ACTOR"
           git config user.email "[email protected]"
       - name: Run chart-releaser
-        uses: helm/[email protected]
+        uses: helm/[email protected]
+        with:
+          mark_as_latest: false
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

README.md

@@ -23,7 +23,7 @@ Use the helm chart to deploy the CloudHealth Collector into each [Kubernetes](ht
 - Helm 3.0+
 - CloudHealth API Token
 
-## Installing the Chart
+## Installing the Collector Chart
 
 To install the chart with the release name `cloudhealth-collector` in a particular namespace `<target_namespace>` (create if it does not exist), run the following commands:
 
@@ -49,6 +49,22 @@ These commands deploy the CloudHealth Collector on the Kubernetes cluster in the
 
 > **Tip**: List all releases using `helm list`
 
+## Installing the Collector & Optimizer Chart
+
+To install the chart with the release name `cloudhealth-collector-optimizer` in the `default` namespace, run the following commands:
+
+```console
+$ helm repo add cloudhealth https://cloudhealth.github.io/helm/
+$ helm install cloudhealth-collector-optimizer --set apiToken=<Unique Customer API Token>,clusterName=<Cluster Name>,chtEndpointPrefix=<Cloudhealth Endpoint Prefix>,optimizer.enabled=true,chapiKey=<CloudHealth API Key> cloudhealth/cloudhealth-collector
+```
+
+To install the chart with the release name `cloudhealth-collector-optimizer` in a specified namespace `<target_namespace>`, run the following commands:
+
+```console
+$ helm repo add cloudhealth https://cloudhealth.github.io/helm/
+$ helm install cloudhealth-collector-optimizer -n <target_namespace> --create-namespace --set apiToken=<Unique Customer API Token>,clusterName=<Cluster Name>,chtEndpointPrefix=<Cloudhealth Endpoint Prefix>,optimizer.enabled=true,chapiKey=<CloudHealth API Key> cloudhealth/cloudhealth-collector
+```
+
 ## Updating the Chart
 
 To update an existing release to the latest version of the chart, run the following command:

charts/cloudhealth-collector/Chart.yaml

@@ -3,10 +3,15 @@
 
 apiVersion: v2
 name: cloudhealth-collector
-description: A Helm chart for CloudHealth's Kubernetes Collector Agent
+description: A Helm chart for CloudHealth's Kubernetes Collector and Optimizer Agent
 type: application
-version: 4.6.1
+version: 6.0.0-beta
 appVersion: "7.0.0"
+dependencies:
+  - name: k8s-optimization
+    repository: oci://projects.packages.broadcom.com/kubernetes-optimization
+    version: 1.1.1
+    condition: optimizer.enabled
 home: https://cloudhealth.vmware.com/
 icon: https://d1fto35gcfffzn.cloudfront.net/images/Tanzu-Logomark.svg
 sources:

charts/cloudhealth-collector/templates/_helpers.tpl

@@ -73,3 +73,18 @@ Create the name of the secrets to use
 {{- define "cloudhealth-collector.secretName" -}}
 {{- default .Values.secretName }}
 {{- end }}
+
+{{/*
+Create the name for CH Optimizer Agent
+*/}}
+{{- define "cloudhealth-optimizer-agent.name" -}}
+{{- default .Values.optimizer.name }}
+{{- end }}
+
+{{/*
+CH Optimizer Agent Selector labels
+*/}}
+{{- define "cloudhealth-optimizer-agent.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "cloudhealth-optimizer-agent.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}

charts/cloudhealth-collector/templates/clusterrole.yaml

@@ -25,3 +25,14 @@ rules:
 - apiGroups: ["networking.k8s.io"]
   resources: ["ingresses"]
   verbs: ["get", "list"]
+{{- if .Values.optimizer.enabled }}
+- apiGroups: ["cloudhealth.containers.com"]
+  resources: ["rz-recommendation-settings"]
+  verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
+- apiGroups: ["apiextensions.k8s.io"]
+  resources: ["customresourcedefinitions"]
+  verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
+- apiGroups: ["k8so.vmware.com"]
+  resources: ["optimizationrecommendations"]
+  verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
+{{- end }}

charts/cloudhealth-collector/templates/deployment.yaml

@@ -54,7 +54,7 @@ spec:
       {{- end }}
       containers:
         - name: {{ .Chart.Name }}
-          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default "latest" }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           resources:
             {{- toYaml .Values.resources | nindent 12 }}

charts/cloudhealth-collector/templates/optimizer-agent-cron.yaml

@@ -0,0 +1,56 @@
+{{- /*
+Copyright 2023 VMware, Inc.
+SPDX-License-Identifier: Apache-2.0
+*/}}
+
+{{- if .Values.optimizer.enabled }}
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  name: {{ include "cloudhealth-optimizer-agent.name" . }}
+  labels:
+    {{- include "cloudhealth-collector.labels" . | nindent 4 }}
+  {{- with .Values.deployAnnotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  schedule: "0 12 * * *"
+  jobTemplate:
+    spec:
+      template:
+        spec:
+          serviceAccountName: {{ include "cloudhealth-collector.serviceAccountName" . }}
+          containers:
+          - name: {{ include "cloudhealth-optimizer-agent.name" . }}
+            env:
+              - name: CHAPI_KEY
+                valueFrom:
+                  secretKeyRef:
+                    name: {{ include "cloudhealth-collector.secretName" . }}
+                    key: chapiKey
+              - name: CHT_CLUSTER_NAME
+                value: {{.Values.clusterName | required "A valid clusterName is required!" | quote }}
+              - name: CHT_ENDPOINT_PREFIX
+                value: {{.Values.chtEndpointPrefix | default "use1" }}
+              - name: SPRING_PROFILES_ACTIVE
+                value: {{.Values.optimizer.springProfile | default "prod" }}
+            image: "{{ .Values.optimizer.image.repository }}:{{ .Values.optimizer.image.tag | default "latest" }}"
+            imagePullPolicy: {{ .Values.optimizer.image.pullPolicy }}
+            resources:
+              {{- toYaml .Values.optimizer.resources | nindent 14 }}
+
+          {{- with .Values.nodeSelector }}
+          nodeSelector:
+            {{- toYaml . | nindent 8 }}
+          {{- end }}
+          {{- with .Values.affinity }}
+          affinity:
+            {{- toYaml . | nindent 8 }}
+          {{- end }}
+          {{- with .Values.tolerations }}
+          tolerations:
+            {{- toYaml . | nindent 8 }}
+          {{- end }}
+          restartPolicy: OnFailure
+{{- end }}

charts/cloudhealth-collector/templates/secrets.yaml

@@ -16,4 +16,7 @@ data:
   {{- if .Values.proxy.sslCert }}
   certPassword:  {{ .Values.proxy.certPassword | quote }}
   {{- end }}
-{{- end }}
+  {{- if .Values.optimizer.enabled }}
+  chapiKey:  {{ .Values.optimizer.chapiKey | b64enc | quote }}
+  {{- end }}
+{{- end }}

charts/cloudhealth-collector/values.schema.json

@@ -27,15 +27,15 @@
         },
         "clusterName": {
             "type": "string",
-            "pattern": "^.{1,255}$"
+            "pattern": "^[a-z0-9-_.]{3,255}$"
         },
         "chtEndpointPrefix": {
             "type": "string",
             "pattern": "^(use1|preprod.test)$"
         },
         "collectionIntervalSecs": {
             "type": "integer",
-            "minimum": 900
+            "minimum": 600
         },
         "jvmMemory": {
             "type": "string"

charts/cloudhealth-collector/values.yaml

@@ -54,16 +54,15 @@ deployAnnotations: {}
 
 podAnnotations: {}
 
-podSecurityContext: {
+podSecurityContext: 
   runAsNonRoot: true
-}
 
-containerSecurityContext: {
-  allowPrivilegeEscalation: false,
-  readOnlyRootFilesystem: true,
-  runAsNonRoot: true,
-  capabilities: {drop: [all]}
-}
+containerSecurityContext: 
+  allowPrivilegeEscalation: false
+  readOnlyRootFilesystem: true
+  runAsNonRoot: true
+  capabilities: 
+    drop: [all]
 
 proxy:
   sslCert: false
@@ -96,3 +95,43 @@ devArgs: |
   ['upload_k8s_state_v4', '--verbose']
 
 customEnvVars: []
+
+optimizer:
+  enabled: false
+  name: cloudhealth-optimizer-agent
+  springProfile: prod
+  image:
+    repository: cloudhealth/cloudhealth-optimizer-agent
+    tag: "1.0.0-20"
+  # Set to automatically create secret, or create a secret with the name specified by the 'secretName' parameter
+  chapiKey: ""
+  resources:
+    limits:
+      cpu: 1000m
+      memory: 1024Mi
+    requests:
+      cpu: 500m
+      memory: 512Mi
+
+k8s-optimization:
+  fullnameOverride: cloudhealth-optimization
+  controllerManager:
+    kubeRbacProxy:
+      resources:
+        limits:
+          cpu: 500m
+          memory: 512Mi
+        requests:
+          cpu: 100m
+          memory: 256Mi
+    manager:
+      resources:
+        limits:
+          cpu: 1000m
+          memory: 2048Mi
+        requests:
+          cpu: 500m
+          memory: 512Mi
+    replicas: 1
+    serviceAccount:
+      annotations: {}