Skip to content

Commit

Permalink
Update docs for using egress_proxy module
Browse files Browse the repository at this point in the history
  • Loading branch information
rahearn committed Oct 10, 2024
1 parent 78a839f commit 5430c07
Showing 1 changed file with 31 additions and 7 deletions.
38 changes: 31 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# terraform-cloudgov

Terraform modules for working with cloud.gov commonly used by [18f/rails-template](https://github.com/18f/rails-template) based apps
Terraform modules for working with cloud.gov commonly used by [GSA-TTS/rails-template](https://github.com/GSA-TTS/rails-template) based apps

## Module Examples

Expand All @@ -10,7 +10,7 @@ Creates an RDS database based on the `rds_plan_name` variable and outputs the `i

```
module "database" {
source = "github.com/18f/terraform-cloudgov//database?ref=v1.0.0"
source = "github.com/GSA-TTS/terraform-cloudgov//database?ref=v1.1.0"
cf_org_name = local.cf_org_name
cf_space_name = local.cf_space_name
Expand All @@ -32,7 +32,7 @@ Creates a Elasticache redis instance and outputs the `instance_id` for use elsew

```
module "redis" {
source = "github.com/18f/terraform-cloudgov//redis?ref=v1.0.0"
source = "github.com/GSA-TTS/terraform-cloudgov//redis?ref=v1.1.0"
cf_org_name = local.cf_org_name
cf_space_name = local.cf_space_name
Expand All @@ -54,7 +54,7 @@ Creates an s3 bucket and outputs the `bucket_id` for use elsewhere.

```
module "s3" {
source = "github.com/18f/terraform-cloudgov//s3?ref=v1.0.0"
source = "github.com/GSA-TTS/terraform-cloudgov//s3?ref=v1.1.0"
cf_org_name = local.cf_org_name
cf_space_name = local.cf_space_name
Expand All @@ -79,7 +79,7 @@ Note that the domain must be created in cloud.gov by an OrgManager before this m

```
module "domain" {
source = "github.com/18f/terraform-cloudgov//domain?ref=v1.0.0"
source = "github.com/GSA-TTS/terraform-cloudgov//domain?ref=v1.1.0"
cf_org_name = local.cf_org_name
cf_space_name = local.cf_space_name
Expand All @@ -101,7 +101,7 @@ Notes:

```
module "clamav" {
source = "github.com/18f/terraform-cloudgov//clamav?ref=v1.0.0"
source = "github.com/GSA-TTS/terraform-cloudgov//clamav?ref=v1.1.0"
cf_org_name = local.cf_org_name
cf_space_name = local.cf_space_name
Expand Down Expand Up @@ -129,7 +129,7 @@ Creates a new cloud.gov space, such as when creating an egress space, and output

```
module "egress_space" {
source = "github.com/18f/terraform-cloudgov//cg_space?ref=v1.0.0"
source = "github.com/GSA-TTS/terraform-cloudgov//cg_space?ref=v1.1.0"
cf_org_name = local.cf_org_name
cf_space_name = "${local.cf_space_name}-egress"
Expand All @@ -145,6 +145,30 @@ module "egress_space" {
}
```

### egress_proxy

Creates and configures an instance of cg-egress-proxy to proxy traffic from your apps.

Prerequities:

* existing client_space with already deployed apps
* existing public-egress space to deploy the proxy into

```
module "egress_proxy" {
source = "github.com/GSA-TTS/terraform-cloudgov//egress_proxy?ref=v1.1.0"
cf_org_name = local.cf_org_name
cf_space_name = "${local.cf_space_name}-egress"
client_space = local.cf_space_name
name = "egress-proxy"
allowlist = {
"source_app_name" = ["host.com:443", "otherhost.com:443"]
}
# see egress_proxy/variables.tf for full list of optional arguments
}
```

## Testing


Expand Down

0 comments on commit 5430c07

Please sign in to comment.