Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for EC2 tenancy related options #1922

Merged
merged 1 commit into from Dec 2, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/content/docs/drivers/aws.md
Expand Up @@ -445,6 +445,34 @@ driver:
interface: private_dns
```

### Tenancy and Dedicated Hosts/Instances

#### tenancy

You can run instances on AWS in three different modes.

The `default` mode places instances on a random host and executes them in a multi-tenant environment. This mode is also the cheapest one (besides Spot).

If you want to run your instances on hardware that is not shared with other customers, mainly due to licensing or security considerations, you can select `dedicated` instances instead. This setting will incur an additional charge but AWS guarantees that no other customers will share the same hardware.

The most specific run type is a dedicated `host`. In this mode your instance will not run on a random host dedicated to your account, but you can reserve a specific host instead. This approach offers options like selecting AZ-level separation or savings plans. It is used mainly for licensing or security considerations; for example, it is needed to work with `mac` instance types.

The default is `default'.

#### allocate_dedicated_host

The most specific run type is a dedicated `host`. In this mode your instance will not run on a random host dedicated to your account, but you can reserve a specific host instead. This approach offers options like selecting AZ-level separation or savings plans. It is used mainly for licensing or security considerations; for example, it is needed to work with `mac` instance types.

The default is `false`.

#### deallocate_dedicated_host

Dedicated hosts can be shared across accounts and might be associated with multi-year savings plans. Also, dedicated hosts of type `mac` have a 24-hour minimum allocation period.

To avoid having Test Kitchen try to deallocate shared or minimum runtime hosts, the functionality of deallocating a host is guarded by this setting.

The default is `false`.

### Example **kitchen.yml**

```yaml
Expand Down