From 791c95309eebd12fcabb85ecde5b545584226646 Mon Sep 17 00:00:00 2001 From: Martin Kopec Date: Thu, 16 Sep 2021 18:13:37 +0000 Subject: [PATCH] Add documented guidelines 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 --- doc/source/guidelines/all.2018.11.rst | 347 +++++++++++++++++++++ doc/source/guidelines/all.2019.06.rst | 349 +++++++++++++++++++++ doc/source/guidelines/all.2019.11.rst | 336 ++++++++++++++++++++ doc/source/guidelines/all.2020.06.rst | 336 ++++++++++++++++++++ doc/source/guidelines/all.2020.11.rst | 412 +++++++++++++++++++++++++ doc/source/guidelines/all.next.rst | 426 ++++++++++++++++++++++++++ zuul.d/projects.yaml | 8 +- 7 files changed, 2209 insertions(+), 5 deletions(-) create mode 100644 doc/source/guidelines/all.2018.11.rst create mode 100644 doc/source/guidelines/all.2019.06.rst create mode 100644 doc/source/guidelines/all.2019.11.rst create mode 100644 doc/source/guidelines/all.2020.06.rst create mode 100644 doc/source/guidelines/all.2020.11.rst create mode 100644 doc/source/guidelines/all.next.rst diff --git a/doc/source/guidelines/all.2018.11.rst b/doc/source/guidelines/all.2018.11.rst new file mode 100644 index 00000000..daf9709b --- /dev/null +++ b/doc/source/guidelines/all.2018.11.rst @@ -0,0 +1,347 @@ +============================================ +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 ``_. + +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 ``_. + +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 diff --git a/doc/source/guidelines/all.2019.06.rst b/doc/source/guidelines/all.2019.06.rst new file mode 100644 index 00000000..5bf9a9e2 --- /dev/null +++ b/doc/source/guidelines/all.2019.06.rst @@ -0,0 +1,349 @@ +============================================ +OpenStack Interoperability Guideline 2019.06 +============================================ + +:Status: superseded +:Replaces: 2018.11 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/guidelines/2019.06.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 `<2019.06.json>`_. + +Releases Covered +============================== +Applies to Queens, Rocky, Stein, Train + + + + + +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-create-multiple (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-delete (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) +* volumes-v3-upload (Cinder) + +Advisory Capabilities +----------------------- +None + +Deprecated Capabilities +------------------------- +None + +Removed 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) + + + + +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) +* identity-v3-tokens-delete (Keystone) + +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 +---------------------------- + +* 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.2019.06 +================================================ + +:Status: superseded +:Replaces: dns.2018.11 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/dns.2019.06.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 ``_. + +Releases Covered +============================== +Applies to Queens, Rocky, Stein, Train + + + + + +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.2019.06 +========================================================== + +:Status: superseded +:Replaces: orchestration.2018.11 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/orchestration.2019.06.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 ``_. + +Releases Covered +============================== +Applies to Queens, Rocky, Stein, Train + + + + + +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 diff --git a/doc/source/guidelines/all.2019.11.rst b/doc/source/guidelines/all.2019.11.rst new file mode 100644 index 00000000..dad22a4e --- /dev/null +++ b/doc/source/guidelines/all.2019.11.rst @@ -0,0 +1,336 @@ +============================================ +OpenStack Interoperability Guideline 2019.11 +============================================ + +:Status: approved +:Replaces: 2019.06 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/guidelines/2019.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 `<2019.11.json>`_. + +Releases Covered +============================== +Applies to Rocky, Stein, Train, Ussuri + + + + + +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-create-multiple (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-delete (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) +* volumes-v3-upload (Cinder) + +Advisory Capabilities +----------------------- +None + +Deprecated Capabilities +------------------------- +None + +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) +* identity-v3-tokens-delete (Keystone) + +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 +---------------------------- + +* 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.2019.11 +================================================ + +:Status: approved +:Replaces: dns.2019.06 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/dns.2019.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 ``_. + +Releases Covered +============================== +Applies to Rocky, Stein, Train, Ussuri + + + + + +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.2019.11 +========================================================== + +:Status: approved +:Replaces: orchestration.2019.06 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/orchestration.2019.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 ``_. + +Releases Covered +============================== +Applies to Rocky, Stein, Train, Ussuri + + + + + +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 diff --git a/doc/source/guidelines/all.2020.06.rst b/doc/source/guidelines/all.2020.06.rst new file mode 100644 index 00000000..14ba8c11 --- /dev/null +++ b/doc/source/guidelines/all.2020.06.rst @@ -0,0 +1,336 @@ +============================================ +OpenStack Interoperability Guideline 2020.06 +============================================ + +:Status: superseded +:Replaces: 2019.11 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/guidelines/2020.06.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 `<2020.06.json>`_. + +Releases Covered +============================== +Applies to Stein, Train, Ussuri, Victoria + + + + + +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-create-multiple (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-delete (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) +* volumes-v3-upload (Cinder) + +Advisory Capabilities +----------------------- +None + +Deprecated Capabilities +------------------------- +None + +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) +* identity-v3-tokens-delete (Keystone) + +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 +---------------------------- + +* 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.2020.06 +================================================ + +:Status: superseded +:Replaces: dns.2019.11 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/dns.2020.06.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 ``_. + +Releases Covered +============================== +Applies to Stein, Train, Ussuri, Victoria + + + + + +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.2020.06 +========================================================== + +:Status: superseded +:Replaces: orchestration.2019.11 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/orchestration.2020.06.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 ``_. + +Releases Covered +============================== +Applies to Stein, Train, Ussuri, Victoria + + + + + +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 diff --git a/doc/source/guidelines/all.2020.11.rst b/doc/source/guidelines/all.2020.11.rst new file mode 100644 index 00000000..4e09224e --- /dev/null +++ b/doc/source/guidelines/all.2020.11.rst @@ -0,0 +1,412 @@ +============================================ +OpenStack Interoperability Guideline 2020.11 +============================================ + +:Status: approved +:Replaces: 2020.06 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/guidelines/2020.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 `<2020.11.json>`_. + +Releases Covered +============================== +Applies to Train, Ussuri, Victoria, Wallaby + + + + + +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-create-multiple (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-delete (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) +* volumes-v3-upload (Cinder) + +Advisory Capabilities +----------------------- +None + +Deprecated Capabilities +------------------------- +None + +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) +* identity-v3-tokens-delete (Keystone) + +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 +---------------------------- + +* 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.2020.11 +================================================ + +:Status: approved +:Replaces: dns.2020.06 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/dns.2020.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 ``_. + +Releases Covered +============================== +Applies to Train, Ussuri, Victoria, Wallaby + + + + + +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.2020.11 +========================================================== + +:Status: approved +:Replaces: orchestration.2020.06 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/orchestration.2020.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 ``_. + +Releases Covered +============================== +Applies to Train, Ussuri, Victoria, Wallaby + + + + + +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 +=============================================================== +OpenStack Interoperability Guideline shared_file_system.2020.11 +=============================================================== + +:Status: approved +:Replaces: None +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/shared_file_system.2020.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 ``_. + +Releases Covered +============================== +Applies to Train, Ussuri, Victoria, Wallaby + + + + + +Os_powered_shared_file_system Component Capabilities +==================================================== +Required Capabilities +----------------------- +* share-list-api-versions (Manila) +* share-create-delete (Manila) +* share-get (Manila) +* share-list (Manila) +* share-update (Manila) +* share-extend (Manila) +* share-shrink (Manila) +* share-network-create-delete (Manila) +* share-network-update (Manila) +* share-network-get (Manila) +* share-network-list (Manila) + +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 +---------------------------- + +* Manila : The Shared File Systems v2 API (with microversions) is designated + +Advisory Designated Sections +---------------------------- + +None + +Deprecated Designated Sections +------------------------------ + +None + +Removed Designated Sections +--------------------------- + +None diff --git a/doc/source/guidelines/all.next.rst b/doc/source/guidelines/all.next.rst new file mode 100644 index 00000000..a4a72277 --- /dev/null +++ b/doc/source/guidelines/all.next.rst @@ -0,0 +1,426 @@ +========================================= +OpenStack Interoperability Guideline next +========================================= + +:Status: draft +:Replaces: 2020.11 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/guidelines/next.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 ``_. + +Releases Covered +============================== +Applies to Ussuri, Victoria, Wallaby, Xena + + + + + +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-create-multiple (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-delete (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) +* volumes-v3-upload (Cinder) + +Advisory Capabilities +----------------------- +* identity-v3-list-versions (Keystone) +* identity-v3-application-credentials (Keystone) +* identity-v3-users (Keystone) +* identity-v3-domains (Keystone) +* volumes-v3-snapshots-list (Cinder) +* compute-images-metadata-delete (Nova) +* compute-images-metadata-get (Nova) +* compute-images-metadata-list (Nova) +* compute-images-metadata-set (Nova) +* compute-images-metadata-update (Nova) +* networks-security-groups-CRUD-2 (Neutron) +* networks-dhcp (Neutron) +* networks-floating-ips-CRUD (Neutron) +* images-v2-import (Glance) + +Deprecated Capabilities +------------------------- +None + +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) +* identity-v3-tokens-delete (Keystone) + +Advisory Capabilities +----------------------- +* objectstore-account-update (Swift) +* objectstore-bulk (Swift) + +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.next +============================================= + +:Status: draft +:Replaces: dns.2020.11 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/dns.next.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 ``_. + +Releases Covered +============================== +Applies to Ussuri, Victoria, Wallaby, Xena + + + + + +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.next +======================================================= + +:Status: draft +:Replaces: orchestration.2020.11 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/orchestration.next.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 ``_. + +Releases Covered +============================== +Applies to Ussuri, Victoria, Wallaby, Xena + + + + + +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 +============================================================ +OpenStack Interoperability Guideline shared_file_system.next +============================================================ + +:Status: draft +:Replaces: 2020.11 +:JSON Master: https://opendev.org/openinfra/interop/raw/branch/master/add-ons/guidelines/shared_file_system.next.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 ``_. + +Releases Covered +============================== +Applies to Ussuri, Victoria, Wallaby, Xena + + + + + +Os_powered_shared_file_system Component Capabilities +==================================================== +Required Capabilities +----------------------- +* share-list-api-versions (Manila) +* share-create-delete (Manila) +* share-get (Manila) +* share-list (Manila) +* share-update (Manila) +* share-extend (Manila) +* share-shrink (Manila) +* share-network-create-delete (Manila) +* share-network-update (Manila) +* share-network-get (Manila) +* share-network-list (Manila) + +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 +---------------------------- + +* Manila : The Shared File Systems v2 API (with microversions) is designated + +Advisory Designated Sections +---------------------------- + +None + +Deprecated Designated Sections +------------------------------ + +None + +Removed Designated Sections +--------------------------- + +None diff --git a/zuul.d/projects.yaml b/zuul.d/projects.yaml index e12aadd1..169ee32b 100644 --- a/zuul.d/projects.yaml +++ b/zuul.d/projects.yaml @@ -3,15 +3,14 @@ - build-openstack-docs-pti check: jobs: - - openstack-tox-pep8: + - openstack-tox-pep8 + - interop-tempest-consistency: # Define a list of irrelevant files to use everywhere else irrelevant-files: &interop-irrelevant-files - ^.*\.rst$ - ^doc/.*$ - ^.gitignore$ - ^.gitreview$ - - interop-tempest-consistency: - irrelevant-files: *interop-irrelevant-files # TODO(kopecmartin) master job has issues with ensure-tox role atm # which we will figure out in a following patch. Let's comment out # the job now so that it doesn't block us @@ -27,7 +26,6 @@ irrelevant-files: *interop-irrelevant-files gate: jobs: - - openstack-tox-pep8: - irrelevant-files: *interop-irrelevant-files + - openstack-tox-pep8 - interop-tempest-consistency: irrelevant-files: *interop-irrelevant-files