Cloudera Surveyor for Apache Kafka configuration overview

Get started with configuring Cloudera Surveyor. Learn about basic configuration practices using Helm and available configuration properties.

Cloudera Surveyor is exclusively managed using Helm. You initially configure Cloudera Surveyor during installation. Typically this involves creating a custom values file (values.yml) that includes configuration properties. The file is applied during installation when you run the helm install command.

If required, you can make configuration updates following installation. This is done with the helm upgrade command using the --reuse-values option together with the -f (--values) or --set options.

helm upgrade cloudera-surveyor [***CHART***] \
  --namespace [***NAMESPACE***] \
  (--set '[***KEY***]=[***VALUE***]' | -f [***MY-VALUES.YAML***] | --set-file [***KEY***]=[***FILEPATH***]) \
  --reuse-values

• The string cloudera-surveyor is the Helm release name of the chart installation. This is an arbitrary, user defined name.

• Ensure that [***CHART***] and [***NAMESPACE***] are the same as the ones you used during installation. You can use helm list to list currently installed releases and charts.

• Use --set if you want to update properties directly from the command line. Helm supports various --set options like --set-file, --set-string, and others. You can use any of these options.

• Use -f (--values) if you want to pass a file containing your configuration updates.

• The --reuse-values option instructs Helm to merge existing values with new ones. You use this option when you want to update an existing configuration.

helm show readme [***CHART***]