Alias support for Key Policies #3768

harshit777 · 2022-05-11T05:21:36Z

Added alias support for KeyPolicies management

dinesh-venkatraman-g

Attach the test results.

dinesh-venkatraman-g · 2022-05-18T10:27:47Z

ibm/service/kms/data_source_ibm_kms_key_policies.go

@@ -160,6 +167,7 @@ func dataSourceIBMKMSKeyPoliciesRead(context context.Context, d *schema.Resource
 		instanceID = CrnInstanceID[len(CrnInstanceID)-3]
 	}
 	endpointType := d.Get("endpoint_type").(string)
+	alias := d.Get("alias").(string)


when we use ExactlyOneOf , can we still provide both the params in the input? (ie) both key_id and alias in our case

If yes, if I provide a incorrect combination, say exiting key_id but an incorrect alias name in the Datasource, what is the current behaviour?

Nope, both the params are not allowed (Exactly one of) require either of the input from the user and will output error if both are used. for ex.

Invalid combination of arguments: "key_id": only one of alias,key_id can be specified, but alias,key_id were specified.

Invalid combination of arguments: "alias": only one of alias,key_id can be specified, but alias,key_id were specified.
2022/05/19 11:20:40 [ERROR] : eval: *terraform.EvalSequence, err: 2 problems:

This comes as an output error when used in combination of both the inputs

resource "ibm_kms_key_policies" "root" {
instance_id = ibm_resource_instance.kms_instance.id
key_id = ibm_kms_key.root.key_id
alias = ibm_kms_key_alias.alias.alias
rotation {
interval_month = 3
}
dual_auth_delete {
enabled = false
}
}

dinesh-venkatraman-g · 2022-05-18T10:40:07Z

ibm/service/kms/data_source_ibm_kms_key_policies.go

+	} else {
+		id = alias
+	}
+	key, err := api.GetKey(context, id)


GetKey need only when the key_id is empty

dinesh-venkatraman-g · 2022-05-18T11:10:25Z

ibm/service/kms/resource_ibm_kms_key_alias_test.go

+					resource.TestCheckResourceAttr("ibm_kms_key.test", "key_name", keyName),
+					resource.TestCheckResourceAttr("ibm_kms_key_alias.testAlias", "alias", aliasName),
+					resource.TestCheckResourceAttr("ibm_kms_key_alias.testAlias2", "existing_alias", aliasName),
+					resource.TestCheckResourceAttr("ibm_kms_key_alias.testAlias2", "alias", aliasName2),


the attribute name ibm_kms_key_alias.testAlias2 is repeating

The two attributes are testing two different variables existing_alias and alias

dinesh-venkatraman-g · 2022-05-18T11:18:18Z

website/docs/d/kms_key_policies.html.markdown

@@ -26,13 +31,15 @@ The following arguments are supported:

 - `endpoint_type` - (Optional, String) The type of the public or private endpoint to be used for fetching keys.
 - `instance_id` - (Required, string) The keyprotect instance guid.
- `key_id` - (Required, string) The id of the key.
+- `key_id` - (Required - If the alias is not provided, String) The id of the key.


Suggested change

- `key_id` - (Required - If the alias is not provided, String) The id of the key.

- `key_id` - (Required - if the alias is not provided, String) The id of the key.

dinesh-venkatraman-g · 2022-05-18T11:18:49Z

website/docs/d/kms_key_policies.html.markdown

@@ -26,13 +31,15 @@ The following arguments are supported:

 - `endpoint_type` - (Optional, String) The type of the public or private endpoint to be used for fetching keys.
 - `instance_id` - (Required, string) The keyprotect instance guid.
- `key_id` - (Required, string) The id of the key.
+- `key_id` - (Required - If the alias is not provided, String) The id of the key.
+- `alias`  - (Required - If the key_id is not provided, String) The alias of the key.


Suggested change

- `alias` - (Required - If the key_id is not provided, String) The alias of the key.

- `alias` - (Required - if the key_id is not provided, String) The alias of the key.

dinesh-venkatraman-g · 2022-05-18T11:19:30Z

website/docs/r/kms_key_alias.html.markdown


 - `alias` - (Required, Forces new resource, String) The alias name of the key.
 - `endpoint_type` - (Optional, Forces new resource, String) The type of the public endpoint, or private endpoint to be used for creating keys.
 - `instance_id` - (Required, Forces new resource, String) The hs-crypto or key protect instance GUID.
- `key_id` - (Required, String) The key ID for which alias has to be created.
+- `existing_alias` - (Required, If the key_id is not provided, String) Existing Alias of the key.


Suggested change

- `existing_alias` - (Required, If the key_id is not provided, String) Existing Alias of the key.

- `existing_alias` - (Required - if the key_id is not provided, String) Existing Alias of the key.

dinesh-venkatraman-g · 2022-05-18T11:19:49Z

website/docs/r/kms_key_alias.html.markdown


 - `alias` - (Required, Forces new resource, String) The alias name of the key.
 - `endpoint_type` - (Optional, Forces new resource, String) The type of the public endpoint, or private endpoint to be used for creating keys.
 - `instance_id` - (Required, Forces new resource, String) The hs-crypto or key protect instance GUID.
- `key_id` - (Required, String) The key ID for which alias has to be created.
+- `existing_alias` - (Required, If the key_id is not provided, String) Existing Alias of the key.
+- `key_id` - (Required, If the alias is not provided, String) The key ID for which alias has to be created.


Suggested change

- `key_id` - (Required, If the alias is not provided, String) The key ID for which alias has to be created.

- `key_id` - (Required - if the alias is not provided, String) The key ID for which alias has to be created.

dinesh-venkatraman-g · 2022-05-18T11:20:18Z

