Skip to content

Commit 7662b23

Browse files
VasundharashuklaVasundharashukla
committed
Refining the documentation
1 parent 4c93f82 commit 7662b23

23 files changed

+533
-1014
lines changed

‎docs/data-sources/tmc_cluster.md

+6-337
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
---
2-
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "tmc_cluster Data Source - terraform-provider-tanzu-mission-control"
4-
subcategory: ""
5-
description: |-
6-
2+
Title: "Cluster Resource"
3+
Description: |-
4+
Reading the cluster resource.
75
---
86

9-
# tmc_cluster (Data Source)
10-
7+
# Cluster
118

9+
Different flavours such as attach cluster, TKG service workload and TKG Vsphere workload clusters can be fetched.
1210

1311
## Example Usage
1412

@@ -33,333 +31,4 @@ data "tmc_cluster" "read_tkg_vsphere_cluster" {
3331
provisioner_name = "default"
3432
name = "new-read"
3533
}
36-
```
37-
38-
<!-- schema generated by tfplugindocs -->
39-
## Schema
40-
41-
### Required
42-
43-
- **name** (String) Name of this cluster
44-
45-
### Optional
46-
47-
- **attach_k8s_cluster** (Block List, Max: 1) (see [below for nested schema](#nestedblock--attach_k8s_cluster))
48-
- **id** (String) The ID of this resource.
49-
- **management_cluster_name** (String) Name of the management cluster
50-
- **meta** (Block List, Max: 1) Metadata for the resource (see [below for nested schema](#nestedblock--meta))
51-
- **provisioner_name** (String) Provisioner of the cluster
52-
- **spec** (Block List, Max: 1) Spec for the cluster (see [below for nested schema](#nestedblock--spec))
53-
- **wait_until_ready** (Boolean) Wait flag of the cluster
54-
55-
### Read-Only
56-
57-
- **status** (Map of String) Status of the cluster
58-
59-
<a id="nestedblock--attach_k8s_cluster"></a>
60-
### Nested Schema for `attach_k8s_cluster`
61-
62-
Optional:
63-
64-
- **description** (String) Attach cluster description
65-
- **kubeconfig_file** (String) Attach cluster KUBECONFIG path
66-
67-
68-
<a id="nestedblock--meta"></a>
69-
### Nested Schema for `meta`
70-
71-
Optional:
72-
73-
- **description** (String) Description of the resource
74-
- **labels** (Map of String) Labels for the resource
75-
76-
Read-Only:
77-
78-
- **annotations** (Map of String) Annotations for the resource
79-
- **resource_version** (String) Resource version of the resource
80-
- **uid** (String) UID of the resource
81-
82-
83-
<a id="nestedblock--spec"></a>
84-
### Nested Schema for `spec`
85-
86-
Optional:
87-
88-
- **cluster_group** (String) Name of the cluster group to which this cluster belongs
89-
- **proxy** (String) Optional proxy name is the name of the Proxy Config to be used for the cluster
90-
- **tkg_service_vsphere** (Block List, Max: 1) The tkg service vsphere cluster spec (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere))
91-
- **tkg_vsphere** (Block List, Max: 1) The TKG Vsphere cluster spec (see [below for nested schema](#nestedblock--spec--tkg_vsphere))
92-
93-
<a id="nestedblock--spec--tkg_service_vsphere"></a>
94-
### Nested Schema for `spec.tkg_service_vsphere`
95-
96-
Required:
97-
98-
- **distribution** (Block List, Min: 1, Max: 1) VSphere specific distribution (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--distribution))
99-
- **settings** (Block List, Min: 1, Max: 1) VSphere related settings for workload cluster (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--settings))
100-
- **topology** (Block List, Min: 1, Max: 1) Topology specific configuration (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--topology))
101-
102-
<a id="nestedblock--spec--tkg_service_vsphere--distribution"></a>
103-
### Nested Schema for `spec.tkg_service_vsphere.distribution`
104-
105-
Required:
106-
107-
- **version** (String) Version of the cluster
108-
109-
110-
<a id="nestedblock--spec--tkg_service_vsphere--settings"></a>
111-
### Nested Schema for `spec.tkg_service_vsphere.settings`
112-
113-
Required:
114-
115-
- **network** (Block List, Min: 1, Max: 1) Network Settings specifies network-related settings for the cluster (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--settings--network))
116-
117-
<a id="nestedblock--spec--tkg_service_vsphere--settings--network"></a>
118-
### Nested Schema for `spec.tkg_service_vsphere.settings.network`
119-
120-
Required:
121-
122-
- **pods** (Block List, Min: 1) Pod CIDR for Kubernetes pods defaults to 192.168.0.0/16 (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--settings--network--pods))
123-
- **services** (Block List, Min: 1) Service CIDR for kubernetes services defaults to 10.96.0.0/12 (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--settings--network--services))
124-
125-
<a id="nestedblock--spec--tkg_service_vsphere--settings--network--pods"></a>
126-
### Nested Schema for `spec.tkg_service_vsphere.settings.network.pods`
127-
128-
Required:
129-
130-
- **cidr_blocks** (List of String) CIDRBlocks specifies one or more ranges of IP addresses
131-
132-
133-
<a id="nestedblock--spec--tkg_service_vsphere--settings--network--services"></a>
134-
### Nested Schema for `spec.tkg_service_vsphere.settings.network.services`
135-
136-
Required:
137-
138-
- **cidr_blocks** (List of String) CIDRBlocks specifies one or more ranges of IP addresses
139-
140-
141-
142-
143-
<a id="nestedblock--spec--tkg_service_vsphere--topology"></a>
144-
### Nested Schema for `spec.tkg_service_vsphere.topology`
145-
146-
Required:
147-
148-
- **control_plane** (Block List, Min: 1, Max: 1) Control plane specific configuration (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--topology--control_plane))
149-
150-
Optional:
151-
152-
- **node_pools** (Block List) Nodepool specific configuration (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--topology--node_pools))
153-
154-
<a id="nestedblock--spec--tkg_service_vsphere--topology--control_plane"></a>
155-
### Nested Schema for `spec.tkg_service_vsphere.topology.node_pools`
156-
157-
Required:
158-
159-
- **class** (String) Control plane instance type
160-
- **storage_class** (String) Storage Class to be used for storage of the disks which store the root filesystems of the nodes
161-
162-
Optional:
163-
164-
- **high_availability** (Boolean) High Availability or Non High Availability Cluster. HA cluster creates three controlplane machines, and non HA creates just one
165-
166-
167-
<a id="nestedblock--spec--tkg_service_vsphere--topology--node_pools"></a>
168-
### Nested Schema for `spec.tkg_service_vsphere.topology.node_pools`
169-
170-
Required:
171-
172-
- **info** (Block List, Min: 1, Max: 1) Info is the meta information of nodepool for cluster (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--topology--node_pools--info))
173-
174-
Optional:
175-
176-
- **spec** (Block List, Max: 1) Spec for the cluster nodepool (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--topology--node_pools--spec))
177-
178-
<a id="nestedblock--spec--tkg_service_vsphere--topology--node_pools--info"></a>
179-
### Nested Schema for `spec.tkg_service_vsphere.topology.node_pools.info`
180-
181-
Optional:
182-
183-
- **description** (String) Description for the nodepool
184-
- **name** (String) Name of the nodepool
185-
186-
187-
<a id="nestedblock--spec--tkg_service_vsphere--topology--node_pools--spec"></a>
188-
### Nested Schema for `spec.tkg_service_vsphere.topology.node_pools.spec`
189-
190-
Optional:
191-
192-
- **cloud_label** (Map of String) Cloud labels
193-
- **node_label** (Map of String) Node labels
194-
- **tkg_service_vsphere** (Block List, Max: 1) Nodepool config for tkg service vsphere (see [below for nested schema](#nestedblock--spec--tkg_service_vsphere--topology--node_pools--spec--tkg_service_vsphere))
195-
- **worker_node_count** (String) Count is the number of nodes
196-
197-
<a id="nestedblock--spec--tkg_service_vsphere--topology--node_pools--spec--tkg_service_vsphere"></a>
198-
### Nested Schema for `spec.tkg_service_vsphere.topology.node_pools.spec.worker_node_count`
199-
200-
Required:
201-
202-
- **class** (String) Control plane instance type
203-
- **storage_class** (String) Storage Class to be used for storage of the disks which store the root filesystems of the nodes
204-
205-
206-
207-
208-
209-
210-
<a id="nestedblock--spec--tkg_vsphere"></a>
211-
### Nested Schema for `spec.tkg_vsphere`
212-
213-
Required:
214-
215-
- **distribution** (Block List, Min: 1, Max: 1) VSphere specific distribution (see [below for nested schema](#nestedblock--spec--tkg_vsphere--distribution))
216-
- **settings** (Block List, Min: 1, Max: 1) VSphere related settings for workload cluster (see [below for nested schema](#nestedblock--spec--tkg_vsphere--settings))
217-
- **topology** (Block List, Min: 1, Max: 1) Topology specific configuration (see [below for nested schema](#nestedblock--spec--tkg_vsphere--topology))
218-
219-
<a id="nestedblock--spec--tkg_vsphere--distribution"></a>
220-
### Nested Schema for `spec.tkg_vsphere.distribution`
221-
222-
Required:
223-
224-
- **version** (String) Version specifies the version of the Kubernetes cluster
225-
- **workspace** (Block List, Min: 1, Max: 1) Workspace defines a workspace configuration for the vSphere cloud provider (see [below for nested schema](#nestedblock--spec--tkg_vsphere--distribution--workspace))
226-
227-
<a id="nestedblock--spec--tkg_vsphere--distribution--workspace"></a>
228-
### Nested Schema for `spec.tkg_vsphere.distribution.workspace`
229-
230-
Required:
231-
232-
- **datacenter** (String)
233-
- **datastore** (String)
234-
- **folder** (String)
235-
- **resource_pool** (String)
236-
- **workspace_network** (String)
237-
238-
239-
240-
<a id="nestedblock--spec--tkg_vsphere--settings"></a>
241-
### Nested Schema for `spec.tkg_vsphere.settings`
242-
243-
Required:
244-
245-
- **network** (Block List, Min: 1, Max: 1) Network Settings specifies network-related settings for the cluster (see [below for nested schema](#nestedblock--spec--tkg_vsphere--settings--network))
246-
- **security** (Block List, Min: 1, Max: 1) Security Settings specifies security-related settings for the cluster (see [below for nested schema](#nestedblock--spec--tkg_vsphere--settings--security))
247-
248-
<a id="nestedblock--spec--tkg_vsphere--settings--network"></a>
249-
### Nested Schema for `spec.tkg_vsphere.settings.security`
250-
251-
Required:
252-
253-
- **control_plane_end_point** (String) ControlPlaneEndpoint specifies the control plane virtual IP address. The value should be unique for every create request, else cluster creation shall fail
254-
- **pods** (Block List, Min: 1) Pod CIDR for Kubernetes pods defaults to 192.168.0.0/16 (see [below for nested schema](#nestedblock--spec--tkg_vsphere--settings--security--pods))
255-
- **services** (Block List, Min: 1) Service CIDR for kubernetes services defaults to 10.96.0.0/12 (see [below for nested schema](#nestedblock--spec--tkg_vsphere--settings--security--services))
256-
257-
<a id="nestedblock--spec--tkg_vsphere--settings--security--pods"></a>
258-
### Nested Schema for `spec.tkg_vsphere.settings.security.pods`
259-
260-
Required:
261-
262-
- **cidr_blocks** (List of String) CIDRBlocks specifies one or more ranges of IP addresses
263-
264-
265-
<a id="nestedblock--spec--tkg_vsphere--settings--security--services"></a>
266-
### Nested Schema for `spec.tkg_vsphere.settings.security.services`
267-
268-
Required:
269-
270-
- **cidr_blocks** (List of String) CIDRBlocks specifies one or more ranges of IP addresses
271-
272-
273-
274-
<a id="nestedblock--spec--tkg_vsphere--settings--security"></a>
275-
### Nested Schema for `spec.tkg_vsphere.settings.security`
276-
277-
Required:
278-
279-
- **ssh_key** (String) SSH key for provisioning and accessing the cluster VMs
280-
281-
282-
283-
<a id="nestedblock--spec--tkg_vsphere--topology"></a>
284-
### Nested Schema for `spec.tkg_vsphere.topology`
285-
286-
Required:
287-
288-
- **control_plane** (Block List, Min: 1, Max: 1) VSphere specific control plane configuration for workload cluster object (see [below for nested schema](#nestedblock--spec--tkg_vsphere--topology--control_plane))
289-
290-
Optional:
291-
292-
- **node_pools** (Block List) Nodepool specific configuration (see [below for nested schema](#nestedblock--spec--tkg_vsphere--topology--node_pools))
293-
294-
<a id="nestedblock--spec--tkg_vsphere--topology--control_plane"></a>
295-
### Nested Schema for `spec.tkg_vsphere.topology.node_pools`
296-
297-
Required:
298-
299-
- **vm_config** (Block List, Min: 1, Max: 1) VM specific configuration (see [below for nested schema](#nestedblock--spec--tkg_vsphere--topology--node_pools--vm_config))
300-
301-
Optional:
302-
303-
- **high_availability** (Boolean) High Availability or Non High Availability Cluster. HA cluster creates three controlplane machines, and non HA creates just one
304-
305-
<a id="nestedblock--spec--tkg_vsphere--topology--node_pools--vm_config"></a>
306-
### Nested Schema for `spec.tkg_vsphere.topology.node_pools.vm_config`
307-
308-
Optional:
309-
310-
- **cpu** (String)
311-
- **disk_size** (String)
312-
- **memory** (String)
313-
314-
315-
316-
<a id="nestedblock--spec--tkg_vsphere--topology--node_pools"></a>
317-
### Nested Schema for `spec.tkg_vsphere.topology.node_pools`
318-
319-
Required:
320-
321-
- **info** (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--spec--tkg_vsphere--topology--node_pools--info))
322-
323-
Optional:
324-
325-
- **spec** (Block List, Max: 1) Spec for the cluster nodepool (see [below for nested schema](#nestedblock--spec--tkg_vsphere--topology--node_pools--spec))
326-
327-
<a id="nestedblock--spec--tkg_vsphere--topology--node_pools--info"></a>
328-
### Nested Schema for `spec.tkg_vsphere.topology.node_pools.info`
329-
330-
Required:
331-
332-
- **name** (String)
333-
334-
Optional:
335-
336-
- **description** (String)
337-
338-
339-
<a id="nestedblock--spec--tkg_vsphere--topology--node_pools--spec"></a>
340-
### Nested Schema for `spec.tkg_vsphere.topology.node_pools.spec`
341-
342-
Optional:
343-
344-
- **cloud_labels** (Map of String) Cloud labels
345-
- **node_labels** (Map of String) Node labels
346-
- **tkg_vsphere** (Block List, Max: 1) Nodepool config for tkgm vsphere (see [below for nested schema](#nestedblock--spec--tkg_vsphere--topology--node_pools--spec--tkg_vsphere))
347-
- **worker_node_count** (String) Count is the number of nodes
348-
349-
<a id="nestedblock--spec--tkg_vsphere--topology--node_pools--spec--tkg_vsphere"></a>
350-
### Nested Schema for `spec.tkg_vsphere.topology.node_pools.spec.worker_node_count`
351-
352-
Required:
353-
354-
- **vm_config** (Block List, Min: 1, Max: 1) VM specific configuration (see [below for nested schema](#nestedblock--spec--tkg_vsphere--topology--node_pools--spec--worker_node_count--vm_config))
355-
356-
<a id="nestedblock--spec--tkg_vsphere--topology--node_pools--spec--worker_node_count--vm_config"></a>
357-
### Nested Schema for `spec.tkg_vsphere.topology.node_pools.spec.worker_node_count.vm_config`
358-
359-
Optional:
360-
361-
- **cpu** (String)
362-
- **disk_size** (String)
363-
- **memory** (String)
364-
365-
34+
```

0 commit comments

Comments
 (0)