Skip to content

Commit f5af98f

Browse files
authored
alignment for OCI Landing Zones (#35)
Updated [MD files](https://github.com/oracle/template-repo) for aligning [OCI Landing Zones](https://github.com/oci-landing-zones) requirements
1 parent 8d9da1a commit f5af98f

File tree

5 files changed

+129
-52
lines changed

5 files changed

+129
-52
lines changed

CONTRIBUTING.md

+36-20
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,50 @@
1-
# Contributing
1+
# Contributing to this repository
22

3-
Oracle welcomes contributions to this repository from anyone.
3+
We welcome your contributions! There are multiple ways to contribute.
44

5-
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.
5+
## Opening issues
66

7-
If you have any questions about a possible submission, feel free to open an issue too.
7+
For bugs or enhancement requests, please file a GitHub issue unless it's
8+
security related. When filing a bug remember that the better written the bug is,
9+
the more likely it is to be fixed. If you think you've found a security
10+
vulnerability, do not raise a GitHub issue and follow the instructions in our
11+
[security policy](./SECURITY.md).
812

9-
## Contributing to the repository
13+
## Contributing code
1014

11-
Pull requests can be made under [The Oracle Contributor Agreement](https://oca.opensource.oracle.com/).
15+
We welcome your code contributions. Before submitting code via a pull request,
16+
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
17+
your commits need to include the following line using the name and e-mail
18+
address you used to sign the OCA:
1219

13-
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.
14-
15-
```
20+
```text
1621
Signed-off-by: Your Name <[email protected]>
1722
```
1823

19-
This can be automatically added to pull requests by committing with:
24+
This can be automatically added to pull requests by committing with `--sign-off`
25+
or `-s`, e.g.
2026

27+
```shell
28+
git commit --signoff
2129
```
22-
git commit --signoff
23-
```
2430

25-
Only pull requests from committers that can be verified as having
26-
signed the OCA can be accepted.
31+
Only pull requests from committers that can be verified as having signed the OCA
32+
can be accepted.
33+
34+
## Pull request process
35+
36+
1. Ensure there is an issue created to track and discuss the fix or enhancement you intend to submit.
37+
2. Fork this repository.
38+
3. 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`.
39+
4. Ensure that any documentation is updated with the changes that are required by your change.
40+
5. Ensure that any samples are updated if the base image has been changed.
41+
6. 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.
42+
7. We will assign the pull request to 2-3 people for review before it is merged.
43+
44+
## Code of conduct
2745

28-
### Pull request process
46+
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
47+
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
2948

30-
1. Fork this repository
31-
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`
32-
1. Ensure that any documentation is updated with the changes that are required by your fix.
33-
1. Ensure that any samples are updated if the base image has been changed.
34-
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. We will assign the pull request to 2-3 people for review before it is merged.
49+
[OCA]: https://oca.opensource.oracle.com
50+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

LICENSE

-27
This file was deleted.

LICENSE.txt

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Copyright (c) 2024 Oracle and/or its affiliates.
2+
3+
The Universal Permissive License (UPL), Version 1.0
4+
5+
Subject to the condition set forth below, permission is hereby granted to any
6+
person obtaining a copy of this software, associated documentation and/or data
7+
(collectively the "Software"), free of charge and under any and all copyright
8+
rights in the Software, and any and all patent rights owned or freely
9+
licensable by each licensor hereunder covering either (i) the unmodified
10+
Software as contributed to or provided by such licensor, or (ii) the Larger
11+
Works (as defined below), to deal in both
12+
13+
(a) the Software, and
14+
(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
15+
one is included with the Software (each a "Larger Work" to which the Software
16+
is contributed by such licensors),
17+
18+
without restriction, including without limitation the rights to copy, create
19+
derivative works of, display, perform, and distribute the Software and make,
20+
use, sell, offer for sale, import, export, have made, and have sold the
21+
Software and the Larger Work(s), and to sublicense the foregoing rights on
22+
either these or other terms.
23+
24+
This license is subject to the following condition:
25+
The above copyright notice and either this complete permission notice or at
26+
a minimum a reference to the UPL must be included in all copies or
27+
substantial portions of the Software.
28+
29+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
31+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
32+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
33+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
34+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35+
SOFTWARE.

README.md

+20-5
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ These module automates the provisioning of components for running Oracle Databas
5353
You must [authenticate to your oci tenancy](https://docs.oracle.com/en-us/iaas/tools/oci-cli/3.43.1/oci_cli_docs/cmdref/session/authenticate.html) with config auth profile as `<MY_PROFILE_NAME>`. All available OCI regions are defined in [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm#top).
5454

5555
``` shell
56-
oci session authenticate --region=<MY_REGION_IDENTIFIERr> --profile_name=<MY_PROFILE_NAME>
56+
oci session authenticate --region=<MY_REGION_IDENTIFIER> --profile-name=<MY_PROFILE_NAME>
5757
```
5858

5959
Example:
6060

6161
``` shell
62-
oci session authenticate --region=us-ashburn-1 --profile_name=ONBOARDING
62+
oci session authenticate --region=us-ashburn-1 --profile-name=ONBOARDING
6363
```
6464

6565
### AZ Authentication
@@ -164,17 +164,32 @@ tofu destroy
164164

165165
## Further Documentation
166166

167-
- [Terraform OCI Provider](https://www.terraform.io/docs/providers/oci/index.html)
167+
### Terraform Provider
168168
- [Oracle Cloud Infrastructure Provider](https://registry.terraform.io/providers/oracle/oci/latest/docs)
169169
- [Azure Active Directory Provider](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs)
170170
- [Azure Provider](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs)
171+
- [AzAPI Provider](https://registry.terraform.io/providers/Azure/azapi/latest/docs)
172+
173+
### Terraform Modules
174+
- [Azure Verified Modules](https://azure.github.io/Azure-Verified-Modules/indexes/terraform/)
175+
- [OCI Landing Zones](https://github.com/oci-landing-zones/)
171176

172177
**Acknowledgement:** Code derived adapted from samples, examples and documentations provided by above mentioned providers.
173178

179+
## Help
180+
181+
Open an issue in this repository.
182+
174183
## Contributing
175184

176-
Learn how to [contribute](./CONTRIBUTING.md).
185+
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md).
186+
187+
## Security
188+
189+
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process.
177190

178191
## License
179192

180-
Copyright (c) 2017, 2024 Oracle Corporation and/or its affiliates. Licensed under the [Universal Permissive License 1.0](./LICENSE) as shown at [https://oss.oracle.com/licenses/upl](https://oss.oracle.com/licenses/upl/).
193+
Copyright (c) 2024 Oracle and/or its affiliates.
194+
195+
Released under the Universal Permissive License v1.0 as shown at <https://oss.oracle.com/licenses/upl/>.

SECURITY.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Reporting security vulnerabilities
2+
3+
Oracle values the independent security research community and believes that
4+
responsible disclosure of security vulnerabilities helps us ensure the security
5+
and privacy of all our users.
6+
7+
Please do NOT raise a GitHub Issue to report a security vulnerability. If you
8+
believe you have found a security vulnerability, please submit a report to
9+
[[email protected]][1] preferably with a proof of concept. Please review
10+
some additional information on [how to report security vulnerabilities to Oracle][2].
11+
We encourage people who contact Oracle Security to use email encryption using
12+
[our encryption key][3].
13+
14+
We ask that you do not use other channels or contact the project maintainers
15+
directly.
16+
17+
Non-vulnerability related security issues including ideas for new or improved
18+
security features are welcome on GitHub Issues.
19+
20+
## Security updates, alerts and bulletins
21+
22+
Security updates will be released on a regular cadence. Many of our projects
23+
will typically release security fixes in conjunction with the
24+
Oracle Critical Patch Update program. Additional
25+
information, including past advisories, is available on our [security alerts][4]
26+
page.
27+
28+
## Security-related information
29+
30+
We will provide security related information such as a threat model, considerations
31+
for secure use, or any known security issues in our documentation. Please note
32+
that labs and sample code are intended to demonstrate a concept and may not be
33+
sufficiently hardened for production use.
34+
35+
[1]: mailto:[email protected]
36+
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
37+
[3]: https://www.oracle.com/security-alerts/encryptionkey.html
38+
[4]: https://www.oracle.com/security-alerts/

0 commit comments

Comments
 (0)