[DOCS-61] Misnamed features in Nitrogen documentation Created: 10/Feb/18  Updated: 07/Mar/18  Resolved: 07/Mar/18

Status: Resolved
Project: docs
Component/s: Getting Started Guide
Affects Version/s: Nitrogen
Fix Version/s: None

Type: Bug Priority: High
Reporter: Patrick Turley Assignee: Charles La Voy
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

In the Nitrogen documentation, specifically "OpenDaylight concepts and tools," I see the following:


As a short example of installing a Karaf feature, OpenDaylight offers Application Layer Traffic Optimization (ALTO). The Karaf feature to install ALTO is odl-alto-all. On the Karaf console, the command to install it is:

feature:install odl-alto-all


I have Nitrogen installed, and I can report there is no feature named odl-alto-all.


Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown OpenDaylight.

opendaylight-user@root>feature:list | grep odl-alto-all
opendaylight-user@root>


There is however, a feature named odl-alto-core.


opendaylight-user@root>feature:list | grep odl-alto-core
odl-alto-core                                    | 0.5.1            | x        | Started     | odl-alto-core                                    | OpenDaylight :: alto :: Core


I believe this is the feature the author intended.



In Running XSQL Console Commands and Queries, I see:


Installing XSQL

To run commands from the XSQL console, you must first install XSQL on your system:


  1. Navigate to the directory in which you unzipped OpenDaylight

  2. Start Karaf: 

    ./bin/karaf


  3. Install XSQL: 

    feature:install odl-mdsal-xsql


Nitrogen reports there is no feature named odl-mdsal-xsql.


opendaylight-user@root>feature:list | grep odl-mdsal-xsql
opendaylight-user@root>




 Comments   
Comment by Thanh Ha (zxiiro) [ 06/Mar/18 ]

kaigao is this something your team can look into?

Comment by Kai Gao [ 07/Mar/18 ]

Certainly. Will do immediately.

Comment by Kai Gao [ 07/Mar/18 ]

The outdated feature related to ALTO is fixed by this patch.

Comment by Thanh Ha (zxiiro) [ 07/Mar/18 ]

Merged. Thanks!

Comment by Charles La Voy [ 07/Mar/18 ]

kaigao I looking over your patch and I just wanted to make sure that all the issues flagged in DOCS-61 have been verified/fixed. In your patch, you changed `odl-alto-all` to `odl-alto-release` (reporter thought it should be changed to 'odl-alto-core`). So I just want to confirm that `odl-alto-release` applies to Nitrogen. Can you confirm?

 

The reporter also found an issue in the "Installing XSQL" section, are you able to comment on this? Or will I need to track down a different reviewer.

 

 

Comment by Charles La Voy [ 07/Mar/18 ]

zxiiro We may need to reopen this issue as Kai's patch addresses the first half of the bug. The reporter also found an issue with the "Installing XSQL" section.

Comment by Thanh Ha (zxiiro) [ 07/Mar/18 ]

Ah good point. Let's reopen it.

clavoy I believe the xsql part is mdsal so we should probably pull in an mdsal committer for that.

Comment by Charles La Voy [ 07/Mar/18 ]

zxiiro Sounds good.

Comment by Charles La Voy [ 07/Mar/18 ]

rovarga Can you or someone on the MDSAL team review the comment in the section about "Installing XSQL"? Thanks in advance.

The person who reported this provided the following comment:

 

In Running XSQL Console Commands and Queries, I see:

 

Installing XSQL

To run commands from the XSQL console, you must first install XSQL on your system:

 

  1. Navigate to the directory in which you unzipped OpenDaylight 
  1. Start Karaf: 
./bin/karaf

 

  1. Install XSQL: 
feature:install odl-mdsal-xsql

 

Nitrogen reports there is no feature named odl-mdsal-xsql.

 

opendaylight-user@root>feature:list | grep odl-mdsal-xsql
opendaylight-user@root>
Comment by Robert Varga [ 07/Mar/18 ]

xsql was removed in Nitrogen: https://opendaylight.readthedocs.io/en/stable-nitrogen/release-notes/projects/controller.html#end-of-life

I suspect the documentation bits were not removed

Comment by Robert Varga [ 07/Mar/18 ]

Oxygen patch: https://git.opendaylight.org/gerrit/69219

Nitrogen patch: https://git.opendaylight.org/gerrit/#/c/69220/

 

Comment by Robert Varga [ 07/Mar/18 ]

FTR, the component was EOL'd in Carbon: https://opendaylight.readthedocs.io/en/stable-carbon/release-notes/projects/controller.html#end-of-life

 

Comment by Charles La Voy [ 07/Mar/18 ]

Thanks rovarga. I am going to close this ticket. Note that I just created a patch which adds a note in the "Running XSQL Commands and Queries" chapter in the stable/carbon branch: https://git.opendaylight.org/gerrit/#/c/69236/

If you're okay with this update, please +1 the patch. Thank you.

Generated at Wed Feb 07 19:58:34 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.