Bugzilla will be upgraded to version 5.0. The upgrade date is tentatively scheduled for 2 December 2018, pending final testing and feedback.
Bug 1483414 - [RFE] [ODL] [sosreport] sosreport should have the option to include OpenDaylight
[RFE] [ODL] [sosreport] sosreport should have the option to include OpenDaylight
Status: CLOSED ERRATA
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: sos (Show other bugs)
7.5
Unspecified Unspecified
high Severity high
: pre-dev-freeze
: ---
Assigned To: Pavel Moravec
Itzik Brown
: FutureFeature, OtherQA, Triaged
Depends On:
Blocks: 1569858
  Show dependency treegraph
 
Reported: 2017-08-21 01:15 EDT by Itzik Brown
Modified: 2018-04-20 03:06 EDT (History)
18 users (show)

See Also:
Fixed In Version: sos-3.5-5.el7
Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed: 2018-04-10 14:04:13 EDT
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)


External Trackers
Tracker ID Priority Status Summary Last Updated
Github sosreport/sos/pull/1143 None None None 2017-11-09 07:14 EST
Github sosreport/sos/pull/1171 None None None 2017-12-20 06:17 EST
Github sosreport/sos/pull/1207 None None None 2018-02-06 06:17 EST
Red Hat Product Errata RHEA-2018:0963 None None None 2018-04-10 14:05 EDT

  None (edit)
Description Itzik Brown 2017-08-21 01:15:54 EDT
Description of problem:
OpenDaylight configuration and log files are missing in SOS report.
There should be an option to include these files in the SOS report.

Currently the log path is /opt/opendaylight/data/log/karaf.log
The configuration files are at /opt/opendaylight/etc/

Version-Release number of selected component (if applicable):
sos-3.4-6.el7.noarch

How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:
Comment 2 Pavel Moravec 2017-08-21 03:04:46 EDT
Sosreport collects various stuff via plug-ins, where each plug-in:

1) is enabled by presence of some package / some of packages.

2) can collect files (config, logs,..)

3) can collect output of commands

4) can scrub confidential info (passwords in configs, or so)


OpenDaylight, a new plug-in should be written, that (please clarify on below details):

1) will be enabled (just) by presence of opendaylight package

2) will collect /opt/opendaylight/data/log/karaf.log file and content of /opt/opendaylight/etc/ directory

3) some cmd output to gather?

4) some password / private key / any other confidential info in collected data we shall obfuscate?
Comment 4 Tim Rozet 2017-08-22 15:56:08 EDT
(In reply to Pavel Moravec from comment #2)
> Sosreport collects various stuff via plug-ins, where each plug-in:
> 
> 1) is enabled by presence of some package / some of packages.
> 
> 2) can collect files (config, logs,..)
> 
> 3) can collect output of commands
> 
> 4) can scrub confidential info (passwords in configs, or so)
> 
> 
> OpenDaylight, a new plug-in should be written, that (please clarify on below
> details):
> 
> 1) will be enabled (just) by presence of opendaylight package
> 
> 2) will collect /opt/opendaylight/data/log/karaf.log file and content of
> /opt/opendaylight/etc/ directory
> 
> 3) some cmd output to gather?
> 
> 4) some password / private key / any other confidential info in collected
> data we shall obfuscate?


1) I don't think inspecting if the package is installed is enough to tell if it is enabled.  Better to check systemd to see if 'opendaylight' is running, but then I guess that assumes it didn't crash either ;)  Could also check hieradata to see if the service (OpenDaylightApi) was enabled in deployment.

2) Please collect all logs from /opt/opendaylight/data/log/, and everything in /opt/opendaylight/etc/

3) We need outputs from every node related to openvswitch.  You could check if this hieradata OOO service was enabled on the node (OpenDaylightOvs).  These include:
- ovs-ofctl -O OpenFlow13 show br-int
- ovs-ofctl -O OpenFlow13 dump-flows br-int
- ovs-ofctl -O OpenFlow13 dump-groups br-int
- ovs-ofctl -O OpenFlow13 dump-group-stats br-int
- ovs-vsctl list Open_vSwitch
- ovs-vsctl show

