system-config/doc/source/storyboard.rst
Khai Do 54b9af4786 doc: add Storyboard integration info
Change-Id: I17f35142ea29f36efdb8810e35ca898f6dc1218b
2016-08-26 13:09:14 -07:00

2.8 KiB

title

StoryBoard

StoryBoard

StoryBoard is the task and project tracking system both developed and used by the OpenStack project. Some projects have already elected to move to StoryBoard, however it is still considered in limited alpha and is not ready for production use.

This section describes how StoryBoard is configured for use in the OpenStack project and the tools used to manage that configuration.

At a Glance

Hosts
Puppet
Projects
Configuration
  • gerrit/projects.yaml
  • modules/openstack_project/files/storyboard/superusers.yaml
Bugs
Resources

Installation

StoryBoard is installed and configured by Puppet, using the puppet module developed for the project. See sysadmin for how Puppet is used to manage OpenStack infrastructure systems.

Configuration

The default superusers configuration of StoryBoard is managed from within infra/system-config. The rest of the configuration is on projects-config. To add a project, admin, or modify a team, please follow the instructions below.

Adding a Project to StoryBoard

Note

At this point, only OpenStack Infrastructure projects should be added to StoryBoard, as key features such as release versioning are not yet implemented.

Projects loaded into StoryBoard are handled from the same file that drives our gerrit projects. Adding a new project is as simple as modifying a single file and adding the line use-storyboard: true:

:config:`gerrit/projects.yaml`:

- project: openstack-infra/storyboard
  description: OpenStack Task Tracking API
  use-storyboard: true

Adding an Admin to StoryBoard

StoryBoard administrators are handled from a single configuration file, and are identified by OpenID. To add a new administator, simply add their Launchpad OpenID string and email as follows:

:config:`gerrit/projects.yaml`:

- openid: https://login.launchpad.net/+id/LOLPONIES
  email: pinkie.pie@example.com

Modifying a Team on StoryBoard

Teams are not yet supported. Stay tuned!