bitovi/Deploy Amazon EFS volume
Deploys an AWS EFS volume
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Feb 16, 2024
- License
- MIT
Pinned Snippet
uses: bitovi/github-actions-deploy-efs-volume@234e325f4bd40f07d1223b84b0923d3d448b01d0 # v0.1.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| bitops_code_only | Will run only the generation phase of BitOps, where the Terraform and Ansible code is built. | no | — |
| bitops_code_store | Store BitOps code as a GitHub artifact | no | false |
| aws_access_key_id | AWS access key ID | yes | — |
| aws_secret_access_key | AWS secret access key | yes | — |
| aws_session_token | AWS session token | no | — |
| aws_default_region | AWS default region | no | us-east-1 |
| aws_resource_identifier | Set to override the AWS resource identifier for the deployment. Defaults to `${org}-{repo}-{branch}`. Use with destroy to destroy specific resources. | no | — |
| aws_additional_tags | A JSON object of additional tags that will be included on created resources. Example: `{"key1": "value1", "key2": "value2"}` | no | — |
| tf_stack_destroy | Set to "true" to Destroy the stack through Terraform. | no | — |
| tf_state_file_name | Change this to be anything you want to. Carefull to be consistent here. A missing file could trigger recreation, or stepping over destruction of non-defined objects. | no | — |
| tf_state_file_name_append | Append a string to the tf-state-file. Setting this to `unique` will generate `tf-state-aws-unique`. Can co-exist with the tf_state_file_name variable. | no | — |
| tf_state_bucket | AWS S3 bucket to use for Terraform state. Defaults to `${org}-${repo}-{branch}-tf-state` | no | — |
| tf_state_bucket_destroy | Force purge and deletion of S3 bucket defined. Any file contained there will be destroyed. `tf_stack_destroy` must also be `true` | no | — |
| aws_efs_create | Toggle to indicate whether to create and EFS and mount it to the ec2 as a part of the provisioning. Note: The EFS will be managed by the stack and will be destroyed along with the stack. | no | true |
| aws_efs_fs_id | ID of existing EFS | no | — |
| aws_efs_create_mount_target | Toggle to indicate whether we should create a mount target for the EFS volume. Accepts incoming fs_id with no mount targets too. | no | — |
| aws_efs_create_ha | Toggle to indicate whether the EFS resource should be highly available (mount points in all available zones within region). | no | — |
| aws_efs_vol_encrypted | Toggle encryption of the EFS volume. | no | — |
| aws_efs_kms_key_id | The ARN for the KMS encryption key. Default key will be used if none defined. | no | — |
| aws_efs_performance_mode | Toggle perfomance mode. Options are: generalPurpose or maxIO. | no | — |
| aws_efs_throughput_mode | Throughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned, or elastic. When using provisioned, also set provisioned_throughput_in_mibps. | no | — |
| aws_efs_throughput_speed | The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughput_mode set to provisioned. | no | — |
| aws_efs_security_group_name | The name of the EFS security group. Defaults to SG for aws_resource_identifier - EFS. | no | — |
| aws_efs_allowed_security_groups | Comma separated list of security groups to be added to the EFS SG. | no | — |
| aws_efs_ingress_allow_all | Allow incoming traffic from 0.0.0.0/0. | no | — |
| aws_efs_create_replica | Toggle to indiciate whether a read-only replica should be created for the EFS primary file system | no | — |
| aws_efs_replication_destination | AWS Region to target for replication | no | — |
| aws_efs_enable_backup_policy | Toggle to indiciate whether the EFS should have a backup policy, default is `false` | no | — |
| aws_efs_transition_to_inactive | https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/efs_file_system#transition_to_ia | no | — |
| aws_efs_mount_target | Directory path in efs to mount to | no | — |
| aws_efs_ec2_mount_point | Directory path in application env to mount directory | no | — |
| aws_efs_additional_tags | A list of strings that will be added to created resources | no | — |
| aws_vpc_create | Define if a VPC should be created | no | — |
| aws_vpc_name | Set a specific name for the VPC | no | — |
| aws_vpc_cidr_block | Define Base CIDR block which is divided into subnet CIDR blocks. Defaults to 10.0.0.0/16. | no | — |
| aws_vpc_public_subnets | Comma separated list of public subnets. Defaults to 10.10.110.0/24 | no | — |
| aws_vpc_private_subnets | Comma separated list of private subnets. If none, none will be created. | no | — |
| aws_vpc_availability_zones | Comma separated list of availability zones. Defaults to `aws_default_region. | no | — |
| aws_vpc_id | AWS VPC ID. Accepts `vpc-###` values. | no | — |
| aws_vpc_subnet_id | Specify a Subnet to be used with the instance. If none provided, will pick one. | no | — |
| aws_vpc_enable_nat_gateway | Enables NAT gateway | no | — |
| aws_vpc_single_nat_gateway | Creates only one NAT gateway | no | — |
| aws_vpc_external_nat_ip_ids | Comma separated list of IP IDS to reuse in the NAT gateways | no | — |
| aws_vpc_additional_tags | A JSON object of additional tags that will be included on created resources. Example: `{"key1": "value1", "key2": "value2"}` | no | — |
Outputs
| name | description |
|---|---|
| aws_efs_fs_id | EFS FS ID |
| aws_efs_replica_fs_id | EFS FS Replica ID |
| aws_efs_sg_id | EFS FS SG ID |
| aws_vpc_id | The selected VPC ID used. |