Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

renaming landing zone submodules to modules #694

Merged
merged 8 commits into from
Jan 25, 2024
Merged

Conversation

Aayush-Abhyarthi
Copy link
Contributor

Description

https://github.ibm.com/GoldenEye/issues/issues/6952

Release required?

  • No release
  • Patch release (x.x.X)
  • Minor release (x.X.x)
  • Major release (X.x.x)
Release notes content

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.

For mergers

  • Use a conventional commit message to set the release level. Follow the guidelines.
  • Include information that users need to know about the PR in the commit message. The commit message becomes part of the GitHub release notes.
  • Use the Squash and merge option.

@Aayush-Abhyarthi
Copy link
Contributor Author

/run pipeline

@@ -1,6 +1,6 @@
# Landing Zone example

This example demonstrates how to use the management and workload VPC [modules](../../landing-zone-submodule/) to create a network VPC topology that is aligned with the network segregation key principles of the IBM Cloud [Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-connectivity-overview).
This example demonstrates how to use the management and workload VPC [modules](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vsi/tree/main/modules/fscloud) to create a network VPC topology that is aligned with the network segregation key principles of the IBM Cloud [Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-connectivity-overview).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that url is wrong

@Aayush-Abhyarthi
Copy link
Contributor Author

/run pipeline

Copy link
Member

@ocofaigh ocofaigh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see latest comments. Do you know if any of our modules or example are consuming these submodules directly? If so, lets ensure we update them to use new directory location.

I also notice that the submodule readme are missing a usage block. Can you add it please?

@@ -1,6 +1,6 @@
# Landing Zone example

This example demonstrates how to use the management and workload VPC [modules](../../landing-zone-submodule/) to create a network VPC topology that is aligned with the network segregation key principles of the IBM Cloud [Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-connectivity-overview).
This example demonstrates how to use the management and workload VPC [modules](../../modules/) to create a network VPC topology that is aligned with the network segregation key principles of the IBM Cloud [Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-connectivity-overview).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

../../modules/ won't render in hashicorp, needs to be full repo url

README.md Outdated
@@ -38,7 +41,7 @@ This module creates the following IBM Cloud® Virtual Private Cloud (VPC) net

### Presets

In addition to this root module, this repository provides two submodules that call the root module with presets and defaults that are aligned with the general [Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-about) management and workload VPC topologies. See the [landing-zone-submodules](/landing-zone-submodule/) for details.
In addition to this root module, this repository provides two submodules that call the root module with presets and defaults that are aligned with the general [Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-about) management and workload VPC topologies. See the [landing-zone-submodules](/modules/) for details.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest chaning to See the landing zone submodules in the [modules](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/tree/main/modules) folder for details.

@Aayush-Abhyarthi
Copy link
Contributor Author

/run pipeline

### Usage
```terraform
module management_vpc {
source = https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/tree/main/modules/management-vpc
Copy link
Member

@ocofaigh ocofaigh Jan 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thats not how you consume a submodule from github, it would be: "git::https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc.git//modules/management-vpc?ref=X.X.X"

However, lets use hashicorp as the source, which would be:

 source                      = "terraform-ibm-modules/terraform-ibm-landing-zone-vpc/ibm//modules/management-vpc"
version                     = "X.X.X" # replace X.X.X with a release version to lock into an exact release

### Usage
```terraform
module workload_vpc {
source = https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/tree/main/modules/workload-vpc
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@ocofaigh ocofaigh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see comments

@Aayush-Abhyarthi
Copy link
Contributor Author

/run pipeline

### Usage
```terraform
module management_vpc {
source = "terraform-ibm-modules/terraform-ibm-landing-zone-vpc/ibm//modules/management-vpc"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, source is still wrong here. should be terraform-ibm-modules/landing-zone-vpc/ibm//modules/management-vpc

### Usage
```terraform
module workload_vpc {
source = "terraform-ibm-modules/terraform-ibm-landing-zone-vpc/ibm//modules/workload-vpc"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, source is still wrong here. should be "terraform-ibm-modules/landing-zone-vpc/ibm//modules/workload-vpc"

@Aayush-Abhyarthi
Copy link
Contributor Author

/run pipeline

@ocofaigh ocofaigh merged commit f583bbb into main Jan 25, 2024
2 checks passed
@ocofaigh ocofaigh deleted the rename-to-modules branch January 25, 2024 09:50
@terraform-ibm-modules-ops
Copy link
Contributor

🎉 This PR is included in version 7.16.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants