feat: add functionality to pass a custom name for the vpe gateway #362

MatthewLemmond · 2023-08-08T02:55:38Z

Description

Add a new variable to allow for passing a map containing keys which match the service name for which a VPE Gateway will be created corresponding to a value which is the name you want that gateway to have. Example and test for this functionality also created.

Release required?

Identify the type of release. For information about the changes in a semantic versioning release, see Release versioning.

No release
Patch release (x.x.X)
Minor release (x.X.x)
Major release (X.x.x)

Release notes content

Add the ability to customize the names of the Gateways being created by the module, in order to pass a name assign a map to var.vpe_names whose keys are the services which you want to have a custom gateway name for, and the corresponding values are the names you want to assign to those gateways.

Run the pipeline

If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.

Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:

/run pipeline

Checklist for reviewers

If relevant, a test for the change is included or updated with this PR.
If relevant, documentation for the change is included or updated with this PR.

Merge actions for mergers

Use a relevant conventional commit message that is based on the PR contents and any release notes provided by the PR author. The commit message determines whether a new version of the module is needed, and if so, which semver increment to use (major, minor, or patch).
Merge by using "Squash and merge".

MatthewLemmond · 2023-08-08T03:13:04Z

/run pipeline

examples/non-default/README.md

MatthewLemmond · 2023-08-09T18:33:01Z

/run pipeline

shemau

The implementation in the main module looks fine.

I would question the whole second example.
During CI tests both others_tests and pr_tests are going to run. Resulting in a second example test that is identical other the names on 3 out of 18 VPE gateways.

The new example code sets and passes the new variable and other_test.pr sends a value. I wonder if a better solution would be to put that code in the existing example and have it called from pr_test with the new map?
My thought is that the coverage is the same, both the old (default name, on 15 of 18 gateways) and the new (passed name, on 3 of 18 gateways) would be tested covering both code paths. This is achieved with only one VPC and ICD instance. Resource consumption is lower and the opportunity to fail is lower (VPC tear down has been a bit flaky at times).

Co-authored-by: Renovate Bot <renovate@whitesourcesoftware.com>

