diff --git a/README.md b/README.md index 2e27b07..f6700f1 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,16 @@ # 5G EVE Experiment NSD composer -A REST API module to compose experiment NSDs. It can also validate blueprints and generate NSDs from them. + +A REST API module to compose experiment NSDs. +It can also validate blueprints and generate NSDs from them. ## Install Docker images are available on [Docker Hub](https://hub.docker.com/r/mpergolesi/exp-nsd-composer). +Check the latest tag (version) available. Run the application with: ```shell script -docker run -p 8086:8086 -d mpergolesi/exp-nsd-composer:1.0.0 +docker run -p 8086:8086 -d mpergolesi/exp-nsd-composer: ``` Wait for the application to start, then test it with: @@ -29,13 +32,13 @@ Some dependencies are not available in Maven repository. Check `pom.xml`. Compile the project with: -``` +```shell script mvn clean package ``` Build the Docker image with: -``` +```shell script docker build --no-cache=true --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') \ --build-arg BUILD_VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) \ -t /exp-nsd-composer:$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) . @@ -47,7 +50,8 @@ Debug log often provides network topology export into graphviz format. Running tests will produce output examples. Copy the output to a text file called 'example.txt' and create a PNG with -``` + +```shell script circo -Tpng example.txt -o example.png ```