From e273209f94688c4831f55f1a1ffbd8f1eba19529 Mon Sep 17 00:00:00 2001 From: yoshutch Date: Tue, 11 Feb 2020 12:38:08 -0700 Subject: [PATCH 1/2] removed ssh --- README.md | 2 +- examples/module/example.tf | 2 +- main.tf | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eaf87df..1fc6bc4 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ provider "aws" { } module "bastion" { - source = "git@github.com:byu-oit/terraform-aws-bastion.git?ref=v1.1.1" + source = "github.com/byu-oit/terraform-aws-bastion.git?ref=v1.1.2" env = "prd" vpc_vpn_to_campus = true netid = "mynetid" diff --git a/examples/module/example.tf b/examples/module/example.tf index 4de12cb..165cd67 100644 --- a/examples/module/example.tf +++ b/examples/module/example.tf @@ -4,7 +4,7 @@ provider "aws" { } module "bastion" { - source = "git@github.com:byu-oit/terraform-aws-bastion.git?ref=v1.1.1" + source = "github.com/byu-oit/terraform-aws-bastion.git?ref=v1.1.2" #source = "../../" dept_abbr = "ces" env = "dev" diff --git a/main.tf b/main.tf index 463f7bb..bf03e3c 100644 --- a/main.tf +++ b/main.tf @@ -6,7 +6,7 @@ terraform { } module "acs" { - source = "git@github.com:byu-oit/terraform-aws-acs-info.git?ref=v1.2.2" + source = "github.com/byu-oit/terraform-aws-acs-info.git?ref=v1.2.2" dept_abbr = var.dept_abbr env = var.env vpc_vpn_to_campus = var.vpc_vpn_to_campus From b996e1c4dbffd54786e4b825865f292f3da172c5 Mon Sep 17 00:00:00 2001 From: yoshutch Date: Tue, 11 Feb 2020 12:42:07 -0700 Subject: [PATCH 2/2] updated readme --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1fc6bc4..7745bcf 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +![Latest GitHub Release](https://img.shields.io/github/v/release/byu-oit/terraform-aws-bastion?sort=semver) + # terraform-aws-bastion Create a temporary bastion in an AWS Account @@ -68,15 +70,15 @@ terraform destroy The bastion is really intended to be ephemeral (spin it up, use it, tear it down). So there's no need for a backend. ## Input -| Name | Description | Default Value | -| --- | --- | --- | +| Name | Type |Description | Default Value | +| --- | --- | --- | --- | | dept_abbr| string | AWS Account department abbreviation (e.g. oit, trn) | oit | -| env | Environment of the AWS Account (for finding the shared VPC and tagging the bastion) (e.g. dev, prd)| | -| vpc_vpn_to_campus | Set to true if the bastion needs to be in the VPC that has VPN access to campus | false | -| netid | Your Net ID (for naming the bastion) | | -| public_key | Public SSH Key (e.g. \"ssh-rsa AA....Qw== comment\"). | | -| ingress_cidrs | IP Address Ranges that should have access to the bastion. | ["128.187.0.0/16", "10.0.0.0/8"] | -| subnet_type | Which subnet type sould the bastion launch in? (e.g. public, private, data) | "public" | +| env | string | Environment of the AWS Account (for finding the shared VPC and tagging the bastion) (e.g. dev, prd)| | +| vpc_vpn_to_campus | bool | Set to true if the bastion needs to be in the VPC that has VPN access to campus | false | +| netid | string | Your Net ID (for naming the bastion) | | +| public_key | string | Public SSH Key (e.g. \"ssh-rsa AA....Qw== comment\"). | | +| ingress_cidrs | list(string) | IP Address Ranges that should have access to the bastion. | ["128.187.0.0/16", "10.0.0.0/8"] | +| subnet_type | string | Which subnet type sould the bastion launch in? (e.g. public, private, data) | "public" | Notes on `subnet_type`: @@ -85,12 +87,12 @@ Notes on `subnet_type`: * If you need a `private` bastion, you'll either need to reach it across the VPN (i.e. be running the dc vpn on your workstation), or spin up a second "public" bastion to go through. ## Output -| Name | Description | -| --- | --- | -| connect | SSH connection details for the bastion | -| ec2_instance | The bastion EC2 Instance | -| security_group | The security group that controls access to the bastion | -| key_pair | The SSH keypair assigned to the bastion | +| Name | Type | Description | +| --- | --- | --- | +| connect | string |SSH connection details for the bastion | +| ec2_instance | [object](https://www.terraform.io/docs/providers/aws/r/instance.html#attributes-reference) | The bastion EC2 Instance | +| security_group | [object](https://www.terraform.io/docs/providers/aws/r/security_group.html#attributes-reference) | The security group that controls access to the bastion | +| key_pair | [object](https://www.terraform.io/docs/providers/aws/r/key_pair.html#attributes-reference) | The SSH keypair assigned to the bastion | ## Resources * An EC2 Instance (the bastion) in a public subnet