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.
...
To get the most from the tools and instructions discussed in the following sections, it is highly recommended that the ONOS_ROOT environment variable is exported in your the shell profile (.bash_aliases, .profile, etc.) to refer to the top of the ONOS source tree. For example:
...
ONOS may be run on the build machine directly, or packaged and launched on remote machines or VMs. This section describes both launching ONOS on the build machine (locally), and packaging and deploying on a remote (target) machine.
Launching locally
After running maven as described in Building ONOS, karaf can be used to start ONOS and attach to its CLI:
| Code Block | ||
|---|---|---|
| ||
$ karaf
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> |
Hitting <Ctrl-D> or logout will exit the CLI.
| Tip | |||||
|---|---|---|---|---|---|
Launching karaf may bring up the default karaf prompt, without the 'ONOS' ASCII art. This is purely cosmetic, and shouldn't affect functionality; typing If the branding is desired, one can move the branding bundle created during the build process to karaf's lib directory:
And relaunch karaf. |
...
Remote installations are useful when one wishes to run multiple ONOS instances in a cluster. This section demonstrates remote installation on a single remote target machine.
| Note |
|---|
As of now, these steps are fairly involved. The procedure is expected to become more streamlined in future releases. |
Overview
The ONOS build process produces a number of OSGi bundles, which are essentially Java jar files. One could simply deploy these bundles in any OSGi container to run ONOS, but this would require that such container be installed, properly configured, and that the bundles be collected and properly staged. The ONOS utility scripts, onos-package and onos-install, simplifies this task by packaging the ONOS binaries into a distributable compressed tar.
...
| 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
The procedures above can get cumbersome when dealing with multiple target machines. For dealing with multiple remote machines, the behavior of the ONOS utilities can be streamlined by employing test cells. Test cells are discussed under [Development environment setup] in the Developer's Guide.
...
[Previous] [Next]
...