This DCOS service will deploy Portworx as well as all the dependencies and additional services to manage the Portworx cluster. This includes a highly available etcd cluster, influxdb to store statistics and the Lighthouse service, which is the Web UI for Portworx.

Portworx can be used to provision volumes on DCOS using either the Docker Volume Driver Interface (DVDI) or, directly through CSI.

NOTE: Please ensure that your mesos private agents have unmounted block devices that can be used by Portworx.

(Optional) Deploy an AWS Portworx-ready cluster

Using this AWS CloudFormation template, you can easily deploy a DCOS 1.10 cluster that is “Portworx-ready”.

Pre-install (only required if moving from a Portworx Docker installation)

If you are moving from a Docker install or Portworx to an OCI install, please make sure that the Portworx service is stopped on all the agents before updating to the OCI install. To do this run the following command on all your private agents:

$ sudo systemctl stop portworx

Deploy Portworx

The Portworx service is available in the DCOS universe, you can find it by typing the name in the search bar.

Portworx in DCOS Universe

Default Install

If you want to use the defaults, you can now run the dcos command to install the service

$ dcos package install --yes portworx

You can also click on the “Install” button on the WebUI next to the service and then click “Install Package”.

This will install all the prerequisites and start the Portworx service on 3 private agents. The default login/password for lighthouse would be

Advanced Install

If you want to modify the defaults, click on the “Install” button next to the package on the DCOS UI and then click on “Advanced Installation”

Through the advanced install options you can change the configuration of the Portworx deployment. Here you can choose to disable etcd (if you have an external etcd service) If you wish to to have a custom etcd installation please refer this doc. You can also disable the Lighthouse service in case you do not want to use the WebUI.

Portworx Options

Specify your kvdb (consul or etcd) server if you don’t want to use the etcd cluster with this service. If the etcd cluster is enabled this config value will be ignored. If you have been given access to the Enterprise version of PX you can replace px-dev:latest with px-enterprise:latest. With PX Enterprise you can increase the number of nodes in the PX Cluster to a value greater than 3.

If you are trying to use block devices that already have a filesystem on them, either add the “-f” option to “Portworx Options” to force Portworx to use these disks or wipe the filesystem using wipefs command before installing.

Portworx Install options

For a full list of installtion options, please look here.

Secrets Options

To use DC/OS secrets for Volume Encryption and storing Cloud Credentials, refer Portworx with DC/OS Secrets.

Etcd Options

By default a 3 node etcd cluster will be created with 5GB of local persistent storage. The size of the persistent disks can be changed during install. This can not be updated once the service has been started so please make sure you have enough storage resources available in your DCOS cluster before starting the install. Portworx ETCD Install options

Lighthouse options

By default the Lighthouse service will be installed. If this is disabled the influxdb service will also be disabled.

You can enter the admin email to be used for creating the Lighthouse account. This can be used to login to Lighthouse after install is complete. The default password is admin which can be changed after login.

Portworx Lighthouse Install options

Once you have configured the service, click on “Review and Install” and then “Install” to start the installation of the service.

Install Status

Once you have started the install you can go to the Services page to monitor the status of the installation.

If you click on the Portworx service you should be able to look at the status of the services being created.

In a default install there will be one service for the framework scheduler, 4 services for etcd ( 3 etcd nodes and one etcd proxy), one service for influxdb and one service for lighthouse.

Portworx Install finished

The install for Portworx on the agent nodes will also run as a service but they will “Finish” once the installation is done.

You can check the nodes where Portworx is installed and the status of the Portworx service by clicking on the Components link on the DCOS UI. Portworx in DCOS Compenents

Accessing Lighthouse

Since Lighthouse is deployed on a private agent it might not be accessible from outside your network depending on your network configuration. To access Lighthouse from an external network you can deploy the Repoxy service to redirect traffic from one of the public agents.

To do so, run the following marathon application

  "id": "/repoxy",
  "cpus": 0.1,
  "acceptedResourceRoles": [
  "instances": 1,
  "mem": 128,
  "container": {
    "type": "DOCKER",
    "docker": {
      "image": "mesosphere/repoxy:2.0.0"
    "volumes": [
        "containerPath": "/opt/mesosphere",
        "hostPath": "/opt/mesosphere",
        "mode": "RO"
  "cmd": "/proxyfiles/bin/start portworx $PORT0",
  "portDefinitions": [
      "port": 9998,
      "protocol": "tcp"
      "port": 9999,
      "protocol": "tcp"
  "requirePorts": true,
  "env": {
    "PROXY_ENDPOINT_0": "Lighthouse,http,lighthouse-0-start,mesos,8085,/,/"

You can then access the Lighthouse WebUI on http://<public_agent_IP>:9998. If your public agent is behind a firewall you will also need to open up two ports, 9998 and 9999.

Login Page

The default username/password is Lighthouse Login Page


Lighthouse Dashboard

Scaling Up Portworx Nodes

If you add more agents to your DCOS cluster and you want to install Portworx on those new nodes, you can increase the NODE_COUNT to start install on the new nodes. This will relaunch the service scheduler and install Portworx on the nodes which didn’t have it previously.

Scale up PX Nodes