Skip to content

Commit b9eb876

Browse files
authored
docs: Variable description (#71)
* fix: make signing key optional * docs: improve variable description * docs: improve variable description * docs: improve variable description * docs: improve variable description
1 parent 1873858 commit b9eb876

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

ibm_catalog.json

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,10 @@
163163
{
164164
"key": "signing_key",
165165
"type": "password",
166-
"description": "The key used to sign the application image built by the CI pipeline deployed in this solution. Please refer to the documentation for details on generating the key.",
166+
"description": "The key used to sign the application image built by the CI pipeline deployed in this solution; please refer to the documentation at https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/blob/main/README.md for generating the key; if not set, all resources will deploy successfully, but the initial CI pipeline execution will fail at the signing step.",
167167
"display_name": "Multiline secure value",
168-
"required": true,
168+
"default_value": "",
169+
"required": false,
169170
"custom_config": {
170171
"type": "multiline_secure_value",
171172
"grouping": "deployment",
@@ -199,14 +200,14 @@
199200
{
200201
"key": "watsonx_admin_api_key",
201202
"type": "password",
202-
"description": "The API Key used to provision the watson project resources. If not set, the ibmcloud_api_key is used.",
203+
"description": "The API key used to provision the watson project resources. If not set, the API key used to deploy the solution is used.",
203204
"required": false
204205
},
205206
{
206207
"key": "secret_manager_service_plan",
207208
"type": "string",
208209
"default_value": "trial",
209-
"description": "The service/pricing plan to use when provisioning a new Secrets Manager instance. Allowed values: 'standard' and 'trial'. Only one trial instance is allowed per account.",
210+
"description": "The service/pricing plan to use when provisioning a new Secrets Manager instance. Only one trial instance is allowed per account.",
210211
"required": false,
211212
"options": [
212213
{
@@ -219,20 +220,20 @@
219220
}
220221
]
221222
},
222-
{
223-
"key": "enable_platform_logs_metrics",
224-
"type": "boolean",
225-
"default_value": false,
226-
"description": "Whether to provision logging and monitoring instances are configured to receive all platform logs and metrics in the target region. There can only be one instance per region provisioned for platform logs/metrics.",
227-
"required": false
228-
},
229223
{
230224
"key": "existing_secrets_manager_crn",
231225
"type": "string",
232226
"default_value": "__NULL__",
233227
"description": "The CRN of an existing secret manager instance to use in this solution. If not set, a new secret manager instance is provisioned. ",
234228
"required": false
235229
},
230+
{
231+
"key": "enable_platform_logs_metrics",
232+
"type": "boolean",
233+
"default_value": false,
234+
"description": "Whether to provision logging and monitoring instances are configured to receive all platform logs and metrics in the target region. There can only be one instance per region provisioned for platform logs/metrics.",
235+
"required": false
236+
},
236237
{
237238
"key": "sample_app_git_url",
238239
"type": "string",

0 commit comments

Comments
 (0)