Merge branch '12-examples-lb' of github.com:/hyder/terraform-oci-base into hyder-12-examples-lb

Author: Djelibeybi

README.adoc

@@ -27,7 +27,7 @@
 :uri-oracle: https://www.oracle.com
 :uri-prereqs: {uri-docs}/prerequisites.adoc
 :uri-quickstart: {uri-docs}/quickstart.adoc
-:uri-reuse-module: {uri-rel-tree-base}/examples/gitlab
+:uri-reuse-module: {uri-rel-tree-base}/examples/db
 :uri-terraform: https://www.terraform.io
 :uri-terraform-cidrsubnet-deconstructed: http://blog.itsjustcode.net/blog/2017/11/18/terraform-cidrsubnet-deconstructed/
 :uri-terraform-hashircorp-examples: https://github.com/hashicorp/terraform-guides/tree/master/infrastructure-as-code/terraform-0.12-examples

datasources.tf

@@ -1,5 +1,5 @@
 # Copyright 2017, 2019, Oracle Corporation and/or affiliates.  All rights reserved.
-# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 data "oci_identity_availability_domains" "ad_list" {
   compartment_id = var.oci_base_identity.tenancy_id

docs/README.adoc

@@ -21,7 +21,7 @@
 :uri-oci-documentation: https://docs.cloud.oracle.com/iaas/Content/home.htm
 :uri-prereqs: {uri-docs}/prerequisites.adoc
 :uri-quickstart: {uri-docs}/quickstart.adoc
-:uri-reuse-module: {uri-rel-tree-base}/examples/gitlab
+:uri-reuse-module: {uri-rel-tree-base}/examples/db
 :uri-terraform-cidrsubnet-deconstructed: http://blog.itsjustcode.net/blog/2017/11/18/terraform-cidrsubnet-deconstructed/
 :uri-terraform-hashircorp-examples: https://github.com/hashicorp/terraform-guides/tree/master/infrastructure-as-code/terraform-0.12-examples
 :uri-terraform-oci: https://www.terraform.io/docs/providers/oci/index.html

docs/quickstart.adoc

@@ -11,7 +11,7 @@
 :uri-docs: {uri-rel-file-base}/docs
 :uri-instance-principal: {uri-docs}/instanceprincipal.adoc
 :uri-ons: {uri-docs}/notifcations.adoc
-:uri-reusing: {uri-rel-tree-base}/examples/gitlab
+:uri-reusing: {uri-rel-tree-base}/examples/db
 :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
 :uri-terraform: https://www.terraform.io

examples/db/README.md

