Skip to content

Commit

Permalink
Generate documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Ishan Gupta <gishan@vmware.com>
  • Loading branch information
ishangupta-ds committed Mar 20, 2024
1 parent e8df664 commit 44af737
Show file tree
Hide file tree
Showing 16 changed files with 136 additions and 144 deletions.
36 changes: 18 additions & 18 deletions docs/data-sources/helm_charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,34 +46,34 @@ data "tanzu-mission-control_helm_charts" "get_cluster_helm_repo" {

Read-Only:

- `chart_metadata_name` (String) Name of the helm chart.
- `name` (String) Version of helm chart such as 0.5.1
- `spec` (List of Object) Spec for the Helm chart. (see [below for nested schema](#nestedobjatt--charts--spec))
- `chart_metadata_name` (String)
- `name` (String)
- `spec` (List of Object) (see [below for nested schema](#nestedobjatt--charts--spec))

<a id="nestedobjatt--charts--spec"></a>
### Nested Schema for `charts.spec`

Read-Only:

- `api_version` (String) The chart API version.
- `app_version` (String) Application version of the chart.
- `api_version` (String)
- `app_version` (String)
- `dependencies` (List of Object) (see [below for nested schema](#nestedobjatt--charts--spec--dependencies))
- `deprecated` (Boolean) Whether this chart is deprecated.
- `kube_version` (String) A SemVer range of compatible Kubernetes versions.
- `released_at` (String) Date on which helm chart is released.
- `sources` (List of String) List of URLs to source code for this project.
- `urls` (List of String) List of URLs to download helm chart bundle.
- `values_config` (String) Default configuration values for this chart.
- `deprecated` (Boolean)
- `kube_version` (String)
- `released_at` (String)
- `sources` (List of String)
- `urls` (List of String)
- `values_config` (String)

<a id="nestedobjatt--charts--spec--dependencies"></a>
### Nested Schema for `charts.spec.dependencies`

Read-Only:

- `alias` (String) Alias to be used for the chart.
- `chart_name` (String) Name of the chart.
- `chart_version` (Boolean) Version of the chart.
- `condition` (String) Yaml path that resolves to a boolean, used for enabling/disabling charts.
- `import_values` (List of String)Holds the mapping of source values to parent key to be imported.
- `repository` (List of String) Repository URL.
- `tags` (List of String) Tags can be used to group charts for enabling/disabling together.
- `alias` (String)
- `chart_name` (String)
- `chart_version` (Boolean)
- `condition` (String)
- `import_values` (List of String)
- `repository` (List of String)
- `tags` (List of String)
2 changes: 1 addition & 1 deletion docs/data-sources/helm_repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ Read-Only:

Read-Only:

- `url` (String) URL of helm repository.
- `url` (String)
16 changes: 8 additions & 8 deletions docs/data-sources/inspections.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ This data source enables users to list cluster inspections.

```terraform
data "tanzu-mission-control_inspections" "demo" {
management_cluster_name = "MGMT_CLS_NAME"
provisioner_name = "PROVISIONER_NAME"
cluster_name = "CLS_NAME"
}
output "inspections" {
value = data.tanzu-mission-control_inspections.demo.inspections
}
management_cluster_name = "MGMT_CLS_NAME"
provisioner_name = "PROVISIONER_NAME"
cluster_name = "CLS_NAME"
}
output "inspections" {
value = data.tanzu-mission-control_inspections.demo.inspections
}
```

<!-- schema generated by tfplugindocs -->
Expand Down
54 changes: 25 additions & 29 deletions docs/data-sources/management_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,52 +28,32 @@ For more information, see [Register a Management Cluster with Tanzu Mission Cont
```terraform
# Read Tanzu Mission Control management cluster registration : fetch management cluster registration details
data "tanzu-mission-control_management_cluster" "read_management_cluster_registration" {
name = "default" # Required
name = "default" # Required
org_id = "<ID of Organization>" # Optional value
}
```

<!-- schema generated by tfplugindocs -->

## Schema

### Required

- `name` (String) Name of this management cluster
- `spec` (Block List, Min: 1, Max: 1) spec for management cluster registration. (
see [below for nested schema](#nestedblock--spec))

### Optional

- `org_id` (String) ID of Organization.
- `meta` (Block List, Max: 1) Metadata for the resource (see [below for nested schema](#nestedblock--meta))
- `register_management_cluster` (Block List, Max: 1) (
see [below for nested schema](#nestedblock--register_management_cluster))
- `org_id` (String) ID of Organization.
- `ready_wait_timeout` (String) Wait timeout duration.
- `register_management_cluster` (Block List, Max: 1) (see [below for nested schema](#nestedblock--register_management_cluster))
- `spec` (Block List, Max: 1) (see [below for nested schema](#nestedblock--spec))

### Read-Only

- `id` (String) The ID of this resource.
- `status` (Map of String) Status of the cluster
- `ready_wait_timeout` (String) Wait timeout duration.

<a id="nestedblock--spec"></a>

### Nested Schema for `spec`

Required:

- `cluster_group` (String) Cluster group name to be used by default for workload clusters
- `kubernetes_provider_type` (String) Kubernetes provider type

Optional:

- `image_registry` (String) Image registry which is only allowed for TKGm
- `managed_workload_cluster_image_registry` (String) Managed workload cluster image registry
- `management_proxy_name` (String) Management cluster proxy name
- `managed_workload_cluster_proxy_name` (String) Managed workload cluster proxy name
- `status` (Map of String) Status of the management cluster

<a id="nestedblock--meta"></a>

### Nested Schema for `meta`

Optional:
Expand All @@ -87,12 +67,28 @@ Read-Only:
- `resource_version` (String) Resource version of the resource
- `uid` (String) UID of the resource

<a id="nestedblock--register_management_cluster"></a>

<a id="nestedblock--register_management_cluster"></a>
### Nested Schema for `register_management_cluster`

Optional:

- `tkgm_kubeconfig_file` (String) Register management cluster KUBECONFIG path for only TKGm
- `tkgm_kubeconfig_raw` (String) Register management cluster KUBECONFIG for only TKGm
- `tkgm_description` (String) Register management cluster description for only TKGm
- `tkgm_kubeconfig_file` (String) Register management cluster KUBECONFIG path for only TKGm
- `tkgm_kubeconfig_raw` (String, Sensitive) Register management cluster KUBECONFIG for only TKGm


<a id="nestedblock--spec"></a>
### Nested Schema for `spec`

Required:

- `cluster_group` (String) Cluster group name to be used by default for workload clusters
- `kubernetes_provider_type` (String) Kubernetes provider type

Optional:

- `image_registry` (String) Image registry which is only allowed for TKGm
- `managed_workload_cluster_image_registry` (String) Managed workload cluster image registry
- `managed_workload_cluster_proxy_name` (String) Managed workload cluster proxy name
- `management_proxy_name` (String) Management cluster proxy name
12 changes: 6 additions & 6 deletions docs/data-sources/package.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ data "tanzu-mission-control_package" "get_cluster_package" {
### Read-Only

- `id` (String) The ID of this resource.
- `namespace_name` (String) Namespae of package.
- `namespace_name` (String) Namespace of package.
- `spec` (List of Object) Spec for the Repository. (see [below for nested schema](#nestedatt--spec))

<a id="nestedblock--scope"></a>
Expand Down Expand Up @@ -131,14 +131,14 @@ Read-Only:

- `examples` (List of Object) (see [below for nested schema](#nestedobjatt--spec--values_schema--template--raw--examples))
- `properties` (List of Object) (see [below for nested schema](#nestedobjatt--spec--values_schema--template--raw--properties))
- `title` (String) Title of object.
- `title` (String)

<a id="nestedobjatt--spec--values_schema--template--raw--examples"></a>
### Nested Schema for `spec.values_schema.template.raw.examples`

Read-Only:

- `namespace` (String) Namespace name.
- `namespace` (String)


<a id="nestedobjatt--spec--values_schema--template--raw--properties"></a>
Expand All @@ -153,6 +153,6 @@ Read-Only:

Read-Only:

- `default` (String) Default value of object.
- `description` (String) Description of the object of object.
- `type` (String) Type of object.
- `default` (String)
- `description` (String)
- `type` (String)
1 change: 1 addition & 0 deletions docs/data-sources/package_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Read-Only:

- `inline_values` (Map of String)
- `package_ref` (List of Object) (see [below for nested schema](#nestedobjatt--spec--package_ref))
- `path_to_inline_values` (String)
- `role_binding_scope` (String)

<a id="nestedobjatt--spec--package_ref"></a>
Expand Down
10 changes: 5 additions & 5 deletions docs/data-sources/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,14 +120,14 @@ Read-Only:

- `examples` (List of Object) (see [below for nested schema](#nestedobjatt--packages--spec--values_schema--template--raw--examples))
- `properties` (List of Object) (see [below for nested schema](#nestedobjatt--packages--spec--values_schema--template--raw--properties))
- `title` (String) Title of object.
- `title` (String)

<a id="nestedobjatt--packages--spec--values_schema--template--raw--examples"></a>
### Nested Schema for `packages.spec.values_schema.template.raw.title`

Read-Only:

- `namespace` (String) Namespace name.
- `namespace` (String)


<a id="nestedobjatt--packages--spec--values_schema--template--raw--properties"></a>
Expand All @@ -142,6 +142,6 @@ Read-Only:

Read-Only:

- `default` (String) Default value of object.
- `description` (String) Description of the object of object.
- `type` (String) Type of object.
- `default` (String)
- `description` (String)
- `type` (String)
4 changes: 2 additions & 2 deletions docs/data-sources/provisioner.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Read provisioner in a management cluster using this Terraform module.
# Read Tanzu Mission Control provisioner : fetch the given provisioner details
data "tanzu-mission-control_provisioner" "read_provisioner" {
provisioners {
name = "test-provisioner" # Optional
management_cluster = "eks" # Required
name = "test-provisioner" # Optional
management_cluster = "eks" # Required
}
}
Expand Down
10 changes: 5 additions & 5 deletions docs/guides/tanzu-mission-control_data_protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You can use the following template as reference for enabling all stages of data
// Tanzu Mission Control Data Protection Feature
locals {
cluster_name = "<cluster-name>"
cluster_name = "<cluster-name>"
management_cluster_name = "<management-cluster-name>"
provisioner_name = "<provisioner-name>"
}
Expand Down Expand Up @@ -81,11 +81,11 @@ resource "tanzu-mission-control_enable_data_protection" "data_protection" {
// Create Target Location for Scheduled Back Up
// Self managed AWS Target Location
resource "tanzu-mission-control_target_location" "aws_self_provisioned" {
name = "<target-location-name>"
name = "<target-location-name>"
spec {
target_provider = "AWS"
credential = {
credential = {
name = "<aws-credential-name?"
}
Expand Down Expand Up @@ -114,7 +114,7 @@ resource "tanzu-mission-control_target_location" "aws_self_provisioned" {
// Create Full Cluster Scheduled Back Up
resource "tanzu-mission-control_backup_schedule" "backup_full_cluster" {
name = "<scheduled-backup-name>"
name = "<scheduled-backup-name>"
scope {
cluster {
cluster_name = local.cluster_name
Expand All @@ -131,7 +131,7 @@ resource "tanzu-mission-control_backup_schedule" "backup_full_cluster" {
}
template {
backup_ttl = "2592000s"
backup_ttl = "2592000s"
excluded_namespaces = [
"<namespace-1>",
]
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/tanzu-mission-control_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ resource "tanzu-mission-control_custom_policy" "cluster_group_scoped_custom_temp
input {
custom {
template_name = tanzu-mission-control_custom_policy_template.sample_template.name
audit = false
audit = false
target_kubernetes_resources {
api_groups = [
Expand Down
8 changes: 4 additions & 4 deletions docs/resources/ekscluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ resource "tanzu-mission-control_ekscluster" "tf_eks_cluster" {
vpc_cni_config {
eni_config {
id = "subnet-0a680171b6330619f" // Required, need not belong to the same VPC as the cluster, subnets provided in vpc_cni_config are expected to be in different AZs
security_groups = [ //optional, if not provided, the cluster security group will be used
security_groups = [ //optional, if not provided, the cluster security group will be used
"sg-00c96ad9d02a22522",
]
}
Expand Down Expand Up @@ -289,18 +289,18 @@ Optional:

Optional:

- `eni_config` (Block List) ENI config is the VPC CNI Elastic Network Interface config for providing the configuration of subnet and security groups for pods in each AZ. Subnets need not be in the same VPC as the cluster. The subnets provided across eniConfigs should be in different availability zones. Nodepool subnets need to be in the same AZ as the AZs used in ENIConfig. (see [below for nested schema](#nestedblock--spec--config--addons_config--vpc_cni_config--eni_config))
- `eni_config` (Block List) ENI config for the VPC CNI addon (see [below for nested schema](#nestedblock--spec--config--addons_config--vpc_cni_config--eni_config))

<a id="nestedblock--spec--config--addons_config--vpc_cni_config--eni_config"></a>
### Nested Schema for `spec.config.addons_config.vpc_cni_config.eni_config`

Required:

- `id` (String) Subnet Id for the pods running in all Nodes in a given AZ.
- `id` (String) Subnet id for the ENI

Optional:

- `security_groups` (Set of String) List of security group is optional and if not provided default security group created by EKS will be used.
- `security_groups` (Set of String) Security groups for the ENI



Expand Down
22 changes: 11 additions & 11 deletions docs/resources/enable_data_protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ resource "tanzu-mission-control_enable_data_protection" "demo" {
resource "tanzu-mission-control_enable_data_protection" "cgdemo" {
scope {
cluster_group {
cluster_group_name = "default"
cluster_group_name = "default"
}
}
Expand All @@ -53,22 +53,22 @@ resource "tanzu-mission-control_enable_data_protection" "cgdemo" {
enable_all_api_group_versions_backup = false
selector {
labelselector {
matchexpressions {
key = "site"
operator = "NotIn"
values = [
"one",
"two"
]
}
labelselector {
matchexpressions {
key = "site"
operator = "NotIn"
values = [
"one",
"two"
]
}
}
}
}
deletion_policy {
delete_backups = false
force = true
force = true
}
}
```
Expand Down
Loading

0 comments on commit 44af737

Please sign in to comment.