Skip to content

Commit 1450fe0

Browse files
snafuzsnafuz
authored
Merge pull request #1 from snafuz/new-0
initial commit - split from terraform-oci-vcn module
2 parents 882d3cb + 9215c49 commit 1450fe0

29 files changed

+1634
-4
lines changed

‎.gitignore‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Local .terraform directories
2+
**/.terraform/*
3+
4+
# .tfstate files
5+
*.tfstate
6+
*.tfstate.*
7+
8+
# .tfvars files
9+
*.tfvars
10+
11+
# provider file for testing - should be manually added
12+
provider.tf
13+
14+
# visual code
15+
**/.vscode/*
16+
17+
# macOS related files
18+
**/.DS_Store
19+
.terraform.lock.hcl

‎CHANGELOG.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
= CHANGELOG
2+
:idprefix:
3+
:idseparator: *
4+
5+
:uri-changelog: http://keepachangelog.com/
6+
:uri-semver: https://semver.org/
7+
All notable changes to this project are documented in this file.
8+
9+
The format is based on {uri-changelog}[Keep a Changelog] and the versioning follows the {uri-semver}[Semantic Versioning 2.0.0] specification.
10+
11+
Given a version number MAJOR.MINOR.PATCH:
12+
13+
- MAJOR version when making incompatible API changes,
14+
- MINOR version when adding functionality in a backwards compatible manner,
15+
- PATCH version when making backwards compatible bug fixes.
16+
17+
18+
== v1.0.0 (not released)
19+
20+
=== Changes
21+
* First release after split from terraform-oci-vcn
22+

‎CONTRIBUTING.adoc‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
= CONTRIBUTING
2+
ifdef::env-github[]
3+
:tip-caption: :bulb:
4+
:note-caption: :information_source:
5+
:important-caption: :heavy_exclamation_mark:
6+
:caution-caption: :fire:
7+
:warning-caption: :warning:
8+
endif::[]
9+
:toc:
10+
11+
:uri-oracle-oca: https://oca.opensource.oracle.com/
12+
13+
Oracle welcomes contributions to this repository from anyone.
14+
15+
If you want to submit a pull request to fix a bug or enhance an existing
16+
feature, please first open an issue and link to that issue when you
17+
submit your pull request.
18+
19+
If you have any questions about a possible submission, feel free to open
20+
an issue too.
21+
22+
== Coding conventions
23+
24+
Be sure to check xref:docs/codingconventions.adoc[the coding conventions] of this project before starting to develop.
25+
26+
== Required documentation updates
27+
28+
The documentation for your contribution is as valuable as the code you contribute.
29+
30+
Please ensure the documentation is updated to include any new feature, functionality or fix you contribute. Including documentation changes will make the contribution process far quicker and easier (and the maintainers will love you!).
31+
32+
You should ensure that your documentation changes include the following:
33+
34+
- Add an entry that explains your fix or enhancement to the list of unreleased items in xref:CHANGELOG.adoc[CHANGELOG]. The maintainers will move your entry to the appropriate version during the release process for that version.
35+
- If your contribution provision new resources, update the README introduction section
36+
- If your contribution adds any new variables, update xref:docs/terraformoptions.adoc[docs/terraformoptions] with the variable requirements
37+
- Add your GitHub handler to xref:CONTRIBUTORS.adoc[CONTRIBUTORS] under the *CONTRIBUTORS* section
38+
-
39+
- Don't forget how important the documentation is, especially for examples: we would love it if you updated the `main.tf` and `variables.tf` in the `examples/` folder. A simple example is fine.
40+
- You should also update the code examples in link:examples/README.md[examples/README]: it contains sample code blocks that probably needs to be updated to reflect your changes
41+
42+
*Notes:*
43+
44+
- We are evaluating options to auto-document as much as possible. Tables on xref:docs/terraformoptions.adoc[docs/terraformoptions] may be the first point will we address.
45+
- Any changes made to link:README.md[README.md] must be done in xref:README.adoc[README.adoc] and vice-versa. We are also evaluating how to reduce friction here.
46+
47+
== How to contribute to this repository
48+
49+
Pull requests can be made under
50+
{uri-oracle-oca}[The Oracle Contributor Agreement (OCA)].
51+
52+
For pull requests to be accepted, the bottom of your commit message must have
53+
the following line using your name and e-mail address as it appears in the
54+
OCA Signatories list.
55+
56+
----
57+
Signed-off-by: Your Name <[email protected]>
58+
----
59+
60+
This can be automatically added to pull requests by committing with:
61+
62+
----
63+
git commit --signoff
64+
----
65+
66+
Only pull requests from committers that can be verified as having
67+
signed the OCA can be accepted.
68+
69+
=== Pull request process
70+
71+
. Fork this repository
72+
. Create a branch in your fork to implement the changes. We recommend using
73+
the issue number as part of your branch name, e.g. `1234-fixes`
74+
. Ensure that any documentation is updated with the changes that are required
75+
by your fix.
76+
. Ensure that any samples are updated to reflect your new features.
77+
. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
78+
what your changes are meant to do and provide simple steps on how to validate
79+
your changes. Ensure that you reference the issue you created as well.
80+
81+
We will assign the pull request to 2-3 people for review before it is merged. Please engage with the maintainer if there is a clarification request and change suggestion. Pull Request with no follow-up from the creator will be closed.

