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

Go to file

Jean-Philippe Evrard 2542768c0a Add OpenStack-Ansible feature list The addition of the deployment tool capabilities requires each project to list their capabilities. As there is none for OSA yet, this adds it. Change-Id: I992788813dbcfcdba1d8334852514f92012bfb80		2019-07-09 15:57:50 +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	Add OpenStack-Ansible feature list	2019-07-09 15:57:50 +00:00
deployment_tools_capabilities.yaml	Fix capabilities following initial review	2019-07-03 14:15:21 +02:00
openstack_components.yaml	Merge "Add placement to the shared service components"	2019-06-10 16:02:46 +00: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).