Open Stack

I think there are two reasonable solutions to this problem and they
may end up being temporarily complementary.
1. Put the tools/scripts in
openstack-infra/config/modules/jenkins/files/slave_scripts so that the
scripts are installed on all of the Jenkins slaves and can be used by
the Jenkins jobs.
2. Break the tools out into a distinct project that can be pip installed.

Option 1 has one major flaw in that it makes it a little hard to find
and install the scripts for people not running our puppet. Not
impossible but definitely difficult. Option 1 is a quick fix, I think
we can start with option 1 to keep the ball rolling and start working
on option 2 at the same time then we can transition to option 2 when
it is ready.

Clark

On Thu, Aug 29, 2013 at 10:18 AM, Anne Gentle
<annegentle at justwriteclick.com> wrote:
> Looping in Clark Boylan from the Infrastructure team.
>
> Anne
>
>
> On Wed, Aug 28, 2013 at 2:03 AM, Ying Chun Guo <guoyingc at cn.ibm.com> wrote:
>>
>> Hi, Tom and Anne
>>
>> These scripts are similar with what nova or horizon use to generate their
>> pot files,
>> like "setup.py" in nova or "./run_tests.sh" in horizon.
>>
>> So I think there should be a "tools" folder under each documentation
>> repository.
>> The question is how can we maintain a single version but use them in
>> several different repositories.
>>
>> Do you know how openstack maintain the common folder (Oslo project)?
>> I think each openstack project copies it when checking out?
>> Or has a script to check out to a specific folder?
>>
>> Daisy
>>
>> Tom Fifield <tom at openstack.org> wrote on 2013/08/28 06:22:02:
>>
>> > Tom Fifield <tom at openstack.org>
>> > 2013/08/28 06:22
>> >
>> > To
>> >
>> > Anne Gentle <annegentle at justwriteclick.com>,
>> >
>> > cc
>> >
>> > "openstack-docs at lists.openstack.org"
>> > <openstack-docs at lists.openstack.org>
>> >
>> > Subject
>> >
>> > Re: [Openstack-docs] ops guide japanese build fails due to split
>> > repositories
>>
>> >
>> > On 28/08/13 00:35, Anne Gentle wrote:
>> > >
>> > >
>> > >
>> > > On Sat, Aug 24, 2013 at 7:59 PM, Tom Fifield <tom at openstack.org
>> > > <mailto:tom at openstack.org>> wrote:
>> > >
>> > >     Cheers for the look-in :) I agree we should be looking at the
>> > >     general case ... sorry for the short-sighted bug report!
>> > >
>> > >     Thought about the idea of putting things in openstack-infra/config
>> > >     too, but discarded it. Essentially, I think we can do this without
>> > >     putting additional review load on openstack-infra. Having a
>> > >     bare-bones configuration in openstack-infra/config that points to
>> > >     scripts in docs-controlled repositories would enable us to be much
>> > >     more responsive to updates, and means we don't need to bother
>> > > infra :)
>> > >
>> > >     The last few patches I put through to config are took 1-3 weeks to
>> > >     get through. Importantly, this is completely fine - our patches
>> > > are
>> > >     definitely low priority compared to others, and being typically
>> > > less
>> > >     skilled at the ways of jenkins-job-builder we do want the time
>> > > spent
>> > >     on thorough review from the overworked infracores.
>> > >
>> > >
>> > > I ask for eyeballs in #openstack-infra if I have a review delay. They
>> > > also have a separate Jenkins job review team so for these types of job
>> > > additions I think your experience is atypical.
>> > >
>> > > I've put this patch in: https://review.openstack.org/#/c/43734/ as a
>> > > fix. Basically the zuul layout file is running in openstack-manuals
>> > > and
>> > > should run for operations-guide. What I'm unsure of, though, is
>> > > whether
>> > > the same pom.xml is used for non-english output. David or Daisy can
>> > > you
>> > > review?
>> >
>> > mm. I hadn't realised we're already in this state:
>> >
>> > >             2) Copy the tools into the openstack-ops repo and perform
>> > >             the painful
>> > >             ongoing task of keep them synchronised
>> >
>> > If that's the decision, then it's an easy-to-fix patch in config.
>> > However, I think this state is sub-optimal. I note that the tools
>> > directory in operations-guide is already way out of sync with the one in
>> > operations-manual, bolstering the claim somewhat :)
>> >
>> > I also still feel that moving tools into openstack-infra/config is not
>> > the solution - and it appears my point above has been missed ... it's
>> > not entirely about the timing! It's also about adding to the workload of
>> > a busy team, and whose 'job' it is to review what.
>> >
>> > My advice would be to take a look at what nova, neutron et al do with
>> > their 'tools' directories.
>> >
>> > Regards,
>> >
>> > Tom
>> >
>> >
>> >
>> > > Thanks,
>> > > Anne
>> > >
>> > >
>> > >     However, this doesn't seem like a tenable situation for the tools,
>> > >     given the amount of churn we're going through right now (consider
>> > > eg
>> > >     validate.py!). I think it would seriously slow things down for
>> > >     something that could potentially be done another way.
>> > >
>> > >
>> > >     Regards,
>> > >
>> > >     Tom
>> > >
>> > >
>> > >     On 25/08/13 01:17, Anne Gentle wrote:
>> > >
>> > >         Is there an option to store the tool in openstack-infra/config
>> > > and
>> > >         point it at different repos? They're already running scripts
>> > > to send
>> > >         Horizon strings to transifex. This makes me think so:
>> > >         https://review.openstack.org/#__/c/32824/3/modules/
>> >
>> > openstack___project/files/jenkins_job___builder/config/translation-__jobs.yaml
>> > >         <https://review.openstack.org/#/c/32824/3/modules/
>> >
>> > openstack_project/files/jenkins_job_builder/config/translation-jobs.yaml>
>> > >
>> > >         Plus
>> > >         https://review.openstack.org/#__/c/34700/3/modules/
>> > jenkins/__files/slave_scripts/propose___translation_update_manuals.sh
>> > >         <https://review.openstack.org/#/c/34700/3/modules/jenkins/
>> > files/slave_scripts/propose_translation_update_manuals.sh>
>> > >         points to a repo and a folder.
>> > >
>> > >         It's from one the original patches Daisy sent through to start
>> > >         translations. Clark or Jeremy, do you know if a change in the
>> > > config
>> > >         project would do what's needed -- slice docs from any repo?
>> > >
>> > >         It's important to figure out because the next priority to me
>> > >         would be
>> > >         the API quick start in the openstack/api-site repo, then the
>> > > install
>> > >         guides, so we have at least 3 repos with docs to translate. We
>> > > could
>> > >         put all the high-priority-to-translate docs in one repo but
>> > > that
>> > >         seems
>> > >         too rigid. Let's find a way.
>> > >
>> > >         Thanks,
>> > >         Anne
>> > >
>> > >
>> > >         On Aug 23, 2013, at 7:23 PM, Tom Fifield <tom at openstack.org
>> > >         <mailto:tom at openstack.org>> wrote:
>> > >
>> > >             Hi all,
>> > >
>> > >             Just throwing this bug out there for your comment to
>> > > select
>> > >             a way forward:
>> > >
>> > >
>> > > https://bugs.launchpad.net/__openstack-manuals/+bug/1216153
>> > >
>> > > <https://bugs.launchpad.net/openstack-manuals/+bug/1216153>
>> > >
>> > >
>> > >             The build job for the Japanese version of the Operations
>> > >             Guide was
>> > >             merged at: https://review.openstack.org/#__/c/39846/
>> > >             <https://review.openstack.org/#/c/39846/>
>> > >
>> > >             However, from the first run of the job (logs:
>> > >             https://jenkins01.openstack.__org/job/openstack-
>> > operations-__guide-ja/1/console
>> > >             <https://jenkins01.openstack.org/job/openstack-
>> > operations-guide-ja/1/console>)
>> > >             it becomes clear that it fails due to the split
>> > > repositories.
>> > >
>> > >             2013-08-23 23:42:49.457 | cp: cannot stat
>> > >             `./doc/src/docbkx/openstack-__ops': No such file or
>> > > directory
>> > >
>> > >             To fix this, we either need to:
>> > >
>> > >             1) Check out the openstack-ops repo into manuals for build
>> > > time
>> > >
>> > >             2) Copy the tools into the openstack-ops repo and perform
>> > >             the painful
>> > >             ongoing task of keep them synchronised
>> > >
>> > >             3) move openstack-ops back into the openstack-manuals repo
>> > >
>> > >
>> > >
>> > >             Regards,
>> > >
>> > >
>> > >             Tom
>> > >
>> > >             _________________________________________________
>> > >             Openstack-docs mailing list
>> > >             Openstack-docs at lists.__openstack.org
>> > >             <mailto:Openstack-docs at lists.openstack.org>
>> > >             http://lists.openstack.org/__cgi-bin/mailman/listinfo/
>> > __openstack-docs
>> > >             <http://lists.openstack.org/cgi-bin/mailman/listinfo/
>> > openstack-docs>
>> > >
>> > >
>> > >
>> > >
>> > >
>> > > --
>> > > Anne Gentle
>> > > annegentle at justwriteclick.com <mailto:annegentle at justwriteclick.com>
>> >
>> >
>> > _______________________________________________
>> > Openstack-docs mailing list
>> > Openstack-docs at lists.openstack.org
>> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>> >
>
>
>
>
> --
> Anne Gentle
> annegentle at justwriteclick.com