Skip to main content
Version: 3.1

KVDB on other orchestrators

To configure Portworx for use with orchestrators other than Kubernetes, you must set up an external KVDB cluster, such as etcd or Consul. This external KVDB is then used by Portworx to bootstrap its own internal KVDB. All the Portworx metadata will be stored in its internal KVDB.

Internal KVDB for Portworx

Follow the instructions in this section to configure an internal KVDB for Portworx.

Prerequisites

  • A 3-node etcd cluster with etcd version 3.3 or newer is required to bootstrap Portworx's internal KVDB. If your orchestrator provides consul, it can also be used for bootstrapping internal KVDB.
  • Allocate a dedicated drive meeting the minimum disk capacity requirements, using the following arguments:
    • -kvdb_dev: if using a KVDB drive
    • -metadata: if using a metadata drive
  • Storage
    • If using a KVDB drive:

      • If IOPS are independent of disk size, the minimum recommended size is 32 GB and a minimum of 450 IOPs.
      • If IOPS are dependent on disk size, the recommended size is 150 GB to ensure you get a minimum of 450 IOPs.
    • If using a metadata drive:

      • If IOPS are independent of disk size, then the recommended size is 64 GB and a minimum of 450 IOPs.
      • If IOPS are dependent on disk size, then the recommended size is 150 GB to ensure you get a minimum of 450 IOPS.
note

If you are using a cloud drive, you should size it in accordance with your cloud provider's specifications to achieve the minimum required IOPs.

Integrate internal KVDB with Portworx

  1. While installing Portworx, use the -b argument to instruct Portworx to set up its internal KVDB.
  2. Provide the -k argument followed by a list of external KVDB endpoints. These endpoints will be used by Portworx to discover its own internal KVDB nodes.

For more information, see the install documentation for other orchestrators for your orchestrator.

External KVDB for Portworx

Follow the instructions in this section to configure an external KVDB.

Prerequisites

  • A 3-node etcd cluster with etcd version 3.3 or newer is required.
  • Allocate a minimum of 8 GB of memory dedicated to each etcd node.
  • KVDB drive:
    • If IOPS are independent of disk size, the minimum recommended size is 32 GB or a minimum of 450 IOPs.
    • If IOPS are dependent on disk size, the recommended size is 150 GB.
    note

    If you are using a cloud drive, you should size it in accordance with your cloud provider's specifications.

  • Ensure that the recommended hardware requirements for your environment are met.

Integrate external KVDB with Portworx

Provide the -k argument followed by a list of external KVDB endpoints. These endpoints will be used by Portworx to reference it in its StorageCluster.

For more information, see the install documentation for other orchestrators for your orchestrator.