From 61ce33a4ca6d3d7662bb091bdd8bcfc9a61c792d Mon Sep 17 00:00:00 2001 From: Mingyu Ma Date: Fri, 16 Oct 2020 19:09:14 +0800 Subject: [PATCH] [Documentation] Improve usability of cloudlab profiles This PR introduces a new Makefile and updated documentation. Commit log: * Update readme versions and makefile * Fix issues * Remove make dpdk --- Makefile | 13 +++++++++++++ README.md | 6 +++--- scripts/setup_cloudlab.sh | 2 ++ 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index c94ac0f72..2ba3d95ac 100644 --- a/Makefile +++ b/Makefile @@ -36,6 +36,19 @@ # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +ifeq ($(ONVM_HOME),) +$(error "Please define ONVM_HOME environment variable") +endif + +ifeq ($(RTE_SDK),) +$(error "Please define RTE_SDK environment variable") +endif + +all: + # cd $(ONVM_HOME)/dpdk && make + cd $(ONVM_HOME)/onvm && make + cd $(ONVM_HOME)/examples && make + .PHONY: tags tags: diff --git a/README.md b/README.md index bfa6e1ceb..7b0524601 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ _Want to get started quickly?_ Try using our NSF CloudLab profile: https://www.c Notes -- -We have updated our DPDK submodule to point to a new version, v18.11. If you have already cloned this repository, please update your DPDK submodule by running: +We have updated our DPDK submodule to point to a new version, v20.05. If you have already cloned this repository, please update your DPDK submodule by running: ``` git submodule sync @@ -25,7 +25,7 @@ make T=$RTE_TARGET -j 8 make install T=$RTE_TARGET -j 8 ``` -See our [release](docs/Releases.md) document for more information. +The current OpenNetVM version is 20.10. Please see our [release](docs/Releases.md) document for more information. About -- @@ -35,7 +35,7 @@ openNetVM is an open source version of the NetVM platform described in our [NSDI The [develop][dev] branch tracks experimental builds (active development) whereas the [master][mast] branch tracks verified stable releases. Please read our [releases][rels] document for more information about our releases and release cycle. -You can find information about research projects building on [OpenNetVM][onvm] at the [UCR/GW SDNFV project site][sdnfv]. OpenNetVM is supported in part by NSF grants CNS-1422362 and CNS-1522546. +You can find information about research projects building on [OpenNetVM][onvm] at the [UCR/GW SDNFV project site][sdnfv]. OpenNetVM is supported in part by NSF grants CNS-1422362 and CNS-1522546. Installing -- diff --git a/scripts/setup_cloudlab.sh b/scripts/setup_cloudlab.sh index 2706efe80..13fa79618 100755 --- a/scripts/setup_cloudlab.sh +++ b/scripts/setup_cloudlab.sh @@ -52,3 +52,5 @@ fi if [ -z "$ONVM_HOME" ]; then export ONVM_HOME=$ONVM_PATH fi + +bash "$ONVM_HOME"/scripts/setup_environment.sh