Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
...
| Code Block |
|---|
$ export ONOS_ROOT=~/onos $ source $ONOS_ROOT/tools/dev/bash_profile |
If this is not done, at the very minimum, one should make sure to adjust their path as follows:
| Code Block | ||
|---|---|---|
| ||
$ export PATH="$PATH:~/onos/dev/bin:~/onos/tools/build:~/onos/tools/test/bin" |
| Tip | ||
|---|---|---|
| ||
To use karaf or onos command described in following sections, $KARAF_HOME/bin needs be added to the PATH environment variable. By default $ONOS_ROOT/tools/dev/bash_profile expects $KARAF_HOME to be ~/Applications/apache-karaf-$KARAF_VERSION and add them to the PATH. If you have installed Apache Karaf to a different path, define $KARAF_HOME pointing to the correct path before including $ONOS_ROOT/tools/dev/bash_profile |
...
Karaf must first be configured to load the ONOS-related modules. In apache-karaf-3.0.2Kara's configuration file KARAF_HOME/etc/org.apache.karaf.features.cfg .
...
The above loads the trivial (single-instance) ONOS core, forwarding, and topology viewer applications.
...
At this point, typing help onos at the prompt should still bring up a list of available commands. Hitting <CtrlCtrl-D> D or logout will exit the CLI.
...
- The Apache Karaf binaries (either .zip or .tar.gz format) are available in ~/Downloads of the build machine
- The ONOS source has been built
- The install target has a Java 8 JRE installed
...
| Code Block | ||
|---|---|---|
| ||
$ export ONOS_FEATURES="webconsole,onos-api,onos-core,onos-cli,onos-openflow,onos-app-fwd,onos-app-mobility,onos-app-tvue" |
...
Deployment
Running onos-package produces a self-contained tar archive.
...
As seen above, the file has the naming convention "onos-1.0.0.<username>.tar.gz", and is created under the /tmp/ directory.
This file can be deployed by pointing onos-install to the remote target to run ONOS on (192.168.56.20 in this example):
| Code Block | ||
|---|---|---|
| ||
$ onos-install 192.168.56.20 onos start/running, process 9513 |
| Tip |
|---|
If ONOS has been previously installed on a remote machine, onos-install -f [target] will force a reinstall. |
Once ONOS is running, the onos utility can be used to attach to the remote instance's CLI:
| Code Block | ||
|---|---|---|
| ||
$ onos 192.168.56.20
Welcome to Open Networking Operating System (ONOS)!
____ _ ______ ____
/ __ \/ |/ / __ \/ __/
/ /_/ / / /_/ /\ \
\____/_/|_/\____/___/
Hit '<tab>' for a list of available commands
and '[cmd] --help' for help on a specific command.
Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown ONOS.
onos> | ||
| Tip | ||
If ONOS has been previously installed on a remote machine, onos-install -f [target] will force a reinstall. |
Handling multiple remote targets
For dealing with multiple remote machines, the behavior of the ONOS utilities can be streamlined by employing test cells. Test cells are discussed under Test Environment Setup in the Developer's Guide.
...