Skip to content

Commit d774de8

Browse files
knee-naAk-skyimprateeksh
authored
fix: updated few variables description and catalog content - content review (#358)
* Update ibm_catalog.json Content review for Cloud automation for account configuration * Update variables.tf * Update variables.tf * Update outputs.tf * Update variables.tf * Update variables.tf * Update variables.tf Co-authored-by: Akash Kumar <Ak-sky@users.noreply.github.com> * Update variables.tf Co-authored-by: Akash Kumar <Ak-sky@users.noreply.github.com> * Update variables.tf * Update variables.tf * Update ibm_catalog.json * Update ibm_catalog.json * Update outputs.tf Co-authored-by: Akash Kumar <Ak-sky@users.noreply.github.com> * Update variables.tf * Update variables.tf * Update variables.tf * Cleaning up acronyms * Update ibm_catalog.json Co-authored-by: prateek <sharma_prateek@outlook.com> * Update variables.tf * Update ibm_catalog.json * fixed pre-commit and typos --------- Co-authored-by: Akash Kumar <Ak-sky@users.noreply.github.com> Co-authored-by: prateek <sharma_prateek@outlook.com> Co-authored-by: Akash Kumar <akash.kumar@ibm.com>
1 parent 4db7d4c commit d774de8

File tree

6 files changed

+164
-164
lines changed

6 files changed

+164
-164
lines changed

README.md

Lines changed: 72 additions & 72 deletions
Large diffs are not rendered by default.

ibm_catalog.json

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
"account",
2222
"iam"
2323
],
24-
"short_description": "Creates and configures the base layer components of an IBM Cloud account",
25-
"long_description": "This architecture supports creating and configuring the foundational components of an IBM Cloud account. This includes IAM account settings, a trusted profile and associated access groups, and the resource groups in which all resources are provisioned [Learn more](https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/tree/main/docs/about.md).\n\nYou can choose from two variations when deploying:\n **Resource groups only**: Creates a structured set of IBM Cloud resource groups to help organize cloud resources by function [Learn more](https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/tree/main/docs/resource-group-configuration.md).\n **Resource groups with Account Settings**: In addition to resource groups, configures account-level settings for access control, security, and compliance alignment [Learn more](https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/tree/main/docs/account-settings-configuration.md).",
24+
"short_description": "Creates and configures basic settings for an IBM Cloud account",
25+
"long_description": "This deployable architecture creates and configures the foundational settings for an IBM Cloud account. This includes IAM account settings, a trusted profile and associated access groups, and the resource groups in which all resources are provisioned. [Learn more](https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/tree/main/docs/about.md).\n\n You can choose from two variations when deploying: \n **Resource groups only**: Creates a structured set of IBM Cloud resource groups to help organize cloud resources by function. [Learn more](https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/tree/main/docs/resource-group-configuration.md).\n **Resource groups with Account Settings**: In addition to resource groups, this variation configures account-level settings for access control, security, and compliance alignment. [Learn more](https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/tree/main/docs/account-settings-configuration.md).",
2626
"offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/tree/main/docs/about.md",
2727
"offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/security_icon.svg",
2828
"provider_name": "IBM",
@@ -33,18 +33,18 @@
3333
},
3434
{
3535
"title": "Access controls",
36-
"description": "Creates a trusted profile and associated access group to give Projects access to securely deploy solutions in this account."
36+
"description": "Creates a trusted profile and associated access group to grant IBM Cloud projects access to securely deploy solutions in this account."
3737
},
3838
{
3939
"title": "Resource group",
40-
"description": "Creates resource group where all resources created by this solution are provisioned."
40+
"description": "Creates a resource group to contain all of the resources created by this deployable architecture."
4141
},
4242
{
43-
"title": "CBR rules",
44-
"description": "Creates pre-wired CBR rules in a given account following a secure by default approach."
43+
"title": "Context-based restriction rules",
44+
"description": "Using a secure-by-default approach, creates pre-wired context-based restriction rules in a specific account."
4545
}
4646
],
47-
"support_details": "This product is in the community registry, as such support is handled through the originated repo. If you experience issues please open an issue in that repository [https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/issues](https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/issues). Please note this product is not supported via the IBM Cloud Support Center.",
47+
"support_details": "This product is in the Community registry, support is handled through the [original repository](https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base). If you experience problems, [open an issue](https://github.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/issues). This product is not currently supported through the IBM Cloud Support Center.",
4848
"flavors": [
4949
{
5050
"label": "Resource groups with account settings",
@@ -68,31 +68,31 @@
6868
"crn:v1:bluemix:public:iam::::role:Administrator"
6969
],
7070
"service_name": "All Account Management services",
71-
"notes": "Administrator access is required for resource group creation and deletion."
71+
"notes": "Administrator access is required to create and delete resource groups."
7272
},
7373
{
7474
"role_crns": [
7575
"crn:v1:bluemix:public:iam::::role:Administrator"
7676
],
7777
"service_name": "All Identity and Access enabled services",
78-
"notes": "(Optional) Only required if creating context-based restrictions which can be toggled using the `provision_cbr` input."
78+
"notes": "[Optional] Required if context-based restrictions are created which can be turned on by using the `provision_cbr` input variable."
7979
}
8080
],
8181
"architecture": {
8282
"features": [
8383
{
8484
"title": " ",
85-
"description": "Orchestrates the creation of resource groups, account-level IAM settings, trusted profiles, and context-based restriction (CBR) rules."
85+
"description": "Creates resource groups, account-level IAM settings, trusted profiles, and context-based restriction rules."
8686
}
8787
],
8888
"diagrams": [
8989
{
9090
"diagram": {
91-
"caption": "Account Configuration",
91+
"caption": "Cloud automation for account configuration",
9292
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/main/reference-architectures/base-account-enterprise.svg",
9393
"type": "image/svg+xml"
9494
},
95-
"description": "**IBM Account Configuration** <br/> <br/> <b>Description</b> <br/>The Account Configuration architecture provides a standardized approach to setting up cloud account settings as outlined in the IBM Cloud Framework for Financial Services. The architecture includes configurations for IAM settings and access controls that enforce security best practices. You can use this architecture as a base for deploying additional services and resources in multiple types of accounts, such as administrative or workload accounts."
95+
"description": "Cloud automation for account configuration provides a standardized approach to setting up cloud account settings as outlined in the IBM Cloud Framework for Financial Services. The deployable architecture includes configurations for IAM settings and access controls that enforce security best practices. You can use this deployable architecture as a base for deploying additional services and resources in multiple types of accounts, such as administrative or workload accounts."
9696
}
9797
]
9898
},
@@ -344,24 +344,24 @@
344344
"crn:v1:bluemix:public:iam::::role:Administrator"
345345
],
346346
"service_name": "All Account Management services",
347-
"notes": "Administrator access is required for resource group creation and deletion."
347+
"notes": "Administrator access is required for creating and deleting resource groups."
348348
}
349349
],
350350
"architecture": {
351351
"features": [
352352
{
353353
"title": " ",
354-
"description": "Orchestrates the creation of resource groups as well as referencing existing resource groups across different functional categories."
354+
"description": "Creates resource groups or references existing resource groups across different functional categories."
355355
}
356356
],
357357
"diagrams": [
358358
{
359359
"diagram": {
360-
"caption": "Resource Groups",
360+
"caption": "Resource groups",
361361
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-account-infrastructure-base/main/reference-architectures/rg-only.svg",
362362
"type": "image/svg+xml"
363363
},
364-
"description": "**IBM Account Configuration** <br/> <br/> <b>Description</b> <br/>The Account Configuration architecture provides a standardized set of resource groups to prepare for different scenarios. You can use this architecture as a base for deploying additional services and resources in multiple types of accounts, such as administrative or workload accounts."
364+
"description": "Cloud automation for account configuration provides a standardized set of resource groups to prepare for different scenarios. You can use this deployable architecture as a base for deploying additional services and resources in multiple types of accounts, such as administrative or workload accounts."
365365
}
366366
]
367367
},

