This topic explains how to install Portworx on Kubernetes using Kubernetes Operations (KOPS). Follow the steps in this topic in order.
This article assumes that you are familiar with KOPS. For information about using KOPS, see one of the following pages:
Granting Portworx the needed AWS permissions
Portworx creates and attaches EBS volumes. As such, it needs the AWS permissions to do so. Below is a sample policy describing these permissions:
You can provide these permissions to Portworx in one of the following ways:
- Instance Privileges: Provide above permissions for all the instances in the autoscaling cluster by applying the corresponding IAM role. More info about IAM roles and policies can be found here
- Environment Variables: Create a User with the above policy and provide the security credentials (
AWS_SECRET_ACCESS_KEY) to Portworx.
If you are not using instance privileges, you must also specify AWS environment variables in the StorageCluster spec file. The environment variables to specify (for the KOPS IAM user) are:
If generating the StorageCluster spec via the GUI wizard, specify the AWS environment variables in the List of environment variables field. If generating the StorageCluster spec via the command line, specify the AWS environment variables using the
Generate the specs
To install Portworx with Kubernetes, you must generate Kubernetes manifests that you will deploy in your cluster.
Navigate to Portworx Central and log in, or create an account, then follow the process to generate a spec.
If you're using a cloud provider and you use the Customize option when generating your spec, do not add volumes of different types when configuring storage devices during spec generation. For example, do not add both GP2 and GP3 for AWS, standard and ssd for GCP, or Standard and Premium for Azure. This can cause performance issues and errors.
Deploy the Operator
To deploy the Operator, run the command that Portworx Central provided, which looks similar to the following:
kubectl apply -f 'https://install.portworx.com/<portworx_version>?comp=pxoperator&kbver=<k8s-version>&ns=portworx'
Deploy the StorageCluster
To deploy the StorageCluster, run the command that Portworx Central provided, which looks similar to the following:
kubectl apply -f “https://install.portworx.com/<portworx_version>?operator=true&mc=false&kbver=1.25.0&ns=portworx&b=true&kd=type%3Dgp3%2Csize%3D150&s=%22type%3Dgp3%2Csize%3D150%22&c=px-cluster-0584f7f1-b6be-4608-800c-2ac5fb8069e0&stork=true&csi=true&mon=true&tel=false&st=k8s&promop=true'
Monitor the Portworx nodes
Enter the following
kubectl getcommand and wait until all Portworx nodes show as ready in the output:
kubectl -n kube-system get storagenodes -l name=portworx
Enter the following
kubectl describecommand with the name of one of the Portworx nodes to show the current installation status for individual nodes:
kubectl -n kube-system describe storagenode <portworx-node-name>
Type Reason Age From Message
---- ------ ---- ---- -------
Normal PortworxMonitorImagePullInPrgress 7m48s portworx, k8s-node-2 Portworx image portworx/px-enterprise:2.5.0 pull and extraction in progress
Warning NodeStateChange 5m26s portworx, k8s-node-2 Node is not in quorum. Waiting to connect to peer nodes on port 9002.
Normal NodeStartSuccess 5m7s portworx, k8s-node-2 PX is ready on this nodenote
In your output, the image pulled will differ based on your chosen Portworx license type and version.
Once you have a running Portworx installation, below sections are useful.
📄 Kubernetes operations
Operations guide for running Portworx in Production with Kubernetes
📄 Storage operations
Learn how to perform various storage operations using Portworx on Kubernetes
📄 Stateful applications on Kubernetes
Learn how to install various applications with Portworx on Kubernetes