[Starlingx-discuss] [docs] Setting up the docs.starlingx.io website

[Ildiko Vancsa]

Hi,

For third-party CI systems that run on premise we don’t provide a log server but recommend to have a machine to which your job runner can push logs onto (via scp or ftp or rsync or...) with apache with autoindexing turned on to make the log files available.

We have a puppet module a lot of third-party CI deployments use which incorporates a log publishing website: https://git.openstack.org/cgit/openstack-infra/puppet-openstackci/tree/manifests/logserver.pp

It might be a bit more than what you would want as a first run as it does colorization and interactive filtering of common log formats via a WSGI backend, it depends on your preference which route you go down on.

In either case you probably also want to have some means of purging logs after they reach a certain age so it doesn't grow out of control (that puppet module I linked above includes a cron-driven script to do that too).

Please let me know if you have any questions.

Thanks and Best Regards,
Ildikó


> On 2018. Sep 3., at 15:07, Arce Moreno, Abraham <abraham.arce.moreno at intel.com> wrote:
> 
>>> Are we considering to include some path in the site in order to upload
>> reports?, should we open a thread for this as well?
>> 
>> This is a static site built from Sphinx docs.  What sort of report are you
>> thinking about?
> 
> Reports containing results coming from our regular functional tests,
> an example of the output in xml:
> 
> -<robot generator="Robot 3.0.4 (Python 2.7.12 on linux2)" generated="20180829 05:18:39.626">
>    -<suite name="Setup" id="s1" source="/home/elio/secondgerrit/clean/stx-test-suite/Tests/Setup.robot">
>        +<test name="Test Qemu Libvirt VMs Setup" id="s1-t1">
>        +<test name="Test Install ISO" id="s1-t2">
>        +<test name="Test Config Controller" id="s1-t3">
>          <doc>Tests for Install and Configuration of a controller node. Author(s): - Jose Perez...
>          <status starttime="20180829 05:18:39.627" endtime="20180829 05:57:07.073" status="FAIL"/>
>      </suite>
>    +<statistics>
>      <errors> </errors>
> </robot>
> 
> We were thinking where it could make sense to upload / post those results:
> - Wiki
> - Launchpad
> - Repository
> 
> We also looked at how OpenStack reports results:
> - For every repo, under Gerrit giving a Pass / Fail
> - For RefStack, under their homepage page "community results" [0]
> - Any other that could fit our needs?
> 
> Some ideas how to share StarlingX test reports:
> 
> - Test wiki page to show executive summary results parsed from the given xml:
>   - Today this is how we report under our Test wiki page [1]
>   - Partially automated
> - stx-docs hosting those results parsed from the given xml to rst format:
>   - Fully automated taking advantage of tox infrastructure, how about using "tox -e results"?
>   - Results uploaded to doc.starlingx.io/results?
> 
> [0] https://refstack.openstack.org/#/community_results
> [1] https://wiki.openstack.org/wiki/StarlingX/Test#Latest_ISO_image_Sanity_Summary
> 
> _______________________________________________
> Starlingx-discuss mailing list
> Starlingx-discuss at lists.starlingx.io
> http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss