5. Interfaces and APIs¶
This chapter presents a consolidated set of OpenStack Service APIs corresponding to the ETSI NFV Nf-Vi, Vi-Vnfm and Or-Vi interfaces. The OpenStack Wallaby version is used as the baseline for these APIs and CLIs in this Reference Architecture (RA-1) version. Any Cloud Infrastructure + VIM reference implementations that get certified by RC (Reference Conformance) can be considered as Anuket RA Conformant.
The Chapter presents the APIs for the core OpenStack services defined in Chapter 3 and a consolidated view of these and other APIs that are of interest.
OpenStack is a multi-project framework composed of independently evolving services. It is not enough to rely only on the OpenStack release to characterise the capabilities supported by these services. Regarding OpenStack services APIs, an “API version” is associated with each OpenStack service. In addition to major API versions, some OpenStack services (Nova, Glance, Keystone, Cinder…) support microversions. The microversions allow new features to be introduced over time. In this chapter, the major version and microversion are specified per service. The specified microversion is the minimal microversion that supports the features requested for this RA. For the purpose of conformance tests, this chapter also identifies the set of features, offered by a service, that are mandatory for Anuket compliant implementation.
5.1. Core OpenStack Services APIs¶
Please note that OpenStack provides a maximum microversion to be used with an OpenStack release. In the following sections the “Maximal API Version” refers to this maximum microversion specified for the OpenStack Wallaby release. Please note that in Reference Conformance (RC-1) testing, the System Under Test (SUT) can utilise newer microversions because of the OpenStack microversion policies. As per multiple OpenStack services documentation, for example the Compute Service, “A cloud that is upgraded to support newer microversions will still support all older microversions to maintain the backward compatibility for those users who depend on older microversions.”
5.1.1. Keystone API¶
OpenStack Service |
API Version |
Maximal API Microversion |
|---|---|---|
Identity: Keystone |
v3 |
3.14 |
Keystone Features |
Mandatory |
|---|---|
access_rules |
|
application_credentials |
X |
external_idp |
|
federation |
|
oauth1 |
|
project_tags |
X |
security_compliance |
X |
trust |
X |
Identity API v3: https://docs.openstack.org/api-ref/identity/v3/index.html
Identity API v3 extensions: https://docs.openstack.org/api-ref/identity/v3-ext/
Security compliance and PCI-DSS: https://docs.openstack.org/keystone/train/admin/configuration.html#security-compliance-and-pci-dss
5.1.2. Glance API¶
OpenStack Service |
API Version |
Maximal API Microversion |
|---|---|---|
Image: Glance |
v2 |
2.9 |
Glance Features |
Mandatory |
|---|---|
import_image |
|
os_glance_reserved |
|
web-download import |
Image Service Versions: https://docs.openstack.org/api-ref/image/versions/index.html#version-history
5.1.3. Cinder API¶
OpenStack Service |
API Version |
Maximal API Microversion |
|---|---|---|
Block Storage: Cinder |
v3 |
3.64 |
Cinder Features |
Mandatory |
|---|---|
backup |
X |
clone |
X |
consistency_group |
|
extend_attached_volume |
|
extend_attached_encrypted_volume |
|
manage_snapshot |
X |
manage_volume |
X |
multi_backend |
|
snapshot |
X |
volume_revert |
X |
Block Storage API: https://docs.openstack.org/api-ref/block-storage/
REST API Version History: https://docs.openstack.org/cinder/latest/contributor/api_microversion_history.html
5.1.4. Swift API¶
OpenStack Service |
API Version |
|---|---|
Object Storage: Swift |
v1 |
Swift Features |
Mandatory |
|---|---|
account_quotas |
X |
bulk_delete |
X |
bulk_upload |
X |
container_quotas |
X |
container_sync |
|
crossdomain |
X |
discoverability |
X |
form_post |
X |
ratelimit |
X |
s3api |
|
slo |
X |
staticweb |
X |
symlink |
X |
temp_url |
X |
tempauth |
X |
versioned_writes |
X |
Object Storage API: https://docs.openstack.org/api-ref/object-store/index.html
Discoverability: https://docs.openstack.org/swift/latest/api/discoverability.html
5.1.5. Neutron API¶
OpenStack Service |
API Version |
|---|---|
Networking: Neutron |
v2.0 |
Neutron Extensions |
Mandatory |
|---|---|
address-scope |
X |
agent |
X |
allowed-address-pairs |
X |
auto-allocated-topology |
X |
availability_zone |
X |
availability_zone_filter |
X |
binding |
X |
binding-extended |
X |
default-subnetpools |
X |
dhcp_agent_scheduler |
|
dns-domain-ports |
|
dns-integration |
|
dvr |
|
empty-string-filtering |
X |
ext-gw-mode |
X |
external-net |
X |
extra_dhcp_opt |
X |
extraroute |
X |
extraroute-atomic |
|
flavors |
X |
filter-validation |
|
fip-port-details |
|
floating-ip-port-forwarding |
|
floatingip-pools |
|
ip-substring-filtering |
X |
l3_agent_scheduler |
|
l3-flavors |
|
l3-ha |
|
logging |
|
metering |
|
multi-provider |
X |
net-mtu |
X |
net-mtu-writable |
X |
network_availability_zone |
X |
network-ip-availability |
X |
network-segment-range |
|
pagination |
X |
port-mac-address-regenerate |
|
port-resource-request |
|
port-security |
X |
port-security-groups-filtering |
X |
project-id |
X |
provider |
X |
rbac-policies |
X |
router |
X |
router_availability_zone |
X |
qos |
X |
qos-bw-limit-direction |
X |
qos-bw-minimum-ingress |
X |
qos-default |
X |
qos-fip |
X |
qos-gateway-ip |
X |
qos-rule-type-details |
X |
qos-rules-alias |
X |
quotas |
X |
quota_details |
X |
revision-if-match |
X |
rbac-address-scope |
|
rbac-security-groups |
|
rbac-subnetpool |
|
router-interface-fip |
|
security-group |
X |
service-type |
X |
sorting |
X |
standard-attr-description |
X |
standard-attr-revisions |
X |
standard-attr-tag |
X |
standard-attr-timestamp |
X |
subnet_allocation |
X |
subnet-service-types |
X |
subnetpool-prefix-ops |
|
tag-ext |
|
tag-ports-during-bulk-creation |
|
trunk |
X |
trunk-details |
X |
uplink-status-propagation |
Neutron Type Drivers |
Mandatory |
|---|---|
geneve |
|
gre |
|
vlan |
X |
vxlan |
Networking Service APIs: https://docs.openstack.org/api-ref/network/
The exhaustive list of extensions is available at https://docs.openstack.org/api-ref/network/v2/
5.1.6. Nova API¶
OpenStack Service |
API Version |
Maximal API Microversion |
|---|---|---|
Compute: Nova |
v2.1 |
2.88 |
Nova Features |
Mandatory |
|---|---|
attach_encrypted_volume |
|
cert |
|
change_password |
|
cold_migration |
X |
console_output |
X |
disk_config |
X |
instance_password |
X |
interface_attach |
X |
live_migration |
X |
metadata_service |
X |
pause |
X |
personality |
|
rdp_console |
|
rescue |
X |
resize |
X |
serial_console |
|
shelve |
X |
shelve_migrate |
|
snapshot |
X |
stable_rescue |
|
spice_console |
|
suspend |
X |
swap_volume |
|
vnc_console |
|
volume_multiattach |
|
xenapi_apis |
Compute API: https://docs.openstack.org/api-ref/compute/
REST API Version History: https://docs.openstack.org/nova/latest/reference/api-microversion-history.html
5.1.7. Placement API¶
OpenStack Service |
API Version |
Maximal API Microversion |
|---|---|---|
Placement |
v1 |
1.36 |
Placement API: https://docs.openstack.org/api-ref/placement/
REST API Version History: https://docs.openstack.org/placement/latest/placement-api-microversion-history.html
5.1.8. Heat API¶
OpenStack Service |
API Version |
Maximal Template Version |
|---|---|---|
Orchestration: Heat |
v1 |
2021-04-16 |
Orchestration Service API: https://docs.openstack.org/api-ref/orchestration/
Template version history: https://docs.openstack.org/heat/latest/template_guide/hot_spec.html
Heat Orchestration Template (HOT) specification: https://docs.openstack.org/heat/latest/template_guide/hot_spec.html#rocky
5.2. Consolidated Set of APIs¶
5.2.1. OpenStack Interfaces¶
This section illustrates some of the Interfaces provided by OpenStack; the exhaustive list of APIs is available at https://docs.openstack.org/api-ref/.
OpenStack REST APIs are simple to interact with using either of two options. Clients can either call the APIs directly using the HTTP or REST library, or they can use one of the many cloud specific programming language libraries.
APIs
OpenStack Service |
Link for API list |
API Version |
Maximal API Microversion |
|---|---|---|---|
Identity: Keystone |
v3 |
3.14 |
|
Compute: Nova |
v2.1 |
2.88 |
|
Networking: Neutron |
v2.0 |
||
Image: Glance |
v2 |
2.9 |
|
Block Storage: Cinder |
v3 |
3.64 |
|
Placement |
v1 |
1.36 |
|
Orchestration: Heat |
v1 |
2021-04-06 (template) |
5.2.2. Kubernetes Interfaces¶
The Kubernetes APIs are available at https://kubernetes.io/docs/concepts/overview/kubernetes-api/.
5.2.3. KVM Interfaces¶
The KVM APIs are documented in Section 4 of the document https://www.kernel.org/doc/Documentation/virtual/kvm/api.txt.
5.2.3.1. Libvirt Interfaces¶
The Libvirt APIs are documented in https://libvirt.org/html/index.html.
5.2.4. Barbican API¶
OpenStack Service |
API Version |
|---|---|
Key Manager: Barbican |
v1 |
Barbican API Documentation: https://docs.openstack.org/barbican/latest/api/