The purpose of this below steps to guide and setting up a production ready dynamic provisioning of Portworx volumes using Kubernetes(KOPS) environment on AWS.


Prepare your AWS environment for KOPS. You will have to perform the following steps:

• Install KOPS

• Install aws cli

• Create and Setup IAM user permission for KOPS

• Create a hosted DNS zone for KOPS

• Create S3 bucket for KOPS to store cluster state.

Detailed instructions on these steps are documented here.

Create a kubernetes cluster using KOPS:

$ export
$ export KOPS_STATE_STORE=s3://KOPS-demo-state-store

$ KOPS create cluster \
>     --channel alpha \
>     --node-count 3 \
>     --zones us-west-2a \
>     --master-zones us-west-2a \
>     --dns-zone \
>     --node-size t2.medium \
>     --master-size t2.medium \
>     --ssh-public-key ~/.ssh/ \
>     --cloud-labels "Team=Portworx,Owner=SenS" \
>     ${NAME}

Prepare the key-value database (etcd):

Portworx requires a key-value database such as etcd for configuring storage. Either point to your external etcd or Follow this steps to set up new etcd Cluster. we are starting our own etcd.

Create EBS volume

Create atleast one EBS volume. This volume will serve as a template EBS volume. On every node where PX is brought up as a storage node, a new EBS volume identical to the template volume will be created.

Ensure that these EBS volumes are created in the same region as the auto scaling group (KOPS cluster).

Record the EBS volume ID (e.g. vol-04e2283f1925ec9ee), this will be passed in to PX as a parameter.

Prepare Portworx Spec for KOPS auto scaling group (ASG):

Update and curl below PX spec URL. Make sure you change the custom parameters (cluster, kvdb , aws environment variables and volume template name) to match your environment. For further information, refer to the explanation of the parameters that can be given on the curl query string here.


$ curl -o px-spec.yaml "<enter your details>,AWS_SECRET_ACCESS_KEY=<enter your details>”

There are 2 env variables passed into the px-spec.yaml. These are the KOPS IAM user AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY used for authentication.

The volume template is passed in as drives=vol-04e2283f1925ec9ee.

Deploy Portworx

Now deploy Portworx into your Kubernetes KOPS cluster by applying the spec file:

$ kubectl create -f px-spec.yaml

daemonset "portworx" created

List the pods and verify that the Portworx daemonset is running:

$ [email protected]:~$ kubectl get pods --all-namespaces | grep portworx
kube-system   portworx-2kst8                                                       1/1       Running   0          32m
kube-system   portworx-b8b2n                                                       1/1       Running   0          32m
kube-system   portworx-sxl59                                                       1/1       Running   0          32m

Kubernetes may take a few minutes to download the Portworx container images and start the cluster.

Portworx will dynamically create it’s local EBS volumes based on the template. Check the status of Portworx with the following command:

$ [email protected]:~$ /opt/pwx/bin/pxctl status
Status: PX is operational
License: Trial (expires in 30 days)
Node ID:
 	Local Storage Pool: 1 pool
	0	LOW		raid0		300 GiB	1.0 GiB	Online	a	us-west-2
	Local Storage Devices: 1 device
	Device	Path		Media Type		Size		Last-Scan
	0:1	/dev/xvdf	STORAGE_MEDIUM_MAGNETIC	300 GiB		14 Nov 17 03:28 UTC
	total			-			300 GiB
Cluster Summary
	Cluster ID: mycluster
	Cluster UUID: a6705624-c41a-4011-95ca-060a19fecd18
	IP		ID						Used	Capacity	Status	StorageStatus	1.0 GiB	300 GiB		Online	Up	0 B	300 GiB		Online	Up	0 B	300 GiB		Online	Up (This node)
Global Storage Pool
	Total Used    	:  1.0 GiB
	Total Capacity	:  900 GiB