openstack
/
horizon
Code Issues Proposed changes

Use Cinder API v3 by default 

Cinder API v3 was introduced several releases ago and is backward
compatible with API v2 so it's safe to swith to use it.

Change-Id: I550e6c59bb14c17da78d7b2abcde5783b2b6825d
Closes-Bug: #1728761
This commit is contained in:
Ivan Kolodyazhny 2017-12-13 21:21:48 +02:00
parent 52115149c2
commit a774fa30dd
18 changed files with 81 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
openstack_dashboard/api/cinder.py
View File

@ -55,12 +55,15 @@ CONSUMER_CHOICES = (
('both', pgettext_lazy('Both of front-end and back-end', u'both')),
)
VERSIONS = base.APIVersionManager("volume", preferred_version='2')
VERSIONS = base.APIVersionManager("volume", preferred_version='3')
try:
from cinderclient.v2 import client as cinder_client_v2
VERSIONS.load_supported_version('2', {"client": cinder_client_v2,
"version": '2'})
from cinderclient.v3 import client as cinder_client_v3
VERSIONS.load_supported_version('3', {"client": cinder_client_v3,
"version": '3'})
except ImportError:
pass
@ -1071,9 +1074,9 @@ def message_list(request, search_opts=None):
def is_volume_service_enabled(request):
return bool(
base.is_service_enabled(request, 'volume') or
base.is_service_enabled(request, 'volumev3') or
base.is_service_enabled(request, 'volumev2') or
base.is_service_enabled(request, 'volumev3')
base.is_service_enabled(request, 'volume')
)

3
openstack_dashboard/dashboards/admin/info/tabs.py
View File

@ -78,7 +78,8 @@ class CinderServicesTab(tabs.TableTab):
slug = tables.CinderServicesTable.Meta.name
template_name = constants.INFO_DETAIL_TEMPLATE_NAME
permissions = (
('openstack.services.volume', 'openstack.services.volumev2'),
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3'),
)
def get_cinder_services_data(self):

3
openstack_dashboard/dashboards/admin/snapshots/panel.py
View File

@ -21,6 +21,7 @@ class Snapshots(horizon.Panel):
name = _("Snapshots")
slug = 'snapshots'
permissions = (
('openstack.services.volume', 'openstack.services.volumev2'),
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3'),
)
policy_rules = (("volume", "context_is_admin"),)

3
openstack_dashboard/dashboards/admin/volume_types/panel.py
View File

@ -21,6 +21,7 @@ class VolumeTypes(horizon.Panel):
name = _("Volume Types")
slug = 'volume_types'
permissions = (
('openstack.services.volume', 'openstack.services.volumev2'),
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3'),
)
policy_rules = (("volume", "volume_extension:types_manage"),)

3
openstack_dashboard/dashboards/admin/volumes/panel.py
View File

@ -19,6 +19,7 @@ class Volumes(horizon.Panel):
name = _("Volumes")
slug = "volumes"
permissions = (
('openstack.services.volume', 'openstack.services.volumev2'),
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3'),
)
policy_rules = (("volume", "context_is_admin"),)

3
openstack_dashboard/dashboards/project/backups/panel.py
View File

@ -21,6 +21,7 @@ class Backups(horizon.Panel):
name = _("Backups")
slug = 'backups'
permissions = (
('openstack.services.volume', 'openstack.services.volumev2'),
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3'),
)
policy_rules = (("volume", "backup:get_all"),)

3
openstack_dashboard/dashboards/project/cg_snapshots/panel.py
View File

@ -21,6 +21,7 @@ class CGSnapshots(horizon.Panel):
name = _("Consistency Group Snapshots")
slug = 'cg_snapshots'
permissions = (
('openstack.services.volume', 'openstack.services.volumev2'),
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3'),
)
policy_rules = (("volume", "consistencygroup:get_all_cgsnapshots"),)

3
openstack_dashboard/dashboards/project/cg_snapshots/tables.py
View File

@ -113,5 +113,6 @@ class CGSnapshotsTable(tables.DataTable):
row_class = UpdateRow
status_columns = ("status",)
permissions = [
('openstack.services.volume', 'openstack.services.volumev2')
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3')
]

3
openstack_dashboard/dashboards/project/cgroups/panel.py
View File