@@ -0,0 +1,177 @@
+[rootvariables]:https://github.com/oracle/terraform-oci-base/blob/master/examples/db/variables.tf
+[rootlocals]:https://github.com/oracle/terraform-oci-base/blob/master/examples/db/locals.tf
+[terraformoptions]:https://github.com/oracle/terraform-oci-base/blob/master/docs/terraformoptions.adoc
+[dbvariables]:https://github.com/oracle/terraform-oci-base/blob/master/examples/db/modules/db/variables.tf
+[dbvariables]:https://github.com/oracle/terraform-oci-base/blob/master/examples/db/modules/db/security.tf
+[dbsubnet]:https://github.com/oracle/terraform-oci-base/blob/master/examples/db/modules/db/subnets.tf
+
+Example reusing terraform-oci-base and extending to create a db instance from OCI Marketplace
+
+## Create a new Terraform project
+
+As an example, we’ll be using terraform-oci-base to create an Oracle Database on OCI. The steps required are the following:
+
+1. Create a new directory for your project e.g. oracle-database
+
+2. Create the following files in root directory of your project:
+
+- variables.tf
+- locals.tf
+- provider.tf
+- main.tf
+- terraform.tfvars
+
+3. Define the oci provider
+
+```
+provider "oci" {
+  tenancy_ocid         = var.tenancy_id
+  user_ocid            = var.user_id
+  fingerprint          = var.api_fingerprint
+  private_key_path     = var.api_private_key_path
+  region               = var.region
+  disable_auto_retries = false
+}
+```
+
+4. Create the modules directory
+
+```
+mkdir modules
+cd modules
+```
+
+5. Add the terraform-oci-base module
+
+```
+git clone https://github.com/oracle/terraform-oci-base.git base
+```
+
+N.B. Cloning will be required until the module is published in Hashicorp's registry
+
+## Define project variables
+
+### Variables to reuse the base module
+
+1. Define the base parameters in the root variables.tf. You can choose to keep the same object-oriented structure like in the base’s variables.tf or keep it flat. 
+
+See [variables.tf][rootvariables] in this directory.
+
+2. Initialize the variables as in [locals.tf][rootlocals]
+
+## Define your modules
+
+1. Define the base module in root main.tf
+
+```
+module "base" {
+  source = "./modules/base"
+
+  # identity
+  oci_base_identity = local.oci_base_identity
+
+  # general oci parameters
+  oci_base_general = local.oci_base_general
+
+  # vcn parameters
+  oci_base_vcn = local.oci_base_vcn
+
+  # bastion parameters
+  oci_base_bastion = local.oci_base_bastion
+}
+```
+
+2. Enter appropriate values for terraform.tfvars. Review [Terraform Options][terraformoptions] for reference
+
+## Add your own modules
+
+1. Create your own module e.g. db. In modules directory, create a db directory:
+
+```
+mkdir db
+```
+
+2. Define the necessary variables, resources (e.g [security lists][dbvariables], [subnets][dbsubnet], [compute][dbcompute]) and [data sources][dbdatasources].
+
+3. Update the [locals.tf][[rootlocals]] to initialize the db variables
+
+4. Add the db module in the main.tf
+
+```
+module "db" {
+  source = "./modules/db"
+
+  db_identity = local.db_identity
+
+  db_ssh_keys = local.oci_base_ssh_keys
+
+  db_oci_general = local.oci_base_general
+
+  db_bastion = local.db_bastion
+
+  db_network = local.db_network
+
+  db_config = local.db_config
+}
+```
+
+5. Update your terraform variable file and add the database parameters:
+
+```
+# db
+
+db_system_shape = "VM.Standard2.8"
+
+cpu_core_count = 2
+
+db_edition = "ENTERPRISE_EDITION"
+
+db_admin_password = "BEstrO0ng_#12"
+
+db_name = "basedb"
+
+db_home_db_name = "basedb2"
+
+db_version = "19.0.0.0"
+
+db_home_display_name = "basedbhome"
+
+db_disk_redundancy = "HIGH"
+
+db_system_display_name = "basedb_system"
+
+hostname = "myoracledb"
+
+n_character_set = "AL16UTF16"
+
+character_set = "AL32UTF8"
+
+db_workload = "OLTP"
+
+pdb_name = "pdb1"
+
+data_storage_size_in_gb = 256
+
+license_model = "LICENSE_INCLUDED"
+
+node_count = 2
+
+data_storage_percentage = 40
+```
+
+## Test access to your database:
+
+1. Login to the OCI Console and note down the IP address of 1 of the database nodes.
+
+2. ssh to the Database node:
+
+```
+ssh -i </path/to/private_ssh_key> -J opc<bastion_public_ip_address> opc@<database_private_ip_address>
+```
+
+3. Login to your database:
+
+```
+sudo su - oracle
+sqlplus / as sysdba
+```

examples/db/locals.tf

