Update variables.tf (#59)

Author: acolleen

solutions/agents/variables.tf

@@ -1,12 +1,12 @@
 variable "ibmcloud_api_key" {
   type        = string
-  description = "The IBM Cloud api key."
+  description = "The IBM Cloud API key."
   sensitive   = true
 }
 
 variable "prefix" {
   type        = string
-  description = "(Optional) Prefix to append to all resources created by this solution."
+  description = "The prefix for resources created by this solution."
   default     = null
 }
 
@@ -16,7 +16,7 @@ variable "prefix" {
 
 variable "cluster_id" {
   type        = string
-  description = "The ID of the cluster you wish to deploy the agents in."
+  description = "The ID of the cluster to deploy the agents in."
 }
 
 variable "cluster_resource_group_id" {
@@ -25,12 +25,12 @@ variable "cluster_resource_group_id" {
 }
 
 variable "cluster_config_endpoint_type" {
-  description = "Specify which type of endpoint to use for for cluster config access: 'default', 'private', 'vpe', 'link'. 'default' value will use the default endpoint of the cluster."
+  description = "Specify the type of endpoint to use to access the cluster configuration. Possible values: `default`, `private`, `vpe`, `link`. The `default` value uses the default endpoint of the cluster."
   type        = string
   default     = "private"
   nullable    = false # use default if null is passed in
   validation {
-    error_message = "Invalid Endpoint Type! Valid values are 'default', 'private', 'vpe', or 'link'"
+    error_message = "The specified endpoint type is not valid. Specify one of the following types of endpoints: `default`, `private`, `vpe`, or `link`."
     condition     = contains(["default", "private", "vpe", "link"], var.cluster_config_endpoint_type)
   }
 }
@@ -41,82 +41,82 @@ variable "cluster_config_endpoint_type" {
 
 variable "log_analysis_enabled" {
   type        = bool
-  description = "Deploy IBM Cloud Logging agent if set as true."
+  description = "Whether to deploy the IBM Cloud logging agent."
   default     = true
 }
 
 
 variable "log_analysis_agent_tags" {
   type        = list(string)
-  description = "List of tags to associate to all log records that the agent collects so that you can identify the agent's data quicker in the logging UI. NOTE: Use the 'log_analysis_add_cluster_name' variable to add the cluster name as a tag."
+  description = "The list of tags to associate with all log records collected by the agent so that you can quickly identify the agent’s data in the logging UI. To add the cluster name as a tag, use the `log_analysis_add_cluster_name` variable."
   default     = []
   nullable    = false
 }
 
 variable "log_analysis_add_cluster_name" {
   type        = bool
-  description = "If true, configure the log analysis agent to attach a tag containing the cluster name to all log messages."
+  description = "Whether to attach the cluster name to log messages. Set to `true` to configure the IBM Log Analysis agent to tag all log messages with the name."
   default     = true
 }
 
 variable "log_analysis_ingestion_key" {
   type        = string
-  description = "Ingestion key for the IBM Cloud Logging agent to communicate with the instance."
+  description = "The ingestion key that is used by the IBM Cloud logging agent to communicate with the instance."
   sensitive   = true
   default     = null
 }
 
 variable "log_analysis_secret_name" {
   type        = string
-  description = "The name of the secret which will store the ingestion key. If prefix input variable is passed then it will get prefixed infront of the value in the format of '<prefix>-value'"
+  description = "The name of the secret that stores the ingestion key. If a prefix input variable is specified, the secret name is prefixed to the value in the `<prefix>-<name>` format."
   default     = "logdna-agent"
   nullable    = false
 }
 
 variable "log_analysis_instance_region" {
   type        = string
-  description = "The region name where the IBM Log Analysis instance is created. Used to construct the ingestion endpoint."
+  description = "The name of the region where the IBM Log Analysis instance is created. The value is used in the ingestion endpoint in the format `api.<var-value>.logging.cloud.ibm.com`."
   default     = null
 }
 
 variable "log_analysis_endpoint_type" {
   type        = string
-  description = "Specify the IBM Log Analysis instance endpoint type (public or private) to use. Used to construct the ingestion endpoint."
+  description = "Specify the IBM Log Analysis instance endpoint type to use to construct the ingestion endpoint. Possible values: `public` or `private`."
   default     = "private"
   validation {
-    error_message = "The specified endpoint_type can be private or public only."
+    error_message = "The specified `endpoint_type` can be `private` or `public` only."
     condition     = contains(["private", "public"], var.log_analysis_endpoint_type)
   }
 }
 
 variable "log_analysis_agent_custom_line_inclusion" {
-  description = "Log Analysis agent custom configuration for line inclusion setting LOGDNA_K8S_METADATA_LINE_INCLUSION. See https://github.com/logdna/logdna-agent-v2/blob/master/docs/KUBERNETES.md#configuration-for-kubernetes-metadata-filtering for more info."
+  description = "The custom configuration of the IBM Log Analysis agent for the `LOGDNA_K8S_METADATA_LINE_INCLUSION` line inclusion setting. [Learn more](https://github.com/logdna/logdna-agent-v2/blob/master/docs/KUBERNETES.md#configuration-for-kubernetes-metadata-filtering)"
   type        = string
   default     = null # "namespace:default"
 }
 
 variable "log_analysis_agent_custom_line_exclusion" {
-  description = "Log Analysis agent custom configuration for line exclusion setting LOGDNA_K8S_METADATA_LINE_EXCLUSION. See https://github.com/logdna/logdna-agent-v2/blob/master/docs/KUBERNETES.md#configuration-for-kubernetes-metadata-filtering for more info."
+  description = "The custom configuration of the IBM Log Analysis agent for the `LOGDNA_K8S_METADATA_LINE_INCLUSION` line exclusion setting. [Learn more](https://github.com/logdna/logdna-agent-v2/blob/master/docs/KUBERNETES.md#configuration-for-kubernetes-metadata-filtering)"
   type        = string
   default     = null # "label.app.kubernetes.io/name:sample-app\\, annotation.user:sample-user"
 }
 
 variable "log_analysis_agent_name" {
-  description = "Log Analysis agent name. Used for naming all kubernetes and helm resources on the cluster. If prefix input variable is passed then it will get prefixed infront of the value in the format of '<prefix>-value'"
+  description = "The name of the IBM Log Analysis agent that is used to name the Kubernetes and Helm resources on the cluster. If a prefix input variable is passed, the name of the IBM Log Analysis agent is prefixed to the value in the `<prefix>-<name>` format."
   type        = string
   default     = "logdna-agent"
   nullable    = false
 }
 
 variable "log_analysis_agent_namespace" {
   type        = string
-  description = "Namespace where to deploy the Log Analysis agent. Default value is 'ibm-observe'."
+  description = "The namespace to deploy the IBM Log Analysis agent in. The default value of the namespace is `ibm-observe`."
   default     = "ibm-observe"
   nullable    = false
 }
 
 variable "log_analysis_agent_tolerations" {
-  description = "List of tolerations to apply to Log Analysis agent. Defaults to the 'Exists' operator, that means it will match any taint on any node. See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ for more info."
+  description = "The list of tolerations to apply to the IBM Log Analysis agent. Because the default value is the `Exists` operator, this variable will match any taint on any node. [Learn more](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)"
   type = list(object({
     key               = optional(string)
     operator          = optional(string)
@@ -135,36 +135,36 @@ variable "log_analysis_agent_tolerations" {
 
 variable "cloud_monitoring_enabled" {
   type        = bool
-  description = "Deploy IBM Cloud Monitoring agent if set as true."
+  description = "Whether to deploy the IBM Cloud Monitoring agent."
   default     = true
 }
 
 variable "cloud_monitoring_access_key" {
   type        = string
-  description = "Access key used by the IBM Cloud Monitoring agent to communicate with the instance."
+  description = "The access key that is used by the IBM Cloud Monitoring agent to communicate with the instance."
   sensitive   = true
   default     = null
 }
 
 variable "cloud_monitoring_secret_name" {
   type        = string
-  description = "The name of the secret which will store the access key. If prefix input variable is passed then it will get prefixed infront of the value in the format of '<prefix>-value'"
+  description = "The name of the secret that will store the access key. If a prefix input variable is passed, the secret name is prefixed to the value in the `<prefix>-<name>` format."
   default     = "sysdig-agent"
   nullable    = false
 }
 
 variable "cloud_monitoring_instance_region" {
   type        = string
-  description = "The region name where the IBM Cloud Monitoring instance is created. Used to construct the ingestion endpoint."
+  description = "The name of the region where the IBM Cloud Monitoring instance is created. This name is used to construct the ingestion endpoint."
   default     = null
 }
 
 variable "cloud_monitoring_endpoint_type" {
   type        = string
-  description = "Specify the IBM Cloud Monitoring instance endpoint type (public or private) to use. Used to construct the ingestion endpoint."
+  description = "Specify the IBM Cloud Monitoring instance endpoint type (`public` or `private`) to use to construct the ingestion endpoint."
   default     = "private"
   validation {
-    error_message = "The specified endpoint_type can be private or public only."
+    error_message = "The specified `endpoint_type` can be `private` or `public` only."
     condition     = contains(["private", "public"], var.cloud_monitoring_endpoint_type)
   }
 }
@@ -174,42 +174,42 @@ variable "cloud_monitoring_metrics_filter" {
     type = string
     name = string
   }))
-  description = "To filter custom metrics, specify the Cloud Monitoring metrics to include or to exclude. See https://cloud.ibm.com/docs/monitoring?topic=monitoring-change_kube_agent#change_kube_agent_inc_exc_metrics."
+  description = "To filter on custom metrics, specify the IBM Cloud Monitoring metrics to include or exclude. [Learn more](https://cloud.ibm.com/docs/monitoring?topic=monitoring-change_kube_agent#change_kube_agent_inc_exc_metrics)"
   default     = [] # [{ type = "exclude", name = "metricA.*" }, { type = "include", name = "metricB.*" }]
   validation {
     condition     = length(var.cloud_monitoring_metrics_filter) == 0 || can(regex("^(include|exclude)$", var.cloud_monitoring_metrics_filter[0].type))
-    error_message = "Invalid input for `cloud_monitoring_metrics_filter`. Valid options for 'type' are: `include` and `exclude`. If empty, no metrics are included or excluded."
+    error_message = "The specified `type` for the `cloud_monitoring_metrics_filter` is not valid. Specify either `include` or `exclude`. If the value for `type` is not specified, no metrics are included or excluded."
   }
 }
 
 variable "cloud_monitoring_agent_tags" {
   type        = list(string)
-  description = "List of tags to associate to all matrics that the agent collects. NOTE: Use the 'cloud_monitoring_add_cluster_name' variable to add the cluster name as a tag."
+  description = "A list of the tags to associate with the metrics that the IBM Cloud Monitoring agent collects. To add the cluster name as a tag, use the `cloud_monitoring_add_cluster_name` variable."
   default     = []
   nullable    = false
 }
 
 variable "cloud_monitoring_add_cluster_name" {
   type        = bool
-  description = "If true, configure the cloud monitoring agent to attach a tag containing the cluster name to all metric data."
+  description = "Whether to attach a tag to log messages. Set to `true` to configure the IBM Cloud Monitoring agent to attach a tag that contains the cluster name to all log messages."
   default     = true
 }
 
 variable "cloud_monitoring_agent_name" {
-  description = "Cloud Monitoring agent name. Used for naming all kubernetes and helm resources on the cluster. If prefix input variable is passed then it will get prefixed infront of the value in the format of '<prefix>-value'"
+  description = "The name of the IBM Cloud Monitoring agent that is used to name the Kubernetes and Helm resources on the cluster. If a prefix input variable is passed, the name of the IBM Cloud Monitoring agent is prefixed to the value in the `<prefix>-<name>` format."
   type        = string
   default     = "sysdig-agent"
 }
 
 variable "cloud_monitoring_agent_namespace" {
   type        = string
-  description = "Namespace where to deploy the Cloud Monitoring agent. Default value is 'ibm-observe'."
+  description = "The namespace to deploy the IBM Cloud Monitoring agent in. Default value: `ibm-observe`."
   default     = "ibm-observe"
   nullable    = false
 }
 
 variable "cloud_monitoring_agent_tolerations" {
-  description = "List of tolerations to apply to Cloud Monitoring agent. Default value means that it will match any taint on any node except the master node. See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ for more info."
+  description = "The list of tolerations to apply to the IBM Cloud Monitoring agent. The default operator value `Exists` matches any taint on any node except the master node. [Learn more](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)"
   type = list(object({
     key               = optional(string)
     operator          = optional(string)