4) I dont think there are any passwords or keys present in the logs or config directory.  The user passwords are stored in a db. Sam can you confirm?
Comment 6 Sam Hague 2017-08-22 17:07:23 EDT
(In reply to Tim Rozet from comment #4)
> (In reply to Pavel Moravec from comment #2)
> > Sosreport collects various stuff via plug-ins, where each plug-in:
> > 
> > 1) is enabled by presence of some package / some of packages.
> > 
> > 2) can collect files (config, logs,..)
> > 
> > 3) can collect output of commands
> > 
> > 4) can scrub confidential info (passwords in configs, or so)
> > 
> > 
> > OpenDaylight, a new plug-in should be written, that (please clarify on below
> > details):
> > 
> > 1) will be enabled (just) by presence of opendaylight package
> > 
> > 2) will collect /opt/opendaylight/data/log/karaf.log file and content of
> > /opt/opendaylight/etc/ directory
> > 
> > 3) some cmd output to gather?
> > 
> > 4) some password / private key / any other confidential info in collected
> > data we shall obfuscate?
> 
> 
> 1) I don't think inspecting if the package is installed is enough to tell if
> it is enabled.  Better to check systemd to see if 'opendaylight' is running,
> but then I guess that assumes it didn't crash either ;)  Could also check
> hieradata to see if the service (OpenDaylightApi) was enabled in deployment.
> 
> 2) Please collect all logs from /opt/opendaylight/data/log/, and everything
> in /opt/opendaylight/etc/
> 
> 3) We need outputs from every node related to openvswitch.  You could check
> if this hieradata OOO service was enabled on the node (OpenDaylightOvs). 
> These include:
> - ovs-ofctl -O OpenFlow13 show br-int
> - ovs-ofctl -O OpenFlow13 dump-flows br-int
> - ovs-ofctl -O OpenFlow13 dump-groups br-int
> - ovs-ofctl -O OpenFlow13 dump-group-stats br-int
> - ovs-vsctl list Open_vSwitch
> - ovs-vsctl show
> 
> 4) I dont think there are any passwords or keys present in the logs or
> config directory.  The user passwords are stored in a db. Sam can you
> confirm?

The credentials shouldn't be in any of the files. I am also double checking upstream.
Comment 7 Bryn M. Reeves 2017-08-23 05:35:59 EDT
> ODL RPM installs to /opt/opendaylight.

The /opt subtree is supposed to be for add-on components that are not part of the operating system (inherited in the FHS from SysV). There are various restrictions on the paths we can use there and parts of the tree are reserved for local administrator use (with a requirement that applications not rely on those parts of the tree to function correctly).

In particular, for sos, this means that we do not search any binary paths under /opt.

I hadn't noticed any other OpenStack components using this installation path so it seems to be a break with our own conventions.
Comment 8 Bryn M. Reeves 2017-08-23 05:45:21 EDT
> 3) We need outputs from every node related to openvswitch.  You could check if > this hieradata OOO service was enabled on the node (OpenDaylightOvs).  These include:
> - ovs-ofctl -O OpenFlow13 show br-int
> - ovs-ofctl -O OpenFlow13 dump-flows br-int
> - ovs-ofctl -O OpenFlow13 dump-groups br-int
> - ovs-ofctl -O OpenFlow13 dump-group-stats br-int
> - ovs-vsctl list Open_vSwitch
> - ovs-vsctl show

These are all collected by the existing openvswitch plugin; I'm assuming that ovs-vsctl (via the opwnvswitch package) must be installed to use OpenDaylight so there should be no action needed here. If not then we just need to add a new trigger to that plugin.

> 1) I don't think inspecting if the package is installed is enough to tell if it 
> is enabled.

