Skip to content

Commit

Permalink
Update M-Plane Demo README to show correct launch commands for the de…
Browse files Browse the repository at this point in the history
…mo client
  • Loading branch information
farshid-cloudly committed Jan 31, 2024
1 parent 98f6639 commit c800043
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions mplane_client/example/demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ written as a docker container which can be run on an arbitrary host.

## Build

From the directory above `mplane_demo`, i.e. `mplane-rru/mplane/mpclient`, run
`docker build -f demo.Dockerfile --tag mplane/mpclient-demo:latest`. Note that
the image `mplane/mpclient-built-tests:latest` is expected to be available in
your local Docker images. `mplane/mpclient-built-tests:latest` is built during
From the directory above `demo`, i.e. `open-mplane/mplane_client/example`, run
`docker build -f demo.Dockerfile --tag mplane/mpclient-demo:latest .`. Note that
the image `mplane/mplane-client-integrated-tester:latest` is expected to be available in
your local Docker images. `mplane/mplane-client-integrated-tester:latest` is built during
the mpclient dockerized build.

## Run
Expand All @@ -21,11 +21,19 @@ port with `ssh`, e.g.:
ssh -L 9999:localhost:830 <M-Plane server host>
```

Once port 9999 is setup, run `mplane_demo/run_demo.sh`. The console will contain
a log from `mpclient-server` and the webapp running in the docker container, and
Once port 9999 is setup, run `demo/run_demo.sh`. The console will contain
a log from `mpc_client` and the webapp running in the docker container, and
a webpage displaying information fetched from the M-Plane server will be
available at `localhost:80`.

For linux, `run_demo.sh` needs to be modified to add the host-gateway:
```
docker run \
-p 127.0.0.1:10000:830 -p 80:8000/tcp \
-it --add-host host.docker.internal:host-gateway mplane/mpclient-demo:latest \
python3 /mplane_demo/server.py
```

## Files

- `getalarms.xml`: A yin payload for fetching the `active-alarm-list` O-RAN YANG leaf
Expand Down

0 comments on commit c800043

Please sign in to comment.