You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 19, 2025. It is now read-only.
feat: removed kms_region variable - its now programmtically determined<br>- existing_kms_guid has been renamed existing_kms_instance_crn<br>- existing_resource_group has been renamed use_existing_resource_group (#52)
Copy file name to clipboardExpand all lines: solutions/instances/README.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,14 +46,12 @@ No resources.
46
46
| <aname="input_existing_activity_tracker_crn"></a> [existing\_activity\_tracker\_crn](#input\_existing\_activity\_tracker\_crn)| (Optional) The CRN of an existing Activity Tracker instance. Used to send SCC COS bucket log data and all object write events to Activity Tracker. Only used if not supplying an existing COS bucket. |`string`|`null`| no |
47
47
| <aname="input_existing_cos_instance_crn"></a> [existing\_cos\_instance\_crn](#input\_existing\_cos\_instance\_crn)| The CRN of an existing Cloud Object Storage instance. If not supplied, a new instance will be created. |`string`|`null`| no |
48
48
| <aname="input_existing_en_crn"></a> [existing\_en\_crn](#input\_existing\_en\_crn)| (Optional) The CRN of an existing Event Notification instance. Used to integrate with SCC. |`string`|`null`| no |
49
-
| <aname="input_existing_kms_guid"></a> [existing\_kms\_guid](#input\_existing\_kms\_guid)| The GUID of of the KMS instance used for the SCC COS bucket root Key. Only required if not supplying an existing KMS root key and if 'skip\_cos\_kms\_auth\_policy' is true. |`string`|`null`| no |
49
+
| <aname="input_existing_kms_instance_crn"></a> [existing\_kms\_instance\_crn](#input\_existing\_kms\_instance\_crn)| The CRN of the existed Hyper Protect Crypto Services or Key Protect instance. Only required if not supplying an existing KMS root key and if 'skip\_cos\_kms\_auth\_policy' is true. |`string`|`null`| no |
50
50
| <aname="input_existing_monitoring_crn"></a> [existing\_monitoring\_crn](#input\_existing\_monitoring\_crn)| (Optional) The CRN of an existing IBM Cloud Monitoring instance. Used to send all COS bucket request and usage metrics to, as well as SCC workload protection data. Ignored if using existing COS bucket and not provisioning SCC workload protection. |`string`|`null`| no |
51
-
| <aname="input_existing_resource_group"></a> [existing\_resource\_group](#input\_existing\_resource\_group)| Whether to use an existing resource group. |`bool`|`false`| no |
52
51
| <aname="input_existing_scc_cos_bucket_name"></a> [existing\_scc\_cos\_bucket\_name](#input\_existing\_scc\_cos\_bucket\_name)| The name of an existing bucket inside the existing Cloud Object Storage instance to use for SCC. If not supplied, a new bucket will be created. |`string`|`null`| no |
53
-
| <aname="input_existing_scc_cos_kms_key_crn"></a> [existing\_scc\_cos\_kms\_key\_crn](#input\_existing\_scc\_cos\_kms\_key\_crn)| The CRN of an existing KMS key to be used to encrypt the SCC COS bucket. If not supplied, a new key ring and key will be created in the provided KMS instance. |`string`|`null`| no |
52
+
| <aname="input_existing_scc_cos_kms_key_crn"></a> [existing\_scc\_cos\_kms\_key\_crn](#input\_existing\_scc\_cos\_kms\_key\_crn)| The CRN of an existing KMS key to be used to encrypt the SCC COS bucket. If no value is passed, a value must be passed for either 'var.existing\_kms\_instance\_crn' if you want to create a new key ring and key, or 'var.existing\_scc\_cos\_bucket\_name' if you want to use an existing bucket. |`string`|`null`| no |
54
53
| <aname="input_ibmcloud_api_key"></a> [ibmcloud\_api\_key](#input\_ibmcloud\_api\_key)| The API Key to use for IBM Cloud. |`string`| n/a | yes |
55
54
| <aname="input_kms_endpoint_type"></a> [kms\_endpoint\_type](#input\_kms\_endpoint\_type)| The type of endpoint to be used for commincating with the KMS instance. Allowed values are: 'public' or 'private' (default) |`string`|`"private"`| no |
56
-
| <aname="input_kms_region"></a> [kms\_region](#input\_kms\_region)| The region in which KMS instance exists. |`string`|`"us-south"`| no |
57
55
| <aname="input_management_endpoint_type_for_bucket"></a> [management\_endpoint\_type\_for\_bucket](#input\_management\_endpoint\_type\_for\_bucket)| The type of endpoint for the IBM terraform provider to use to manage COS buckets. (`public`, `private` or `direct`). Ensure to enable virtual routing and forwarding (VRF) in your account if using `private`, and that the terraform runtime has access to the the IBM Cloud private network. |`string`|`"private"`| no |
58
56
| <aname="input_provision_scc_workload_protection"></a> [provision\_scc\_workload\_protection](#input\_provision\_scc\_workload\_protection)| Whether to provision an SCC Workload Protection instance. |`bool`|`true`| no |
59
57
| <aname="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name)| The name of a new or an existing resource group in which to provision resources to. |`string`| n/a | yes |
@@ -74,6 +72,7 @@ No resources.
74
72
| <aname="input_scc_wp_service_plan"></a> [scc\_wp\_service\_plan](#input\_scc\_wp\_service\_plan)| SCC Workload Protection instance service pricing plan. Allowed values are: `free-trial` or `graduated-tier`. |`string`|`"graduated-tier"`| no |
75
73
| <aname="input_skip_cos_kms_auth_policy"></a> [skip\_cos\_kms\_auth\_policy](#input\_skip\_cos\_kms\_auth\_policy)| Set to true to skip the creation of an IAM authorization policy that permits the COS instance created to read the encryption key from the KMS instance. WARNING: An authorization policy must exist before an encrypted bucket can be created |`bool`|`false`| no |
76
74
| <aname="input_skip_scc_cos_auth_policy"></a> [skip\_scc\_cos\_auth\_policy](#input\_skip\_scc\_cos\_auth\_policy)| Set to true to skip the creation of an IAM authorization policy that permits the SCC instance created by this solution write access to the COS instance. Only used if `provision_scc_instance` is set to true. |`bool`|`false`| no |
75
+
| <aname="input_use_existing_resource_group"></a> [use\_existing\_resource\_group](#input\_use\_existing\_resource\_group)| Whether to use an existing resource group. |`bool`|`false`| no |
Copy file name to clipboardExpand all lines: solutions/instances/main.tf
+12-6Lines changed: 12 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
locals {
6
6
# tflint-ignore: terraform_unused_declarations
7
-
validate_inputs=var.existing_scc_cos_bucket_name==null&& var.existing_scc_cos_kms_key_crn==null&& var.existing_kms_guid==null?tobool("A value must be passed for 'existing_kms_guid' if not supplying any value for 'existing_scc_cos_kms_key_crn' or 'existing_scc_cos_bucket_name'.") :true
7
+
validate_inputs=var.existing_scc_cos_bucket_name==null&& var.existing_scc_cos_kms_key_crn==null&& var.existing_kms_instance_crn==null?tobool("A value must be passed for 'existing_kms_instance_crn' if not supplying any value for 'existing_scc_cos_kms_key_crn' or 'existing_scc_cos_bucket_name'.") :true
8
8
# tflint-ignore: terraform_unused_declarations
9
9
validate_cos_inputs=var.existing_scc_cos_bucket_name!=null&& var.existing_scc_cos_kms_key_crn!=null?tobool("A value should not be passed for 'existing_scc_cos_kms_key_crn' when passing a value for 'existing_scc_cos_bucket_name'. A key is only needed when creating a new COS bucket.") :true
description="The region in which KMS instance exists."
37
-
}
38
-
39
-
variable"existing_kms_guid" {
33
+
variable"existing_kms_instance_crn" {
40
34
type=string
41
35
default=null
42
-
description="The GUID of of the KMS instance used for the SCC COS bucket root Key. Only required if not supplying an existing KMS root key and if 'skip_cos_kms_auth_policy' is true."
36
+
description="The CRN of the existed Hyper Protect Crypto Services or Key Protect instance. Only required if not supplying an existing KMS root key and if 'skip_cos_kms_auth_policy' is true."
43
37
}
44
38
45
39
variable"existing_scc_cos_kms_key_crn" {
46
40
type=string
47
41
default=null
48
-
description="The CRN of an existing KMS key to be used to encrypt the SCC COS bucket. If not supplied, a new key ring and key will be created in the provided KMS instance."
42
+
description="The CRN of an existing KMS key to be used to encrypt the SCC COS bucket. If no value is passed, a value must be passed for either 'var.existing_kms_instance_crn' if you want to create a new key ring and key, or 'var.existing_scc_cos_bucket_name' if you want to use an existing bucket."
0 commit comments