inkweaver
/
P4-in-a-Bottle
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

README.md: Update sc-run to app-run

This commit is contained in:
Jack Yu 2023-05-18 11:07:14 -07:00
parent d8adf910a9
commit a07e8e94ed
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -24,32 +24,32 @@ this container also has a few other advantages:
2. It can run with a variety of setups: Docker, Podman, K8S, OpenShift, etc...
3. It can be used as a basis for other P4 runtime testing suites.
4. It's much smaller than a VM image.
5. When converted into a singularity container, it can be launched as a single
binary executable.
5. When converted into a Apptainer SIF, it can be launched as a single binary
executable.
How to Use
----------
There are two ways of launching P4-in-a-Bottle:
### Singularity
### Apptainer
Singularity is a container runtime by Sylabs developed specificly for software
Apptainer is a container runtime by Sylabs developed specificly for software
that require low-level access to hardware (i.e. NVIDIA drivers, network
devices). This is great for P4-in-a-Bottle, since Mininet requires access to
networking kernel components to work.
Unfortunately, Singularity only works natively on Linux, so if you're on Mac or
Unfortunately, Apptainer only works natively on Linux, so if you're on Mac or
Windows (without WSL), you're out-of-luck here and should proceed to the docker
instructions below.
To use P4-in-a-Bottle with Singularity:
1. Install singularity from [GitHub](https://github.com/sylabs/singularity/releases).
To use P4-in-a-Bottle with Apptainer:
1. Install Apptainer from [GitHub](https://github.com/apptainer/apptainer/releases).
2. Clone and cd into this repository.
3. Download a pre-built image
[p4iab.sif](https://git.inkweaver.net/inkweaver/P4-in-a-Bottle/releases)
and place it in the same directory alongside `README.md`.
4. Run `make sc-run`. A shared directory `shared/` will be created to allow
4. Run `make app-run`. A shared directory `shared/` will be created to allow
you to move files between the container and your system.
### Docker
@ -81,7 +81,7 @@ $ make .docker_build
# Building a docker image that can be imported on other machines
$ make p4iab.tar.gz
# Building a singularity image (This depends on the docker image)
# Building a Apptainer image (This depends on the docker image)
$ make p4iab.sif
# Cleanup any cached artifacts