Steps to install all the required CLIs (nkp, kubectl and helm) to create and manage NKP clusters.
-
Add NKP Rocky Linux image from the Nutanix Support Portal to Prism Central
-
Create a jump host with 2 vCPUs, 8 GB memory, use the Rocky image (update disk to 128 GiB), and the following Cloud-init custom script : cloud-init
-
SSH to
nutanix@<jump host_IP>(default password: nutanix/4u - unless you modified it in the cloud-init file) -
Install the NKP CLI with the command: get-nkp-cli
When prompted, you must use the download link as-is, which is available in the Nutanix portal.
The NKP CLI is a command-line interface for managing NKP-based workflows. This guide provides a quick and easy way to install the required CLIs (nkp, kubectl and helm) using the Rocky Linux image provided by Nutanix in the Nutanix Support Portal.
Below an example of NKP on Nutanix deployment diagram. Ip ranges are provided as example.
For NKP CLI:
-
Internet connectivity
-
Add NKP Node OS Image Rocky Linux to Prism Central. DO NOT CHANGE the auto-populated image name
For NKP cluster creation:
- The target cluster must be running AOS 7.3 and Prism Central (PC) 7.3 or newer. Check the Nutanix support portal to align NKP, AOS, and PC versions.
- DHCP/IPAM is required
- IP Addresses (must be reachable to jump host)
- Static IP address for the control plane VIP
- One or more IP addresses for the NKP dashboard and load balancing service
-
Connect to Prism Central
-
Create a virtual machine
- Name: nkp-jump host
- vCPUs: 2
- Memory: 8
- Disk: Clone from Image (select the Rocky Linux you previously uploaded)
- Disk Capacity: 128 (default is 20)
- Guest Customization: Cloud-init (Linux)
- Custom Script: cloud-init
-
Power on the virtual machine
-
Connect to your jump host using SSH (default password: nutanix/4u)
ssh nutanix@<jump host_IP>
-
git clone this repo
git clone https://github.com/nutanixdev/nkp-quickstart.git
-
Install the NKP CLI with the command: get-nkp-cli
cd nkp-quickstart && ./get-nkp-cli
When prompted, you must use the download link as-is, which is available in the Nutanix portal.
Before creating a cluster, ensure you meet the prerequisites:
- Static IP address for the control plane VIP (must be outside of IPAM scope)
- One or more IP addresses for the NKP dashboard and load-balancing service (must be outside of IPAM scope)
- IP addresses must be in the same subnet as the virtual machines
- Access to the Nutanix Support Portal to download the NKP Bundle
Choose one of the following installation methods based on your needs:
This method guides you through the entire deployment process interactively with automatic validation and error checking. It's ideal for first-time users and provides:
- ✅ Automated system prerequisite validation - Checks and configures cgroup v2 delegation automatically
- ✅ Smart NKP Bundle management - Auto-detects existing bundles, downloads if needed, extracts binaries
- ✅ Prism Central version compatibility checks - Prevents incompatible deployments before they start
- ✅ Comprehensive input validation - Validates IP ranges, cluster names, and subnet alignment
- ✅ Network connectivity verification - Ensures outbound access to Nutanix portal
- ✅ Pre-flight summary review - Shows all parameters and requires explicit confirmation
Use this method if:
- You want a guided, hands-off deployment experience
- This is your first NKP deployment
- You want automatic compatibility validation to prevent mid-deployment failures
- You prefer interactive prompts over manual configuration files
Steps:
-
From your cloned repository run the script to begin:
./nkpDeploy.sh
-
The script will verify prerequisites and then prompt for the following information:
Parameter Description Example Prism Central Endpoint IP address of Prism Central 10.0.0.10Prism Username Your Prism Central username adminPrism Password Your Prism Central password (masked input) Cluster Name Desired NKP cluster name (lowercase) prod-clusterControl Plane VIP Static IP for control plane (outside IPAM) 10.0.0.50VM Image Name NKP Rocky image name in Prism Central nkp-rocky-9.6-release-cis-1.34.1...qcow2AHV Cluster Name Name of the AHV cluster PHX-Cluster-1Network Name Network for cluster nodes ManagementStorage Container Storage container for persistent volumes SelfServiceContainerLB IP Range Load balancer IP range 10.0.0.100-10.0.0.110Control Plane Replicas Number of control plane nodes (1-5, default: 1) 1Worker Replicas Number of worker nodes (1-10, default: 3) 3 -
Review the final deployment summary and confirm to proceed.
-
The deployment typically takes 45-60 minutes. Once complete, configure your kubeconfig:
export KUBECONFIG=$(pwd)/<cluster_name>.conf nkp get dashboard
This will display the Kommander dashboard URL and login credentials.
- Dependency Check: Verifies
curl,jq, andtarare installed - System Prerequisites: Checks/configures cgroup v2 delegation (may require reboot)
- Connectivity Check: Verifies outbound access to Nutanix portal
- Bundle Management: Looks for existing bundle, prompts for download URL if needed, extracts binaries
- Binary Installation: Installs
nkpandkubectlto/usr/local/bin - Configurable Sizing: Allows custom control plane and worker replica counts (optional, has defaults)
- Version Validation: Queries Prism Central API to confirm PC and AOS versions > 7.3
- Input Validation: Ensures all parameters are correctly formatted and compatible
- Deployment: Executes the
nkp create clustercommand with validated parameters and custom sizing
This installation method provides an interactive deployment experience with less control over cluster configuration. The NKP cluster will be created with three control plane nodes and four worker nodes (default sizing).
Use this method if:
- You want a quick proof-of-concept deployment
- Default cluster sizing works for your use case
- You prefer interactive prompts over pre-configuration
We recommend starting a tmux session in case your ssh connection is at risk of disconnection (like laptop going into sleep mode) as the process can take some time based on several parameters (like download speed).
nkp create cluster nutanixThis installation method lets you fully customize your cluster configuration. The following commands create a cluster with one control plane node and three worker nodes.
Use this method if:
- You need non-standard cluster sizing
- You want to fine-tune every cluster parameter
- You're deploying multiple cluster variations
- You need full control and repeatability via configuration files
-
Before running the following command in your jump host VM, update the values with your environment: nkp-env
-
The next command will start the installation process of an NKP management cluster: nkp-create-cluster
| Factor | Scripted | Prompt-Based | CLI |
|---|---|---|---|
| Ease of Use | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐ | ⭐⭐⭐ |
| Customization | ⭐⭐⭐ | ⭐⭐ | ⭐⭐⭐⭐⭐ |
| Version Validation | Automatic | Manual | Manual |
| Input Validation | Comprehensive | Basic | None |
| Time to Deploy | 5-10 min setup | 10-15 min setup | Variable |
| Best For | New users, POCs | Quick tests | Advanced/Production |
| Typical Use Case | First deployment | Learning | Automation |
These code samples are intended as standalone examples. Please be aware that all public code samples provided by Nutanix are unofficial in nature, are provided as examples only, are unsupported, and will need to be heavily scrutinized and potentially modified before they can be used in a production environment. All such code samples are provided on an as-is basis, and Nutanix expressly disclaims all warranties, express or implied. All code samples are © Nutanix, Inc., and are provided as-is under the MIT license (https://opensource.org/licenses/MIT).