diff --git a/README.md b/README.md index 3917abe..d33b027 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,94 @@ # terraform-aws-ocean-ecs Terraform module which creates an spotinst ocean ecs cluster + + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 1.3.6 | +| [aws](#requirement\_aws) | 4.45.0 | +| [spotinst](#requirement\_spotinst) | 1.87.1 | +| [tls](#requirement\_tls) | 4.0.4 | + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | 4.45.0 | +| [aws.owner](#provider\_aws.owner) | 4.45.0 | +| [spotinst](#provider\_spotinst) | 1.87.1 | +| [tls](#provider\_tls) | 4.0.4 | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [sg](#module\_sg) | cloudposse/security-group/aws | 1.0.1 | +| [this](#module\_this) | cloudposse/label/null | 0.25.0 | + +## Resources + +| Name | Type | +|------|------| +| [aws_ecs_cluster.default](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/resources/ecs_cluster) | resource | +| [aws_iam_instance_profile.default](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/resources/iam_instance_profile) | resource | +| [aws_iam_role.default](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/resources/iam_role) | resource | +| [aws_iam_role_policy_attachment.amazon_ec2_container_registry_read_only](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/resources/iam_role_policy_attachment) | resource | +| [aws_iam_role_policy_attachment.amazon_ec2_container_service_for_ec2_role](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/resources/iam_role_policy_attachment) | resource | +| [aws_key_pair.ecs](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/resources/key_pair) | resource | +| [aws_route53_vpc_association_authorization.auth](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/resources/route53_vpc_association_authorization) | resource | +| [aws_route53_zone_association.assoc](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/resources/route53_zone_association) | resource | +| [aws_service_discovery_private_dns_namespace.main](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/resources/service_discovery_private_dns_namespace) | resource | +| [spotinst_ocean_ecs.default](https://registry.terraform.io/providers/spotinst/spotinst/1.87.1/docs/resources/ocean_ecs) | resource | +| [tls_private_key.ecs](https://registry.terraform.io/providers/hashicorp/tls/4.0.4/docs/resources/private_key) | resource | +| [aws_iam_policy_document.assume_role](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/data-sources/iam_policy_document) | data source | +| [aws_route53_zone.service_discovery](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/data-sources/route53_zone) | data source | +| [aws_ssm_parameter.image_id](https://registry.terraform.io/providers/hashicorp/aws/4.45.0/docs/data-sources/ssm_parameter) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no | +| [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the `delimiter`
and treated as a single ID element. | `list(string)` | `[]` | no | +| [autoscaler\_auto\_headroom\_percentage](#input\_autoscaler\_auto\_headroom\_percentage) | The auto-headroom percentage. Set a number between 0-200 to control the headroom % of the cluster. Relevant when isAutoConfig=true | `number` | `10` | no | +| [autoscaler\_headroom\_cpu\_per\_unit](#input\_autoscaler\_headroom\_cpu\_per\_unit) | Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU | `number` | `null` | no | +| [autoscaler\_headroom\_memory\_per\_unit](#input\_autoscaler\_headroom\_memory\_per\_unit) | Optionally configure the amount of memory (MB) to allocate the headroom | `number` | `null` | no | +| [autoscaler\_headroom\_num\_of\_units](#input\_autoscaler\_headroom\_num\_of\_units) | The number of units to retain as headroom, where each unit has the defined headroom CPU and memory | `number` | `null` | no | +| [context](#input\_context) | Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as `null` to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | 
{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
| no | +| [create\_key\_pair](#input\_create\_key\_pair) | Whether to create the key pair to attach the instances | `string` | `true` | no | +| [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no | +| [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
`{
format = string
labels = list(string)
}`
(Type is `any` so the map values can later be enhanced to provide additional options.)
`format` is a Terraform format string to be passed to the `format()` function.
`labels` is a list of labels, in order, to pass to `format()` function.
Label values will be normalized before being passed to `format()` so they will be
identical to how they appear in `id`.
Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no | +| [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no | +| [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no | +| [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).
Set to `0` for unlimited length.
Set to `null` for keep the existing setting, which defaults to `0`.
Does not affect `id_full`. | `number` | `null` | no | +| [initial\_vpc\_id](#input\_initial\_vpc\_id) | The VPC ID used for service discovery namespace creation when you are not the owner if var.vpc\_id. You can later on authorize the vpc to hosted zone association and tell the vpc owner to assign your hosted zone to the vpc. | `string` | `null` | no | +| [key\_pair](#input\_key\_pair) | The key pair to attach the instances | `string` | `"ecs"` | no | +| [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper`.
Default value: `title`. | `string` | `null` | no | +| [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no | +| [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper` and `none` (no transformation).
Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.
Default value: `lower`. | `string` | `null` | no | +| [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.
Default is to include all labels.
Tags with empty values will not be included in the `tags` output.
Set to `[]` to suppress all generated tags.
**Notes:**
The value of the `name` tag, if included, will be the `id`, not the `name`.
Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be
changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | 
[
  "default"
]
| no | +| [max\_size](#input\_max\_size) | The upper limit of instances the cluster can scale up to | `number` | `null` | no | +| [min\_size](#input\_min\_size) | The lower limit of instances the cluster can scale down to | `number` | `1` | no | +| [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a `tag`.
The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no | +| [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no | +| [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no | +| [region](#input\_region) | The region the cluster will run in | `string` | `null` | no | +| [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no | +| [subnet\_ids](#input\_subnet\_ids) | A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public ip | `list(string)` | `[]` | no | +| [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no | +| [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no | +| [vpc\_id](#input\_vpc\_id) | The VPC ID | `string` | `null` | no | +| [whitelist](#input\_whitelist) | Instance types allowed in the Ocean cluster, Cannot be configured if blacklist is configured | `list(string)` | 
[
  "c4.large",
  "c4.xlarge",
  "c4.2xlarge",
  "c4.4xlarge",
  "c5.large",
  "c5.xlarge",
  "c5.2xlarge",
  "c5.4xlarge",
  "c5a.large",
  "c5a.xlarge",
  "c5a.2xlarge",
  "c5a.4xlarge",
  "c5ad.large",
  "c5ad.xlarge",
  "c5ad.2xlarge",
  "c5ad.4xlarge",
  "c5d.large",
  "c5d.xlarge",
  "c5d.2xlarge",
  "c5d.4xlarge",
  "c5n.large",
  "c5n.xlarge",
  "c5n.2xlarge",
  "c5n.4xlarge",
  "c6a.large",
  "c6i.large",
  "c6a.xlarge",
  "c6i.xlarge",
  "c6a.2xlarge",
  "c6i.2xlarge",
  "c6a.4xlarge",
  "c6i.4xlarge",
  "g4dn.xlarge",
  "g4dn.2xlarge",
  "i3.large",
  "i3.xlarge",
  "i3en.large",
  "i3en.xlarge",
  "i4i.large",
  "i4i.xlarge",
  "inf1.xlarge",
  "inf1.2xlarge",
  "m4.large",
  "m4.xlarge",
  "m4.2xlarge",
  "m5.large",
  "m5.xlarge",
  "m5.2xlarge",
  "m5a.large",
  "m5a.xlarge",
  "m5a.2xlarge",
  "m5ad.large",
  "m5ad.xlarge",
  "m5ad.2xlarge",
  "m5d.large",
  "m5d.xlarge",
  "m5d.2xlarge",
  "m5dn.large",
  "m5dn.xlarge",
  "m5dn.2xlarge",
  "m5n.large",
  "m5n.xlarge",
  "m5n.2xlarge",
  "m6i.large",
  "m6i.xlarge",
  "m6i.2xlarge",
  "m6a.large",
  "m6a.xlarge",
  "m6a.2xlarge",
  "r4.large",
  "r4.xlarge",
  "r5.large",
  "r5.xlarge",
  "r5a.large",
  "r5a.xlarge",
  "r5ad.large",
  "r5ad.xlarge",
  "r5b.large",
  "r5b.xlarge",
  "r5d.large",
  "r5d.xlarge",
  "r5dn.large",
  "r5dn.xlarge",
  "r5n.large",
  "r5n.xlarge",
  "r6i.large",
  "r6i.xlarge",
  "r6a.large",
  "r6a.xlarge",
  "z1d.large",
  "z1d.xlarge"
]
| no | + +## Outputs + +| Name | Description | +|------|-------------| +| [ecs\_cluster\_arn](#output\_ecs\_cluster\_arn) | Arn of the ecs cluster | +| [ecs\_cluster\_id](#output\_ecs\_cluster\_id) | Id of the ecs cluster | +| [key\_pair\_private\_key](#output\_key\_pair\_private\_key) | private key for allowing to connect to the amazon linux 2 instances | +| [key\_pair\_public\_key](#output\_key\_pair\_public\_key) | public key used on the amazon linux 2 instances | +| [service\_discovery\_dns\_namespace\_id](#output\_service\_discovery\_dns\_namespace\_id) | ID of the discovery namespace | +