Updates readme documentation (#4)

* Updates readme documentation
* Adds outputs for module

Signed-off-by: Sean Sundberg <[email protected]>

Author: Sean Sundberg

README.md

@@ -1,59 +1,46 @@
-# Starter kit for a Terraform module
+# IBM Cloud OpenShift VPC cluster
 
-This is a Starter kit to help with the creation of Terraform modules. The basic structure of a Terraform module is fairly
-simple and consists of the following basic values:
-
-- README.md - provides a description of the module
-- main.tf - defiens the logic for the module
-- variables.tf (optional) - defines the input variables for the module
-- outputs.tf (optional) - defines the values that are output from the module
-
-Beyond those files, any other content can be added and organized however you see fit. For example, you can add a `scripts/` directory
-that contains shell scripts executed by a `local-exec` `null_resource` in the terraform module. The contents will depend on what your
-module does and how it does it.
-
-## Instructions for creating a new module
-
-1. Update the title and description in the README to match the module you are creating
-2. Fill out the remaining sections in the README template as appropriate
-3. Implement your logic in the in the main.tf, variables.tf, and outputs.tf
-4. Use releases/tags to manage release versions of your module
+Provisions an IBM Cloud OpenShift VPC cluster using a provided VPC instance and COS
+instance.
 
 ## Software dependencies
 
 The module depends on the following software components:
 
 ### Command-line tools
 
-- terraform - v12
+- terraform - v13
 - kubectl
 
 ### Terraform providers
 
-- IBM Cloud provider >= 1.5.3
+- IBM Cloud provider >= 1.18
 - Helm provider >= 1.1.1 (provided by Terraform)
 
 ## Module dependencies
 
 This module makes use of the output from other modules:
 
-- Cluster - github.com/ibm-garage-cloud/terraform-ibm-container-platform.git
-- Namespace - github.com/ibm-garage-clout/terraform-cluster-namespace.git
-- etc
+- Object Storage - github.com/cloud-native-toolkit/terraform-ibm-object-storage.git
+- VPC - github.com/cloud-native-toolkit/terraform-ibm-vpc.git
 
 ## Example usage
 
 ```hcl-terraform
-module "dev_tools_argocd" {
-  source = "github.com/ibm-garage-cloud/terraform-tools-argocd.git?ref=v1.0.0"
-
-  cluster_config_file = module.dev_cluster.config_file_path
-  cluster_type        = module.dev_cluster.type
-  app_namespace       = module.dev_cluster_namespaces.tools_namespace_name
-  ingress_subdomain   = module.dev_cluster.ingress_hostname
-  olm_namespace       = module.dev_software_olm.olm_namespace
-  operator_namespace  = module.dev_software_olm.target_namespace
-  name                = "argocd"
+module "cluster" {
+  source = "github.com/cloud-native-toolkit/terraform-ibm-ocp-vpn.git?ref=v1.0.0"
+
+  resource_group_name = var.resource_group_name
+  region              = var.region
+  ibmcloud_api_key    = var.ibmcloud_api_key
+  name                = var.cluster_name
+  worker_count        = var.worker_count
+  ocp_version         = var.ocp_version
+  exists              = var.cluster_exists
+  name_prefix         = var.name_prefix
+  vpc_name            = module.vpc.name
+  vpc_subnet_count    = module.vpc.subnet_count
+  cos_id              = module.cos.id
 }
 ```
 

outputs.tf

@@ -1,5 +1,42 @@
-#output "myoutput" {
-#  description = "Description of my output"
-#  value       = "value"
-#  depends_on  = [<some resource>]
-#}
+output "id" {
+  value       = data.ibm_container_cluster_config.cluster.id
+  description = "ID of the cluster."
+  depends_on  = [helm_release.cloud_setup]
+}
+
+output "name" {
+  value       = local.cluster_name
+  description = "Name of the cluster."
+}
+
+output "resource_group_name" {
+  value       = var.resource_group_name
+  description = "Name of the resource group containing the cluster."
+  depends_on  = [helm_release.cloud_setup]
+}
+
+output "region" {
+  value       = var.region
+  description = "Region containing the cluster."
+  depends_on  = [helm_release.cloud_setup]
+}
+
+output "config_file_path" {
+  value       = local.cluster_config
+  description = "Path to the config file for the cluster."
+  depends_on  = [helm_release.cloud_setup]
+}
+
+output "platform" {
+  value = {
+    id         = data.ibm_container_cluster_config.cluster.id
+    kubeconfig = local.cluster_config
+    type       = local.cluster_type
+    type_code  = local.cluster_type_code
+    version    = local.cluster_version
+    ingress    = local.ingress_hostname
+    tls_secret = local.tls_secret
+  }
+  description = "Configuration values for the cluster platform"
+  depends_on  = [helm_release.cloud_setup]
+}