Date: Thu, 28 Mar 2024 13:44:16 +0000 (UTC) Message-ID: <560569381.765.1711633456502@ip-10-30-146-46.us-west-2.compute.internal> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_764_1711392999.1711633456499" ------=_Part_764_1711392999.1711633456499 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The following section describes how to perform basic tasks on ON= OS applications, such as installing, uninstalling, listing, activating appl= ications, in production environments.
For production deployments, apps can be either included in the ONOS pack= age before deploying, or installed later, in form of ONOS Application aRchi= ves (OARs).
As any other cluster operation, managing applications can be done from o= ne node of the cluster. The cluster itself will know how to copy the bits t= o the other nodes of the cluster (target machines) and/or replicate configu= rations.
Installing an application means copying the application to the = target machine running ONOS. As on your PC, installing an application doesn= 't mean necessarily run the application.
In order to run (execute) an application, you need to explicitly act= ivate it.
Of course, related uninstall and deactivate options follow the same sema= ntic.
ONOS comes in its standard distribution with a number of default applica= tions, such as SDN-IP and&nb= sp;VPLS. T= hese applications do not have to be installed explicitly via OAR files, but= they do need to be activated and configured. Detailed instructions for con= figuring and running these applications can be found in the appropriat= e sections of Apps and Us= e Cases.
Specific REST APIs to manage applications won't be discussed in the sect= ions below. You can find a complete list of applications related REST APIs = under the development guide, here: Appendix B: REST API#Application=
Installed applications can be listed through the CLI, the GUI and the RE= ST APIs.
In the CLI, use the apps command to list all the applications i= nstalled. You can add the -s (summary) parameter to see a more compact vers= ion of the list, and the -a (active) parameter to see only the active appli= cations. Active applications should have an asterisk near their name.
onos>= ; apps -s 4 org.onosproject.scalablegateway 1.9.0.SNAPSHOT Scalable GW App 5 org.onosproject.distributedprimitives 1.9.0.SNAPSHOT Distributed Prim= itives Test App 6 org.onosproject.patchpanel 1.9.0.SNAPSHOT Patch Panel 7 org.onosproject.netcfglinksprovider 1.9.0.SNAPSHOT Network Config Li= nk Provider 8 org.onosproject.isis 1.9.0.SNAPSHOT ISIS Provider 9 org.onosproject.cip 1.9.0.SNAPSHOT Cluster IP alias = App 10 org.onosproject.openflow-message 1.9.0.SNAPSHOT Control Message S= tats Provider 11 org.onosproject.segmentrouting 1.9.0.SNAPSHOT Segment Routing A= pp 12 org.onosproject.virtualbng 1.9.0.SNAPSHOT Virtual Broadband= Gateway App 13 org.onosproject.metrics 1.9.0.SNAPSHOT OpenStack Interfa= ce App 14 org.onosproject.ovsdb-base 1.9.0.SNAPSHOT OVSDB Provider 15 org.onosproject.drivers.ovsdb 1.9.0.SNAPSHOT OVSDB Device Driv= ers 16 org.onosproject.yms 1.9.0.SNAPSHOT YANG Management S= ystem App 17 org.onosproject.influxdbmetrics 1.9.0.SNAPSHOT InfluxDB Report a= nd Query App 18 org.onosproject.bgp 1.9.0.SNAPSHOT BGP Provider 19 org.onosproject.restsb 1.9.0.SNAPSHOT REST Provider * 20 org.onosproject.hostprovider 1.9.0.SNAPSHOT Host Location Pro= vider * 21 org.onosproject.lldpprovider 1.9.0.SNAPSHOT LLDP Link Provide= r * 22 org.onosproject.optical-model 1.9.0.SNAPSHOT Optical informati= on model * 23 org.onosproject.openflow-base 1.9.0.SNAPSHOT OpenFlow Provider * 24 org.onosproject.openflow 1.9.0.SNAPSHOT OpenFlow Meta App=
You can list applications from the GUI accessing the specific view. For = more details, please look at the ONOS We= b GUI section.
ONOS applications in form of OAR bundles can be (re)-installed and unins= talled from the ONOS GUI. To do that, go in the application view and click = on the plus button on the top-right corner of the page, choose your OAR fil= e from your local storage and click ok. From the same view, an application = can be selected and uninstalled (removed) using the bin icon.
Soon, an onos-app CLI utility (included for now only in the ONOS develop= ment repository) will also be added to the ONOS package to facilitate the C= LI application management.
Once installed, applications can be activated and deactivated through th= e ONOS CLI, GUI and REST APIs.
To activate/deactivate an application from the ONOS CLI use the app comm= and:
onos>= ; app (de)activate org.onosproject.$YOUR_APP_NAME
From the ONOS GUI, access the application view, select the application y= ou like to (de)activate, and click either the start or stop icons in the to= p-right corner of the screen.