Added docs for vpc cluster and worker

IBM-Cloud · Oct 30, 2019 · c684947 · c684947
1 parent fdadb5a
commit c684947
Show file tree

Hide file tree

Showing 3 changed files with 124 additions and 0 deletions.
diff --git a/website/docs/d/container_vpc_cluster.html.markdown b/website/docs/d/container_vpc_cluster.html.markdown
@@ -0,0 +1,70 @@
+---
+layout: "ibm"
+page_title: "IBM: container_vpc_cluster"
+sidebar_current: "docs-ibm-data-source-container-vpc-cluster"
+description: |-
+  Manages IBM VPC container cluster.
+---
+
+# ibm\_container_vpc_cluster
+
+Import the details of a Kubernetes VPC cluster on IBM Cloud as a read-only data source.
+
+## Example Usage
+
+
+```
+data "ibm_container_vpc_cluster" "cluster" {
+
+  cluster_name_id              = "no-zones-tf"
+  resource_group_id = "${data.ibm_resource_group.group.id}"
+
+}
+
+```
+
+## Argument Reference
+
+The following arguments are supported:
+* `cluster_name_id` - (Required, string) Name of the Cluster
+* `resource_group_id` - (Optional, string) The ID of the resource group. You can retrieve the value from data source `ibm_resource_group`. If not provided defaults to default resource group.
+* `alb_type` - (Optional, string) ALB type of a Cluster
+
+
+## Attribute Reference
+
+The following attributes are exported:
+
+* `worker_count` - The number of worker nodes per zone in the default worker pool. Default value '1'.
+* `workers` - Worker nodes in worker pool.
+* `worker_pools`- Collection of worker nodes in a cluster
+    * `name`- Name of the worker pool
+    * `flavor`- Flavou of the worker node
+    * `worker_count`- Total number of workers
+    * `isolation`- Isolation for the worker node
+    * `id`- Id of the cluster
+    * `labels`- Labels on the workers
+    * `zones`- A nested block describing the zones of this worker_pool. Nested zones blocks have the following structure:
+        * `zone`- The name of the zone
+        * `subnets`- The worker pool subnet to assign the cluster. 
+            * `id`- Id of the Subnet
+            * `primary`- Is primary or not
+        * ` workercount`- The number of worker nodes in the current worker pool
+* `albs` - ALBs of a cluster
+    * `id` - ALB Id
+    * `name` - ALB Name
+    * `alb_type` - Type of ALB
+    * `enable` - Enable an ALB for cluster
+    * `state` - State of ALB
+    * `load_balancer_hostname` - Host name of Load Balancer
+    * `resize` - Resize of ALB
+    * `disable_deployment` - Disable the ALB Deployment
+* `public_service_endpoint` -  Is public service endpoint enabled to make the master publicly accessible.
+* `private_service_endpoint` -  Is private service endpoint enabled to make the master privately accessible.
+* `public_service_endpoint_url` - Url of the public_service_endpoint
+* `private_service_endpoint_url` - Url of the private_service_endpoint
+* `crn` - CRN of the cluster.
+* `master_url` - Url of the master
+* `status` - Status of cluster master.
+* `health` - Health of cluster master
+* `kube_version` -  The Kubernetes version, including at least the major.minor version.To see available versions, run 'ibmcloud ks versions'.
diff --git a/website/docs/d/container_vpc_cluster_worker.html.markdown b/website/docs/d/container_vpc_cluster_worker.html.markdown
@@ -0,0 +1,48 @@
+---
+layout: "ibm"
+page_title: "IBM: container_vpc_cluster_Worker"
+sidebar_current: "docs-ibm-data-source-container-vpc-cluster-Worker"
+description: |-
+  Manages IBM VPC container cluster worker.
+---
+
+# ibm\_container_vpc_cluster
+
+Import details of a worker node of a Kubernetes VPC cluster as a read-only data source. 
+
+
+## Example Usage
+
+
+```hcl
+data "ibm_container_cluster_worker" "worker_foo" {
+  worker_id    = "dev-mex10-pa70c4414695c041518603bfd0cd6e333a-w1"
+  cluster_name_id = "test"
+}
+
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `worker_id` - (Required, string) The name of the worker pool.
+* `cluster_name_id` - (Required, string) The name or id of the cluster.
+* `flavor` - (Required, string) The flavour of the worker node.
+* `kube_version` -  (Required, string) The Kubernetes version, including at least the major.minor version.To see available versions, run 'ibmcloud ks versions'.
+* `resource_group_id` - (Optional, string) The ID of the resource group.  You can retrieve the value from data source `ibm_resource_group`. If not provided defaults to default resource group.
+
+
+
+
+## Attribute Reference
+
+The following attributes are exported:
+
+* `State` - State of worker.
+* `pool_id` - Id of Worker pool.
+* `pool_name`- Name of the worker pool
+* `network_interfaces`- Network Interface of the cluster
+    * `cidr`- cidr of the network
+    * `ip_address`- Ip Address of the worker pool
+    * `subnet_id`- The worker pool subnet id to assign the cluster.
diff --git a/website/ibm.erb b/website/ibm.erb
@@ -60,6 +60,12 @@
               <li<%= sidebar_current("docs-ibm-datasource-container-cluster-versions") %>>
                 <a href="/docs/providers/ibm/d/container_cluster_versions.html">container_cluster_versions</a>
               </li>
+              <li<%= sidebar_current("docs-ibm-datasource-container-vpc-cluster") %>>
+                <a href="/docs/providers/ibm/d/container_vpc_cluster.html">container_vpc_cluster</a>
+              </li>
+              <li<%= sidebar_current("docs-ibm-datasource-container-vpc-cluster-worker") %>>
+                <a href="/docs/providers/ibm/d/container_vpc_cluster_worker.html">container_vpc_cluster_worker</a>
+              </li>
             </ul>
           </li>
           <li<%= sidebar_current("docs-ibm-datasource-function") %>>