Version R2 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

Nephio install guides

Nephio install guides

Demonstration Environment Installation

Table of Contents


This Installation Guide will set up and run a Nephio demonstration environment. This environment is a single VM that will be used in the exercises to simulate a topology with a Nephio Management cluster, a Regional Workload cluster, and two Edge Workload clusters.

Installing on GCE

GCE Prerequisites

You will need a account in GCP and gcloud installed on your local environment.

Create a Virtual Machine on GCE

gcloud compute instances create --machine-type e2-standard-16 \
                                    --boot-disk-size 200GB \
                                    --image-family=ubuntu-2004-lts \
                                    --image-project=ubuntu-os-cloud \
                                    --metadata=startup-script-url=,nephio-test-infra-branch=v2.0.0 \

NOTE: e2-standard-16 is recommended and e2-standard-8 is minimum.

Follow the Installation on GCE

If you want to watch the progress of the installation, give it about 30 seconds to reach a network accessible state, and then ssh in and tail the startup script execution:

gcloud compute ssh ubuntu@nephio-r2-e2e -- \
                sudo journalctl -u google-startup-scripts.service --follow

Installing on a Pre-Provisioned VM

This install has been verified on VMs running on vSphere, OpenStack, AWS, and Azure.

VM Prerequisites

Order or create a VM with the following specification:

  • Linux Flavour: Ubuntu-20.04-focal
  • Minimum 8 cores and recommended 16 Cores
  • 32 GB memory
  • 200 GB disk size
  • Default user with sudo passwordless permissions

Configure a Route for Kubernetes

In some installations, the IP range used by Kubernetes in the sandbox can clash with the IP address used by your VPN. In such cases, the VM will become unreachable during the sandbox installation. If you have this situation, add the route below on your VM.

Log onto your VM and run the following commands, replacing <interface-name> and <interface-gateway-ip> with your VMs values:

sudo bash -c 'cat << EOF > /etc/netplan/99-cloud-init-network.yaml
        - to:
          via: <interface-gateway-ip>
          metric: 100
  version: 2

sudo netplan apply

Kick Off an Installation on VM

Log onto your VM and run the following command:

wget -O - |  \
sudo NEPHIO_DEBUG=false   \
     NEPHIO_BRANCH=v2.0.0 \
     NEPHIO_USER=ubuntu   \

The following environment variables can be used to configure the installation:

Variable Values Default Value Description
NEPHIO_USER userid ubuntu The user to install the sandbox on (must have sudo passwordless permissions)
NEPHIO_DEBUG false or true false Controls debug output from the install
NEPHIO_HOME path /home/$NEPHIO_USER The directory to check out the install scripts into
RUN_E2E false or true false Specifies whether end-to-end tests should be executed or not
DOCKERHUB_USERNAME alpha-num string Specifies the dockerhub username
DOCKERHUB_TOKEN alpha-num string Specifies the password or token
NEPHIO_REPO URL URL of the repository to be used for installation
NEPHIO_BRANCH branch or tag main/v2.0.0 Tag or branch name to use in NEPHIO_REPO
DOCKER_REGISTRY_MIRRORS list of URLs in JSON format List of docker registry mirrors in JSON format, or empty for no mirrors to be set. Example value: ["", ""]

Follow the Installation on VM

Monitor the installation on your terminal.

Log onto your VM using ssh on another terminal and use commands docker and kubectl to monitor the installation.

Access to the User Interfaces

Once it is completed, ssh in and port forward the port to the UI (7007) and to Gitea’s HTTP interface, if desired (3000):

Using GCE:

gcloud compute ssh ubuntu@nephio-r2-e2e -- \
                -L 7007:localhost:7007 \
                -L 3000: \
                kubectl port-forward --namespace=nephio-webui svc/nephio-webui 7007

Using a VM:

ssh <user>@<vm-address> \
                -L 7007:localhost:7007 \
                -L 3000: \
                kubectl port-forward --namespace=nephio-webui svc/nephio-webui 7007

You can now navigate to:

Open Terminal

You will probably want a second ssh window open to run kubectl commands, etc., without the port forwarding (which would fail if you try to open a second ssh connection with that setting).

Using GCE:

gcloud compute ssh ubuntu@nephio-r2-e2e

Using a VM:

ssh <user>@<vm-address>

Next Steps

Installing common dependencies

This guide describes how to install some required dependencies that are the same across all environments.

Installing base Nephio components

After installing the environment-specific dependencies, you can install the base Nephio components. There are two essential components: Porch, and Nephio Controllers.

Installation on BYOC

Step by step guide to install Nephio on any cluster

Installation on GCE

Step by step guide to install Nephio on GCE

Installation on GCP

A step by step guide to install Nephio on GCP

Installation on OpenShift

Step by step guide to install Nephio on OpenShift

Installation on a single VM

Nephio Installation in a sandbox VM

Overview of the single VM installation

An overview of the Nephio single VM

Install WebUI

These instructions explain how to install the Nephio WebUI.

Nephio demo on Windows

Step by step guide to run Nephio on Windows

Nephio Free5gc Operator

Step by step guide to deploy the Free5gc Operator

OpenStack deployment management

OpenStack Multi-Cluster Deployment Management with Nephio

Package transformations guide

Package Transformations Work in Nephio Sandbox Installation

WebUI authentication with Google OAuth 2.0 or OIDC

These instructions explain how to set up the Nephio WebUI to use Google OAuth 2.0 for authentication, or using OIDC backed by Google authentication.

WebUI OIDC authentication with Okta

These instructions explain how to set up the Nephio WebUI to use OIDC with Okta for authentication.