outputs.tf

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,180 +4,180 @@
44

55
output "single_resource_group_id" {
66
value = local.single_resource_group.id
7-
description = "ID of the single Resource Group created by the module."
7+
description = "ID of the resource group created by the module."
88
}
99

1010
output "single_resource_group_name" {
1111
value = local.single_resource_group.name
12-
description = "Name of the single Resource Group created by the module."
12+
description = "Name of the resource group created by the module."
1313
}
1414

1515
output "security_resource_group_id" {
1616
value = local.security_resource_group.id
17-
description = "ID of the Resource Group created for security-related resources."
17+
description = "ID of the resource group created for security-related resources."
1818
}
1919

2020
output "security_resource_group_name" {
2121
value = local.security_resource_group.name
22-
description = "Name of the Resource Group created for security-related resources."
22+
description = "Name of the resource group created for security-related resources."
2323
}
2424

2525
output "audit_resource_group_id" {
2626
value = local.audit_resource_group.id
27-
description = "ID of the Resource Group created for audit-related resources."
27+
description = "ID of the resource group created for audit-related resources."
2828
}
2929

3030
output "audit_resource_group_name" {
3131
value = local.audit_resource_group.name
32-
description = "Name of the Resource Group created for audit-related resources."
32+
description = "Name of the resource group created for audit-related resources."
3333
}
3434

