Skip to content

Commit 8e66181

Browse files
shobha2626shobha2626
committed
Provisioner resource and data source documentation
Signed-off-by: Shobha M <[email protected]>
1 parent 5f4bb0b commit 8e66181

File tree

4 files changed

+203
-0
lines changed

4 files changed

+203
-0
lines changed

‎docs/data-sources/provisioner.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
Title: "Provisioner data source in a management cluster"
3+
Description: |-
4+
Provisioner data source in a management cluster.
5+
---
6+
7+
# Management Cluster Provisioner
8+
9+
Read provisioner in a management cluster using this Terraform module.
10+
11+
### Tanzu Kubernetes Grid Service and Tanzu Kubernetes Grid vSphere
12+
- Only provisioner read feature is enabled for Tanzu Kubernetes Grid Service and Tanzu Kubernetes Grid vSphere management clusters.
13+
- For a Tanzu Kubernetes cluster running in vSphere, you add a provisioner by creating
14+
a namespace in the management cluster, which you can do using kubectl.
15+
For more information, see [Create Namespaces in the Management Cluster] in the VMware Tanzu Kubernetes Grid Product Documentation.
16+
- For a Tanzu Kubernetes cluster running in vSphere with Tanzu, you add a provisioner by creating
17+
a vSphere namespace in the Supervisor Cluster, which you can do in your vSphere environment.
18+
For more information, see [Configuring and Managing vSphere Namespaces] in the vSphere with
19+
Tanzu Configuration and Management documentation.
20+
21+
[Create Namespaces in the Management Cluster] : https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-cluster-lifecycle-multiple-management-clusters.html#namespaces
22+
[Configuring and Managing vSphere 7.x Namespaces] : https://docs.vmware.com/en/VMware-vSphere/7.0/vmware-vsphere-with-tanzu/GUID-1544C9FE-0B23-434E-B823-C59EFC2F7309.html
23+
[Configuring and Managing vSphere 8.x Namespaces] : https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-services-workloads/GUID-1544C9FE-0B23-434E-B823-C59EFC2F7309.html
24+
25+
### Example Usage
26+
27+
```terraform
28+
# Read Tanzu Mission Control provisioner : fetch the given provisioner details
29+
data "tanzu-mission-control_provisioner" "read_provisioner" {
30+
name = "test-provisioner" # Optional
31+
management_cluster = "eks" # Required
32+
}
33+
34+
# Read Tanzu Mission Control provisioner : fetch all the provisioner details for the given management cluster
35+
data "tanzu-mission-control_provisioner" "read_provisioner" {
36+
management_cluster = "eks" # Required
37+
}
38+
```
39+
40+
<!-- schema generated by tfplugindocs -->
41+
## Schema
42+
43+
### Required
44+
45+
- `management_cluster` (String) Name of the management cluster
46+
47+
### Optional
48+
49+
- `meta` (Block List, Max: 1) Metadata for the resource (see [below for nested schema](#nestedblock--meta))
50+
- `name` (String) Name of the provisioner
51+
- `org_id` (String) ID of the organization
52+
53+
### Read-Only
54+
55+
- `id` (String) The ID of this resource.
56+
57+
<a id="nestedblock--meta"></a>
58+
### Nested Schema for `meta`
59+
60+
Optional:
61+
62+
- `annotations` (Map of String) Annotations for the resource
63+
- `description` (String) Description of the resource
64+
- `labels` (Map of String) Labels for the resource
65+
66+
Read-Only:
67+
68+
- `resource_version` (String) Resource version of the resource
69+
- `uid` (String) UID of the resource

‎docs/resources/provisioner.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
Title: "Provisioner resource in a management cluster"
3+
Description: |-
4+
Provisioner resource lifecycle management.
5+
---
6+
7+
# Management Cluster Provisioner
8+
9+
Lifecycle management of provisioner in a management cluster using this Terraform module.
10+
11+
Addition of a provisioner resource refers to creation of namespace in the management cluster.
12+
13+
### Tanzu Kubernetes Grid Service and Tanzu Kubernetes Grid vSphere
14+
- Only provisioner read only feature is enabled for Tanzu Kubernetes Grid Service and Tanzu Kubernetes Grid vSphere management clusters.
15+
- For a Tanzu Kubernetes cluster running in vSphere, you add a provisioner by creating
16+
a namespace in the management cluster, which you can do using kubectl.
17+
For more information, see [Create Namespaces in the Management Cluster] in the VMware Tanzu Kubernetes Grid Product Documentation.
18+
- For a Tanzu Kubernetes cluster running in vSphere with Tanzu, you add a provisioner by creating
19+
a vSphere namespace in the Supervisor Cluster, which you can do in your vSphere environment.
20+
For more information, see [Configuring and Managing vSphere Namespaces] in the vSphere with
21+
Tanzu Configuration and Management documentation.
22+
23+
[Create Namespaces in the Management Cluster] : https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-cluster-lifecycle-multiple-management-clusters.html#namespaces
24+
[Configuring and Managing vSphere 7.x Namespaces] : https://docs.vmware.com/en/VMware-vSphere/7.0/vmware-vsphere-with-tanzu/GUID-1544C9FE-0B23-434E-B823-C59EFC2F7309.html
25+
[Configuring and Managing vSphere 8.x Namespaces] : https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-services-workloads/GUID-1544C9FE-0B23-434E-B823-C59EFC2F7309.html
26+
27+
### Example Usage
28+
29+
```terraform
30+
# Create provisioner resource
31+
resource "tanzu-mission-control_provisioner" "create_provisioner" {
32+
name = "demo-test" # Required
33+
management_cluster = "eks" # Required
34+
35+
meta {
36+
description = "Create provisioner through terraform"
37+
labels = {
38+
"key1" : "value1",
39+
"key2" : "value2",
40+
}
41+
}
42+
}
43+
```
44+
45+
<!-- schema generated by tfplugindocs -->
46+
## Schema
47+
48+
### Required
49+
50+
- `management_cluster` (String) Name of the management cluster. Edit operation such as create, update and delete is not supported for TKG vSphere & TKG service vSphere management cluster provisioners.
51+
- `name` (String) Name of the provisioner
52+
53+
### Optional
54+
55+
- `meta` (Block List, Max: 1) Metadata for the resource (see [below for nested schema](#nestedblock--meta))
56+
- `org_id` (String) ID of the organization
57+
58+
### Read-Only
59+
60+
- `id` (String) The ID of this resource.
61+
62+
<a id="nestedblock--meta"></a>
63+
### Nested Schema for `meta`
64+
65+
Optional:
66+
67+
- `annotations` (Map of String) Annotations for the resource
68+
- `description` (String) Description of the resource
69+
- `labels` (Map of String) Labels for the resource
70+
71+
Read-Only:
72+
73+
- `resource_version` (String) Resource version of the resource
74+
- `uid` (String) UID of the resource

‎templates/data-sources/provisioner.md.tmpl

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
Title: "Provisioner data source in a management cluster"
3+
Description: |-
4+
Provisioner data source in a management cluster.
5+
---
6+
7+
# Management Cluster Provisioner
8+
9+
Read provisioner in a management cluster using this Terraform module.
10+
11+
### Tanzu Kubernetes Grid Service and Tanzu Kubernetes Grid vSphere
12+
- Only provisioner read feature is enabled for Tanzu Kubernetes Grid Service and Tanzu Kubernetes Grid vSphere management clusters.
13+
- For a Tanzu Kubernetes cluster running in vSphere, you add a provisioner by creating
14+
a namespace in the management cluster, which you can do using kubectl.
15+
For more information, see [Create Namespaces in the Management Cluster] in the VMware Tanzu Kubernetes Grid Product Documentation.
16+
- For a Tanzu Kubernetes cluster running in vSphere with Tanzu, you add a provisioner by creating
17+
a vSphere namespace in the Supervisor Cluster, which you can do in your vSphere environment.
18+
For more information, see [Configuring and Managing vSphere Namespaces] in the vSphere with
19+
Tanzu Configuration and Management documentation.
20+
21+
[Create Namespaces in the Management Cluster] : https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-cluster-lifecycle-multiple-management-clusters.html#namespaces
22+
[Configuring and Managing vSphere 7.x Namespaces] : https://docs.vmware.com/en/VMware-vSphere/7.0/vmware-vsphere-with-tanzu/GUID-1544C9FE-0B23-434E-B823-C59EFC2F7309.html
23+
[Configuring and Managing vSphere 8.x Namespaces] : https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-services-workloads/GUID-1544C9FE-0B23-434E-B823-C59EFC2F7309.html
24+
25+
### Example Usage
26+
27+
{{ tffile "examples/data-sources/provisioner/data_source_provisioner.tf" }}
28+
29+
{{ .SchemaMarkdown | trimspace }}

‎templates/resources/provisioner.md.tmpl

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
Title: "Provisioner resource in a management cluster"
3+
Description: |-
4+
Provisioner resource lifecycle management.
5+
---
6+
7+
# Management Cluster Provisioner
8+
9+
Lifecycle management of provisioner in a management cluster using this Terraform module.
10+
11+
Addition of a provisioner resource refers to creation of namespace in the management cluster.
12+
13+
### Tanzu Kubernetes Grid Service and Tanzu Kubernetes Grid vSphere
14+
- Only provisioner read only feature is enabled for Tanzu Kubernetes Grid Service and Tanzu Kubernetes Grid vSphere management clusters.
15+
- For a Tanzu Kubernetes cluster running in vSphere, you add a provisioner by creating
16+
a namespace in the management cluster, which you can do using kubectl.
17+
For more information, see [Create Namespaces in the Management Cluster] in the VMware Tanzu Kubernetes Grid Product Documentation.
18+
- For a Tanzu Kubernetes cluster running in vSphere with Tanzu, you add a provisioner by creating
19+
a vSphere namespace in the Supervisor Cluster, which you can do in your vSphere environment.
20+
For more information, see [Configuring and Managing vSphere Namespaces] in the vSphere with
21+
Tanzu Configuration and Management documentation.
22+
23+
[Create Namespaces in the Management Cluster] : https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-cluster-lifecycle-multiple-management-clusters.html#namespaces
24+
[Configuring and Managing vSphere 7.x Namespaces] : https://docs.vmware.com/en/VMware-vSphere/7.0/vmware-vsphere-with-tanzu/GUID-1544C9FE-0B23-434E-B823-C59EFC2F7309.html
25+
[Configuring and Managing vSphere 8.x Namespaces] : https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-services-workloads/GUID-1544C9FE-0B23-434E-B823-C59EFC2F7309.html
26+
27+
### Example Usage
28+
29+
{{ tffile "examples/resources/provisioner/provisioner_resource.tf" }}
30+
31+
{{ .SchemaMarkdown | trimspace }}

0 commit comments

Comments
 (0)