From c2088aa4f8eca2def08abf1c4495b314ddba9507 Mon Sep 17 00:00:00 2001 From: surajsbharadwaj <101711050+surajsbharadwaj@users.noreply.github.com> Date: Fri, 8 Sep 2023 11:27:16 +0200 Subject: [PATCH] docs: powervs_images variable description (#609) --- .secrets.baseline | 4 ++-- ibm_catalog.json | 12 +++++++----- solutions/extension/README.md | 2 +- solutions/extension/variables.tf | 2 +- solutions/full-stack/README.md | 2 +- solutions/full-stack/variables.tf | 2 +- 6 files changed, 13 insertions(+), 11 deletions(-) diff --git a/.secrets.baseline b/.secrets.baseline index 7b549625..578a96ab 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -3,7 +3,7 @@ "files": "go.sum|^.secrets.baseline$", "lines": null }, - "generated_at": "2023-09-05T11:42:19Z", + "generated_at": "2023-09-08T06:55:00Z", "plugins_used": [ { "name": "AWSKeyDetector" @@ -100,7 +100,7 @@ "hashed_secret": "3a16a2d2850bbe557924aebe9f1f1294199bfbab", "is_secret": false, "is_verified": false, - "line_number": 717, + "line_number": 719, "type": "Secret Keyword", "verified_result": null } diff --git a/ibm_catalog.json b/ibm_catalog.json index 395d7357..11c9ac1f 100644 --- a/ibm_catalog.json +++ b/ibm_catalog.json @@ -239,6 +239,10 @@ "type": "multiline_secure_value" } }, + { + "key": "powervs_image_names", + "required": true + }, { "key": "configure_dns_forwarder" }, @@ -260,9 +264,6 @@ { "key": "cloud_connection" }, - { - "key": "powervs_image_names" - }, { "key": "tags" } @@ -582,10 +583,11 @@ } }, { - "key": "cloud_connection" + "key": "powervs_image_names", + "required": true }, { - "key": "powervs_image_names" + "key": "cloud_connection" }, { "key": "tags" diff --git a/solutions/extension/README.md b/solutions/extension/README.md index 7b09c468..baabce48 100644 --- a/solutions/extension/README.md +++ b/solutions/extension/README.md @@ -60,7 +60,7 @@ Catalog image names to be imported into infrastructure can be found [here](../fu | [cloud\_connection](#input\_cloud\_connection) | Cloud connection configuration: speed (50, 100, 200, 500, 1000, 2000, 5000, 10000 Mb/s), count (1 or 2 connections), global\_routing (true or false), metered (true or false). Not applicable for dal10 DC where PER is enabled. | 
object({
    count          = number
    speed          = number
    global_routing = bool
    metered        = bool
  })
| 
{
  "count": 2,
  "global_routing": true,
  "metered": true,
  "speed": 5000
}
| no | | [ibmcloud\_api\_key](#input\_ibmcloud\_api\_key) | The IBM Cloud platform API key needed to deploy IAM enabled resources. | `string` | n/a | yes | | [powervs\_backup\_network](#input\_powervs\_backup\_network) | Name of the IBM Cloud PowerVS backup network and CIDR to create. | 
object({
    name = string
    cidr = string
  })
| 
{
  "cidr": "10.62.0.0/24",
  "name": "bkp_net"
}
| no | -| [powervs\_image\_names](#input\_powervs\_image\_names) | List of Images to be imported into cloud account from catalog images | `list(string)` | 
[
  "SLES15-SP4-SAP",
  "SLES15-SP4-SAP-NETWEAVER",
  "RHEL8-SP6-SAP",
  "RHEL8-SP6-SAP-NETWEAVER"
]
| no | +| [powervs\_image\_names](#input\_powervs\_image\_names) | List of Images to be imported into cloud account from catalog images. Supported values can be found [here](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/blob/main/solutions/full-stack/docs/catalog_image_names.md) | `list(string)` | 
[
  "SLES15-SP4-SAP",
  "SLES15-SP4-SAP-NETWEAVER",
  "RHEL8-SP6-SAP",
  "RHEL8-SP6-SAP-NETWEAVER"
]
| no | | [powervs\_management\_network](#input\_powervs\_management\_network) | Name of the IBM Cloud PowerVS management subnet and CIDR to create. | 
object({
    name = string
    cidr = string
  })
| 
{
  "cidr": "10.61.0.0/24",
  "name": "mgmt_net"
}
| no | | [powervs\_resource\_group\_name](#input\_powervs\_resource\_group\_name) | Existing IBM Cloud resource group name. | `string` | n/a | yes | | [powervs\_zone](#input\_powervs\_zone) | IBM Cloud data center location where IBM PowerVS infrastructure will be created. | `string` | n/a | yes | diff --git a/solutions/extension/variables.tf b/solutions/extension/variables.tf index 1b5b8fd0..926a3b3a 100644 --- a/solutions/extension/variables.tf +++ b/solutions/extension/variables.tf @@ -65,7 +65,7 @@ variable "cloud_connection" { } variable "powervs_image_names" { - description = "List of Images to be imported into cloud account from catalog images" + description = "List of Images to be imported into cloud account from catalog images. Supported values can be found [here](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/blob/main/solutions/full-stack/docs/catalog_image_names.md)" type = list(string) default = ["SLES15-SP4-SAP", "SLES15-SP4-SAP-NETWEAVER", "RHEL8-SP6-SAP", "RHEL8-SP6-SAP-NETWEAVER"] } diff --git a/solutions/full-stack/README.md b/solutions/full-stack/README.md index a9e0be4b..c4568c90 100644 --- a/solutions/full-stack/README.md +++ b/solutions/full-stack/README.md @@ -63,7 +63,7 @@ No resources. | [ibmcloud\_api\_key](#input\_ibmcloud\_api\_key) | The IBM Cloud platform API key needed to deploy IAM enabled resources. | `string` | n/a | yes | | [landing\_zone\_configuration](#input\_landing\_zone\_configuration) | VPC landing zone configuration. | `string` | n/a | yes | | [powervs\_backup\_network](#input\_powervs\_backup\_network) | Name of the IBM Cloud PowerVS backup network and CIDR to create. | 
object({
    name = string
    cidr = string
  })
| 
{
  "cidr": "10.52.0.0/24",
  "name": "bkp_net"
}
| no | -| [powervs\_image\_names](#input\_powervs\_image\_names) | List of Images to be imported into cloud account from catalog images | `list(string)` | 
[
  "SLES15-SP4-SAP",
  "SLES15-SP4-SAP-NETWEAVER",
  "RHEL8-SP6-SAP",
  "RHEL8-SP6-SAP-NETWEAVER"
]
| no | +| [powervs\_image\_names](#input\_powervs\_image\_names) | List of Images to be imported into cloud account from catalog images. Supported values can be found [here](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/blob/main/solutions/full-stack/docs/catalog_image_names.md) | `list(string)` | 
[
  "SLES15-SP4-SAP",
  "SLES15-SP4-SAP-NETWEAVER",
  "RHEL8-SP6-SAP",
  "RHEL8-SP6-SAP-NETWEAVER"
]
| no | | [powervs\_management\_network](#input\_powervs\_management\_network) | Name of the IBM Cloud PowerVS management subnet and CIDR to create. | 
object({
    name = string
    cidr = string
  })
| 
{
  "cidr": "10.51.0.0/24",
  "name": "mgmt_net"
}
| no | | [powervs\_resource\_group\_name](#input\_powervs\_resource\_group\_name) | Existing IBM Cloud resource group name. | `string` | n/a | yes | | [powervs\_zone](#input\_powervs\_zone) | IBM Cloud data center location where IBM PowerVS infrastructure will be created. | `string` | n/a | yes | diff --git a/solutions/full-stack/variables.tf b/solutions/full-stack/variables.tf index 397aaa8d..a5399b7d 100644 --- a/solutions/full-stack/variables.tf +++ b/solutions/full-stack/variables.tf @@ -119,7 +119,7 @@ variable "cloud_connection" { } variable "powervs_image_names" { - description = "List of Images to be imported into cloud account from catalog images" + description = "List of Images to be imported into cloud account from catalog images. Supported values can be found [here](https://github.com/terraform-ibm-modules/terraform-ibm-powervs-infrastructure/blob/main/solutions/full-stack/docs/catalog_image_names.md)" type = list(string) default = ["SLES15-SP4-SAP", "SLES15-SP4-SAP-NETWEAVER", "RHEL8-SP6-SAP", "RHEL8-SP6-SAP-NETWEAVER"] }