Skip to content

Commit

Permalink
Merge pull request #12 from aws-ia/md-links
Browse files Browse the repository at this point in the history
Use default markdown link format
  • Loading branch information
tlindsay42 authored Apr 19, 2022
2 parents 5dd29d1 + be6c16c commit fc1b6cb
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 54 deletions.
16 changes: 5 additions & 11 deletions .header.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# vSphere Tags Terraform Module

This Terraform module either creates or imports a list of [tags][tags] grouped in a [tag category][category] in your [VMware Cloud on AWS][vmconaws] or [VMware vSphere][vsphere] on‑premises environment. You use these tags to label your inventory objects with metadata to make it easier to sort and search for these objects.
This Terraform module either creates or imports a list of [tags](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-2FF21224-B6BC-499B-AD8B-D2C4309AD9DC.html) grouped in a [tag category](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-BA3D1794-28F2-43F3-BCE9-3964CB207FB6.html) in your [VMware Cloud on AWS](https://aws.amazon.com/vmware/) or [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) on‑premises environment.
You use these tags to label your inventory objects with metadata to make it easier to sort and search for these objects.

Tags and categories can span multiple [vCenter Server][vsphere] instances.
When you use [Hybrid Linked Mode][hybrid], tags and tag categories are maintained across your linked domain. So in this mode, the on‑premises and VMware Cloud on AWS software‑defined data centers (SDDCs) share tags and tag attributes.
If multiple on‑premises vCenter Server instances are configured to use [Enhanced Linked Mode][enhanced], tags and categories are replicated across the vCenter Server instances.
Tags and categories can span multiple [vCenter Server](https://docs.vmware.com/en/VMware-vSphere/index.html) instances.
When you use [Hybrid Linked Mode](https://docs.vmware.com/en/VMware-Cloud-on-AWS/services/com.vmware.vsphere.vmc-aws-manage-data-center-vms.doc/GUID-91C57891-4D61-4F4C-B580-74F3000B831D.html), tags and tag categories are maintained across your linked domain. So in this mode, the on‑premises and VMware Cloud on AWS software‑defined data centers (SDDCs) share tags and tag attributes.
If multiple on‑premises vCenter Server instances are configured to use [Enhanced Linked Mode](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-6ADB06EF-E342-457E-A17B-1EA31C0F6D4B.html), tags and categories are replicated across the vCenter Server instances.

## Usage

Expand Down Expand Up @@ -63,10 +64,3 @@ module "vsphere_tags" {
}
}
```

[category]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-BA3D1794-28F2-43F3-BCE9-3964CB207FB6.html
[enhanced]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-6ADB06EF-E342-457E-A17B-1EA31C0F6D4B.html
[hybrid]: https://docs.vmware.com/en/VMware-Cloud-on-AWS/services/com.vmware.vsphere.vmc-aws-manage-data-center-vms.doc/GUID-91C57891-4D61-4F4C-B580-74F3000B831D.html
[tags]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-2FF21224-B6BC-499B-AD8B-D2C4309AD9DC.html
[vsphere]: https://docs.vmware.com/en/VMware-vSphere/index.html
[vmconaws]: https://aws.amazon.com/vmware/
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
<!-- BEGIN_TF_DOCS -->
# vSphere Tags Terraform Module

This Terraform module either creates or imports a list of [tags][tags] grouped in a [tag category][category] in your [VMware Cloud on AWS][vmconaws] or [VMware vSphere][vsphere] on&#8209;premises environment. You use these tags to label your inventory objects with metadata to make it easier to sort and search for these objects.
This Terraform module either creates or imports a list of [tags](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-2FF21224-B6BC-499B-AD8B-D2C4309AD9DC.html) grouped in a [tag category](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-BA3D1794-28F2-43F3-BCE9-3964CB207FB6.html) in your [VMware Cloud on AWS](https://aws.amazon.com/vmware/) or [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) on&#8209;premises environment.
You use these tags to label your inventory objects with metadata to make it easier to sort and search for these objects.

Tags and categories can span multiple [vCenter Server][vsphere] instances.
When you use [Hybrid Linked Mode][hybrid], tags and tag categories are maintained across your linked domain. So in this mode, the on&#8209;premises and VMware Cloud on AWS software&#8209;defined data centers (SDDCs) share tags and tag attributes.
If multiple on&#8209;premises vCenter Server instances are configured to use [Enhanced Linked Mode][enhanced], tags and categories are replicated across the vCenter Server instances.
Tags and categories can span multiple [vCenter Server](https://docs.vmware.com/en/VMware-vSphere/index.html) instances.
When you use [Hybrid Linked Mode](https://docs.vmware.com/en/VMware-Cloud-on-AWS/services/com.vmware.vsphere.vmc-aws-manage-data-center-vms.doc/GUID-91C57891-4D61-4F4C-B580-74F3000B831D.html), tags and tag categories are maintained across your linked domain. So in this mode, the on&#8209;premises and VMware Cloud on AWS software&#8209;defined data centers (SDDCs) share tags and tag attributes.
If multiple on&#8209;premises vCenter Server instances are configured to use [Enhanced Linked Mode](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-6ADB06EF-E342-457E-A17B-1EA31C0F6D4B.html), tags and categories are replicated across the vCenter Server instances.

## Usage

Expand Down Expand Up @@ -65,13 +66,6 @@ module "vsphere_tags" {
}
```

[category]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-BA3D1794-28F2-43F3-BCE9-3964CB207FB6.html
[enhanced]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-6ADB06EF-E342-457E-A17B-1EA31C0F6D4B.html
[hybrid]: https://docs.vmware.com/en/VMware-Cloud-on-AWS/services/com.vmware.vsphere.vmc-aws-manage-data-center-vms.doc/GUID-91C57891-4D61-4F4C-B580-74F3000B831D.html
[tags]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-2FF21224-B6BC-499B-AD8B-D2C4309AD9DC.html
[vsphere]: https://docs.vmware.com/en/VMware-vSphere/index.html
[vmconaws]: https://aws.amazon.com/vmware/

## Requirements

| Name | Version |
Expand Down
21 changes: 5 additions & 16 deletions examples/basic/.header.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Basic example

If deployed with the default values, this example will create two [tags][tags]: 1/&nbsp;`terraform` and 2/&nbsp;`project` grouped in a [tag category][category] named `example-category` in your [VMware Cloud on AWS][vmconaws] or [VMware vSphere][vsphere] on&#8209;premises environment.
If deployed with the default values, this example will create two [tags](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-2FF21224-B6BC-499B-AD8B-D2C4309AD9DC.html): 1/&nbsp;`terraform` and 2/&nbsp;`project` grouped in a [tag category](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-BA3D1794-28F2-43F3-BCE9-3964CB207FB6.html) named `example-category` in your [VMware Cloud on AWS](https://aws.amazon.com/vmware/) or [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) on&#8209;premises environment.

## Usage

### Configure the provider

One way to configure the VMware vSphere provider is with [environment variables][env_vars], for example:
One way to configure the VMware vSphere provider is with [environment variables](https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs#argument-reference), for example:

* Required
* `VSPHERE_USER`: Username for vSphere API operations.
Expand All @@ -19,7 +19,7 @@ One way to configure the VMware vSphere provider is with [environment variables]

### Configure the input variables

All of the variables in this example have default values, but if you would like to override any of these, one way to do so is to create a [`terraform.tfvars` variable definition file][tfvars] in this directory.
All of the variables in this example have default values, but if you would like to override any of these, one way to do so is to create a [`terraform.tfvars` variable definition file](https://www.terraform.io/language/values/variables#variable-definitions-tfvars-files) in this directory.

#### Example `terraform.tfvars`

Expand All @@ -31,19 +31,8 @@ tags = {

### Deploy

To deploy this example, execute the following: 1/&nbsp;[`terraform init`][tf_init], 2/&nbsp;[`terraform plan`][tf_plan], and 3/&nbsp;[`terraform apply`][tf_apply].
To deploy this example, execute the following: 1/&nbsp;[`terraform init`](https://www.terraform.io/cli/commands/init), 2/&nbsp;[`terraform plan`](https://www.terraform.io/cli/commands/plan), and 3/&nbsp;[`terraform apply`](https://www.terraform.io/cli/commands/apply).

### Clean-up

When you want to remove the resources, execute the following: [`terraform destroy`][tf_destroy].

[category]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-BA3D1794-28F2-43F3-BCE9-3964CB207FB6.html
[env_vars]: https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs#argument-reference
[tags]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-2FF21224-B6BC-499B-AD8B-D2C4309AD9DC.html
[tf_apply]: https://www.terraform.io/cli/commands/apply
[tf_destroy]: https://www.terraform.io/cli/commands/destroy
[tf_init]: https://www.terraform.io/cli/commands/init
[tf_plan]: https://www.terraform.io/cli/commands/plan
[tfvars]: https://www.terraform.io/language/values/variables#variable-definitions-tfvars-files
[vsphere]: https://docs.vmware.com/en/VMware-vSphere/index.html
[vmconaws]: https://aws.amazon.com/vmware/
When you want to remove the resources, execute the following: [`terraform destroy`](https://www.terraform.io/cli/commands/destroy).
21 changes: 5 additions & 16 deletions examples/basic/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- BEGIN_TF_DOCS -->
# Basic example

If deployed with the default values, this example will create two [tags][tags]: 1/&nbsp;`terraform` and 2/&nbsp;`project` grouped in a [tag category][category] named `example-category` in your [VMware Cloud on AWS][vmconaws] or [VMware vSphere][vsphere] on&#8209;premises environment.
If deployed with the default values, this example will create two [tags](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-2FF21224-B6BC-499B-AD8B-D2C4309AD9DC.html): 1/&nbsp;`terraform` and 2/&nbsp;`project` grouped in a [tag category](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-BA3D1794-28F2-43F3-BCE9-3964CB207FB6.html) named `example-category` in your [VMware Cloud on AWS](https://aws.amazon.com/vmware/) or [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) on&#8209;premises environment.

## Usage

### Configure the provider

One way to configure the VMware vSphere provider is with [environment variables][env\_vars], for example:
One way to configure the VMware vSphere provider is with [environment variables](https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs#argument-reference), for example:

* Required
* `VSPHERE_USER`: Username for vSphere API operations.
Expand All @@ -20,7 +20,7 @@ One way to configure the VMware vSphere provider is with [environment variables]

### Configure the input variables

All of the variables in this example have default values, but if you would like to override any of these, one way to do so is to create a [`terraform.tfvars` variable definition file][tfvars] in this directory.
All of the variables in this example have default values, but if you would like to override any of these, one way to do so is to create a [`terraform.tfvars` variable definition file](https://www.terraform.io/language/values/variables#variable-definitions-tfvars-files) in this directory.

#### Example `terraform.tfvars`

Expand All @@ -32,22 +32,11 @@ tags = {

### Deploy

To deploy this example, execute the following: 1/&nbsp;[`terraform init`][tf\_init], 2/&nbsp;[`terraform plan`][tf\_plan], and 3/&nbsp;[`terraform apply`][tf\_apply].
To deploy this example, execute the following: 1/&nbsp;[`terraform init`](https://www.terraform.io/cli/commands/init), 2/&nbsp;[`terraform plan`](https://www.terraform.io/cli/commands/plan), and 3/&nbsp;[`terraform apply`](https://www.terraform.io/cli/commands/apply).

### Clean-up

When you want to remove the resources, execute the following: [`terraform destroy`][tf\_destroy].

[category]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-BA3D1794-28F2-43F3-BCE9-3964CB207FB6.html
[env\_vars]: https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs#argument-reference
[tags]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-2FF21224-B6BC-499B-AD8B-D2C4309AD9DC.html
[tf\_apply]: https://www.terraform.io/cli/commands/apply
[tf\_destroy]: https://www.terraform.io/cli/commands/destroy
[tf\_init]: https://www.terraform.io/cli/commands/init
[tf\_plan]: https://www.terraform.io/cli/commands/plan
[tfvars]: https://www.terraform.io/language/values/variables#variable-definitions-tfvars-files
[vsphere]: https://docs.vmware.com/en/VMware-vSphere/index.html
[vmconaws]: https://aws.amazon.com/vmware/
When you want to remove the resources, execute the following: [`terraform destroy`](https://www.terraform.io/cli/commands/destroy).

## Requirements

Expand Down

0 comments on commit fc1b6cb

Please sign in to comment.