changed base module source from github to hashicorp registry, added descriptions and README.md for publishing to hashicorp registry (#129)

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

Author: hyder

CHANGELOG.adoc

@@ -7,6 +7,13 @@ All notable changes to this project are documented in this file.
 
 The format is based on {uri-changelog}[Keep a Changelog].
 
+== 2.1.2 (February 19, 2020)
+* base module now points to the published base module on hashicorp registry
+* updated descriptions in variables, outputs and formatting to publish to hashicorp registry
+* added readme in markdown to publish to hashicorp registry
+* removed unused kms variables and module
+* updated documentation to indicated required values
+
 == 2.1.1 (February 06, 2020)
 * Install latest version of kubectl into admin host (#119)
 * Added OCIR support for new regions (#122)

README.md

@@ -0,0 +1,82 @@
+# Terraform for Oracle Container Engine
+
+[uri-repo]: https://github.com/oracle-terraform-modules/terraform-oci-oke
+
+[uri-docs]: https://github.com/oracle-terraform-modules/terraform-oci-oke/docs
+
+[uri-changelog]: https://github.com/oracle-terraform-modules/terraform-oci-oke/CHANGELOG.adoc
+[uri-configuration]: https://github.com/oracle-terraform-modules/terraform-oci-oke/docs/configuration.adoc
+
+[uri-contribute]: https://github.com/oracle-terraform-modules/terraform-oci-oke/CONTRIBUTING.adoc
+[uri-contributors]: https://github.com/oracle-terraform-modules/terraform-oci-oke/CONTRIBUTORS.adoc
+
+[uri-instructions]: https://github.com/oracle-terraform-modules/terraform-oci-oke/docs/instructions.adoc
+[uri-license]: https://github.com/oracle-terraform-modules/terraform-oci-oke/LICENSE
+[uri-canonical-license]: https://oss.oracle.com/licenses/upl/
+[uri-kubernetes]: https://kubernetes.io/
+[uri-networks-subnets-cidr]: https://erikberg.com/notes/networks.html
+[uri-oci]: https://cloud.oracle.com/cloud-infrastructure
+[uri-oci-documentation]: https://docs.cloud.oracle.com/iaas/Content/home.htm
+[uri-oke]: https://docs.cloud.oracle.com/iaas/Content/ContEng/Concepts/contengoverview.htm
+[uri-oracle]: https://www.oracle.com
+[uri-prereqs]: https://github.com/oracle-terraform-modules/terraform-oci-oke/docs/prerequisites.adoc
+[uri-quickstart]: https://github.com/oracle-terraform-modules/terraform-oci-oke/docs/quickstart.adoc
+
+[uri-terraform]: https://www.terraform.io
+[uri-terraform-dependencies]: https://github.com/oracle-terraform-modules/terraform-oci-oke/docs/dependencies.adoc
+[uri-terraform-cidrsubnet-deconstructed]: http://blog.itsjustcode.net/blog/2017/11/18/terraform-cidrsubnet-deconstructed/
+[uri-terraform-oci]: https://www.terraform.io/docs/providers/oci/index.html
+[uri-terraform-oke-sample]: https://github.com/terraform-providers/terraform-provider-oci/tree/master/examples/container_engine
+[uri-terraform-options]: https://github.com/oracle-terraform-modules/terraform-oci-oke/docs/terraformoptions.adoc
+[uri-terraform-hashircorp-examples]: https://github.com/hashicorp/terraform-guides/tree/master/infrastructure-as-code/terraform-0.12-examples
+[uri-topology]: https://github.com/oracle-terraform-modules/terraform-oci-oke/docs/topology.adoc
+
+
+[Oracle Container Engine (OKE)][uri-oke] is [Oracle's][uri-oracle] managed [Kubernetes][uri-kubernetes] service on [Oracle Cloud Infrastructure (OCI)][uri-oci].
+
+This [Terraform OKE Installer][uri-repo] for [Oracle Cloud Infrastructure][uri-oci] provides a reusable Terraform module that provisions a Oracle Container Engine][uri-oke] cluster.
+
+## [Documentation][uri-docs]
+
+* [Pre-requisites][uri-prereqs]
+
+* [Quick Start][uri-quickstart]
+
+* [Configuration][uri-configuration]
+
+* [Instructions][uri-instructions]
+
+* [Topology][uri-topology]
+
+* [Terraform Options][uri-terraform-options]
+
+* [Feature Dependencies][uri-terraform-dependencies]
+
+## Related Documentation, Blog
+* [Oracle Cloud Infrastructure Documentation][uri-oci-documentation]
+* [Oracle Container Engine Documentation][uri-oke]
+* [Terraform OCI Provider Documentation][uri-terraform-oci]
+* [Erik Berg on Networks, Subnets and CIDR][uri-networks-subnets-cidr]
+* [Lisa Hagemann on Terraform cidrsubnet Deconstructed][uri-terraform-cidrsubnet-deconstructed]
+
+## Changelog
+
+View the [CHANGELOG][uri-changelog].
+
+## Acknowledgement
+
+Code derived and adapted from [Terraform OKE Sample][uri-terraform-oke-sample] and Hashicorp's [Terraform 0.12 examples][uri-terraform-hashircorp-examples]
+
+## Contributors
+
+[Folks][uri-contributors] who contributed with explanations, code, feedback, ideas, testing etc.
+
+Learn how to [contribute][uri-contribute].
+
+
+## License
+
+Copyright © 2019 Oracle and/or its associates. All rights reserved.
+
+Licensed under the [Universal Permissive License 1.0][uri-license] as shown at 
+[https://oss.oracle.com/licenses/upl][uri-canonical-license].

docs/terraformoptions.adoc

@@ -110,9 +110,9 @@ Ensure you review the {uri-terraform-dependencies}[dependencies].
 |Default
 
 |label_prefix
-|a string to be prepended to the name of resources.
+|a string to be prepended to the name of resources. *Required*
+|
 |
-|oke
 
 |region
 |Region where to provision the OKE cluster. {uri-oci-region}[List of regions]. *Required*
@@ -193,14 +193,14 @@ newbits = {
 |10.0.0.0/16
 
 |vcn_dns_label
-|The internal DNS domain for resources created and prepended to "oraclevcn.com" which is the VCN-internal domain name.
+|The internal DNS domain for resources created and prepended to "oraclevcn.com" which is the VCN-internal domain name. *Required*
+|
 |
-|oke
 
 |vcn_name
-|The name of the VCN that will be appended to the label_prefix.
+|The name of the VCN that will be appended to the label_prefix. *Required*
+|
 |
-|oke vcn
 
 |===
 
@@ -254,14 +254,14 @@ newbits = {
 |true
 
 |bastion_shape
-|The shape of bastion instance.
+|The shape of bastion instance. *Required*
+|
 |
-|VM.Standard.E2.1
 
 |bastion_timezone
-|The preferred timezone for the bastion host. {uri-timezones}[List of timezones]
+|The preferred timezone for the bastion host. {uri-timezones}[List of timezones]. *Required*
+|
 |
-|Australia/Sydney
 
 |===
 
@@ -315,14 +315,14 @@ newbits = {
 |true
 
 |admin_shape
-|The shape of admin instance.
+|The shape of admin instance. *Required*
+|
 |
-|VM.Standard.E2.1
 
 |admin_timezone
-|The preferred timezone for the admin host. {uri-timezones}[List of timezones]
+|The preferred timezone for the admin host. {uri-timezones}[List of timezones]. *Required*
+|e.g. Australia/Sydney
 |
-|Australia/Sydney
 
 |===
 
@@ -375,9 +375,9 @@ availability_domains = {
 |false
 
 |cluster_name
-|The name of the OKE cluster. This will be appended to the label_prefix.
+|The name of the OKE cluster. This will be appended to the label_prefix. *Required*
+|
 |
-|oke
 
 |dashboard_enabled
 |Whether to create the default Kubernetes dashboard.
@@ -393,16 +393,15 @@ availability_domains = {
 |The number, shape and quantities per subnets of node pools to create. Each key and tuple pair corresponds to 1 node pool. The first parameter in the tuple sets the shape of the worker node and the 2nd parameter sets the size of the node pool. A minimum of 3 worker worker nodes per node pool will be created.  Refer to {uri-topology}[topology] for more thorough examples.
 |e.g.
 [source]
-----
 node_pools = {
   "np1" = ["VM.Standard2.1", 1]
 }
-----
-|----
+ 
+|
+[source]
 node_pools = {
   "np1" = ["VM.Standard2.1", 1]
 }
-----
 
 |node_pool_name_prefix
 |A string prefixed to the node pool name.
@@ -487,17 +486,17 @@ Refer to {uri-topology}[topology] for more thorough examples.
 |false
 
 |email_address
-|The email address to be used when creating the Docker secret. *Required* if create_auth_token is set to true.
+|The email address to be used when creating the Docker secret. *Required* if _create_auth_token_ is set to *true*.
 |
 |None
 
 |tenancy_name
-|The *_name_* of the tenancy to be used when creating the Docker secret.  This is different from tenancy_id. *Required* if create_auth_token is set to true.
+|The *_name_* of the tenancy to be used when creating the Docker secret.  This is different from tenancy_id. *Required* if _create_auth_token_ is set to *true*.
 |
 |None
 
 |username
-|The username that can login to the selected tenancy. This is different from tenancy_id. *Required* if create_auth_token is set to true.
+|The username that can login to the selected tenancy. This is different from tenancy_id. *Required* if _create_auth_token_ is set to *true*.
 |
 |None
 
@@ -574,7 +573,7 @@ Refer to {uri-topology}[topology] for more thorough examples.
 |false
 
 |existing_key_id
-|id of existing KMS key
+|id of existing KMS key. *Required* if _use_encryption_ is set to *true*
 |
 |
 |===

main.tf

@@ -6,7 +6,9 @@ terraform {
 }
 
 module "base" {
-  source = "github.com/oracle-terraform-modules/terraform-oci-base?ref=v1.1.0"
+  # source = "github.com/oracle-terraform-modules/terraform-oci-base?ref=v1.1.1"
+  source  = "oracle-terraform-modules/base/oci"
+  version = "1.1.1"
 
   # identity
   oci_base_identity = local.oci_base_identity

modules/kms/variables.tf

@@ -2,26 +2,32 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
 
 output "bastion_public_ip" {
-  value = module.base.bastion_public_ip
+  description = "public ip address of bastion host"
+  value       = module.base.bastion_public_ip
 }
 
 output "admin_private_ip" {
-  value = module.base.admin_private_ip
+  description = "private ip address of admin host"
+  value       = module.base.admin_private_ip
 }
 
 output "ssh_to_admin" {
-  value = module.base.ssh_to_admin
+  description = "convenient command to ssh to the admin host"
+  value       = module.base.ssh_to_admin
 }
 
 output "ssh_to_bastion" {
-  value = module.base.ssh_to_bastion
+  description = "convenient command to ssh to the bastion host"
+  value       = module.base.ssh_to_bastion
 }
 
 output "kubeconfig" {
-  value = "export KUBECONFIG=generated/kubeconfig"
+  description = "convenient command to set KUBECONFIG environment variable before running kubectl locally"
+  value       = "export KUBECONFIG=generated/kubeconfig"
 }
 
 output "ocirtoken" {
-  value     = module.auth.ocirtoken
-  sensitive = true
+  description = "authentication token for ocir"
+  sensitive   = true
+  value       = module.auth.ocirtoken
 }