charts/goldilocks-7.3.1/README.md

Intro

This is a Helm chart for the Fairwinds Goldilocks project. It provides an easy way to install the controller and the dashboard for viewing resource recommendations in your Kubernetes cluster. Please see the Goldilocks README for more information.

Installation

helm repo add fairwinds-stable https://charts.fairwinds.com/stable
helm install goldilocks fairwinds-stable/goldilocks --namespace goldilocks

Requirements

This has a hard requirement on VPA being installed. Please see the Goldilocks README

vpa subchart

Fairwinds has published a chart for installing VPA in our stable repo. It can be enabled as a sub-chart by setting vpa.enabled==true. We recommend just installing the chart and managing it separately.

Major Version Upgrade Notes

Upgrading from v6.x.x to v7.x.x

In this change, the VPA helm chart was upgraded to the latest version, including a major bump. We recommend you to check the VPA Helm chart changelog to ensure a smooth upgrade.

BREAKING Upgrading from v4.x.x to v5.x.x

The new chart version includes Ingress configuration for the networking.k8s.io/v1 Kubernetes API.

Because of the new API version, you need to specify dashboard.ingress.hosts[X].paths[Y].type when installing this chart with enabled Ingress on a Kubernetes cluster version 1.19+.

Upgrading from v3.x.x to v4.x.x

There are no breaking changes, but the goldilocks controller and dashboard have had some major tweaks so they can work with more workload controllers. To allow v4.0.0+ to work with more than Deployments, the main change here is in RBAC permissions so that the goldilocks service accounts can access all resources in the apps/v1.

BREAKING Upgrading from v2.x.x to v3.x.x

In this change, the installVPA value and corresponding hooks have been removed in favor of the sub-chart. The recommended path forward is to remove the hook-installed resources and manage the VPA installation with the Fairwinds VPA Chart

We have kept the uninstallVPA flag in place, which will remove a vpa installation that was previously managed by this chart. This flag will be deprecated in a later release.

BREAKING Upgrading to chart v2.x.x from v1.x.x

If using installVPA=true when updating from v1.x.x to v2.x.x of this chart, there are some considerations. v2.x.x of the chart started only installing the recommender and the necessary CRDs and RBAC from the VPA installation. This is due to the volatile and risky nature of running a beta mutatingadmissionwebhook in your cluster. If you have previously used the installVPA=true flag to install the VPA, we recommend that you completely uninstall and re-install the VPA as part of the upgrade. We have provided a new hook to do this that will run before the install hook.

If upgrading from v1.x.x to v2.x.x we recommend upgrading like so:

helm upgrade goldilocks fairwinds-stable/goldilocks --set reinstallVPA=true

This will completely remove the VPA and then re-install it using the new method.

Values

