charts/bitnami/wavefront-adapter-for-istio

Wavefront Adapter for Istio packaged by Bitnami

Wavefront Adapter for Istio is an adapter for Istio to expose Istio metrics to Wavefront. It is a lightweight tool written in Go. It supports Istio v1.4+ and Kubernetes v1.15+.

Overview of Wavefront Adapter for Istio

TL;DR

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/wavefront-adapter-for-istio

Introduction

Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.

This will deploy a Wavefront Adapter for Istio Deployment in a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This Helm chart has been tested on top of Bitnami Kubernetes Production Runtime (BKPR). Deploy BKPR to get automated TLS certificates, logging and monitoring for your applications.

Prerequisites

• Kubernetes 1.19+
• Helm 3.2.0+
• Istio v1.4, v1.5 and v1.6 with Mixer support

In order to enable the Mixer in Istio versions starting from v1.5, execute the following commands:

Istio v1.5.x

istioctl manifest apply --set values.prometheus.enabled=true --set values.telemetry.v1.enabled=true --set values.telemetry.v2.enabled=false --set components.citadel.enabled=true --set components.telemetry.enabled=true

Istio v1.6.x

istioctl install --set values.prometheus.enabled=true --set values.telemetry.v1.enabled=true --set values.telemetry.v2.enabled=false --set components.citadel.enabled=true --set components.telemetry.enabled=true

Installing the Chart

To install the chart with the release name my-release:

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/wavefront-adapter-for-istio

These commands deploy wavefront-adapter-for-istio on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip

: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release helm release:

$ helm uninstall my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

Global parameters

Name	Description	Value
global.imageRegistry	Global Docker image registry	""
global.imagePullSecrets	Global Docker registry secret names as an array	[]
global.storageClass	Global StorageClass for Persistent Volume(s)	""
kubeVersion	Override Kubernetes version	""
nameOverride	String to partially override common.names.fullname	""
fullnameOverride	String to fully override common.names.fullname	""
commonLabels	Labels to add to all deployed objects	{}
commonAnnotations	Annotations to add to all deployed objects	{}
clusterDomain	Kubernetes cluster domain name	cluster.local
extraDeploy	Array of extra objects to deploy with the release	[]

Wavefront Adapter for Istio deployment parameters

Name	Description	Value
image.registry	Adapter image registry	docker.io
image.repository	Adapter image repository	bitnami/wavefront-adapter-for-istio
image.tag	Adapter image tag (immutabe tags are recommended)	0.1.5-debian-10-r273
image.pullPolicy	Adapter image pull policy	IfNotPresent
image.pullSecrets	Adapter image pull secrets	[]
image.debug	Enable image debug mode	false
livenessProbe.enabled	Enable livenessProbe	true
livenessProbe.initialDelaySeconds	Initial delay seconds for livenessProbe	10
livenessProbe.periodSeconds	Period seconds for livenessProbe	10
livenessProbe.timeoutSeconds	Timeout seconds for livenessProbe	1
livenessProbe.failureThreshold	Failure threshold for livenessProbe	3
livenessProbe.successThreshold	Success threshold for livenessProbe	1
readinessProbe.enabled	Enable readinessProbe	true
readinessProbe.initialDelaySeconds	Initial delay seconds for readinessProbe	10
readinessProbe.periodSeconds	Period seconds for readinessProbe	10
readinessProbe.timeoutSeconds	Timeout seconds for readinessProbe	1
readinessProbe.failureThreshold	Failure threshold for readinessProbe	3
readinessProbe.successThreshold	Success threshold for readinessProbe	1
command	Override default container command (useful when using custom images)	[]
args	Override default container args (useful when using custom images)	[]
hostAliases	Add deployment host aliases	[]
resources.limits	The resources limits for the Adapter container	{}
resources.requests	The requested resourcesc for the Adapter container	{}
containerSecurityContext.enabled	Enabled Adapter containers' Security Context	true
containerSecurityContext.runAsUser	Set Adapter container's Security Context runAsUser	1001
containerSecurityContext.runAsNonRoot	Set Adapter container's Security Context runAsNonRoot	true
podSecurityContext.enabled	Enabled Adapter pods' Security Context	true
podSecurityContext.fsGroup	Set Adapter pod's Security Context fsGroup	1001
podAffinityPreset	Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard	""
podAntiAffinityPreset	Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard	soft
nodeAffinityPreset.type	Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard	""
nodeAffinityPreset.key	Node label key to match. Ignored if affinity is set	""
nodeAffinityPreset.values	Node label values to match. Ignored if affinity is set	[]
affinity	Affinity for pod assignment	{}
nodeSelector	Node labels for pod assignment	{}
tolerations	Tolerations for pod assignment	[]
podLabels	Extra labels for Adapter pods	{}
priorityClassName	Adapter pod priority	""
lifecycleHooks	Add lifecycle hooks to the Adapter deployment	{}
customLivenessProbe	Override default liveness probe	{}
customReadinessProbe	Override default readiness probe	{}
updateStrategy.type	Adapter deployment update strategy	RollingUpdate
containerPort	Adapter container port	8000
extraEnvVars	Add extra environment variables to the Adapter container	[]
extraEnvVarsCM	Name of existing ConfigMap containing extra env vars	""
extraEnvVarsSecret	Name of existing Secret containing extra env vars	""
extraVolumes	Optionally specify extra list of additional volumes for Adapter pods	[]
extraVolumeMounts	Optionally specify extra list of additional volumeMounts for Adapter container(s)	[]
initContainers	Add additional init containers to the Adapter pods	[]
sidecars	Add additional sidecar containers to the Adapter pod	[]
externalProxy.host	Host of a wavefront-proxy instance (required if wavefront.enabled = false)	""
externalProxy.port	Host of a wavefront-proxy instance (required if wavefront.enabled = false)	2878
adapterLogLevel	Adapter log level	info
istio.create	Deploy istio objects	true
istio.namespace	Namespace to deploy the Istio objects	istio-system
istio.apiVersion	Override Istio API version	""
metrics.flushInterval	Interval to flush the metrics	5s
metrics.source	Source tag for all metrics handled by the adapter	istio
metrics.prefix	Prefix to prepend to all metrics handled by the adapter	istio
metrics.http	Enable the collection of http metrics	true
metrics.tcp	Enable the collection of tcp metrics	true

