|
| 1 | += Terraform OCI Operator for Oracle Cloud Infrastructure |
| 2 | + |
| 3 | +:idprefix: |
| 4 | +:idseparator: - |
| 5 | + |
| 6 | +:uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-operator |
| 7 | + |
| 8 | +:uri-rel-file-base: link:{uri-repo}/blob/master |
| 9 | +:uri-rel-tree-base: link:{uri-repo}/tree/master |
| 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-instance_principal: {uri-docs}/instanceprincipal.adoc |
| 21 | +:uri-networks-subnets-cidr: https://erikberg.com/notes/networks.html |
| 22 | +:uri-oci: https://cloud.oracle.com/cloud-infrastructure |
| 23 | +:uri-oci-documentation: https://docs.cloud.oracle.com/iaas/Content/home.htm |
| 24 | +:uri-oracle: https://www.oracle.com |
| 25 | +:uri-prereqs: {uri-docs}/prerequisites.adoc |
| 26 | +:uri-quickstart: {uri-docs}/quickstart.adoc |
| 27 | +:uri-reuse-module: {uri-rel-tree-base}/examples/ |
| 28 | +:uri-terraform: https://www.terraform.io |
| 29 | +:uri-terraform-cidrsubnet-deconstructed: http://blog.itsjustcode.net/blog/2017/11/18/terraform-cidrsubnet-deconstructed/ |
| 30 | +:uri-terraform-hashicorp-examples: https://github.com/hashicorp/terraform-guides/tree/master/infrastructure-as-code/terraform-0.12-examples |
| 31 | +:uri-terraform-oci: https://www.terraform.io/docs/providers/oci/index.html |
| 32 | +:uri-terraform-options: {uri-docs}/terraformoptions.adoc |
| 33 | +:uri-terraform-oci-examples: https://github.com/terraform-providers/terraform-provider-oci/tree/master/examples |
| 34 | + |
| 35 | +The {uri-repo}[Terraform OCI Operator] for {uri-oci}[Oracle Cloud Infrastructure] (OCI) provides a Terraform module that reuses an existing VCN and adds a compute instance to it. |
| 36 | + |
| 37 | +It creates the following resources: |
| 38 | + |
| 39 | +* A security list to allow ssh access from within the VCN only |
| 40 | +* A private subnet |
| 41 | +* A compute instance with optional instance_principal access |
| 42 | +* An optional notification via email |
| 43 | +
|
| 44 | +This module is primarily meant to be reusable and the operator instance is used for: |
| 45 | + |
| 46 | +1. performing post-provisioning tasks with Terraform or other automation tools |
| 47 | +2. provide administrators access without the need to upload api authentication keys (instance_principal) |
| 48 | +
|
| 49 | +You can further use it as part of higher level Terraform modules. |
| 50 | + |
| 51 | +== {uri-docs}[Documentation] |
| 52 | + |
| 53 | +* {uri-prereqs}[Pre-requisites] |
| 54 | + |
| 55 | +* Instructions |
| 56 | +** {uri-quickstart}[Quickstart] |
| 57 | +** {uri-reuse-module}[Reusing as a Terraform module] |
| 58 | +** {uri-instance_principal}[Instance Principal] |
| 59 | +* {uri-terraform-options}[Terraform Options] |
| 60 | + |
| 61 | +== Related Documentation, Blog |
| 62 | +* {uri-oci-documentation}[Oracle Cloud Infrastructure Documentation] |
| 63 | +* {uri-terraform-oci}[Terraform OCI Provider Documentation] |
| 64 | +* {uri-networks-subnets-cidr}[Erik Berg on Networks, Subnets and CIDR] |
| 65 | +* {uri-terraform-cidrsubnet-deconstructed}[Lisa Hagemann on Terraform cidrsubnet Deconstructed] |
| 66 | + |
| 67 | +== Projects using this module |
| 68 | + |
| 69 | +== Changelog |
| 70 | + |
| 71 | +View the {uri-changelog}[CHANGELOG]. |
| 72 | + |
| 73 | +== Acknowledgement |
| 74 | + |
| 75 | +Code derived and adapted from {uri-terraform-oci-examples}[Terraform OCI Examples] and Hashicorp's {uri-terraform-hashicorp-examples}[Terraform 0.12 examples] |
| 76 | + |
| 77 | +== Contributors |
| 78 | + |
| 79 | +{uri-contributors}[Folks who contributed with explanations, code, feedback, ideas, testing etc.] |
| 80 | + |
| 81 | +Learn how to {uri-contribute}[contribute]. |
| 82 | + |
| 83 | +== License |
| 84 | + |
| 85 | +Copyright(c) 2019,2020 Oracle and/or its associates. All rights reserved. |
| 86 | + |
| 87 | +Licensed under the {uri-license}[Universal Permissive License 1.0] as shown at |
| 88 | +{uri-canonical-license}[https://oss.oracle.com/licenses/upl]. |
0 commit comments