infra-specs/specs/publish-election-repo.rst

This work is licensed under a Creative Commons Attribution 3.0
Unported License.
http://creativecommons.org/licenses/by/3.0/legalcode

Publish election repository

https://storyboard.openstack.org/#!/story/2000499

Last election cycle (Sept/Oct 2015) a new gerrit based workflow was used to propose and validate candidates for the PTL and TC elections. The publication of validated candidates was somewhat manual in that a list of confirmed candidates needed to be pasted in to a wiki page. This list is trivially generated with sphinx. This spec covers the publication of the openstack/election repo. This will be closely modeled on the existing governance.openstack.org site and exist on the same vhost.

Problem Description

See above.

Proposed Change

The proposed change is to add the election data to static.openstack.org and publish the results of a job run on the openstack/election repo grafted onto governance.openstack.org. The scope for this spec is configuring the graft and arranging for publishing the data. Any additional work would be an additional spec. We're asking for minimal help with the changes form the infra team and expect the infra team's primary role would be review and approval.

Alternatives

1. As always we can do nothing and go with the status quo
2. We could host the election data on its own vhost

Implementation

Assignee(s)

Primary assignee:

Tony Breeds (o-tony)

Additional assignee:

Tristan Cacqueray (tristan-cacqueray) Joshua Hesketh (jhesketh)

Tony will primarily work on the {system,project}-config changes required and Tristan will work on the job to build the required HTML.

Gerrit Topic

We will use the add_elections as the gerrit topic

Work Items

1. Define a vhost on static.openstack.org
2. Create a tox env and Jenkins job to generate candidate lists using the usual "python setup.py build_sphinx" entry point
3. Create a Jenkins job to publish the generated HTML

Repositories

No.

Servers

No new servers. I propose that static.openstack.org be modified to handle this role.

DNS Entries

Yes: election.openstack.org should be a CNAME for static.openstack.org

Documentation

I believe that this spec and changes to system-config and project-config repos will be adequate documentation.

Security

I propose to use governance.openstack.org as a template so I do not expect any new security concerns

Testing

I don't believe that this spec introduces any infra specific testing. Of course Tristan and I will endeavour to thoroughly test changes in the openstack/election repo.

Dependencies

None outside of this spec.