From 78e352157e84a29ab76cf1214acc7b8819cd077b Mon Sep 17 00:00:00 2001 From: Kolbeinn Karlsson Date: Mon, 30 Oct 2023 10:01:09 +0000 Subject: [PATCH 1/2] docs: mention OCI authentication in documentation Signed-off-by: Kolbeinn Karlsson --- README.md | 5 +++-- examples/custom-iam-user/README.md | 8 +++++--- examples/default-iam-user/README.md | 10 +++++++--- examples/skip-creation-iam-user/README.md | 7 ++++++- main.tf | 2 -- variables.tf | 2 +- 6 files changed, 22 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 59f97c5..d64c945 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ A Terraform Module to create a user and group to be used to integrate and OCI cloud account with Lacework. + ## Requirements @@ -46,7 +47,7 @@ No modules. | [email](#input\_email) | Email associated with the created user | `string` | n/a | yes | | [freeform\_tags](#input\_freeform\_tags) | freeform tags for the resources created for Lacework integration | `map(any)` | `{}` | no | | [group\_name](#input\_group\_name) | Name of the identity group for the Lacework user (overrides name\_prefix) | `string` | `""` | no | -| [name\_prefix](#input\_name\_prefix) | Names for the created resources will be ${name\_prefix}\_{user,group} | `string` | `"lacework_security_integration"` | no | +| [name\_prefix](#input\_name\_prefix) | Names for the created resources will be ${name\_prefix}\_{user,group} | `string` | `"lw_"` | no | | [tenancy\_id](#input\_tenancy\_id) | OCID of the OCI tenancy to be integrated with Lacework | `string` | n/a | yes | | [user\_name](#input\_user\_name) | Name of the IAM user used for Lacework integration (overrides name\_prefix) | `string` | `""` | no | @@ -61,4 +62,4 @@ No modules. | [user\_ocid](#output\_user\_ocid) | OCID of the user created for the Lacework integration | | [user\_private\_key\_pem](#output\_user\_private\_key\_pem) | The private key of the API key of the user created for integration | | [user\_public\_key\_fingerprint](#output\_user\_public\_key\_fingerprint) | The public key fingerprint of the API key created for integration | - \ No newline at end of file + diff --git a/examples/custom-iam-user/README.md b/examples/custom-iam-user/README.md index 47b0bc9..3cb86c3 100644 --- a/examples/custom-iam-user/README.md +++ b/examples/custom-iam-user/README.md @@ -1,14 +1,16 @@ # Skip creation of resources This example shows how to use the Terraform module with custom names for -resources. +resources. The following example will use the OCI credentials in your +~/.oci/config file. See the OCI Terraform Provider documentation [on +authentication](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/terraformproviderconfiguration.htm) for alternative approaches of providing +credentials to the OCI provider. ```hcl module "lacework_iam_user" { - source = "../.." + source = "lacework/iam-user/oci" tenancy_id = var.tenancy_ocid email = "example@example.com" - name_prefix = "lacework_test" } variable "tenancy_ocid" { diff --git a/examples/default-iam-user/README.md b/examples/default-iam-user/README.md index 0970fa9..20b764a 100644 --- a/examples/default-iam-user/README.md +++ b/examples/default-iam-user/README.md @@ -1,16 +1,20 @@ # Default Example -This example creates an IAM user, group, and policy needed for Lacework integration/ +This example creates an OCI user, group, and policy needed for Lacework +integration. The following example will use the OCI credentials in your +~/.oci/config file. See the OCI Terraform Provider documentation [on +authentication](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/terraformproviderconfiguration.htm) for alternative approaches of providing +credentials to the OCI provider. ```hcl module "lacework_iam_user" { - source = "../.." + source = "lacework/iam-user/oci" tenancy_id = var.tenancy_id + email = "email@example.com" } variable "tenancy_id" { type = string description = "OCID of the tenancy to be integrated with Lacework" } - ``` diff --git a/examples/skip-creation-iam-user/README.md b/examples/skip-creation-iam-user/README.md index eac435e..49c07b8 100644 --- a/examples/skip-creation-iam-user/README.md +++ b/examples/skip-creation-iam-user/README.md @@ -1,12 +1,17 @@ # Skip creation of resources This example shows how to run the Terraform module without creating resources. +The following example will use the OCI credentials in your +~/.oci/config file. See the OCI Terraform Provider documentation [on +authentication](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/terraformproviderconfiguration.htm) for alternative approaches of providing +credentials to the OCI provider. ```hcl module "lacework_iam_user" { - source = "../.." + source = "lacework/iam-user/oci" tenancy_id = var.tenancy_id create = false + email = "email@example.com" } variable "tenancy_id" { diff --git a/main.tf b/main.tf index 9040468..d4fe357 100644 --- a/main.tf +++ b/main.tf @@ -48,5 +48,3 @@ resource "oci_identity_api_key" "lacework_api_key" { user_id = oci_identity_user.lacework_user[count.index].id key_value = tls_private_key.rsa_key[count.index].public_key_pem } - -# Use public_key_fingerprint_md5, private_key_pem, public_key_pem \ No newline at end of file diff --git a/variables.tf b/variables.tf index 097802c..3991426 100644 --- a/variables.tf +++ b/variables.tf @@ -26,7 +26,7 @@ variable "freeform_tags" { variable "name_prefix" { type = string - default = "lacework_security_integration" + default = "lw_" description = "Names for the created resources will be $${name_prefix}_{user,group}" } From 57568dc9bdcc3efe5484b56b4f2e11352933b5e7 Mon Sep 17 00:00:00 2001 From: Kolbeinn Karlsson Date: Wed, 1 Nov 2023 15:57:25 +0000 Subject: [PATCH 2/2] docs: clearer custom-iam-user example Signed-off-by: Kolbeinn Karlsson --- examples/custom-iam-user/main.tf | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/examples/custom-iam-user/main.tf b/examples/custom-iam-user/main.tf index 892333e..b68fdb2 100644 --- a/examples/custom-iam-user/main.tf +++ b/examples/custom-iam-user/main.tf @@ -2,7 +2,8 @@ module "lacework_iam_user" { source = "../.." tenancy_id = var.tenancy_ocid email = "example@example.com" - name_prefix = "lacework_test" + user_name = "custom_user_name" + group_name = "custom_group_name" } variable "tenancy_ocid" {