Traffic Exposure Parameters

Name	Description	Value
service.type	Adapter service type	ClusterIP
service.port	Adapter service port	8000
service.loadBalancerIP	Adapter service LoadBalancer IP	""
service.loadBalancerSourceRanges	loadBalancerIP source ranges for the Service	[]
service.nodePorts.http	NodePort for the HTTP endpoint	""
service.externalTrafficPolicy	External traffic policy for the service	Cluster

Wavefront sub-chart parameters

Name	Description	Value
wavefront.enabled	Deploy Wavefront chart (necessary if externalProxyHost is not set)	true
wavefront.wavefront.url	Wavefront SAAS service URL	https://YOUR_CLUSTER.wavefront.com
wavefront.wavefront.token	Wavefront SAAS token	YOUR_API_TOKEN
wavefront.collector.enabled	Deploy Wavefront collector (not used by the Adapter pod)	false
wavefront.rbac.create	Create RBAC rules (not necessary as the Adapter only uses wavefront-proxy)	false
wavefront.proxy.enabled	Deploy Wavefront Proxy (required if externalProxyHost is not set)	true
wavefront.proxy.port	Deployed Wavefront Proxy port (required if externalProxyHost is not set)	2878
wavefront.serviceAccount.create	Create Wavefront serivce account (not necessary as the Adapter only uses wavefront-proxy)	false

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install my-release \
  --set livenessProbe.successThreshold=5 \
    bitnami/wavefront-adapter-for-istio

The above command sets the livenessProbe.successThreshold to 5.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install my-release -f values.yaml bitnami/wavefront-adapter-for-istio

Configuration and installation details

Rolling vs Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Connect to Wavefront

The Wavefront Adapter for Istio chart needs to be connected to a Wavefront instance. This can be done in three different ways:

• Deploying the Wavefront subchart, using only the Wavefront Proxy component (default behavior): This is done by setting wavefront.enabled=true and wavefront.proxy.enabled=true, but leaving the externalProxy.host value unset. We recommend disabling the rest of the Wavefront sub-chart resources as they would not be used by the Prometheus Storage Adapter. You also need to configure the Wavefront SaaS URL and token using the wavefont.wavefront.url and wavefront.wavefront.token parameters.

• Using an external Wavefront Proxy instance: This is done by setting the externalProxy.host and externalProxy.port values. In this case, you should set the wavefront.enabled value to false. You also need to configure the Wavefront SaaS URL and token using the wavefront.wavefront.url and wavefront.wavefront.token parameters.

• Use direct ingestion without a Wavefront Proxy instance. This is done by not setting the externalProxy values and setting the wavefront.enabled value to false.

Refer to the chart documentation for more detailed configuration examples.

Troubleshooting

Find more information about how to deal with common errors related to Bitnami's Helm charts in this troubleshooting guide.

Upgrading

$ helm upgrade my-release bitnami/wavefront-adapter-for-istio

To 1.0.0

This major updates the wavefront subchart to it newest major, 3.0.0, which contains a new major for kube-state-metrics. For more information on this subchart's major, please refer to wavefront upgrade notes.

License

Copyright © 2022 Bitnami

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.