openstack/openstack-manuals
Code Issues Proposed changes

[www] Setup 2024.1 Caracal and add project data to Bobcat

Browse Source 
This change adds
* default pages for next release, 2024.1 Caracal
* 2023.2 Bobcat project data so that index pages will be generated

It still keeps 2023.2 Bobcat in development phase. A future change
will transition it to 'maintained' at release time.

The patch content was setup by following the www page release
guideline [1].

[1] https://docs.openstack.org/doc-contrib-guide/release/taskdetail.html#update-www-pages-for-end-of-release

Change-Id: Idd6f8943d16d104a0037bbfc81e3a945135ed4a4
This commit is contained in:
Elod Illes 2023-09-25 15:34:15 +02:00
parent 4cbdcee2f7
commit 48ac7df0c2
12 changed files with 1424 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
tools/www-generator.py
View File

@ -76,6 +76,7 @@ SERIES_INFO = collections.OrderedDict([
('zed', SeriesInfo(date='October 2022', status='maintained')),
('2023.1', SeriesInfo(date='March 2023', status='maintained')),
('2023.2', SeriesInfo(date='October 2023', status='development')),
('2024.1', SeriesInfo(date='April 2024', status='development')),
])
# Build a list of the series that are not the current series being

69
www/2024.1/admin/index.html Normal file
View File

@ -0,0 +1,69 @@
{% set projects = PROJECT_DATA[SERIES] %}
{% extends "templates/base.tmpl" %}
{% block pagetitle %}{{SERIES_TITLE}} Administrator Guides{% endblock %}
{% block title %}
<a href="https://docs.openstack.org/">Documentation</a> &gt; Administrator Guides
{% endblock %}
{% block content %}
<!-- Begin Page Content -->
<div class="top-docs-wrapper">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8">
<h1>OpenStack {{SERIES_TITLE}} Administrator Guides</h1>
<p>
This page contains documentation about administering OpenStack services.
</p>
</div>
</div>
</div>
<div class="mid-docs-wrapper" id="docs-main-body">
<div class="container">
<div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>Administrator Guides for OpenStack Services</h3>
{% for project in projects|sort(attribute='name') -%}
{% if project.type in ['service', 'other'] and project.has_admin_guide %}
<a href="/{{project.name}}/{{SERIES}}/admin/">
{{project.service}} ({{project.name}})
</a><br />
{% endif %}
{%- endfor %}
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>Administrator Guides for Common OpenStack Libraries</h3>
{% for project in projects|sort(attribute='name') -%}
{% if project.type == 'library' and project.has_admin_guide %}
<a href="/{{project.name}}/{{SERIES}}/admin/">{{project.name}}</a><br />
<p>{{project.service}}</p>
{% endif %}
{%- endfor %}
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>Administrator Guides for OpenStack Deployment Tools</h3>
{% for project in projects|sort(attribute='name') -%}
{% if project.type == 'deployment' and project.has_admin_guide %}
<a href="/{{project.name}}/{{SERIES}}/admin/">{{project.name}}</a><br />
<p>{{project.service}}</p>
{% endif %}
{%- endfor %}
</div>
</div>
</div>
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="/doc-contrib-guide/" class="overview-btn contribute-btn"
>How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>
</div>
{% endblock content %}

65
www/2024.1/api/index.html Normal file
View File

@ -0,0 +1,65 @@
{% set projects = PROJECT_DATA[SERIES] %}
{% extends "templates/base.tmpl" %}
{% block pagetitle %}{{SERIES_TITLE}} API references{% endblock %}
{% block title %}API references{% endblock %}
{% block header %}
{% endblock header %}
{% block content %}
<!-- Begin Page Content -->
<div class="top-docs-wrapper">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8">
<h1>OpenStack {{SERIES_TITLE}} API Reference Documentation</h1>
<p>
This page contains documentation about the OpenStack API and how to use it.
</p>
</div>
</div>
</div>
<div class="mid-docs-wrapper" id="docs-main-body">
<div class="container">
<div class="row">
<div class="col-lg-12">
</div>
</div>
<div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>API References</h3>
{% for project in projects|sort(attribute='service') %}
{% if project.has_api_ref or project.has_api_guide or project.has_in_tree_api_docs %}
{{project.service}} ({{project.name}}):
{% if project.has_api_ref %}
<a href="https://docs.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
{% endif %}
{% if project.has_in_tree_api_docs %}
<a href="/{{project.name}}/{{SERIES}}/api/"> API Documentation</a>
{% endif %}
{% if project.has_api_guide %}
<a href="https://docs.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
{% endif %}
<br/>
{% endif %}
{% endfor %}
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cloud"></i>User Guides</h3>
<a href="/api-quick-start/">API Guide</a><br/>
<a href="../user/">OpenStack End User Guides (includes Python SDK)</a><br/>
<a href="https://developer.openstack.org">Open source software for application development</a><br/>
</div>
</div>
</div>
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="/doc-contrib-guide/" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>
</div>
<!-- End Page Content -->
{% endblock content %}

