Skip to content

Commit

Permalink
docs: update landing docs (#2294)
Browse files Browse the repository at this point in the history
Removes specified VMware vSphere component links, which are subject to change by Broadcom.

Also removes reference to the prior "free ESXi license". Refer to https://knowledge.broadcom.com/external/article?legacyId=2107518

Signed-off-by: Ryan Johnson <[email protected]>
  • Loading branch information
tenthirtyam authored Oct 31, 2024
1 parent a120bd8 commit 2158f36
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 23 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
[![License](https://img.shields.io/github/license/hashicorp/terraform-provider-vsphere.svg?style=for-the-badge)](LICENSE)

The Terraform Provider for VMware vSphere is a plugin for Terraform that allows
you to interact with VMware vSphere, notably [vCenter Server][vmware-vcenter]
and [ESXi][vmware-esxi]. This provider can be used to manage a VMware vSphere
environment, including virtual machines, host and cluster management, inventory,
networking, storage, datastores, content libraries, and more.
you to interact with VMware vSphere. This provider can be used to manage a
VMware vSphere environment, including virtual machines, host and cluster
management, inventory, networking, storage, datastores, content libraries, and
more.

Learn more:

Expand Down Expand Up @@ -73,7 +73,7 @@ the project team appreciates your help!

If you discover a bug or would like to suggest an enhancement, submit
[an issue][provider-issues]. Once submitted, your issue will follow the
[lifecycle][provider-issue-lifecycke] process.
[lifecycle][provider-issue-lifecycle] process.

If you would like to submit a pull request, please read the
[contribution guidelines][provider-contributing] to get started. In case of
Expand All @@ -89,18 +89,16 @@ The Terraform Provider for VMware vSphere is available under the

[golang-install]: https://golang.org/doc/install
[hashicorp]: https://hashicorp.com
[product-lifecycle]: https://support.broadcom.com/group/ecx/productlifecycle
[provider-contributing]: docs/CONTRIBUTING.md
[provider-documentation]: https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs
[provider-discussions]: https://discuss.hashicorp.com/tags/c/terraform-providers/31/vsphere
[provider-documentation]: https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs
[provider-faq]: docs/FAQ.md
[provider-install]: docs/INSTALL.md
[provider-issue-lifecycle]: docs/ISSUES.md
[provider-issues]: https://github.com/hashicorp/terraform-provider-vsphere/issues/new/choose
[provider-issue-lifecycke]: docs/ISSUES.md
[provider-license]: LICENSE
[terraform-install]: https://developer.hashicorp.com/terraform/install
[terraform-github]: https://github.com/hashicorp/terraform
[terraform-install]: https://developer.hashicorp.com/terraform/install
[terraform-registry]: https://registry.terraform.io
[vmware-esxi]: https://www.vmware.com/products/esxi-and-esx.html.html
[product-lifecycle]: https://support.broadcom.com/group/ecx/productlifecycle
[vmware-vcenter]: https://www.vmware.com/products/vcenter.html
[vmware-vsphere-documenation]: https://docs.vmware.com/en/VMware-vSphere/index.html
17 changes: 5 additions & 12 deletions website/docs/index.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,14 @@ description: |-

# Terraform Provider for VMware vSphere

This provider gives Terraform the ability to work with VMware vSphere,
notably [vCenter Server][vmware-vcenter] and [ESXi][vmware-esxi].
This provider can be used to manage many aspects of a vSphere environment,
including virtual machines, standard and distributed switches, datastores,
content libraries, and more.

[vmware-vcenter]: https://www.vmware.com/products/vcenter.html
[vmware-esxi]: https://www.vmware.com/content/vmware/vmware-published-sites/us/products/esxi-and-esx.html
This provider gives Terraform the ability to work with VMware vSphere. This
provider can be used to manage many aspects of a vSphere environment, including
virtual machines, standard and distributed switches, datastores, content
libraries, and more.

Use the navigation to read about the resources and data sources supported by
this provider.

~> **NOTE:** This provider requires API write access and hence is not supported
on a free ESXi license.

## Example Usage

The following abridged example demonstrates basic usage of the provider to
Expand All @@ -45,7 +38,7 @@ provider "vsphere" {
user = var.vsphere_user
password = var.vsphere_password
vsphere_server = var.vsphere_server
allow_unverified_ssl = true
allow_unverified_ssl = true
api_timeout = 10
}
Expand Down

0 comments on commit 2158f36

Please sign in to comment.