Fix endpoint URL

[Sidd-kp]

Description: This fix would allow users to provide endpoint url without "/api/v2/keys" without breaking backward compatibility.
Signed-off-by: Siddharth Mishra siddharth.mishra2@ibm.com

Community Note

• Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Relates OR Closes #0000

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccXXX'

...

[dinesh-venkatraman-g]

Thanks @Sidd-kp Can you attach following evidences for following scenarios:

• When IBM KP End point URL is not set
  • private endpoint
  • public endpoint
• When IBM KP End point URL is set without /v2/api/keys suffix
  • private
  • public
• When IBM KP End point URL is set with /v2/api/keys suffix
  • private
  • public
  • Other resources like key ring, alias etc.,
• Evidence that all test case are passing successfully

[Sidd-kp]

I am using the following script for all the test cases:
Cases:

• IBM KP End point URL is not set

  • For Public:

    Script

    provider "ibm" {}
    
    
    resource "ibm_resource_instance" "kms_instance" {
        name              = "kms_inst"
        service           = "kms"
        plan              = "tiered-pricing"
        location          = "us-south"
    }
    
    resource "ibm_kms_key_rings" "key_ring" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_ring_id   = "key-ring1"
    }
    
    resource "ibm_kms_key" "test" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_name = "key1"
        standard_key =  false
        key_ring_id = ibm_kms_key_rings.key_ring.key_ring_id
        endpoint_type = "public"
    }
    
    resource "ibm_kms_key_alias" "test_alias" {
        instance_id = ibm_resource_instance.kms_instance.guid
        alias = "alias1"
        key_id = ibm_kms_key.test.key_id
    }
    

    

  • For Private(Url is set correctly)

    Script

    provider "ibm" {}
    
    
    resource "ibm_resource_instance" "kms_instance" {
        name              = "kms_inst"
        service           = "kms"
        plan              = "tiered-pricing"
        location          = "us-south"
        service_endpoints = "private"
    }
    
    resource "ibm_kms_key_rings" "key_ring" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_ring_id   = "key-ring1"
        endpoint_type = "private"
    }
    
    resource "ibm_kms_key" "test" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_name = "key1"
        standard_key =  false
        endpoint_type = "private"
    }
    
    resource "ibm_kms_key_alias" "test_alias" {
        instance_id = ibm_resource_instance.kms_instance.guid
        alias = "alias1"
        key_id = ibm_kms_key.test.key_id
    }
    
    

    

• IBM KP End point URL is set without /v2/api/keys suffix

  • For Public:

    Script

    provider "ibm" {}
    
    
    resource "ibm_resource_instance" "kms_instance" {
        name              = "kms_inst"
        service           = "kms"
        plan              = "tiered-pricing"
        location          = "us-south"
    }
    
    resource "ibm_kms_key_rings" "key_ring" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_ring_id   = "key-ring1"
    }
    
    resource "ibm_kms_key" "test" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_name = "key1"
        standard_key =  false
        key_ring_id = ibm_kms_key_rings.key_ring.key_ring_id
        endpoint_type = "public"
    }
    
    resource "ibm_kms_key_alias" "test_alias" {
        instance_id = ibm_resource_instance.kms_instance.guid
        alias = "alias1"
        key_id = ibm_kms_key.test.key_id
    }
    

    

  • For Private:

    Script

    provider "ibm" {}
    
    
    resource "ibm_resource_instance" "kms_instance" {
        name              = "kms_inst"
        service           = "kms"
        plan              = "tiered-pricing"
        location          = "us-south"
        service_endpoints = "private"
    }
    
    resource "ibm_kms_key_rings" "key_ring" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_ring_id   = "key-ring1"
        endpoint_type = "private"
    }
    
    resource "ibm_kms_key" "test" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_name = "key1"
        standard_key =  false
        endpoint_type = "private"
    }
    
    resource "ibm_kms_key_alias" "test_alias" {
        instance_id = ibm_resource_instance.kms_instance.guid
        alias = "alias1"
        key_id = ibm_kms_key.test.key_id
    }
    
    

    

• IBM KP End point URL is set with /v2/api/keys suffix

  • Public

    Script

    provider "ibm" {}
    
    
    resource "ibm_resource_instance" "kms_instance" {
        name              = "kms_inst"
        service           = "kms"
        plan              = "tiered-pricing"
        location          = "us-south"
    }
    
    resource "ibm_kms_key_rings" "key_ring" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_ring_id   = "key-ring1"
    }
    
    resource "ibm_kms_key" "test" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_name = "key1"
        standard_key =  false
    }
    
    resource "ibm_kms_key_alias" "test_alias" {
        instance_id = ibm_resource_instance.kms_instance.guid
        alias = "alias1"
        key_id = ibm_kms_key.test.key_id
    }
    
    

    

  • Private

    Script

    provider "ibm" {}
    
    
    resource "ibm_resource_instance" "kms_instance" {
        name              = "kms_inst"
        service           = "kms"
        plan              = "tiered-pricing"
        location          = "us-south"
        service_endpoints = "private"
    }
    
    resource "ibm_kms_key_rings" "key_ring" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_ring_id   = "key-ring1"
        endpoint_type = "private"
    }
    
    resource "ibm_kms_key" "test" {
        instance_id = ibm_resource_instance.kms_instance.guid
        key_name = "key1"
        standard_key =  false
        endpoint_type = "private"
    }
    
    resource "ibm_kms_key_alias" "test_alias" {
        instance_id = ibm_resource_instance.kms_instance.guid
        alias = "alias1"
        key_id = ibm_kms_key.test.key_id
    }
    
    

    

[dinesh-venkatraman-g]

looks good. thanks for detailed test evidences @Sidd-kp