Update README
- Remove instructions to install the JDK, as we now use the
Bazel-provided remote JDK.
- Formatting (wrap at 80 chars column)
Change-Id: I446d64a5e2910427b09937ff7adbe84991c70bcd
diff --git a/README.md b/README.md
index 31b89dd..2a6803e 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,10 @@
## What is ONOS?
-ONOS is the only SDN controller platform that supports the transition from legacy “brown field” networks to SDN “green field” networks.
-This enables exciting new capabilities, and disruptive deployment and operational cost points for network operators.
+ONOS is the only SDN controller platform that supports the transition from
+legacy “brown field” networks to SDN “green field” networks. This enables
+exciting new capabilities, and disruptive deployment and operational cost points
+for network operators.
## Top-Level Features
@@ -13,7 +15,8 @@
that will continue to support improvements.
* Northbound abstractions for a global network view, network graph, and
application intents.
-* Pluggable southbound for support of OpenFlow and new or legacy protocols.
+* Pluggable southbound for support of OpenFlow, P4Runtime, and new or legacy
+ protocols.
* Graphical user interface to view multi-layer topologies and inspect elements
of the topology.
* REST API for access to Northbound abstractions as well as CLI commands.
@@ -28,35 +31,31 @@
### Dependencies
-The following packages are reuqired:
+The following packages are required:
* git
* zip
* curl
* unzip
* python2.7
-* Oracle JDK8
-
-To install Oracle JDK8, use following commands (Ubuntu):
-```bash
-$ sudo apt-get install software-properties-common -y && \
- sudo add-apt-repository ppa:webupd8team/java -y && \
- sudo apt-get update && \
- echo "oracle-java8-installer shared/accepted-oracle-license-v1-1 select true" | sudo debconf-set-selections && \
- sudo apt-get install oracle-java8-installer oracle-java8-set-default -y
-```
+* python3 (needed by Bazel)
### Build ONOS from source
-ONOS is built with [Bazel](https://bazel.build/), an open-source build tool developed by Google.
-ONOS supports Bazel 0.17 You can download it from official website or package manager (e.g. apt, brew...)
+ONOS is built with [Bazel](https://bazel.build/), an open-source build tool
+developed by Google. We suggest downloading and installing Bazel using the
+[official instructions](https://docs.bazel.build/versions/master/install.html).
-1. Clone the code from ONOS gerrit repository
+The minimum required Bazel version is 0.27.0
+
+1. Clone the code from the ONOS Gerrit repository
```bash
$ git clone https://gerrit.onosproject.org/onos
```
-2. Add ONOS developer environment to your bash profile, no need to do this step again if you had done this before
+2. Optionally, you can add the ONOS developer environment to your bash profile.
+ This will provide access to a number of handy commands to run, test and debug
+ ONOS. No need to do this step again if you had done this before:
```bash
$ cd onos
$ cat << EOF >> ~/.bash_profile
@@ -80,22 +79,31 @@
$ bazel run onos-local [-- [clean] [debug]]
```
-or simpler one:
+Or simpler one, if you have added the ONOS developer environment to your bash
+profile:
```bash
$ ok [clean] [debug]
```
-The above command will create a local installation from the onos.tar.gz file (re-building it if necessary) and will start the ONOS server in the background.
-In the foreground, it will display a continuous view of the ONOS (Apache Karaf) log file.
-Options following the double-dash (–) are passed through to the ONOS Apache Karaf and can be omitted.
-Here, the `clean` option forces a clean installation of ONOS and the `debug` option means that the default debug port 5005 will be available for attaching a remote debugger.
+The above command will create a local installation from the ONOS tarbal
+(re-building if necessary) and will start the ONOS server in the background. In
+the foreground, it will display a continuous view of the ONOS (Apache Karaf) log
+file. Options following the double-dash (–) are passed through to the ONOS
+Apache Karaf and can be omitted. Here, the `clean` option forces a clean
+installation, removing any state from previous executions. The `debug` option
+means that the default debug port 5005 will be available for attaching a remote
+debugger.
### Interacting with ONOS
-To access ONOS UI, use browser to open [http://localhost:8181/onos/ui](http://localhost:8181/onos/ui) or use `onos-gui localhost` command
+To access ONOS UI, use a browser to open:
-The default username and password is **onos/rocks**
+[http://localhost:8181/onos/ui](http://localhost:8181/onos/ui)
+
+Or simpler, use the `onos-gui localhost` command.
+
+The default username and password is `onos`/`rocks`.
To attach to the ONOS CLI console, run:
@@ -105,13 +113,15 @@
### Unit Tests
-To run ONOS unit tests, including code Checkstyle validation, run the following command:
+To run ONOS unit tests, including code Checkstyle validation, run the following
+command:
```bash
$ bazel query 'tests(//...)' | xargs bazel test
```
-Or better yet, to run code Checkstyle and all unit tests use the following convenience alias:
+Or better yet, to run code Checkstyle and all unit tests use the following
+convenience alias:
```bash
$ ot
@@ -121,9 +131,12 @@
ONOS code is hosted and maintained using [Gerrit](https://gerrit.onosproject.org/).
-Code on GitHub is only a mirror. The ONOS project does **NOT** accept code through pull requests on GitHub.
+Code on GitHub is only a mirror. The ONOS project does **NOT** accept code
+through pull requests on GitHub.
-To contribute to ONOS, please refer to [Sample Gerrit Workflow](https://wiki.onosproject.org/display/ONOS/Sample+Gerrit+Workflow). It should includes most of the things you'll need to get your contribution started!
+To contribute to ONOS, please refer to [Sample Gerrit
+Workflow](https://wiki.onosproject.org/display/ONOS/Sample+Gerrit+Workflow). It
+should includes most of the things you'll need to get your contribution started!
## More information
@@ -136,4 +149,5 @@
## License
-ONOS (Open Network Operating System) is published under [Apache License 2.0](https://github.com/opennetworkinglab/onos/blob/master/LICENSE.txt)
+ONOS (Open Network Operating System) is published under [Apache License
+2.0](https://github.com/opennetworkinglab/onos/blob/master/LICENSE.txt)