style: prepare release and updating version (#4)

Signed-off-by: Salim Afiune Maya <[email protected]>

README.md

@@ -69,14 +69,14 @@ artifactregistry.googleapis.com
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_lacework_integration_name"></a> [lacework\_integration\_name](#input\_lacework\_integration\_name) | The integration name displayed in the Lacework UI. | `string` | `"TF GAR"` | no |
-| <a name="input_limit_by_label"></a> [limit\_by\_label](#input\_limit\_by\_label) | An image label to limit the assessment of images with matching label. If you specify limit\_by\_tag and limit\_by\_label limits, they function as an AND.  Input is "key" = "value". Defaults to empty. | `list(any)` | <pre>[<br>  {<br>    "": ""<br>  }<br>]</pre> | no |
-| <a name="input_limit_by_repositories"></a> [limit\_by\_repositories](#input\_limit\_by\_repositories) | A comma-separated list of repositories to assess. This should be defined as a string. (without spaces recommended).  Defaults to empty. | `list(any)` | `[]` | no |
-| <a name="input_limit_by_tags"></a> [limit\_by\_tags](#input\_limit\_by\_tags) | An image tag to limit the assessment of images with matching tag. If you specify limit\_by\_tag and limit\_by\_label limits, they function as an AND. Supported field input are mytext*mytext, mytext, mytext*, or mytext. Only one * wildcard is supported. Defaults to empty. | `list(any)` | `[]` | no |
-| <a name="input_limit_num_imgs"></a> [limit\_num\_imgs](#input\_limit\_num\_imgs) | The maximum number of newest container images to assess per repository. Must be one of 5, 10, or 15. Defaults to 5. | `string` | `"5"` | no |
-| <a name="input_non_os_package_support"></a> [non\_os\_package\_support](#input\_non\_os\_package\_support) | Whether or not the integration should check non-os packages in the container for vulnerabilities.  Defaults to true | `bool` | `true` | no |
+| <a name="input_limit_by_label"></a> [limit\_by\_label](#input\_limit\_by\_label) | An image label to limit the assessment of images with matching label. If you specify limit\_by\_tag and limit\_by\_label limits, they function as an AND.  Input is "key" = "value" | `list(any)` | <pre>[<br>  {<br>    "": ""<br>  }<br>]</pre> | no |
+| <a name="input_limit_by_repositories"></a> [limit\_by\_repositories](#input\_limit\_by\_repositories) | A comma-separated list of repositories to assess. This should be defined as a string. (without spaces recommended) | `list(any)` | `[]` | no |
+| <a name="input_limit_by_tags"></a> [limit\_by\_tags](#input\_limit\_by\_tags) | An image tag to limit the assessment of images with matching tag. If you specify limit\_by\_tag and limit\_by\_label limits, they function as an AND. Supported field input are mytext*mytext, mytext, mytext*, or mytext. Only one * wildcard is supported | `list(any)` | `[]` | no |
+| <a name="input_limit_num_imgs"></a> [limit\_num\_imgs](#input\_limit\_num\_imgs) | The maximum number of newest container images to assess per repository. Must be one of 5, 10, or 15. | `string` | `"5"` | no |
+| <a name="input_non_os_package_support"></a> [non\_os\_package\_support](#input\_non\_os\_package\_support) | Whether or not the integration should check non-os packages in the container for vulnerabilities | `bool` | `true` | no |
 | <a name="input_prefix"></a> [prefix](#input\_prefix) | The prefix that will be use at the beginning of every generated resource | `string` | `"lw-gar"` | no |
 | <a name="input_project_id"></a> [project\_id](#input\_project\_id) | A project ID different from the default defined inside the provider | `string` | `""` | no |
-| <a name="input_registry_domain"></a> [registry\_domain](#input\_registry\_domain) | The GAR domain, which specifies the location where you store the images. Supported domains should follow the format of (region\|zone)-docker.pkg.dev. Defaults to us-docker.pkg.dev. | `string` | `"us-docker.pkg.dev"` | no |
+| <a name="input_registry_domain"></a> [registry\_domain](#input\_registry\_domain) | The GAR domain, which specifies the location where you store the images. Supported domains should follow the format of (region\|zone)-docker.pkg.dev | `string` | `"us-docker.pkg.dev"` | no |
 | <a name="input_required_gar_apis"></a> [required\_gar\_apis](#input\_required\_gar\_apis) | n/a | `map(any)` | <pre>{<br>  "artifactregistry": "artifactregistry.googleapis.com",<br>  "resourcemanager": "cloudresourcemanager.googleapis.com"<br>}</pre> | no |
 | <a name="input_service_account_name"></a> [service\_account\_name](#input\_service\_account\_name) | The Service Account name (required when use\_existing\_service\_account is set to true). This can also be used to specify the new service account name when use\_existing\_service\_account is set to false | `string` | `""` | no |
 | <a name="input_service_account_private_key"></a> [service\_account\_private\_key](#input\_service\_account\_private\_key) | The private key in JSON format, base64 encoded (required when use\_existing\_service\_account is set to true) | `string` | `""` | no |
@@ -88,3 +88,4 @@ artifactregistry.googleapis.com
 | Name | Description |
 |------|-------------|
 | <a name="output_service_account_name"></a> [service\_account\_name](#output\_service\_account\_name) | The Service Account name created for the integration |
+| <a name="output_service_account_private_key"></a> [service\_account\_private\_key](#output\_service\_account\_private\_key) | The private key in JSON format, base64 encoded |

VERSION

@@ -1 +1 @@
-1.0.0-dev
+0.0.1-dev

examples/configure-lacework-gar-integration/README.md

@@ -28,7 +28,7 @@ module "lacework_gar" {
   registry_domain           = "us-docker.pkg.dev"
   limit_by_tags             = ["example*"]
   limit_by_label            = ["example*"]
-  limit_by_repositories     = ["foo","bar"]
+  limit_by_repositories     = ["foo", "bar"]
   limit_num_imgs            = "10"
   non_os_packages           = true
 }

examples/configure-lacework-gar-integration/main.tf

@@ -11,7 +11,7 @@ module "lacework_gar" {
   registry_domain           = "us-docker.pkg.dev"
   limit_by_tags             = ["example*"]
   limit_by_label            = ["example*"]
-  limit_by_repositories     = ["foo","bar"]
+  limit_by_repositories     = ["foo", "bar"]
   limit_num_imgs            = "10"
   non_os_package_support    = true
 }

output.tf

@@ -2,3 +2,9 @@ output "service_account_name" {
   value       = local.service_account_name
   description = "The Service Account name created for the integration"
 }
+
+output "service_account_private_key" {
+  value       = length(var.service_account_private_key) > 0 ? var.service_account_private_key : module.lacework_gar_svc_account.private_key
+  description = "The private key in JSON format, base64 encoded"
+  sensitive   = true
+}

variables.tf

@@ -51,37 +51,37 @@ variable "wait_time" {
 variable "registry_domain" {
   type        = string
   default     = "us-docker.pkg.dev"
-  description = "The GAR domain, which specifies the location where you store the images. Supported domains should follow the format of (region|zone)-docker.pkg.dev. Defaults to us-docker.pkg.dev."
+  description = "The GAR domain, which specifies the location where you store the images. Supported domains should follow the format of (region|zone)-docker.pkg.dev"
 }
 
 variable "limit_by_tags" {
   type        = list(any)
   default     = []
-  description = "An image tag to limit the assessment of images with matching tag. If you specify limit_by_tag and limit_by_label limits, they function as an AND. Supported field input are mytext*mytext, mytext, mytext*, or mytext. Only one * wildcard is supported. Defaults to empty."
+  description = "An image tag to limit the assessment of images with matching tag. If you specify limit_by_tag and limit_by_label limits, they function as an AND. Supported field input are mytext*mytext, mytext, mytext*, or mytext. Only one * wildcard is supported"
 }
 
 variable "limit_by_label" {
   type = list(any)
   default = [{
     "" = ""
   }]
-  description = "An image label to limit the assessment of images with matching label. If you specify limit_by_tag and limit_by_label limits, they function as an AND.  Input is \"key\" = \"value\". Defaults to empty."
+  description = "An image label to limit the assessment of images with matching label. If you specify limit_by_tag and limit_by_label limits, they function as an AND.  Input is \"key\" = \"value\""
 }
 
 variable "limit_by_repositories" {
   type        = list(any)
   default     = []
-  description = "A comma-separated list of repositories to assess.  Defaults to empty (will assess all repositories in the registry)."
+  description = "A comma-separated list of repositories to assess. Defaults to empty (will assess all repositories in the registry)."
 }
 
 variable "limit_num_imgs" {
   type        = string
   default     = "5"
-  description = "The maximum number of newest container images to assess per repository. Must be one of 5, 10, or 15. Defaults to 5."
+  description = "The maximum number of newest container images to assess per repository. Must be one of 5, 10, or 15"
 }
 
 variable "non_os_package_support" {
   type        = bool
-  default     = true
-  description = "Whether or not the integration should check non-os packages in the container for vulnerabilities.  Defaults to true"
+  default     = false
+  description = "Whether or not the integration should check non-os packages in the container for vulnerabilities"
 }