Skip to content

Latest commit

 

History

History
252 lines (175 loc) · 8.62 KB

INSTALL.md

File metadata and controls

252 lines (175 loc) · 8.62 KB
Raw

Installing the Terraform Provider for vSphere

This document assumes the use of Terraform 0.13 or later.

Automated Installation (Recommended)

The Terraform Provider for vSphere is an official provider. Official providers are maintained by the Terraform team at HashiCorp and are listed on the Terraform Registry.

Configure the Terraform Configuration Files

Providers listed on the Terraform Registry can be automatically downloaded when initializing a working directory with terraform init. The Terraform configuration block is used to configure some behaviors of Terraform itself, such as the Terraform version and the required providers and versions.

Example: A Terraform configuration block.

terraform {
  required_providers {
    vsphere = {
      source  = "hashicorp/vsphere"
    }
  }
  required_version = ">= 0.13"
}

You can use version locking and operators to require specific versions of the provider.

Example: A Terraform configuration block with the provider versions.

terraform {
  required_providers {
    vsphere = {
      source  = "hashicorp/vsphere"
      version = ">= x.y.z"
    }
  }
  required_version = ">= 0.13"
}

To specify a particular provider version when installing released providers, see the Terrraform documentation on provider versioning

Verify Terraform Initialization Using the Terraform Registry

To verify the initialization, navigate to the working directory for your Terraform configuration and run terraform init. You should see a message indicating that Terraform has been successfully initialized and has installed the provider from the Terraform Registry.

Example: Initialize and Download the Provider.

$ terraform init

Initializing the backend...

Initializing provider plugins...
- Finding hashicorp/vsphere versions matching ">= x.y.z" ...
- Installing hashicorp/vsphere x.y.z ...
- Installed hashicorp/vsphere x.y.z (signed by HashiCorp, key ID *************)

...

Terraform has been successfully initialized!

Manual Installation

The latest release of the provider can be found on the GitHub repository releases. You can download the appropriate version of the provider for your operating system using a command line shell or a browser.

This can be useful in environments that do not allow direct access to the Internet.

Linux

The following examples use Bash on Linux (x64).

  1. On an a Linux operating system with Internet access, download the plugin from GitHub using the shell.

    RELEASE=x.y.z
wget -q https://github.com/hashicorp/terraform-provider-vsphere/releases/download/v${RELEASE}/terraform-provider-vsphere_${RELEASE}_linux_amd64.zip

  2. Extract the plugin.

    tar xvf terraform-provider-vsphere_${RELEASE}_linux_amd64.zip

  3. Create a directory for the provider.

    Note: The directory hierarchy that Terraform use to precisely determine the source of each provider it finds locally.
    $PLUGIN_DIRECTORY/$SOURCEHOSTNAME/$SOURCENAMESPACE/$NAME/$VERSION/$OS_$ARCH/

    mkdir -p ~/.terraform.d/plugins/local/hashicorp/vsphere/${RELEASE}/linux_amd64

  4. Copy the extracted plugin to a target system and move to the Terraform plugins directory.

    mv terraform-provider-vsphere_v${RELEASE} ~/.terraform.d/plugins/local/hashicorp/vsphere/${RELEASE}/linux_amd64

  5. Verify the presence of the plugin in the Terraform plugins directory.

    cd ~/.terraform.d/plugins/local/hashicorp/vsphere/${RELEASE}/linux_amd64
ls

macOS

The following example uses Bash (default) on macOS (Intel).

  1. On a macOS operating system with Internet access, install wget with Homebrew.

    brew install wget

  2. Download the plugin from GitHub using the shell.

    RELEASE=x.y.x
