Rework stackforge.html for infra manual changes
Rework the page so that all content that is now in the infra-manual is removed and the page just explains what StackForge is. Replace links to stackforge with a link to the project creators page. Change-Id: I79902876d05f8fc540e18bd3f596ea1f0cdf0e30
This commit is contained in:
Andreas Jaeger
parent
68a06213c2
commit
45f0fe03db
@ -172,7 +172,7 @@ Migrate the manifests:
|
||||
|
||||
* You need to modify the puppet path for gerrit acls - they should come from
|
||||
your project - make the directory but you can leave it empty (except for a
|
||||
. file to let git add it). ``http://ci.openstack.org/stackforge.html``
|
||||
. file to let git add it). The `Project Creator's Guide <http://docs.openstack.org/infra/manual/creators.html>`_
|
||||
covers how it gets populated when your infrastructure is working.
|
||||
|
||||
* Ditto projects.yaml and projects.ini, which is passed in from your
|
||||
@ -227,7 +227,7 @@ least 10G+ of RAM, as gerrit is configured for 8G of heap.
|
||||
Follow the :file:`doc/source/gerrit.rst` for instructions on getting gerrit
|
||||
configured once installed.
|
||||
|
||||
Finally, you should be able to follow :ref:`stackforge` to setup a project at
|
||||
Finally, you should be able to follow the `Project Creator’s Guide <http://docs.openstack.org/infra/manual/creators.html>`_ to setup a project at
|
||||
this point. (Zuul and Jenkins jobs obviously won't work yet).
|
||||
|
||||
Stage 4 - Zuul
|
||||
@ -300,7 +300,7 @@ which get the most load (as they run jobs from anyone).
|
||||
|
||||
#. Setup an equivalent to
|
||||
modules/openstack_project/files/jenkins_job_builder/config for your project.
|
||||
This is documented in :ref:`stackforge`. You should copy hooks.yaml and
|
||||
This is documented in the `Project Creator's Guide <http://docs.openstack.org/infra/manual/creators.html>`_. You should copy hooks.yaml and
|
||||
defaults.yaml across as-is, and if you want the stock set of python jobs
|
||||
that OpenStack uses, the python-jobs.yaml and pypi-jobs.yaml files too.
|
||||
Macros.yaml will need to be copied and customised. See the
|
||||
|
||||
@ -43,223 +43,6 @@ https://wiki.openstack.org/wiki/Gerrit_Workflow article linked from it.
|
||||
Add a Project to StackForge
|
||||
***************************
|
||||
|
||||
Create a new StackForge Project with Puppet
|
||||
===========================================
|
||||
|
||||
OpenStack uses Puppet and a management script to create Gerrit
|
||||
projects with simple changes to the openstack-infra/project-config
|
||||
repository. To start make sure you have cloned the
|
||||
openstack-infra/project-config repository ``git clone
|
||||
https://git.openstack.org/openstack-infra/project-config``.
|
||||
|
||||
First you need to add your StackForge project to the master project
|
||||
list. Edit :config:`gerrit/projects.yaml` and add a new section for
|
||||
your project in alphabetical order within the file. It should look
|
||||
something like::
|
||||
|
||||
- project: stackforge/project-name
|
||||
description: Latest and greatest cloud stuff.
|
||||
upstream: git://github.com/awesumsauce/project-name.git
|
||||
|
||||
The description will set the project description on the GitHub
|
||||
StackForge mirror, and the upstream should point at an existing
|
||||
repository which can be used to preseed Gerrit with an initial commit
|
||||
history. Both of these are optional. Note that the current tools
|
||||
assume that the upstream repo will have a master branch.
|
||||
|
||||
Note: Ensure the source repo has been evaluated and only required branches
|
||||
and tags remain when it seeds the stackforge repo. Cleaning up a repo of
|
||||
unnecessary branches and tags after the merge requires an openstack-infra
|
||||
core member to do so.
|
||||
|
||||
The next step is to add a Gerrit ACL config file. Edit
|
||||
``gerrit/acls/stackforge/project-name.config`` and make it look like::
|
||||
|
||||
[access "refs/heads/*"]
|
||||
abandon = group project-name-core
|
||||
label-Code-Review = -2..+2 group project-name-core
|
||||
label-Workflow = -1..+1 group project-name-core
|
||||
|
||||
[access "refs/tags/*"]
|
||||
pushSignedTag = group project-name-release
|
||||
|
||||
[receive]
|
||||
requireChangeId = true
|
||||
requireContributorAgreement = true
|
||||
|
||||
[submit]
|
||||
mergeContent = true
|
||||
|
||||
The access sections in the example ACL grant the project's core group
|
||||
approval privileges and the ability so set/un-set Workflow status on
|
||||
changes, as well as the ability to push tags. The other sections set
|
||||
some required options for Gerrit to function normally (enforcing
|
||||
presence of a Change-Id in commits and allowing changes to be merged).
|
||||
This example also expects contributors to agree to a standard
|
||||
OpenStack CLA, join the OpenStack Foundation and submit contact
|
||||
information (this feature can be disabled by setting
|
||||
requireContributorAgreement to false).
|
||||
|
||||
That is all that is necessary to add a StackForge project to Gerrit;
|
||||
however, this project isn't very useful until we setup Jenkins jobs for
|
||||
it and configure Zuul to run those jobs. Continue reading to configure
|
||||
these additional tools.
|
||||
|
||||
Add Jenkins Jobs to StackForge Projects
|
||||
=======================================
|
||||
|
||||
In the same openstack-infra/project-config repository (and in the same
|
||||
change if you like) we need to edit additional files to setup Jenkins
|
||||
jobs and Zuul for the new StackForge project.
|
||||
|
||||
If you are interested in using the standard python Jenkins jobs (docs,
|
||||
pep8, python 2.6 and 2.7 unittests, and coverage), edit
|
||||
:config:`jenkins/jobs/projects.yaml` and add a new section for your
|
||||
project in alphabetical order in the file. It should look something
|
||||
like::
|
||||
|
||||
- project:
|
||||
name: project-name
|
||||
node: bare-trusty
|
||||
tarball-site: tarballs.openstack.org
|
||||
|
||||
jobs:
|
||||
- python-jobs
|
||||
|
||||
List of jobs included to the ``python-jobs`` jobs group is located in
|
||||
:config:`jenkins/jobs/python-jobs.yaml`. For document publication
|
||||
there's also a publisher job template for the popular `Read the Docs`_
|
||||
documentation hosting service, which can be used by adding the
|
||||
``hook-{name}-rtfd`` template to the jobs list::
|
||||
|
||||
- project:
|
||||
name: project-name
|
||||
node: bare-trusty
|
||||
tarball-site: tarballs.openstack.org
|
||||
|
||||
jobs:
|
||||
- python-jobs
|
||||
- hook-{name}-rtfd
|
||||
|
||||
.. _Read the Docs: https://readthedocs.org/
|
||||
|
||||
If you aren't ready to run any gate tests or other project-specific
|
||||
jobs yet, you don't need to edit ``projects.yaml``.
|
||||
|
||||
Now that we have Jenkins jobs we need to tell Zuul to run them when
|
||||
appropriate. Edit :config:`zuul/layout.yaml` and add a new section for
|
||||
your project in alphabetical order within the file. It should look
|
||||
something like::
|
||||
|
||||
- name: stackforge/project-name
|
||||
template:
|
||||
- name: merge-check
|
||||
- name: python-jobs
|
||||
- name: python3-jobs
|
||||
|
||||
If you aren't ready to run any gate tests yet and did not configure
|
||||
python-jobs in ``projects.yaml``, it should look like this instead::
|
||||
|
||||
- name: stackforge/project-name
|
||||
template:
|
||||
- name: merge-check
|
||||
- name: noop-jobs
|
||||
|
||||
That concludes the bare minimum openstack-infra/project-config changes
|
||||
necessary to add a project to StackForge. You can commit these changes
|
||||
and submit them to review.openstack.org at this point, or you can wait
|
||||
a little longer and add your project to GerritBot first.
|
||||
|
||||
Request an Initial Gerrit Core Group Member
|
||||
===========================================
|
||||
|
||||
StackForge uses Gerrit for group management. After the change to create
|
||||
your StackForge project has merged, request an initial member for the
|
||||
Gerrit group configured in your ACL (probably something like
|
||||
``your-project-name-core``). Members of this team will have permissions
|
||||
to approve code changes to your project as defined in your ACL, and to
|
||||
add other Gerrit users to the group.
|
||||
|
||||
You can request an initial Gerrit group member by opening a bug at
|
||||
https://storyboard.openstack.org/#!/project/748 (make sure to mention
|
||||
the Gerrit full name or E-mail address of your initial member). See
|
||||
https://wiki.openstack.org/wiki/Project_Group_Management for details on
|
||||
project group management.
|
||||
|
||||
Configure StackForge Project to use GerritBot
|
||||
=============================================
|
||||
|
||||
To have GerritBot send Gerrit events for your project to a Freenode
|
||||
IRC channel edit :config:`gerritbot/channels.yaml`. If you want to
|
||||
configure GerritBot to leave alerts in a channel GerritBot has always
|
||||
joined just add your project to the project list for that channel::
|
||||
|
||||
stackforge-dev:
|
||||
events:
|
||||
- patchset-created
|
||||
- change-merged
|
||||
- x-vrif-minus-2
|
||||
projects:
|
||||
- stackforge/foo
|
||||
- stackforge/python-fooclient
|
||||
- stackforge/project-name
|
||||
branches:
|
||||
- master
|
||||
|
||||
If you want to join GerritBot to a new channel add a new section to the
|
||||
end of this file that looks like::
|
||||
|
||||
project-name-dev:
|
||||
events:
|
||||
- patchset-created
|
||||
- change-merged
|
||||
- x-vrif-minus-2
|
||||
projects:
|
||||
- stackforge/project-name
|
||||
branches:
|
||||
- master
|
||||
|
||||
If you are defining a new channel, add it also in
|
||||
:config:`accessbot/channels.yaml` file, optionally defining also its
|
||||
mask. The mask will be used to define the access level for IRC users
|
||||
who are not listed in that file in the ``global`` section or otherwise
|
||||
listed for the channel.
|
||||
|
||||
For instance:
|
||||
|
||||
- name: new_project
|
||||
mask: full_mask
|
||||
|
||||
For more information about channel requirements and IRC services provided by
|
||||
the infrastructure team, visit :ref:`irc`
|
||||
|
||||
And that's it. At this point you will want to submit these edits as a
|
||||
change to review.openstack.org. When you do so, please use the
|
||||
``new-project`` topic. You can do that using the ``-t`` option to
|
||||
``git review``.
|
||||
|
||||
$ git review -t new-project
|
||||
|
||||
Add .gitreview file to project
|
||||
==============================
|
||||
|
||||
If the new project you have added has a specified upstream you will need
|
||||
to add a ``.gitreview`` file to the project once it has been created. This
|
||||
new file will allow you to use ``git review``.
|
||||
|
||||
The basic process is clone from stackforge, add file, push to Gerrit,
|
||||
review and approve.::
|
||||
|
||||
git clone https://git.openstack.org/stackforge/project-name
|
||||
cd project-name
|
||||
git checkout -b add-gitreview
|
||||
cat > .gitreview <<EOF
|
||||
[gerrit]
|
||||
host=review.openstack.org
|
||||
port=29418
|
||||
project=stackforge/project-name.git
|
||||
EOF
|
||||
git review -s
|
||||
git add .gitreview
|
||||
git commit -m 'Add .gitreview file.'
|
||||
git review
|
||||
For information on adding a project to StackForge, see the `Project
|
||||
Creator's Guide
|
||||
<http://docs.openstack.org/infra/manual/creators.html>`_.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user