1
www/2024.1/badge.html Normal file
View File

@ -0,0 +1 @@
{% include 'templates/project_deprecated_badge.tmpl' %}

60
www/2024.1/configuration/index.html Normal file
View File

@ -0,0 +1,60 @@
{% set projects = PROJECT_DATA[SERIES] %}
{% extends "templates/base.tmpl" %}
{% block pagetitle %}{{SERIES_TITLE}} Configuration Guides{% endblock %}
{% block title %}
<a href="https://docs.openstack.org/">Documentation</a> &gt; Configuration Guides
{% endblock %}
{% block content %}
<!-- Begin Page Content -->
<div class="top-docs-wrapper">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8">
<h1>OpenStack {{SERIES_TITLE}} Configuration Guides</h1>
<p>
This page contains documentation about configuring OpenStack services.
</p>
</div>
</div>
</div>
<div class="mid-docs-wrapper" id="docs-main-body">
<div class="container">
<div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>Configuration Guides for OpenStack Services</h3>
<a href="/oslo.config/{{SERIES}}/configuration/">
General information about configuring OpenStack (oslo.config)
</a><br />
{% for project in projects|sort(attribute='name') -%}
{% if project.type in ['service', 'other'] and project.has_config_ref %}
<a href="/{{project.name}}/{{SERIES}}/configuration/">
{{project.service}} ({{project.name}})
</a><br />
{% endif %}
{%- endfor %}
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-pencil"></i>Common Configuration via Libraries</h3>
{% for project in projects|sort(attribute='name') %}
{% if project.type == 'library' and project.has_config_ref %}
<a href="/{{project.name}}/{{SERIES}}/configuration/">{{project.name}}</a><br />
<p>{{project.service}}</p>
{% endif %}
{% endfor %}
</div>
</div>
</div>
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="/doc-contrib-guide/" class="overview-btn contribute-btn"
>How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>
</div>
{% endblock content %}

45
www/2024.1/deploy/index.html Normal file
View File

@ -0,0 +1,45 @@
{% set projects = PROJECT_DATA[SERIES] %}
{% extends "templates/base.tmpl" %}
{% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %}
{% block title %}
<a href="https://docs.openstack.org">Documentation</a> &gt; {{SERIES_TITLE}} Deployment Guides
{% endblock %}
{% block content %}
<!-- Begin Page Content -->
<div class="top-docs-wrapper">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8">
<h1>OpenStack {{SERIES_TITLE}} Deployment Guides</h1>
<p>The following deployment guides support different installation
methods for core and optional OpenStack services.</p>
<p>This is documentation in progress for the next release.</p>
</div>
</div>
</div>
<div class="mid-docs-wrapper" id="docs-main-body">
<div class="container">
<div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cogs"></i>By deployment method</h3>
{% for project in projects|sort(attribute='name') -%}
{% if project.type == 'deployment' and project.has_deployment_guide %}
<p><a href="/project-deploy-guide/{{project.name}}/{{SERIES}}/">
{{project.service}} Guide
</a></p>
{% endif %}
{%- endfor %}
</div>
</div>
</div>
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="/doc-contrib-guide/" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>
</div>
{% endblock content %}

112
www/2024.1/index.html Normal file
View File

