[Openstack-docs] How to openstack-doc-tools in gate jobs for openstack-manuals etc

Andreas Jaeger aj at suse.com
Sat Dec 14 21:59:36 UTC 2013


On 12/10/2013 09:01 PM, Andreas Jaeger wrote:
> On 12/09/2013 08:51 PM, Andreas Jaeger wrote:
>> The OpenStack docu team now has a repository called
>> openstack-doc-tools for their automation tools and gate tests.
>>
>> I'd like to get some advise on how to use the tool for working with
>> the various repositories we have.
>>
>> Does the infra team has any recommendation on how to move forward?
>>
>> For building documentation with Jenkins, I see two options:
>>
>> Option 1: Have Jenkins checkout the openstack-doc-tools repository
>> 	  every time and use that for building - similar to the
>> 	  "devstack-checkout" job.
>>
>> 	  This would mean that directly after every change done in
>> 	  openstack-doc-tools, the tools are used for checking of all
>> 	  gated repositories.
> 
> Anne suggested on IRC to use option 1 - unless we hit some major roadblocks.
> 
>> Option 2: Copy the tools and all support files to each and every
>>           repository. We could automate that.
>>
>> Moving forward, I'd like to have all our repositories (api-site,
>> compute-api, identity-api, image-api, netconn-api, object-api,
>> volume-api, operations-guide, openstack-manuals) use proper gates,
>> thus extend "test.py" so that it can be used in more places. Note that
>> the $service-api repos will be moved to $project/doc/source - we then
>> should gate on those.
>>
>> Right now only operations-guide and openstack-manuals are gated - but
>> operations-guide uses an old version of the tools.
>>
>> So, I want to move forward with these steps:
>> 1) Properly setup openstack-doc-tools project, there are some open
>>    reviews that need to go in.
>> 2) Use openstack-doc-tools in openstack-manuals and operations-guide
> 
> I'm starting with the operations-guide with the assumption that a
> failure here will hit us less:
> 
> https://review.openstack.org/61204


Clark reviewed this and gave the great advice go create a python package
of the repository: "I think we should try to package the doc-tools if
possible then we can pip install them into a virtualenv, or have puppet
checkout and keep this repo up to date on our slaves. Packaging seems to
be most friendly for people wanting to run the tools at home."

I think this is a great idea and started reworking the repository so
that we can package it. My first goal is to get "test.py" running
correctly so that we can use it for gating. Review is welcome:
https://review.openstack.org/#/c/61684/

Clark, do you have any pointer on how I can do this best on the Jenkins
side? Is there an example that I can follow? Thanks for your review and
advise!

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



More information about the Openstack-docs mailing list