Skip to content

Latest commit

 

History

History
198 lines (135 loc) · 6.71 KB

INSTALL.md

File metadata and controls

198 lines (135 loc) · 6.71 KB

Installing the Terraform Provider for HPE GreenLake

This document assumes the use of Terraform 0.13 or later.

Installation

The latest release of the provider can be found on [https://github.com/HPE/terraform-provider-hpegl/releases][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.

Install Scripts

See linux, windows, and macOS install scripts that will download the latest release of the provider and install it in the appropriate location for your operating system.

Then skip to Configure the Terraform Configuration Files to complete the steps.

Linux

The following examples use Bash on Linux (x64).

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

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

  2. Extract the plugin.

    unzip terraform-provider-hpegl_${RELEASE}_linux_amd64.zip -d terraform-provider-hpegl_${RELEASE}

  3. Create a directory for the provider.

    Note

    The directory hierarchy that Terraform uses to precisely determine the source of each provider it finds locally.

    $PLUGIN_DIRECTORY/$SOURCEHOSTNAME/$SOURCENAMESPACE/$NAME/$VERSION/$OS_$ARCH/

    mkdir -p ~/.local/share/terraform/plugins/registry.terraform.io/hpe/hpegl/${RELEASE}/linux_amd64

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

    mv terraform-provider-hpegl_${RELEASE}/terraform-provider-hpegl_v${RELEASE} ~/.local/share/terraform/plugins/registry.terraform.io/hpe/hpegl/${RELEASE}/linux_amd64

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

    cd ~/.local/share/terraform/plugins/registry.terraform.io/hpe/hpegl/${RELEASE}/linux_amd64
ls

macOS

The following example uses Zsh (default) on macOS (Apple Silicon).

  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.z
wget -q https://github.com/HPE/terraform-provider-hpegl/releases/download/v${RELEASE}/terraform-provider-hpegl_${RELEASE}_darwin_arm64.zip

  3. Extract the plugin.

    unzip terraform-provider-hpegl_${RELEASE}_darwin_arm64.zip -d terraform-provider-hpegl_${RELEASE}

  4. Create a directory for the provider.

    Note

    The directory hierarchy that Terraform uses to precisely determine the source of each provider it finds locally.

    $PLUGIN_DIRECTORY/$SOURCEHOSTNAME/$SOURCENAMESPACE/$NAME/$VERSION/$OS_$ARCH/

    mkdir -p ~/.terraform.d/plugins/registry.terraform.io/hpe/hpegl/${RELEASE}/darwin_arm64

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

    mv terraform-provider-hpegl_${RELEASE}/terraform-provider-hpegl_v${RELEASE} ~/.terraform.d/plugins/registry.terraform.io/hpe/hpegl/${RELEASE}/darwin_arm64

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

    cd ~/.terraform.d/plugins/registry.terraform.io/hpe/hpegl/${RELEASE}/darwin_arm64
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.

    Set-Variable -Name "RELEASE" -Value "x.y.z"
Invoke-WebRequest https://github.com/HPE/terraform-provider-hpegl/releases/download/v${RELEASE}/terraform-provider-hpegl_${RELEASE}_windows_amd64.zip -outfile terraform-provider-hpegl_${RELEASE}_windows_amd64.zip

  2. Extract the plugin.

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

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

    Note

    The directory hierarchy that Terraform uses 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\registry.terraform.io\hpe\hpegl\${RELEASE}\ -Name "windows_amd64" -ItemType "directory"

Move-Item terraform-provider-hpegl_v${RELEASE}.exe $ENV:APPDATA\terraform.d\plugins\registry.terraform.io\hpe\hpegl\${RELEASE}\windows_amd64\terraform-provider-hpegl_v${RELEASE}.exe

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

    cd $ENV:APPDATA\terraform.d\plugins\registry.terraform.io\hpe\hpegl\${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 {
    hpegl = {
      source  = "HPE/hpegl"
      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 HPE Greenlake.

Example: Initialize and Use a Manually Installed Provider

% terraform init

Initializing the backend...

Initializing provider plugins...
- Reusing previous version of hpe/hpegl from the dependency lock file
- Installing hpe/hpegl x.y.z...
- Installed hpe/hpegl x.y.z (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 darwin_arm64
+ provider registry.terraform.io/hpe/hpegl x.y.z