@ -0,0 +1,112 @@
{% extends "templates/indexbase.tmpl" %}
{% block pagetitle %}{{SERIES_TITLE}}{% endblock %}
{% block title %}{% endblock %}
{% block header %}
{% endblock header %}
{% block content %}
<div class="container">
<div class="row">
<div class="col-lg-12"></div>
</div>
<div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3 id="release-notes"><i class="fa fa-refresh"></i>Release Notes</h3>
<p>New features, upgrade and deprecation notes, known issues, and bug fixes</p>
<a href="https://releases.openstack.org/{{SERIES}}/index.html">OpenStack Projects Release Notes</a>
<a href="/releasenotes/openstack-manuals/index.html">OpenStack Documentation Release Notes</a>
</div>
<div class="docs-link-sections">
<h3 id="install-guides"><i class="fa fa-cogs"></i>Installation Guides</h3>
<p>Getting started with the most commonly used OpenStack services</p>
<a href="install/">Installation Guides</a>
</div>
<div class="docs-link-sections">
<h3 id="project-deploy-guide"><i class="fa fa-cogs"></i>Deployment Guides</h3>
<p>Choose how to deploy OpenStack and get started with the most commonly used OpenStack services</p>
<a href="deploy/">Deployment Guides</a>
</div>
<div class="docs-link-sections">
<h3 id="ops-and-admin-guides"><i class="fa fa-users"></i>Operations and Administration Guides</h3>
<a href="admin/">Administrator Guides</a>
<p>Manage and troubleshoot an OpenStack cloud</p>
<!-- TODO(jaegerandi): Enable once we have content again
<a href="/ha-guide/">High Availability Guide</a> -->
<p>Install and configure OpenStack for high availability</p>
<a href="/arch-design/">Architecture Guide</a>
<p>Plan and design an OpenStack cloud</p>
<a href="/operations-guide/">Operations Guide</a>
<p>Operate an OpenStack cloud</p>
<a href="/security-guide/">Security Guide</a>
<p>Guidelines and scenarios for creating more secure OpenStack clouds</p>
<a href="/image-guide/">Virtual Machine Image Guide</a><a href="/image-guide/ImageGuide.pdf">[PDF]</a>
<p>Obtain, create, and modify OpenStack-compatible virtual machine images</p>
</div>
<div class="docs-link-sections">
<h3 id="configuration-guides"><i class="fa fa-wrench"></i>Configuration Guides</h3>
<a href="configuration/">Configuration Reference</a>
<p>Installation and configuration options for OpenStack</p>
</div>
<div class="docs-link-sections">
<h3 id="api-guides"><i class="fa fa-book"></i>API Guides</h3>
<a href="api/">API Guides</a>
<p>OpenStack API Documentation</p>
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3 id="user-guides"><i class="fa fa-cloud"></i>User Guides</h3>
<a href="user/">End User Guides</a>
<p>Create and manage resources using the OpenStack dashboard, command-line client, and Python SDK</p>
<a href="https://developer.openstack.org">Open source software for application development</a>
<p>Resources for application development on OpenStack clouds</p>
</div>
<div class="docs-link-sections">
<h3 id="services-libraries"><i class="fa fa-leaf"></i>Project-specific Guides</h3>
<a href="projects.html">Services and Libraries</a>
<p>Documentation for OpenStack services and libraries</p>
<a href="language-bindings.html">Language Bindings and Python Clients</a>
<p>Documentation for the OpenStack Python bindings and clients</p>
</div>
<div class="docs-link-sections">
<h3 id="services-libraries"><i class="fa fa-users-cog"></i>SIG-specific Documentation</h3>
<a href="https://docs.openstack.org/project-team-guide/stable-branches.html">Extended Maintenance SIG</a>
<p>The Extended Maintenance SIG manages the existing stable branches</p>
<a href="/self-healing-sig/">Self-healing SIG documentation</a>
<p>Self-healing use cases and implementation details</p>
<a href="/large-scale/">Large Scale SIG documentation</a>
<p>The journey of running OpenStack at large scale</p>
</div>
<div class="docs-link-sections">
<h3 id="doc-contrib-guides"><i class="fa fa-pencil"></i>Contributor Guides</h3>
<a href="/contributors/">The OpenStack Contributor Guide</a>
<p>The contribution process explained</p>
<a href="/doc-contrib-guide/index.html">OpenStack Documentation Contributor Guide</a>
<p>Documentation workflow and conventions</p>
<a href="https://governance.openstack.org/tc/">OpenStack Technical Committee Governance Documents</a>
<p>OpenStack Technical Committee reference documents and official resolutions</p>
<a href="http://specs.openstack.org/">OpenStack Project specifications</a>
<p>Specifications for future project features</p>
<a href="/project-team-guide/">OpenStack Project Team Guide</a>
<p>Guide to the OpenStack project and community</p>
<a href="/infra/">OpenStack Testing and Collaboration Tools Documentation</a>
<p>Community-managed development and communication systems</p>
<a href="/i18n/">OpenStack I18n Guide</a>
<p>Internationalization workflow and conventions</p>
<a href="https://openinfra.dev/join/">Join the Open Infrastructure Foundation</a>
<p>How to join the Open Infrastructure Foundation</p>
<a href="https://www.openstack.org/user-survey/">Take the Deployment Survey</a>
<p>Influence the future of OpenStack</p>
</div>
<div class="docs-link-sections">
<h3 id="training-guides"><i class="fa fa-university"></i>Training Guides and Training Labs</h3>
<a href="/upstream-training/">Upstream training</a>
<p>Resources for the OpenStack Upstream Training program</p>
<a href="/training_labs/">Training Labs</a>
<p>Tools for OpenStack Training. Automatic deployment of lean virtualized multi-node openstack cluster.</p>
</div>
</div>
</div>
</div>
<!-- End Page Content -->
{% endblock content %}

75
www/2024.1/install/index.html Normal file
View File

