Skip to content
This repository was archived by the owner on Mar 19, 2025. It is now read-only.

Commit eb90470

Browse files
SirSpideySirSpidey
authored
fix: cleanup of variable descriptions (#125)
1 parent 2dbbbc1 commit eb90470

File tree

5 files changed

+114
-112
lines changed

5 files changed

+114
-112
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ This repository contains the following infrastructure as code solutions:
1010
- [Security and Compliance Center instances solution](./solutions/instances)
1111
- [Security and Compliance Center Workload Protection agents solution](./solutions/agents)
1212

13-
**NB:** These solutions are not intended to be called by one or more other modules since they contain a provider configurations, meaning they are not compatible with the `for_each`, `count`, and `depends_on` arguments. For more information see [Providers Within Modules](https://developer.hashicorp.com/terraform/language/modules/develop/providers)
13+
:exclamation: **Important:** These solutions are not intended to be called by other modules because they contain a provider configuration and are not compatible with the `for_each`, `count`, and `depends_on` arguments. For more information see [Providers Within Modules](https://developer.hashicorp.com/terraform/language/modules/develop/providers)
1414

1515
<!-- Leave this section as is so that your module has a link to local development environment set up steps for contributors to follow -->
1616
## Contributing
1717

18-
You can report issues and request features for this module in GitHub issues in the module repo. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md).
18+
You can report issues and request features for this module in GitHub [issues in the module](/issues) repo. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md).
1919

2020
To set up your local development environment, see [Local development setup](https://terraform-ibm-modules.github.io/documentation/#/local-dev-setup) in the project documentation.

‎ibm_catalog.json‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@
2828
"provider_name": "IBM",
2929
"features": [
3030
{
31-
"title": "Creates a Security and Compliance Center instance.",
31+
"title": "Security and Compliance Center",
3232
"description": "Creates and configures a Security and Compliance Center instance."
3333
},
3434
{
35-
"title": "Creates the COS bucket required for the Security and Compliance Center instance",
36-
"description": "Creates and configures a KMS encrypted COS bucket required for the Security and Compliance Center instance."
35+
"title": "Object Storage bucket for Security and Compliance Center",
36+
"description": "Creates and configures a KMS-encrypted Object Storage bucket required for the Security and Compliance Center instance."
3737
},
3838
{
39-
"title": "Creates a Security and Compliance Center Workload Protection instance.",
39+
"title": "Security and Compliance Center Workload Protection",
4040
"description": "Creates and configures a Security and Compliance Center Workload Protection instance."
4141
}
4242
],
@@ -287,15 +287,15 @@
287287
"descriptions": "This architecture supports creating and configuring a Security and Compliance Center Workload Protection instance.",
288288
"features": [
289289
{
290-
"title": "Creates a Security and Compliance Center instance.",
290+
"title": "Creates a Security and Compliance Center instance",
291291
"description": "Creates and configures a Security and Compliance Center instance."
292292
},
293293
{
294-
"title": "Creates the COS bucket required for the Security and Compliance Center instance",
295-
"description": "Creates and configures a KMS encrypted COS bucket required for the Security and Compliance Center instance."
294+
"title": "Creates an Object Storage bucket",
295+
"description": "Creates and configures a KMS-encrypted Object Storage bucket required for the Security and Compliance Center instance."
296296
},
297297
{
298-
"title": "Creates a Security and Compliance Center Workload Protection instance.",
298+
"title": "Creates a Security and Compliance Center Workload Protection instance",
299299
"description": "Creates and configures a Security and Compliance Center Workload Protection instance."
300300
}
301301
],
@@ -447,14 +447,14 @@
447447
"descriptions": "This architecture supports creating and configuring Security and Compliance Center Workload Protection agents.",
448448
"features": [
449449
{
450-
"title": "Creates a Security and Compliance Center Workload Protection agents.",
451-
"description": "Creates and configures a Security and Compliance Center Workload Protection agents."
450+
"title": "Security and Compliance Center Workload Protection agent",
451+
"description": "Creates and configures a Security and Compliance Center Workload Protection agent."
452452
}
453453
],
454454
"diagrams": [
455455
{
456456
"diagram": {
457-
"caption": "Security and Compliance Center Workload Protection Agent",
457+
"caption": "Security and Compliance Center Workload Protection agent",
458458
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-scc-da/main/reference-architecture/scc-wp-agent.svg",
459459
"type": "image/svg+xml"
460460
},

‎solutions/agents/variables.tf‎

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

55
variable "ibmcloud_api_key" {
66
type = string
7-
description = "The API Key to use for IBM Cloud."
7+
description = "The IBM Cloud API key to deploy resources."
88
sensitive = true
99
}
1010

@@ -14,35 +14,35 @@ variable "ibmcloud_api_key" {
1414

1515
variable "name" {
1616
type = string
17-
description = "Helm release name."
17+
description = "The Helm release name."
1818
default = "ibm-scc-wp-agent"
1919
}
2020

2121
variable "namespace" {
2222
type = string
23-
description = "Namespace of the Security and Compliance Workload Protection agent."
23+
description = "The namespace of the Workload Protection agent."
2424
default = "ibm-scc-wp"
2525
}
2626

2727
variable "cluster_name" {
2828
type = string
29-
description = "Cluster name to add Security and Compliance Workload Protection agent to."
29+
description = "The cluster name to add the Workload Protection agent to."
3030
}
3131

3232
variable "access_key" {
3333
type = string
34-
description = "Security and Compliance Workload Protection instance access key."
34+
description = "The Workload Protection instance access key."
3535
sensitive = true
3636
}
3737

3838
variable "region" {
3939
type = string
40-
description = "Region where Security and Compliance Workload Protection instance is created."
40+
description = "The region where the Workload Protection instance is created."
4141
}
4242

4343
variable "endpoint_type" {
4444
type = string
45-
description = "Specify the endpoint (public or private) for the Security and Compliance Center Workload Protection service."
45+
description = "The endpoint for the Workload Protection service. Possible values: `public`, `private.`"
4646
default = "private"
4747
validation {
4848
error_message = "The specified endpoint_type can be private or public only."
@@ -52,38 +52,38 @@ variable "endpoint_type" {
5252

5353
variable "deployment_tag" {
5454
type = string
55-
description = "Sets a global tag that will be included in the components. It represents the mechanism from where the components have been installed (terraform, local...)."
55+
description = "A global tag that is included in the components. The tag represents the mechanism where the components are installed. For example, `terraform` or `local`."
5656
default = "terraform"
5757
}
5858

5959
variable "kspm_deploy" {
6060
type = bool
61-
description = "Deploy Security and Compliance Workload Protection KSPM component."
61+
description = "Whether to deploy the Workload Protection Kubernetes Security Posture Management component."
6262
default = true
6363
}
6464

6565
variable "node_analyzer_deploy" {
6666
type = bool
67-
description = "Deploy Security and Compliance Workload Protection node analyzer component."
67+
description = "Whether to deploy the Workload Protection node analyzer component."
6868
default = true
6969
}
7070

7171
variable "host_scanner_deploy" {
7272
type = bool
73-
description = "Deploy Security and Compliance Workload Protection host scanner component. If node_analyzer_deploy false, this component will not be deployed."
73+
description = "Whether to deploy the Workload Protection host scanner component. Applies only if `node_analyzer_deploy` is true."
7474
default = true
7575
}
7676

7777
variable "cluster_scanner_deploy" {
7878
type = bool
79-
description = "Deploy Security and Compliance Workload Protection cluster scanner component."
79+
description = "Whether to deploy the Workload Protection cluster scanner component."
8080
default = true
8181
}
8282

8383

8484
variable "cluster_endpoint_type" {
8585
type = string
86-
description = "Specify the endpoint (public or private) for the cluster."
86+
description = "The endpoint for the cluster. Possible values: `public`, `private.`"
8787
default = "private"
8888
validation {
8989
error_message = "The specified cluster_endpoint_type can be private or public only."

0 commit comments

Comments
 (0)