chaostoolkit / chaostoolkit

Chaos Engineering Toolkit & Orchestration for Developers

Home Page:https://chaostoolkit.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Error in documentation for Setting the region

lefamoffat opened this issue · comments

Describe the bug
In the Setting the region part of the documentation the env and type value should be switched.

Runtime versions
Please run:

$ python --version
$ chaos info core
$ chaos info extensions

To Reproduce
Configure your project as described in the docs with

{
    "configuration": {
        "aws_region": {
            "env": "type",
            "key": "AWS_REGION"
        }
    }
}

Screenshot 2021-11-16 at 14 08 15

Expected behavior
No errors and for the CLI to take the correct value from env

Screenshot 2021-11-16 at 14 08 28

Additional context
The fix is just to switch the two, i.e.

{
    "configuration": {
        "aws_region": {
            "type": "env",
            "key": "AWS_REGION"
        }
    }
}

like it is done here

Hey @lefamoffat - would you mind raising a PR for this fix here: https://github.com/chaostoolkit-incubator/chaostoolkit-aws? Looks like it's just in the README 😄