website/docs/r/kms_key_policies.html.markdown

 ```

 ## Argument reference

 The following arguments are supported:

 - `endpoint_type` - (Optional, String) The type of the public or private endpoint to be used for fetching policies.
+- `key_id` - (Required - If the alias is not provided, String) The ID of the key.


Suggested change

- `key_id` - (Required - If the alias is not provided, String) The ID of the key.

- `key_id` - (Required - if the alias is not provided, String) The ID of the key.

dinesh-venkatraman-g · 2022-05-18T11:20:44Z

website/docs/r/kms_key_policies.html.markdown

 ```

 ## Argument reference

 The following arguments are supported:

 - `endpoint_type` - (Optional, String) The type of the public or private endpoint to be used for fetching policies.
+- `key_id` - (Required - If the alias is not provided, String) The ID of the key.
+- `alias` - (Required - If the key_id is not provided, String) The alias created for the key.


Suggested change

- `alias` - (Required - If the key_id is not provided, String) The alias created for the key.

- `alias` - (Required - if the key_id is not provided, String) The alias created for the key.

harshit777 · 2022-05-20T11:29:31Z

harshit777 · 2022-05-23T11:14:20Z

hkantare · 2022-05-25T04:14:43Z

And share the testcases results of the reosurces and datasources

hkantare · 2022-05-25T04:06:01Z

ibm/service/kms/data_source_ibm_kms_key_policies.go

@@ -160,6 +167,7 @@ func dataSourceIBMKMSKeyPoliciesRead(context context.Context, d *schema.Resource
 		instanceID = CrnInstanceID[len(CrnInstanceID)-3]
 	}
 	endpointType := d.Get("endpoint_type").(string)
+	alias := d.Get("alias").(string)


Can we use d.GetOK for both key_id and alias

var id string if v, ok := d.GetOk("key_id");ok { id =v.(string) } if v, ok := d.GetOk("alias");ok { id = v.(string) key, err := api.GetKey(context, id) if err != nil { return diag.Errorf("Failed to get Key: %s", err) } d.Set("key_id", key.ID) } ```

hkantare · 2022-05-25T04:11:41Z

ibm/service/kms/resource_ibm_kms_key_alias.go

@@ -86,7 +94,14 @@ func resourceIBMKmsKeyAliasCreate(d *schema.ResourceData, meta interface{}) erro

 	aliasName := d.Get("alias").(string)
 	keyID := d.Get("key_id").(string)
-	stkey, err := kpAPI.CreateKeyAlias(context.Background(), aliasName, keyID)
+	aliasID := d.Get("existing_alias").(string)
+	var id string


use the same concept of d.GetOk for optional fields in all files

harshit777 changed the title ~~Alias support for policies~~ Alias support for Key Policies May 11, 2022

harshit777 force-pushed the AliasExtension branch 4 times, most recently from 8dab582 to c245bbc Compare May 17, 2022 11:55

dinesh-venkatraman-g suggested changes May 18, 2022

View reviewed changes

harshit777 force-pushed the AliasExtension branch from c245bbc to c7a3c0e Compare May 20, 2022 09:20

dinesh-venkatraman-g approved these changes May 23, 2022

View reviewed changes

hkantare reviewed May 25, 2022

View reviewed changes

Alias support for policies

9872b87

harshit777 force-pushed the AliasExtension branch from c7a3c0e to 9872b87 Compare May 25, 2022 11:37

hkantare merged commit 8d78ee7 into IBM-Cloud:master May 25, 2022

SunithaGudisagarIBM pushed a commit to ibm-vpc/terraform-provider-ibm that referenced this pull request Sep 14, 2022

Alias support for policies (IBM-Cloud#3768)

18f827b

SunithaGudisagarIBM pushed a commit to ibm-vpc/terraform-provider-ibm that referenced this pull request Sep 14, 2022

Alias support for policies (IBM-Cloud#3768)

1592529

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Alias support for Key Policies #3768

Alias support for Key Policies #3768

harshit777 commented May 11, 2022

dinesh-venkatraman-g left a comment

dinesh-venkatraman-g May 18, 2022

harshit777 May 20, 2022

dinesh-venkatraman-g May 18, 2022

dinesh-venkatraman-g May 18, 2022

harshit777 May 20, 2022

dinesh-venkatraman-g May 18, 2022

dinesh-venkatraman-g May 18, 2022

dinesh-venkatraman-g May 18, 2022

dinesh-venkatraman-g May 18, 2022

dinesh-venkatraman-g May 18, 2022

dinesh-venkatraman-g May 18, 2022

harshit777 commented May 20, 2022 •

edited

Loading

harshit777 commented May 23, 2022

hkantare commented May 25, 2022

hkantare May 25, 2022

hkantare May 25, 2022

	- `key_id` - (Required - If the alias is not provided, String) The id of the key.
	- `key_id` - (Required - if the alias is not provided, String) The id of the key.

	- `alias` - (Required - If the key_id is not provided, String) The alias of the key.
	- `alias` - (Required - if the key_id is not provided, String) The alias of the key.

	- `existing_alias` - (Required, If the key_id is not provided, String) Existing Alias of the key.
	- `existing_alias` - (Required - if the key_id is not provided, String) Existing Alias of the key.

	- `key_id` - (Required, If the alias is not provided, String) The key ID for which alias has to be created.
	- `key_id` - (Required - if the alias is not provided, String) The key ID for which alias has to be created.

Alias support for Key Policies #3768

Alias support for Key Policies #3768

Conversation

harshit777 commented May 11, 2022

dinesh-venkatraman-g left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harshit777 commented May 20, 2022 • edited Loading

harshit777 commented May 23, 2022

hkantare commented May 25, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harshit777 commented May 20, 2022 •

edited

Loading