Reworked compute, MongoDB, DBSystems examples

Author: craigcarl-oracle

README.md

@@ -9,8 +9,11 @@ Oracle customers now have access to an enterprise class, developer friendly orch
 
 This Terraform provider is OSS, available to all OBMCS customers at no charge.
 
+## Compatibility
+The provider is compatible with Terraform .8.\*, .8.8 is recommended. .9.\* compatibility is in the works.
+
 ### Coverage
-The Terraform provider provides coverage for the entire BMC API excluding the Load Balancer Service, expected March 1 2017.  
+The Terraform provider provides coverage for the entire BMC API excluding the Load Balancer Service, expected first half of April 2017.  
 
 ## Getting started
 Be sure to read the FAQ and Writing Terraform configurations for OBMCS in [/docs](https://github.com/oracle/terraform-provider-baremetal/tree/master/docs).
@@ -42,26 +45,28 @@ Required Keys and OCIDs - https://docs.us-phoenix-1.oraclecloud.com/Content/API/
 If you primarily work in a single compartment consider exporting that compartment's OCID as well. Remember that the tenancy OCID is also the OCID of the root compartment.
 
 #### \*nix
-In your ~/.bash_profile set these variables  
-`export TF_VAR_tenancy_ocid=`  
-`export TF_VAR_user_ocid=`  
-`export TF_VAR_fingerprint=`  
-`export TF_VAR_private_key_path=<fully qualified path>`  
-`export TF_VAR_private_key_password=`  
+If your TF configurations are limited to a single compartment/user then using this `bash_profile` option will work well. For more complex environments you may want to maintain multiple sets of environment variables. [See the single-compute example for an example.](https://github.com/oracle/terraform-provider-baremetal/tree/master/docs/examples/compute/single-instance)  
 
+In your ~/.bash_profile set these variables  
+```
+export TF_VAR_tenancy_ocid=  
+export TF_VAR_user_ocid=  
+export TF_VAR_fingerprint=  
+export TF_VAR_private_key_path=<fully qualified path>`
+```
 Don't forget to `source ~/.bash_profile` once you've set these.
 
 #### Windows
-`setx TF_VAR_tenancy_ocid <value>`  
-`setx TF_VAR_user_ocid <value>`  
-`setx TF_VAR_fingerprint <value>`  
-`setx TF_VAR_private_key_path <value>`  
-`setx TF_VAR_private_key_password <value>`  
-
+```
+setx TF_VAR_tenancy_ocid <value>  
+setx TF_VAR_user_ocid <value>  
+setx TF_VAR_fingerprint <value>  
+setx TF_VAR_private_key_path <value>  
+```
 The variables won't be set for the current session, exit the terminal and reopen.
 
 ## Deploy an example configuration
-Download the [VCN example configuration.](https://github.com/oracle/terraform-provider-baremetal/tree/master/docs/examples/network/simple_vcn)  
+Download the [Single instance example.](https://github.com/oracle/terraform-provider-baremetal/tree/master/docs/examples/compute/single-instance)  
 
 Edit it to include the OCID of the compartment you want to create the VCN. Remember that the tenancy OCID is the compartment OCID of your root compartment.
 
@@ -82,7 +87,7 @@ or meet us in the OBMCS forums
 https://community.oracle.com/community/cloud_computing/bare-metal
 
 ## Known serious bugs
-None
+See [Issues.](https://github.com/oracle/terraform-provider-baremetal/issues)
 
-#### About the provider
+## About the provider
 This provider was written on behalf of Oracle by [MustWin.](http://mustwin.com/)

docs/examples/DBsystems/DBSystem.tf

@@ -0,0 +1,21 @@
+resource "baremetal_database_db_system" "TFDBNode" {
+  availability_domain = "${lookup(data.baremetal_identity_availability_domains.ADs.availability_domains[0],"name")}" 
+  compartment_id = "${var.compartment_ocid}"
+  cpu_core_count = "${var.CPUCoreCount}"
+  database_edition = "${var.DBEdition}"
+  db_home {
+    database {
+      "admin_password" = "${var.DBAdminPassword}"
+      "db_name" = "${var.DBName}"
+    }
+    db_version = "${var.DBVersion}"
+    display_name = "${var.DBDisplayName}"
+  }
+  disk_redundancy = "${var.DBDiskRedundancy}"
+  shape = "${var.DBNodeShape}"
+  subnet_id = "${var.SubnetOCID}"
+  ssh_public_keys = ["${var.ssh_private_key}"]
+  display_name = "${var.DBNodeDisplayName}"
+  domain = "${var.DBNodeDomainName}"
+  hostname = "${var.DBNodeHostName}"
+}

docs/examples/DBsystems/DBsystems.tf

@@ -0,0 +1,43 @@
+    #     ___  ____     _    ____ _     _____
+    #    / _ \|  _ \   / \  / ___| |   | ____|
+    #   | | | | |_) | / _ \| |   | |   |  _|
+    #   | |_| |  _ < / ___ | |___| |___| |___
+    #    \___/|_| \_/_/   \_\____|_____|_____|
+***
+## Manage an instance
+This example launches a Database System into an existing subnet and because it's an anti-pattern to launch an DBSystem in a subnet with Internet access, behind an existing bastion host. Database Systems don't support user-data scripts but there are still use cases where you might want to execute a script once the DBNode starts so we use the `file` and `remote-exec` provisoners to get through the bastion host and onto the instance. The configuration outputs the private IP address of the instance.
+
+### Using this example
+* Update env-var with the required information. Most examples use the same set of environment variables so you only need to do this once.
+* Source env-var -
+  * `$ . env-var`
+* Update `variables.tf` with your launch options and bastion host IP.  
+
+### Files in the configuration
+
+#### `env-vars`
+Is used to export the environmental variables used in the configuration. These are usually authentication related, be sure to exclude this file from your version control system. It's typical to keep this file outside of the configuration.
+
+Before you plan, apply, or destroy the configuration source the file -  
+`$ . env-vars`
+
+#### `DBSystem.tf`
+Defines the Database System
+
+#### `remote-exec.tf`
+Uses a `null_resource`, `file`, `remote-exec` and `depends_on` to execute a script on the instance. [More information on the remote-exec provisioner.](https://www.terraform.io/docs/provisioners/remote-exec.html)  
+
+#### `./scripts/bootstrap.sh`
+A script that gets scp'ed onto the instance then executed.  
+
+#### `variables.tf`
+Defines the variables used in the configuration
+
+#### `datasources.tf`
+Defines the datasources used in the configuration
+
+#### `outputs.tf`
+Defines the outputs of the configuration
+
+#### `provider.tf`
+Specifies and passes authentication details to the OBMCS TF provider

docs/examples/DBsystems/README.md

@@ -0,0 +1,15 @@
+# Gets a list of Availability Domains
+data "baremetal_identity_availability_domains" "ADs" {
+  compartment_id = "${var.tenancy_ocid}"
+}
+
+# Get DB node details
+data "baremetal_database_db_node" "DBNodeDetails" { 
+db_node_id = "${baremetal_database_db_system.TFDBNode.id}" 
+}
+
+# Gets the OCID of the first (default) vNIC
+data "baremetal_core_vnic" "DBNodeVnic" {
+vnic_id = "${lookup(data.baremetal_database_db_node.DBNodeDetails.vnic_id,"vnic_id")}"
+}
+

docs/examples/DBsystems/datasources.tf

@@ -0,0 +1,17 @@
+### Authentication details
+export TF_VAR_tenancy_ocid="<tenancy OCID"
+export TF_VAR_user_ocid="<user OCID>"
+export TF_VAR_fingerprint="<PEM key fingerprint>"
+export TF_VAR_private_key_path="<path to the private key that matches the fingerprint above>"
+
+### Compartment
+export TF_VAR_compartment_ocid="<compartment OCID>"
+
+### Public/private keys used on the instance
+export TF_VAR_ssh_public_key=$(cat <path to public key>)
+export TF_VAR_ssh_private_key=$(cat <path to private key>)
+
+## Specific to this example
+### Choose a subnet that exists in the AD and compartment you are launching the instance in
+export TF_VAR_SubnetOCID="<subnet>"
+

docs/examples/DBsystems/env-vars

@@ -0,0 +1,5 @@
+# Output the private IP of the instance
+
+output "DBNodePrivateIP" {
+value = ["${data.baremetal_core_vnic.DBNodeVnic.private_ip_address}"]
+}

docs/examples/DBsystems/outputs.tf

@@ -0,0 +1,6 @@
+provider "baremetal" {
+  tenancy_ocid = "${var.tenancy_ocid}"
+  user_ocid = "${var.user_ocid}"
+  fingerprint = "${var.fingerprint}"
+  private_key_path = "${var.private_key_path}"
+}

docs/examples/DBsystems/provider.tf

@@ -0,0 +1,37 @@
+resource "null_resource" "remote-exec" {
+    depends_on = ["baremetal_database_db_system.TFDBNode"]
+    provisioner "file" {
+      connection {
+        agent = false
+        timeout = "10m"
+        host = "${data.baremetal_core_vnic.DBNodeVnic.private_ip_address}"
+        user = "${var.HostUserName}"
+        private_key = "${var.ssh_private_key}"
+        # Bastion details
+        bastion_host = "${var.BastionHost}"
+        bastion_user = "${var.HostUserName}"
+        bastion_key = "${var.ssh_private_key}"        
+    }
+      source = "./scripts/bootstrap"
+      destination = "~/bootstrap.sh"
+ 
+    }    
+    
+    provisioner "remote-exec" {
+      connection {
+        agent = false
+        timeout = "10m"
+        host = "${data.baremetal_core_vnic.DBNodeVnic.private_ip_address}"
+        user = "${var.HostUserName}"
+        private_key = "${var.ssh_private_key}"
+        # Bastion details
+        bastion_host = "${var.BastionHost}"       
+        bastion_user = "${var.HostUserName}"
+        bastion_key = "${var.ssh_private_key}"
+    }
+      inline = [
+        "chmod +x ~/bootstrap.sh",
+	"~/bootstrap.sh",
+      ]
+    }
+}