3535
output "observability_resource_group_id" {
3636
value = local.observability_resource_group.id
37-
description = "ID of the Resource Group created observability-related resources."
37+
description = "ID of the resource group created for observability-related resources."
3838
}
3939

4040
output "observability_resource_group_name" {
4141
value = local.observability_resource_group.name
42-
description = "Name of the Resource Group created observability-related resources."
42+
description = "Name of the resource group created for observability-related resources."
4343
}
4444

4545
output "management_resource_group_id" {
4646
value = local.management_resource_group.id
47-
description = "ID of the Resource Group created management-related resources."
47+
description = "ID of the resource group created for management-related resources."
4848
}
4949

5050
output "management_resource_group_name" {
5151
value = local.management_resource_group.name
52-
description = "Name of the Resource Group created management-related resources."
52+
description = "Name of the resource group created for management-related resources."
5353
}
5454

5555
output "workload_resource_group_id" {
5656
value = local.workload_resource_group.id
57-
description = "ID of the Resource Group created workload-related resources."
57+
description = "ID of the resource group created for workload-related resources."
5858
}
5959

6060
output "workload_resource_group_name" {
6161
value = local.workload_resource_group.name
62-
description = "Name of the Resource Group created workload-related resources."
62+
description = "Name of the resource group created for workload-related resources."
6363
}
6464

6565
output "edge_resource_group_id" {
6666
value = local.edge_resource_group.id
67-
description = "ID of the Resource Group created edge network-related resources."
67+
description = "ID of the resource group created for edge network-related resources."
6868
}
6969

7070
output "edge_resource_group_name" {
7171
value = local.edge_resource_group.name
72-
description = "Name of the Resource Group created edge network-related resources."
72+
description = "Name of the resource group created for edge network-related resources."
7373
}
7474

7575
output "devops_resource_group_id" {
7676
value = local.devops_resource_group.id
77-
description = "ID of the Resource Group created devops-related resources."
77+
description = "ID of the resource group created for devops-related resources."
7878
}
7979

8080
output "devops_resource_group_name" {
8181
value = local.devops_resource_group.name
82-
description = "Name of the Resource Group created devops-related resources."
82+
description = "Name of the resource group created for devops-related resources."
8383
}
8484

8585
output "account_allowed_ip_addresses" {
8686
value = one(module.account_settings[*].account_allowed_ip_addresses)
87-
description = "Account Settings Allowed IP Addresses"
87+
description = "Account settings allowed IP addresses"
8888
}
8989

9090
output "account_allowed_ip_addresses_control_mode" {
9191
value = one(module.account_settings[*].account_allowed_ip_addresses_control_mode)
92-
description = "Account Settings Allowed IP Addresses Control Mode"
92+
description = "Account settings allowed IP addresses control mode"
9393
}
9494

9595
output "account_allowed_ip_addresses_enforced" {
9696
value = one(module.account_settings[*].account_allowed_ip_addresses_enforced)
97-
description = "Account Settings Allowed IP Addresses Enforced"
97+
description = "Account settings allowed IP addresses enforced"
9898
}
9999

100100
output "account_iam_access_token_expiration" {
101101
value = one(module.account_settings[*].account_iam_access_token_expiration)
102-
description = "Account Settings IAM Access Token Expiration"
102+
description = "Account eettings IAM access token expiration"
103103
}
104104

105105
output "account_iam_active_session_timeout" {
106106
value = one(module.account_settings[*].account_iam_active_session_timeout)
107-
description = "Account Settings IAM Active Session Timeout"
107+
description = "Account settings IAM active session timeout"
108108
}
109109

110110
output "account_iam_apikey_creation" {
111111
value = one(module.account_settings[*].account_iam_apikey_creation)
112-
description = "Account Settings IAM API Key Creation"
112+
description = "Account settings IAM API key creation"
113113
}
114114

115115
output "account_iam_inactive_session_timeout" {
116116
value = one(module.account_settings[*].account_iam_inactive_session_timeout)
117-
description = "Account Settings IAM Inactive Session Timeout"
117+
description = "Account settings IAM inactive session timeout"
118118
}
119119

