release v2.2.0 (#40)

update documentation links as default branch is now main.

Signed-off-by: Çetin ARDAL <[email protected]>

.gitignore

@@ -12,4 +12,7 @@
 provider.tf
 
 # visual code
- **/.vscode/*
+ **/.vscode/*
+
+# macOS related files
+ .DS_Store

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

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]

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.
 

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,29 +57,29 @@ Licensed under the [Universal Permissive License 1.0][license] as shown at
 [https://oss.oracle.com/licenses/upl][canonical_license].
 
 <!-- Links reference section -->
-[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
 [terraform]: https://www.terraform.io
 [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
 <!-- Links reference section -->

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

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

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

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

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
 

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
 

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

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
   }
 }
 

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)