Skip to content

Commit 5171ca5

Browse files
authored
chore: adopt best practises for VPE gateway examples (#544)
1 parent 280b071 commit 5171ca5

File tree

17 files changed

+21
-16
lines changed

17 files changed

+21
-16
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ An IBM Provider [issue](https://github.com/IBM-Cloud/terraform-provider-ibm/issu
2222
## Overview
2323
* [terraform-ibm-vpe-gateway](#terraform-ibm-vpe-gateway)
2424
* [Examples](./examples)
25-
* [End-to-end example](./examples/default)
26-
* [Every multi-tenant VPE](./examples/every-mt-vpe)
25+
* [Advanced dedicated service VPE gateway](./examples/advanced)
26+
* [Basic multi-tenant VPE gateway](./examples/basic)
2727
* [Contributing](#contributing)
2828
<!-- END OVERVIEW HOOK -->
2929

cra-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# More info about this file at https://github.com/terraform-ibm-modules/common-pipeline-assets/blob/main/.github/workflows/terraform-test-pipeline.md#cra-config-yaml
22
version: "v1"
33
CRA_TARGETS:
4-
- CRA_TARGET: "examples/default" # Target directory for CRA scan. If not provided, the CRA Scan will not be run.
4+
- CRA_TARGET: "examples/advanced" # Target directory for CRA scan. If not provided, the CRA Scan will not be run.
55
CRA_IGNORE_RULES_FILE: "cra-tf-validate-ignore-rules.json" # CRA Ignore file to use. If not provided, it checks the repo root directory for `cra-tf-validate-ignore-rules.json`
66
PROFILE_ID: "0e6e7b5a-817d-4344-ab6f-e5d7a9c49520" # SCC profile ID (currently set to the FSCloud 1.4.0 profile).
77
CRA_ENVIRONMENT_VARIABLES:
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
# End-to-end example
1+
# Advanced dedicated service VPE gateway
22

33
This example creates the following infrastructure:
44
- A resource group, if one is not passed in.
55
- A VPC, if one is not passed in.
66
- The VPC is created with three subnets across the three availability zones of the region that is passed as input.
77
- A security group in the VPC.
88
- The security group is created with a single inbound rule that allows traffic from resources that are attached to the default VPC security group. This rule is added as an example.
9-
- Two virtual private endpoint (VPE) gateways. By default, one VPE to COS and another VPE to Key Protect are created. You can change the defaults by using the `service_endpoints` input.
9+
- Two virtual private endpoint (VPE) gateways are created. One to COS and the other VPE to Key Protect.
1010
- Each of the two virtual private endpoint gateways are attached to the three VPC subnets.
1111
- The new security group is attached to the two VPE gateways.
12+
- A dedicated postgresql instance with a VPE gateway from the VPC
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ terraform {
1010
ibm = {
1111
source = "IBM-Cloud/ibm"
1212
# pin above lowest vesion, required for postgresql and IAM auth policy
13-
version = "1.62.0"
13+
version = ">=1.61.0"
1414
}
1515
time = {
1616
source = "hashicorp/time"

examples/basic/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Basic multi-tenant VPE gateway
2+
3+
This example creates the following infrastructure:
4+
- A resource group, if one is not passed in.
5+
- A VPC
6+
- The VPC is created with three subnets across the three availability zones of the region that is passed as input.
7+
- A virtual private endpoint (VPE) gateways for every multitenant service supported

0 commit comments

Comments
 (0)