diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e774914..637430b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,23 +1,55 @@ -# Contributing to the CIS OCI Terraform Modules +# Contributing to this repository -*Copyright (c) 2023, Oracle and/or its affiliates.* +We welcome your contributions! There are multiple ways to contribute. -*Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.* +## Opening issues -To post feedback, submit feature ideas or report bugs, please use the Issues section in this repository. +For bugs or enhancement requests, please file a GitHub issue unless it's +security related. When filing a bug remember that the better written the bug is, +the more likely it is to be fixed. If you think you've found a security +vulnerability, do not raise a GitHub issue and follow the instructions in our +[security policy](./SECURITY.md). -Pull requests can be made under [The Oracle Contributor Agreement](https://oca.opensource.oracle.com/) (OCA). +## Contributing code -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. +We welcome your code contributions. Before submitting code via a pull request, +you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and +your commits need to include the following line using the name and e-mail +address you used to sign the OCA: -``` - Signed-off-by: Your Name +```text +Signed-off-by: Your Name ``` -This can be automatically added to pull requests by committing with: +This can be automatically added to pull requests by committing with `--sign-off` +or `-s`, e.g. -```sh - git commit --signoff +```text +git commit --signoff ``` -Only pull requests from committers that can be verified as having signed the OCA can be accepted. +Only pull requests from committers that can be verified as having signed the OCA +can be accepted. + +## Pull request process + +1. Ensure there is an issue created to track and discuss the fix or enhancement + you intend to submit. +1. Fork this repository. +1. Create a branch in your 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 change. +1. Ensure that any samples are updated if the base image has been changed. +1. Submit the pull request. *Do not leave the pull request 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. +1. We will assign the pull request to 2-3 people for review before it is merged. + +## Code of conduct + +Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd +like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC]. + +[OCA]: https://oca.opensource.oracle.com +[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/ diff --git a/LICENSE b/LICENSE.txt similarity index 96% rename from LICENSE rename to LICENSE.txt index f36e4df..9880d71 100644 --- a/LICENSE +++ b/LICENSE.txt @@ -1,4 +1,4 @@ -Copyright (c) 2023 Oracle and/or its affiliates. +Copyright (c) 2023 Oracle and/or its affiliates. The Universal Permissive License (UPL), Version 1.0 @@ -32,4 +32,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +SOFTWARE. diff --git a/README.md b/README.md index 96e8560..6d02225 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CIS OCI Landing Zone Governance Modules +# OCI Landing Zones Governance Modules ![Landing Zone logo](./landing_zone_300.png) @@ -24,15 +24,26 @@ The modules in this collection are designed for flexibility, are straightforward Using these modules does not require a user extensive knowledge of Terraform or OCI resource types usage. Users declare a JSON object describing the OCI resources according to each module’s specification and minimal Terraform code to invoke the modules. The modules generate outputs that can be consumed by other modules as inputs, allowing for the creation of independently managed operational stacks to automate your entire OCI infrastructure. +## Help + +Open an [issue]() in this repository. + ## Contributing -See [CONTRIBUTING.md](./CONTRIBUTING.md). + +This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md). + +## Security + +Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process. ## License -Copyright (c) 2023, Oracle and/or its affiliates. -Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl. +Copyright (c) 2023,2024 Oracle and/or its affiliates. + +*Replace this statement if your project is not licensed under the UPL* -See [LICENSE](./LICENSE) for more details. +Released under the Universal Permissive License v1.0 as shown at +. ## Known Issues None. \ No newline at end of file diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index 4b431c5..d0f9b5d 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -1,25 +1,23 @@ -# January 15, 2024 Release Notes - 0.1.2 +# July 24, 2024 Release Notes - 0.1.3 +## Updates +1. Aligned [README.md](./README.md) structure to Oracle's GitHub organizations requirements. +# January 15, 2024 Release Notes - 0.1.2 ## New 1. A module for budgets is available. It manages budgets based on compartments or cost-tracking tags and alert messages based on specific thresholds. - -## Updated +## Updates 1. The Tags module can now declare an external dependency on IAM compartments. # July 03, 2023 Release Notes - 0.1.1 - -## Updated +## Updates 1. [Release Metadata](#0-1-1-metadata) - ### Release Metadata Managed resources are tagged with release metadata. # March 23, 2023 Release Notes - 0.1.0 - ## New 1. [Initial Release](#0-1-0-initial) - ### Initial Release Module for tags. \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..2ca8102 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,38 @@ +# Reporting security vulnerabilities + +Oracle values the independent security research community and believes that +responsible disclosure of security vulnerabilities helps us ensure the security +and privacy of all our users. + +Please do NOT raise a GitHub Issue to report a security vulnerability. If you +believe you have found a security vulnerability, please submit a report to +[secalert_us@oracle.com][1] preferably with a proof of concept. Please review +some additional information on [how to report security vulnerabilities to Oracle][2]. +We encourage people who contact Oracle Security to use email encryption using +[our encryption key][3]. + +We ask that you do not use other channels or contact the project maintainers +directly. + +Non-vulnerability related security issues including ideas for new or improved +security features are welcome on GitHub Issues. + +## Security updates, alerts and bulletins + +Security updates will be released on a regular cadence. Many of our projects +will typically release security fixes in conjunction with the +Oracle Critical Patch Update program. Additional +information, including past advisories, is available on our [security alerts][4] +page. + +## Security-related information + +We will provide security related information such as a threat model, considerations +for secure use, or any known security issues in our documentation. Please note +that labs and sample code are intended to demonstrate a concept and may not be +sufficiently hardened for production use. + +[1]: mailto:secalert_us@oracle.com +[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html +[3]: https://www.oracle.com/security-alerts/encryptionkey.html +[4]: https://www.oracle.com/security-alerts/ diff --git a/budgets/README.md b/budgets/README.md index 210d80f..b1cbbe8 100644 --- a/budgets/README.md +++ b/budgets/README.md @@ -1,4 +1,4 @@ -# CIS OCI Landing Zone Budgets Module +# OCI Landing Zones Budgets Module ![Landing Zone logo](../landing_zone_300.png) diff --git a/budgets/examples/compartment-based-budget/README.md b/budgets/examples/compartment-based-budget/README.md index 00e3f07..00fab1c 100644 --- a/budgets/examples/compartment-based-budget/README.md +++ b/budgets/examples/compartment-based-budget/README.md @@ -1,4 +1,4 @@ -# CIS OCI Budgets Module Example - Compartment Based Budget +# OCI Landing Zones Budgets Module Example - Compartment Based Budget This example shows how to manage budgets in Oracle Cloud Infrastructure using the [CIS Landing Zone Budgets module](../..). The configuration provided by this example creates a budget for a specific target compartment. The budget starts in the first day of the current month. diff --git a/budgets/examples/minimal-config-budget/README.md b/budgets/examples/minimal-config-budget/README.md index 0557643..7b836e9 100644 --- a/budgets/examples/minimal-config-budget/README.md +++ b/budgets/examples/minimal-config-budget/README.md @@ -1,4 +1,4 @@ -# CIS OCI Budgets Module Example - Minimal Configuration (Root Compartment Budget) +# OCI Landing Zones Budgets Module Example - Minimal Configuration (Root Compartment Budget) This example shows how to manage budgets in Oracle Cloud Infrastructure using the [CIS Landing Zone Budgets module](../..). The configuration provided by this example omits all optional attributes in the input variable. As a result, the monthly recurring budget starting in the budget create day is created for the tenancy Root compartment. diff --git a/budgets/examples/tag-based-budget/README.md b/budgets/examples/tag-based-budget/README.md index 01c15de..17ecde5 100644 --- a/budgets/examples/tag-based-budget/README.md +++ b/budgets/examples/tag-based-budget/README.md @@ -1,4 +1,4 @@ -# CIS OCI Budgets Module Example - Tag Based Budget +# OCI Landing Zones Budgets Module Example - Tag Based Budget This example shows how to manage budgets in Oracle Cloud Infrastructure using the [CIS Landing Zone Budgets module](../..). The configuration provided by this example creates a budget for a specific cost tracking tag. The budget starts in the budget creation day (as *day_of_month_to_begin* is undefined). An alert message is sent if the consumption exceeds the absolute value specified by *threshold_value* attribute. diff --git a/release.txt b/release.txt index 8294c18..7693c96 100644 --- a/release.txt +++ b/release.txt @@ -1 +1 @@ -0.1.2 \ No newline at end of file +0.1.3 \ No newline at end of file diff --git a/tags/README.md b/tags/README.md index 6bf49ec..8f97059 100644 --- a/tags/README.md +++ b/tags/README.md @@ -1,4 +1,4 @@ -# CIS OCI Landing Zone IAM Tags Module +# OCI Landing Zones Tags Module ![Landing Zone logo](../landing_zone_300.png) diff --git a/tags/examples/external-dependency/README.md b/tags/examples/external-dependency/README.md index 4e529f4..40d44fe 100644 --- a/tags/examples/external-dependency/README.md +++ b/tags/examples/external-dependency/README.md @@ -1,6 +1,6 @@ -# CIS OCI Tags Module Example - Vision Tags with External Dependencies +# OCI Landing Zones Tags Module Example - Vision Tags with External Dependencies -This example shows how to manage defined tags in Oracle Cloud Infrastructure for a hypothetical Vision entity using the [CIS Landing Zone Tags module](../..). It is functionally equivalent to the [vision example](../vision/). The difference is that it takes compartment dependencies from a file that sits in OCI Object Storage bucket. +This example shows how to manage defined tags in Oracle Cloud Infrastructure for a hypothetical Vision entity using the [OCI Landing Zones Tags module](../..). It is functionally equivalent to the [vision example](../vision/). The difference is that it takes compartment dependencies from a file that sits in OCI Object Storage bucket. As this example needs to read from an OCI Object Storage bucket, the following extra permissions are required for the executing user, in addition to the permissions required by the [tags module](../..) itself. diff --git a/tags/examples/vision/README.md b/tags/examples/vision/README.md index e5a3ed9..63a9ef6 100644 --- a/tags/examples/vision/README.md +++ b/tags/examples/vision/README.md @@ -1,6 +1,6 @@ -# CIS OCI Tags Module Example - Vision Tags +# OCI Landing Zones Tags Module Example - Vision Tags -This example shows how to manage defined tags in Oracle Cloud Infrastructure for a hypothetical Vision entity using the [CIS Landing Zone Tags module](../..). +This example shows how to manage defined tags in Oracle Cloud Infrastructure for a hypothetical Vision entity using the [OCI Landing Zones Tags module](../..). The following resources are created in this example: