Portworx is a software-defined persistent storage solution designed and purpose-built for applications deployed as containers, via container orchestrators such as Kubernetes. You can use Palette to install Portworx on the cloud or on-premises.

For deploying Portworx for Kubernetes, make sure to configure the properties in the pack:

• Have at least three nodes with the proper hardware, software, and network requirements.

• Ensure you are using a supported Kubernetes version.

• Identify and set up the storageType.

The default installation of Portworx will deploy the following components in the Kubernetes cluster.

• Portworx

• CSI Provisioner

• Lighthouse

• Stork and Stork on Portworx

• Storage class making use of portworx-volume provisioner.

Manifests - Portworx:

manifests:
  portworx:

    # The namespace to install Portworx resources
    namespace: "portworx"

    # Portworx storage type and size
    storageType: "type=zeroedthick,size=150"

    # Max storgae nodes per zone
    maxStorageNodesPerZone: 3

    # Node recovery timeout in seconds
    nodeRecoveryTimeout: 1500

    # Portworx storage class config
    storageClass:
      enabled: true
      isDefaultStorageClass: true
      allowVolumeExpansion: true
      reclaimPolicy: Retain
      volumeBindingMode: Immediate
      parameters:
        repl: "3"
        priority_io: "high"
        #sharedv4: true

    k8sVersion: '{{.spectro.system.kubernetes.version}}'

    templateVersion: "v4"

    # List of additional container args to be passed
    args:
      ociMonitor:
        #- "-dedicated_cache"
        #- "-a"
      storkDeployment:
        #- "--app-initializer=true"
      storkScheduler:
        #- "--scheduler-name=xyz"
      autoPilot:
      csiProvisioner:
      csiSnapshotter:
      csiSnapshotController:
      csiResizer:

    # The private registry from where images will be pulled from. When left empty, images will be pulled from the public registry
    # Example, imageRegistry: "harbor.company.com/portworx"
    imageRegistry: ""
    

Starting Portworx v2.6.1, you can use the presets feature to toggle between the available ETCD options.

By default, Portworx is set to use internal KVDB. However, you can integrate Portworx to an external etcd server by following the steps below.

1. Enable useExternalKvdb flag by setting it to true.

2. Configure the external etcd endpoints in externalKvdb.endpoints.

If the external etcd server is configured to authenticate via certificates, additionally you may want to set up the following:

1. Enable externalKvdb.useCertsForSSL flag by setting it to true.

2. Setup certificate related configuration in externalKvdb.cacert, externalKvdb.cert, and externalKvdb.key.

These are the three types of Presets that can be selected and modified.

# ECTD selection
  useExternalKvdb: false

  # External kvdb related config
  externalKvdb:

    useCertsForSSL: false

vsphere-cloud-controller-manager:
  k8sVersion: '{{.spectro.system.kubernetes.version}}'

# VSphere cloud configurations
vsphereConfig:
  insecure: "true"
  host: ""
  port: "443"
  datastorePrefix: "datastore"
  installMode: "shared"
  userName: ""
  password: ""
  # Enter the name of the secret which has vsphere user credentials (Use keys VSPHERE_USER, VSPHERE_PASSWORD)
  userCredsSecret: ""

apiVersion: v1
kind: Secret
metadata:
  name: px-vsphere-secret
  namespace: kube-system
type: Opaque
data:
  VSPHERE_USER: "b64 encoded admin username"
  VSPHERE_PASSWORD: "b64 encoded admin password"

manifests:
  portworx:
    vsphereConfig:
      userCredsSecret: "px-vsphere-secret"

Portworx Install with Kubernetes

Lighthouse

Installation Prerequisites

Install Portworx on AWS ASG using the DaemonSet