@ -0,0 +1,75 @@
{% set projects = PROJECT_DATA[SERIES] %}
{% extends "templates/base.tmpl" %}
{% block pagetitle %}{{SERIES_TITLE}} Installation Guides{% endblock %}
{% block title %}
<a href="https://docs.openstack.org">Documentation</a> &gt; {{SERIES_TITLE}} Installation Guides
{% endblock %}
{% block content %}
<!-- Begin Page Content -->
<div class="top-docs-wrapper">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8">
<h1>OpenStack {{SERIES_TITLE}} Installation Guides</h1>
<p>
These documents cover installation procedures for OpenStack
services.
</p>
<p>
If you prefer to install OpenStack using an automated deployment
tool, see the <a href="../deploy/">Deployment Guides.</a>
</p>
</div>
</div>
</div>
</div>
<div class="mid-docs-wrapper" id="docs-main-body">
<div class="container">
<div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections services-section">
<h3><i class="fa fa-cogs"></i>Installation Guide</h3>
<p>The following guide provides information about getting started,
setting up your environment, and launching your instance.
</p>
<p>
<a class="overview-btn docs-btn" style="width:80%;text-transform:initial;"
href="/install-guide/">
OpenStack Installation Guide
</a>
</p>
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cogs"></i>Project Installation Guides</h3>
<ul>
{% for project in projects|sort(attribute='service') -%}
{% if project.type in ['service', 'other'] and project.has_install_guide %}
<li><a href="/{{project.name}}/{{SERIES}}/install/">{{project.service}} ({{project.name|title}})</a></li>
{% endif %}
{%- endfor %}
</ul>
</div>
</div>
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="/doc-contrib-guide/" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
<script>
var elements = document.getElementsByClassName("os-box");
var maximum = Number.MIN_VALUE;
for (var i = 0, len = elements.length; i < len; i++) {
if(elements[i].offsetHeight>maximum){
maximum = elements[i].offsetHeight;
}
}
$('.os-box').height(maximum);
</script>
{% endblock content %}

68
www/2024.1/language-bindings.html Normal file
View File

@ -0,0 +1,68 @@
{% set projects = PROJECT_DATA[SERIES] %}
{% extends "templates/base.tmpl" %}
{% block pagetitle %}{{SERIES_TITLE}} Language bindings{% endblock %}
{% block title %}
<a href="https://docs.openstack.org/">Documentation</a> &gt; Language Bindings and Python Clients
{% endblock %}
{% block content %}
<!-- Begin Page Content -->
<div class="top-docs-wrapper">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8">
<h1>OpenStack {{SERIES_TITLE}} API Bindings</h1>
<p>
This page contains documentation about the Python
bindings provided by OpenStack and how to use them.
</p>
</div>
</div>
</div>
<div class="mid-docs-wrapper" id="docs-main-body">
<div class="container">
<div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>Bindings for the OpenStack APIs</h3>
{% for project in projects|sort(attribute='service') -%}
{% if project.type == 'cloud-client' and project.name != 'python-openstackclient' %}
<a href="/{{project.name}}/{{SERIES}}/">
{{project.service}} ({{project.description}})
</a><br />
{% endif %}
{%- endfor %}
</div>
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i> Bindings for individual OpenStack service APIs</h3>
{% for project in projects|sort(attribute='service') -%}
{% if project.type == 'service-client' %}
<a href="/{{project.name}}/{{SERIES}}/">
{{project.service}} ({{project.description}})
</a><br />
{% endif %}
{%- endfor %}
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cloud"></i>Use the unified command-line client</h3>
<a href="/python-openstackclient/{{SERIES}}/">
Unified OpenStack Client
</a><br />
<p>
Documentation for python-openstackclient, a unified shell command structure.
</p>
</div>
</div>
</div>
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="/doc-contrib-guide/" class="overview-btn contribute-btn"
>How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>
</div>
{% endblock content %}

1
www/2024.1/projects.html Normal file
View File

@ -0,0 +1 @@
{% extends "templates/project_list.tmpl" %}

71
www/2024.1/user/index.html Normal file
View File

@ -0,0 +1,71 @@
{% set projects = PROJECT_DATA[SERIES] %}
{% extends "templates/base.tmpl" %}
{% block pagetitle %}{{SERIES_TITLE}} User Guides{% endblock %}
{% block title %}
<a href="https://docs.openstack.org">Documentation</a> &gt; User Guides
{% endblock %}
{% block content %}
<!-- Begin Page Content -->
<div class="top-docs-wrapper">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8">
<h1>OpenStack {{SERIES_TITLE}} Project User Guides</h1>
<p>
This page contains project-specific documentation for
using OpenStack services and libraries.
</p>
</div>
</div>
</div>
<div class="mid-docs-wrapper" id="docs-main-body">
<div class="container">
<div class="row">
<div class="col-lg-12">
</div>
</div>
<div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cog"></i>User Guides for OpenStack Services</h3>
{% for project in projects|sort(attribute='service') %}
{% if project.type in ['service', 'other'] and project.has_user_guide %}
<a href="/{{project.name}}/{{SERIES}}/user/">
{{project.service}} ({{project.name}})</a><br />
{% endif %}
{% endfor %}
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cog"></i>User Guides for OpenStack Deployment Tools</h3>
{% for project in projects|sort(attribute='service') %}
{% if project.type in ['deployment'] and project.has_user_guide %}
<a href="/{{project.name}}/{{SERIES}}/user/">
{{project.service}} ({{project.name}})</a><br />
{% endif %}
{% endfor %}
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cog"></i>Client Libraries</h3>
<p>Refer to <a href="../language-bindings.html">the
language bindings list</a> for Python client library
documentation and the Unified OpenStack command line
client.</p>
</div>
</div>
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="/doc-contrib-guide/" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>
</div>
{% endblock content %}

