Skip to content

Commit

Permalink
Update some obsolete README content
Browse files Browse the repository at this point in the history
  • Loading branch information
rahearn committed Dec 20, 2024
1 parent abc01da commit 66624a2
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ module "domain" {

### clamav

Creates an application and associated network routing to run ClamAV via API to scan user uploads and outputs the `app_id`, the `route_id`, and the `endpoint` for use elsewhere.
Creates an application to run ClamAV via API to scan user uploads and outputs the `app_id`, the `route_id`, and the `endpoint` for use elsewhere.

Notes:
* The scanning app requires at least `3GB` of memory, and your `app_name` must be deployed before this module is included.
Expand All @@ -113,6 +113,8 @@ module "clamav" {
}
```

See <UPGRADING.md> for an example of how to set up network policies to reach the clamav app from the client apps.

### cg_space

Creates a new cloud.gov space, such as when creating an egress space, and outputs the `space_id` for use elsewhere.
Expand Down Expand Up @@ -146,26 +148,22 @@ module "egress_space" {

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
Prerequite: existing public-egress space to deploy the proxy into

```
module "egress_proxy" {
source = "github.com/GSA-TTS/terraform-cloudgov//egress_proxy?ref=v2.0.0"
cf_org_name = local.cf_org_name
cf_egress_space = data.cloudfoundry_space.egress_space
cf_client_spaces = {(data.cloudfoundry_space.app_space.name) = data.cloudfoundy_space.app_space.id}
name = "egress-proxy"
allowlist = {
"source_app_name" = ["host.com:443", "otherhost.com:443"]
}
cf_org_name = local.cf_org_name
cf_egress_space = data.cloudfoundry_space.egress_space
name = "egress-proxy"
allowlist = [ "list.of.hosts", "to.allow.access" ]
# see egress_proxy/variables.tf for full list of optional arguments
}
```

See <UPGRADING.md> for an example of how to set up network policies and credential stores to enable your client app to reach the proxy.

## Testing


Expand Down

0 comments on commit 66624a2

Please sign in to comment.