Skip to content

docs: added field description to enhance user-exp for S2S CRNs fields usage #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
+71 −47
Open

docs: added field description to enhance user-exp for S2S CRNs fields usage #124

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
55e5465
docs: added field description to enhance user-exp for S2S CRNs fields…
vbontempi Sep 26, 2025
1e697b6
feat: added projects button support
vbontempi Sep 26, 2025
4823921
Merge branch 'main' into review_userexp
vbontempi Oct 1, 2025
a96a470
feat: moved description to variable and added virtual direct mapping
vbontempi Oct 6, 2025
5f87163
Merge branch 'review_userexp' of https://github.com/terraform-ibm-mod…
vbontempi Oct 6, 2025
e7827cf
feat: mapped mq-cloud output to s2s policy input
vbontempi Oct 6, 2025
f4d236b
feat: mapped mq-cloud output to s2s policy input
vbontempi Oct 6, 2025
5569876
fix: fixed plan name to lower case
vbontempi Oct 6, 2025
5d417e2
fix: setting default null value to existing_mq_capacity_crn DA input
vbontempi Oct 6, 2025
e571767
fix: fixed mq capacity instance to use in test
vbontempi Oct 6, 2025
318ed01
fix: forced bump of ibmcloud-terratest-wrapper to v1.60.11
vbontempi Oct 9, 2025
5a698ac
Merge branch 'main' into review_userexp
vbontempi Oct 9, 2025
6b8aa7f
feat: modified variable name and description
vbontempi Oct 10, 2025
652d5c6
Merge branch 'review_userexp' of https://github.com/terraform-ibm-mod…
vbontempi Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ No modules.
| <a name="input_ease_name"></a> [ease\_name](#input\_ease\_name) | The name for the newly provisioned Enterprise Application Service instance. If a prefix input variable is specified, the prefix is added to the name in the `<prefix>-<name>` format. | `string` | `"instance"` | no |
| <a name="input_maven_repository_password"></a> [maven\_repository\_password](#input\_maven\_repository\_password) | Maven repository authentication password if needed. Default to null. | `string` | `null` | no |
| <a name="input_maven_repository_username"></a> [maven\_repository\_username](#input\_maven\_repository\_username) | Maven repository authentication username if needed. Default to null. | `string` | `null` | no |
| <a name="input_plan"></a> [plan](#input\_plan) | The desired pricing plan for Enterprise Application Service instance. | `string` | `"Standard"` | no |
| <a name="input_plan"></a> [plan](#input\_plan) | The desired pricing plan for Enterprise Application Service instance. | `string` | `"standard"` | no |
| <a name="input_region"></a> [region](#input\_region) | The desired region for deploying Enterprise Application Service instance. | `string` | `"us-east"` | no |
| <a name="input_repos_git_token"></a> [repos\_git\_token](#input\_repos\_git\_token) | The GitHub token to read from the application and configuration repositories. It cannot be null if var.source\_repo and var.config\_repo are not null. | `string` | `null` | no |
| <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | The ID of the resource group to use for the creation of the Enterprise Application Service instance. | `string` | n/a | yes |
Expand Down
2 changes: 1 addition & 1 deletion common-dev-assets
Open in desktop
Submodule common-dev-assets updated 18 files
+1 −1 commonRenovateConfig.json
+5 −5 da-assets/da-dependency-updater/README.md
+1 −1 da-assets/da-dependency-updater/requirements.txt
+8 −3 da-assets/da-dependency-updater/update_da_dependencies.py
+222 −223 module-assets/.pre-commit-config.yaml
+1 −0 module-assets/ci/.typos.toml
+144 −12 module-assets/ci/install-deps.sh
+2 −2 module-assets/ci/terraformConfigInspect.py
+3 −5 module-assets/ci/terraformDocGoMod.py
+6 −8 module-assets/ci/terraformDocOverview.py
+3 −3 module-assets/ci/terraformDocs.py
+3 −3 module-assets/ci/terraformDocsUtils.py
+1 −1 module-assets/ci/validateIbmCatalogJson.py
+2 −4 module-assets/ci/validateJsonTemplate.py
+2 −2 scripts/update-source/run-update-src.py
+2 −0 stack-assets/.pre-commit-config.yaml
+1 −1 stack-assets/stack-updater/requirements.txt
+3 −4 stack-assets/stack-updater/update_stack_definition.py
2 changes: 1 addition & 1 deletion examples/basic/variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ variable "resource_group" {
variable "plan" {
type = string
description = "The desired pricing plan for IBM Enterprise Application Service instance."
default = "Standard"
default = "standard"
}

variable "region" {
Expand Down
2 changes: 1 addition & 1 deletion examples/bdr_complete/variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ variable "resource_group" {
variable "plan" {
type = string
description = "The desired pricing plan for IBM Enterprise Application Service instance."
default = "Standard"
default = "standard"
}

variable "region" {
Expand Down
2 changes: 1 addition & 1 deletion examples/dr_complete/variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ variable "resource_group" {
variable "plan" {
type = string
description = "The desired pricing plan for IBM Enterprise Application Service instance."
default = "Standard"
default = "standard"
}

variable "region" {
Expand Down
16 changes: 14 additions & 2 deletions ibm_catalog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@
{
"reference_version": true,
"dependency_input": "existing_mq_capacity_crn",
"version_input": "mq_s2s_policy_target_crn"
"version_input": "existing_mq_capacity_crn"
},
{
"value": true,
Expand All @@ -326,6 +326,10 @@
"dependency_input": "secrets_manager_service_plan",
"version_input": "secrets_manager_service_plan",
"reference_version": true
},
{
"dependency_output": "capacity_crn",
"version_input": "mq_s2s_policy_target_crn"
}
]
}
Expand Down Expand Up @@ -376,7 +380,7 @@
"options": [
{
"displayname": "Standard",
"value": "Standard"
"value": "standard"
},
{
"displayname": "Trial (for allowlisted accounts only)",
Expand Down Expand Up @@ -576,6 +580,14 @@
{
"key": "mq_s2s_policy_target_crn"
},
{
"key": "existing_mq_capacity_crn",
"required": true,
"virtual": true,
"default_value": "__NULL__",
"type": "string",
"description": "The existing MQ capacity instance for MQ on Cloud Deployable architecture."
Copy link
Contributor

@ocofaigh ocofaigh Oct 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why would this say "Deployable architecture"? It doesn't have to come from a DA? oh wait I see what your trying to say... thinking about this....

},
{
"key": "db2_s2s_policy_enable"
},
Expand Down
15 changes: 15 additions & 0 deletions solutions/fully-configurable/outputs.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,18 @@ output "db2_s2s_resource_id" {
description = "Target Resource ID for the Service to Service policy for DB2 instance"
value = var.db2_s2s_policy_target_crn != null ? module.crn_parser_db2_instance_crn[0].service_instance : null
}

output "next_steps_text" {
value = "Enterprise Application Service instance dashboard"
description = "Access the Enterprise Application Service instance dashboard"
}

output "next_step_primary_label" {
value = "Enterprise Application Service Instance"
description = "Primary label"
}

output "next_step_primary_url" {
value = local.app_dashboard_url
description = "primary url"
}
6 changes: 3 additions & 3 deletions solutions/fully-configurable/variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,11 @@ variable "instance_name" {
variable "plan" {
type = string
description = "The desired pricing plan for Enterprise Application Service instance."
default = "Standard"
default = "standard"
validation {
# free plan is added only to allow test/validation execution (its catalog name is Trial, programmatic name is free)
condition = contains(["Standard", "free"], var.plan)
error_message = "The only values accepted for the plan field are Standard and free."
condition = contains(["standard", "free"], var.plan)
error_message = "The only values accepted for the plan field are standard and free."
}
}

Expand Down
9 changes: 5 additions & 4 deletions tests/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ toolchain go1.25.1

require (
github.com/stretchr/testify v1.11.1
github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper v1.60.6
github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper v1.60.11
gopkg.in/yaml.v3 v3.0.1
)

Expand All @@ -17,7 +17,7 @@ require (
github.com/IBM/cloud-databases-go-sdk v0.8.0 // indirect
github.com/IBM/go-sdk-core/v5 v5.21.0 // indirect
github.com/IBM/platform-services-go-sdk v0.86.1 // indirect
github.com/IBM/project-go-sdk v0.3.6 // indirect
github.com/IBM/project-go-sdk v0.3.9 // indirect
github.com/IBM/schematics-go-sdk v0.4.0 // indirect
github.com/IBM/vpc-go-sdk v1.0.2 // indirect
github.com/Microsoft/go-winio v0.6.2 // indirect
Expand Down Expand Up @@ -53,7 +53,7 @@ require (
github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect
github.com/google/go-cmp v0.7.0 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/gruntwork-io/terratest v0.50.0 // indirect
github.com/gruntwork-io/terratest v0.51.0 // indirect
github.com/hashicorp/errwrap v1.1.0 // indirect
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
github.com/hashicorp/go-getter/v2 v2.2.3 // indirect
Expand Down Expand Up @@ -91,6 +91,7 @@ require (
go.opentelemetry.io/otel v1.35.0 // indirect
go.opentelemetry.io/otel/metric v1.35.0 // indirect
go.opentelemetry.io/otel/trace v1.35.0 // indirect
go.yaml.in/yaml/v2 v2.4.2 // indirect
golang.org/x/crypto v0.41.0 // indirect
golang.org/x/mod v0.26.0 // indirect
golang.org/x/net v0.42.0 // indirect
Expand All @@ -100,5 +101,5 @@ require (
golang.org/x/tools v0.35.0 // indirect
gopkg.in/warnings.v0 v0.1.2 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
sigs.k8s.io/yaml v1.4.0 // indirect
sigs.k8s.io/yaml v1.6.0 // indirect
)
22 changes: 12 additions & 10 deletions tests/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ github.com/IBM/go-sdk-core/v5 v5.21.0 h1:DUnYhvC4SoC8T84rx5omnhY3+xcQg/Whyoa3mDP
github.com/IBM/go-sdk-core/v5 v5.21.0/go.mod h1:Q3BYO6iDA2zweQPDGbNTtqft5tDcEpm6RTuqMlPcvbw=
github.com/IBM/platform-services-go-sdk v0.86.1 h1:ngBpaXvUF3gmLvbU1Z4lX1wowOSYgGoKBEBaR/urt30=
github.com/IBM/platform-services-go-sdk v0.86.1/go.mod h1:aGD045m6I8pfcB77wft8w2cHqWOJjcM3YSSV55BX0Js=
github.com/IBM/project-go-sdk v0.3.6 h1:DRiANKnAePevFsIKSvR89SUaMa2xsd7YKK71Ka1eqKI=
github.com/IBM/project-go-sdk v0.3.6/go.mod h1:FOJM9ihQV3EEAY6YigcWiTNfVCThtdY8bLC/nhQHFvo=
github.com/IBM/project-go-sdk v0.3.9 h1:D/UfMMn+vMQyvYf9EfocV6HrD3HcVpeIVoUSjNKuROo=
github.com/IBM/project-go-sdk v0.3.9/go.mod h1:FOJM9ihQV3EEAY6YigcWiTNfVCThtdY8bLC/nhQHFvo=
github.com/IBM/schematics-go-sdk v0.4.0 h1:x01f/tPquYJYLQzJLGuxWfCbV/EdSMXRikOceNy/JLM=
github.com/IBM/schematics-go-sdk v0.4.0/go.mod h1:Xe7R7xgwmXBHu09w2CbBe8lkWZaYxNQo19bS4dpLrUA=
github.com/IBM/vpc-go-sdk v1.0.2 h1:WhI1Cb8atA8glUdFg0SEUh9u8afjnKHxZAj9onQBi04=
Expand Down Expand Up @@ -147,8 +147,8 @@ github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+
github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gruntwork-io/terratest v0.50.0 h1:AbBJ7IRCpLZ9H4HBrjeoWESITv8nLjN6/f1riMNcAsw=
github.com/gruntwork-io/terratest v0.50.0/go.mod h1:see0lbKvAqz6rvzvN2wyfuFQQG4PWcAb2yHulF6B2q4=
github.com/gruntwork-io/terratest v0.51.0 h1:RCXlCwWlHqhUoxgF6n3hvywvbvrsTXqoqt34BrnLekw=
github.com/gruntwork-io/terratest v0.51.0/go.mod h1:evZHXb8VWDgv5O5zEEwfkwMhkx9I53QR/RB11cISrpg=
github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I=
github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
Expand Down Expand Up @@ -295,8 +295,8 @@ github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO
github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper v1.60.6 h1:Tr7AlrQ+s1Nc9VOwB+It8sItnDOXhfXTxKqI2KtdyFA=
github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper v1.60.6/go.mod h1:YBrRYc+5y5Pr9CXmY35lOqTQdlIjA4x4+3iVObXGOCE=
github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper v1.60.11 h1:+ATsuqFoHUg/EWpBfF7o8wzxibSan8hG5DJV2NIgrO4=
github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper v1.60.11/go.mod h1:9QXyZWo0MotbNavJDyeEdpTj1YKoI6IT1wOPJnI1ahI=
github.com/tidwall/pretty v1.0.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk=
github.com/tmccombs/hcl2json v0.6.4 h1:/FWnzS9JCuyZ4MNwrG4vMrFrzRgsWEOVi+1AyYUVLGw=
github.com/tmccombs/hcl2json v0.6.4/go.mod h1:+ppKlIW3H5nsAsZddXPy2iMyvld3SHxyjswOZhavRDk=
Expand Down Expand Up @@ -331,6 +331,8 @@ go.opentelemetry.io/otel/sdk v1.29.0 h1:vkqKjk7gwhS8VaWb0POZKmIEDimRCMsopNYnriHy
go.opentelemetry.io/otel/sdk v1.29.0/go.mod h1:pM8Dx5WKnvxLCb+8lG1PRNIDxu9g9b9g59Qr7hfAAok=
go.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=
go.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=
go.yaml.in/yaml/v2 v2.4.2 h1:DzmwEr2rDGHl7lsFgAHxmNz/1NlQ7xLIrlN2h5d1eGI=
go.yaml.in/yaml/v2 v2.4.2/go.mod h1:081UH+NErpNdqlCXm3TtEran0rJZGxAYx9hb/ELlsPU=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
Expand Down Expand Up @@ -500,8 +502,8 @@ google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2
google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
google.golang.org/protobuf v1.35.1 h1:m3LfL6/Ca+fqnjnlqQXNpFPABW1UD7mjh8KO2mKFytA=
google.golang.org/protobuf v1.35.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
google.golang.org/protobuf v1.36.5 h1:tPhr+woSbjfYvY6/GPufUoYizxw1cF/yFoxJ2fmpwlM=
google.golang.org/protobuf v1.36.5/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
Expand All @@ -524,5 +526,5 @@ gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C
gopkg.in/yaml.v3 v3.0.0-20200605160147-a5ece683394c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
sigs.k8s.io/yaml v1.4.0 h1:Mk1wCc2gy/F0THH0TAp1QYyJNzRm2KCLy3o5ASXVI5E=
sigs.k8s.io/yaml v1.4.0/go.mod h1:Ejl7/uTz7PSA4eKMyQCUTnhZYNmLIl+5c2lQPGR2BPY=
sigs.k8s.io/yaml v1.6.0 h1:G8fkbMSAFqgEFgh4b1wmtzDnioxFCUgTZhlbj5P9QYs=
sigs.k8s.io/yaml v1.6.0/go.mod h1:796bPqUfzR/0jLAl6XjHl3Ck7MiyVv8dbTdyT3/pMf4=
1 change: 1 addition & 0 deletions tests/pr_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,7 @@ func TestAddonsDefaultConfiguration(t *testing.T) {
"plan": "free",
"secrets_manager_region": "eu-de",
"mq_s2s_policy_target_crn": mqCapacityInstanceCRN,
"existing_mq_capacity_crn": mqCapacityInstanceCRN,
},
)

Expand Down
6 changes: 3 additions & 3 deletions variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ variable "tags" {
variable "plan" {
type = string
description = "The desired pricing plan for Enterprise Application Service instance."
default = "Standard"
default = "standard"
validation {
# free plan is added only to allow test/validation execution (its catalog name is Trial)
condition = contains(["Standard", "free"], var.plan)
error_message = "The only values accepted for the plan field are Standard and free."
condition = contains(["standard", "free"], var.plan)
error_message = "The only values accepted for the plan field are standard and free."
}
}

Expand Down