‎CONTRIBUTORS.adoc‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
== GitHub userids of contributors
2+
3+
=== Maintainers
4+
5+
_maintainers have admin access and can merge code to main_
6+
7+
- https://github.com/hyder[@hyder]
8+
- https://github.com/snafuz[@snafuz]
9+
10+
=== CONTRIBUTORS
11+
12+

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2019, 2021 Oracle and/or its affiliates.
1+
Copyright (c) 2022 Oracle and/or its affiliates.
22

33
The Universal Permissive License (UPL), Version 1.0
44

‎README.adoc‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
= Terraform Dynamic Routing Gateway for Oracle Cloud Infrastructure
2+
3+
:idprefix:
4+
:idseparator: -
5+
6+
:uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-drg
7+
8+
:uri-rel-file-base: link:{uri-repo}/blob/main
9+
:uri-rel-tree-base: link:{uri-repo}/tree/main
10+
11+
:uri-docs: {uri-rel-file-base}/docs
12+
13+
:uri-changelog: {uri-rel-file-base}/CHANGELOG.adoc
14+
15+
:uri-contribute: {uri-rel-file-base}/CONTRIBUTING.adoc
16+
:uri-contributors: {uri-rel-file-base}/CONTRIBUTORS.adoc
17+
18+
:uri-license: {uri-rel-file-base}/LICENSE
19+
:uri-canonical-license: https://oss.oracle.com/licenses/upl/
20+
:uri-oci: https://cloud.oracle.com/cloud-infrastructure
21+
:uri-oci-documentation: https://docs.cloud.oracle.com/iaas/Content/home.htm
22+
:uri-oracle: https://www.oracle.com
23+
:uri-prereqs: {uri-docs}/prerequisites.adoc
24+
:uri-quickstart: {uri-docs}/quickstart.adoc
25+
:uri-reuse-module: {uri-rel-tree-base}/examples/
26+
:uri-terraform: https://www.terraform.io
27+
:uri-terraform-hashicorp-examples: https://github.com/hashicorp/terraform-guides/tree/master/infrastructure-as-code/terraform-0.12-examples
28+
:uri-terraform-oci: https://www.terraform.io/docs/providers/oci/index.html
29+
:uri-terraform-options: {uri-docs}/terraformoptions.adoc
30+
:uri-terraform-oci-examples: https://github.com/terraform-providers/terraform-provider-oci/tree/master/examples
31+
32+
The {uri-repo}[Terraform DRG] for {uri-oci}[Oracle Cloud Infrastructure] (OCI) provides a reusable Terraform module that provisions a minimal Dynamic Routing Gateway (DRG) on OCI.
33+
34+
It creates the following resources:
35+
36+
* A DRG attached to one or more customizable VCNs
37+
* An optional Remote Peering Connection (RPC)
38+
39+
40+
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.
41+
42+
== {uri-docs}[Documentation]
43+
44+
* {uri-prereqs}[Pre-requisites]
45+
46+
* Instructions
47+
** {uri-quickstart}[Quickstart]
48+
** {uri-reuse-module}[Reusing as a Terraform module]
49+
* {uri-terraform-options}[Terraform Options]
50+
51+
== Related Documentation, Blog
52+
* {uri-oci-documentation}[Oracle Cloud Infrastructure Documentation]
53+
* {uri-terraform-oci}[Terraform OCI Provider Documentation]
54+
55+
== Projects using this module
56+
57+
== Changelog
58+
59+
View the {uri-changelog}[CHANGELOG].
60+
61+
== Acknowledgement
62+
63+
Code derived and adapted from {uri-terraform-oci-examples}[Terraform OCI Examples] and Hashicorp's {uri-terraform-hashicorp-examples}[Terraform examples]
64+
65+
== Contributors
66+
67+
{uri-contributors}[Folks who contributed with explanations, code, feedback, ideas, testing etc.]
68+
69+
Learn how to {uri-contribute}[contribute].
70+
71+
== License
72+
73+
Copyright &copy; 2022 Oracle and/or its associates.
74+
75+
Licensed under the {uri-license}[Universal Permissive License 1.0] as shown at
76+
{uri-canonical-license}[https://oss.oracle.com/licenses/upl].

‎README.md‎

Lines changed: 71 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,79 @@
11
# Terraform Dynamic Routing Gateway for Oracle Cloud Infrastructure
22

3-
The Terraform DRG for Oracle Cloud Infrastructure provides a reusable Terraform module that provisions a minimal Dynamic Routing Gateway (DRG) on OCI.
3+
The [Terraform DRG][repo] for [Oracle Cloud Infrastructure][OCI] provides a reusable [Terraform][terraform] module that provisions a minimal Dynamic Routing Gateway (DRG) on OCI.
44

55
It creates the following resources:
66

77
* A DRG attached to one or more customizable VCNs
8-
* An optional Remote Peering Gateway (RPC) internet gateway and a route table
8+
* An optional Remote Peering Connection (RPC)
99

1010

11-
This module is primarily meant to be reusable to create more advanced infrastructure on OCI either manually in the OCI Console or by extending the Terraform code.
11+
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.
12+
13+
## [Documentation][docs]
14+
15+
### [Pre-requisites][prerequisites]
16+
17+
#### Instructions
18+
19+
* [Quickstart][quickstart]
20+
* [Reusing as a Terraform module][reuse]
21+
* [Terraform Options][terraform_options]
22+
23+
## Related Documentation, Blog
24+
25+
* [Oracle Cloud Infrastructure Documentation][oci_documentation]
26+
* [Terraform OCI Provider Documentation][terraform_oci]
27+
* [Erik Berg on Networks, Subnets and CIDR][subnets]
28+
* [Lisa Hagemann on Terraform cidrsubnet Deconstructed][terraform_cidr_subnet]
29+
30+
## Projects using this module
31+
32+
## Changelog
33+
34+
View the [CHANGELOG][changelog].
35+
36+
## Acknowledgement
37+
38+
Code derived and adapted from [Terraform OCI Examples][terraform_oci_examples] and Hashicorp's [Terraform examples][terraform_oci_examples]
39+
40+
## Contributors
41+
42+
[Folks who contributed with explanations, code, feedback, ideas, testing etc.][contributors]
43+
44+
Learn how to [contribute][contributing].
45+
46+
## License
47+
48+
Copyright (c) 2022 Oracle and/or its associates.
49+
50+
Licensed under the [Universal Permissive License 1.0][license] as shown at
51+
[https://oss.oracle.com/licenses/upl][canonical_license].
52+
53+
<!-- Links reference section -->
54+
[changelog]: https://github.com/oracle-terraform-modules/terraform-oci-drg/blob/main/CHANGELOG.adoc
55+
[contributing]: https://github.com/oracle-terraform-modules/terraform-oci-drg/blob/main/CONTRIBUTING.adoc
56+
[contributors]: https://github.com/oracle-terraform-modules/terraform-oci-drg/blob/main/CONTRIBUTORS.adoc
57+
[docs]: https://github.com/oracle-terraform-modules/terraform-oci-drg/tree/main/docs
58+
59+
[license]: https://github.com/oracle-terraform-modules/terraform-oci-drg/blob/main/LICENSE
60+
[canonical_license]: https://oss.oracle.com/licenses/upl/
61+
62+
[oci]: https://cloud.oracle.com/cloud-infrastructure
63+
[oci_documentation]: https://docs.cloud.oracle.com/iaas/Content/home.htm
64+
65+
[oracle]: https://www.oracle.com
66+
[prerequisites]: https://github.com/oracle-terraform-modules/terraform-oci-drg/blob/main/docs/prerequisites.adoc
67+
68+
[quickstart]: https://github.com/oracle-terraform-modules/terraform-oci-drg/blob/main/docs/quickstart.adoc
69+
[repo]: https://github.com/oracle/terraform-oci-drg
70+
[reuse]: https://github.com/oracle/terraform-oci-drg/examples/db
71+
[subnets]: https://erikberg.com/notes/networks.html
72+
[terraform]: https://www.terraform.io
73+
[terraform_cidr_subnet]: http://blog.itsjustcode.net/blog/2017/11/18/terraform-cidrsubnet-deconstructed/
74+
[terraform_hashircorp_examples]: https://github.com/hashicorp/terraform-guides/tree/master/infrastructure-as-code/terraform-0.12-examples
75+
[terraform_oci]: https://www.terraform.io/docs/providers/oci/index.html
76+
[terraform_options]: https://github.com/oracle-terraform-modules/terraform-oci-drg/blob/main/docs/terraformoptions.adoc
77+
[terraform_oci_examples]: https://github.com/terraform-providers/terraform-provider-oci/tree/master/examples
78+
[terraform_oci_oke]: https://github.com/oracle-terraform-modules/terraform-oci-oke
79+
<!-- Links reference section -->

0 commit comments

Comments
 (0)