791c95309e
Document latest guidelines / convert them from .json to .rst so that they can be included in the documentation. The patch converts all guidelines since 2018 when this convert happend for the last time. The patch also enables pep8 job on doc changes as there is a .rst check implemented within tox' pep8 env. Change-Id: I8a65dfb15c5572bedf1bbf36bfa2143df47010bb
348 lines
9.1 KiB
ReStructuredText
348 lines
9.1 KiB
ReStructuredText
============================================
|
|
OpenStack Interoperability Guideline 2018.11
|
|
============================================
|
|
|
|
:Status: superseded
|
|
:Replaces: 2018.02
|
|
:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/guidelines/2018.11.json
|
|
|
|
This document outlines the mandatory capabilities and designated
|
|
sections required to exist in a software installation in order to
|
|
be eligible to use marks controlled by the OpenStack Foundation.
|
|
|
|
This document was generated from the `<2018.11.json>`_.
|
|
|
|
Releases Covered
|
|
==============================
|
|
Applies to Ocata, Pike, Queens, Rocky, Stein
|
|
|
|
|
|
|
|
|
|
|
|
Os_powered_compute Component Capabilities
|
|
=========================================
|
|
Required Capabilities
|
|
-----------------------
|
|
* compute-availability-zones-list (Nova)
|
|
* compute-flavors-list (Nova)
|
|
* compute-images-create (Nova)
|
|
* compute-instance-actions-get (Nova)
|
|
* compute-instance-actions-list (Nova)
|
|
* compute-keypairs-create (Nova)
|
|
* compute-keypairs-create-type (Nova)
|
|
* compute-list-api-versions (Nova)
|
|
* compute-quotas-get (Nova)
|
|
* compute-servers-create (Nova)
|
|
* compute-servers-delete (Nova)
|
|
* compute-servers-get (Nova)
|
|
* compute-servers-host (Nova)
|
|
* compute-servers-invalid (Nova)
|
|
* compute-servers-list (Nova)
|
|
* compute-servers-lock (Nova)
|
|
* compute-servers-name (Nova)
|
|
* compute-servers-reboot (Nova)
|
|
* compute-servers-rebuild (Nova)
|
|
* compute-servers-resize (Nova)
|
|
* compute-servers-stop (Nova)
|
|
* compute-servers-update (Nova)
|
|
* compute-servers-verify (Nova)
|
|
* compute-servers-metadata-delete (Nova)
|
|
* compute-servers-metadata-get (Nova)
|
|
* compute-servers-metadata-list (Nova)
|
|
* compute-servers-metadata-set (Nova)
|
|
* compute-servers-metadata-update (Nova)
|
|
* compute-volume-attach (Nova)
|
|
* identity-v3-api-discovery (Keystone)
|
|
* identity-v3-catalog (Keystone)
|
|
* identity-v3-list-projects (Keystone)
|
|
* identity-v3-tokens-create (Keystone)
|
|
* identity-v3-tokens-validate (Keystone)
|
|
* images-v2-index (Glance)
|
|
* images-v2-update (Glance)
|
|
* images-v2-list (Glance)
|
|
* images-v2-delete (Glance)
|
|
* images-v2-get (Glance)
|
|
* networks-l2-CRUD (Neutron)
|
|
* networks-l3-router (Neutron)
|
|
* networks-l3-CRUD (Neutron)
|
|
* networks-list-api-versions (Neutron)
|
|
* networks-security-groups-CRUD (Neutron)
|
|
* networks-subnet-pools-CRUD (Neutron)
|
|
* volumes-list-api-versions (Cinder)
|
|
* volumes-v3-create-delete (Cinder)
|
|
* volumes-v3-snapshot-create-delete (Cinder)
|
|
* volumes-v3-get (Cinder)
|
|
* volumes-v3-list (Cinder)
|
|
* volumes-v3-update (Cinder)
|
|
* volumes-v3-copy-image-to-volume (Cinder)
|
|
* volumes-v3-clone (Cinder)
|
|
* volumes-v3-availability-zones (Cinder)
|
|
* volumes-v3-extensions (Cinder)
|
|
* volumes-v3-metadata (Cinder)
|
|
* volumes-v3-readonly (Cinder)
|
|
|
|
Advisory Capabilities
|
|
-----------------------
|
|
* volumes-v3-upload (Cinder)
|
|
* compute-servers-create-multiple (Nova)
|
|
* identity-v3-tokens-delete (Keystone)
|
|
|
|
Deprecated Capabilities
|
|
-------------------------
|
|
* volumes-v2-reserve (Cinder)
|
|
* volumes-v3-reserve (Cinder)
|
|
* volumes-v2-create-delete (Cinder)
|
|
* volumes-v2-snapshot-create-delete (Cinder)
|
|
* volumes-v2-get (Cinder)
|
|
* volumes-v2-list (Cinder)
|
|
* volumes-v2-update (Cinder)
|
|
* volumes-v2-copy-image-to-volume (Cinder)
|
|
* volumes-v2-clone (Cinder)
|
|
* volumes-v2-availability-zones (Cinder)
|
|
* volumes-v2-extensions (Cinder)
|
|
* volumes-v2-metadata (Cinder)
|
|
* volumes-v2-readonly (Cinder)
|
|
* volumes-v2-upload (Cinder)
|
|
|
|
Removed Capabilities
|
|
----------------------
|
|
None
|
|
|
|
|
|
|
|
|
|
Os_powered_storage Component Capabilities
|
|
=========================================
|
|
Required Capabilities
|
|
-----------------------
|
|
* objectstore-account-quotas (Swift)
|
|
* objectstore-account-list (Swift)
|
|
* objectstore-container-acl (Swift)
|
|
* objectstore-container-quotas (Swift)
|
|
* objectstore-container-create (Swift)
|
|
* objectstore-container-delete (Swift)
|
|
* objectstore-container-list (Swift)
|
|
* objectstore-container-metadata (Swift)
|
|
* objectstore-dlo-support (Swift)
|
|
* objectstore-slo-support (Swift)
|
|
* objectstore-info-request (Swift)
|
|
* objectstore-object-copy (Swift)
|
|
* objectstore-object-create (Swift)
|
|
* objectstore-object-delete (Swift)
|
|
* objectstore-object-get (Swift)
|
|
* objectstore-object-versioned (Swift)
|
|
* objectstore-temp-url-get (Swift)
|
|
* objectstore-temp-url-put (Swift)
|
|
* identity-v3-tokens-create (Keystone)
|
|
|
|
Advisory Capabilities
|
|
-----------------------
|
|
* identity-v3-tokens-delete (Keystone)
|
|
|
|
Deprecated Capabilities
|
|
-------------------------
|
|
None
|
|
|
|
Removed Capabilities
|
|
----------------------
|
|
None
|
|
|
|
|
|
Designated Sections
|
|
=====================================
|
|
|
|
The following designated sections apply to the same releases as
|
|
this specification.
|
|
|
|
Required Designated Sections
|
|
----------------------------
|
|
|
|
* Cinder : Designated sections are the API implementation code
|
|
* Glance : Designated sections are the API implementation code and domain
|
|
model.
|
|
* Keystone : Designation is outlined per API grouping. Identity (user and
|
|
group) management APIs will not be designated. API access (with exception of
|
|
auth) may be prohibited by policy (resulting in HTTP 403). Designated APIs
|
|
include v3 version where applicable.
|
|
* Neutron : By default, designated for all code backing required capabilities
|
|
except pluggable components such as plugins, drivers, and API extensions
|
|
other than those listed below.
|
|
* Nova : By default, designated except scheduler, filter, drivers, API
|
|
extensions and networking. Additional properties on responses are not
|
|
allowed.
|
|
* Swift : Designated sections are proxy server, object server, container
|
|
server, account server and select middleware
|
|
|
|
Advisory Designated Sections
|
|
----------------------------
|
|
|
|
None
|
|
|
|
Deprecated Designated Sections
|
|
------------------------------
|
|
|
|
None
|
|
|
|
Removed Designated Sections
|
|
---------------------------
|
|
|
|
None
|
|
================================================
|
|
OpenStack Interoperability Guideline dns.2018.11
|
|
================================================
|
|
|
|
:Status: superseded
|
|
:Replaces: None
|
|
:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/dns.2018.11.json
|
|
|
|
This document outlines the mandatory capabilities and designated
|
|
sections required to exist in a software installation in order to
|
|
be eligible to use marks controlled by the OpenStack Foundation.
|
|
|
|
This document was generated from the `<dns.2018.11.json>`_.
|
|
|
|
Releases Covered
|
|
==============================
|
|
Applies to Ocata, Pike, Queens, Rocky, Stein
|
|
|
|
|
|
|
|
|
|
|
|
Os_powered_dns Component Capabilities
|
|
=====================================
|
|
Required Capabilities
|
|
-----------------------
|
|
* dns-record-crud (Designate)
|
|
* dns-zone-crud (Designate)
|
|
|
|
Advisory Capabilities
|
|
-----------------------
|
|
None
|
|
|
|
Deprecated Capabilities
|
|
-------------------------
|
|
None
|
|
|
|
Removed Capabilities
|
|
----------------------
|
|
None
|
|
|
|
|
|
Designated Sections
|
|
=====================================
|
|
|
|
The following designated sections apply to the same releases as
|
|
this specification.
|
|
|
|
Required Designated Sections
|
|
----------------------------
|
|
|
|
* Designate : API and Central code, allowing for plugins and excluding storage
|
|
and scheduler filters
|
|
|
|
Advisory Designated Sections
|
|
----------------------------
|
|
|
|
None
|
|
|
|
Deprecated Designated Sections
|
|
------------------------------
|
|
|
|
None
|
|
|
|
Removed Designated Sections
|
|
---------------------------
|
|
|
|
None
|
|
==========================================================
|
|
OpenStack Interoperability Guideline orchestration.2018.11
|
|
==========================================================
|
|
|
|
:Status: superseded
|
|
:Replaces: orchestration.2018.02
|
|
:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/orchestration.2018.11.json
|
|
|
|
This document outlines the mandatory capabilities and designated
|
|
sections required to exist in a software installation in order to
|
|
be eligible to use marks controlled by the OpenStack Foundation.
|
|
|
|
This document was generated from the `<orchestration.2018.11.json>`_.
|
|
|
|
Releases Covered
|
|
==============================
|
|
Applies to Ocata, Pike, Queens, Rocky, Stein
|
|
|
|
|
|
|
|
|
|
|
|
Os_powered_orchestration Component Capabilities
|
|
===============================================
|
|
Required Capabilities
|
|
-----------------------
|
|
* stack-create (Heat)
|
|
* stack-delete (Heat)
|
|
* stack-environment-parameter (Heat)
|
|
* stack-event (Heat)
|
|
* stack-hook (Heat)
|
|
* stack-list (Heat)
|
|
* stack-output (Heat)
|
|
* stack-preview (Heat)
|
|
* stack-list-resources (Heat)
|
|
* stack-list-resource-types (Heat)
|
|
* stack-list-template-functions (Heat)
|
|
* stack-list-template-versions (Heat)
|
|
* stack-mark-resource-unhealthy (Heat)
|
|
* stack-resource-type-template (Heat)
|
|
* stack-show (Heat)
|
|
* stack-show-resource (Heat)
|
|
* stack-show-resource-type (Heat)
|
|
* stack-show-unhealthy-resource (Heat)
|
|
* stack-signal-resource (Heat)
|
|
* stack-software-config (Heat)
|
|
* stack-tag (Heat)
|
|
* stack-template (Heat)
|
|
* stack-update (Heat)
|
|
|
|
Advisory Capabilities
|
|
-----------------------
|
|
None
|
|
|
|
Deprecated Capabilities
|
|
-------------------------
|
|
None
|
|
|
|
Removed Capabilities
|
|
----------------------
|
|
None
|
|
|
|
|
|
Designated Sections
|
|
=====================================
|
|
|
|
The following designated sections apply to the same releases as
|
|
this specification.
|
|
|
|
Required Designated Sections
|
|
----------------------------
|
|
|
|
* Heat : Must at a minimum include resources for OpenStack Powered Compute
|
|
components.
|
|
|
|
Advisory Designated Sections
|
|
----------------------------
|
|
|
|
None
|
|
|
|
Deprecated Designated Sections
|
|
------------------------------
|
|
|
|
None
|
|
|
|
Removed Designated Sections
|
|
---------------------------
|
|
|
|
None
|