Skip to content

feat: update docs to for file-based configuration #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −0
Open

feat: update docs to for file-based configuration #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/deployments-and-hosting/kubernetes/helm-chart/router.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,29 @@ commonConfiguration: |-
log_level: "info"
```

### File-based router configuration

You can also specify a path to a configuration file that will be embedded into the chart. This is useful for managing complex configurations or when you want to keep configuration separate from the values file.

```bash values.yaml
# Path to a configuration file to embed. If set, this takes precedence over commonConfiguration.
# The file path is relative to the chart directory and will be processed with the helm `tpl` function.
commonConfigurationPath: "configs/router-config.yaml"
```

Create your configuration file:

```bash configs/router-config.yaml
version: "1"
log_level: "info"
# You can use Helm template variables in the file
controlplane_url: "{{ .Values.configuration.controlplaneUrl }}"
```

<Info>
The file will be processed with Helm's `tpl` function, allowing you to use template variables and functions within the configuration file.
</Info>

### Install with a static Router Execution Config

If you follow the default instructions the execution config is polled from the controlplane. Sometimes this is not desired e.g. when you have a strict CI/CD workflow or SLA requirements. The following instructions, shows you how to deploy a Router with a static router execution config.
Expand Down