renamed remaining control variables (#42)

* renamed remaining control variables

Signed-off-by: Ali Mukadam <[email protected]>

* renamed variables, fix typos, removed locl file, updated docs

Author: hyder

.gitignore

@@ -8,6 +8,8 @@
 # .tfvars files
 *.tfvars
 
+.terraform.lock.hcl
+
 # provider file for testing - should be manually added
 provider.tf
 

CHANGELOG.adoc

@@ -10,6 +10,9 @@ The format is based on {uri-changelog}[Keep a Changelog].
 = Unreleased
 
 == New features
+* Changed default tag values
+* Renamed notification variables
+* Renamed variable operating_system_version --> operator_os_version
 * Renamed variable operator_upgrade --> upgrade_operator
 * Renamed variable timezone --> operator_timezone
 * Added support for Bastion service

README.adoc

@@ -6,8 +6,8 @@
 :uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-operator
 :uri-bastion-repo: https://github.com/oracle-terraform-modules/terraform-oci-bastion
 
-:uri-rel-file-base: link:{uri-repo}/blob/master
-:uri-rel-tree-base: link:{uri-repo}/tree/master
+:uri-rel-file-base: link:{uri-repo}/blob/main
+:uri-rel-tree-base: link:{uri-repo}/tree/main
 
 :uri-docs: {uri-rel-file-base}/docs
 
@@ -38,12 +38,14 @@ The {uri-repo}[Terraform OCI Operator] for {uri-oci}[Oracle Cloud Infrastructure
 
 It creates the following resources:
 
-* A security list to allow ssh access from within the VCN only
 * A private subnet
-* A compute instance with optional instance_principal access
+* An NSG that allows access only through a bastion host
+* A compute instance:
+** accessible through the OCI Bastion Service
+** with optional instance_principal access
 * An optional notification via email
 
-This module is primarily meant to be reusable and the operator instance is used for:
+This module is meant to be reusable and to be embedded in your terraform modules. The operator instance is used for:
 
 1. performing post-provisioning tasks with Terraform or other automation tools
 2. provide administrators access without the need to upload api authentication keys (instance_principal)

README.md

@@ -1,41 +1,43 @@
 # Terraform OCI Operator for Oracle Cloud Infrastructure
 
-[changelog]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/master/CHANGELOG.adoc
-[contributing]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/master/CONTRIBUTING.adoc
-[contributors]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/master/CONTRIBUTORS.adoc
-[docs]: https://github.com/oracle-terraform-modules/terraform-oci-operator/tree/master/docs
+[changelog]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/main/CHANGELOG.adoc
+[contributing]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/main/CONTRIBUTING.adoc
+[contributors]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/main/CONTRIBUTORS.adoc
+[docs]: https://github.com/oracle-terraform-modules/terraform-oci-operator/tree/main/docs
 
-[license]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/master/LICENSE
+[license]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/main/LICENSE
 [canonical_license]: https://oss.oracle.com/licenses/upl/
 
 [oci]: https://cloud.oracle.com/cloud-infrastructure
 [oci_documentation]: https://docs.cloud.oracle.com/iaas/Content/home.htm
 
 [oracle]: https://www.oracle.com
-[prerequisites]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/master/docs/prerequisites.adoc
+[prerequisites]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/main/docs/prerequisites.adoc
 
-[quickstart]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/master/docs/quickstart.adoc
+[quickstart]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/main/docs/quickstart.adoc
 [repo]: https://github.com/oracle/terraform-oci-operator
 [reuse]: https://github.com/oracle/terraform-oci-operator/examples/db
 [subnets]: https://erikberg.com/notes/networks.html
 [terraform]: https://www.terraform.io
 [terraform_cidr_subnet]: http://blog.itsjustcode.net/blog/2017/11/18/terraform-cidrsubnet-deconstructed/
 [terraform_hashircorp_examples]: https://github.com/hashicorp/terraform-guides/tree/master/infrastructure-as-code/terraform-0.12-examples
 [terraform_oci]: https://www.terraform.io/docs/providers/oci/index.html
-[terraform_options]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/master/docs/terraformoptions.adoc
+[terraform_options]: https://github.com/oracle-terraform-modules/terraform-oci-operator/blob/main/docs/terraformoptions.adoc
 [terraform_oci_examples]: https://github.com/terraform-providers/terraform-provider-oci/tree/master/examples
 [terraform_oci_oke]: https://github.com/oracle-terraform-modules/terraform-oci-oke
 
 The [Terraform OCI Operator][repo] for [Oracle Cloud Infrastructure] (OCI)[oci] provides a Terraform module that reuses an existing VCN and adds a compute instance to it.
 
 It creates the following resources:
 
-* A security list to allow ssh access from within the VCN only
 * A private subnet
-* A compute instance with optional instance_principal access
+* An NSG that allows access only through a bastion host
+* A compute instance:
+  - accessible through the OCI Bastion Service
+  - with optional instance_principal access
 * An optional notification via email
 
-This module is primarily meant to be reusable and the operator instance is used for:
+This module is meant to be reusable and to be embedded in your terraform modules. The operator instance can be used for:
 
 1. performing post-provisioning tasks with Terraform or other automation tools
 2. provide administrators access without the need to upload api authentication keys (instance_principal)

datasources.tf

@@ -34,7 +34,7 @@ data "oci_core_vcn" "vcn" {
 data "oci_core_images" "oracle_images" {
   compartment_id           = var.compartment_id
   operating_system         = "Oracle Linux"
-  operating_system_version = var.operating_system_version
+  operating_system_version = var.operator_os_version
   shape                    = lookup(var.operator_shape, "shape", "VM.Standard.E4.Flex")
   sort_by                  = "TIMECREATED"
 

docs/instanceprincipal.adoc

@@ -6,8 +6,8 @@
 
 :uri-repo: https://github.com/oracle/terraform-oci-terraform-oci-operator
 
-:uri-rel-file-terraform-oci-operator: link:{uri-repo}/blob/master
-:uri-rel-tree-terraform-oci-operator: link:{uri-repo}/tree/master
+:uri-rel-file-terraform-oci-operator: link:{uri-repo}/blob/main
+:uri-rel-tree-terraform-oci-operator: link:{uri-repo}/tree/main
 
 :uri-docs: {uri-rel-file-terraform-oci-operator}/docs
 

docs/prerequisites.adoc

@@ -6,8 +6,8 @@
 
 :uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-operator
 
-:uri-rel-file-base: link:{uri-repo}/blob/master
-:uri-rel-tree-base: link:{uri-repo}/tree/master
+:uri-rel-file-base: link:{uri-repo}/blob/main
+:uri-rel-tree-base: link:{uri-repo}/tree/main
 
 :uri-docs: {uri-rel-file-base}/docs
 

docs/quickstart.adoc

@@ -6,8 +6,8 @@
 
 :uri-bastion: https://github.com/oracle-terraform-modules/terraform-oci-bastion
 :uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-operator
-:uri-rel-file-base: link:{uri-repo}/blob/master
-:uri-rel-tree-base: link:{uri-repo}/tree/master
+:uri-rel-file-base: link:{uri-repo}/blob/main
+:uri-rel-tree-base: link:{uri-repo}/tree/main
 :uri-docs: {uri-rel-file-base}/docs
 :uri-oci-keys: https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm
 :uri-oci-ocids: https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five
@@ -83,8 +83,8 @@ provider "oci" {
 * `operator_instance_principal`
 * `operator_shape`
 * `operator_upgrade`
-* `notification_enabled`
-* `notification_endpoint`
+* `enable_operator_notification`
+* `operator_notification_endpoint`
 
 . Run Terraform:
 

docs/terraformoptions.adoc

@@ -5,8 +5,8 @@
 :sectnums:
 :uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-operator
 
-:uri-rel-file-base: link:{uri-repo}/blob/master
-:uri-rel-tree-base: link:{uri-repo}/tree/master
+:uri-rel-file-base: link:{uri-repo}/blob/main
+:uri-rel-tree-base: link:{uri-repo}/tree/main
 
 :uri-docs: {uri-rel-file-base}/docs
 :uri-oci-region: https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm
@@ -178,7 +178,7 @@ Ensure you review the {uri-terraform-dependencies}[dependencies].
 |""
 |
 
-|`timezone`
+|`operator_timezone`
 |The preferred timezone for the operator host. {uri-timezones}[List of timezones]
 |e.g. Australia/Sydney
 |The preferred timezone for the operator host. {uri-timezones}[List of timezones]
@@ -195,22 +195,22 @@ Ensure you review the {uri-terraform-dependencies}[dependencies].
 |Values
 |Default
 
-|`notification_enabled`
+|`enable_operator_notification`
 |Whether to enable ONS notification for the operator host.
 |true/false
 |false
 
-|`notification_endpoint`
-|The subscription notification endpoint. Email address to be notified. *Required if notification_enabled = true* ..
+|`operator_notification_endpoint`
+|The subscription notification endpoint. Email address to be notified. *Required if enable_operator_notification = true* ..
 |
 |Autonomous
 
-|`notification_protocol`
+|`operator_notification_protocol`
 |The notification protocol used.
 |
 |EMAIL
 
-|`notification_topic`
+|`operator_notification_topic`
 |The name of the notification topic.
 |
 |operator
@@ -232,7 +232,7 @@ Ensure you review the {uri-terraform-dependencies}[dependencies].
 [source]
 ----
 tags = {
-    department  = "finance"
+    access      = "restricted"
     environment = "dev"
     role        = "operator"
 }

locals.tf

@@ -16,7 +16,7 @@ locals {
   operator_script_template = base64gzip(
     templatefile("${path.module}/scripts/operator.template.sh",
       {
-        ol = var.operating_system_version
+        ol = var.operator_os_version
       }
     )
   )