[SDO-2649] Kubernetes Optimizer Project

.github/workflows/release.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - gmudumbai/sdo-2649-k8s-optimizer
 
 jobs:
   release:

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`, run the following command:
 
@@ -36,7 +36,7 @@ To install the chart with the release name `cloudhealth-collector` in a particul
 
 ```console
 $ helm repo add cloudhealth https://cloudhealth.github.io/helm/
-$ helm install cloudhealth-collector -n <target_namespace> --set apiToken=<Unique Customer API Token>,clusterName=<Cluster Name>,chtRegion=<Cloudhealth Region> cloudhealth/cloudhealth-collector
+$ helm install cloudhealth-collector -n <target_namespace> --create-namespace --set apiToken=<Unique Customer API Token>,clusterName=<Cluster Name>,chtRegion=<Cloudhealth Region> cloudhealth/cloudhealth-collector
 ```
 
 The `apiToken` is required for `cloudhealth-collector` to work and should be either set while running helm install command as in the example above or in a secret object with the following data structure:
@@ -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`, run the following command:
+
+```console
+$ helm repo add cloudhealth https://cloudhealth.github.io/helm/
+$ helm install cloudhealth-collector-optimizer --set apiToken=<Unique Customer API Token>,clusterName=<Cluster Name>,chtRegion=<Cloudhealth Region>,optimizer.enabled=true,chapiKey=<CloudHealth API Key> cloudhealth/cloudhealth-collector
+```
+
+To install the chart with the release name `cloudhealth-collector-optimizer` in a particular 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>,chtRegion=<Cloudhealth Region>,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.2.0
+version: 5.5.0-beta
 appVersion: "5.1.0"
+dependencies:
+  - name: k8s-optimization
+    repository: oci://projects.registry.vmware.com/kubernetes-optimization
+    version: 1.0.0-beta
+    condition: optimizer.enabled
 home: https://cloudhealth.vmware.com/
 icon: https://d1fto35gcfffzn.cloudfront.net/images/Tanzu-Logomark.svg
 sources:

charts/cloudhealth-collector/NOTES.txt

@@ -31,3 +31,8 @@ upload_k8s_state_v2 --verbose --endpoint http://<your_ip_address>:9292
 helm install cloudhealth-collector --debug --dry-run --set apiToken=$CHT_API_TOKEN,clusterName=$CHT_CLUSTER_NAME,chtRegion=$CHT_REGION,image.repository=latest-libs-06-13-3,image.pullPolicy=Never --set devArgs="\['upload_k8s_state_v2'\,'--verbose'\,'--endpoint'\,'http://<your_ip_address>:9292'\]",podSecurityContext.fsGroup=2000,containerSecurityContext.readOnlyRootFilesystem=true,containerSecurityContext.runAsNonRoot=true,containerSecurityContext.runAsUser=1000,containerSecurityContext.capabilities.drop={ALL} ./cloudhealth-collector-1.1.3.tgz
 
 helm install cloudhealth-collector --debug --dry-run --set apiToken=$CHT_API_TOKEN,clusterName=$CHT_CLUSTER_NAME,chtRegion=$CHT_REGION,image.repository=latest-libs-06-13-3,image.pullPolicy=Never --set devArgs="\['upload_k8s_state_v2'\,'--verbose'\,'--endpoint'\,'http://<your_ip_address>:9292'\]" --set "customEnvVars[0].name=ENV4" --set "customEnvVars[0].value=VALUE4" --set serviceAccount.name=sample_service_account ./cloudhealth-collector-1.1.2.tgz
+
+NEW ALPHA IMAGE INSTRUCTIONS:
+helm install cloudhealth-collector --debug --dry-run -n cloudhealth --set optimizer.enabled=true,optimizer.chapiKey=xyzabc,clusterName=test-cluster,apiToken=tttyyy cloudhealth/cloudhealth-collector --version 5.0.6-alpha
+
+helm install cloudhealth-collector --debug --dry-run -n cloudhealth --set clusterName=test-cluster,apiToken=tttyyy cloudhealth/cloudhealth-collector --version 5.0.6-alpha

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

@@ -22,3 +22,14 @@ rules:
 - apiGroups: ["batch"]
   resources: ["cronjobs", "jobs"]
   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

@@ -33,7 +33,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 }}
@@ -61,7 +61,7 @@ spec:
                   name: {{ include "cloudhealth-collector.secretName" . }}
                   key: apiToken
             - name: CHT_CLUSTER_NAME
-              value: {{.Values.clusterName | required "A valid clusterName required!" | quote }}
+              value: {{.Values.clusterName | required "A valid clusterName is required!" | quote }}
             - name: CHT_REGION
               value: {{.Values.chtRegion | default "us-east-1" }}
             - name: CHT_INTERVAL

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_REGION
+                value: {{.Values.chtRegion | default "us-east-1" }}
+              - 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

@@ -13,4 +13,7 @@ metadata:
 type: Opaque
 data:
   apiToken:  {{ .Values.apiToken | b64enc | quote }}
-{{- end }}
+  {{- if .Values.optimizer.enabled }}
+  chapiKey:  {{ .Values.optimizer.chapiKey | b64enc | quote }}
+  {{- end }}
+{{- end }}

charts/cloudhealth-collector/values.yaml

@@ -51,16 +51,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]
 
 resources:
   limits:
@@ -85,3 +84,43 @@ devArgs: |
   ['upload_k8s_state_v4', '--verbose']
 
 customEnvVars: []
+
+optimizer:
+  enabled: false
+  name: cloudhealth-optimizer-agent
+  springProfile: prod
+  image:
+    repository: cloudhealth/cloudhealth-optimizer-agent
+    tag: "latest"
+  # Set to automatically create secret, or create a secret with the name specified by the 'secretName' parameter
+  chapiKey: ""
+  resources:
+    limits:
+      cpu: 1000m
+      memory: 512Mi
+    requests:
+      cpu: 250m
+      memory: 128Mi
+
+k8s-optimization:
+  fullnameOverride: cloudhealth-optimization
+  controllerManager:
+    kubeRbacProxy:
+      resources:
+        limits:
+          cpu: 500m
+          memory: 128Mi
+        requests:
+          cpu: 100m
+          memory: 64Mi
+    manager:
+      resources:
+        limits:
+          cpu: 500m
+          memory: 128Mi
+        requests:
+          cpu: 250m
+          memory: 64Mi
+    replicas: 1
+    serviceAccount:
+      annotations: {}

cloudhealth-collector-image-docs/CHANGELOG.md

@@ -10,6 +10,12 @@ The agent has been verified against:
 
 All versions before June 20, 2022 have been deprecated.
 
+## [1398] - 2023-10-23
+
+### Added
+
+* The collector docker image now supports multiple regions(us-east-1 & us-east-2). optional parameter `chtRegion` added. Default: `us-east-1`
+
 ## [1360] - 2023-07-19
 
 ### Added