Release v2.0.0

Author: kral2

CHANGELOG.md

@@ -11,92 +11,50 @@ 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.
 
-## [Unreleased]
-
-### Changed
-
-- bump Copyright notice to 2021
-
-## [2.1.3] 2021-01-19
-
-### Fixed
-
-- update documentation links to use absolute paths (Terraform Registry do not support relative paths)
-- update image link
-
-## [2.1.2] 2021-01-05
+## [2.0.0] - 2021-01-27
 
 ### Added
 
-- clarify documentation regarding provider configuration requirements for OCI IAM resources (you must you home region)
+#### New features
 
-## [2.1.1] 2020-12-22
+- delete a compartment
+- create a sub-compartment
+- create a list of oci users
+- set email of oci user
 
-### Added
+#### Documentation
 
-- variables: type constraints defined for all variables,
-- variables: default value is `null` if there is no other advisable value,
-- ouputs: user_description output for iam-user module,
-- terraform and OCI terraform provider version pinning block,
-- examples: add a README
+- CHANGELOG following [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) format
+- CONTRIBUTING guide
+- prerequisites section with the required Terraform and Terraform Provider versions
+- clarify provider configuration requirements for OCI IAM resources (you must your home region)
+- README for /examples
+- examples on how to use the new features of this module
 
 ### Changed
 
-Documentation update:
-
-- update README files to use relative links for content coming from this repo
-- Update oci provider URL to registry.terraform.io
-- update the prerequisites and usage section for each submodule
-- add a column with default value for each variable
-
-Resources:
+#### Resources
 
 - `count` tests with true/false for boolean variables,
 - `count` tests with null or variable length for arrays.
 
-### Fixed
+#### modules/*
 
-- iam-user: email can be empty if value is set to `null`
-
-## [2.1.0] 2020-12-15
-
-### Added
+- terraform and OCI terraform provider version pinning block : Terraform 0.12 and OCI Provider 3.27 or greater
+- new outputs for each sub-modules
+- typed variables
+- variables default value is `null` if there is no better advisable value
 
-- More current README.md for the example folder. Also add a sample apply output.
-
-#### Module - iam-compartment, iam-group, iam-dynamic-group
-
-- More complete outputs. oci-compartment now also expose the parent compartment ocid,
-- add a new combined output name -> ocid
-
-### Changed
-
-#### Module - iam-compartment
+#### modules/iam-compartment
 
 - compartment_name and compartment_description are now mandatory (default value is null),
 - compartment_id is now optional: if the parent compartment ID is not specified, the compartment is created at the root level of the tenancy
 
-#### Module - iam-user
+#### modules/iam-user
 
 - name and description are now mandatory (default value is null)
 
 ### Fixed
 
-- update modules and examples to not use deprecated interpolation syntax anymore,
-- update examples to show how to use the 2.x.x features of this module.
-
-## [2.0.1] 2020-12-14
-
-### Added
-
-- repo maintenance: starts this CHANGELOG.md
-- update README.md prerequisites section with the required Terraform and Terraform Provider versions
-
-### Changed
-
-- repo maintenance: updates Copyright to 2020
-- repo maintenance: .gitignore and .gitattributes adjusted files for cleaner repo
-
-### Removed
-
-- Resource "watermark" with freeform tags - may be reintroduced later in a more flexible manner
+- Issues: #11 #12 #16
+- no more deprecated interpolation syntax in modules and examples

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# CONTRIBUTING
+
+Oracle welcomes contributions to this repository from anyone.
+
+If you want to submit a pull request to fix a bug or enhance an existing feature, please first open an issue and link to that issue when you submit your pull request.
+
+If you have any questions about a possible submission, feel free to open an issue too.
+
+## Contributing to the terraform-oci-iam repository
+
+Pull requests can be made under The Oracle Contributor Agreement(OCA).
+
+For pull requests to be accepted, the bottom of your commit message must have the following line using your name and e-mail address as it appears in the OCA Signatories list.
+
+`Signed-off-by: Your Name <[email protected]>`
+
+This can be automatically added to pull requests by committing with:
+
+`git commit --signoff`
+
+or by turning on the "Always Sign Off" flag in your IDE's preferences.
+
+Only pull requests from committers that can be verified as having signed the OCA can be accepted.
+
+## Pull request process
+
+1. Fork this repository
+
+1. Create a branch in your own fork to implement the changes. We recommend using the issue number as part of your branch name, e.g.: `1234-fixes`
+
+1. Ensure that any documentation is updated with the changes that are required by your fix
+
+1. Update README.md when necessary
+
+1. Ensure that any samples are updated if the base image has been changed
+
+1. Update CHANGELOG.md - add information about the changes that are done in this pull request, increment the version
+
+1. Tag your branch with the new version
+
+1. Submit the pull request. **Do not leave the pull request description blank**. Explain exactly what your changes are meant to do and provide simple steps on how to validate your changes. Ensure that you reference the issue you created as well adding `#1234` to the description. We will assign the pull request to 2-3 people for review before it is merged.

