From 9ae2b2414729e1bbf3dadc9765106ffd68552cc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=87etin=20ARDAL?= <6201562+kral2@users.noreply.github.com> Date: Wed, 24 Mar 2021 00:40:12 +0100 Subject: [PATCH] release v2.2.0 (#40) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit update documentation links as default branch is now main. Signed-off-by: Çetin ARDAL --- .gitignore | 5 ++++- CHANGELOG.adoc | 12 +++++------- CONTRIBUTORS.adoc | 4 ++-- README.adoc | 12 +++++++----- README.md | 20 +++++++++++--------- docs/prerequisites.adoc | 4 ++-- docs/quickstart.adoc | 4 ++-- docs/routing_rules.adoc | 4 ++-- docs/terraformoptions.adoc | 4 ++-- examples/README.md | 12 ++++++------ examples/custom_route_rules/README.md | 8 ++++---- examples/custom_route_rules/main.tf | 3 ++- examples/main.tf | 2 +- outputs.tf | 5 ----- 14 files changed, 50 insertions(+), 49 deletions(-) diff --git a/.gitignore b/.gitignore index 5a25443..97de3aa 100644 --- a/.gitignore +++ b/.gitignore @@ -12,4 +12,7 @@ provider.tf # visual code - **/.vscode/* \ No newline at end of file + **/.vscode/* + +# macOS related files + .DS_Store \ No newline at end of file diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index 82cf3f8..fadeabd 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -14,27 +14,25 @@ Given a version number MAJOR.MINOR.PATCH: - MINOR version when adding functionality in a backwards compatible manner, - PATCH version when making backwards compatible bug fixes. -== v2.2.0 (unreleased) +== v2.2.0 (March, 23, 2021) === New features * added a new parameter to create a DRG and attach it to VCN (fixes #16) * added support for custom routing rules to provisioned route tables (fixes #17) -* added gateway custom display names: drg (related to issue #30) -* added new outputs for each provisioned resources: "all_attributes" outputs have full provider coverage and are auto-updating. +* added new outputs for each provisioned resources: "all_attributes" outputs have full provider coverage and are auto-updating. (fixes #34) +* added `service_gateway_id` output === Changes +* oci provider minimum version to 4.0.0 * module examples ** added Terraform minimum version to 0.13 and OCI provider minimum version to 4.0.0 -** changed module block of the main example to use variables from variables.tf instead of hardcoded values ** changed default label prefix to "terraform-oci" ** added outputs for cli feedback ** added a new example config for custom routing rules -* added oci provider minimum version to 4.0.0 * documentation update: coding conventions -* added `service_gateway_id` output +* repo: default branch renamed from `master` to `main` === Fixes -* added CHANGELOG entry for v2.0.0 (fixes #19) * update legacy (attributes only) splat syntax in outputs === Deprecation notice diff --git a/CONTRIBUTORS.adoc b/CONTRIBUTORS.adoc index 1b118ff..16447ca 100644 --- a/CONTRIBUTORS.adoc +++ b/CONTRIBUTORS.adoc @@ -1,8 +1,8 @@ == GitHub userids of contributors -=== OWNERS +=== Maintainers -_Owners have admin access and can merge code to master_ +_maintainers have admin access and can merge code to main_ - https://github.com/hyder[@hyder] - https://github.com/markxnelson[@markxnelson] diff --git a/README.adoc b/README.adoc index ca28358..4e7bc83 100644 --- a/README.adoc +++ b/README.adoc @@ -5,8 +5,8 @@ :uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-vcn -:uri-rel-file-base: link:{uri-repo}/blob/master -:uri-rel-tree-base: link:{uri-repo}/tree/master +:uri-rel-file-base: link:{uri-repo}/blob/main +:uri-rel-tree-base: link:{uri-repo}/tree/main :uri-docs: {uri-rel-file-base}/docs @@ -37,12 +37,14 @@ The {uri-repo}[Terraform VCN] for {uri-oci}[Oracle Cloud Infrastructure] (OCI) p It creates the following resources: * A VCN with customizable CIDR block -* An optional internet gateway -* An optional NAT gateway +* An optional internet gateway and a route table +* An optional NAT gateway and a route table * An optional service gateway * An optional dynamic routing gateway -It also controls the Default Security List, with a *Lockdown mode* that can be enabled or disabled. +It also controls the Default Security List, with a *Lockdown mode* that can be enabled or disabled + +Custom route rules can be added to the two route tables created by the module. This module is primarily meant to be reusable to create more advanced infrastructure on {uri-oci}[OCI] either manually in the OCI Console or by extending the Terraform code. diff --git a/README.md b/README.md index b0d0e5b..c14bd60 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,15 @@ The [Terraform VCN][repo] for [Oracle Cloud Infrastructure][OCI] provides a reus It creates the following resources: * A VCN with customizable CIDR block -* An optional internet gateway +* An optional internet gateway and a route table * An optional NAT gateway * An optional service gateway * An optional dynamic routing gateway It also controls the Default Security List, with a *Lockdown mode* that can be enabled or disabled. +Custom route rules can be added to the two route tables created by the module. + This module is primarily meant to be reusable to create more advanced infrastructure on [OCI][OCI] either manually in the OCI Console or by extending the Terraform code. ## [Documentation][docs] @@ -55,21 +57,21 @@ Licensed under the [Universal Permissive License 1.0][license] as shown at [https://oss.oracle.com/licenses/upl][canonical_license]. -[changelog]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/master/CHANGELOG.adoc -[contributing]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/master/CONTRIBUTING.adoc -[contributors]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/master/CONTRIBUTORS.adoc -[docs]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/tree/master/docs +[changelog]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/CHANGELOG.adoc +[contributing]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/CONTRIBUTING.adoc +[contributors]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/CONTRIBUTORS.adoc +[docs]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/tree/main/docs -[license]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/master/LICENSE +[license]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/LICENSE [canonical_license]: https://oss.oracle.com/licenses/upl/ [oci]: https://cloud.oracle.com/cloud-infrastructure [oci_documentation]: https://docs.cloud.oracle.com/iaas/Content/home.htm [oracle]: https://www.oracle.com -[prerequisites]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/master/docs/prerequisites.adoc +[prerequisites]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/docs/prerequisites.adoc -[quickstart]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/master/docs/quickstart.adoc +[quickstart]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/docs/quickstart.adoc [repo]: https://github.com/oracle/terraform-oci-vcn [reuse]: https://github.com/oracle/terraform-oci-vcn/examples/db [subnets]: https://erikberg.com/notes/networks.html @@ -77,7 +79,7 @@ Licensed under the [Universal Permissive License 1.0][license] as shown at [terraform_cidr_subnet]: http://blog.itsjustcode.net/blog/2017/11/18/terraform-cidrsubnet-deconstructed/ [terraform_hashircorp_examples]: https://github.com/hashicorp/terraform-guides/tree/master/infrastructure-as-code/terraform-0.12-examples [terraform_oci]: https://www.terraform.io/docs/providers/oci/index.html -[terraform_options]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/master/docs/terraformoptions.adoc +[terraform_options]: https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/docs/terraformoptions.adoc [terraform_oci_examples]: https://github.com/terraform-providers/terraform-provider-oci/tree/master/examples [terraform_oci_oke]: https://github.com/oracle-terraform-modules/terraform-oci-oke \ No newline at end of file diff --git a/docs/prerequisites.adoc b/docs/prerequisites.adoc index 1308cce..2182f8c 100644 --- a/docs/prerequisites.adoc +++ b/docs/prerequisites.adoc @@ -13,8 +13,8 @@ endif::[] :toc-placement!: :uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-vcn -:uri-rel-file-base: link:{uri-repo}/blob/master -:uri-rel-tree-base: link:{uri-repo}/tree/master +:uri-rel-file-base: link:{uri-repo}/blob/main +:uri-rel-tree-base: link:{uri-repo}/tree/main :uri-docs: {uri-rel-file-base}/docs :uri-oci: https://cloud.oracle.com/cloud-infrastructure diff --git a/docs/quickstart.adoc b/docs/quickstart.adoc index 2612c9f..0346439 100644 --- a/docs/quickstart.adoc +++ b/docs/quickstart.adoc @@ -5,8 +5,8 @@ :toc: :uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-vcn -:uri-rel-file-base: link:{uri-repo}/blob/master -:uri-rel-tree-base: link:{uri-repo}/tree/master +:uri-rel-file-base: link:{uri-repo}/blob/main +:uri-rel-tree-base: link:{uri-repo}/tree/main :uri-docs: {uri-rel-file-base}/docs :uri-oci-keys: https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm :uri-oci-ocids: https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five diff --git a/docs/routing_rules.adoc b/docs/routing_rules.adoc index cb76c6d..41d2d77 100644 --- a/docs/routing_rules.adoc +++ b/docs/routing_rules.adoc @@ -12,8 +12,8 @@ endif::[] :toc: :uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-vcn -:uri-rel-file-base: link:{uri-repo}/blob/master -:uri-rel-tree-base: link:{uri-repo}/tree/master +:uri-rel-file-base: link:{uri-repo}/blob/main +:uri-rel-tree-base: link:{uri-repo}/tree/main :uri-docs: {uri-rel-file-base}/docs :uri-tf-namedvalues: https://www.terraform.io/docs/language/expressions/references.html :uri-oci-lpg: https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/core_local_peering_gateway diff --git a/docs/terraformoptions.adoc b/docs/terraformoptions.adoc index e6f5803..5a47043 100644 --- a/docs/terraformoptions.adoc +++ b/docs/terraformoptions.adoc @@ -6,8 +6,8 @@ :toc: :uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-vcn -:uri-rel-file-base: link:{uri-repo}/blob/master -:uri-rel-tree-base: link:{uri-repo}/tree/master +:uri-rel-file-base: link:{uri-repo}/blob/main +:uri-rel-tree-base: link:{uri-repo}/tree/main :uri-docs: {uri-rel-file-base}/docs :uri-oci-region: https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm diff --git a/examples/README.md b/examples/README.md index 0d581da..5615cd6 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,14 +1,14 @@ # Example reusing terraform-oci-vcn and extending to create other network resources -[rootvariables]:https://github.com/oracle/terraform-oci-vcn/blob/master/examples/db/variables.tf -[rootlocals]:https://github.com/oracle/terraform-oci-vcn/blob/master/examples/db/locals.tf -[terraformoptions]:https://github.com/oracle/terraform-oci-vcn/blob/master/docs/terraformoptions.adoc +[rootvariables]:https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/examples/variables.tf +[terraformoptions]:https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/docs/terraformoptions.adoc +[terraform-oci-vcn]:https://registry.terraform.io/modules/oracle-terraform-modules/vcn/oci/latest __Note: This is an example to demonstrate reusing this Terraform module to create additional network resources. Ensure you evaluate your own security needs when creating security lists, network security groups etc.__ ## Create a new Terraform project -As an example, we’ll be using terraform-oci-vcn to create +As an example, we’ll be using [terraform-oci-vcn] to create additional network resources in the VCN. The steps required are the following: 1. Create a new directory for your project e.g. mynetwork @@ -44,10 +44,10 @@ cd modules 5. Add the terraform-oci-vcn module ```shell -git clone https://github.com/oracle/terraform-oci-vcn.git vcn +git clone https://github.com/oracle-terraform-modules/terraform-oci-vcn.git vcn ``` -Note: Cloning will be required until the module is published in HashiCorp's registry. +Note: Cloning is now optional as [the module is published in HashiCorp's registry][terraform-oci-vcn]. ## Define project variables diff --git a/examples/custom_route_rules/README.md b/examples/custom_route_rules/README.md index f8df48f..6d2d02e 100644 --- a/examples/custom_route_rules/README.md +++ b/examples/custom_route_rules/README.md @@ -4,9 +4,9 @@ [Input Variables]:https://www.terraform.io/docs/language/values/variables.html [Local Values]:https://www.terraform.io/docs/language/values/locals.html [Named Values]:https://www.terraform.io/docs/language/expressions/references.html -[docs/prerequisites]:https://github.com/oracle-terraform-modules/terraform-oci-compute-instance/blob/master/docs/prerequisites.adoc -[docs/terraformoptions]:https://github.com/oracle-terraform-modules/terraform-oci-compute-instance/blob/master/docs/terraformoptions.adoc -[docs/routing_rules]:https://github.com/oracle-terraform-modules/terraform-oci-compute-instance/blob/master/docs/routing_rules.adoc +[docs/prerequisites]:https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/docs/prerequisites.adoc +[docs/terraformoptions]:https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/docs/terraformoptions.adoc +[docs/routing_rules]:https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/docs/routing_rules.adoc [Provisioning Infrastructure with Terraform]:https://www.terraform.io/docs/cli/run/index.html This example illustrates how to use `terraform-oci-vcn` module to create a vcn with gateways and custom routing rules. @@ -27,7 +27,7 @@ In addition, a Local Peering Gateway is created at the root of the configuration This diagram shows what will be created by this example. -![diagram](https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/master/docs/images/custom_route_rules.drawio.PNG?raw=true&sanitize=true) +![diagram](https://github.com/oracle-terraform-modules/terraform-oci-vcn/blob/main/docs/images/custom_route_rules.drawio.PNG?raw=true&sanitize=true) ## How to specify module Input Variables values diff --git a/examples/custom_route_rules/main.tf b/examples/custom_route_rules/main.tf index c2451c0..8ba18c9 100644 --- a/examples/custom_route_rules/main.tf +++ b/examples/custom_route_rules/main.tf @@ -16,7 +16,8 @@ terraform { # Resources module "vcn" { - source = "../../" + source = "oracle-terraform-modules/vcn/oci" + version = "2.2.0" # general oci parameters compartment_id = var.compartment_id diff --git a/examples/main.tf b/examples/main.tf index 4ec2e80..09e5589 100644 --- a/examples/main.tf +++ b/examples/main.tf @@ -52,7 +52,7 @@ output "module_vcn_ids" { vcn_default_security_list_id = module.vcn.vcn_all_attributes.default_security_list_id vcn_default_route_table_id = module.vcn.vcn_all_attributes.default_route_table_id vcn_default_dhcp_options_id = module.vcn.vcn_all_attributes.default_dhcp_options_id - vcn_id = module.vcn.vcn_id + vcn_id = module.vcn.vcn_id } } diff --git a/outputs.tf b/outputs.tf index 76eda5d..7e395e5 100644 --- a/outputs.tf +++ b/outputs.tf @@ -26,11 +26,6 @@ output "service_gateway_id" { value = join(",", oci_core_service_gateway.service_gateway[*].id) } -output "service_gateway_id" { - description = "id of service gateway if it is created" - value = join(",", oci_core_service_gateway.service_gateway.*.id) -} - output "ig_route_id" { description = "id of internet gateway route table" value = join(",", oci_core_route_table.ig[*].id)