Base data to generate the OpenStack map and the Software section of the www.openstack.org website.

Go to file

OpenDev Sysadmins c3df101105 OpenDev Migration Patch This commit was bulk generated and pushed by the OpenDev sysadmins as a part of the Git hosting and code review systems migration detailed in these mailing list posts: http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html Attempts have been made to correct repository namespaces and hostnames based on simple pattern matching, but it's possible some were updated incorrectly or missed entirely. Please reach out to us via the contact information listed at https://opendev.org/ with any questions you may have.		2019-04-19 19:25:32 +00:00
.gitignore	Add YAML linting in check and gate	2019-01-07 11:34:04 +01:00
.gitreview	OpenDev Migration Patch	2019-04-19 19:25:32 +00:00
.zuul.yaml	Add YAML linting in check and gate	2019-01-07 11:34:04 +01:00
README.rst	Document YAML file schema in README	2018-12-20 15:07:21 +01:00
deployment_tools.yaml	Update information for Chef OpenStack project	2019-03-21 14:32:50 +00:00
openstack_components.yaml	Add base dependencies for "main" OpenStack	2019-02-14 12:12:32 +01:00
sdks.yaml	Update the prelude/description	2018-12-27 14:46:51 -06:00
tox.ini	Add YAML linting in check and gate	2019-01-07 11:34:04 +01:00

README.rst

Using This Repository

This repository contains information about OpenStack first-order deliverables, to be used to generate the OpenStack map and "software" pages on the openstack.org website.

What should be included

The goal is to provide a user-facing view of OpenStack deliverables. As such, only first-order deliverables (components that users actually opt into installing) are presented. Libraries, pure dependencies and other second-level deliverables should not be included.

File structure

This repository contains one file for the OpenStack components themselves (openstack_components.yaml), one for tools that can be used to deploy them (deployment_tools.yaml) and one for tools that can be used client-side to interact with them (sdks.yaml).

Each file has a super-structure with tabs and categories, under which each component can be added.

Component schema

Each component is defined by a YAML dictionary with the following keys:

name

The component name (mandatory).

title

A user-friendly short description of the component role (mandatory).

docs-title

Text to use for a link to further documentation (optional).

docs-url

URL to use for a link to further documentation (optional).

desc

Long description of the component role (mandatory).

project-team

Name of the project team that produces this deliverable, as found in the openstack/governance repository in the reference/projects.yaml file (mandatory).

support-teams

List of other project teams (such as I18n, Docs...) to credit for helping in the production of that component, as found in the openstack/governance repository in the reference/projects.yaml file (optional).

since

First OpenStack release that included that component (optional).

video

Video to embed. Currently only supports linking to YouTube videos (optional).

id: YouTube ID for the video.
title: Title for the video.
desc: Description of the video.

dependencies

List of other component names that are hard dependencies for this component (can't work without them) (optional, only for openstack_components.yaml).

see-also

List of other component names that are soft dependencies for this component (benefits of the presence of them) (optional, only for openstack_components.yaml).