Skip to content

Commit e0e8b12

Browse files
VasundharashuklaVasundharashukla
authored
Merge pull request #97 from vmware/vasundharas/documentation-tsm-integration
Documentation for Tanzu Service Mesh Integration
2 parents 65cb41d + 2c236c9 commit e0e8b12

File tree

9 files changed

+273
-60
lines changed

9 files changed

+273
-60
lines changed

‎docs/data-sources/integration.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
Title: "Tanzu Service Mesh Integration Resource"
3+
Description: |-
4+
Fetching the details of Integration by Tanzu Service Mesh.
5+
---
6+
7+
# Tanzu Service Mesh Integration
8+
9+
The `Tanzu Service Mesh integration` is available on the Tanzu Mission Control platform.
10+
When the Tanzu Service Mesh service has been enabled on your organization, your Tanzu Mission Control organization administrator can enable the integration for use on clusters that are managed through Tanzu Mission Control.
11+
Then, cluster administrators can add Tanzu Service Mesh to managed clusters and designate which namespaces should belong in the mesh.
12+
`Tanzu Mission Control` takes care of the installation of service mesh components in the cluster, provides health status, and onboards it into Tanzu Service Mesh.
13+
14+
For reading the Tanzu Service Mesh Integration via the terraform provider, use the following configuration.
15+
16+
## Example Usage
17+
18+
```terraform
19+
# Read Tanzu Mission Control TSM integration : fetch details
20+
data "tanzu-mission-control_integration" "read_tsm-integration" {
21+
management_cluster_name = "attached"
22+
provisioner_name = "attached"
23+
cluster_name = "test-cluster"
24+
integration_name = "tanzu-service-mesh"
25+
}
26+
```
27+
28+
<!-- schema generated by tfplugindocs -->
29+
## Schema
30+
31+
### Required
32+
33+
- `cluster_name` (String) Name of this cluster
34+
- `integration_name` (String) Name of the Integration; valid options are currently only ['tanzu-service-mesh']
35+
- `spec` (Block List, Min: 1, Max: 1) Specification for the Integration (see [below for nested schema](#nestedblock--spec))
36+
37+
### Optional
38+
39+
- `management_cluster_name` (String) Name of the management cluster
40+
- `meta` (Block List, Max: 1) Metadata for the resource (see [below for nested schema](#nestedblock--meta))
41+
- `provisioner_name` (String) Provisioner of the cluster
42+
43+
### Read-Only
44+
45+
- `id` (String) The ID of this resource.
46+
- `status` (Map of String) Status of Integration
47+
48+
<a id="nestedblock--spec"></a>
49+
### Nested Schema for `spec`
50+
51+
Optional:
52+
53+
- `configurations` (String) Integration specific configurations in JSON format
54+
55+
56+
<a id="nestedblock--meta"></a>
57+
### Nested Schema for `meta`
58+
59+
Optional:
60+
61+
- `annotations` (Map of String) Annotations for the resource
62+
- `description` (String) Description of the resource
63+
- `labels` (Map of String) Labels for the resource
64+
65+
Read-Only:
66+
67+
- `resource_version` (String) Resource version of the resource
68+
- `uid` (String) UID of the resource

‎docs/resources/integration.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
Title: "Tanzu Service Mesh Integration Resource"
3+
Description: |-
4+
Creating the Integration by Tanzu Service Mesh on a cluster.
5+
---
6+
7+
# Tanzu Service Mesh Integration
8+
9+
The `Tanzu Service Mesh integration` is available on the Tanzu Mission Control platform.
10+
When the Tanzu Service Mesh service has been enabled on your organization, your Tanzu Mission Control organization administrator can enable the integration for use on clusters that are managed through Tanzu Mission Control.
11+
Then, cluster administrators can add Tanzu Service Mesh to managed clusters and designate which namespaces should belong in the mesh.
12+
`Tanzu Mission Control` takes care of the installation of service mesh components in the cluster, provides health status, and onboards it into Tanzu Service Mesh.
13+
14+
For leveraging this feature via the terraform provider, use the following configuration.
15+
16+
## Example Usage
17+
18+
```terraform
19+
# Create Tanzu Mission Control TSM Integration resource
20+
resource "tanzu-mission-control_integration" "create_tsm-integration" {
21+
management_cluster_name = "attached"
22+
provisioner_name = "attached"
23+
cluster_name = "test-cluster"
24+
integration_name = "tanzu-service-mesh"
25+
26+
spec {
27+
configurations = jsonencode({
28+
enableNamespaceExclusions = true
29+
namespaceExclusions = [
30+
{
31+
match = "custom-namespace-1"
32+
type = "EXACT"
33+
}, {
34+
match = "kube"
35+
type = "START_WITH"
36+
}
37+
]
38+
})
39+
}
40+
}
41+
```
42+
43+
<!-- schema generated by tfplugindocs -->
44+
## Schema
45+
46+
### Required
47+
48+
- `cluster_name` (String) Name of this cluster
49+
- `integration_name` (String) Name of the Integration; valid options are currently only ['tanzu-service-mesh']
50+
- `spec` (Block List, Min: 1, Max: 1) Specification for the Integration (see [below for nested schema](#nestedblock--spec))
51+
52+
### Optional
53+
54+
- `management_cluster_name` (String) Name of the management cluster
55+
- `meta` (Block List, Max: 1) Metadata for the resource (see [below for nested schema](#nestedblock--meta))
56+
- `provisioner_name` (String) Provisioner of the cluster
57+
58+
### Read-Only
59+
60+
- `id` (String) The ID of this resource.
61+
- `status` (Map of String) Status of Integration
62+
63+
<a id="nestedblock--spec"></a>
64+
### Nested Schema for `spec`
65+
66+
Optional:
67+
68+
- `configurations` (String) Integration specific configurations in JSON format
69+
70+
71+
<a id="nestedblock--meta"></a>
72+
### Nested Schema for `meta`
73+
74+
Optional:
75+
76+
- `annotations` (Map of String) Annotations for the resource
77+
- `description` (String) Description of the resource
78+
- `labels` (Map of String) Labels for the resource
79+
80+
Read-Only:
81+
82+
- `resource_version` (String) Resource version of the resource
83+
- `uid` (String) UID of the resource

‎docs/resources/security_policy.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ resource "tanzu-mission-control_security_policy" "cluster_scoped_custom_security
117117
max = 5000
118118
}
119119
120-
allowed_volumes = [
120+
allowed_volumes = [
121121
"configMap",
122122
"nfs",
123123
"vsphereVolume"
@@ -176,7 +176,7 @@ resource "tanzu-mission-control_security_policy" "cluster_scoped_custom_security
176176
}
177177
178178
linux_capabilities {
179-
allowed_capabilities = [
179+
allowed_capabilities = [
180180
"CHOWN",
181181
"IPC_LOCK"
182182
]
@@ -187,15 +187,15 @@ resource "tanzu-mission-control_security_policy" "cluster_scoped_custom_security
187187
188188
allowed_host_paths {
189189
path_prefix = "p1"
190-
read_only = true
190+
read_only = true
191191
}
192192
allowed_host_paths {
193193
path_prefix = "p2"
194-
read_only = false
194+
read_only = false
195195
}
196196
allowed_host_paths {
197197
path_prefix = "p3"
198-
read_only = true
198+
read_only = true
199199
}
200200
201201
allowed_se_linux_options {
@@ -213,7 +213,7 @@ resource "tanzu-mission-control_security_policy" "cluster_scoped_custom_security
213213
}
214214
215215
seccomp {
216-
allowed_profiles = [
216+
allowed_profiles = [
217217
"Localhost"
218218
]
219219
allowed_localhost_files = [
@@ -261,7 +261,7 @@ resource "tanzu-mission-control_security_policy" "cluster_scoped_strict_security
261261
match_expressions {
262262
key = "component"
263263
operator = "NotIn"
264-
values = [
264+
values = [
265265
"api-server",
266266
"agent-gateway"
267267
]
@@ -308,7 +308,7 @@ resource "tanzu-mission-control_security_policy" "cluster_group_scoped_baseline_
308308
match_expressions {
309309
key = "component"
310310
operator = "In"
311-
values = [
311+
values = [
312312
"api-server",
313313
"agent-gateway"
314314
]
@@ -359,7 +359,7 @@ resource "tanzu-mission-control_security_policy" "cluster_group_scoped_custom_se
359359
max = 5000
360360
}
361361
362-
allowed_volumes = [
362+
allowed_volumes = [
363363
"configMap",
364364
"nfs",
365365
"vsphereVolume"
@@ -418,7 +418,7 @@ resource "tanzu-mission-control_security_policy" "cluster_group_scoped_custom_se
418418
}
419419
420420
linux_capabilities {
421-
allowed_capabilities = [
421+
allowed_capabilities = [
422422
"CHOWN",
423423
"IPC_LOCK"
424424
]
@@ -429,15 +429,15 @@ resource "tanzu-mission-control_security_policy" "cluster_group_scoped_custom_se
429429
430430
allowed_host_paths {
431431
path_prefix = "p1"
432-
read_only = true
432+
read_only = true
433433
}
434434
allowed_host_paths {
435435
path_prefix = "p2"
436-
read_only = false
436+
read_only = false
437437
}
438438
allowed_host_paths {
439439
path_prefix = "p3"
440-
read_only = true
440+
read_only = true
441441
}
442442
443443
allowed_se_linux_options {
@@ -455,8 +455,8 @@ resource "tanzu-mission-control_security_policy" "cluster_group_scoped_custom_se
455455
}
456456
457457
seccomp {
458-
allowed_profiles = [
459-
"Localhost"
458+
allowed_profiles = [
459+
"Localhost"
460460
]
461461
allowed_localhost_files = [
462462
"profiles/audit.json",
@@ -470,7 +470,7 @@ resource "tanzu-mission-control_security_policy" "cluster_group_scoped_custom_se
470470
match_expressions {
471471
key = "component"
472472
operator = "In"
473-
values = [
473+
values = [
474474
"api-server",
475475
"agent-gateway"
476476
]
@@ -583,7 +583,7 @@ resource "tanzu-mission-control_security_policy" "organization_scoped_custom_sec
583583
max = 5000
584584
}
585585
586-
allowed_volumes = [
586+
allowed_volumes = [
587587
"configMap",
588588
"nfs",
589589
"vsphereVolume"
@@ -642,7 +642,7 @@ resource "tanzu-mission-control_security_policy" "organization_scoped_custom_sec
642642
}
643643
644644
linux_capabilities {
645-
allowed_capabilities = [
645+
allowed_capabilities = [
646646
"CHOWN",
647647
"IPC_LOCK"
648648
]
@@ -653,15 +653,15 @@ resource "tanzu-mission-control_security_policy" "organization_scoped_custom_sec
653653
654654
allowed_host_paths {
655655
path_prefix = "p1"
656-
read_only = true
656+
read_only = true
657657
}
658658
allowed_host_paths {
659659
path_prefix = "p2"
660-
read_only = false
660+
read_only = false
661661
}
662662
allowed_host_paths {
663663
path_prefix = "p3"
664-
read_only = true
664+
read_only = true
665665
}
666666
667667
allowed_se_linux_options {
@@ -679,7 +679,7 @@ resource "tanzu-mission-control_security_policy" "organization_scoped_custom_sec
679679
}
680680
681681
seccomp {
682-
allowed_profiles = [
682+
allowed_profiles = [
683683
"Localhost"
684684
]
685685
allowed_localhost_files = [
@@ -694,7 +694,7 @@ resource "tanzu-mission-control_security_policy" "organization_scoped_custom_sec
694694
match_expressions {
695695
key = "component"
696696
operator = "In"
697-
values = [
697+
values = [
698698
"api-server",
699699
"agent-gateway"
700700
]
@@ -741,7 +741,7 @@ resource "tanzu-mission-control_security_policy" "organization_scoped_strict_sec
741741
match_expressions {
742742
key = "component"
743743
operator = "In"
744-
values = [
744+
values = [
745745
"api-server",
746746
"agent-gateway"
747747
]

‎examples/data-sources/integration/data-source.tf

+3-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
1-
data "tanzu-mission-control_cluster" "default" {
2-
management_cluster_name = "attached" # Default: attached
3-
provisioner_name = "attached" # Default: attached
4-
name = "terraform-test" # Required
5-
}
6-
7-
data "tanzu-mission-control_integration" "default" {
1+
# Read Tanzu Mission Control TSM integration : fetch details
2+
data "tanzu-mission-control_integration" "read_tsm-integration" {
83
management_cluster_name = "attached"
94
provisioner_name = "attached"
10-
cluster_name = tanzu-mission-control_cluster.default.name
5+
cluster_name = "test-cluster"
116
integration_name = "tanzu-service-mesh"
127
}

‎examples/resources/integration/resource.tf

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Create Tanzu Mission Control TSM Integration resource
2+
resource "tanzu-mission-control_integration" "create_tsm-integration" {
3+
management_cluster_name = "attached"
4+
provisioner_name = "attached"
5+
cluster_name = "test-cluster"
6+
integration_name = "tanzu-service-mesh"
7+
8+
spec {
9+
configurations = jsonencode({
10+
enableNamespaceExclusions = true
11+
namespaceExclusions = [
12+
{
13+
match = "custom-namespace-1"
14+
type = "EXACT"
15+
}, {
16+
match = "kube"
17+
type = "START_WITH"
18+
}
19+
]
20+
})
21+
}
22+
}

0 commit comments

Comments
 (0)