Skip to content

Commit d1c8359

Browse files
authored
fix: landing zone configuration tool updates (#801)
1 parent 5978ff9 commit d1c8359

File tree

11 files changed

+27
-23
lines changed

11 files changed

+27
-23
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ The second route is to use the `override.json` to create a fully customized envi
124124

125125
Through the `override.json`, you can pass any variable or supported optional variable attributes from this root module, which each pattern uses to provision infrastructure. For a complete list of supported variables and attributes, see the [variables.tf ](variables.tf) file.
126126

127+
:information_source: **Tip:** You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to create the JSON.
128+
127129
#### Overriding variables
128130

129131
After every execution of `terraform apply`, a JSON-encoded definition is output. This definition of your environment is based on the defaults for the Landing Zone and any variables that are changed in the `override.json` file. You can then use the output in the `override.json` file.

examples/one-vpc-one-vsi/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# One VPC with one VSI example
22

33
The examples shows how you can use the landing zone module to create a basic, minimal topology by using an `override.json` file.
4-
1. A single VPC:
5-
- Named `management` in this example
6-
- Includes three subnets across the three availability zone to host VSIs
7-
- Default, open network ACLs
8-
2. One single VSI:
9-
- Named 'jump-box' in this example
10-
- Located in one of the 'vsi' subnets of the VPC
11-
- Publicly exposed via a floating IP address.
12-
- Open security groups
13-
14-
This example also creates the minimum encryption and audit infrastructure.
15-
- A Key Protect instance and key that is used to encrypt the VSI boot volume
16-
- The Activity Tracker infrastructure (Activity Tracker route to an encrypted COS bucket that stores audit events)
4+
5+
:information_source: **Tip:** You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to further customize the `override.json` file.
6+
7+
The example deploys the following infrastructure:
8+
9+
- A single VPC that is named `management` with 3 subnets across the three availability zone to host VSIs. By default, the network ACLS are open.
10+
- A single VSI that is name `jump-box` and located in one of the `vsi` subnets of the VPC. It is publicly exposed with a floating IP address and with open security groups.
11+
12+
The example also creates the minimum encryption and audit infrastructure:
13+
14+
- A Key Protect instance and key that is used to encrypt the VSI boot volume.
15+
- The Activity Tracker infrastructure: An Activity Tracker route to an encrypted COS bucket that stores audit events.
1716

1817
:exclamation: **Important:** This example shows an example of basic topology. The topology is not highly available or validated for the IBM Cloud Framework for Financial Services.
1918

2019
Example usage:
21-
```
20+
21+
```sh
2222
export TF_VAR_ibmcloud_api_key=<your api key> # pragma: allowlist secret
2323
terraform apply -var=ssh_key='ssh-rsa ...' -var=region=eu-gb -var=prefix=my_slz
2424
```

examples/override-example/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This example demonstrates how to configure the landing zone module by using an `override.json` file. The example builds on the default topology that is defined in the VSI pattern, and uses a JSON file to override the default configuration.
44

5+
:information_source: **Tip:** You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to further customize the `override.json` file.
6+
57
The example deploys the following infrastructure:
68

79
- An edge VPC with 1 VSI in one of the three subnets and a VPC load balancer in the edge VPC, exposing the VSI publicly.

patterns/mixed/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,7 @@ variable "override" {
573573
}
574574

575575
variable "override_json_string" {
576-
description = "Override default values with custom JSON. Any value here other than an empty string will override all other configuration changes."
576+
description = "Override default values with a JSON object. Any JSON other than an empty string overrides other configuration changes. You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to create the JSON."
577577
type = string
578578
default = ""
579579
}

patterns/roks/module/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -574,7 +574,7 @@ variable "override" {
574574
}
575575

576576
variable "override_json_string" {
577-
description = "Override default values with custom JSON. Any value here other than an empty string will override all other configuration changes."
577+
description = "Override default values with a JSON object. Any JSON other than an empty string overrides other configuration changes. You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to create the JSON."
578578
type = string
579579
default = ""
580580
}

patterns/roks/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ variable "override" {
567567
}
568568

569569
variable "override_json_string" {
570-
description = "Override default values with custom JSON. Any value here other than an empty string will override all other configuration changes."
570+
description = "Override default values with a JSON object. Any JSON other than an empty string overrides other configuration changes. You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to create the JSON."
571571
type = string
572572
default = ""
573573
}

patterns/vpc/module/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ variable "override" {
473473
}
474474

475475
variable "override_json_string" {
476-
description = "Override default values with custom JSON. Any value here other than an empty string will override all other configuration changes."
476+
description = "Override default values with a JSON object. Any JSON other than an empty string overrides other configuration changes. You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to create the JSON."
477477
type = string
478478
default = ""
479479
}

patterns/vpc/variables.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -456,13 +456,13 @@ variable "skip_all_s2s_auth_policies" {
456456
##############################################################################
457457

458458
variable "override" {
459-
description = "Override default values with custom JSON template. This uses the file `override.json` to allow users to create a fully customized environment."
459+
description = "Override default values with custom JSON template. This uses the file `override.json` to allow users to create a fully customized environment. You can use the landing zone configuration tool to customize your override.json file."
460460
type = bool
461461
default = false
462462
}
463463

464464
variable "override_json_string" {
465-
description = "Override default values with custom JSON. Any value here other than an empty string will override all other configuration changes."
465+
description = "Override default values with a JSON object. Any JSON other than an empty string overrides other configuration changes. You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to create the JSON."
466466
type = string
467467
default = ""
468468
}

patterns/vsi-quickstart/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ variable "resource_tags" {
4141
}
4242

4343
variable "override_json_string" {
44-
description = "Override default values with custom JSON. Any value here other than an empty string will override all other configuration changes."
44+
description = "Override default values with a JSON object. Any JSON other than an empty string overrides other configuration changes. You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to create the JSON."
4545
type = string
4646
default = <<EOF
4747
{

patterns/vsi/module/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ variable "override" {
505505
}
506506

507507
variable "override_json_string" {
508-
description = "Override default values with custom JSON. Any value here other than an empty string will override all other configuration changes."
508+
description = "Override default values with a JSON object. Any JSON other than an empty string overrides other configuration changes. You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to create the JSON."
509509
type = string
510510
default = ""
511511
}

0 commit comments

Comments
 (0)