StorageCluster

The Portworx cluster configuration is specified by a Kubernetes CRD (CustomResourceDefinition) called StorageCluster. The StorageCluster object acts as the definition of the Portworx Cluster.

The StorageCluster object provides a Kubernetes native experience. You can manage your Portworx cluster just like any other application running on Kubernetes. That is, if you create or edit the StorageCluster object, the operator will create or edit the Portworx cluster in the background.

To generate a StorageCluster spec customized for your environment, point your browser to PX-Central, and click “Install and Run” to start the Portworx spec generator. Then, the wizard will walk you through all the necessary steps to create a StorageCluster spec customized for your environment.

Note that using the Portworx spec generator is the recommended way of generating a StorageCluster spec. However, if you want to generate the StorageCluster spec manually, you can refer to the StorageCluster Examples and StorageCluster Schema sections.

StorageCluster Examples

This section provides a few examples of common Portworx configurations you can use for manually configuring your Portworx cluster. Update the default values in these files to match your environment.

• Portworx with internal KVdb, configured to use all unused devices on the system.

apiVersion: core.libopenstorage.org/v1
kind: StorageCluster
metadata:
  name: portworx
  namespace: kube-system
spec:
  image: portworx/oci-monitor:2.6
  kvdb:
    internal: true
  storage:
    useAll: true

• Portworx with external ETCD, Stork, and Lighthouse.

apiVersion: core.libopenstorage.org/v1
kind: StorageCluster
metadata:
  name: portworx
  namespace: kube-system
spec:
  image: portworx/oci-monitor:2.6
  kvdb:
    endpoints:
    - etcd:http://etcd-1.net:2379
    - etcd:http://etcd-2.net:2379
    - etcd:http://etcd-3.net:2379
    authSecret: px-etcd-auth
  stork:
    enabled: true
    args:
      health-monitor-interval: "100"
  userInterface:
    enabled: true

• Portworx with Security enabled.

apiVersion: core.libopenstorage.org/v1
kind: StorageCluster
metadata:
  name: portworx
  namespace: kube-system
spec:
  image: portworx/oci-monitor:2.6
  security:
    enabled: true

• Portworx with Security enabled, guest access disabled, a custom self signed issuer/secret location, and five day token lifetime.

apiVersion: core.libopenstorage.org/v1
kind: StorageCluster
metadata:
  name: portworx
  namespace: kube-system
spec:
  image: portworx/oci-monitor:2.6
  security:
    enabled: true
    auth:
      guestAccess: 'Disabled'
      selfSigned:
        issuer: 'openstorage.io'
        sharedSecret: 'my-k8s-secret'
        tokenLifetime: '5d'

• Portworx with update and delete strategies, and placement rules.

apiVersion: core.libopenstorage.org/v1
kind: StorageCluster
metadata:
  name: portworx
  namespace: kube-system
spec:
  image: portworx/oci-monitor:2.6
  updateStrategy:
    type: RollingUpdate
    rollingUpdate:
      maxUnavailable: 20%
  deleteStrategy:
    type: UninstallAndWipe
  placement:
    nodeAffinity:
      requiredDuringSchedulingIgnoredDuringExecution:
        nodeSelectorTerms:
        - matchExpressions:
          - key: px/enabled
            operator: NotIn
            values:
            - "false"
          - key: node-role.kubernetes.io/master
            operator: DoesNotExist
    tolerations:
    - key: infra/node
      operator: Equal
      value: "true"
      effect: NoExecute

• Portworx with custom image registry, network interfaces, and miscellaneous options

apiVersion: core.libopenstorage.org/v1
kind: StorageCluster
metadata:
  name: portworx
  namespace: kube-system
spec:
  image: portworx/oci-monitor:2.6
  imagePullPolicy: Always
  imagePullSecret: regsecret
  customImageRegistry: docker.private.io/repo
  network:
    dataInterface: eth1
    mgmtInterface: eth1
  secretsProvider: vault
  runtimeOptions:
    num_io_threads: "10"
  env:
  - name: VAULT_ADDRESS
    value: "http://10.0.0.1:8200"

• Portworx with node specific overrides. Use different devices or no devices on different set of nodes.

apiVersion: core.libopenstorage.org/v1
kind: StorageCluster
metadata:
  name: portworx
  namespace: kube-system
spec:
  image: portworx/oci-monitor:2.6
  storage:
    devices:
    - /dev/sda
    - /dev/sdb
  nodes:
  - selector:
      labelSelector:
        matchLabels:
          px/storage: "nvme"
    storage:
      devices:
      - /dev/nvme1
      - /dev/nvme2
  - selector:
      labelSelector:
        matchLabels:
          px/storage: "false"
    storage:
      devices: []

StorageCluster Schema

This section explains the fields used to configure the StorageCluster object.

KVdb configuration

This section explains the fields used to configure Portworx with a KVdb. Note that, if you don’t specify the endpoints, the operator starts Portworx with the internal KVdb.

Storage configuration

This section provides details about the fields used to configure the storage for your Portworx cluster. If you don’t specify a device, the operator sets the spec.storage.useAll field to true.

Cloud storage configuration

This section explains the fields used to configure Portworx with cloud storage. Once the cloud storage is configured, Portworx manages the cloud disks automatically based on the provided specs. Note that the spec.storage fields take precedence over the fields presented in this section. Make sure the spec.storage fields are empty when configuring Portworx with cloud storage.

Network configuration

This section describes the fields used to configure the network settings. If these fields are not specified, Portworx auto-detects the network interfaces.

Volume configuration

This section describes the fields used to configure custom volume mounts for Portworx pods.

Placement rules

You can use the placement rules to specify where Portworx should be deployed. By default, the operator deploys Portworx on all worker nodes.

Update strategy

This section provides details on how to specify an update strategy.

Delete/Uninstall strategy

This section provides details on how to specify an uninstall strategy for your Portworx cluster.

Monitoring configuration

This section provides details on how to enable monitoring for Portworx.

Stork configuration

This section describes the fields used to manage the Stork deployment through the Portworx operator.

Lighthouse configuration

This section provides details on how to deploy and manage Lighthouse.

Autopilot configuration

This section provides details on how to deploy and manage Autopilot.

Node specific configuration

This section provides details on how to override certain cluster level configuration for individual or group of nodes.

Security Configuration