Skip to content
This repository was archived by the owner on Aug 8, 2025. It is now read-only.

Commit 8d1b2fa

Browse files
committed
Added pair site documentation and refactor README
1 parent 9066609 commit 8d1b2fa

File tree

4 files changed

+102
-5
lines changed

4 files changed

+102
-5
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ appliance roles:
1212
The initial configuration includes changing the initial password of the **root** user of the appliance, adding external
1313
Replicator Service instances and configuring the Tunnel Service.
1414

15-
* For information about the Terraform provider, see the [provider documentation](https://registry.terraform.io/providers/hashicorp/vcda/latest/docs).
15+
Since VCDA Terraform Provider v2.0.0, the provider supports one-step pairing of either a Cloud Director Replication Management Appliance to an already configured
16+
Cloud Director Replication Management Appliance, or vCenter Replication Management Appliance to an already configured vCenter Replication Management Appliance.
17+
18+
* For information about the Terraform provider, see the [provider documentation](https://registry.terraform.io/providers/vmware/vcda/latest/docs).
1619
* For information about VMware Cloud Director Availability,
1720
see the [ Product Page](https://www.vmware.com/products/cloud-director-availability.html).
1821
* For more information,
@@ -78,7 +81,7 @@ instructions above, follow the instructions
7881
to [install it as a plugin](https://www.terraform.io/docs/plugins/basics.html#installing-plugins). After placing the
7982
custom-built provider into your plugins directory, to initialize it run `terraform init`.
8083

81-
For information about either installation method and for documentation about the provider-specific configuration options, see the [VMware Cloud Director Availability provider's website](https://www.terraform.io/docs/providers/vmware-cloud-director-availability/index.html).
84+
For information about either installation method and for documentation about the provider-specific configuration options, see the [VMware Cloud Director Availability provider's website](https://registry.terraform.io/providers/vmware/vcda/latest/docs).
8285
8386
# Automated Installation (Recommended)
8487
@@ -142,9 +145,9 @@ work is being duplicated, before you start working on a feature, check the
142145
[Issue Tracker][gh-issues] and the existing [Pull Requests][gh-prs]. For further clarification, you can also ask in a
143146
new issue.
144147
145-
[gh-issues]: https://github.com/vmware/terraform-provider-for-vmware-cloud-director-availability/issues
148+
[gh-issues]: https://github.com/vmware/terraform-provider-vcda/issues
146149
147-
[gh-prs]: https://github.com/vmware/terraform-provider-for-vmware-cloud-director-availability/pulls
150+
[gh-prs]: https://github.com/vmware/terraform-provider-vcda/pulls
148151
149152
For more information, see the [Building the Provider](#building-the-provider) section and for instructions
150153
about manually loading the provider for development, see the [Manual Installation](#manual-installation) section.
@@ -189,6 +192,12 @@ Manager tests
189192
make testacc TESTS=/manager
190193
```
191194
195+
Pairing tests
196+
197+
```sh
198+
make testacc TESTS=/pair
199+
```
200+
192201
Data sources tests
193202
194203
```sh

docs/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ appliance roles:
1717
The initial configuration includes changing the initial password of the **root** user of the appliance, adding external
1818
Replicator Service instances and configuring the Tunnel Service.
1919

20+
Since VCDA Terraform Provider v2.0.0, the provider supports one-step pairing of either a Cloud Director Replication Management Appliance to an already configured
21+
Cloud Director Replication Management Appliance, or vCenter Replication Management Appliance to an already configured vCenter Replication Management Appliance.
22+
2023
Note: The provider must be configured with the correct credentials and inputs before it can be used.
2124

2225
* For more information,
@@ -26,11 +29,14 @@ Note: The provider must be configured with the correct credentials and inputs be
2629

2730
## Supported Versions
2831

29-
This provider supports the following versions of VMware Cloud Director Availability:
32+
The VCDA Terraform provider v1.0.0 supports the following versions of VMware Cloud Director Availability:
3033

3134
* [Version 4.5](https://docs.vmware.com/en/VMware-Cloud-Director-Availability/4.5/rn/vmware-cloud-director-availability-45-release-notes/index.html)
3235
* [Version 4.5.0.1](https://docs.vmware.com/en/VMware-Cloud-Director-Availability/4.5.0.1/rn/vmware-cloud-director-availability-4501-release-notes/index.html)
3336

37+
The VCDA Terraform provider v2.0.0 supports the following versions of VMware Cloud Director Availability:
38+
* [Version 4.6](https://docs.vmware.com/en/VMware-Cloud-Director-Availability/4.6/rn/vmware-cloud-director-availability-46-release-notes/index.html)
39+
3440
## Example Usage
3541

3642
```terraform

docs/resources/vcda_pair_site.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "vcda_pair_site Resource - terraform-provider-for-vmware-cloud-director-availability"
4+
subcategory: ""
5+
description: |-
6+
VMware Cloud Director Availability Pair Site resource.
7+
---
8+
9+
# vcda_pair_site (Resource)
10+
11+
The Pair Site resource performs one-step pairing of either:
12+
13+
- a Cloud Director Replication Management Appliance to an already configured
14+
Cloud Director Replication Management Appliance, or
15+
16+
- a vCenter Replication Management Appliance to an already configured vCenter Replication Management Appliance.
17+
18+
## Example Usage
19+
20+
### Pair Cloud Director Replication Management Appliance to an already configured Cloud Director Replication Management Appliance
21+
22+
```terraform
23+
resource "vcda_pair_site" "pair_cloud_site" {
24+
api_url = var.cloud_site_endpoint
25+
pairing_description = "pair cloud site"
26+
site = var.cloud_site_name
27+
28+
service_cert = data.vcda_service_cert.cloud_service_cert.id
29+
api_thumbprint = data.vcda_remote_services_thumbprint.cloud_site_thumbprint.id
30+
}
31+
```
32+
33+
### Pair vCenter Replication Management Appliance to an already configured vCenter Replication Management Appliance
34+
35+
```terraform
36+
resource "vcda_pair_site" "pair_manager_site" {
37+
api_url = var.manager_site_endpoint
38+
pairing_description = "pair manager site"
39+
40+
service_cert = data.vcda_service_cert.manager_service_cert.id
41+
api_thumbprint = data.vcda_remote_services_thumbprint.manager_site_thumbprint.id
42+
}
43+
```
44+
45+
<!-- schema generated by tfplugindocs -->
46+
47+
## Schema
48+
49+
### Required
50+
51+
- `api_thumbprint` (String) The thumbprint of the to-be paired Cloud Director/vCenter Replication Management Appliance.
52+
It can either be computed from
53+
the `vcda_remote_services_thumbprint` data source or provided directly as a SHA-256 fingerprint.
54+
- `api_url` (String) The API URL address/endpoint of the to-be paired Cloud Director/vCenter Replication Management
55+
Appliance.
56+
- `service_cert` (String) The certificate of the Cloud Director/vCenter Replication Management Appliance.
57+
58+
### Optional
59+
60+
- `pairing_description` (String) The description of the pairing.
61+
- `site` (String) The site name of the to-be paired Cloud Director Replication Management Appliance.
62+
Only required for pairing a Cloud Director Replication Management Appliance to another Cloud Director Replication
63+
Management Appliance.
64+
65+
### Read-Only
66+
67+
- `site_id` (String) The site ID of the paired vCenter Replication Management Appliance. Computed only for pairing a
68+
vCenter Replication Management Appliance to another vCenter Replication Management Appliance.
69+
- `site_name` (String) The site name of the paired Cloud Director/vCenter Replication Management Appliance.
70+
- `site_description` (String) The site description of the paired Cloud Director/vCenter Replication Management
71+
Appliance.
72+
- `api_public_url` (Boolean) The public API URL address of the paired Cloud Director/vCenter Replication Management
73+
Appliance.
74+
- `api_version` (String) The API version of the paired Cloud Director/vCenter Replication Management Appliance.
75+
- `build_version` (String) The build version of the paired Cloud Director Replication Management Appliance. Computed
76+
only for pairing a Cloud Director Replication Management Appliance to another Cloud Director Replication Management
77+
Appliance.
78+
- `is_provider_deployment` (String) A flag that indicates whether the paired vCenter Replication Management Appliance is
79+
of type provider. Computed only for pairing a vCenter Replication Management Appliance to another vCenter Replication
80+
Management Appliance.

scripts/env_variables.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ export DC_ID=''
1616
# Appliances VM names
1717
export CLOUD_VM_NAME=''
1818
export MANAGER_VM_NAME=''
19+
export REMOTE_MANAGER_VM_NAME=''
1920
export REPLICATOR_VM_NAME=''
2021
export TUNNEL_VM_NAME=''
2122

@@ -37,5 +38,6 @@ export SSO_PASSWORD=''
3738

3839
# Services endpoints
3940
export MANAGER_ADDRESS=''
41+
export REMOTE_MANAGER_ADDRESS=''
4042
export REPLICATOR_ADDRESS=''
4143
export TUNNEL_ADDRESS=''

0 commit comments

Comments
 (0)