Doesn't matter; sos does not care if something is enabled, or even configured, just that it is present. Data collection is opportunistic, so if something is not there, it is not an error.

We provide package triggers, path triggers, and (in the 3.5 release due in a month or so), executable command triggers based on search of the distribution's standard PATH.

One of these should be adequate for this use.
Comment 9 Sam Hague 2017-08-23 11:51:05 EDT
> > 4) I dont think there are any passwords or keys present in the logs or
> > config directory.  The user passwords are stored in a db. Sam can you
> > confirm?
> 
> The credentials shouldn't be in any of the files. I am also double checking
> upstream.

Upstream confirms that credentials are stored in idmlight.db.mv.db with an encrypted hash. We should be OK that they are not in the logs or config directory.
Comment 10 Tim Rozet 2017-08-23 12:04:34 EDT
(In reply to Bryn M. Reeves from comment #7)
> > ODL RPM installs to /opt/opendaylight.
> 
> The /opt subtree is supposed to be for add-on components that are not part
> of the operating system (inherited in the FHS from SysV). There are various
> restrictions on the paths we can use there and parts of the tree are
> reserved for local administrator use (with a requirement that applications
> not rely on those parts of the tree to function correctly).
> 
> In particular, for sos, this means that we do not search any binary paths
> under /opt.
> 
> I hadn't noticed any other OpenStack components using this installation path
> so it seems to be a break with our own conventions.

I'm not an expert on this stuff so you may want to raise a separate BZ against ODL packaging if you feel /opt is the wrong place to put ODL.  From googling it looks like it is ok for binary to be under /opt:

http://www.pathname.com/fhs/pub/fhs-2.3.html#OPTADDONAPPLICATIONSOFTWAREPACKAGES

"Programs to be invoked by users must be located in the directory /opt/<package>/bin"

and it looks like /usr/local is admin only, and /opt is different:
https://unix.stackexchange.com/questions/11544/what-is-the-difference-between-opt-and-usr-local

Also take into consideration that ODL is not part of openstack, it is simply used with openstack for certain deployments.  It is java based, and does not install into python path like openstack packages do.
Comment 11 Bryn M. Reeves 2017-08-23 13:32:30 EDT
> From googling it looks like it is ok for binary to be under /opt:

That's not the issue (the whole point of /opt is to put _extra software_ that's not part of the distribution).

It's the fact that this is not in keeping with Red Hat's packaging for RHEL or with prior OSP experience - before we can make a change like this upstream we need to understand if it is the location it is conventionally installed to, or whether this is a quirk of Red Hat packaging that we need to work around some how (it's less problematic since the current request does not include executable commands to be run from the plugin but we still prefer to establish these things before we start making changes).

If this is entirely specific to our packaging then we may prefer to address this via a downstream patch until we have a better picture of how it may be packaged in future Red Hat releases and elsewhere.
Comment 12 Bryn M. Reeves 2017-08-23 13:38:35 EDT
> and it looks like /usr/local is admin only, and /opt is different:
> https://unix.stackexchange.com/questions/11544/what-is-the-difference-between-
> opt-and-usr-local

The _whole_ of /usr/local is reserved for the administrator's use. Packaged software must never place files there.

As I said: _parts_ of /opt are reserved - and this places restrictions on the applications that use it - the actual paths ODL is using aren't really a concern, but sos does not include any location in /opt in PATH which is a problem if there is ever a need to run any command from here.

These restrictions are discussed in the fist link you gave, under "Requirements" - the reason that we do not include '/opt/bin' in PATH is the requirement that no packaged software rely on the presence of these paths (since nothing can rely on being able to install files to that location we can't assume anything about its content).
Comment 13 Janki 2017-09-11 10:46:04 EDT
HI Bryn

Would /usr/share be optimal location to install ODL? We can then put logs into /var/log/opendaylight and config files into /etc/opendaylight.
Comment 16 Pavel Moravec 2017-09-12 03:28:33 EDT
Some questions to decide be reporter:

1) ODL data collection shall be triggered by presence of opendaylight package? Could this package be installed standalone or just together with openvswitch package? (i.e. shall we have separate independent plug-in (my preferred option) or extend the openvswitch plug-in (worth doing only if there is some strong dependency/relationship among openvswitch and ODL))?

1.1) Just presence of the package will trigger the plugin / data collection - it as explained above by Bryn.

