Portworx Documentation has moved to https://docs.portworx.com
Portworx Enterprise version 2.13 has reached end of life and end of extended maintenance. Refer to the release support policy doc here.
Upgrade to the latest version of Portworx Enterprise for continued support. Documentation for the latest version of Portworx Enterprise can be found here.

Prepare your environment


Follow the instructions on this page to prepare your environment.

Install storkctl

Perform the following steps to download storkctl from the Stork pod to the system where you are running kubectl:

  • Linux:

    STORK_POD=$(kubectl get pods -n <namespace> -l name=stork -o jsonpath='{.items[0].metadata.name}') &&
    kubectl cp -n <namespace> $STORK_POD:/storkctl/linux/storkctl ./storkctl
    sudo mv storkctl /usr/local/bin &&
    sudo chmod +x /usr/local/bin/storkctl
  • OS X:

    STORK_POD=$(kubectl get pods -n <namespace> -l name=stork -o jsonpath='{.items[0].metadata.name}') &&
    kubectl cp -n <namespace> $STORK_POD:/storkctl/darwin/storkctl ./storkctl
    sudo mv storkctl /usr/local/bin &&
    sudo chmod +x /usr/local/bin/storkctl
  • Windows:

    1. Copy storkctl.exe from the Stork pod:

      STORK_POD=$(kubectl get pods -n <namespace> -l name=stork -o jsonpath='{.items[0].metadata.name}') &&
      kubectl cp -n <namespace> $STORK_POD:/storkctl/windows/storkctl.exe ./storkctl.exe
    2. Move storkctl.exe to a directory in your PATH

Enable load balancing on cloud clusters

If you’re running Kubernetes in the cloud, you must configure an External LoadBalancer (ELB) for the Portworx API service on your source and destination clusters.

Warning: For security reasons, Portworx, Inc. recommends enabling authorization on your Portworx cluster before enabling a load balancer.

Enable load balancing by entering the kubectl edit service command and changing the service type value from nodePort to LoadBalancer:

kubectl edit service portworx-service -n <namespace>
kind: Service
apiVersion: v1
metadata:
  name: portworx-service
  namespace: <namespace>
  labels:
    name: portworx
spec:
  selector:
    name: portworx
  type: LoadBalancer


Last edited: Tuesday, May 16, 2023