Key	Type	Default	Description
uninstallVPA	bool	false	Enabling this flag will remove a vpa installation that was previously managed with this chart. It is considered deprecated and will be removed in a later release.
vpa.enabled	bool	false	If true, the vpa will be installed as a sub-chart
vpa.updater.enabled	bool	false
metrics-server.enabled	bool	false	If true, the metrics-server will be installed as a sub-chart
metrics-server.apiService.create	bool	true
image.repository	string	"us-docker.pkg.dev/fairwinds-ops/oss/goldilocks"	Repository for the goldilocks image
image.tag	string	"v4.10.0"	The goldilocks image tag to use
image.pullPolicy	string	"Always"	imagePullPolicy - Highly recommended to leave this as Always
imagePullSecrets	list	[]	A list of image pull secret names to use
nameOverride	string	""
fullnameOverride	string	""
controller.enabled	bool	true	Whether or not to install the controller deployment
controller.revisionHistoryLimit	int	10	Number of old replicasets to retain, default is 10, 0 will garbage-collect old replicasets
controller.rbac.create	bool	true	If set to true, rbac resources will be created for the controller
controller.rbac.enableArgoproj	bool	true	If set to true, the clusterrole will give access to argoproj.io resources
controller.rbac.extraRules	list	[]	Extra rbac rules for the controller clusterrole
controller.rbac.extraClusterRoleBindings	list	[]	A list of ClusterRoles for which ClusterRoleBindings will be created for the ServiceAccount, if enabled
controller.serviceAccount.create	bool	true	If true, a service account will be created for the controller. If set to false, you must set controller.serviceAccount.name
controller.serviceAccount.name	string	nil	The name of an existing service account to use for the controller. Combined with controller.serviceAccount.create
controller.flags	object	{}	A map of additional flags to pass to the controller
controller.logVerbosity	string	"2"	Controller log verbosity. Can be set from 1-10 with 10 being extremely verbose
controller.nodeSelector	object	{}	Node selector for the controller pod
controller.tolerations	list	[]	Tolerations for the controller pod
controller.affinity	object	{}	Affinity for the controller pods
controller.topologySpreadConstraints	list	[]	Topology spread constraints for the controller pods
controller.resources	object	{"limits":{},"requests":{"cpu":"25m","memory":"256Mi"}}	The resources block for the controller pods
controller.podSecurityContext	object	{"seccompProfile":{"type":"RuntimeDefault"}}	Defines the podSecurityContext for the controller pod
controller.securityContext	object	{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":10324}	The container securityContext for the controller container
controller.deployment.extraVolumeMounts	list	[]	Extra volume mounts for the controller container
controller.deployment.extraVolumes	list	[]	Extra volumes for the controller pod
controller.deployment.annotations	object	{}	Extra annotations for the controller deployment
controller.deployment.additionalLabels	object	{}	Extra labels for the controller deployment
controller.deployment.podAnnotations	object	{}	Extra annotations for the controller pod
dashboard.basePath	string	nil	Path on which the dashboard is served. Defaults to /
dashboard.enabled	bool	true	If true, the dashboard component will be installed
dashboard.revisionHistoryLimit	int	10	Number of old replicasets to retain, default is 10, 0 will garbage-collect old replicasets
dashboard.replicaCount	int	2	Number of dashboard pods to run
dashboard.service.type	string	"ClusterIP"	The type of the dashboard service
dashboard.service.port	int	80	The port to run the dashboard service on
dashboard.service.annotations	object	{}	Extra annotations for the dashboard service
dashboard.flags	object	{}	A map of additional flags to pass to the dashboard
dashboard.logVerbosity	string	"2"	Dashboard log verbosity. Can be set from 1-10 with 10 being extremely verbose
dashboard.excludeContainers	string	"linkerd-proxy,istio-proxy"	Container names to exclude from displaying in the Goldilocks dashboard
dashboard.rbac.create	bool	true	If set to true, rbac resources will be created for the dashboard
dashboard.rbac.enableArgoproj	bool	true	If set to true, the clusterrole will give access to argoproj.io resources
dashboard.serviceAccount.create	bool	true	If true, a service account will be created for the dashboard. If set to false, you must set dashboard.serviceAccount.name
dashboard.serviceAccount.name	string	nil	The name of an existing service account to use for the controller. Combined with dashboard.serviceAccount.create
dashboard.deployment.annotations	object	{}	Extra annotations for the dashboard deployment
dashboard.deployment.additionalLabels	object	{}	Extra labels for the dashboard deployment
dashboard.deployment.extraVolumeMounts	list	[]	Extra volume mounts for the dashboard container
dashboard.deployment.extraVolumes	list	[]	Extra volumes for the dashboard pod
dashboard.deployment.podAnnotations	object	{}	Extra annotations for the dashboard pod
dashboard.ingress.enabled	bool	false	Enables an ingress object for the dashboard.
dashboard.ingress.ingressClassName	string	nil	From Kubernetes 1.18+ this field is supported in case your ingress controller supports it. When set, you do not need to add the ingress class as annotation.
dashboard.ingress.annotations	object	{}
dashboard.ingress.hosts[0].host	string	"chart-example.local"
dashboard.ingress.hosts[0].paths[0].path	string	"/"
dashboard.ingress.hosts[0].paths[0].type	string	"ImplementationSpecific"
dashboard.ingress.tls	list	[]
dashboard.resources	object	{"limits":{},"requests":{"cpu":"25m","memory":"256Mi"}}	A resources block for the dashboard.
dashboard.podSecurityContext	object	{"seccompProfile":{"type":"RuntimeDefault"}}	Defines the podSecurityContext for the dashboard pod
dashboard.securityContext	object	{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":10324}	The container securityContext for the dashboard container
dashboard.nodeSelector	object	{}
dashboard.tolerations	list	[]
dashboard.affinity	object	{}
dashboard.topologySpreadConstraints	list	[]	Topology spread constraints for the dashboard pods