Nutanix Kubernetes Platform (NKP)
This guide will walk you through the process of installing Okteto on a Nutanix Kubernetes Platform (NKP) workload cluster.
Okteto is a supported platform on NKP. NKP provides the cluster and its infrastructure (storage, networking, and load balancing), and Okteto runs on top of it as a regular Helm-based application, giving your developers and their AI agents on-demand application environments.
Supported configurations
NKP manages clusters on several infrastructure providers. Okteto only depends on standard Kubernetes capabilities that NKP provides natively on all of them: a default storage class backed by a CSI driver, a CNI, and a LoadBalancer service implementation.
| Configuration | Status |
|---|---|
| NKP 2.17 workload clusters on Amazon EKS | Validated |
| NKP workload clusters on Nutanix AHV, AWS, Azure, AKS, GCP, vSphere, and pre-provisioned infrastructure | Supported. Meets the same requirements and follows the same steps |
| Air-gapped NKP installations | Not covered by this guide. Contact us to plan your installation |
Install Okteto on an NKP workload cluster, not on the NKP management cluster. The management cluster runs Kommander and the Cluster API controllers, and it should stay dedicated to managing your fleet.
Installation Requirements
Install these CLIs on your machine:
okteto>= 3.23.0 (installation guide)nkp>= 2.17 (installation guide)kubectl>= 1.28 (installation guide)helm>= 3.14 (installation guide)
You also need:
- An Okteto license
- A domain where you can create wildcard DNS records
- An NKP management cluster, and a workload cluster managed by it
Getting your Okteto License
You need a license to install Okteto. If you have an Okteto subscription, your license key came with it, and support can send it again if you can't find it. If you don't have a subscription yet, sign up for the free tier: you get a one-year license for up to 5 users and 500 environments per month, and you don't need a credit card.
A Domain and the ability to create wildcard DNS records for it
You need enough access to a subdomain, such as dev.example.com, to add a wildcard DNS record to it.
By default, Okteto exposes the endpoints of your application environments on that subdomain.
NKP doesn't create this record for you, so make sure you can add it in your DNS provider.
Prepare your NKP workload cluster
This guide assumes Okteto runs in a new, dedicated workload cluster.
To install Okteto in an existing workload cluster with other workloads, read this section to check that your cluster meets the requirements.
Create the workload cluster
Create a workload cluster from your NKP management cluster using the NKP Dashboard or the nkp create cluster command for your infrastructure provider.
Follow the NKP documentation for the provider-specific options.
For an initial evaluation, we recommend a node pool of 3 worker nodes with 4 vCPUs, 16 GB of memory, and 250 GB of disk each (for example, m5.xlarge on AWS).
Okteto supports Kubernetes versions 1.33 through 1.35. Check the supported Kubernetes versions for the Okteto Helm chart version you plan to install, and choose an NKP release that ships a compatible Kubernetes version.
For example, to create a workload cluster on Amazon EKS from your management cluster:
export CLUSTER_NAME="okteto"
export WORKSPACE_NAMESPACE="<your-workspace-namespace>"
nkp create cluster eks \
--cluster-name=${CLUSTER_NAME} \
--namespace=${WORKSPACE_NAMESPACE} \
--region=<your-aws-region> \
--worker-instance-type=m5.xlarge \
--worker-replicas=3 \
--kubeconfig=<management-cluster-kubeconfig>
Clusters created from the management cluster are attached to its workspace automatically, so they show up in the NKP Dashboard and receive the workspace platform applications.
Get the workload cluster kubeconfig
Retrieve the kubeconfig of the workload cluster from the management cluster:
nkp get kubeconfig \
--cluster-name=${CLUSTER_NAME} \
--namespace=${WORKSPACE_NAMESPACE} \
--kubeconfig=<management-cluster-kubeconfig> > ${CLUSTER_NAME}.conf
export KUBECONFIG=$(pwd)/${CLUSTER_NAME}.conf
kubectl get nodes
All the commands below run against the workload cluster.
On Amazon EKS, the kubeconfig returned by nkp get kubeconfig authenticates with aws-iam-authenticator. If you don't have it installed, generate the kubeconfig with aws eks update-kubeconfig --name <eks-cluster-name> --region <your-aws-region> instead.
Verify the default storage class
Okteto uses persistent volumes for the cache of the Okteto Build Service (BuildKit) and, in the default installation, to store your container images in the Okteto Registry.
NKP deploys a CSI driver and a default storage class on every cluster. Confirm there is one marked as (default):
kubectl get storageclass
The name depends on your infrastructure provider:
| Infrastructure provider | Default storage class |
|---|---|
| Nutanix AHV | nutanix-volume |
| AWS / Amazon EKS | ebs-sc |
| Azure / AKS | azuredisk-sc |
| GCP | csi-gce-pd |
| vSphere | vsphere-raw-block-sc |
On pre-provisioned clusters, NKP uses the localvolumeprovisioner storage class, which Nutanix doesn't recommend for production. Configure a production-grade CSI driver as the default storage class before installing Okteto.
Verify load balancer support
Okteto exposes its ingress controller using a Kubernetes LoadBalancer service. Make sure your workload cluster can allocate an external address for it:
- Nutanix AHV, vSphere, and pre-provisioned clusters: NKP uses MetalLB. NKP's own Traefik ingress already takes one address from the MetalLB range, so make sure the range has at least one more free IP address for Okteto.
- Cloud providers (AWS, EKS, Azure, AKS, GCP): the cloud provider allocates a load balancer automatically.
NKP clusters use Cilium as the CNI, with kube-proxy replacement enabled.
We recommend setting externalTrafficPolicy: Local on the Okteto ingress controller service so the load balancer only sends traffic to nodes that run an ingress controller pod. The configuration below already includes it.
Installing Okteto
If you already use Argo CD, or you want a GitOps-based installation, you can install Okteto with Argo CD instead of running Helm directly. Argo CD deploys the same Helm chart declaratively. See Configure Argo CD for the Application manifest, sync policy, and the ignoreDifferences Okteto requires.
It replaces Add the Okteto Helm repository and Installing the Okteto Helm chart. Every other step on this page still applies, including the DNS record and the sign-in.
You install Okteto with its Helm chart.
Add the Okteto Helm repository
Add the Okteto Helm repository:
helm repo add okteto https://charts.okteto.com
helm repo update
Create the Helm configuration file
Create a config.yaml file with the configuration for your infrastructure provider, replacing license and subdomain with your own values:
- Nutanix AHV and on-premises
- Amazon EKS
- Microsoft AKS
- GCP
license: "REPLACE ME WITH YOUR OKTETO LICENSE"
subdomain: "REPLACE ME WITH YOUR OKTETO DOMAIN"
ingress-nginx:
controller:
service:
externalTrafficPolicy: Local
registry:
storage:
filesystem:
persistence:
enabled: true
MetalLB assigns the next free address in its range to the Okteto ingress controller. To request a specific address, add the metallb.universe.tf/loadBalancerIPs: <ip-address> annotation under ingress-nginx.controller.service.annotations.
license: "REPLACE ME WITH YOUR OKTETO LICENSE"
subdomain: "REPLACE ME WITH YOUR OKTETO DOMAIN"
ingress-nginx:
controller:
service:
externalTrafficPolicy: Local
annotations:
service.beta.kubernetes.io/aws-load-balancer-type: nlb
service.beta.kubernetes.io/aws-load-balancer-scheme: "internet-facing"
registry:
storage:
filesystem:
persistence:
enabled: true
The annotations tell AWS to create an internet-facing Network Load Balancer (NLB). NLBs on NKP-managed clusters are internal by default, so the internet-facing scheme is required to reach Okteto from outside your VPC.
license: "REPLACE ME WITH YOUR OKTETO LICENSE"
subdomain: "REPLACE ME WITH YOUR OKTETO DOMAIN"
ingress-nginx:
controller:
service:
externalTrafficPolicy: Local
registry:
storage:
filesystem:
persistence:
enabled: true
Azure allocates a public load balancer for the Okteto ingress controller automatically, so no additional annotations are required.
license: "REPLACE ME WITH YOUR OKTETO LICENSE"
subdomain: "REPLACE ME WITH YOUR OKTETO DOMAIN"
ingress-nginx:
controller:
service:
externalTrafficPolicy: Local
registry:
storage:
filesystem:
persistence:
enabled: true
Google Cloud allocates a public load balancer for the Okteto ingress controller automatically, so no additional annotations are required.
This is the minimum configuration. The Helm configuration lists every setting.
Okteto installs its own NGINX ingress controller, which runs alongside the Traefik ingress that NKP deploys on every cluster. The two don't conflict: Okteto only manages ingresses for the endpoints of your application environments.
Installing the Okteto Helm chart
Install the Okteto Helm chart:
helm upgrade --install okteto okteto/okteto -f config.yaml --namespace=okteto --create-namespace --version=1.48.0
After a few seconds, Helm creates all the resources. The output looks like this:
Release "okteto" has been installed. Happy Helming!
NAME: okteto
LAST DEPLOYED: Thu Mar 26 18:07:55 2020
NAMESPACE: okteto
STATUS: deployed
Retrieve the Ingress Controller address
Use kubectl to get the address allocated to the NGINX ingress controller that Okteto installs:
kubectl get service -l=app.kubernetes.io/name=ingress-nginx,app.kubernetes.io/component=controller --namespace=okteto
The output looks like this:
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
okteto-ingress-nginx-controller LoadBalancer 10.0.7.73 10.38.12.151 80:30795/TCP,443:32481/TCP,1234:30885/TCP 5m
Take the EXTERNAL-IP value and add a wildcard DNS record for your domain:
- If it's an IP address (MetalLB), create an
Arecord with the name*pointing to it. - If it's a hostname (for example, an AWS NLB), create a
CNAMErecord with the name*pointing to it, or an alias record if your DNS provider supports it.
Sign in to your Okteto instance
The default installation isn't meant for production. Once you finish your evaluation, and before you give your team access to your Okteto instance, configure a wildcard certificate and Okteto Registry storage.
NKP deploys cert-manager on workload clusters by default, so you can follow the cert-manager and Let's Encrypt guide without installing cert-manager yourself. Only create the DNS01 Issuer and the wildcard Certificate.
Once the installation finishes, your Okteto instance is available at https://okteto.SUBDOMAIN. Okteto creates your account the first time you log in, and the first user to log in gets the Admin role.
Deploy your first app
With your Okteto instance running, install the Okteto CLI and configure it with the URL of your instance, https://okteto.SUBDOMAIN. Then deploy your first app.
Support for joint Okteto and Nutanix customers
Okteto and Nutanix work together to support joint customers. If you run into an issue installing or operating Okteto on NKP, open a support ticket with Okteto. When an issue involves the NKP layer, we'll coordinate with Nutanix to resolve it.