Configuration
Last updated
Was this helpful?
Last updated
Was this helpful?
ConsoleMe is extremely configurable. For ConsoleMe to operate properly, you must provide it with a YAML configuration. ConsoleMe will attempt to locate its configuration by looking at the CONFIG_LOCATION environment variable. The value of this variable should be the full path to your configuration. Example configurations are provided in the .
If you do not tell ConsoleMe where it can find a configuration, ConsoleMe will attempt to discover it. When ConsoleMe first starts, it will attempt to find its configuration based on the function in the default_plugins set. If you've installed a custom plugins set, it will use the logic that you've defined in your version of this function.
ConsoleMe will attempt to load a configuration in the following order:
CONFIG_LOCATION environment variable
consoleme.yaml in the current working directory
~/.config/consoleme/config.yaml
/etc/consoleme/config/config.yaml
example_config/example_config_development.yaml
If you've just cloned ConsoleMe and attempt to run it locally without making any changes, it will run with
If you plan to have multiple deployments of ConsoleMe (Such as development, test, and production), you'll want to have different YAML configurations for each deployment. These YAML configurations will be unique to you, and you should store them in a secure internal repository.
We hear you, and we're pleased to offer a configuration generation script. After running through the , run python scripts/config/generate.py from your ConsoleMe repository directory. This should guide you through the process of generating a basic ConsoleMe configuration.
Please provide feedback on this feature!
Yes!
If you wish to use this feature, upload your ConsoleMe configuration to S3 as a single file, make sure ConsoleMe is using IAM credentials with permissions to fetch that file in S3, and set the CONSOLEME_CONFIG_S3environment variable to the location of your configuration.
Example usage:
Yes!
Set the consoleme_s3_bucket configuration to the name of an S3 bucket. This S3 bucket should exist on the same account ConsoleMe is deployed to, and ConsoleMeInstanceProfile (The role ConsoleMe is running as) should have write access to the bucket.
If you have multiple ConsoleMe configurations for your different deployments, you'll most likely have configuration keys that are common with one another.
The way this works in practice is as follows:
base.yaml:
secrets.yaml:
prod.yaml:
test.yaml:
Resulting configurations:
CONFIG_LOCATION=prod.yaml python consoleme/__main__.py :
CONFIG_LOCATION=test.yaml python consoleme/__main__.py : �
During the initial boot of its docker image, ConsoleMe will run that can either fetch ConsoleMe's configuration from S3, or attempt to base-64 decode the ConsoleMe's configuration.
It is possible to "extend" one configuration YAML file with another. Examples of this can be seen in the . You'll notice that example_config_development.yaml extends example_config_header_auth.yaml, which extends both example_config_base.yaml and example_config_secrets.yaml. If a developer runs ConsoleMe with CONFIG_LOCATION=/path/to/example_config_development.yaml, the resultant configuration will be a combination of all of those configurations, with keys from example_config_development preferred if duplicate keys exist in the extended configurations.
The first configuration file loaded by ConsoleMe has the highest priority, followed by the subsequent configuration files in the order that they are loaded. If you like to read code, check out the for this functionality.
We recommend starting with one of our example configuration files, preferably , and modify it to suit your needs. You can copy it in as a part of your deployment process via S3, AWS Secrets Manager, Hashicorp Vault, or something else of your choosing.