From cdd52a797654f0e047f3ec62c3d96b79f496d583 Mon Sep 17 00:00:00 2001 From: Tom Kirchner Date: Wed, 10 Jun 2020 10:20:25 -0700 Subject: [PATCH] Document platform-specific settings in README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index ad5cf76f86a..9bd2e4ea2f7 100644 --- a/README.md +++ b/README.md @@ -327,6 +327,17 @@ We use it for the control container because it needs to be available early to gi Be careful, and make sure you have a similar low-level use case before reaching for host containers. +#### Platform-specific settings + +Platform-specific settings are automatically set at boot time by [early-boot-config](sources/api/early-boot-config) based on metadata available on the running platform. +They can be overridden for testing purposes in [the same way as other settings](#interacting-with-settings). + +##### AWS-specific settings + +AWS-specific settings are automatically set based on calls to the Instance MetaData Service (IMDS). + +* `settings.aws.region`: This is set to the AWS region in which the instance is running, for example `us-west-2`. + ### Logs You can use `logdog` through the [admin container](#admin-container) to obtain an archive of log files from your Bottlerocket host.