Installing common dependencies
This guide describes how to install some required dependencies that are the same across all environments.
This page is draft and the separation of the content to different categories is not clearly done.
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.
You will need a account in GCP and gcloud
installed on your local environment.
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
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
This install has been verified on VMs running on vSphere, OpenStack, AWS, and Azure.
Order or create a VM with the following specification:
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
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:
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 | https://github.com/nephio-project/test-infra.git | URL of the repository to be used for installation |
NEPHIO_BRANCH | branch | main/v3.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: ["https://docker-registry-remote.mycompany.com", "https://docker-registry-remote2.mycompany.com"] |
|
K8S_CONTEXT | K8s context | kind-kind | Kubernetes context for existing non-kind cluster (gathered from kubectl config get-contexts , for example “kubernetes-admin@kubernetes”) |
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.
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:
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>
This guide describes how to install some required dependencies that are the same across all environments.
After installing the environment-specific dependencies, you can install the base Nephio components. There are two essential components: Porch, and Nephio Controllers.
Step by step guide to install Nephio on any cluster
Step by step guide to install Nephio on GCE
A step by step guide to install Nephio on GCP
Step by step guide to install Nephio on OpenShift
Nephio Installation in a sandbox VM
An overview of the Nephio single VM
These instructions explain how to install the Nephio WebUI.
Step by step guide to run Nephio on Windows
Step by step guide to deploy the Free5gc Operator
Nephio manual deployment on different VMs
Package Transformations Work in Nephio Sandbox Installation
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.
These instructions explain how to set up the Nephio WebUI to use OIDC with Okta for authentication.