OpenStack Interoperability Guideline 2017.09

Status

approved

Replaces

2017.01

JSON Master

https://opendev.org/openinfra/interop/raw/branch/master/guidelines/2017.09.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 master JSON version.

Releases Covered

Applies to Mitaka, Newton, Ocata, Pike

Platform Components

Required

Compute, Object

Advisory

None

Deprecated

None

Removed

None

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-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-list-projects (Keystone)

  • identity-v3-tokens-create (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-security-groups-CRUD (Neutron)

  • networks-subnet-pools-CRUD (Neutron)

  • 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-reserve (Cinder)

  • volumes-v2-readonly (Cinder)

  • volumes-v2-upload (Cinder)

Advisory Capabilities

  • networks-l3-router (Neutron)

  • networks-l3-CRUD (Neutron)

  • networks-list-api-versions (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-reserve (Cinder)

  • volumes-v3-readonly (Cinder)

Deprecated Capabilities

  • volumes-v2-attach-detach (Cinder)

  • volumes-v3-attach-detach (Cinder)

Removed Capabilities

None

Object 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-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

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 allowed on Nova 2.0 API responses.

  • Swift : Designated sections are proxy server, object server, container server, account server and select middleware

Advisory Designated Sections

None

Deprecated Designated Sections

  • Keystone : Designation is outlined per API grouping.

Removed Designated Sections

None