Installing Cloud Native Runtimes Locally

This topic describes how to install Cloud Native Runtimes on your local machine in as little as 3 steps. Install a working Kubernetes cluster using a provider of your choice with the correct physical resources. Install the necessary cli tools on your local machine. Then download and install CNR and kApp on your Kubernetes cluster.

Prerequisites

The following is an overview of prerequisites required to install Cloud Native Runtimes:

Cluster Hardware Requirements
Physical Resources Single Node Multi Node
CPU 6 2
RAM 6 4
Disk Storage 30 20

Note: You may need to increase your physical resources from Docker preferences.

  • Kubernetes v1.20 or later.

  • Local command line tools required:

  • Kubernetes cluster software required:

    • CNR
    • kapp-controller
    • secretgen-controller

Note: See the CNR Compatibility Matrix for compatible versions.

  • For a successful install limit your cluster software install to just what’s shown here.

Install local command line tools

To install Cloud Native Runtimes you first need to install software on your local machine.

To Install Carvel Tools Suite: - kapp - ytt - kbld

  • Via Homebrew on MacOS or Linux
    brew tap vmware-tanzu/carvel
    brew install ytt kbld kapp imgpkg
    
  • Via script on MacOS or Linux
    wget -O- https://carvel.dev/install.sh | bash
    # or with curl...
    curl -L https://carvel.dev/install.sh | bash
    

To install Kube-ctl and KN cli: - Install Tools | Kubernetes - Installing kn - Knative

Create a Kubernetes Cluster Locally

To use Cloud Native Runtimes, you must have a Kubernetes cluster. There are several resources you can choose from to create a local cluster. CNR works especially well with Kind or Minikube follow their install docs to get started:

Download Cloud Native Runtimes

To install Cloud Native Runtimes, you must first download the installation package from VMware Tanzu Network.

To download Cloud Native Runtimes:

  1. Log into VMware Tanzu Network.
  2. Navigate to the Cloud Native Runtimes release page.
  3. Download the cloud-native-runtimes-<RELEASE_TARBALL_NAME> archive.
  4. Extract the tarball cloud-native-runtimes-<RELEASE_TARBALL_NAME>.tgz, for example:
    tar -xvf cloud-native-runtimes-<RELEASE_TARBALL_NAME>.tgz
    

Install Cloud Native Runtimes

Use one of the following procedures, depending on your platform, to install Cloud Native Runtimes. To install, you target the cluster and run the installation script.

Note: If you see the following error message after you run the Cloud Native Runtimes installation script, see Installing Cloud Native Runtimes with an Existing Contour Installation:
Could not proceed with installation. Refer to Cloud Native Runtimes documentation for details on how to utilize an existing Contour installation. Another app owns the custom resource definitions listed below.

Install on a Local Kubernetes Cluster Provider

To install Cloud Native Runtimes on Docker Desktop, kind, or minikube:

Note: To install on minikube, you need at least 4GB of available system RAM for all pods to start.

  1. Target the cluster you want to use. See kind User Guide, or minikube start.

  2. Verify that you are targeting the correct Kubernetes cluster. Run:

    kubectl cluster-info
    
  3. Run the installation script from the cloud-native-runtimes directory:

    cnr_provider=local ./bin/install.sh
    
check-circle-line exclamation-circle-line close-line
Scroll to top icon