removed code for building terraform oci provider, added copiright info, corrected typos

Author: marinakog

kubernetes/samples/README.md

@@ -14,7 +14,7 @@ While these samples may be useful and usable as is, it is intended that you woul
 * [Sample for creating a WebLogic domain home inside a Docker image](scripts/create-weblogic-domain/domain-home-in-image/README.md), and the domain resource YAML file for deploying the generated WebLogic domain.
 * [Sample for configuring the Elasticsearch and Kibana](scripts/elasticsearch-and-kibana/README.md) deployments and services for the operator's logs.
 * [Sample for generating a self-signed certificate and private key](scripts/rest/README.md) that can be used for the operator's external REST API.
-* [Sample for generating OKE cluster using Terraform](scripts/terraform/README.md).
+* [Sample for creating an OKE cluster using Terraform](scripts/terraform/README.md).
 
 ## Sample Helm charts
 

kubernetes/samples/scripts/terraform/README.md

@@ -1,49 +1,62 @@
-# Sample to create OKE cluster using Terraform scripts
+# Sample to create an OKE cluster using Terraform scripts
 
 The provided sample will create:
 
 	A new Virtual Cloud Network (VCN) for the cluster
 
-	2 LoadBalancer subnets with seclists
+	Two LoadBalancer subnets with security lists
 
-	3 Worker subnets with seclists
+	Three Worker subnets with security lists
 
-	A Kubernetes Cluster with one NodePool
+	A Kubernetes Cluster with one Node Pool
 
-	A kubeconfig file to allow access using kubectl
+	A `kubeconfig` file to allow access using `kubectl`
 
-Nodes and network settings will be configured to allow SSH access, and the cluster Networking policies will allow NodePort services to be exposed.
+Nodes and network settings will be configured to allow SSH access, and the cluster networking policies will allow `NodePort` services to be exposed. This cluster can be used for testing and development purposes only. The provided samples of Terraform scripts should not be considered for creating production clusters, without more of a review.
 
-By default all OCI Container Engine for Kubernetes Cluster masters are Highly Available (HA) and fronted by load balancers.
+All OCI Container Engine masters are Highly Available (HA) and fronted by load balancers.
 
 
 
-Prerequisites
+###Prerequisites
 
 To use these Terraform scripts, you will need fulfill the following prerequisites:
 
-	Have an existing tenancy with enough compute and networking resources available for the desired cluster
+	Have an existing tenancy with enough compute and networking resources available for the desired cluster.
 