…terratest-wrapper to v1.10.17 (#365) Co-authored-by: Renovate Bot <renovate@whitesourcesoftware.com>

MatthewLemmond · 2023-08-14T21:08:00Z

Given the above feedback, I've removed the non-default example folder and moved the 3 custom names into the setup options the default test uses. Given that this is passing a new argument to the test, the upgrade test is going to fail. I'm including here the output of running terraform plan on both the main branch and this branch to show there are no changes in the output from the plan. I'm going to let the upgrade test run and fail then push a commit to skip it just to verify.

Output from main terraform plan:

Changes to Outputs:
  ~ vpe_ips = {
      ~ tmp-ml-vpc-instance-cloud-object-storage = [
          + {
              + address       = "10.20.10.5"
              + id            = "0727-a35c3b9f-67e2-4edb-a073-37df69068871"
              + name          = "excluded-saved-agility-duct"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.30.10.4"
              + id            = "0737-6eb41720-7a3b-4490-9e5d-dc5413c79db8"
              + name          = "obstacle-uncross-wiry-essential"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.10.10.4"
              + id            = "0717-9d954cf7-5e0c-4c41-96c8-ce5b30ffbc38"
              + name          = "cope-unfrosted-neurotic-eagle"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
        ]
      ~ tmp-ml-vpc-instance-kms                  = [
          + {
              + address       = "10.10.10.5"
              + id            = "0717-fe104ec7-7ef8-4a5a-8a2c-984644a3780e"
              + name          = "pupil-guise-sling-septet"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.20.10.4"
              + id            = "0727-f4c18626-fb21-4aaf-a96b-86509af23d16"
              + name          = "kerchief-detergent-glimmer-spotted"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.30.10.5"
              + id            = "0737-a1bc3a48-fb79-4187-995f-51462768c6a5"
              + name          = "stoppage-freehand-crinkly-lagged"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
        ]
      ~ tmp-ml-vpc-instance-postgresql           = [
          + {
              + address       = "10.10.10.6"
              + id            = "0717-77a5ced5-b9ed-4dc8-8265-6cbed95c28ab"
              + name          = "unshattered-overall-matchbook-frogman"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.20.10.6"
              + id            = "0727-9b0a2e81-8e14-4792-8be6-cf42d24442df"
              + name          = "ferment-disagree-suffixed-obstinate"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.30.10.6"
              + id            = "0737-5e990900-e20b-46da-b1f5-2f722bd5bf45"
              + name          = "far-flashy-enchilada-until"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
        ]
    }

Output from vpe-name terraform plan:

Changes to Outputs:
  ~ vpe_ips = {
      ~ tmp-ml-vpc-instance-cloud-object-storage = [
          + {
              + address       = "10.10.10.4"
              + id            = "0717-9d954cf7-5e0c-4c41-96c8-ce5b30ffbc38"
              + name          = "cope-unfrosted-neurotic-eagle"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.20.10.5"
              + id            = "0727-a35c3b9f-67e2-4edb-a073-37df69068871"
              + name          = "excluded-saved-agility-duct"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.30.10.4"
              + id            = "0737-6eb41720-7a3b-4490-9e5d-dc5413c79db8"
              + name          = "obstacle-uncross-wiry-essential"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
        ]
      ~ tmp-ml-vpc-instance-kms                  = [
          + {
              + address       = "10.10.10.5"
              + id            = "0717-fe104ec7-7ef8-4a5a-8a2c-984644a3780e"
              + name          = "pupil-guise-sling-septet"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.20.10.4"
              + id            = "0727-f4c18626-fb21-4aaf-a96b-86509af23d16"
              + name          = "kerchief-detergent-glimmer-spotted"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.30.10.5"
              + id            = "0737-a1bc3a48-fb79-4187-995f-51462768c6a5"
              + name          = "stoppage-freehand-crinkly-lagged"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
        ]
      ~ tmp-ml-vpc-instance-postgresql           = [
          + {
              + address       = "10.20.10.6"
              + id            = "0727-9b0a2e81-8e14-4792-8be6-cf42d24442df"
              + name          = "ferment-disagree-suffixed-obstinate"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.30.10.6"
              + id            = "0737-5e990900-e20b-46da-b1f5-2f722bd5bf45"
              + name          = "far-flashy-enchilada-until"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
          + {
              + address       = "10.10.10.6"
              + id            = "0717-77a5ced5-b9ed-4dc8-8265-6cbed95c28ab"
              + name          = "unshattered-overall-matchbook-frogman"
              + resource_type = "subnet_reserved_ip"
              + subnet        = ""
            },
        ]
    }

MatthewLemmond · 2023-08-14T21:23:12Z

/run pipeline

SKIP UPGRADE TEST upgrade test fails due to new variable being passed to the test, skipping

MatthewLemmond · 2023-08-14T22:20:51Z

/run pipeline

shemau

LGTM

terraform-ibm-modules-ops · 2023-08-15T16:31:51Z

🎉 This PR is included in version 2.7.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

MatthewLemmond added 2 commits August 7, 2023 22:44

feat: add functionality to pass a custom name for the vpe gateway

50e9d03

refactor: update readme header, fix go.mod

aea12dc

ocofaigh reviewed Aug 9, 2023

View reviewed changes

examples/non-default/README.md Outdated Show resolved Hide resolved

refactor: clarify what example does in Readme

5b45c26

shemau requested changes Aug 11, 2023

View reviewed changes

terraform-ibm-modules-ops and others added 4 commits August 14, 2023 08:59

chore(deps): update common-dev-assets digest to 00b5683 (#361)

4a538fe

Co-authored-by: Renovate Bot <renovate@whitesourcesoftware.com>

chore(deps): update common-dev-assets digest to eee03c3 (#363)

c2053fb

Co-authored-by: Renovate Bot <renovate@whitesourcesoftware.com>

chore(deps): update ci dependencies (#364)

2b3bdad

Co-authored-by: Renovate Bot <renovate@whitesourcesoftware.com>

chore(deps): update module github.com/terraform-ibm-modules/ibmcloud-…

9545103

…terratest-wrapper to v1.10.17 (#365) Co-authored-by: Renovate Bot <renovate@whitesourcesoftware.com>

MatthewLemmond added 2 commits August 14, 2023 17:10

refactor: move vpe_names into pr_test and remove redundant example

9c15c21

Merge branch 'main' into vpe-name

b742113

refactor: change description on example var

0a5e26f

SKIP UPGRADE TEST upgrade test fails due to new variable being passed to the test, skipping

MatthewLemmond requested a review from shemau August 15, 2023 14:06

shemau approved these changes Aug 15, 2023

View reviewed changes

ocofaigh mentioned this pull request Aug 15, 2023

Give more flexibility in the VPE name #344

Closed

ocofaigh merged commit 3bf013b into main Aug 15, 2023
2 checks passed

ocofaigh deleted the vpe-name branch August 15, 2023 16:29

terraform-ibm-modules-ops added the released label Aug 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add functionality to pass a custom name for the vpe gateway #362

feat: add functionality to pass a custom name for the vpe gateway #362

MatthewLemmond commented Aug 8, 2023

MatthewLemmond commented Aug 8, 2023

MatthewLemmond commented Aug 9, 2023

shemau left a comment

MatthewLemmond commented Aug 14, 2023

MatthewLemmond commented Aug 14, 2023

MatthewLemmond commented Aug 14, 2023

shemau left a comment

terraform-ibm-modules-ops commented Aug 15, 2023

feat: add functionality to pass a custom name for the vpe gateway #362

feat: add functionality to pass a custom name for the vpe gateway #362

Conversation

MatthewLemmond commented Aug 8, 2023

Description

Release required?

Release notes content

Run the pipeline

Checklist for reviewers

Merge actions for mergers

MatthewLemmond commented Aug 8, 2023

MatthewLemmond commented Aug 9, 2023

shemau left a comment

Choose a reason for hiding this comment

MatthewLemmond commented Aug 14, 2023

MatthewLemmond commented Aug 14, 2023

MatthewLemmond commented Aug 14, 2023

shemau left a comment

Choose a reason for hiding this comment

terraform-ibm-modules-ops commented Aug 15, 2023