Nephio install guides

Introduction

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 and three 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=https://raw.githubusercontent.com/nephio-project/test-infra/v3.0.0/e2e/provision/init.sh,nephio-test-infra-branch=v3.0.0 \
                                    nephio-r3-e2e

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-r3-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
network:
  ethernets:
    <interface-name>:
      routes:
        - to: 172.18.2.6/32
          via: <interface-gateway-ip>
          metric: 100
  version: 2
EOF'

sudo netplan apply

Kick Off an Installation on VM

The commands below use default values for the GitHub path, GitHub branch/tag, username, K8s context, etc. See the table of variables below for information on how to set custom installation parameters and make changes to commands as you need to.

Kind Cluster

Log onto your VM and run the following command :

wget -O - https://raw.githubusercontent.com/nephio-project/test-infra/v3.0.0/e2e/provision/init.sh |  \
sudo NEPHIO_DEBUG=false   \
     NEPHIO_BRANCH=v3.0.0 \
     NEPHIO_USER=ubuntu   \
     bash

Pre-installed K8s Cluster

Log onto your VM/System and run the following command: (NOTE: The VM or System should be able to access the K8S API server via the kubeconfig file and have docker installed. Docker is needed to run the KRM container functions specified in rootsync and repository packages.)

wget -O - https://raw.githubusercontent.com/nephio-project/test-infra/v3.0.0/e2e/provision/init.sh |  \
sudo NEPHIO_DEBUG=false   \
     NEPHIO_BRANCH=v3.0.0 \
     NEPHIO_USER=ubuntu   \
     DOCKERHUB_USERNAME=username \
     DOCKERHUB_TOKEN=password \
     K8S_CONTEXT=kubernetes-admin@kubernetes \
     bash

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

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-r3-e2e -- \
                -L 7007:localhost:7007 \
                -L 3000:172.18.0.200:3000 \
                kubectl port-forward --namespace=nephio-webui svc/nephio-webui 7007

Using a VM:

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

You can now navigate to:

• http://localhost:7007/config-as-data to browse the Nephio Web UI
• http://localhost:3000/nephio to browse the Gitea UI

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-r3-e2e

Using a VM:

ssh <user>@<vm-address>

Next Steps

• Step through the exercises
  • Free5GC Testbed Deployment and E2E testing with UERANSIM
  • OAI Core and RAN Testbed Deployment and E2E testing
• Dig into the user guide
• Nephio sandbox environment
  • Install on pre-provisioned single VM
  • Install on GCE
  • Explore sandbox environment
• Bring-Your-Own-Cluster
• Install using vagrant on Windows (for development)