Skip to content

Commit

Permalink
Merge pull request #941 from tjkirch/doc-platform-settings
Browse files Browse the repository at this point in the history
Document platform-specific settings in README
  • Loading branch information
tjkirch authored Jun 10, 2020
2 parents b23f883 + cdd52a7 commit 9a17514
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 9a17514

Please sign in to comment.