Planning your Portworx setup
Before you create your cluster and install Portworx, review the following planning steps.
- Decide where you want to store the Portworx metadata. You can use the internal Portworx key-value database (KVDB), or in some cases an external etcd-based store. For more information, see Understanding the key-value store. To learn more about the internal KVDB, see the Portworx documentation.
- Decide whether you want encryption. You can use Hyper Protect Crypto Services or IBM Key Protect. For more information, see Understanding encryption for Portworx.
- Decide whether you want to use journal devices. Journal devices allow Portworx to write logs directly to a local disk on your worker node.
- VPC or Satellite clusters only - Decide whether you want to use cloud drives. Cloud drives allow you to dynamically provision the Portworx volumes. If you don’t want to use cloud drives, you must manually attach volumes to worker nodes.
- Review the Limitations.
Limitations
Review the following Portworx limitations.
| Limitation | Description |
|---|---|
| Private-only clusters in Montreal | The default installation method for Portworx Enterprise and Portworx Backup is not yet supported for private-only clusters in the Montreal region. Contact Portworx Support if you need to install Portworx Enterprise or Portworx Backup in a private-only cluster in Montreal. For more information, see Portworx Support. |
| Classic clusters Pod restart required when adding worker nodes. | Because Portworx runs as a DaemonSet in your cluster, existing worker nodes are automatically inspected for raw block storage and added to the Portworx data layer when you deploy Portworx. If you add or update worker nodes to your cluster and add raw block storage to those workers, restart the Portworx pods on the new or updated worker nodes so that your storage volumes are detected by the DaemonSet. |
| VPC clusters Storage volume reattachment required when updating worker nodes. | When you update a worker node in a VPC cluster, the worker node is removed from your cluster and replaced with a new worker node. If Portworx volumes are attached to the worker node that is replaced, you must attach the volumes to the new worker node. You can attach storage volumes with the API or the CLI. Note this limitation does not apply to Portworx deployments that are using cloud drives. |
The Portworx experimental InitializerConfiguration feature is not supported. |
IBM Cloud Kubernetes Service does not support the Portworx experimental InitializerConfiguration admission controller. |
| Private clusters | To install Portworx in a cluster that doesn't have VRF or access to private cloud service endpoints (CSEs), you must create a rule in the default security group to allow inbound and outbound traffic for the following IP addresses: 166.9.24.81,
166.9.22.100, and 166.9.20.178. For more information, see Updating the default security group. |
| Portworx Backup | Portworx backup is not supported for Satellite clusters. |
Overview of the Portworx lifecycle
- Create a multizone cluster.
- Infrastructure provider: For Satellite clusters, make sure to add block storage volumes to your hosts before attaching them to your location. If you use classic infrastructure, you must choose a bare metal flavor for the worker nodes. For classic clusters, virtual machines have only 1000 Mbps of networking speed, which is not sufficient to run production workloads with Portworx. Instead, provision Portworx on bare metal machines for the best performance.
- Worker node flavor: Choose an SDS or bare metal flavor. If you want to use virtual machines, use a worker node with 8 vCPU and 8 GB memory or more.
- Minimum number of workers: Two worker nodes per zone across three zones, for a minimum total of six worker nodes.
- VPC and non-SDS classic worker nodes only: Create raw, unformatted, and unmounted block storage.
- Choose the Portworx metadata store that fits your environment. For most environments, you can use the internal Portworx KVDB. If you use an external etcd-based store, review Setting up the Portworx key-value store.
- Optional Set up encryption.
- Install Portworx.
- Maintain the lifecycle of your Portworx deployment in your cluster.
- When you update worker nodes in VPC clusters, you must take additional steps to re-attach your Portworx volumes. You can attach your storage volumes by using the API or CLI.
- To remove a Portworx volume, storage node, or the entire Portworx cluster, see Portworx cleanup.
Encryption planning
If you plan to encrypt your Portworx volumes, decide whether to use IBM Key Protect, Hyper Protect Crypto Services, or the Kubernetes Secret option that Portworx supports. For setup instructions, see Understanding encryption for Portworx.
Check out how to encrypt the secrets in your cluster, including the secret where you stored your Key Protect CRK for your Portworx storage cluster.