Bug 1479900 - apidoc for openscap results in a 404
Summary: apidoc for openscap results in a 404
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: SCAP Plugin
Version: 6.3.0
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: Unspecified
Assignee: Ondřej Pražák
QA Contact: Nikhil Kathole
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-08-09 17:17 UTC by Bryan Kearney
Modified: 2019-09-26 15:38 UTC (History)
8 users (show)

Fixed In Version: foreman_openscap 0.7.10-2
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-02-21 17:09:48 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
screenshot (164.77 KB, image/png)
2017-12-04 06:50 UTC, Nikhil Kathole
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Foreman Issue Tracker 21377 0 Normal Closed foreman_openscap needs to precompile apidoc 2020-10-05 11:02:02 UTC
Red Hat Bugzilla 1480563 0 unspecified CLOSED API doc for virt-who config results not found 2021-02-22 00:41:40 UTC

Internal Links: 1480563

Description Bryan Kearney 2017-08-09 17:17:25 UTC
While testing 6.3, Snap 10:

1) Navigate to https://$HOST/apidoc/v2
2) Search on any of Policies, Arf reports, Scap Content, Tailoring Files
3) For each main section, or sub command, click on any link. Each ends in a 404.

Relevant Versions
satellite-cli-6.3.0-16.0.beta.el7sat.noarch
satellite-installer-6.3.0.3-1.beta.el7sat.noarch
satellite-6.3.0-16.0.beta.el7sat.noarch
tfm-rubygem-foreman_theme_satellite-1.0.4-1.el7sat.noarch
tfm-rubygem-foreman_openscap-0.7.4-1.fm1_15.el7sat.noarch
tfm-rubygem-apipie-rails-0.4.0-2.el7sat.noarch
tfm-rubygem-apipie-bindings-0.2.0-1.el7sat.noarch
tfm-rubygem-apipie-params-0.0.5-1.el7sat.noarch

Comment 1 Marek Hulan 2017-08-10 14:28:37 UTC
as a workaround, generate the cache by running

> foreman-rake apipie:cache

after it finishes, pages are there.

I suppose this might be similar for other plugins and might not be trivial to be fixed. The task is run in installer after the db is seeded, but we run only rake apipie:cache:index, I'm not sure whether it's the cause. Tomas do you happen to know? I suppose apipie:cache:index is used to make the installer run faster.

Comment 2 Tomas Strachota 2017-08-11 06:44:55 UTC
If I recall it correctly plugins are supposed to provide their own part of the cache and apipie:cache:index glues the information together:
https://github.com/theforeman/foreman/blob/develop/lib/tasks/apipie.rake#L12-L16

I'm not sure where the plugin cache is generated. I guess that Martin will know.

Comment 3 Marek Hulan 2017-09-25 12:06:55 UTC

*** This bug has been marked as a duplicate of bug 1490070 ***

Comment 4 Marek Hulan 2017-09-25 12:09:43 UTC

*** This bug has been marked as a duplicate of bug 1480563 ***

Comment 5 Martin Bacovsky 2017-10-15 21:06:22 UTC
The scap plugin needs to prebuild the cache during a build time. This will be fixed by adding '-a' switch to the foreman_precompile_plugin macro [1].

I'm reopening the bug as though the consequences are same as in the virt-who plugin each of the plugins will require its own fix.

[1]  https://github.com/theforeman/foreman-packaging/blob/rpm/develop/rubygem-foreman_openscap/rubygem-foreman_openscap.spec#L77

Comment 6 Ondřej Pražák 2017-10-18 11:14:54 UTC
Connecting redmine issue http://projects.theforeman.org/issues/21377 from this bug

Comment 9 Nikhil Kathole 2017-12-04 06:49:55 UTC
VERIFIED

Version Tested:
Satellite-6.3 Snap 27

Found api documentation for policy, scap-content, tailoring-file and arf-report.

Comment 10 Nikhil Kathole 2017-12-04 06:50:22 UTC
Created attachment 1362533 [details]
screenshot

Comment 11 Bryan Kearney 2018-02-21 16:44:00 UTC
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/RHSA-2018:0336

Comment 12 Bryan Kearney 2018-02-21 17:09:48 UTC
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/RHSA-2018:0336


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