manila-ui/manila_ui/dashboards/admin/shares/forms.py

491 lines
21 KiB
Python

# Copyright (c) 2014 NetApp, Inc.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from django.conf import settings
from django.core.urlresolvers import reverse
from django.forms import ValidationError # noqa
from django.utils.translation import ugettext_lazy as _
from oslo_utils import strutils
import six
from horizon import exceptions
from horizon import forms
from horizon import messages
from manila_ui.api import manila
from manila_ui.dashboards import utils
from openstack_dashboard.api import keystone
from openstack_dashboard.api import neutron
ST_EXTRA_SPECS_FORM_ATTRS = {
"rows": 5,
"cols": 40,
"style": "height: 135px; width: 100%;", # in case 'rows' not picked up
}
class MigrationStart(forms.SelfHandlingForm):
name = forms.CharField(
label=_("Share Name"), required=False,
widget=forms.TextInput(attrs={'readonly': 'readonly'}))
share_id = forms.CharField(
label=_("ID"), required=False,
widget=forms.TextInput(attrs={'readonly': 'readonly'}))
host = forms.CharField(
max_length=255, label=_("Host to migrate share"),
help_text=_("Destination host where share will be migrated to. Use the"
" format 'host@backend#pool'."))
force_host_assisted_migration = forms.BooleanField(
label=_("Force Host Assisted Migration"),
required=False, initial=False,
help_text=("Defines whether the migration of this share should skip "
"the attempt to be assisted by a storage vendor backend. "
"This will force the use of the Data Service to perform "
"migration."))
nondisruptive = forms.BooleanField(
label=_("Non-disruptive"),
required=False, initial=False,
help_text=("Defines whether the migration of this share should be "
"performed only if it is non-disruptive If set so, this "
"will prevent the use of the Data Service for migration."))
writable = forms.BooleanField(
label=_("Writable"), required=False, initial=True,
help_text=("Defines whether this share should remain writable during "
"migration. If set so, this will prevent the use of the "
"Data Service for migration."))
preserve_metadata = forms.BooleanField(
label=_("Preserve Metadata"), required=False, initial=True,
help_text=("Defines whether this share should have all its file "
"metadata preserved during migration. If set so, this will "
"prevent the use of the Data Service for migration."))
new_share_network = forms.ChoiceField(
label=_("New share network to be set in migrated share"),
required=False,
help_text=_("Input the new share network where the share should"
" be migrated to if you would like to change it."))
new_share_type = forms.ChoiceField(
label=_("New share type to be set in migrating share"), required=False,
help_text=_("Input the new share type which the migrating share will "
"be set to if you would like to change the type."))
def __init__(self, request, *args, **kwargs):
super(MigrationStart, self).__init__(request, *args, **kwargs)
share_networks = manila.share_network_list(request)
share_types = manila.share_type_list(request)
st_choices = [('', '')] + [(st.id, st.name) for st in share_types]
sn_choices = (
[('', '')] +
[(sn.id, sn.name or sn.id) for sn in share_networks])
self.fields['new_share_type'].choices = st_choices
self.fields['new_share_network'].choices = sn_choices
def handle(self, request, data):
share_name = _get_id_if_name_empty(data)
try:
manila.migration_start(
request, self.initial['share_id'],
force_host_assisted_migration=(
data['force_host_assisted_migration']),
writable=data['writable'],
preserve_metadata=data['preserve_metadata'],
nondisruptive=data['nondisruptive'],
dest_host=data['host'],
new_share_network_id=data['new_share_network'],
new_share_type_id=data['new_share_type'])
messages.success(
request,
_('Successfully sent the request to migrate share: %s.')
% share_name)
return True
except Exception:
redirect = reverse("horizon:admin:shares:index")
exceptions.handle(
request, _("Unable to migrate share %s.") % share_name,
redirect=redirect)
return False
class MigrationForms(forms.SelfHandlingForm):
name = forms.CharField(
label=_("Share Name"), required=False,
widget=forms.TextInput(attrs={'readonly': 'readonly'}))
share_id = forms.CharField(
label=_("ID"), required=False,
widget=forms.TextInput(attrs={'readonly': 'readonly'}))
class MigrationComplete(MigrationForms):
def handle(self, request, data):
share_name = _get_id_if_name_empty(data)
try:
manila.migration_complete(request, self.initial['share_id'])
messages.success(
request,
_('Successfully sent the request to complete migration of '
' share: %s.') % share_name)
return True
except Exception:
exceptions.handle(request, _("Unable to complete migration "
"of share %s.") % share_name)
return False
class MigrationGetProgress(MigrationForms):
def handle(self, request, data):
share_name = _get_id_if_name_empty(data)
try:
result = manila.migration_get_progress(request,
self.initial['share_id'])
progress = result[1]
messages.success(
request,
_('Migration of share %(name)s is at %(progress)s percent.') %
{'name': share_name, 'progress': progress['total_progress']})
return True
except Exception:
exceptions.handle(request, _("Unable to obtain progress of "
"migration of share %s at this "
"moment.") % share_name)
return False
class MigrationCancel(MigrationForms):
def handle(self, request, data):
share_name = _get_id_if_name_empty(data)
try:
manila.migration_cancel(request, self.initial['share_id'])
messages.success(
request,
_('Successfully sent the request to cancel migration of '
' share: %s.') % share_name)
return True
except Exception:
exceptions.handle(request, _("Unable to cancel migration of share"
" %s at this moment.") % share_name)
return False
class ManageShare(forms.SelfHandlingForm):
name = forms.CharField(
max_length=255, label=_("Share Name"), required=False,
help_text=_("Share name to be assigned"))
description = forms.CharField(
max_length=255, label=_("Description"), required=False,
widget=forms.Textarea(
attrs={'class': 'modal-body-fixed-width', 'rows': 4}))
host = forms.CharField(
max_length=255, label=_("Host of share"), required=True,
help_text=_(
"Host where share is located, example: some.host@driver[#pool]"))
export_location = forms.CharField(
max_length=255, label=_("Export location"), required=True,
help_text=_("Export location of share. Example for NFS: "
"1.2.3.4:/path/to/share"))
protocol = forms.ChoiceField(label=_("Share Protocol"), required=True)
share_type = forms.ChoiceField(label=_("Share Type"), required=True)
driver_options = forms.CharField(
max_length=255, required=False,
label=_("Driver options ('volume_id' for Generic driver, etc...)"),
help_text=_("key=value pairs per line can be set"),
widget=forms.Textarea(
attrs={'class': 'modal-body-fixed-width', 'rows': 2}))
is_public = forms.BooleanField(
label=_("Public"), required=False, initial=False,
help_text=("Defines whether this share is available for all or not."))
def __init__(self, request, *args, **kwargs):
super(ManageShare, self).__init__(request, *args, **kwargs)
share_types = manila.share_type_list(request)
# NOTE(vponomaryov): choose only those share_types that have spec
# 'driver_handles_share_servers' set to 'False' value or alias of it.
dhss_key = 'driver_handles_share_servers'
st_choices = [('', ''), ]
for st in share_types:
dhss = st.to_dict()['extra_specs'].get(dhss_key)
if dhss and dhss.lower() in strutils.FALSE_STRINGS:
st_choices.append((st.name, st.name))
self.fields['share_type'].choices = st_choices
# NOTE(vkmc): choose only those share protocols that are enabled
# FIXME(vkmc): this should be better implemented by having a
# capabilities endpoint on the control plane.
manila_features = getattr(settings, 'OPENSTACK_MANILA_FEATURES', {})
self.enabled_share_protocols = manila_features.get(
'enabled_share_protocols',
['NFS', 'CIFS', 'GlusterFS', 'HDFS', 'CephFS'])
self.fields['protocol'].choices = ([(' ', ' ')] +
[(enabled_proto, enabled_proto)
for enabled_proto in
self.enabled_share_protocols])
def handle(self, request, data):
try:
driver_options = data.get('driver_options') or {}
driver_options_error_msg = _(
"Got improper value for field 'driver_options'. "
"Expected only pairs of key=value.")
if driver_options and isinstance(driver_options, six.string_types):
try:
set_dict, unset_list = utils.parse_str_meta(driver_options)
if unset_list:
raise ValidationError(message=driver_options_error_msg)
driver_options = set_dict
except ValidationError as e:
self.api_error(e.messages[0])
return False
elif not isinstance(driver_options, dict):
self.api_error(driver_options_error_msg)
return False
manila.share_manage(
request,
service_host=data['host'],
protocol=data['protocol'],
export_path=data['export_location'],
driver_options=driver_options,
share_type=data['share_type'],
name=data['name'],
description=data['description'],
is_public=data['is_public'])
share_name = data.get('name', data.get('id'))
messages.success(
request,
_('Successfully sent the request to manage share: %s')
% share_name)
return True
except Exception:
exceptions.handle(request, _("Unable to manage share"))
return False
class UnmanageShare(forms.SelfHandlingForm):
name = forms.CharField(
label=_("Share Name"), required=False,
widget=forms.TextInput(attrs={'readonly': 'readonly'}))
host = forms.CharField(
label=_("Host"), required=False,
widget=forms.TextInput(attrs={'readonly': 'readonly'}))
share_id = forms.CharField(
label=_("ID"), required=False,
widget=forms.TextInput(attrs={'readonly': 'readonly'}))
def handle(self, request, data):
try:
manila.share_unmanage(request, self.initial['share_id'])
messages.success(
request,
_('Successfully sent the request to unmanage share: %s')
% data['name'])
return True
except Exception:
exceptions.handle(request, _("Unable to unmanage share."))
return False
class CreateShareType(forms.SelfHandlingForm):
name = forms.CharField(max_length="255", label=_("Name"), required=True)
spec_driver_handles_share_servers = forms.ChoiceField(
label=_("Driver handles share servers"), required=True,
choices=(('False', 'False'), ('True', 'True')))
extra_specs = forms.CharField(
required=False, label=_("Extra specs"),
widget=forms.widgets.Textarea(attrs=ST_EXTRA_SPECS_FORM_ATTRS))
is_public = forms.BooleanField(
label=_("Public"), required=False, initial=True,
help_text=("Defines whether this share type is available for all "
"or not. List of allowed tenants should be set "
"separately."))
def __init__(self, *args, **kwargs):
super(CreateShareType, self).__init__(*args, **kwargs)
manila_features = getattr(settings, 'OPENSTACK_MANILA_FEATURES', {})
self.enable_public_share_type_creation = manila_features.get(
'enable_public_share_type_creation', True)
if not self.enable_public_share_type_creation:
self.fields.pop('is_public')
def handle(self, request, data):
try:
spec_dhss = data['spec_driver_handles_share_servers'].lower()
allowed_dhss_values = ('true', 'false')
if spec_dhss not in allowed_dhss_values:
msg = _("Improper value set to required extra spec "
"'spec_driver_handles_share_servers'. "
"Allowed values are %s. "
"Case insensitive.") % allowed_dhss_values
raise ValidationError(message=msg)
set_dict, unset_list = utils.parse_str_meta(data['extra_specs'])
if unset_list:
msg = _("Expected only pairs of key=value.")
raise ValidationError(message=msg)
is_public = (self.enable_public_share_type_creation
and data["is_public"])
share_type = manila.share_type_create(
request, data["name"], spec_dhss, is_public=is_public)
if set_dict:
manila.share_type_set_extra_specs(
request, share_type.id, set_dict)
msg = _("Successfully created share type: %s") % share_type.name
messages.success(request, msg)
return True
except ValidationError as e:
# handle error without losing dialog
self.api_error(e.messages[0])
return False
except Exception:
exceptions.handle(request, _('Unable to create share type.'))
return False
class UpdateShareType(forms.SelfHandlingForm):
def __init__(self, *args, **kwargs):
super(UpdateShareType, self).__init__(*args, **kwargs)
# NOTE(vponomaryov): parse existing extra specs
# to str view for textarea html element
es_str = ""
for k, v in self.initial["extra_specs"].iteritems():
es_str += "%s=%s\r\n" % (k, v)
self.initial["extra_specs"] = es_str
extra_specs = forms.CharField(
required=False, label=_("Extra specs"),
widget=forms.widgets.Textarea(attrs=ST_EXTRA_SPECS_FORM_ATTRS))
def handle(self, request, data):
try:
set_dict, unset_list = utils.parse_str_meta(data['extra_specs'])
if set_dict:
manila.share_type_set_extra_specs(
request, self.initial["id"], set_dict)
if unset_list:
get = manila.share_type_get_extra_specs(
request, self.initial["id"])
# NOTE(vponomaryov): skip keys that are already unset
to_unset = set(unset_list).intersection(set(get.keys()))
if to_unset:
manila.share_type_unset_extra_specs(
request, self.initial["id"], to_unset)
msg = _("Successfully updated extra specs for share type '%s'.")
msg = msg % self.initial['name']
messages.success(request, msg)
return True
except ValidationError as e:
# handle error without losing dialog
self.api_error(e.messages[0])
return False
except Exception:
msg = _("Unable to update extra_specs for share type.")
exceptions.handle(request, msg)
return False
class CreateSecurityService(forms.SelfHandlingForm):
name = forms.CharField(max_length="255", label=_("Name"))
dns_ip = forms.CharField(max_length="15", label=_("DNS IP"))
server = forms.CharField(max_length="255", label=_("Server"))
domain = forms.CharField(max_length="255", label=_("Domain"))
user = forms.CharField(max_length="255", label=_("User"))
password = forms.CharField(max_length="255", label=_("Password"))
type = forms.ChoiceField(choices=(("", ""),
("active_directory", "Active Directory"),
("ldap", "LDAP"),
("kerberos", "Kerberos")),
label=_("Type"))
description = forms.CharField(widget=forms.Textarea,
label=_("Description"), required=False)
def handle(self, request, data):
try:
# Remove any new lines in the public key
security_service = manila.security_service_create(
request, **data)
messages.success(request,
_('Successfully created security service: %s')
% data['name'])
return security_service
except Exception:
exceptions.handle(request,
_('Unable to create security service.'))
return False
class CreateShareNetworkForm(forms.SelfHandlingForm):
name = forms.CharField(max_length="255", label=_("Name"))
neutron_net_id = forms.ChoiceField(choices=(), label=_("Neutron Net ID"))
neutron_subnet_id = forms.ChoiceField(choices=(),
label=_("Neutron Subnet ID"))
# security_service = forms.MultipleChoiceField(
# widget=forms.SelectMultiple,
# label=_("Security Service"))
project = forms.ChoiceField(choices=(), label=_("Project"))
description = forms.CharField(widget=forms.Textarea,
label=_("Description"), required=False)
def __init__(self, request, *args, **kwargs):
super(CreateShareNetworkForm, self).__init__(
request, *args, **kwargs)
net_choices = neutron.network_list(request)
subnet_choices = neutron.subnet_list(request)
self.fields['neutron_net_id'].choices = [(' ', ' ')] + \
[(choice.id, choice.name_or_id)
for choice in net_choices]
self.fields['neutron_subnet_id'].choices = [(' ', ' ')] + \
[(choice.id,
choice.name_or_id) for
choice in subnet_choices]
tenants, has_more = keystone.tenant_list(request)
self.fields['project'].choices = [(' ', ' ')] + \
[(choice.id,
choice.name) for
choice in tenants]
def handle(self, request, data):
try:
# Remove any new lines in the public key
share_network = manila.share_network_create(request, **data)
messages.success(request,
_('Successfully created share network: %s')
% data['name'])
return share_network
except Exception:
exceptions.handle(request,
_('Unable to create share network.'))
return False
def _get_id_if_name_empty(data):
result = data.get('name', None)
if not result:
result = data.get('id')
if not result:
result = ''
return result