120120
output "account_iam_mfa" {
121121
value = one(module.account_settings[*].account_iam_mfa)
122-
description = "Account Settings IAM MFA"
122+
description = "Account settings IAM MFA"
123123
}
124124

125125
output "account_iam_refresh_token_expiration" {
126126
value = one(module.account_settings[*].account_iam_refresh_token_expiration)
127-
description = "Account Settings IAM Refresh Token Expiration"
127+
description = "Account settings IAM refresh token expiration"
128128
}
129129

130130
output "account_iam_serviceid_creation" {
131131
value = one(module.account_settings[*].account_iam_serviceid_creation)
132-
description = "Account Settings IAM Service ID Creation"
132+
description = "Account settings IAM service ID creation"
133133
}
134134

135135
output "account_iam_user_mfa_list" {
136136
value = one(module.account_settings[*].account_iam_user_mfa_list)
137-
description = "Account Settings IAM User MFA List"
137+
description = "Account settings IAM user MFA list"
138138
}
139139

140140
output "account_public_access" {
141141
value = one(module.account_settings[*].account_public_access)
142-
description = "Account Settings Public Access"
142+
description = "Account settings public access"
143143
}
144144

145145
output "account_shell_settings_status" {
146146
value = one(module.account_settings[*].account_shell_settings_status)
147-
description = "Account Settings Shell Settings Status"
147+
description = "Account settings shell settings status"
148148
}
149149

150150
output "trusted_profile_projects" {
151151
value = one(module.trusted_profile_projects[*].trusted_profile)
152-
description = "Trusted Profile Projects Profile"
152+
description = "Trusted profile for IBM Cloud projects"
153153
}
154154

155155
output "trusted_profile_projects_claim_rules" {
156156
value = one(module.trusted_profile_projects[*].trusted_profile_claim_rules)
157-
description = "Trusted Profile Projects Profile Claim Rules"
157+
description = "Trusted profile IBM Cloud projects profile claim rules"
158158
}
159159

160160
output "trusted_profile_projects_links" {
161161
value = one(module.trusted_profile_projects[*].trusted_profile_links)
162-
description = "Trusted Profile Projects Profile Links"
162+
description = "Trusted profile IBM Cloud projects profile links"
163163
}
164164

165165
output "trusted_profile_projects_policies" {
166166
value = one(module.trusted_profile_projects[*].trusted_profile_policies)
167-
description = "Trusted Profile Projects Profile Policies"
167+
description = "Policies for the trusted profile for IBM Cloud projects"
168168
}
169169

170170
output "cbr_map_service_ref_name_zoneid" {
171171
value = one(module.cbr_fscloud[*].map_service_ref_name_zoneid)
172-
description = "Map of service reference and zone ids"
172+
description = "Map of service references and zone IDs"
173173
}
174174

175175
output "cbr_map_target_service_rule_ids" {
176176
value = one(module.cbr_fscloud[*].map_target_service_rule_ids)
177-
description = "Map of target service and rule ids"
177+
description = "Map of target services and rule IDs"
178178
}
179179

180180
output "cbr_map_vpc_zoneid" {
181181
value = one(module.cbr_fscloud[*].map_vpc_zoneid)
182-
description = "Map of VPC and zone id"
182+
description = "Map of VPC and zone ID"
183183
}

solutions/fully-configurable/account-base.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ If the single resource group name is not provided, the following resource groups
2121
- A resource group to be used for the provisioning of any devops resources in the account
2222
- Edge resource group
2323
- A resource group to be used for the provisioning of any edge network resources in the account
24-
- Managmenet resource group
24+
- Management resource group
2525
- A resource group to be used for the provisioning of any management resources in the account
2626
- Observability resource group
2727
- A resource group to be used for the provisioning of any observability resources in the account

solutions/fully-configurable/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ variable "api_creation" {
168168

169169
variable "enforce_allowed_ip_addresses" {
170170
type = bool
171-
description = "Whether the IP address restriction is enforced. If you want to test the impact of this setting, set to `false`. Traffic originating outside of the specified allowed IP addresss is monitored with audit events sent to Activity Tracker, after running in monitoring mode to test the impact of the restriction, you must set to `true` to enforce the IP allowlist."
171+
description = "Whether the IP address restriction is enforced. If you want to test the impact of this setting, set to `false`. Traffic originating outside of the specified allowed IP addresses is monitored with audit events sent to Activity Tracker, after running in monitoring mode to test the impact of the restriction, you must set to `true` to enforce the IP allowlist."
172172
default = true
173173
}
174174

0 commit comments

Comments
 (0)