856
www/project-data/2023.2.yaml Normal file
View File

@ -0,0 +1,856 @@
---
# Schema: See schema.yaml and README.txt
- name: keystone
service: Identity service
service_type: identity
has_install_guide: true
has_api_ref: true
has_admin_guide: true
has_config_ref: true
has_user_guide: true
type: service
- name: python-keystoneclient
service: Identity service Python Bindings
type: service-client
description: keystone client
- name: keystoneauth
type: cloud-client
description: keystoneauth
service: Common authentication library and REST client for OpenStack.
- name: keystonemiddleware
type: library
service: Middleware provided for integrating with the OpenStack Identity API.
#- name: pycadf
# type: library
# service: Creates CADF events to capture cloud-related events.
- name: glance
service: Image service
service_type: image
has_install_guide: true
has_api_ref: true
has_config_ref: true
has_admin_guide: true
type: service
has_user_guide: true
has_in_tree_htaccess: true
- name: python-glanceclient
service: Image service Python Bindings
type: service-client
description: glance client
- name: glance_store
deliverable-name: glance-store
service: glance backend abstraction library
type: library
has_user_guide: true
- name: nova
service: Compute service
service_type: compute
has_api_ref: true
has_api_guide: true
has_install_guide: true
has_config_ref: true
has_admin_guide: true
has_user_guide: true
has_in_tree_htaccess: true
type: service
- name: python-novaclient
service: Compute service Python Bindings
has_user_guide: true
has_in_tree_htaccess: true
type: service-client
description: nova client
#- name: os-traits
# type: library
# service: Library containing standardized trait strings.
- name: os-vif
type: library
service: Library for plugging and unplugging virtual interfaces.
- name: placement
type: service
service: Placement service
service_type: placement
has_admin_guide: true
has_api_ref: true
has_config_ref: true
has_install_guide: true
has_user_guide: true
- name: osc-placement
type: service-client
service: OpenStackClient plugin for the Nova Placement service.
description: nova placement client
- name: neutron
service: Networking service
service_type: network
has_api_ref: true # currently published under neutron-lib
has_install_guide: true
has_admin_guide: true
has_config_ref: true
type: service
- name: python-neutronclient
service: Networking service Python Bindings
type: service-client
description: neutron client
- name: neutron-lib
type: library
service: Library provided for integrating with the OpenStack Networking platform.
has_install_guide: true
has_user_guide: true
- name: networking-bagpipe
service: BaGPipe backend
type: networking
has_install_guide: true
has_user_guide: true
- name: networking-bgpvpn
service: BGP-MPLS VPN Networking service Plug-in
type: networking
has_install_guide: true
has_user_guide: true
- name: neutron-dynamic-routing
service: Dynamic Routing service Plug-in
type: networking
has_install_guide: true
has_admin_guide: true
- name: neutron-fwaas
service: Firewall-as-a-Service Plug-in
type: networking
- name: neutron-vpnaas
service: VPN-as-a-Service Plug-in
type: networking
#- name: networking-odl
# service: OpenDaylight(ODL) Networking service Plug-in
# type: networking
# has_install_guide: true
# has_admin_guide: true
# has_config_ref: true
- name: networking-sfc
service: Service Function Chaining Networking service Plug-in
type: networking
has_install_guide: true
has_config_ref: true
has_user_guide: true
- name: horizon
service: Dashboard
has_install_guide: true
has_config_ref: true
has_admin_guide: true
has_user_guide: true
type: service
- name: cinder
service: Block Storage service
service_type: block-storage
has_install_guide: true
has_api_ref: true
has_admin_guide: true
has_config_ref: true
type: service
- name: python-cinderclient
service: Block Storage service Python Bindings
type: service-client
description: cinder client
- name: os-brick
service: library for managing local volume attaches
type: library
description: cinder backend abstraction library
- name: python-brick-cinderclient-ext
service: client for local volume attachement
type: service-client
description: cinder local client
- name: ironic
service: Bare Metal service
service_type: baremetal
has_install_guide: true
has_api_ref: true
has_admin_guide: true
has_user_guide: true
has_config_ref: true
type: service
- name: python-ironicclient
service: Bare Metal service Python Bindings
type: service-client
description: ironic client
- name: ironic-inspector
service: Bare Metal Introspection service
type: baremetal
has_install_guide: true
has_admin_guide: true
has_user_guide: true
- name: python-ironic-inspector-client
service: Bare Metal Introspection service Python Bindings
type: service-client
description: ironic-inspector client
- name: bifrost
service: Ansible roles and playbooks to enable a standalone Ironic install
type: baremetal
- name: sushy
service: Python library to communicate with Redfish based systems
type: baremetal
- name: ironic-python-agent
service: Python agent for provisioning and deprovisioning Bare Metal servers
type: baremetal
- name: magnum
service: Container Infrastructure Management service
service_type: container-infrastructure-management
has_api_ref: true
has_install_guide: true
has_admin_guide: true
has_config_ref: true
has_user_guide: true
type: service
- name: python-magnumclient
service: Container Infrastructure Management service Python Bindings
type: service-client
description: magnum client
- name: trove
service: Database service
service_type: database
has_install_guide: true
has_admin_guide: true
has_user_guide: true
has_api_ref: true
type: service
- name: python-troveclient
service: Database service Python Bindings
type: service-client
description: trove client
has_user_guide: true
- name: designate
service: DNS service
service_type: dns
has_admin_guide: true
has_api_ref: true
has_user_guide: true
has_install_guide: true
has_config_ref: true
type: service
- name: python-designateclient
service: DNS service Python Bindings
type: service-client
description: designate client
has_install_guide: true
has_user_guide: true
- name: ec2-api
service: EC2 API compatibility layer
service_type: ec2-api
has_api_ref: true
has_install_guide: true
has_config_ref: true
type: service
- name: barbican
service: Key Manager service
service_type: key-manager
has_api_guide: true
has_in_tree_api_docs: true
has_install_guide: true
has_admin_guide: true
has_config_ref: true
type: service
- name: python-barbicanclient
service: Key Manager service Python Bindings
type: service-client
description: barbican client
has_install_guide: true
- name: zaqar
service: Messaging service
service_type: message
has_admin_guide: true
has_api_ref: true
has_install_guide: true
has_user_guide: true
has_config_ref: true
type: service
- name: python-zaqarclient
service: Messaging service Python Bindings
type: service-client
description: zaqar client
- name: swift
service: Object Storage service
service_type: object-store
has_admin_guide: true
has_install_guide: true
has_api_ref: true
type: service
- name: python-swiftclient
service: Object Storage service Python Bindings
type: service-client
description: swift client
- name: heat
service: Orchestration service
service_type: orchestration
has_in_tree_api_docs: true
has_api_ref: true
has_install_guide: true
has_admin_guide: true
has_config_ref: true
has_in_tree_htaccess: true
type: service
- name: python-heatclient
service: Orchestration service Python Bindings
type: service-client
description: heat client
- name: heat-translator
type: tool
service: Translate non-heat templates to heat Orchestration Template
#- name: tosca-parser
# type: tool
# service: Parser for TOSCA Simple Profile in YAML
- name: manila
service: Shared File Systems service
service_type: shared-file-system
has_admin_guide: true
has_api_ref: true
has_config_ref: true
has_install_guide: true
has_user_guide: true
type: service
- name: python-manilaclient
service: Shared File Systems service Python Bindings
type: service-client
description: manila client
#- name: aodh
# service: Telemetry Alarming services
# service_type: alarm
# has_install_guide: true
# has_admin_guide: true
# has_config_ref: true
# type: service
- name: python-aodhclient
service: Telemetry Alarming service Python Bindings
type: service-client
description: aodh client
- name: ceilometer
service: Telemetry Data Collection service
service_type: meter
has_admin_guide: true
has_install_guide: true
has_config_ref: true
type: service
#- name: requirements
# service: Global requirements for OpenStack
# type: tool
- name: sahara
service: Data Processing service
service_type: data-processing
has_admin_guide: true
has_api_ref: true
has_config_ref: true
has_install_guide: true
has_user_guide: true
has_in_tree_htaccess: true
type: service
- name: python-saharaclient
service: Data Processing service Python Bindings
type: service-client
description: sahara client
- name: watcher
service: Infrastructure Optimization service
service_type: resource-optimization
type: service
has_install_guide: true
has_admin_guide: true
has_user_guide: true
has_config_ref: true
has_api_ref: true
#- name: python-watcherclient
# service: Infrastructure Optimization service Python Bindings
# type: service-client
# description: watcher client
#- name: mistral
# service: Workflow service
# service_type: workflow
# type: service
# has_admin_guide: true
#- name: python-mistralclient
# service: Workflow service Python Bindings
# type: service-client
# description: mistral client
- name: murano
service: Application Catalog service
service_type: application-catalog
type: service
has_install_guide: true
has_api_ref: true
has_admin_guide: true
has_config_ref: true
- name: python-muranoclient
service: Application Catalog service Python Bindings
type: service-client
description: murano client
- name: senlin
service: Clustering service
service_type: clustering
type: service
has_install_guide: true
has_api_ref: true
has_admin_guide: true
has_config_ref: true
- name: python-senlinclient
service: Clustering service Python Bindings
type: service-client
description: senlin client
#- name: storlets
# service: Compute inside Object Storage service
# type: other
- name: zun
service: Containers service
service_type: application-container
has_admin_guide: true
has_api_ref: true
has_install_guide: true
has_config_ref: true
type: service
- name: python-zunclient
service: Containers service Python Bindings
has_install_guide: true
type: service-client
description: zun client
- name: tacker
service: NFV Orchestration service
service_type: nfv-orchestration
has_admin_guide: true
has_api_ref: true
has_install_guide: true
has_config_ref: true
has_user_guide: true
type: service
#- name: python-tackerclient
# service: NFV Orchestration service Python Bindings
# type: service-client
# description: tacker client
- name: cloudkitty
service: Rating service
service_type: rating
type: service
has_api_ref: true
has_admin_guide: true
has_user_guide: true
- name: python-cloudkittyclient
service: Rating service Python Bindings
type: service-client
description: cloudkitty client
#- name: vitrage
# service: RCA (Root Cause Analysis) service
# service_type: root-cause-analysis
# has_config_ref: true
# has_install_guide: true
# type: service
- name: python-vitrageclient
service: RCA (Root Cause Analysis) service Python Bindings
type: service-client
description: vitrage client
- name: automaton
service: Friendly state machines for Python.
type: library
has_install_guide: true
has_user_guide: true
- name: castellan
service: Key Manager interface abstraction
type: library
has_install_guide: true
has_user_guide: true
#- name: debtcollector
# type: library
# service:
# A collection of Python deprecation patterns and strategies that
# help you collect your technical debt in a non-destructive manner.
# has_install_guide: true
# has_user_guide: true
#- name: futurist
# type: library
# service:
# Asynchronous code from the future, helping you build out your
# applications to handle asynchronous and periodic work in a nice
# manner.
# has_install_guide: true
# has_user_guide: true
- name: oslo.cache
type: library
service: Cache management library.
has_config_ref: true
has_install_guide: true
has_user_guide: true
- name: oslo.concurrency
type: library
service: External process management and task synchronization.
has_user_guide: true
has_install_guide: true
has_config_ref: true
- name: oslo.config
type: library
service: Configuration option parsing from the command line or configuration files.
has_config_ref: true
- name: oslo.context
type: library
service: Helpers to maintain useful information about a request context.
has_install_guide: true
has_user_guide: true
- name: oslo.db
type: library
service: Database connectivity.
has_install_guide: true
has_user_guide: true
- name: oslo.i18n
type: library
service: Internationalization and translation.
has_user_guide: true
- name: oslo.log
type: library
service: A logging configuration library.
has_config_ref: true
has_install_guide: true
has_admin_guide: true
has_user_guide: true
- name: oslo.messaging
type: library
service: Inter-process communication.
has_admin_guide: true
has_user_guide: true
has_config_ref: true
- name: oslo.middleware
type: library
service: WSGI middleware library for web service development.
has_config_ref: true
has_install_guide: true
has_admin_guide: true
#- name: oslo.policy
# type: library
# service: Common policy enforcement.
# has_install_guide: true
# has_admin_guide: true
# has_config_ref: true
# has_user_guide: true
- name: oslo.privsep
type: library
service: library for privilege separation
has_install_guide: true
has_user_guide: true
- name: oslo.reports
type: library
service: Error report framework for projects.
has_install_guide: true
has_user_guide: true
- name: oslo.rootwrap
type: library
service: Fine filtering of shell commands to run as root.
has_install_guide: true
has_user_guide: true
- name: oslo.serialization
type: library
service: Serialization with special handling for some common types.
has_install_guide: true
has_user_guide: true
- name: oslo.service
type: library
service: Library for running and managing OpenStack services.
has_config_ref: true
has_install_guide: true
has_user_guide: true
- name: oslo.upgradecheck
type: library
service: Library of common code for upgrade checks.
- name: oslo.utils
type: library
service: Library of common low-level utility modules.
has_install_guide: true
has_user_guide: true
#- name: oslo.versionedobjects
# type: library
# service: Database and RPC object schema versioning.
# has_install_guide: true
# has_config_ref: true
# has_user_guide: true
- name: oslo.vmware
type: library
service: Common functionality required by VMware drivers in several projects.
has_install_guide: true
has_user_guide: true
#- name: oslotest
# type: library
# service: Unit test and fixture framework.
# has_install_guide: true
# has_user_guide: true
#- name: osprofiler
# type: library
# service: Cross-Project profiling library.
# has_user_guide: true
#- name: pbr
# type: library
# service: Manages setuptools packaging needs in a consistent way.
# has_user_guide: true
- name: stevedore
type: library
service: Manages dynamic plug-ins for Python applications.
has_install_guide: true
has_user_guide: true
- name: taskflow
type: library
service: Makes task execution easy, consistent, and reliable.
has_user_guide: true
#- name: tooz
# type: library
# service:
# Distributed primitives like group membership protocol, lock
# service and leader elections.
# has_user_guide: true
# has_install_guide: true
- name: octavia
service: Load-balancer service
service_type: load-balancer
has_install_guide: true
has_api_ref: true
has_config_ref: true
has_admin_guide: true
type: service
has_user_guide: true
- name: python-octaviaclient
service: Load-balancer service client
type: service-client
description: octavia client
- name: blazar
service: Resource reservation service
service_type: reservation
has_api_ref: true
has_install_guide: true
has_config_ref: true
has_admin_guide: true
has_user_guide: true
type: service
#- name: monasca-api
# service: Monitoring service
# type: service
# service_type: monitoring
# has_api_ref: false
# has_install_guide: false
# has_config_ref: false
# has_admin_guide: false
# has_user_guide: true
#- name: python-monascaclient
# service: Monitoring service client
# type: service-client
# description: monasca client
- name: python-openstackclient
service: Command line interface to OpenStack
type: cloud-client
description: OpenStack client
has_config_ref: true
- name: cliff
service: Builds command-line programs in Python.
type: library
has_install_guide: true
has_user_guide: true
#- name: os-client-config
# service: Library for collecting client configuration for using an OpenStack cloud
# type: library
# has_install_guide: true
# has_user_guide: true
- name: openstacksdk
service: Client library for building applications to work with OpenStack clouds
type: cloud-client
description: openstacksdk client library
has_install_guide: true
has_user_guide: true
#- name: solum
# service: Software Development Lifecycle Automation service
# service_type: application-deployment
# has_install_guide: true
# has_admin_guide: true
# has_config_ref: true
# has_user_guide: true
# type: service
#- name: python-solumclient
# service: Software Development Lifecycle Automation client
# type: service-client
# description: solum client
#- name: openstackdocstheme
# service: Theme and extension support for Sphinx documentation for official projects
# type: library
#- name: os-api-ref
# service: Sphinx extension to support OpenStack API reference pages creation
# type: library
#- name: coverage2sql
# service: Tooling for converting coverage data into a SQL DB
# type: tool
#- name: diskimage-builder
# service: Image building tools for OpenStack
# type: tool
#- name: devstack
# service: DevStack
# type: tool
#- name: os-testr
# service: Tooling for interacting with testr
# type: tool
#- name: pymod2pkg
# service: Python module name to package name map
# type: tool
#- name: renderspec
# service: RPM .spec template renderer
# type: tool
#- name: reno
# service: Release Notes Manager
# type: tool
# has_install_guide: true
# has_user_guide: true
#- name: tempest
# service: Tempest Test Suite for OpenStack
# type: tool
#- name: bashate
# service: Linter for bash scripts.
# type: tool
# has_install_guide: true
# has_user_guide: true
#- name: grenade
# service: Test harness to exercise the upgrade process between releases.
# type: tool
#- name: hacking
# service: Hacking guideline enforcement
# type: tool
#- name: kolla
# type: deployment
# service: Providing production-ready containers and deployment tools for operating OpenStack clouds
# has_admin_guide: true
#- name: kolla-ansible
# service: Deploying OpenStack using Ansible in Docker Containers (kolla)
# type: deployment
# has_admin_guide: true
# has_user_guide: true
# has_deployment_guide: true
#- name: openstack-ansible
# type: deployment
# service: OpenStack-Ansible Deployment (in LXC Containers or on Bare Metal)
# has_admin_guide: true
# has_user_guide: true
# has_deployment_guide: true
#- name: puppet-openstack-guide
# type: deployment
# service: Puppet modules for deployment
# has_install_guide: true
#- name: i18n
# type: other
# service: Internationalization of OpenStack projects and documents
- name: kuryr
service: Bridge between container framework and OpenStack abstractions
type: service
#- name: charm-guide
# type: deployment
# service: OpenStack Charm Guide
# has_admin_guide: true
# has_in_tree_htaccess: true
#- name: charm-deployment-guide
# type: deployment
# service: OpenStack Charms Deployment
# has_deployment_guide: true
# has_in_tree_htaccess: true
# has_project_guide: false
#- name: openstack-chef
# service: Chef OpenStack Deployment
# type: deployment
# has_deployment_guide: true
#- name: masakari
# service: Instances High Availability Service
# service_type: instance-ha
# type: service
# has_api_ref: true
# has_config_ref: true
# has_install_guide: true
#- name: python-masakariclient
# service: Instances High Availability Client
# type: service-client
# description: masakari client
# has_install_guide: true
- name: freezer
service: Backup, Restore, and Disaster Recovery service
service_type: backup
type: service
has_admin_guide: true
has_api_ref: true
has_install_guide: true
has_user_guide: true
#- name: cyborg
# service: Accelerator Life Cycle Management
# service_type: accelerator
# type: service
# has_api_ref: true
# has_config_ref: true
# has_admin_guide: true
#- name: adjutant
# service: Operations Processes Automation
# service_type: admin-logic
# type: service
# has_api_ref: true
- name: venus
service: Log Management Service
service_type: log-management
type: service
has_api_ref: true
has_config_ref: false
has_admin_guide: false
# Projects that do not appear in the service-types-authority list:
# - kuryr