2) We shall collect /opt/opendaylight/data/log/karaf.log file and content of /opt/opendaylight/etc/ directory (or rather their equivalents after the movement from /opt)

2.1) optionally, sos shall (also? instead of logfile?) collect systemd service logs of opendaylight unit ("journalctl --no-pager --unit opendaylight" command output)?

3) ovs-* commands are collected by openvswitch plugin, enabled by presence of openvswitch package (that installs the ovs-* commands) - so no need to collect anything, sos_commands/openvswitch directory in sosreport shall contain that data already.


I suggest to wait for decision where the binaries/configs/logs will be placed to per packaging guidelines first, and then add the sos plugin. ODL on OSP 12 (deployed under /opt) wont be captured, ODSL since OSP 13 will be captured.

(alternativelly, we can collect both new locations and also the current under /opt, and drop support of /opt later on, but the 1st option is imho cleaner)


Let me know if I skip something wrt. technical requirements what to collect.
Comment 17 Mike Kolesnik 2017-09-25 05:10:03 EDT
Some answers..

(In reply to Pavel Moravec from comment #16)
> Some questions to decide be reporter:
> 
> 1) ODL data collection shall be triggered by presence of opendaylight
> package? Could this package be installed standalone or just together with
> openvswitch package? (i.e. shall we have separate independent plug-in (my
> preferred option) or extend the openvswitch plug-in (worth doing only if
> there is some strong dependency/relationship among openvswitch and ODL))?

I think it's reasonable to collect based on the presence of the 'opendaylight' package.
It's not necessarily installed alongside openvswitch, so wrt your other questions it makes sense to have it's own SOS plugin.

> 
> 1.1) Just presence of the package will trigger the plugin / data collection
> - it as explained above by Bryn.
> 
> 2) We shall collect /opt/opendaylight/data/log/karaf.log file and content of
> /opt/opendaylight/etc/ directory (or rather their equivalents after the
> movement from /opt)

Sounds right.

> 
> 2.1) optionally, sos shall (also? instead of logfile?) collect systemd
> service logs of opendaylight unit ("journalctl --no-pager --unit
> opendaylight" command output)?

We have a plan to move to journal logging, but for the OSP 12 release it isn't going to happen. For now just the log file mentioned previously is used, and in the future a bug for SOS to collect from the journal should be opened once the logging is moved to the journal.

> 
> 3) ovs-* commands are collected by openvswitch plugin, enabled by presence
> of openvswitch package (that installs the ovs-* commands) - so no need to
> collect anything, sos_commands/openvswitch directory in sosreport shall
> contain that data already.
> 
> 
> I suggest to wait for decision where the binaries/configs/logs will be
> placed to per packaging guidelines first, and then add the sos plugin. ODL
> on OSP 12 (deployed under /opt) wont be captured, ODSL since OSP 13 will be
> captured.
> 
> (alternativelly, we can collect both new locations and also the current
> under /opt, and drop support of /opt later on, but the 1st option is imho
> cleaner)
> 

Is this request going to make it in time for OSP 12 at all?
If so then we need to collect the existing paths, and adjust them once they're changed.

> 
> Let me know if I skip something wrt. technical requirements what to collect.
Comment 18 Janki 2017-09-25 05:12:19 EDT
Hi Pavel,

Will this plugin also add ODL in sosreport when run with TripleO?
Comment 24 Itzik Brown 2017-11-09 03:59:55 EST
There is also a need to gather information about SNAT (routers to NAPT switches).
What do you think?
Comment 25 Janki 2017-11-09 04:21:00 EST
Hi Pavel

