Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
louisroyer committed Sep 21, 2024
1 parent 1da5976 commit 7ec58c5
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,8 @@ ue/ip/%:
.PHONY: ue/ping
ue/ping/%:
@# ping between ues
@# ex: `make ue/ping/1/2` pings from ue1 to ue2
@# example:
@# make ue/ping/1/2
@# pings from ue1 to ue2
@TARGET=$(shell docker exec -it ue$(@F)-debug bash -c "ip --brief address show uesimtun0|awk '{print \$$3; exit}'|cut -d"/" -f 1");\
docker exec -it ue$(*D)-debug bash -c "ping $$TARGET"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The following Debian's packets are required (or their equivalent on your distrib
> install [Free5CG's GTP5G kernel module](https://github.com/free5gc/gtp5g) on your host.
> Until [upstream issue](https://github.com/free5gc/go-upf/issues/53) is fixed, and this repository updated, use version v0.8.10 of the driver.
> Please note that you need to have Linux headers installed on the host to be able to install the module
> (for example, the package linux-headers-amd64 on Debian if you are on an amd64 architecture).
> (for example, the package `linux-headers-amd64` on Debian if you are on an amd64 architecture).

### Usage
Expand Down
3 changes: 2 additions & 1 deletion doc/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ When you update the git repository, please ensure to update Docker images as wel
- `make db/<container-name>`: enter the database associated with a container (for NextMN-SRv6)
- `make l/<container-name>`: show logs of a container
- `make lf/<container-name>`: show logs of a container (continuous)
- `make ping/<container-source-name>/<container-target-name>`: ping from `container-source` to `container-target`

## Using UEs
- `make ue/ip/<ue-number>`: show IP Address of the UE within the Mobile Network
- `make ue/ping/<ue-source-number>/<ue-target-number>`
- `make ue/ping/<ue-source-number>/<ue-target-number>`: ping from `ue-source` to `ue-target`

0 comments on commit 7ec58c5

Please sign in to comment.