Skip to content

Commit 1567723

Browse files
knee-namaheshwarishikhaKhuzaima-Shakeel
authored
fix: Update catalog content, input and output variables description as suggested by Content reviewer<br>Add a missing permission for app-config in DA, dependency of SCC-WP (#172)
* Cloud automation for watsonx.ai content review * Update ibm_catalog.json * Update variables.tf * Update ibm_catalog.json * minor fixes * minor fixes * fix pre-commit --------- Co-authored-by: Shikha Maheshwari <maheshwari.shikha@gmail.com> Co-authored-by: Khuzaima-Shakeel <Khuzaima.Shakeel@ibm.com>
1 parent 956b8bf commit 1567723

File tree

5 files changed

+86
-78
lines changed

5 files changed

+86
-78
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -130,35 +130,35 @@ You need the following permissions to run this module:
130130

131131
| Name | Description | Type | Default | Required |
132132
|------|-------------|------|---------|:--------:|
133-
| <a name="input_cos_instance_crn"></a> [cos\_instance\_crn](#input\_cos\_instance\_crn) | The CRN of the Cloud Object Storage instance. | `string` | n/a | yes |
134-
| <a name="input_cos_kms_key_crn"></a> [cos\_kms\_key\_crn](#input\_cos\_kms\_key\_crn) | The CRN of a KMS (Key Protect) key. It is used to encrypt the COS buckets used by the watsonx.ai projects. | `string` | `null` | no |
133+
| <a name="input_cos_instance_crn"></a> [cos\_instance\_crn](#input\_cos\_instance\_crn) | The CRN of the Object Storage instance. | `string` | n/a | yes |
134+
| <a name="input_cos_kms_key_crn"></a> [cos\_kms\_key\_crn](#input\_cos\_kms\_key\_crn) | The CRN of a Key Protect key. This key is used to encrypt the Object Storage buckets used by watsonx.ai. | `string` | `null` | no |
135135
| <a name="input_create_watsonx_ai_project"></a> [create\_watsonx\_ai\_project](#input\_create\_watsonx\_ai\_project) | Whether to create and configure a starter watsonx.ai project. | `bool` | `true` | no |
136-
| <a name="input_enable_cos_kms_encryption"></a> [enable\_cos\_kms\_encryption](#input\_enable\_cos\_kms\_encryption) | Flag to enable COS KMS encryption. If set to true, a value must be passed for `cos_kms_key_crn`. | `bool` | `false` | no |
137-
| <a name="input_existing_watsonx_ai_runtime_instance_crn"></a> [existing\_watsonx\_ai\_runtime\_instance\_crn](#input\_existing\_watsonx\_ai\_runtime\_instance\_crn) | The CRN of an existing watsonx.ai Runtime instance. If not provided, a new instance will be provisioned. | `string` | `null` | no |
138-
| <a name="input_existing_watsonx_ai_studio_instance_crn"></a> [existing\_watsonx\_ai\_studio\_instance\_crn](#input\_existing\_watsonx\_ai\_studio\_instance\_crn) | The CRN of an existing watsonx.ai Studio instance. If not provided, a new instance will be provisioned. | `string` | `null` | no |
139-
| <a name="input_mark_as_sensitive"></a> [mark\_as\_sensitive](#input\_mark\_as\_sensitive) | Set to true to allow the watsonx.ai project to be created with 'Mark as sensitive' flag. It enforces access restriction and prevents data from being moved out of the project. | `bool` | `false` | no |
140-
| <a name="input_project_description"></a> [project\_description](#input\_project\_description) | A description of the watsonx.ai project that is created. | `string` | `"Watsonx project created by the watsonx.ai module."` | no |
136+
| <a name="input_enable_cos_kms_encryption"></a> [enable\_cos\_kms\_encryption](#input\_enable\_cos\_kms\_encryption) | Flag to enable Object Storage key encryption. If set to `true`, a value must be passed for `cos_kms_key_crn`. | `bool` | `false` | no |
137+
| <a name="input_existing_watsonx_ai_runtime_instance_crn"></a> [existing\_watsonx\_ai\_runtime\_instance\_crn](#input\_existing\_watsonx\_ai\_runtime\_instance\_crn) | The CRN of an existing watsonx.ai Runtime instance. If not provided, a new instance is provisioned. | `string` | `null` | no |
138+
| <a name="input_existing_watsonx_ai_studio_instance_crn"></a> [existing\_watsonx\_ai\_studio\_instance\_crn](#input\_existing\_watsonx\_ai\_studio\_instance\_crn) | The CRN of an existing watsonx.ai Studio instance. If not provided, a new instance is provisioned. | `string` | `null` | no |
139+
| <a name="input_mark_as_sensitive"></a> [mark\_as\_sensitive](#input\_mark\_as\_sensitive) | Set to `true` to create the watsonx.ai project with the `Mark as sensitive` flag enabled. The flag enforces access restrictions and prevents data from being moved out of the project. | `bool` | `false` | no |
140+
| <a name="input_project_description"></a> [project\_description](#input\_project\_description) | A description of the watsonx.ai project that is created. | `string` | `"Watsonx.ai project created by the watsonx.ai module."` | no |
141141
| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | The name of the watsonx.ai project. | `string` | `"demo"` | no |
142-
| <a name="input_project_tags"></a> [project\_tags](#input\_project\_tags) | A list of tags associated with the watsonx.ai project. Each tag consists of a string containing up to 255 characters. These tags can include spaces, letters, numbers, underscores, dashes, as well as the symbols # and @. | `list(string)` | <pre>[<br/> "watsonx-ai"<br/>]</pre> | no |
143-
| <a name="input_region"></a> [region](#input\_region) | Region where the watsonx.ai resources will be provisioned. | `string` | `"us-south"` | no |
144-
| <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | The resource group ID where the watsonx services will be provisioned. Required when creating a new instance. | `string` | `null` | no |
145-
| <a name="input_resource_tags"></a> [resource\_tags](#input\_resource\_tags) | Optional list of tags to describe the service instances created by the module. | `list(string)` | `[]` | no |
146-
| <a name="input_skip_iam_authorization_policy"></a> [skip\_iam\_authorization\_policy](#input\_skip\_iam\_authorization\_policy) | Whether to create an IAM authorization policy that permits the Object Storage instance to read the encryption key from the KMS instance. An authorization policy must exist before an encrypted bucket can be created. Set to `true` to avoid creating the policy. | `bool` | `false` | no |
147-
| <a name="input_watsonx_ai_new_project_members"></a> [watsonx\_ai\_new\_project\_members](#input\_watsonx\_ai\_new\_project\_members) | The list of new members the owner of the Watsonx.ai project would like to add to the project. | <pre>list(object({<br/> email = string<br/> iam_id = string<br/> role = string<br/> state = optional(string, "ACTIVE")<br/> type = optional(string, "user")<br/> })<br/> )</pre> | `[]` | no |
148-
| <a name="input_watsonx_ai_runtime_instance_name"></a> [watsonx\_ai\_runtime\_instance\_name](#input\_watsonx\_ai\_runtime\_instance\_name) | The name of the watsonx.ai Runtime instance to create. If a prefix input variable is passed, it is prefixed to the value in the `<prefix>-value` format. | `string` | `"watsonx-runtime"` | no |
149-
| <a name="input_watsonx_ai_runtime_plan"></a> [watsonx\_ai\_runtime\_plan](#input\_watsonx\_ai\_runtime\_plan) | The plan that is used to provision the watsonx.ai Runtime instance. Allowed values are 'lite', 'v2-professional' and 'v2-standard'. 'lite' refers to 'Lite', 'v2-professional' refers to 'Standard' and 'v2-standard' refers to 'Essentials' plan on IBM Cloud dashboard. For 'lite' plan, the `watsonx_ai_runtime_service_endpoints` value is ignored and the default service configuration is applied. | `string` | `"lite"` | no |
150-
| <a name="input_watsonx_ai_runtime_service_endpoints"></a> [watsonx\_ai\_runtime\_service\_endpoints](#input\_watsonx\_ai\_runtime\_service\_endpoints) | The type of service endpoints for watsonx.ai Runtime. Possible values: 'public', 'private', 'public-and-private'. | `string` | `"public"` | no |
151-
| <a name="input_watsonx_ai_studio_instance_name"></a> [watsonx\_ai\_studio\_instance\_name](#input\_watsonx\_ai\_studio\_instance\_name) | The name of the watsonx.ai Studio instance to create. If a prefix input variable is passed, it is prefixed to the value in the `<prefix>-value` format. | `string` | `"watsonx-studio"` | no |
152-
| <a name="input_watsonx_ai_studio_plan"></a> [watsonx\_ai\_studio\_plan](#input\_watsonx\_ai\_studio\_plan) | The plan that is used to provision the watsonx.ai Studio instance. Allowed values are 'free-v1' and 'professional-v1'. 'free-v1' refers to 'Lite' and 'professional-v1' refers to 'Professional' plan on IBM Cloud dashboard. | `string` | `"free-v1"` | no |
142+
| <a name="input_project_tags"></a> [project\_tags](#input\_project\_tags) | A list of tags associated with the watsonx.ai project. Each tag consists of a string containing up to 255 characters. These tags can include spaces, letters, numbers, underscores, dashes, as well as the symbols `#` and `@`. | `list(string)` | <pre>[<br/> "watsonx-ai"<br/>]</pre> | no |
143+
| <a name="input_region"></a> [region](#input\_region) | Region where the watsonx.ai instance is provisioned. | `string` | `"us-south"` | no |
144+
| <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | The resource group ID for the watsonx.ai instance. Required to create an instance of watsonx.ai. | `string` | `null` | no |
145+
| <a name="input_resource_tags"></a> [resource\_tags](#input\_resource\_tags) | Optional list of tags to describe the watsonx.ai instance. | `list(string)` | `[]` | no |
146+
| <a name="input_skip_iam_authorization_policy"></a> [skip\_iam\_authorization\_policy](#input\_skip\_iam\_authorization\_policy) | Whether to create an IAM authorization policy that permits the Object Storage instance to read the encryption key from the key management service instance. An authorization policy must exist before an encrypted bucket can be created. Set to `true` to not create this policy. | `bool` | `false` | no |
147+
| <a name="input_watsonx_ai_new_project_members"></a> [watsonx\_ai\_new\_project\_members](#input\_watsonx\_ai\_new\_project\_members) | The list of members to add to the watsonx.ai project. | <pre>list(object({<br/> email = string<br/> iam_id = string<br/> role = string<br/> state = optional(string, "ACTIVE")<br/> type = optional(string, "user")<br/> })<br/> )</pre> | `[]` | no |
148+
| <a name="input_watsonx_ai_runtime_instance_name"></a> [watsonx\_ai\_runtime\_instance\_name](#input\_watsonx\_ai\_runtime\_instance\_name) | The name of the watsonx.ai Runtime instance to create. If a prefix input variable is passed, it is prefixed to the value following a `<prefix>-value` format. | `string` | `"watsonx-runtime"` | no |
149+
| <a name="input_watsonx_ai_runtime_plan"></a> [watsonx\_ai\_runtime\_plan](#input\_watsonx\_ai\_runtime\_plan) | The plan that is used to provision the watsonx.ai Runtime instance. Allowed values are 'lite', 'v2-professional', and 'v2-standard'. 'lite' refers to the 'Lite' plan, 'v2-professional' refers to the 'Standard' plan, and 'v2-standard' refers to the 'Essentials' plan on the IBM Cloud dashboard. For 'lite' plan, the `watsonx_ai_runtime_service_endpoints` value is ignored and the default service configuration is applied. | `string` | `"lite"` | no |
150+
| <a name="input_watsonx_ai_runtime_service_endpoints"></a> [watsonx\_ai\_runtime\_service\_endpoints](#input\_watsonx\_ai\_runtime\_service\_endpoints) | The type of service endpoints for watsonx.ai Runtime. Possible values are 'public', 'private', or 'public-and-private'. | `string` | `"public"` | no |
151+
| <a name="input_watsonx_ai_studio_instance_name"></a> [watsonx\_ai\_studio\_instance\_name](#input\_watsonx\_ai\_studio\_instance\_name) | The name of the watsonx.ai Studio instance to create. If a prefix input variable is passed, it is prefixed to the value following a `<prefix>-value` format. | `string` | `"watsonx-studio"` | no |
152+
| <a name="input_watsonx_ai_studio_plan"></a> [watsonx\_ai\_studio\_plan](#input\_watsonx\_ai\_studio\_plan) | The plan that is used to provision the watsonx.ai Studio instance. Allowed values are 'free-v1' and 'professional-v1'. 'free-v1' refers to the 'Lite' plan and 'professional-v1' refers to the 'Professional' plan on IBM Cloud dashboard. | `string` | `"free-v1"` | no |
153153

154154
### Outputs
155155

156156
| Name | Description |
157157
|------|-------------|
158-
| <a name="output_watsonx_ai_project_bucket_name"></a> [watsonx\_ai\_project\_bucket\_name](#output\_watsonx\_ai\_project\_bucket\_name) | The name of the COS bucket created for the watsonx.ai project. |
158+
| <a name="output_watsonx_ai_project_bucket_name"></a> [watsonx\_ai\_project\_bucket\_name](#output\_watsonx\_ai\_project\_bucket\_name) | The name of the Object Storage bucket created for the watsonx.ai project. |
159159
| <a name="output_watsonx_ai_project_id"></a> [watsonx\_ai\_project\_id](#output\_watsonx\_ai\_project\_id) | The ID of the watsonx.ai project that is created. |
160160
| <a name="output_watsonx_ai_project_url"></a> [watsonx\_ai\_project\_url](#output\_watsonx\_ai\_project\_url) | The URL of the watsonx.ai project that is created. |
161-
| <a name="output_watsonx_ai_runtime_account_id"></a> [watsonx\_ai\_runtime\_account\_id](#output\_watsonx\_ai\_runtime\_account\_id) | The account id of the watsonx.ai Runtime instance. |
161+
| <a name="output_watsonx_ai_runtime_account_id"></a> [watsonx\_ai\_runtime\_account\_id](#output\_watsonx\_ai\_runtime\_account\_id) | The account ID of the watsonx.ai Runtime instance. |
162162
| <a name="output_watsonx_ai_runtime_crn"></a> [watsonx\_ai\_runtime\_crn](#output\_watsonx\_ai\_runtime\_crn) | The CRN of the watsonx.ai Runtime instance. |
163163
| <a name="output_watsonx_ai_runtime_dashboard_url"></a> [watsonx\_ai\_runtime\_dashboard\_url](#output\_watsonx\_ai\_runtime\_dashboard\_url) | The dashboard URL of the watsonx.ai Runtime instance. |
164164
| <a name="output_watsonx_ai_runtime_guid"></a> [watsonx\_ai\_runtime\_guid](#output\_watsonx\_ai\_runtime\_guid) | The GUID of the watsonx.ai Runtime instance. |

0 commit comments

Comments
 (0)