{"id":21202508,"url":"https://github.com/infrablocks/terraform-aws-bastion","last_synced_at":"2025-07-10T06:33:04.642Z","repository":{"id":40433492,"uuid":"105784941","full_name":"infrablocks/terraform-aws-bastion","owner":"infrablocks","description":"Terraform module for adding a supervised bastion into an existing network.","archived":false,"fork":false,"pushed_at":"2024-10-28T04:32:56.000Z","size":778,"stargazers_count":10,"open_issues_count":2,"forks_count":8,"subscribers_count":12,"default_branch":"main","last_synced_at":"2024-10-28T07:50:24.600Z","etag":null,"topics":["aws","bastion","infrastructure","terraform","terraform-modules"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/infrablocks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-04T15:27:32.000Z","updated_at":"2024-10-28T04:31:33.000Z","dependencies_parsed_at":"2023-11-07T03:11:31.764Z","dependency_job_id":"a8dafac7-9e0d-493e-9ad3-d419d24445db","html_url":"https://github.com/infrablocks/terraform-aws-bastion","commit_stats":null,"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-bastion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-bastion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-bastion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-bastion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infrablocks","download_url":"https://codeload.github.com/infrablocks/terraform-aws-bastion/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225622825,"owners_count":17498170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","bastion","infrastructure","terraform","terraform-modules"],"created_at":"2024-11-20T20:16:34.374Z","updated_at":"2024-11-20T20:16:35.092Z","avatar_url":"https://github.com/infrablocks.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Terraform AWS Bastion\n=====================\n\n[![Version](https://img.shields.io/github/v/tag/infrablocks/terraform-aws-bastion?label=version\u0026sort=semver)](https://github.com/infrablocks/terraform-aws-bastion/tags)\n[![Build Pipeline](https://img.shields.io/circleci/build/github/infrablocks/terraform-aws-bastion/main?label=build-pipeline)](https://app.circleci.com/pipelines/github/infrablocks/terraform-aws-bastion?filter=all)\n[![Maintainer](https://img.shields.io/badge/maintainer-go--atomic.io-red)](https://go-atomic.io)\n\nA Terraform module for deploying a supervised bastion into a base network in\nAWS.\n\nThe bastion requires:\n\n* An existing base network\n* One or more existing load balancers\n\nThe bastion consists of:\n\n* An autoscaling group and launch configuration for bastion instances\n  configured with the supplied SSH key updating the supplied load balancers.\n* A security group allowing SSH access to the bastion from the load balancers.\n* A security group allowing SSH access from the bastion, for assigning to\n  protected instances.\n\n![Diagram of infrastructure managed by this module](https://raw.githubusercontent.com/infrablocks/terraform-aws-bastion/main/docs/architecture.png)\n\nUsage\n-----\n\nTo use the module, include something like the following in your Terraform\nconfiguration:\n\n```terraform\nmodule \"bastion\" {\n  source  = \"infrablocks/bastion/aws\"\n  version = \"3.0.0\"\n\n  vpc_id     = \"vpc-fb7dc365\"\n  subnet_ids = [\"subnet-ae4533c4\", \"subnet-443e6b12\"]\n\n  component             = \"important-component\"\n  deployment_identifier = \"production\"\n\n  ami           = \"ami-bb373ddf\"\n  instance_type = \"t2.micro\"\n\n  ssh_public_key_path = \"~/.ssh/id_rsa.pub\"\n\n  allowed_cidrs = [\"100.10.10.0/24\", \"200.20.0.0/16\"]\n  egress_cidrs  = \"10.0.0.0/16\"\n\n  load_balancer_names = [\"lb-12345678\"]\n\n  minimum_instances = 1\n  maximum_instances = 3\n  desired_instances = 2\n}\n```\n\nAs mentioned above, the bastion deploys into an existing base network.\nWhilst the base network can be created using any mechanism you like, the\n[AWS Base Networking](https://github.com/infrablocks/terraform-aws-base-networking)\nmodule will create everything you need. See the\n[docs](https://github.com/infrablocks/terraform-aws-base-networking/blob/main/README.md)\nfor usage instructions.\n\nSimilarly, the bastion is reachable through one or more load balancers.\nWhilst the load balancers can be created using any mechanism you like, the\n[AWS Classic Load Balancer](https://github.com/infrablocks/terraform-aws-classic-load-balancer)\nmodule will create everything you need. See the\n[docs](https://github.com/infrablocks/terraform-aws-classic-load-balancer/blob/main/README.md)\nfor usage instructions.\n\nSee the\n[Terraform registry entry](https://registry.terraform.io/modules/infrablocks/bastion/aws/latest)\nfor more details.\n\n### Inputs\n\n| Name                          | Description                                                                |   Default   | Required |\n|-------------------------------|----------------------------------------------------------------------------|:-----------:|:--------:|\n| `vpc_id`                      | The ID of the VPC the bastion should be deployed into.                     |      -      |   Yes    |\n| `subnet_ids`                  | The IDs of the subnets the bastion should deploy into.                     |      -      |   Yes    |\n| `component`                   | The name of this component.                                                |      -      |   Yes    |\n| `deployment_identifier`       | An identifier for this instantiation.                                      |      -      |   Yes    |\n| `ami`                         | The ID of the AMI for the bastion instances.                               |      -      |   Yes    |\n| `instance_type`               | The instance type of the bastion instances.                                | `\"t2.nano\"` |    No    |\n| `ssh_public_key_path`         | The absolute path of the SSH public key to use for bastion access.         |      -      |   Yes    |\n| `allowed_cidrs`               | A list of CIDRs that are allowed to access the bastion.                    |      -      |   Yes    |\n| `egress_cidrs`                | A list of CIDRs that are reachable from the bastion.                       |      -      |   Yes    |\n| `load_balancer_names`         | The names of the load balancers to update on autoscaling events.           |    `[]`     |    No    |\n| `minimum_instances`           | The minimum number of bastion instances.                                   |     `1`     |    No    |\n| `maximum_instances`           | The maximum number of bastion instances.                                   |     `1`     |    No    |\n| `desired_instances`           | The desired number of bastion instances.                                   |     `1`     |    No    |\n| `associate_public_ip_address` | Whether or not to associate a public IP address with an instance in a VPC. |   `false`   |    No    |\n\n### Outputs\n\n| Name                                       | Description                                                           |\n|--------------------------------------------|-----------------------------------------------------------------------|\n| `launch_configuration_name`                | The name of the launch configuration for bastion instances.           |\n| `allow_ssh_to_bastion_security_group_id`   | The ID of the security group that allows ssh access to the bastion.   |\n| `allow_ssh_from_bastion_security_group_id` | The ID of the security group that allows ssh access from the bastion. |\n\n### Compatibility\n\nThis module is compatible with Terraform versions greater than or equal to\nTerraform 1.0 and Terraform AWS provider versions greater than or equal to 3.29.\n\nDevelopment\n-----------\n\n### Machine Requirements\n\nIn order for the build to run correctly, a few tools will need to be installed\non your development machine:\n\n* Ruby (3.1)\n* Bundler\n* git\n* git-crypt\n* gnupg\n* direnv\n* aws-vault\n\n#### Mac OS X Setup\n\nInstalling the required tools is best managed by [homebrew](http://brew.sh).\n\nTo install homebrew:\n\n```shell\nruby -e \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\"\n```\n\nThen, to install the required tools:\n\n```shell\n# ruby\nbrew install rbenv\nbrew install ruby-build\necho 'eval \"$(rbenv init - bash)\"' \u003e\u003e ~/.bash_profile\necho 'eval \"$(rbenv init - zsh)\"' \u003e\u003e ~/.zshrc\neval \"$(rbenv init -)\"\nrbenv install 3.1.1\nrbenv rehash\nrbenv local 3.1.1\ngem install bundler\n\n# git, git-crypt, gnupg\nbrew install git\nbrew install git-crypt\nbrew install gnupg\n\n# aws-vault\nbrew cask install\n\n# direnv\nbrew install direnv\necho \"$(direnv hook bash)\" \u003e\u003e ~/.bash_profile\necho \"$(direnv hook zsh)\" \u003e\u003e ~/.zshrc\neval \"$(direnv hook $SHELL)\"\n\ndirenv allow \u003crepository-directory\u003e\n```\n\n### Running the build\n\nRunning the build requires an AWS account and AWS credentials. You are free to\nconfigure credentials however you like as long as an access key ID and secret\naccess key are available. These instructions utilise\n[aws-vault](https://github.com/99designs/aws-vault) which makes credential\nmanagement easy and secure.\n\nTo run the full build, including unit and integration tests, execute:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go\n```\n\nTo run the unit tests, execute:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go test:unit\n```\n\nTo run the integration tests, execute:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go test:integration\n```\n\nTo provision the module prerequisites:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go deployment:prerequisites:provision[\u003cdeployment_identifier\u003e]\n```\n\nTo provision the module contents:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go deployment:root:provision[\u003cdeployment_identifier\u003e]\n```\n\nTo destroy the module contents:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go deployment:root:destroy[\u003cdeployment_identifier\u003e]\n```\n\nTo destroy the module prerequisites:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go deployment:prerequisites:destroy[\u003cdeployment_identifier\u003e]\n```\n\nConfiguration parameters can be overridden via environment variables. For\nexample, to run the unit tests with a seed of `\"testing\"`, execute:\n\n```shell\nSEED=testing aws-vault exec \u003cprofile\u003e -- ./go test:unit\n```\n\nWhen a seed is provided via an environment variable, infrastructure will not be\ndestroyed at the end of test execution. This can be useful during development\nto avoid lengthy provision and destroy cycles.\n\nTo subsequently destroy unit test infrastructure for a given seed:\n\n```shell\nFORCE_DESTROY=yes SEED=testing aws-vault exec \u003cprofile\u003e -- ./go test:unit\n```\n\n### Common Tasks\n\n#### Generating an SSH key pair\n\nTo generate an SSH key pair:\n\n```shell\nssh-keygen -m PEM -t rsa -b 4096 -C integration-test@example.com -N '' -f config/secrets/keys/bastion/ssh\n```\n\n#### Generating a self-signed certificate\n\nTo generate a self signed certificate:\n\n```shell\nopenssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365\n```\n\nTo decrypt the resulting key:\n\n```shell\nopenssl rsa -in key.pem -out ssl.key\n```\n\n#### Managing CircleCI keys\n\nTo encrypt a GPG key for use by CircleCI:\n\n```shell\nopenssl aes-256-cbc \\\n  -e \\\n  -md sha1 \\\n  -in ./config/secrets/ci/gpg.private \\\n  -out ./.circleci/gpg.private.enc \\\n  -k \"\u003cpassphrase\u003e\"\n```\n\nTo check decryption is working correctly:\n\n```shell\nopenssl aes-256-cbc \\\n  -d \\\n  -md sha1 \\\n  -in ./.circleci/gpg.private.enc \\\n  -k \"\u003cpassphrase\u003e\"\n```\n\nContributing\n------------\n\nBug reports and pull requests are welcome on GitHub at\nhttps://github.com/infrablocks/terraform-aws-bastion.\nThis project is intended to be a safe, welcoming space for collaboration, and\ncontributors are expected to adhere to the\n[Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\nLicense\n-------\n\nThe library is available as open source under the terms of the\n[MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfrablocks%2Fterraform-aws-bastion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfrablocks%2Fterraform-aws-bastion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfrablocks%2Fterraform-aws-bastion/lists"}