Tuning Component Settings¶

Helm Charts are a set of Kubernetes manifests that reflect best practices for deploying an application or service on Kubernetes.

After you add the Deis Chart Repository, you can customize the chart using helm inspect values hephy/workflow > values.yaml before using helm install to complete the installation.

There are a few ways to customize the respective component:

• If the value is exposed in the values.yaml file as derived above, one may modify the section of the component to tune these settings. The modified value(s) will then take effect at chart installation or release upgrade time via either of the two respective commands:

  $ helm install hephy/workflow -n hephy --namespace deis -f values.yaml
  $ helm upgrade hephy -f values.yaml
  

• If the value hasn't yet been exposed in the values.yaml file, one may edit the component deployment with the tuned setting. Here we edit the deis-controller deployment:

  $ kubectl --namespace deis edit deployment deis-controller
  

  Add/edit the setting via the appropriate environment variable and value under the env section and save. The updated deployment will recreate the component pod with the new/modified setting.

• Lastly, one may also fetch and edit the chart as served by version control/the chart repository itself:

  $ helm fetch hephy/workflow --untar
  $ $EDITOR workflow/charts/controller/templates/controller-deployment.yaml
  

  Then run helm install ./workflow --namespace deis --name hephy to apply the changes, or helm upgrade hephy ./workflow if the cluster is already running.

Setting Resource limits¶

You can set resource limits to Workflow components by modifying the values.yaml file fetched earlier. This file has a section for each Workflow component. To set a limit to any Workflow component just add limits_cpu, limits_memory in the section and set them to the appropriate values.

Below is an example of how the builder section of values.yaml might look with CPU and memory limits set:

builder:
  org: "hephyci"
  pullPolicy: "Always"
  dockerTag: "canary"
  limits_cpu: "100m"
  limits_memory: "50Mi"

Customizing the Builder¶

The following environment variables are tunable for the Builder component:

Customizing the Controller¶

The following environment variables are tunable for the Controller component:

LDAP authentication settings¶

Configuration options for LDAP authentication are detailed here.

The following environment variables are available for enabling LDAP authentication of user accounts in the Controller component:

Global and per application settings¶

See the Deploying Apps guide for more detailed information on those.

Customizing the Database¶

The following environment variables are tunable for the Database component:

Customizing Fluentd¶

The following values can be changed in the values.yaml file or by using the --set flag with the Helm CLI.

For more information about the various environment variables that can be set please see the README

Customizing the Logger¶

The following environment variables are tunable for the Logger component:

Customizing the Monitor¶

Grafana¶

We have exposed some of the more useful configuration values directly in the chart. This allows them to be set using either the values.yaml file or by using the --set flag with the Helm CLI. You can see these options below:

For a list of other options you can set by using environment variables please see the configuration file in Github.

Telegraf¶

For a list of configuration values that can be set by using environment variables please see the following configuration file.

InfluxDB¶

You can find a list of values that can be set using environment variables here.

Customizing the Registry¶

The Registry component can be tuned by following the teamhephy/distribution config doc.

Customizing the Router¶

The majority of router settings are tunable through annotations, which allows the router to be re-configured with zero downtime post-installation. You can find the list of annotations to tune here.

The following environment variables are tunable for the Router component:

Customizing Workflow Manager¶

The following environment variables are tunable for Workflow Manager: