added feature dependencies documentation (#127)

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

Author: hyder

README.adoc

@@ -29,6 +29,7 @@
 :uri-quickstart: {uri-docs}/quickstart.adoc
 
 :uri-terraform: https://www.terraform.io
+:uri-terraform-dependencies: {uri-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
@@ -55,6 +56,8 @@ This {uri-repo}[Terraform OKE Installer] for {uri-oci}[Oracle Cloud Infrastructu
 
 * {uri-terraform-options}[Terraform Options]
 
+* {uri-terraform-dependencies}[Feature Dependencies]
+
 == Related Documentation, Blog
 * {uri-oci-documentation}[Oracle Cloud Infrastructure Documentation]
 * {uri-oke}[Oracle Container Engine Documentation]

docs/dependencies.adoc

@@ -0,0 +1,47 @@
+= Instructions
+
+:idprefix:
+:idseparator: -
+:sectlinks:
+
+:uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-oke
+
+:uri-rel-file-base: link:{uri-repo}/blob/master
+:uri-rel-tree-base: link:{uri-repo}/tree/master
+
+:uri-docs: {uri-rel-file-base}/docs
+:uri-terraform-options: {uri-docs}/terraformoptions.adoc
+
+== Dependencies
+
+The following table documents the {uri-terraform-options}[Terraform Options] dependencies.
+
+[stripes=odd,cols="1d,4d,3a", options=header,width="100%"] 
+|===
+|Feature
+|Description
+|Depends on
+
+|allow_worker_ssh_access
+|Allows ssh access to worker node via the bastion host
+|bastion_enabled = true
+
+|create_service_account
+|Creates a service account that can be used for CI/CD. 
+|bastion_enabled = true, admin_enabled = true, admin_instance_principal = true
+
+|install_calico
+|Installs calico as network policy engine
+|bastion_enabled = true, admin_enabled = true, admin_instance_principal = true
+
+|install_metricserver
+|Installs Kubernetes metrics server for Horizontal Pod Autoscaling
+|bastion_enabled = true, admin_enabled = true, admin_instance_principal = true
+
+|ocir secret
+|Whether to create an authentication secret for OCIR
+|bastion_enabled = true, admin_enabled = true, admin_instance_principal = true, create_auth_token = true
+
+|use_encryption
+|Uses OCI KMS to encrypt data in OKE's underlying etcd
+|bastion_enabled = true, admin_enabled = true, admin_instance_principal = true

docs/terraformoptions.adoc

@@ -19,6 +19,7 @@
 :uri-oci-loadbalancer-annotations: https://github.com/oracle/oci-cloud-controller-manager/blob/master/docs/load-balancer-annotations.md
 :uri-oci-region: https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm
 :uri-terraform-cidrsubnet: https://www.terraform.io/docs/configuration/functions/cidrsubnet.html
+:uri-terraform-dependencies: {uri-docs}/dependencies.adoc
 :uri-timezones: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
 :uri-topology: {uri-docs}/topology.adoc
 
@@ -39,6 +40,8 @@ Configuration Terraform Options:
 . link:#kms-integration[KMS integration]
 . link:#service-account[Service Account]
 
+Ensure you review the {uri-terraform-dependencies}[dependencies].
+
 == Identity and access
 
 [stripes=odd,cols="1d,4d,3a,3a", options=header,width="100%"]