Skip to main content
Version: 3.1

Spec File Generation

This section explains how to generate the Portworx DaemonSet spec file via the command line.

Parameters

Below are the parameters you can specify when generating the spec file.

Required Parameters

ParameterDescriptionExample
cSpecifies the unique name for the Portworx cluster.c=test_cluster
kYour key value database, such as an etcd cluster. If using secure etcd, specify https in the URL and ensure all certificates are in the /etc/pwx/ directory on each host pointed to by the Portworx container.k=etcd:http://etcd.fake.net:2379

Optional Parameters

ParameterDescriptionExample
sSpecify comma-separated list of drives.s=/dev/sdb,/dev/sdc
dSpecify data network interface. This is useful if your instances have non-standard network interfaces.d=eth1
mSpecify management network interface. This is useful if your instances have non-standard network interfaces.m=eth1
kbverSpecify Kubernetes version (current default is 1.7)kbver=1.8.4
storkSpecify if you want to install Storkstork=true
coreosREQUIRED if target nodes are running coreos.coreos=true
osftREQUIRED if installing on Openshift.osft =true
masSpecify if Portworx should run on the Kubernetes control plane node. For Kubernetes 1.6.4 and prior, this needs to be true (default is false)mas=true
zInstructs Portworx to run in zero storage mode on the Kubernetes control plane node.z=true
fInstructs Portworx to use any available, unused and unmounted drives or partitions. Portworx will never use a drive or partition that is mounted.f=true
stSelect the secrets type (aws, kvdb or vault)st=vault
j(Portworx 1.3 and higher) Specify a separate block device as a journaling device for px metadata.j=/dev/sde

KVDB Parameters (All required except e)

ParameterDescriptionExample
pwdUsername and password for ETCD authentication in the form user:passwordpwd=username:password
caLocation of CA file for ETCD authentication.ca=/path/to/server.ca
certLocation of certificate for ETCD authentication.cert=/path/to/server.crt
keyLocation of certificate key for ETCD authentication.key=/path/to/server.key
eComma-separated list of environment variables that will be exported to Portworx. For a list of all of these variables, See the Environment Variables section in the notes below.e=MYENV1=myvalue1,MYENV2=myvalue2

Environment Variables (e parameter)

  • PX_HTTP_PROXY: If running behind an HTTP proxy, setPX_HTTP_PROXY to your HTTP proxy.
  • PX_HTTPS_PROXY: If running behind an HTTPS proxy, set PX_HTTPS_PROXY to your HTTPS proxy.
  • PX_ENABLE_CACHE_FLUSH: To enable the cache flush deamon, set PX_ENABLE_CACHE_FLUSH=true.
  • PX_ENABLE_NFS: To enable the Portworx NFS daemon, set PX_ENABLE_NFS=true.

Generate the Spec via the command line

You can use curl to generate the spec via the command line. An example is given below.

VER=$(kubectl version --short | awk -Fv '/Server Version: /{print $3}')
# For the 1.4 tech preview release
curl -L -o px-spec.yaml "https://install.portworx.com/1.4/?c=mycluster&k=etcd://<ETCD_ADDRESS>:<ETCD_PORT>&kbver=$VER"

# For the 1.3 stable release
curl -L -o px-spec.yaml "https://install.portworx.com/1.3/?c=mycluster&k=etcd://<ETCD_ADDRESS>:<ETCD_PORT>&kbver=$VER"

# For the 1.2 stable release
curl -L -o px-spec.yaml "https://install.portworx.com/1.2/?c=mycluster&k=etcd://<ETCD_ADDRESS>:<ETCD_PORT>&kbver=$VER"
Was this page helpful?