LICENSE.txt LICENSELICENSE.txt renamed to LICENSE

@@ -79,4 +79,5 @@ END OF TERMS AND CONDITIONS
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.
+   

README.md

@@ -6,8 +6,8 @@ Note: the root folder of this module contains no Terraform code: it groups toget
 
 The file and directory layout follows the [Terraform Standard Module Structure](https://www.terraform.io/docs/modules/structure.html):
 
-* [modules](https://github.com/kral2/terraform-oci-iam/tree/master/modules) folder contains several standalone, reusable, submodules for creating IAM resources in Oracle Cloud Infrastructure,
-* [examples](https://github.com/kral2/terraform-oci-iam/tree/master/examples) folder contains fully-functional examples that you can copy and paste "as is" to have a first look at the submodules capabilities.
+* [modules](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/modules) folder contains several standalone, reusable, submodules for creating IAM resources in Oracle Cloud Infrastructure,
+* [examples](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/examples) folder contains fully-functional examples that you can copy and paste "as is" to have a first look at the submodules capabilities.
 
 ## Maintainers
 
@@ -53,7 +53,7 @@ The first OCI Terraform provider version to work with Terraform v0.12 is provide
 
 The diagram below summarizes the required components and their respective versions to use this module.
 
-![versions](https://github.com/kral2/terraform-oci-iam/blob/master/docs/diagrams/versions.svg?raw=true&sanitize=true)
+![versions](https://github.com/oracle-terraform-modules/terraform-oci-iam/blob/master/docs/diagrams/versions.svg?raw=true&sanitize=true)
 
 To enforce versions compatibility of both Terraform and the OCI provider, your root configuration should ideally include this block in main.tf for version pinning:
 
@@ -79,7 +79,7 @@ You should always pin the version of this module in your configuration: add the
 ```HCL
 module "iam" {
   source  = "oracle-terraform-modules/iam/oci"
-  version = "2.1.1"
+  version = "2.0.0"
 }
 ```
 
@@ -98,11 +98,11 @@ Note:
 - *When using the oci-iam modules, or more generally when manipulating iam resources, **be sure to configure your oci provider to use the tenancy's home region**, as IAM resources can only be managed from the home region.*
 - To combine this template with non-iam resources provisioned in a region different from your *home region*, you will need to use [provider aliases](https://www.terraform.io/docs/configuration/providers.html#alias-multiple-provider-configurations).
 
-The available submodules are listed below with example block codes. For fully-functional examples, please see [examples](https://github.com/kral2/terraform-oci-iam/tree/master/examples).
+The available submodules are listed below with example block codes. For fully-functional examples, please see [examples](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/examples).
 
 ### Declaring OCI Compartments with iam-compartment
 
-See a basic example below and [the iam-compartment readme](https://github.com/kral2/terraform-oci-iam/tree/master/modules/iam-compartment) for details.
+See a basic example below and [the iam-compartment readme](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/modules/iam-compartment) for details.
 
 * To create a compartment at the root level of the tenancy, insert this block in your root configuration:
 
@@ -134,14 +134,14 @@ module "iam_subcompartment" {
 
 ### Declaring a list of OCI Users with iam-user
 
-See a basic example below and [the iam-user readme](https://github.com/kral2/terraform-oci-iam/tree/master/modules/iam-user) for details.
+See a basic example below and [the iam-user readme](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/modules/iam-user) for details.
 
 * To create a list of users, insert this block in your root configuration:
 
 ```HCL
 module "iam_users" {
   source          = "oracle-terraform-modules/iam/oci//modules/iam-user"
-  version         = "2.1.1"
+  version         = "2.0.0"
   tenancy_ocid    = var.tenancy_ocid # required
   users           = [ # a list of users
     { # user1
@@ -165,14 +165,14 @@ module "iam_users" {
 
 ### Declaring OCI Groups with iam-group
 
-See a basic example below and [the iam-group readme](https://github.com/kral2/terraform-oci-iam/tree/master/modules/iam-group) for details.
+See a basic example below and [the iam-group readme](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/modules/iam-group) for details.
 
 * To create a group, add previously declared users as members and create an IAM policy in the previously declared compartment, insert this block in your root configuration:
 
 ```HCL
 module "iam_group" {
   source                = "oracle-terraform-modules/iam/oci//modules/iam-group"
-  version         = "2.1.1"
+  version         = "2.0.0"
   tenancy_ocid          = var.tenancy_ocid # required
   group_name            = "tf_example_group"  # required
   group_description     = "an example group - terraformed"  # required
@@ -189,7 +189,7 @@ module "iam_group" {
 
 ### Declaring OCI Dynamic Groups with iam-dynamic-group
 
-See a basic example below and [the iam-dynamic-group readme](https://github.com/kral2/terraform-oci-iam/tree/master/modules/iam-dynamic-groupd) for details.
+See a basic example below and [the iam-dynamic-group readme](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/modules/iam-dynamic-group) for details.
 
 * To create a dynamic group with a matching rule, and create an IAM policy in the previously declared compartment, insert this block in your root configuration:
 
@@ -213,10 +213,12 @@ module "iam_dynamic_group" {
 
 This project is open source. Oracle appreciates any contributions that are made by the open source community.
 
+Learn how to [contribute](https://github.com/oracle-terraform-modules/terraform-oci-iam/blob/master/CONTRIBUTING.md).
+
 ## License
 
 Copyright (c) 2018, 2021, Oracle and/or its affiliates.
 
 Licensed under the Universal Permissive License 1.0 or Apache License 2.0.
 
-See [LICENSE](https://github.com/oracle-terraform-modules/terraform-oci-iam/blob/master/LICENSE.txt) for more details.
+See [LICENSE](https://github.com/oracle-terraform-modules/terraform-oci-iam/blob/master/LICENSE) for more details.

modules/iam-compartment/README.md

@@ -38,7 +38,7 @@ module "iam_subcompartment" {
 }
 ```
 
-Check out the [examples](https://github.com/kral2/terraform-oci-iam/tree/master/examples) for fully-working sample code.
+Check out the [examples](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/examples) for fully-working sample code.
 
 Note the following parameters:
 

modules/iam-dynamic-group/README.md

@@ -18,7 +18,7 @@ module "iam_dynamic_group" {
 }
 ```
 
-Check out the [examples](https://github.com/kral2/terraform-oci-iam/tree/master/examples) for fully-working sample code.
+Check out the [examples](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/examples) for fully-working sample code.
 
 Note the following parameters:
 

modules/iam-group/README.md

@@ -25,7 +25,7 @@ module "iam_group" {
 }
 ```
 
-Check out the [examples](https://github.com/kral2/terraform-oci-iam/tree/master/examples) folder for fully-working sample code.
+Check out the [examples](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/examples) folder for fully-working sample code.
 
 Note the following parameters:
 

modules/iam-user/README.md

@@ -31,7 +31,7 @@ module "iam_users" {
 }
 ```
 
-Check out the [examples](https://github.com/kral2/terraform-oci-iam/tree/master/examples) folder for fully-working sample code.
+Check out the [examples](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/examples) folder for fully-working sample code.
 
 Note the following parameters for the module: