Skip to content

Commit

Permalink
Line up argument, annotation names
Browse files Browse the repository at this point in the history
  • Loading branch information
davekonopka authored and Andrew Suderman committed Aug 1, 2019
1 parent 241603e commit b5f87c5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,10 @@ Queries all the VPA objects that are labelled for this tool and summarizes their

### Container Exclusions

The `dashboard` and `summary` commands can exclude recommendations for a list of comma separate container names using the `--excludes-containers` argument. This option can be useful for hiding recommendations for sidecar containers for things like Linkerd and Istio.
The `dashboard` and `summary` commands can exclude recommendations for a list of comma separated container names using the `--exclude-containers` argument. This option can be useful for hiding recommendations for sidecar containers for things like Linkerd and Istio.

Containers can be excluded for individual deployments by applying an annotation to any deployment. The annotation value should be a list of comma separated container names. The annotation value will be combined with any values provided through the `--excludes-containers` argument.
Containers can be excluded for individual deployments by applying an annotation to any deployment. The annotation value should be a list of comma separated container names. The annotation value will be combined with any values provided through the `--exclude-containers` argument.

`goldilocks.fairwinds.com/exclude-container: linkerd-proxy`
Example annotation:

`goldilocks.fairwinds.com/exclude-containers: linkerd-proxy,istio-proxy`
2 changes: 1 addition & 1 deletion pkg/summary/summary.go
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ func constructSummary(vpas *v1beta2.VerticalPodAutoscalerList, excludeContainers
break
}

if annotationValue, annotationFound := deployment.Annotations["goldilocks.fairwinds.com/exclude-container"]; annotationFound {
if annotationValue, annotationFound := deployment.Annotations["goldilocks.fairwinds.com/exclude-containers"]; annotationFound {
containerExclusions = append(containerExclusions, strings.Split(annotationValue, ",")...)
}

Expand Down

0 comments on commit b5f87c5

Please sign in to comment.