Skip to main content
The File config source reads Orchestrator configuration from a YAML file on the local filesystem. This is the simplest configuration source and the default for most deployments.
Console terminology: In the Maverics Console, Orchestrator instances and configuration delivery are managed through Deployments. When working directly with YAML, configuration is managed as files delivered via the -config flag or MAVERICS_CONFIG environment variable.

​
Overview

When using the File config source, the Orchestrator reads its configuration from a YAML file on disk at startup. The file path is specified via the -config CLI flag or the MAVERICS_CONFIG environment variable.

​
Use Cases

  • Development and testing — load configuration from a local file during development without requiring external services
  • Single-node deployments — simple deployments where a single Orchestrator instance reads from a local config file
  • Air-gapped environments — deployments without network access to remote config sources

​
Configuration

Console UI documentation is coming soon. This section will walk you through configuring this component using the Maverics Console’s visual interface, including step-by-step screenshots and field descriptions.

​
Console Download-Only Workflow

The Maverics Console supports a download-only workflow where no cloud storage service is configured. Instead, you build your deployment in the Console, download the config bundle, and point the Orchestrator to it locally.
1

Configure Download Only

In the Console, go to Deployments. Create a new deployment or select an existing one. Under Host Environment, click Edit next to Configuration Storage. Select No cloud storage service configured (download only). Click Save.
2

Publish and Download

Publish your deployment configuration. Download the config bundle (maverics.tar.gz) and the public key file from the Console.
3

Point the Orchestrator to the Bundle

Start the Orchestrator with the downloaded bundle:
export MAVERICS_BUNDLE_PUBLIC_KEY_FILE=/path/to/bundle-key.pem
maverics -config /path/to/maverics.tar.gz
This workflow is useful when you want to use the Console UI for configuration authoring but manage config delivery yourself, such as in air-gapped environments or when integrating with existing deployment pipelines.

​
Configuration Reference

SettingTypeDefaultDescription
-config flagstring/etc/maverics/maverics.yamlPath to the YAML configuration file or .tar.gz bundle
MAVERICS_CONFIG env varstring/etc/maverics/maverics.yamlEnvironment variable alternative to the -config flag
MAVERICS_BUNDLE_PUBLIC_KEY_FILE env varstring—Path to a public key file for verifying config bundle signatures
Precedence: The -config CLI flag takes priority over the MAVERICS_CONFIG environment variable.

​
Troubleshooting

  • File not found — verify the file path is correct and the Orchestrator process has read permissions. Check with ls -la /path/to/config.yaml.
  • YAML parsing errors — validate YAML syntax before starting. Ensure indentation uses spaces (not tabs) and all keys are properly nested.
  • Config not updating — the File source does not support hot-reload. Restart the Orchestrator after changing the configuration file.

Config Sources

Overview of all configuration sources

Environment Variables

Substitute environment variables in YAML config

Configuration Reference

Complete configuration field reference

Publishing Deployment Configs

Bundle format, signing, and deployment lifecycle