wget -q https://github.com/hashicorp/terraform-provider-vsphere/releases/download/v${RELEASE}/terraform-provider-vsphere_${RELEASE}_darwin_amd64.zip

  3. Extract the plugin.

    tar xvf terraform-provider-vsphere_${RELEASE}_darwin_amd64.zip

  4. Create a directory for the provider.

    Note: The directory hierarchy that Terraform use to precisely determine the source of each provider it finds locally.
    $PLUGIN_DIRECTORY/$SOURCEHOSTNAME/$SOURCENAMESPACE/$NAME/$VERSION/$OS_$ARCH/

    mkdir -p ~/.terraform.d/plugins/local/hashicorp/vsphere/${RELEASE}/darwin_amd64

  5. Copy the extracted plugin to a target system and move to the Terraform plugins directory.

    mv terraform-provider-vsphere_v${RELEASE} ~/.terraform.d/plugins/local/hashicorp/vsphere/${RELEASE}/darwin_amd64

  6. Verify the presence of the plugin in the Terraform plugins directory.

    cd ~/.terraform.d/plugins/local/hashicorp/vsphere/${RELEASE}/darwin_amd64
ls

Windows

The following examples use PowerShell on Windows (x64).

  1. On a Windows operating system with Internet access, download the plugin using the PowerShell.

    $RELEASE="x.y.z"
Invoke-WebRequest https://github.com/hashicorp/terraform-provider-vsphere/releases/download/v${RELEASE}/terraform-provider-vsphere_${RELEASE}_windows_amd64.zip -outfile terraform-provider-vsphere_${RELEASE}_windows_amd64.zip

  2. Extract the plugin.

    Expand-Archive terraform-provider-vsphere_${RELEASE}_windows_amd64.zip

cd terraform-provider-vsphere_${RELEASE}_windows_amd64

  3. Copy the extracted plugin to a target system and move to the Terraform plugins directory.

    Note: The directory directory hierarchy that Terraform use to precisely determine the source of each provider it finds locally.
    $PLUGIN_DIRECTORY/$SOURCEHOSTNAME/$SOURCENAMESPACE/$NAME/$VERSION/$OS_$ARCH/

    New-Item $ENV:APPDATA\terraform.d\plugins\local\hashicorp\vsphere\${RELEASE}\ -Name "windows_amd64" -ItemType "directory"

Move-Item terraform-provider-vsphere_v${RELEASE}.exe $ENV:APPDATA\terraform.d\plugins\local\hashicorp\vsphere\${RELEASE}\windows_amd64\terraform-provider-vsphere_v${RELEASE}.exe

  4. Verify the presence of the plugin in the Terraform plugins directory.

    cd $ENV:APPDATA\terraform.d\plugins\local\hashicorp\vsphere\${RELEASE}\windows_amd64
dir

Configure the Terraform Configuration Files

A working directory can be initialized with providers that are installed locally on a system by using terraform init. The Terraform configuration block is used to configure some behaviors of Terraform itself, such as the Terraform version and the required providers source and version.

Example: A Terraform configuration block.

terraform {
  required_providers {
    vsphere = {
      source  = "local/hashicorp/vsphere"
      version = ">= x.y.z"
    }
  }
  required_version = ">= 0.13"
}

Verify the Terraform Initialization of a Manually Installed Provider

To verify the initialization, navigate to the working directory for your Terraform configuration and run terraform init. You should see a message indicating that Terraform has been successfully initialized and the installed version of the Terraform Provider for vSphere.

Example: Initialize and Use a Manually Installed Provider

$ terraform init

Initializing the backend...

Initializing provider plugins...
- Finding local/hashicorp/vsphere versions matching ">= x.y.x" ...
- Installing local/hashicorp/vsphere x.y.x ...
- Installed local/hashicorp/vsphere x.y.x (unauthenticated)
...

Terraform has been successfully initialized!

Get the Provider Version

To find the provider version, navigate to the working directory of your Terraform configuration and run terraform version. You should see a message indicating the provider version.

Example: Terraform Provider Version from the Terraform Registry

$ terraform version
Terraform x.y.z
on linux_amd64
+ provider registry.terraform.io/hashicorp/vsphere x.y.z

Example: Terraform Provider Version for a Manually Installed Provider

$ terraform version
Terraform x.y.z
on linux_amd64
+ provider local/hashicorp/vsphere x.y.z