manila/releasenotes/notes/bp-export-locations-az-api-changes-c8aa1a3a5bc86312.yaml
Goutham Pacha Ravi 53918308c8 Separate APIs for share & replica export locations
Users of replicated shares expect to see primary
export locations when viewing information regarding
the share. Because we collate exports of all replicas
within the export locations APIs, it becomes hard for
users to discern which exports belong to the primary
share. For secondary replicas, users would also need
additional information (availability zone, state of the
replication) to work with.

Introduce micro-version 2.47 from which the export locations
API (GET /v2/{tenant_id}/shares/{share_id}/export_locations)
no longer provides export locations of non-active share
replicas. A new API has been introduced to provide export
location details for share replicas, both active and non-active.
(GET /v2/{tenant_id}/share-replicas/{share_replica_id}/export-locations)

The new API provides the replica's state and availability zone
in addition to the export location information.

APIImpact
Implements: bp export-locations-az
Change-Id: I0a1d9dd00b4c13ac01988e30ca2b7d7ce4a747d1
2019-01-07 01:51:16 -08:00

23 lines
1.2 KiB
YAML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
features:
- |
New experimental APIs were introduced version ``2.47`` to retrieve
export locations of share replicas. With API versions ``2.46`` and
prior, export locations of non-active or secondary share replicas are
included in the share export locations APIs, albeit these APIs do not
provide all the necessary distinguishing information (availability zone,
replica state and replica ID). See the `API reference
<https://developer.openstack.org/api-ref/shared-file-system/>`_ for more
information regarding these API changes.
deprecations:
- |
In API version ``2.47``, export locations APIs: ``GET
/v2/{tenant_id}/shares/{share_id}/export_locations`` and ``GET
/v2/{tenant_id}/shares/{share_id}/export_locations/{export_location_id
}`` no longer provide export locations of non-active or secondary share
replicas where available. Use the newly introduced share replica export
locations APIs to gather this information: ``GET
/v2/{tenant_id}/share-replicas/{share_replica_id}/export-locations`` and
``GET /v2/{tenant_id}/share-replicas/{share_replica_id}/export
-locations/{export_location_id}``.