@@ -0,0 +1,98 @@
+# Copyright 2017, 2019, Oracle Corporation and/or affiliates.  All rights reserved.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+locals {
+  oci_base_identity = {
+    api_fingerprint      = var.api_fingerprint
+    api_private_key_path = var.api_private_key_path
+    compartment_id       = var.compartment_id
+    tenancy_id           = var.tenancy_id
+    user_id              = var.user_id
+  }
+  oci_base_general = {
+    label_prefix = var.label_prefix
+    region       = var.region
+  }
+
+  oci_base_ssh_keys = {
+    ssh_private_key_path = var.ssh_private_key_path
+    ssh_public_key_path  = var.ssh_public_key_path
+  }
+
+  oci_base_vcn = {
+    create_nat_gateway     = var.create_nat_gateway
+    create_service_gateway = var.create_service_gateway
+    vcn_cidr               = var.vcn_cidr
+    vcn_dns_label          = var.vcn_dns_label
+    vcn_name               = var.vcn_name
+  }
+
+  oci_base_bastion = {
+    availability_domains      = var.availability_domains["bastion"]
+    bastion_access            = var.bastion_access
+    bastion_image_id          = "NONE"
+    bastion_shape             = var.bastion_shape
+    bastion_upgrade           = false
+    create_bastion            = var.create_bastion
+    enable_instance_principal = var.enable_instance_principal
+    enable_notification       = false
+    newbits                   = var.newbits["bastion"]
+    netnum                    = var.subnets["bastion"]
+    notification_endpoint     = ""
+    notification_protocol     = "EMAIL"
+    notification_topic        = "bastion"
+    ssh_private_key_path      = var.ssh_private_key_path
+    ssh_public_key_path       = var.ssh_public_key_path
+    timezone                  = "Australia/Sydney"
+    use_autonomous            = false
+  }
+
+  db_identity = {
+    compartment_id = var.compartment_id
+    tenancy_id     = var.tenancy_id
+  }
+
+  db_oci_general = {
+    ad_names            = module.base.ad_names
+    availability_domain = var.availability_domains["db"]
+    label_prefix        = var.label_prefix
+    region              = var.region
+  }
+
+  db_bastion = {
+    bastion_public_ip = module.base.bastion_public_ip
+  }
+
+  db_network = {
+    ig_route_id                = module.base.ig_route_id
+    is_service_gateway_enabled = var.create_service_gateway
+    nat_route_id               = module.base.nat_route_id
+    newbits                    = var.newbits
+    subnets                    = var.subnets
+    vcn_cidr                   = var.vcn_cidr
+    vcn_id                     = module.base.vcn_id
+  }
+
+  db_config = {
+    db_system_shape         = var.db_system_shape
+    cpu_core_count          = var.cpu_core_count
+    db_edition              = var.db_edition
+    db_admin_password       = var.db_admin_password
+    db_name                 = var.db_name
+    db_home_db_name         = var.db_home_db_name
+    db_version              = var.db_version
+    db_home_display_name    = var.db_home_display_name
+    db_disk_redundancy      = var.db_disk_redundancy
+    db_system_display_name  = var.db_system_display_name
+    hostname                = var.hostname
+    n_character_set         = var.n_character_set
+    character_set           = var.character_set
+    db_workload             = var.db_workload
+    pdb_name                = var.pdb_name
+    data_storage_size_in_gb = var.data_storage_size_in_gb
+    license_model           = var.license_model
+    node_count              = var.node_count
+    data_storage_percentage = var.data_storage_percentage
+  }
+
+}

examples/gitlab/main.tf examples/db/main.tfexamples/gitlab/main.tf renamed to examples/db/main.tf

@@ -1,15 +1,12 @@
 # Copyright 2017, 2019, Oracle Corporation and/or affiliates.  All rights reserved.
-# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 module "base" {
   source = "./modules/base"
 
   # identity
   oci_base_identity = local.oci_base_identity
 
-  # ssh keys
-  oci_base_ssh_keys = local.oci_base_ssh_keys
-
   # general oci parameters
   oci_base_general = local.oci_base_general
 
@@ -20,19 +17,19 @@ module "base" {
   oci_base_bastion = local.oci_base_bastion
 }
 
-module "gitlab" {
-  source = "./modules/gitlab"
+module "db" {
+  source = "./modules/db"
 
-  gitlab_identity = local.gitlab_identity
+  db_identity = local.db_identity
 
   # since they have the same signature, we can reuse that
-  gitlab_ssh_keys = local.oci_base_ssh_keys
+  db_ssh_keys = local.oci_base_ssh_keys
 
-  gitlab_oci_general = local.oci_base_general
+  db_oci_general = local.db_oci_general
 
-  gitlab_bastion = local.gitlab_bastion
+  db_bastion = local.db_bastion
 
-  gitlab_network = local.gitlab_network
+  db_network = local.db_network
 
-  gitlab_config = local.gitlab_config
+  db_config = local.db_config
 }