https://github.com/infrablocks/terraform-aws-client-vpn
A terraform module for deploying a client VPN in AWS.
https://github.com/infrablocks/terraform-aws-client-vpn
aws infrastructure terraform terraform-modules vpn
Last synced: 12 months ago
JSON representation
A terraform module for deploying a client VPN in AWS.
- Host: GitHub
- URL: https://github.com/infrablocks/terraform-aws-client-vpn
- Owner: infrablocks
- License: mit
- Created: 2020-05-24T17:31:19.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-06-02T06:41:58.000Z (about 1 year ago)
- Last Synced: 2025-06-04T21:09:26.376Z (about 1 year ago)
- Topics: aws, infrastructure, terraform, terraform-modules, vpn
- Language: Ruby
- Homepage:
- Size: 485 KB
- Stars: 3
- Watchers: 7
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Terraform AWS Client VPN
===============================
[](https://circleci.com/gh/infrablocks/terraform-aws-client-vpn)
A Terraform module for deploying a client VPN in AWS.
The client VPN deployment requires:
* An existing VPC
The client VPN deployment consists of:
*
Usage
-----
To use the module, include something like the following in your Terraform
configuration:
```hcl-terraform
module "client_vpn" {
source = "infrablocks/client-vpn/aws"
version = "0.1.1"
region = "eu-west-2"
vpc_id = "vpc-fb7dc365"
component = "important-component"
deployment_identifier = "production"
}
```
As mentioned above, the client VPN deploys into an existing base network. Whilst
these can be created using any mechanism you like, the following modules may be
of use:
* [AWS Base Networking](https://github.com/infrablocks/terraform-aws-base-networking)
### Inputs
| Name | Description | Default | Required |
|-----------------------|--------------------------------------------------|:-------:|:--------:|
| region | The region into which to deploy the cache | - | yes |
| vpc_id | The ID of the VPC into which to deploy the cache | - | yes |
| component | The component this cache will contain | - | yes |
| deployment_identifier | An identifier for this instantiation | - | yes |
### Outputs
| Name | Description |
|------|-------------|
Development
-----------
### Machine Requirements
In order for the build to run correctly, a few tools will need to be installed
on your development machine:
* Ruby (3.1.1)
* Bundler
* git
* git-crypt
* gnupg
* direnv
* aws-vault
#### Mac OS X Setup
Installing the required tools is best managed by [homebrew](http://brew.sh).
To install homebrew:
```
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
Then, to install the required tools:
```
# ruby
brew install rbenv
brew install ruby-build
echo 'eval "$(rbenv init - bash)"' >> ~/.bash_profile
echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrc
eval "$(rbenv init -)"
rbenv install 3.1.1
rbenv rehash
rbenv local 3.1.1
gem install bundler
# git, git-crypt, gnupg
brew install git
brew install git-crypt
brew install gnupg
# aws-vault
brew cask install
# direnv
brew install direnv
echo "$(direnv hook bash)" >> ~/.bash_profile
echo "$(direnv hook zsh)" >> ~/.zshrc
eval "$(direnv hook $SHELL)"
direnv allow
```
### Running the build
Running the build requires an AWS account and AWS credentials. You are free to
configure credentials however you like as long as an access key ID and secret
access key are available. These instructions utilise
[aws-vault](https://github.com/99designs/aws-vault) which makes credential
management easy and secure.
To provision module infrastructure, run tests and then destroy that
infrastructure, execute:
```bash
aws-vault exec -- ./go
```
To provision the module prerequisites:
```bash
aws-vault exec -- ./go deployment:prerequisites:provision[]
```
To provision the module contents:
```bash
aws-vault exec -- ./go deployment:root:provision[]
```
To destroy the module contents:
```bash
aws-vault exec -- ./go deployment:root:destroy[]
```
To destroy the module prerequisites:
```bash
aws-vault exec -- ./go deployment:prerequisites:destroy[]
```
Configuration parameters can be overridden via environment variables:
```bash
DEPLOYMENT_IDENTIFIER=testing aws-vault exec -- ./go
```
When a deployment identifier is provided via an environment variable,
infrastructure will not be destroyed at the end of test execution. This can
be useful during development to avoid lengthy provision and destroy cycles.
By default, providers will be downloaded for each terraform execution. To
cache providers between calls:
```bash
TF_PLUGIN_CACHE_DIR="$HOME/.terraform.d/plugin-cache" aws-vault exec -- ./go
```
### Common Tasks
#### Generating an SSH key pair
To generate an SSH key pair:
```
ssh-keygen -m PEM -t rsa -b 4096 -C integration-test@example.com -N '' -f config/secrets/keys/bastion/ssh
```
#### Generating a self-signed certificate
To generate a self signed certificate:
```
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365
```
To decrypt the resulting key:
```
openssl rsa -in key.pem -out ssl.key
```
#### Managing CircleCI keys
To encrypt a GPG key for use by CircleCI:
```bash
openssl aes-256-cbc \
-e \
-md sha1 \
-in ./config/secrets/ci/gpg.private \
-out ./.circleci/gpg.private.enc \
-k ""
```
To check decryption is working correctly:
```bash
openssl aes-256-cbc \
-d \
-md sha1 \
-in ./.circleci/gpg.private.enc \
-k ""
```
Contributing
------------
Bug reports and pull requests are welcome on GitHub at
https://github.com/infrablocks/terraform-aws-client-vpn.
This project is intended to be a safe, welcoming space for collaboration, and
contributors are expected to adhere to
the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
License
-------
The library is available as open source under the terms of the
[MIT License](http://opensource.org/licenses/MIT).