Config Assistant

The Config Assistant generates Helm values for a Data and Search Platform deployment. You answer questions about your cluster, and the page prints values for the sherlock Helm chart as YAML or JSON. You save the output as values.yaml and pass it to helm install or helm upgrade.

Open the Config Assistant


Before you start

  • The Config Assistant supports every sherlock chart release from 0.9.9 on. The version selector lists them.

  • Have the addresses of your Qdrant, object storage and Temporal services, and the names of the Kubernetes Secrets that hold their credentials and the PostgreSQL connection details. The page asks only for Secret names and keys, never Secret values.

  • Decide how the credentials reach the cluster: you create the Secrets yourself, or the External Secrets Operator copies them from your secret store.

For development and evaluation clusters, the page can instead run test instances of PostgreSQL, Qdrant, object storage and Temporal inside the platform. These are advanced settings.

Generate the values

  1. Open the Config Assistant and select the chart version you will install. The page opens the newest version. To open another one directly, add it to the URL, for example ?chart=0.10.1.

  2. Work through the steps. Each question states what it controls and what the chart does when the value is left empty.

  3. Resolve every blocking check. A blocking check means the chart would reject the values or the deployment would not start. Review checks are warnings; notes are informational. Each check links to the step where you fix it.

  4. Copy or download the output as YAML or JSON. Answers are not saved: reloading or closing the page clears them.

  5. Make sure every credential the output references exists. If a Secret or a required key is missing, the pods that read it stay in CreateContainerConfigError.

    • If you create the Secrets yourself, create every Secret the output references, with the keys it names.

    • If you use External Secrets, make sure your secret store holds the entries at the path you entered.

  6. Run helm install or helm upgrade with the saved values.yaml.

When you switch chart versions, the page keeps the answer to every question that both versions share. Questions that are new in the target version start at their default. The URL records the chart version and the current step, for example ?chart=0.10.1#step-access, so a link reopens the same place.

Data handling

After it loads, the page makes no network requests: its Content-Security-Policy sets connect-src 'none'. Your answers stay in the browser tab. The page stores only the selected output format and layout, in the browser’s local storage.

You can save the page and open the file from disk; it works offline.

Limitations

  • The page does not run helm template. A chart rule that the checks do not reproduce is reported only when you render or install the chart.

  • The page prints values even when a blocking check fails, so you can see what the check refers to. Do not apply values while a blocking check fails.

  • The page does not install, upgrade, diff, or roll back releases.