@ -21,6 +21,7 @@ class CGroups(horizon.Panel):
name = _("Consistency Groups")
slug = 'cgroups'
permissions = (
('openstack.services.volume', 'openstack.services.volumev2'),
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3'),
)
policy_rules = (("volume", "consistencygroup:get_all"),)

3
openstack_dashboard/dashboards/project/snapshots/panel.py
View File

@ -21,6 +21,7 @@ class Snapshots(horizon.Panel):
name = _("Snapshots")
slug = 'snapshots'
permissions = (
('openstack.services.volume', 'openstack.services.volumev2'),
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3'),
)
policy_rules = (("volume", "volume:get_all_snapshots"),)

3
openstack_dashboard/dashboards/project/snapshots/tables.py
View File

@ -208,7 +208,8 @@ class VolumeDetailsSnapshotsTable(volume_tables.VolumesTableBase):
row_class = UpdateRow
status_columns = ("status",)
permissions = [
('openstack.services.volume', 'openstack.services.volumev2'),
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3'),
]

4
openstack_dashboard/dashboards/project/snapshots/tests.py
View File

@ -41,9 +41,9 @@ class VolumeSnapshotsViewTests(test.TestCase):
api.base: ('is_service_enabled',)})
def _test_snapshots_index_paginated(self, marker, sort_dir, snapshots, url,
has_more, has_prev):
api.base.is_service_enabled(IsA(http.HttpRequest), 'volumev2') \
api.base.is_service_enabled(IsA(http.HttpRequest), 'volumev3') \
.AndReturn(True)
api.base.is_service_enabled(IsA(http.HttpRequest), 'volume') \
api.base.is_service_enabled(IsA(http.HttpRequest), 'volumev3') \
.AndReturn(True)
api.cinder.volume_snapshot_list_paged(
IsA(http.HttpRequest), marker=marker, sort_dir=sort_dir,

20
openstack_dashboard/dashboards/project/snapshots/views.py
View File

@ -21,7 +21,7 @@ from horizon import tables
from horizon import tabs
from horizon.utils import memoized
from openstack_dashboard import api
from openstack_dashboard.api import cinder
from openstack_dashboard.dashboards.project.snapshots \
import forms as vol_snapshot_forms
@ -38,14 +38,14 @@ class SnapshotsView(tables.PagedTableMixin, tables.DataTableView):
def get_data(self):
snapshots = []
volumes = {}
if api.base.is_service_enabled(self.request, 'volumev2'):
if cinder.is_volume_service_enabled(self.request):
try:
marker, sort_dir = self._get_marker()
snapshots, self._has_more_data, self._has_prev_data = \
api.cinder.volume_snapshot_list_paged(
cinder.volume_snapshot_list_paged(
self.request, paginate=True, marker=marker,
sort_dir=sort_dir)
volumes = api.cinder.volume_list(self.request)
volumes = cinder.volume_list(self.request)
volumes = dict((v.id, v) for v in volumes)
except Exception:
exceptions.handle(self.request, _("Unable to retrieve "
@ -71,8 +71,8 @@ class UpdateView(forms.ModalFormView):
def get_object(self):
snap_id = self.kwargs['snapshot_id']
try:
self._object = api.cinder.volume_snapshot_get(self.request,
snap_id)
self._object = cinder.volume_snapshot_get(self.request,
snap_id)
except Exception:
msg = _('Unable to retrieve volume snapshot.')
url = reverse('horizon:project:snapshots:index')
@ -123,10 +123,10 @@ class DetailView(tabs.TabView):
def get_data(self):
try:
snapshot_id = self.kwargs['snapshot_id']
snapshot = api.cinder.volume_snapshot_get(self.request,
snapshot_id)
snapshot._volume = api.cinder.volume_get(self.request,
snapshot.volume_id)
snapshot = cinder.volume_snapshot_get(self.request,
snapshot_id)
snapshot._volume = cinder.volume_get(self.request,
snapshot.volume_id)
except Exception:
redirect = self.get_redirect_url()
exceptions.handle(self.request,

3
openstack_dashboard/dashboards/project/volumes/panel.py
View File

@ -21,6 +21,7 @@ class Volumes(horizon.Panel):
name = _("Volumes")
slug = 'volumes'
permissions = (
('openstack.services.volume', 'openstack.services.volumev2'),
('openstack.services.volume', 'openstack.services.volumev2',
'openstack.services.volumev3'),
)
policy_rules = (("volume", "volume:get_all"),)

24
openstack_dashboard/test/test_data/keystone_data.py
View File

@ -56,13 +56,25 @@ SERVICE_CATALOG = [
"endpoints_links": [],
"endpoints": [
{"region": "RegionOne",
"adminURL": "http://admin.nova.example.com:8776/v2",
"internalURL": "http://int.nova.example.com:8776/v2",
"publicURL": "http://public.nova.example.com:8776/v2"},
"adminURL": "http://admin.cinder.example.com:8776/v2",
"internalURL": "http://int.cinder.example.com:8776/v2",
"publicURL": "http://public.cinder.example.com:8776/v2"},
{"region": "RegionTwo",
"adminURL": "http://admin.nova.example.com:8776/v2",
"internalURL": "http://int.nova.example.com:8776/v2",
"publicURL": "http://public.nova.example.com:8776/v2"}]},
"adminURL": "http://admin.cinder.example.com:8776/v2",
"internalURL": "http://int.cinder.example.com:8776/v2",
"publicURL": "http://public.cinder.example.com:8776/v2"}]},
{"type": "volumev3",
"name": "cinderv3",
"endpoints_links": [],
"endpoints": [
{"region": "RegionOne",
"adminURL": "http://admin.cinder.example.com:8776/v3",
"internalURL": "http://int.cinder.example.com:8776/v3",
"publicURL": "http://public.cinder.example.com:8776/v3"},
{"region": "RegionTwo",
"adminURL": "http://admin.cinder.example.com:8776/v3",
"internalURL": "http://int.cinder.example.com:8776/v3",
"publicURL": "http://public.cinder.example.com:8776/v3"}]},
{"type": "image",
"name": "glance",
"endpoints_links": [],

12
openstack_dashboard/test/unit/api/test_base.py
View File

@ -249,16 +249,16 @@ class ApiHelperTests(test.TestCase):
endpoint_type='adminURL')
self.assertEqual('http://admin.nova.example.com:8774/v2', url)
url = api_base.url_for(self.request, 'volumev2')
self.assertEqual('http://public.nova.example.com:8776/v2', url)
url = api_base.url_for(self.request, 'volumev3')
self.assertEqual('http://public.cinder.example.com:8776/v3', url)
url = api_base.url_for(self.request, 'volumev2',
url = api_base.url_for(self.request, 'volumev3',
endpoint_type="internalURL")
self.assertEqual('http://int.nova.example.com:8776/v2', url)
self.assertEqual('http://int.cinder.example.com:8776/v3', url)
url = api_base.url_for(self.request, 'volumev2',
url = api_base.url_for(self.request, 'volumev3',
endpoint_type='adminURL')
self.assertEqual('http://admin.nova.example.com:8776/v2', url)
self.assertEqual('http://admin.cinder.example.com:8776/v3', url)
self.assertNotIn('notAnApi', self.request.user.service_catalog,
'Select a new nonexistent service catalog key')

8
openstack_dashboard/test/unit/api/test_cinder.py
View File

@ -458,12 +458,16 @@ class CinderApiVersionTests(test.TestCase):
# versions.
api.cinder.VERSIONS._active = None
def test_default_client_is_v2(self):
def test_default_client_is_v3(self):
client = api.cinder.cinderclient(self.request)
self.assertIsInstance(client, cinder_client.v2.client.Client)
self.assertIsInstance(client, cinder_client.v3.client.Client)
@override_settings(OPENSTACK_API_VERSIONS={'volume': 2})
def test_v2_setting_returns_v2_client(self):
# FIXME(e0ne): this is a temporary workaround to bypass
# @memoized_with_request decorator caching. We have to find a better
# solution instead this hack.
self.request.user.username = 'test_user_cinder_v2'
client = api.cinder.cinderclient(self.request)
self.assertIsInstance(client, cinder_client.v2.client.Client)

11
releasenotes/notes/cinder-api-v3-by-default-d6e3c12760fdf655.yaml Normal file
View File

@ -0,0 +1,11 @@
---
features:
- |
Cinder API v3 is used by default now. It was introduced in Mitaka release
and has all features from API v2.
upgrade:
- |
If your deployment doesn't have Cinder API v3 endpoint like ``volumev3``
you should create new endpoint or use Cinder API v2 via setting
OPENSTACK_API_VERSIONS['volume'] = 2 in your OpenStack Dashboard (Horizon)
configuration file.