Skip to content

Commit 963da7b

Browse files
authored
added README in markdown format (#41)
Signed-off-by: Ali Mukadam <[email protected]>
1 parent 515d6a8 commit 963da7b

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

README.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Terraform Base for Oracle Cloud Infrastructure
2+
3+
[changelog]: https://github.com/oracle/terraform-oci-base/CHANGELOG.adoc
4+
[contributing]: https://github.com/oracle/terraform-oci-base/CONTRIBUTING.adoc
5+
[contributors]: https://github.com/oracle/terraform-oci-base/CONTRIBUTORS.adoc
6+
[docs]: https://github.com/oracle/terraform-oci-base/docs
7+
8+
[instance_principal]: https://github.com/oracle/terraform-oci-base/docs/instanceprincipal.adoc
9+
10+
[license]: https://github.com/oracle/terraform-oci-base/docs/LICENSE
11+
[canonical_license]: https://oss.oracle.com/licenses/upl/
12+
13+
[oci]: https://cloud.oracle.com/cloud-infrastructure
14+
[oci_documentation]: https://docs.cloud.oracle.com/iaas/Content/home.htm
15+
16+
[ons]: https://github.com/oracle/terraform-oci-base/docs/notifications.adoc
17+
[oracle]: https://www.oracle.com
18+
[prerequisites]: https://github.com/oracle/terraform-oci-base/docs/prerequisites.adoc
19+
[quickstart]: https://github.com/oracle/terraform-oci-base/docs/quickstart.adoc
20+
[repo]: https://github.com/oracle/terraform-oci-base
21+
[reuse]: https://github.com/oracle/terraform-oci-base/examples/db
22+
[subnets]: https://erikberg.com/notes/networks.html
23+
[terraform]: https://www.terraform.io
24+
[terraform_cidr_subnet]: http://blog.itsjustcode.net/blog/2017/11/18/terraform-cidrsubnet-deconstructed/
25+
[terraform_hashircorp_examples]: https://github.com/hashicorp/terraform-guides/tree/master/infrastructure-as-code/terraform-0.12-examples
26+
[terraform_oci]: https://www.terraform.io/docs/providers/oci/index.html
27+
[terraform_options]: https://github.com/oracle/terraform-oci-base/docs/terraformoptions.adoc
28+
[terraform_oci_examples]: https://github.com/terraform-providers/terraform-provider-oci/tree/master/examples
29+
[terraform_oci_oke]: https://github.com/oracle-terraform-modules/terraform-oci-oke
30+
31+
The [Terraform OCI Base module][repo] for [Oracle Cloud Infrastructure (OCI)][oci] provides a reusable [Terraform][terraform] module that provisions a minimal infrastructure on OCI.
32+
33+
It creates the following resources:
34+
35+
* A VCN, along with optional NAT, Internet and service gateways
36+
* An optional bastion host
37+
* An optional private admin host where privileged actions can be performed
38+
39+
The module can be reused to create more advanced infrastructure on [OCI][oci] either manually in the OCI Console or by extending the Terraform code.
40+
41+
## [Documentation][docs]
42+
43+
### [Pre-requisites][prerequisites]
44+
45+
#### Instructions
46+
- [Provisioning a basic infrastructure (Quickstart)][quickstart]
47+
- [Reusing as a Terraform module][reuse]
48+
- [Enabling instance_principal][instance_principal]
49+
- [Using ONS Notification][ons]
50+
- [Terraform Options][terraform_options]
51+
52+
## Related Documentation, Blog
53+
- [Oracle Cloud Infrastructure Documentation][oci_documentation]
54+
- [Terraform OCI Provider Documentation][terraform_oci]
55+
- [Erik Berg on Networks, Subnets and CIDR][subnets]
56+
- [Lisa Hagemann on Terraform cidrsubnet Deconstructed][terraform_cidr_subnet]
57+
58+
## Projects using this module
59+
- [terraform-oci-oke][terraform_oci_oke]
60+
61+
## Changelog
62+
63+
View the [CHANGELOG][changelog].
64+
65+
## Acknowledgement
66+
67+
Code derived and adapted from [Terraform OCI Examples][terraform_oci_examples] and Hashicorp's [Terraform 0.12 examples][terraform_oci_examples]
68+
69+
## Contributors
70+
71+
[Folks who contributed with explanations, code, feedback, ideas, testing etc.][contributors]
72+
73+
Learn how to [contribute][contributing].
74+
75+
== License
76+
77+
Copyright &copy; 2019 Oracle and/or its associates. All rights reserved.
78+
79+
Licensed under the [Universal Permissive License 1.0][license] as shown at
80+
[https://oss.oracle.com/licenses/upl][canonical_license].
81+

0 commit comments

Comments
 (0)