Terraform Module for Portworx Enterprise on IBM Cloud

IBM Cloud provides an option to provision Portworx Enterprise on IKS cluster through IBM Catalog. This repo hosts the terraform module which can be used in conjunction with existing terraform scripts to provision Portworx Enterprise on IKS.

Usage

Include the below module definition in a .tf file to deploy Portworx Enterprise with the default values.

Please take a look at the default values in the Input Variables section to understand the default behavior of this module.

module "portworx-enterprise" {
  source                    = "portworx/portworx-enterprise/ibm"
  region                    = "us-east"
  cluster_name              = "my-iks-cluster"
  resource_group            = "my-resource-group"
  ibmcloud_api_key          = "my-api-key"
}

Features

This terraform module provides the following features for seamless adoption:

• Declarative Installation/Uninstallation
• Seamless Upgrades
• Support for Cloud Drives
• Easy Integration with existing Terraform Scripts
• Built-in Preflight Checks

Getting Started

Please refer to the Getting Started Guide to install Portworx Enterprise on an IKS using Cloud Drives. This guide outlines the steps to set up an environment and deploy on IBM Cloud.

Examples

The below hyperlinks guide you to understand and demonstrate the features and capabilities of this Terraform module:

• IKS Cluster created using VPC Gen 2 (Block Volumes already attached to the k8s worker nodes by the user)
• Installation on IKS Cluster created using VPC Gen 2 with Cloud Drives
• Worker Node Replacement on IKS Cluster created using VPC Gen 2 using Cloud Drives

Requirements

The following are requirements needed to be installed on the host machine where the terraform commands will be issued. wget, curl and jq libraries are needed as some bash scripts are required for validation checks.

Refer to the table below for more details:

Providers

Following providers are used by our modules, to manage resources on IBM Cloud:

Resources

Below resources and data sources are created to manage the resources of terraform module:

Input Variables

Below list of input variables can be provided to the Terraform module. There are some default values already set for this module which can be overridden otherwise. Please read through the description and default values before handling advanced scenarios of using this module.

object({
 max_storage_node_per_zone = number
 num_cloud_drives = number
 cloud_drives_sizes = list(number)
 storage_classes = list(string)
 })

{
 "cloud_drives_sizes": [
 100
 ],
 "max_storage_node_per_zone": 1,
 "num_cloud_drives": 1,
 "storage_classes": [
 "ibmc-vpc-block-10iops-tier"
 ]
}

object({
 use_external_etcd = bool
 etcd_secret_name = string
 external_etcd_connection_url = string
 })

{
 "etcd_secret_name": null,
 "external_etcd_connection_url": null,
 "use_external_etcd": false
}

Output Variables

Table below lists out the output variables to be read or referred after successful application/execution of the Terraform module.

License

Apache License 2.0 - Copyright 2022 Pure Storage, Inc.