-	Have an OCI Container Engine for Kubernetes policy in place within that tenancy to allow the OCI Container Engine for Kubernetes service to manage tenancy resources
+	Have an [Identity and Access Management](https://docs.cloud.oracle.com/iaas/Content/ContEng/Concepts/contengpolicyconfig.htm#PolicyPrerequisitesService) policy in place within that tenancy to allow the OCI Container Engine for Kubernetes service to manage tenancy resources.
 
-	Install Terraform with the OCI plugin as described here.
+	Have a user defined within that tenancy.
 
-	Have a user defined within that tenancy
+	Have an API key defined for use with the OCI API, as documented [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).
 
-	Have an API key defined for use with the OCI API, as documented here
+	Have an [SSH key pair](https://docs.oracle.com/en/cloud/iaas/compute-iaas-cloud/stcsg/generating-ssh-key-pair.html) for configuring SSH access to the nodes in the cluster.
 
-	Have an SSH key pair with file permission 600 ready for configuring SSH access to the nodes in the cluster
 
+Copy provided `oci.props.template` file to `oci.props` and add all required values:
+	* `user.ocid` - OCID for the tenancy user - can be obtained from the user settings in the OCI console.
+	* `tfvars.filename` - File name for generated tfvar file.
+	* `okeclustername` - The name for OCI Container Engine for Kubernetes cluster.
+	* `tenancy.ocid` - OCID for the target tenancy.
+	* `region` - name of region in the target tenancy.
+	* `compartment.ocid` - OCID for the target compartment.
+	* `compartment.name` - Name for the target compartment.
+	* `ociapi.pubkey.fingerprint` - Fingerprint of the OCI user's public key.
+	* `ocipk.path` - API Private Key -- local path to the private key for the API key pair.
+	* `vcn.cidr.prefix` - Prefix for VCN CIDR, used when creating subnets -- you should examine the target compartment find a CIDR that is available.
+	* `vcn.cidr` - Full CIDR for the VCN, must be unique within the compartment, first 2 octets should match the vcn_cidr_prefix.
+	* `nodepool.shape` - A valid OCI VM Shape for the cluster nodes.
+	* `k8s.version` - SSH public key (key contents as a string).
+	* `nodepool.imagename - A valid image name for Node Pool creation.
+	* `terraform.installdir` - Location to install Terraform binaries.
 
-Copy provided oci.props.template file to oci.props and add all required values.
-
-The syntax of the script is:
+To run the script, use the command:
 ```
 $ kubernetes/samples/scripts/terraform/oke.create.sh oci.props
 ```
-The scripts collects the values from oci.props file and performs the following steps:
-Create a new tfvars file based on the values from the provided oci.props file.
-Downloads and installs all needed binaries for Terraform, Terraform OCI Provider and Go, based on OS system ( Mac or Linux)
-Apply the configuration and creates OKE Cluster using Terraform
+The script collects the values from `oci.props` file and performs the following steps:
+	* Creates a new tfvars file based on the values from the provided `oci.props` file.
+	* Downloads and installs all needed binaries for Terraform, Terraform OCI Provider, based on OS system (macOS or Linux)
+	* Applies the configuration and creates OKE Cluster using Terraform
 
 

kubernetes/samples/scripts/terraform/cluster.tf

@@ -1,30 +1,28 @@
-variable "cluster_kubernetes_version" { default = "v1.10.3" }
+/*
+# Copyright 2018, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+*/
+variable "cluster_kubernetes_version" { default = "v1.11.5" }
 variable "cluster_name" { default = "tfTestCluster" }
 variable "cluster_options_add_ons_is_kubernetes_dashboard_enabled" { default = true }
 variable "cluster_options_add_ons_is_tiller_enabled" { default = true }
 variable "cluster_options_kubernetes_network_config_pods_cidr" { default = "10.1.0.0/16" }
 variable "cluster_options_kubernetes_network_config_services_cidr" { default = "10.2.0.0/16" }
 variable "node_pool_initial_node_labels_key" { default = "key" }
 variable "node_pool_initial_node_labels_value" { default = "value" }
-variable "node_pool_kubernetes_version" { default = "v1.10.3" }
+variable "node_pool_kubernetes_version" { default = "v1.11.5" }
 variable "node_pool_name" { default = "tfTestCluster_workers" }
 variable "node_pool_node_image_name" { default = "Oracle-Linux-7.4" }
-variable "node_pool_node_shape" { default = "VM.Standard1.1" }
+variable "node_pool_node_shape" { default = "VM.Standard2.1" }
 variable "node_pool_quantity_per_subnet" { default = 2 }
 variable "node_pool_ssh_public_key" { }
 
-data "oci_identity_availability_domains" "test_availability_domains" {
+data "oci_identity_availability_domains" "tfsample_availability_domains" {
   compartment_id = "${var.compartment_ocid}"
 }
 
-// Defined in oke.tf
-/*resource "oci_core_virtual_network" "oke-vcn" {
-  cidr_block = "${var.vcn_cidr}"
-  compartment_id = "${var.compartment_ocid}"
-  display_name = "${var.cluster_name}_vcn"
-}*/
 
-resource "oci_containerengine_cluster" "test_cluster" {
+resource "oci_containerengine_cluster" "tfsample_cluster" {
   #Required
   compartment_id = "${var.compartment_ocid}"
   kubernetes_version = "${var.cluster_kubernetes_version}"
@@ -41,17 +39,12 @@ resource "oci_containerengine_cluster" "test_cluster" {
       is_kubernetes_dashboard_enabled = "${var.cluster_options_add_ons_is_kubernetes_dashboard_enabled}"
       is_tiller_enabled = "${var.cluster_options_add_ons_is_tiller_enabled}"
     }
-    #kubernetes_network_config {
-      #Optional
-      #pods_cidr = "${var.cluster_options_kubernetes_network_config_pods_cidr}"
-      #services_cidr = "${var.cluster_options_kubernetes_network_config_services_cidr}"
-    #}
   }
 }
 
-resource "oci_containerengine_node_pool" "test_node_pool" {
+resource "oci_containerengine_node_pool" "tfsample_node_pool" {
 	#Required
-	cluster_id = "${oci_containerengine_cluster.test_cluster.id}"
+	cluster_id = "${oci_containerengine_cluster.tfsample_cluster.id}"
 	compartment_id = "${var.compartment_ocid}"
 	kubernetes_version = "${var.node_pool_kubernetes_version}"
 	name = "${var.node_pool_name}"
@@ -60,16 +53,10 @@ resource "oci_containerengine_node_pool" "test_node_pool" {
         subnet_ids = ["${oci_core_subnet.oke-subnet-worker-1.id}", "${oci_core_subnet.oke-subnet-worker-2.id}","${oci_core_subnet.oke-subnet-worker-3.id}"]
 
 	#Optional
-	#initial_node_labels {
-
-		#Optional
-	#	key = "${var.node_pool_initial_node_labels_key}"
-	#	value = "${var.node_pool_initial_node_labels_value}"
-	#}
 	quantity_per_subnet = "${var.node_pool_quantity_per_subnet}"
 	ssh_public_key = "${var.node_pool_ssh_public_key}"
 }
 
 output "cluster_id" {
-  value = "${oci_containerengine_cluster.test_cluster.id}"
+  value = "${oci_containerengine_cluster.tfsample_cluster.id}"
 }

kubernetes/samples/scripts/terraform/kube_config.tf

@@ -1,16 +1,17 @@
+/*
+# Copyright 2018, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+*/
+
 variable "cluster_kube_config_expiration" { default = 2592000 }
 variable "cluster_kube_config_token_version" { default = "1.0.0" }
 
-data "oci_containerengine_cluster_kube_config" "test_cluster_kube_config" {
+data "oci_containerengine_cluster_kube_config" "tfsample_cluster_kube_config" {
   #Required
-  cluster_id = "${oci_containerengine_cluster.test_cluster.id}"
-
-  #Optional
-  #expiration = "${var.cluster_kube_config_expiration}"
-  #token_version = "${var.cluster_kube_config_token_version}"
+  cluster_id = "${oci_containerengine_cluster.tfsample_cluster.id}"
 }
 
-resource "local_file" "test_cluster_kube_config_file" {
-  content     = "${data.oci_containerengine_cluster_kube_config.test_cluster_kube_config.content}"
+resource "local_file" "tfsample_cluster_kube_config_file" {
+  content     = "${data.oci_containerengine_cluster_kube_config.tfsample_cluster_kube_config.content}"
   filename = "${path.module}/${var.cluster_name}_kubeconfig"
 }

kubernetes/samples/scripts/terraform/oci.props.example

@@ -0,0 +1,17 @@
+user.ocid=ocid1.user.oc1..aaaaaaaast7s6jdho6mh2dqvyqcychofaiv5lhztkx7u5jlr5wwuhhmewq
+okeclustername=myokecluster
+tfvars.filename=myokeclustertf
+region=us-phoenix-1
+tenancy.ocid=ocid1.tenancy.oc1..aaaaaahmcbb5mp2h6toh4vj7ax526xtmihrneoumyat557rvlolsx63imq
+compartment.ocid=ocid1.compartment.oc1..aaaaaaaaxzwkinzejhkncuvfy67pmb6wb46ifrixtuikkrgnnrp4wswsu4xq
+compartment.name=QualityAssurance
+ociapi.pubkey.fingerprint=c8\:b2\:da\:b2\:e8\:96\:7e\:bf\:ac\:ee\:ce\:bc\:a8\:7f\:07\:c5
+ocipk.path=/scratch/mkogan/.oci/oci_api_key.pem
+vcn.cidr.prefix=10.1
+vcn.cidr=10.1.0.0/16
+nodepool.shape=VM.Standard2.1
+nodepool.imagename=Oracle-Linux-7.4
+k8s.version=v1.10.11
+nodepool.ssh.pubkey=ssh-rsa AAAAB3NzaC1yc2EAAAAQABAAABAQC9FSfGdjjL+EZre2p5yLTAgtLsnp49AUVX1yY9V8guaXHol6UkvJWnyFHhL7s0qvWj2M2BYo6WAROVc0/054UFtmbd9zb2oZtGVk82VbT6aS74cMlqlY91H/rt9/t51Om9Sp5AvbJEzN0mkI4ndeG/5p12AUyg9m5XOdkgI2n4J8KFnDAI33YSGjxXb7UrkWSGl6XZBGUdeaExo3t2Ow8Kpl9T0Tq19qI+IncOecsCFj1tbM5voD8IWE2l0SW7V6oIqFJDMecq4IZusXdO+bPc+TKak7g82RUZd8PARpvYB5/7EOfVadxsXGRirGAKPjlXDuhwJYVRj1+IjZ+5Suxz mkogan@slc13kef
+terraform.installdir=/scratch/mkogan/myterraformtest
+

kubernetes/samples/scripts/terraform/oci.props.template

@@ -1,16 +1,45 @@
+# Copyright 2018, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+
+# Properties to generate TF variables file for cluster creation from property file oci.props
+#
+# Copy this file to oci.props and update it with your own info, see oci.props.example as sample for values
+#
+
+# OCID can be obtained from the user info page in the OCI console
 user.ocid= 
+
+# name of OKE cluster
 okeclustername=
+
+# name of tfvars file (no extention) to generate
 tfvars.filename=
+
+# Required tenancy info
 tenancy.ocid=
 compartment.ocid=
 compartment.name=
+region=
+
+# API key fingerprint and private key location, needed for API access -- you should have added a public API key through the OCI console first, add escape backslash \ for each colon signt
 ociapi.pubkey.fingerprint=
+
+# path to private OCI API key
 ocipk.path=
+
+# VCN CIDR -- must be unique within the compartment in the tenancy
+# - assuming 1:1 cluster:vcn
+# BE SURE TO SET BOTH VARS -- the first 2 octets for each variable have to match
 vcn.cidr.prefix=
 vcn.cidr=
+
+# Node pool info
 nodepool.shape=
-k8s.version=
 nodepool.ssh.pubkey=
-terraform.installdir=
-go.installdir=
+nodepool.imagename=
 
+# K8S version
+k8s.version=
+
+#location for terraform installation
+terraform.installdir=