Setting up your Fusion DevKit Client

This repository is to help you set up a machine that will install and configure the necessary tools to connect to your Fusion environment.

If you need a high level overview of Pure Fusion please check out this Youtube playlist.

Prerequisites

• A Pure Fusion control plane

• Pure1 Edge Services enabled in Pure1

• 1 or more FlashArrays configured with the Fusion Agents installed

• An API Client ("Application") registered with Pure1 along with it's associated private key. This API key will need Pure1 Admin permissions. The private key file must be an RSA key. Please refer to ths guide for creating the proper keys:

  • API Client Creation Guide

• Operating system compatability. The intial build of the DevKit was tested on Ubuntu 20.04. Since the DevKit can run as a Docker container, it should run on any platform supported by a Linux container. Pull requests welcomed for other tested operating systems

  • An x86-64 Ubuntu linux machine
    • Windows WSL2 or a virtual machine
    • If not running native Docker, install Docker Desktop for the DevKit container
  • An Apple M1 (arm64) or Intel (amd64) machine
    • Docker Desktop installed
    • wget installed

Setting up the Tools

There are 2 main ways to get access to the tools:

• Downloading and using the pre-packaged Docker image
• Running the installer to install the tools natively

Using the pre-packaged Docker image (recommended)

• Notes:
  • Install Docker Desktop before proceeding for WSL2 and MacOS or Windows. If using WSL2 in Windows, ensure Docker Desktop is enabled for your distribution in the Docker settings
  • If running on MacOS with Darwin, install wget before proceeding (ex. brew install wget)
  • Replace API_CLIENT_ID with the APP ID from Pure1.
  • Replace PATH_TO_PRIV_KEY with absolute path to the private key.pem file

wget https://github.com/pure-aferrario/fusion-client-setup/releases/latest/download/fusion-devkit.tar
docker load < fusion-devkit.tar
mkdir api-client
echo API_CLIENT_ID > api-client/issuer
cp PATH_TO_PRIV_KEY api-client/
docker run -it -v `pwd`/api-client:/api-client fusion-devkit bash

** If running on an Apple M1 arm64 OS, use:

docker run --platform linux/amd64 -it -v `pwd`/api-client:/api-client fusion-devkit bash

Using the installer bash script

git clone https://github.com/pure-aferrario/fusion-client-setup.git
cd fusion-client-setup
sudo chmod +x setup.sh
./setup.sh API_CLIENT_ID PATH_TO_PRIV_KEY

Tools currently available

Here are the current tools provided in the DevKit:

HMCTL

HMCTL is the remote CLI utility provided with Fusion.

To check if HMCTL was configured correctly, run

hmctl version

After this install you should be able to run commands as seen in this guide.

Python

Our Python library has full support for all Fusion APIs.

To run the smoke test:

python3 python/00_smoke_test.py

After installation is complete you can refer to the documentation for guidance on writing your own Python scripts.

Ansible

Our Ansible collection has full support for all Fusion APIs.

To run the smoke test:

ansible-playbook smoke_test.yml

After installation you can check out the ansible collection from the Ansible documentation page here for more information on the individual modules.

Terraform

Our Terraform provider supports consumer workflows in Fusion. Terraform won't do a full smoke test because it is a consumer-focused provider and requires more Fusion configuration before it can execute.

After installation you can see the Terraform module documentation here for guidance on writing your own Terraform templates.