Skip to content

Commit

Permalink
Update to use latest fkc-nat AL2023 AMI (#12)
Browse files Browse the repository at this point in the history
* Update to use latest fkc-nat AL2023 AMI

* Update docs
  • Loading branch information
kieranbrown authored Mar 24, 2024
1 parent 2b147f0 commit ab69ccf
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 12 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ A Terraform module for deploying NAT Instances using [fck-nat](https://github.co
The following is a list of features available with this module:
- High-availability mode achieved through a floating internal ENI automatically attached to instances being started by
an ASG
- Optional consistent static IP via EIP re-attachment to the internet facing ENI **\***
- Cloudwatch metrics reported similar to those available with the managed NAT Gateway **\***
- Optional consistent static IP via EIP re-attachment to the internet facing ENI
- Cloudwatch metrics reported similar to those available with the managed NAT Gateway
- Use of spot instances instead of on-demand for reduced costs

**Features marked with a * may not be published as part of the latest fck-nat version and may require you to build the AMI yourself yourself to use them.**

## Example

```hcl
Expand Down Expand Up @@ -75,7 +73,7 @@ module "fck-nat" {
| <a name="input_attach_ssm_policy"></a> [attach\_ssm\_policy](#input\_attach\_ssm\_policy) | Whether to attach the minimum required IAM permissions to connect to the instance via SSM. | `bool` | `true` | no |
| <a name="input_cloudwatch_agent_configuration"></a> [cloudwatch\_agent\_configuration](#input\_cloudwatch\_agent\_configuration) | CloudWatch configuration for the NAT instance | <pre>object({<br> namespace = optional(string, "fck-nat"),<br> collection_interval = optional(number, 60),<br> endpoint_override = optional(string, "")<br> })</pre> | <pre>{<br> "collection_interval": 60,<br> "endpoint_override": "",<br> "namespace": "fck-nat"<br>}</pre> | no |
| <a name="input_cloudwatch_agent_configuration_param_arn"></a> [cloudwatch\_agent\_configuration\_param\_arn](#input\_cloudwatch\_agent\_configuration\_param\_arn) | ARN of the SSM parameter containing the CloudWatch agent configuration. If none provided, creates one | `string` | `null` | no |
| <a name="input_ebs_root_volume_size"></a> [ebs\_root\_volume\_size](#input\_ebs\_root\_volume\_size) | Size of the EBS root volume in GB | `number` | `2` | no |
| <a name="input_ebs_root_volume_size"></a> [ebs\_root\_volume\_size](#input\_ebs\_root\_volume\_size) | Size of the EBS root volume in GB | `number` | `8` | no |
| <a name="input_eip_allocation_ids"></a> [eip\_allocation\_ids](#input\_eip\_allocation\_ids) | EIP allocation IDs to use for the NAT instance. Automatically assign a public IP if none is provided. Note: Currently only supports at most one EIP allocation. | `list(string)` | `[]` | no |
| <a name="input_encryption"></a> [encryption](#input\_encryption) | Whether or not to encrypt the EBS volume | `bool` | `true` | no |
| <a name="input_ha_mode"></a> [ha\_mode](#input\_ha\_mode) | Whether or not high-availability mode should be enabled via autoscaling group | `bool` | `true` | no |
Expand Down Expand Up @@ -114,4 +112,4 @@ module "fck-nat" {
| <a name="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id) | Deprecated. The ID of the security group used by fck-nat ENIs |
| <a name="output_security_group_ids"></a> [security\_group\_ids](#output\_security\_group\_ids) | List of security group IDs used by fck-nat ENIs |
| <a name="output_subnet_id"></a> [subnet\_id](#output\_subnet\_id) | Subnet ID to which the fck-nat instance is deployed into |
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | VPC ID to which the fck-nat instance is deployed into |
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | VPC ID to which the fck-nat instance is deployed into |
6 changes: 2 additions & 4 deletions docs/header.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ A Terraform module for deploying NAT Instances using [fck-nat](https://github.co
The following is a list of features available with this module:
- High-availability mode achieved through a floating internal ENI automatically attached to instances being started by
an ASG
- Optional consistent static IP via EIP re-attachment to the internet facing ENI **\***
- Cloudwatch metrics reported similar to those available with the managed NAT Gateway **\***
- Optional consistent static IP via EIP re-attachment to the internet facing ENI
- Cloudwatch metrics reported similar to those available with the managed NAT Gateway
- Use of spot instances instead of on-demand for reduced costs

**Features marked with a * may not be published as part of the latest fck-nat version and may require you to build the AMI yourself yourself to use them.**

## Example

```hcl
Expand Down
2 changes: 1 addition & 1 deletion ec2.tf
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ data "aws_ami" "main" {

filter {
name = "name"
values = ["fck-nat-amzn2-hvm-*"]
values = ["fck-nat-al2023-hvm-*"]
}

filter {
Expand Down
2 changes: 1 addition & 1 deletion variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ variable "ami_id" {
variable "ebs_root_volume_size" {
description = "Size of the EBS root volume in GB"
type = number
default = 2
default = 8
}

variable "eip_allocation_ids" {
Expand Down

0 comments on commit ab69ccf

Please sign in to comment.