Fill in the below parameters and once finished, download the generated spec at the bottom of the page.

Required parameters:

Specifies the unique name for the Portworx cluster. (example: test_cluster)

Points to your key value database, such as an etcd cluster or a consul cluster. (example: etcd:,etcd:,etcd:

Specify Kubernetes version (default is 1.8.12). Use output of kubectl version --short | awk -Fv '/Server Version: /{print $3}' (example: 1.8.10-gke.0)

Optional parameters:

Specify how Portworx should consume storage. You have following options:

  • Comma-separated lists of drives (example:/dev/sdb,/dev/sdc)
  • A spec for creating drives if running on AWS (example: "type=gp2,size=100")
  • Leave empty for Portworx to consume unused devices

Specify data network interface. This is useful if your instances have non-standard network interfaces. (example: eth1)

Specify management network interface. This is useful if your instances have non-standard network interfaces. (example: eth1)

Select if installing on RHEL Openshift. Please note that you will require RHEL account, and must specify docker-registry secret. (example: true)

Select if installing on Pivotal Container Service (PKS). (example: true)

Select if you want to install STORK to enable hyper-convergence, snapshots and storage-aware scheduling (recommended) (example: true)

Instructs PX to use any available, unused and unmounted drives or partitions. PX will never use a drive or partition that is mounted. (example: true)

Select the secrets type for encrypting volumes. (example: vault)

Specify a separate block device as a journaling device for px metadata. (example: /dev/sde)

Specify the start of the portrange Portworx will use for communication (default: 9001) (example: 9001)

Comma-separated list of environment variables that will be exported to portworx. (example: MYENV1=myvalue1,MYENV2=myvalue2)

Container registry:

This section is required if using custom container registry (docker registry)

Specify a custom container registry server that will be used instead of to download Docker images. You may also include a custom repository. (example: or

Specify a custom Kubernetes secret that will be used to authenticate with a container registry. Must be defined in kube-system namespace. (example: regcred)

Secure KVDB configuration:

This section is required if you are using a secured key-value store

Username and password for ETCD authentication in the form user:password. (example: username:password)

Location of CA file for ETCD authentication. (example: /path/to/

Location of certificate certificate for ETCD authentication. (example: /path/to/server.crt)

Location of certificate key for ETCD authentication. (example: /path/to/server.key)

ACL token value used for Consul authentication. (example: 398073a8-5091-4d9c-871a-bbbeb030d1f6)