Skip to content
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.

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

Update descriptions #125

Merged
merged 9 commits into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ This repository contains the following infrastructure as code solutions:
- [Security and Compliance Center instances solution](./solutions/instances)
- [Security and Compliance Center Workload Protection agents solution](./solutions/agents)

**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)
: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)

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

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).
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).

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.
22 changes: 11 additions & 11 deletions ibm_catalog.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@
"provider_name": "IBM",
"features": [
{
"title": "Creates a Security and Compliance Center instance.",
"title": "Security and Compliance Center",
"description": "Creates and configures a Security and Compliance Center instance."
},
{
"title": "Creates the COS bucket required for the Security and Compliance Center instance",
"description": "Creates and configures a KMS encrypted COS bucket required for the Security and Compliance Center instance."
"title": "Object Storage bucket for Security and Compliance Center",
"description": "Creates and configures a KMS-encrypted Object Storage bucket required for the Security and Compliance Center instance."
},
{
"title": "Creates a Security and Compliance Center Workload Protection instance.",
"title": "Security and Compliance Center Workload Protection",
"description": "Creates and configures a Security and Compliance Center Workload Protection instance."
}
],
Expand Down Expand Up @@ -287,15 +287,15 @@
"descriptions": "This architecture supports creating and configuring a Security and Compliance Center Workload Protection instance.",
"features": [
{
"title": "Creates a Security and Compliance Center instance.",
"title": "Creates a Security and Compliance Center instance",
"description": "Creates and configures a Security and Compliance Center instance."
},
{
"title": "Creates the COS bucket required for the Security and Compliance Center instance",
"description": "Creates and configures a KMS encrypted COS bucket required for the Security and Compliance Center instance."
"title": "Creates an Object Storage bucket",
"description": "Creates and configures a KMS-encrypted Object Storage bucket required for the Security and Compliance Center instance."
},
{
"title": "Creates a Security and Compliance Center Workload Protection instance.",
"title": "Creates a Security and Compliance Center Workload Protection instance",
"description": "Creates and configures a Security and Compliance Center Workload Protection instance."
}
],
Expand Down Expand Up @@ -447,14 +447,14 @@
"descriptions": "This architecture supports creating and configuring Security and Compliance Center Workload Protection agents.",
"features": [
{
"title": "Creates a Security and Compliance Center Workload Protection agents.",
"description": "Creates and configures a Security and Compliance Center Workload Protection agents."
"title": "Security and Compliance Center Workload Protection agent",
"description": "Creates and configures a Security and Compliance Center Workload Protection agent."
}
],
"diagrams": [
{
"diagram": {
"caption": "Security and Compliance Center Workload Protection Agent",
"caption": "Security and Compliance Center Workload Protection agent",
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-scc-da/main/reference-architecture/scc-wp-agent.svg",
"type": "image/svg+xml"
},
Expand Down
26 changes: 13 additions & 13 deletions solutions/agents/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

variable "ibmcloud_api_key" {
type = string
description = "The API Key to use for IBM Cloud."
description = "The IBM Cloud API key to deploy resources."
sensitive = true
}

Expand All @@ -14,35 +14,35 @@ variable "ibmcloud_api_key" {

variable "name" {
type = string
description = "Helm release name."
description = "The Helm release name."
default = "ibm-scc-wp-agent"
}

variable "namespace" {
type = string
description = "Namespace of the Security and Compliance Workload Protection agent."
description = "The namespace of the Workload Protection agent."
default = "ibm-scc-wp"
}

variable "cluster_name" {
type = string
description = "Cluster name to add Security and Compliance Workload Protection agent to."
description = "The cluster name to add the Workload Protection agent to."
}

variable "access_key" {
type = string
description = "Security and Compliance Workload Protection instance access key."
description = "The Workload Protection instance access key."
sensitive = true
}

variable "region" {
type = string
description = "Region where Security and Compliance Workload Protection instance is created."
description = "The region where the Workload Protection instance is created."
}

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

variable "deployment_tag" {
type = string
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...)."
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`."
default = "terraform"
}

variable "kspm_deploy" {
type = bool
description = "Deploy Security and Compliance Workload Protection KSPM component."
description = "Whether to deploy the Workload Protection Kubernetes Security Posture Management component."
default = true
}

variable "node_analyzer_deploy" {
type = bool
description = "Deploy Security and Compliance Workload Protection node analyzer component."
description = "Whether to deploy the Workload Protection node analyzer component."
default = true
}

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

variable "cluster_scanner_deploy" {
type = bool
description = "Deploy Security and Compliance Workload Protection cluster scanner component."
description = "Whether to deploy the Workload Protection cluster scanner component."
default = true
}


variable "cluster_endpoint_type" {
type = string
description = "Specify the endpoint (public or private) for the cluster."
description = "The endpoint for the cluster. Possible values: `public`, `private.`"
default = "private"
validation {
error_message = "The specified cluster_endpoint_type can be private or public only."
Expand Down
Loading