Skip to content

Commit

Permalink
Remove "Build custom Podman images" from README.md (#26)
Browse files Browse the repository at this point in the history
This section is irrelevant, as the building the
images is a part of the Makefiles in the examples.
Also, the root Makefile was moved to utils, so
`make images`  is not a valid command anymore.

Signed-off-by: Stanislav Kosorin <stanokosorin4@gmail.com>
  • Loading branch information
stano45 authored Sep 6, 2024
1 parent 52f389e commit 5cfac89
Showing 1 changed file with 2 additions and 14 deletions.
16 changes: 2 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ For more information about the project, please refer to the [final report](REPOR
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Install Python Dependencies](#install-python-dependencies)
- [Build Custom Podman Images](#build-custom-podman-images)
- [Running examples](#running-examples)


Expand All @@ -24,9 +23,10 @@ For more information about the project, please refer to the [final report](REPOR
- [P4 Compiler](https://github.com/p4lang/p4c) (v1.2.4.14)
- [PI](https://github.com/p4lang/PI)
- [Podman](https://podman.io/docs/installation) (v5.2.1)

The versions mentioned above are the ones used during development. Newer versions may work, but have not been tested.

We have provided [scripts](scripts) to install CRIU (with crit), the P4 compiler, PI, and Podman. The scripts have been tested on Ubuntu 22.04 and 24.04 and are not guaranteed to work on all machines. If you encounter any issues, please refer to the official documentation of the respective projects.
We have provided [scripts](scripts) to install CRIU (with crit), the P4 compiler, PI, and Podman. The scripts have been tested on Ubuntu [22.04.4](https://releases.ubuntu.com/jammy/) and [24.04](https://releases.ubuntu.com/noble/) and are not guaranteed to work on all machines. If you encounter any issues, please refer to the official documentation of the respective projects.

### Install Python Dependencies
```bash
Expand All @@ -35,18 +35,6 @@ source .venv/bin/activate
pip install -r requirements.txt
```

### Build Custom Podman Images
```bash
make images
```
This will build the following images:
- `tcp-client`: A simple TCP client that sends a message to a server (this will run in h1-pod)
- `tcp-server`: A simple TCP server that listens for a message from a client (this will run in all other pods)

You can configure the target IP of the client and the port of the server in the [tcp/Containerfile.server](tcp/Containerfile.server) and [tcp/Containerfile.client](tcp/Containerfile.client) files respectively.

Furthermore, you can specify which image to run in the hosts by changing the `IMG` and `ARGS` variables in [scripts/switch_container/build.sh](scripts/switch_container/build.sh).

## Running examples
There are three examples in the `examples` directory:
- [process_migration](examples/process_migration): Process migration demo using network namespaces
Expand Down

0 comments on commit 5cfac89

Please sign in to comment.