We are in discussion to decide on moving ODL installation out of /opt. Meanwhile, lets implement this with following in mind:

1. Installation path - /opt/opendaylight/
2. Log files - /opt/opendaylight/data/log/
3. Config data - /opt/opendaylight/etc/
4. Presence of ODL package should suffice to trigger data collection
5. ovs related info from ovs commands
- ovs-ofctl -O OpenFlow13 show br-int
- ovs-ofctl -O OpenFlow13 dump-flows br-int
- ovs-ofctl -O OpenFlow13 dump-groups br-int
- ovs-ofctl -O OpenFlow13 dump-group-stats br-int
- ovs-vsctl list Open_vSwitch
- ovs-vsctl show

Let me know if you need more data.
Comment 26 Pavel Moravec 2017-11-09 04:50:41 EST
(In reply to Janki from comment #25)
> Hi Pavel
> 
> We are in discussion to decide on moving ODL installation out of /opt.
> Meanwhile, lets implement this with following in mind:
> 

Thanks for clear specification.

> 1. Installation path - /opt/opendaylight/
> 2. Log files - /opt/opendaylight/data/log/

Will add (with default limit of 10MB of newest files and option to increase the limit).

> 3. Config data - /opt/opendaylight/etc/

Will add.

> 4. Presence of ODL package should suffice to trigger data collection

Great.

> 5. ovs related info from ovs commands
> - ovs-ofctl -O OpenFlow13 show br-int
> - ovs-ofctl -O OpenFlow13 dump-flows br-int
> - ovs-ofctl -O OpenFlow13 dump-groups br-int
> - ovs-ofctl -O OpenFlow13 dump-group-stats br-int
> - ovs-vsctl list Open_vSwitch
> - ovs-vsctl show

This shall be collected by openvswitch plug-in. These cmds are already collected - am I right?

ovs-ofctl -O OpenFlow13 dump-flows br-int
ovs-vsctl -t 5 show

(please run "sosreport -o openvswitch --batch --build", go to the directory specified in output, and search for files under sos_commands/openvswitch/ subdirectory; the above 2 shall be included already)
Comment 27 Janki 2017-11-09 04:56:30 EST
(In reply to Pavel Moravec from comment #26)
> (In reply to Janki from comment #25)
> > Hi Pavel
> > 
> > We are in discussion to decide on moving ODL installation out of /opt.
> > Meanwhile, lets implement this with following in mind:
> > 
> 
> Thanks for clear specification.
> 
> > 1. Installation path - /opt/opendaylight/
> > 2. Log files - /opt/opendaylight/data/log/
> 
> Will add (with default limit of 10MB of newest files and option to increase
> the limit).

ODL creates 2 log files with 10GB size each when used with TripleO. Will these default limit config be needed then?
> 
> > 3. Config data - /opt/opendaylight/etc/
> 
> Will add.
> 
> > 4. Presence of ODL package should suffice to trigger data collection
> 
> Great.
> 
> > 5. ovs related info from ovs commands
> > - ovs-ofctl -O OpenFlow13 show br-int
> > - ovs-ofctl -O OpenFlow13 dump-flows br-int
> > - ovs-ofctl -O OpenFlow13 dump-groups br-int
> > - ovs-ofctl -O OpenFlow13 dump-group-stats br-int
> > - ovs-vsctl list Open_vSwitch
> > - ovs-vsctl show
> 
> This shall be collected by openvswitch plug-in. These cmds are already
> collected - am I right?
> 
> ovs-ofctl -O OpenFlow13 dump-flows br-int
> ovs-vsctl -t 5 show
> 
> (please run "sosreport -o openvswitch --batch --build", go to the directory
> specified in output, and search for files under sos_commands/openvswitch/
> subdirectory; the above 2 shall be included already)
Comment 28 Janki 2017-11-09 05:21:40 EST
(In reply to Pavel Moravec from comment #26)
> (In reply to Janki from comment #25)
> > Hi Pavel
> > 
> > We are in discussion to decide on moving ODL installation out of /opt.
> > Meanwhile, lets implement this with following in mind:
> > 
> 
> Thanks for clear specification.
> 
> > 1. Installation path - /opt/opendaylight/
> > 2. Log files - /opt/opendaylight/data/log/
> 
> Will add (with default limit of 10MB of newest files and option to increase
> the limit).
> 
> > 3. Config data - /opt/opendaylight/etc/
> 
> Will add.
> 
> > 4. Presence of ODL package should suffice to trigger data collection
> 
> Great.
> 
> > 5. ovs related info from ovs commands
> > - ovs-ofctl -O OpenFlow13 show br-int
> > - ovs-ofctl -O OpenFlow13 dump-flows br-int
> > - ovs-ofctl -O OpenFlow13 dump-groups br-int
> > - ovs-ofctl -O OpenFlow13 dump-group-stats br-int
> > - ovs-vsctl list Open_vSwitch
> > - ovs-vsctl show
> 
> This shall be collected by openvswitch plug-in. These cmds are already
> collected - am I right?
> 
> ovs-ofctl -O OpenFlow13 dump-flows br-int
> ovs-vsctl -t 5 show
> 
> (please run "sosreport -o openvswitch --batch --build", go to the directory
> specified in output, and search for files under sos_commands/openvswitch/
> subdirectory; the above 2 shall be included already)

@Itzik, can you please verify above 2 commands.
@Pavel, these 2 commands are listed in plugin, so they should be good but still verifying with the steps you mentioned.
Comment 30 Janki 2017-11-09 06:12:08 EST
> > 
> > This shall be collected by openvswitch plug-in. These cmds are already
> > collected - am I right?
> > 
> > ovs-ofctl -O OpenFlow13 dump-flows br-int
> > ovs-vsctl -t 5 show
> > 
> > (please run "sosreport -o openvswitch --batch --build", go to the directory
> > specified in output, and search for files under sos_commands/openvswitch/
> > subdirectory; the above 2 shall be included already)
> 
> @Itzik, can you please verify above 2 commands.
> @Pavel, these 2 commands are listed in plugin, so they should be good but
> still verifying with the steps you mentioned.

These has been verified by Itzik. The ovs plugin needs to be updated to run these commands with -O OpenFlow13 flag.
Comment 31 Pavel Moravec 2017-11-09 07:14:38 EST
All required work shall be captured in https://github.com/sosreport/sos/pull/1143
Comment 42 Janki 2017-12-12 04:35:04 EST
Hi

@Itzik, Run this on machine.

@Pavel, We need to include few containarised deployment related settings too like:

1. collect logs from /var/log/containers/opendaylight/*.log like [1]
2. collect config files from /var/lib/config-data/puppet-generated/opendaylight/opt/opendaylight/etc like [2].

[1]. https://github.com/stuggi/sos/blob/master/sos/plugins/openstack_ceilometer.py#L38
[2]. https://github.com/stuggi/sos/blob/master/sos/plugins/openstack_ceilometer.py#L47
Comment 43 Pavel Moravec 2017-12-12 14:29:14 EST
(In reply to Janki from comment #42)
> Hi
> 
> @Itzik, Run this on machine.
> 
> @Pavel, We need to include few containarised deployment related settings too
> like:
> 
> 1. collect logs from /var/log/containers/opendaylight/*.log like [1]
> 2. collect config files from
> /var/lib/config-data/puppet-generated/opendaylight/opt/opendaylight/etc like
> [2].
> 
> [1].
> https://github.com/stuggi/sos/blob/master/sos/plugins/openstack_ceilometer.
> py#L38
> [2].
> https://github.com/stuggi/sos/blob/master/sos/plugins/openstack_ceilometer.
> py#L47

Why you come up with a requirement in the middle of QE phase? :(

I guess both 1 and 2 needs to be collected if and only if opendaylight package is present / within odl sosreport plug-in, am I right?

And you need to collect exactly these two patterns:

/var/log/containers/opendaylight/*.log (files)
/var/lib/config-data/puppet-generated/opendaylight/opt/opendaylight/etc (directory)

Can you pls. confirm?


(If there would be some other requirement to re-spin sos in 7.5, I can add it there, otherwise I dont plan so)
Comment 44 Janki 2017-12-13 02:43:45 EST
Hi Pavel

So sorry for these late requirements. We are in process of evolving ODL Log mechanism. These can change further in coming few days if/when ODL log mechanism changes.

Would you like these new requirements to be as a separate BZ? Is sos in freeze state for 7.5? If not, what's the deadline for new changes to go in? Can we backport it from "master" to "7.5"?
Comment 46 Pavel Moravec 2017-12-13 03:18:59 EST
(In reply to Janki from comment #44)
> Hi Pavel
> 
> So sorry for these late requirements. We are in process of evolving ODL Log
> mechanism. These can change further in coming few days if/when ODL log
> mechanism changes.
> 
> Would you like these new requirements to be as a separate BZ? Is sos in
> freeze state for 7.5? If not, what's the deadline for new changes to go in?
> Can we backport it from "master" to "7.5"?

Pls. come with the requirements within few days so I can re-spin the package before Christmas. Then it should be no problem to add it to 7.5.
Comment 50 Janki 2017-12-19 09:37:54 EST
Hi Pavel

Please add below functionality to existing ODL Plugin

1. Collect logs from /var/log/containers/opendaylight/*.log (files) and ignore error if the files are not present.
2. Collect config info from /var/lib/config-data/puppet-generated/opendaylight/opt/opendaylight/etc (directory)
3. Collect output of "docker logs opendaylight_api"

Again apologies for last minute editions and thanks for accommodating them.

P.S. I am adding needinfo for you Pavel just so that you get notified so this comment.
Comment 51 Pavel Moravec 2017-12-20 06:17:12 EST
(to be) added as PR https://github.com/sosreport/sos/pull/1171 .
Comment 53 Janki 2018-01-17 03:34:46 EST
Pavel, you also need to backport the last PR to rhel-7.4.z right?
Comment 54 Pavel Moravec 2018-01-17 13:52:51 EST
(In reply to Janki from comment #53)
> Pavel, you also need to backport the last PR to rhel-7.4.z right?

I don't plan to backport either of this to RHEL 7.4, due to few reasons:

1) Please use proper flags next time, here "rhel-7.4.z?". Original request "can this be added to 7.4.z?" was responded by mine "first requirements, then implementation, then ACK to 7.5, then .." and since that time one forgets there is such a request..

2) RHEL 7.5 will be released relatively soon, esp. compared to next possible z-stream in 7.4. Is it really worth having it in 7.4 as well? Isn't 7.5 sufficient?

3) this is RFE and RFEs dont get into z-stream. Well, sosreport might be seen as an exception even in RHEL, esp. when just adding a new isolated plug-in. But still these requests are quite exceptionally accepted.

4) Continuation of previous point: currently there is no other z-stream request for sos. I dont think it is worth offering update of a RHEL package in such late z-stream update to _all_ RHEL7.4 customers just due to a new feature that will be utilized by a fraction of them. If there would be e.g. some another important bug to be fixed, _that_ would justify new errata that would be created. But an extra errata just due to a new feature in a late z-stream close to y-stream release?
Comment 55 Janki 2018-01-18 05:16:30 EST
Sorry, my bad. We need this for RHOSP13 which seems to be based on RHEL7.5. So we are good here.
Comment 64 Pavel Moravec 2018-02-06 06:17:02 EST
It was discovered that ODL plugin must be automatically enabled also by puppet-opendaylight package. Thus trivial but critical change pending:

/usr/lib/python2.7/site-packages/sos/plugins/opendaylight.py 

     packages = ('opendaylight',)

change to:

     packages = ('opendaylight', 'puppet-opendaylight')

will fix it.
Comment 65 Pavel Moravec 2018-02-13 09:21:19 EST
Janki,
could you please verify the BZ against sos-3.5-5 ?


A yum repository for the build of sos-3.5-5.el7 (task 15272478) is available at:

http://brew-task-repos.usersys.redhat.com/repos/official/sos/3.5/5.el7/

You can install the rpms locally by putting this .repo file in your /etc/yum.repos.d/ directory:

http://brew-task-repos.usersys.redhat.com/repos/official/sos/3.5/5.el7/sos-3.5-5.el7.repo

RPMs and build logs can be found in the following locations:
http://brew-task-repos.usersys.redhat.com/repos/official/sos/3.5/5.el7/noarch/
Comment 67 Itzik Brown 2018-02-18 03:38:02 EST
Ran the following command:
sosreport -o openvswitch -o opendaylight --batch --build --all-logs

Version:
sos-3.5-5.el7.noarch
RHEL OSP12
RHEL7.4

Karaf log is present at:
/var/log/containers/opendaylight/karaf.log.1

ofctl outputs:
# ls -1  sos_commands/openvswitch/ovs-ofctl_-O_OpenFlow13*
sos_commands/openvswitch/ovs-ofctl_-O_OpenFlow13_dump-flows_br-int
sos_commands/openvswitch/ovs-ofctl_-O_OpenFlow13_dump-groups_br-int
sos_commands/openvswitch/ovs-ofctl_-O_OpenFlow13_dump-group-stats_br-int
sos_commands/openvswitch/ovs-ofctl_-O_OpenFlow13_dump-ports-desc_br-int
sos_commands/openvswitch/ovs-ofctl_-O_OpenFlow13_show_br-int

ovs-vsctl outputs:
# ls -1 sos_commands/openvswitch/ovs-vsctl_*
sos_commands/openvswitch/ovs-vsctl_list_bridge_br-ex
sos_commands/openvswitch/ovs-vsctl_list_bridge_br-int
sos_commands/openvswitch/ovs-vsctl_list_bridge_br-isolated
sos_commands/openvswitch/ovs-vsctl_list_Open_vSwitch
sos_commands/openvswitch/ovs-vsctl_-t_5_get_Open_vSwitch_._other_config
sos_commands/openvswitch/ovs-vsctl_-t_5_show

Configuration files:
# tree var/lib/config-data/puppet-generated/opendaylight/opt/opendaylight/etc/
var/lib/config-data/puppet-generated/opendaylight/opt/opendaylight/etc/
├── jetty.xml
├── opendaylight
│   └── datastore
│       └── initial
│           └── config
│               └── netvirt-natservice-config.xml
├── org.apache.karaf.features.cfg
└── org.ops4j.pax.logging.cfg

docker logs opendaylight_api output:
sos_commands/opendaylight/docker_logs_opendaylight_api exists and empty (It's the same output as docker logs opendaylight_api)

Janki,
Can you please verify the above outputs are what is needed?
Comment 68 Janki 2018-02-19 00:46:18 EST
@Itzik, if these files are inside sosreport folder, then yes this is expected output.
Comment 69 Janki 2018-02-19 00:58:27 EST
Also check if all karaf log files are created. karaf.log.1 and karaf.log
Comment 70 Itzik Brown 2018-02-19 01:08:31 EST
There was only karaf.log.1 om the Hypervisor and in the sos folder.
It's seems OK from my side.
But I can't mark it as verified until it's in d/s repo.
Comment 75 errata-xmlrpc 2018-04-10 14:04:13 EDT
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2018:0963

Note You need to log in before you can comment on or make changes to this bug.