class SnapshotSerializer(s.InstanceSerializer):
"""
vms.models.Snapshot
"""
_model_ = Snapshot
_update_fields_ = ('note', )
_default_fields_ = ('hostname', 'name', 'disk_id')
hostname = s.CharField(source='vm.hostname', read_only=True)
vm_uuid = s.CharField(source='vm.uuid', read_only=True)
define = s.CharField(source='define.name', read_only=True)
name = s.RegexField(r'^[A-Za-z0-9][A-Za-z0-9\._-]*$',
max_length=24,
min_length=1)
disk_id = s.IntegerField(source='array_disk_id',
max_value=DISK_ID_MAX,
min_value=DISK_ID_MIN)
note = s.SafeCharField(max_length=128, required=False)
type = s.IntegerChoiceField(choices=Snapshot.TYPE,
default=2,
read_only=True)
created = s.DateTimeField(read_only=True, required=False)
status = s.IntegerChoiceField(choices=Snapshot.STATUS,
read_only=True,
required=False)
size = s.IntegerField(read_only=True)
id = s.SafeCharField(read_only=True)
class SnapshotDefineSerializer(s.InstanceSerializer):
"""
vms.models.SnapshotDefine
"""
_model_ = SnapshotDefine
_update_fields_ = ('desc', 'active', 'schedule', 'retention')
_default_fields_ = ('hostname', 'name', 'disk_id')
hostname = s.CharField(source='vm.hostname', read_only=True)
vm_uuid = s.CharField(source='vm.uuid', read_only=True)
name = s.RegexField(r'^[A-Za-z0-9][A-Za-z0-9\._-]*$',
max_length=8,
min_length=1)
disk_id = s.IntegerField(source='array_disk_id',
max_value=DISK_ID_MAX,
min_value=DISK_ID_MIN)
desc = s.SafeCharField(max_length=128, required=False)
active = s.BooleanField(default=True)
schedule = s.CronField()
retention = s.IntegerField() # limits set below
fsfreeze = s.BooleanField(default=False)
def __init__(self, request, instance, *args, **kwargs):
super(SnapshotDefineSerializer, self).__init__(request, instance,
*args, **kwargs)
if not kwargs.get('many', False):
dc_settings = request.dc.settings
# Limit maximum number of snapshots - Issue #chili-447
if dc_settings.VMS_VM_SNAPSHOT_LIMIT_AUTO is None:
min_count, max_count = RETENTION_MIN, RETENTION_MAX
else:
min_count, max_count = 1, int(
dc_settings.VMS_VM_SNAPSHOT_LIMIT_AUTO)
self.fields['retention'].validators.append(
validators.MinValueValidator(min_count))
self.fields['retention'].validators.append(
validators.MaxValueValidator(max_count))
if instance.vm.is_hvm():
self._update_fields_ = list(self._update_fields_)
self._update_fields_.append('fsfreeze')
if instance.vm.is_bhyve():
self.fields['disk_id'].max_value = DISK_ID_MAX_BHYVE
def validate(self, attrs):
# Check total number of existing snapshot definitions - Issue #chili-447
if self.request.method == 'POST':
limit = self.request.dc.settings.VMS_VM_SNAPSHOT_DEFINE_LIMIT
if limit is not None:
total = self._model_.objects.filter(vm=self.object.vm).count()
if int(limit) <= total:
raise s.ValidationError(
_('Maximum number of snapshot definitions reached.'))
return attrs
class BackupRestoreSerializer(s.Serializer):
target_hostname_or_uuid = s.RegexField(r'^[A-Za-z0-9][A-Za-z0-9\._-]*$',
required=True)
target_disk_id = s.IntegerField(max_value=DISK_ID_MAX,
min_value=DISK_ID_MIN,
required=True)
disk_id = s.IntegerField(max_value=DISK_ID_MAX,
min_value=DISK_ID_MIN,
default=1,
required=True)
force = s.BooleanField(default=True)
class SliceCreateSerializer(serializers.UriHyperlinkedModelSerializer):
id = serializers.Field()
expires_on = serializers.DateTimeField(read_only=True)
instance_sn = serializers.IntegerField(read_only=True)
properties = serializers.PropertyField()
isolated_vlan_tag = serializers.IntegerField(read_only=True)
sliver_defaults = SliverDefaultsSerializer()
slivers = serializers.RelHyperlinkedRelatedField(many=True, read_only=True,
view_name='sliver-detail')
class Meta:
model = Slice
exclude = ('set_state',)
class ExtendedDcSerializer(SuperDcSerializer):
"""
Include extended datacenter statistics (only available for staff).
"""
extra_select = frozendict({
'nodes':
'''SELECT COUNT(*) FROM "vms_dcnode" WHERE "vms_dc"."id" = "vms_dcnode"."dc_id"''',
'vms':
'''SELECT COUNT(*) FROM "vms_vm" WHERE "vms_dc"."id" = "vms_vm"."dc_id"''',
'real_vms':
'''SELECT COUNT(*) FROM "vms_vm" LEFT OUTER JOIN "vms_slavevm" ON
( "vms_vm"."uuid" = "vms_slavevm"."vm_id" ) WHERE "vms_dc"."id" = "vms_vm"."dc_id" AND
"vms_slavevm"."vm_id" IS NULL''',
'snapshots':
'''SELECT COUNT(*) FROM "vms_snapshot" LEFT OUTER JOIN "vms_vm" ON
( "vms_vm"."uuid" = "vms_snapshot"."vm_id" ) WHERE "vms_dc"."id" = "vms_vm"."dc_id"''',
'backups':
'''SELECT COUNT(*) FROM "vms_backup" WHERE "vms_dc"."id" = "vms_backup"."dc_id"''',
})
vms = s.IntegerField(read_only=True)
nodes = s.IntegerField(read_only=True)
snapshots = s.IntegerField(read_only=True)
backups = s.IntegerField(read_only=True)
real_vms = s.IntegerField(read_only=True)
size_vms = s.IntegerField(read_only=True, source='size_vms')
size_snapshots = s.IntegerField(read_only=True, source='size_snapshots')
size_backups = s.IntegerField(read_only=True, source='size_backups')
class RecordSerializer(s.InstanceSerializer):
"""
pdns.models.Record
"""
_model_ = Record
_update_fields_ = ('name', 'type', 'content', 'ttl', 'prio', 'disabled')
_null_fields_ = frozenset({'content', 'ttl', 'prio'})
id = s.Field()
domain = s.Field()
name = s.CharField(max_length=253) # Validated via pdns.validators
type = s.ChoiceField(choices=Record.TYPE)
content = s.CharField(max_length=65535, required=False)
ttl = s.IntegerField(default=Record.TTL, required=False, min_value=0, max_value=2147483647)
prio = s.IntegerField(default=Record.PRIO, required=False, min_value=0, max_value=65535)
disabled = s.BooleanField(default=False)
changed = s.DateTimeField(read_only=True, required=False)
# noinspection PyMethodMayBeStatic
def validate_name(self, attrs, source):
if source in attrs:
name = attrs[source]
if name == '@':
name = self.object.domain.name
attrs[source] = name.lower() # The record name must be always lower-cased (DB requirement)
return attrs
def validate(self, attrs):
record = self.object
try:
run_record_validator(record.domain, attrs.get('type', record.type), attrs.get('name', record.name),
attrs.get('content', record.content))
except RecordValidationError as exc:
self._errors = exc.message_dict
return attrs
def detail_dict(self, **kwargs):
"""Always include id and name"""
dd = super(RecordSerializer, self).detail_dict(**kwargs)
dd['id'] = self.object.id
dd['name'] = self.object.name
return dd
class NetworkIPPlanSerializer(NetworkIPSerializer):
"""
Read-only serializer. Includes subnet/netmask and network name to NetworkIPSerializer.
"""
net = s.Field(source='subnet.name')
subnet = s.Field(source='subnet.ip_network.with_prefixlen')
vlan_id = s.IntegerField(source='subnet.vlan_id', read_only=True)
class VmStatusStopSerializer(s.Serializer):
timeout = s.IntegerField(default=settings.VMS_VM_STOP_TIMEOUT_DEFAULT)
force = s.BooleanField(default=False)
def __init__(self, request, vm, *args, **kwargs):
super(VmStatusStopSerializer, self).__init__(*args, **kwargs)
if vm.is_kvm():
dc_settings = request.dc.settings
if vm.ostype == vm.WINDOWS:
self.fields['timeout'].default = dc_settings.VMS_VM_STOP_WIN_TIMEOUT_DEFAULT
else:
self.fields['timeout'].default = dc_settings.VMS_VM_STOP_TIMEOUT_DEFAULT
else:
del self.fields['timeout']
@property
def data(self):
data = super(VmStatusStopSerializer, self).data
if 'timeout' not in data:
data['timeout'] = None
return data
class VmMonitoringSerializer(s.InstanceSerializer):
"""
Serializer for validating mon_vm_define parameters.
"""
_model_ = Vm
_blank_fields_ = ('ip', )
_update_fields_ = ('ip', 'dns', 'port', 'useip', 'proxy', 'templates',
'hostgroups')
hostname = s.CharField(read_only=True)
uuid = s.CharField(read_only=True)
monitored = s.BooleanField(read_only=True)
ip = s.IPAddressField(source='monitoring_ip', required=False)
dns = s.RegexField(r'^[A-Za-z0-9\.-]+$',
source='monitoring_dns',
required=False,
min_length=1,
max_length=128)
port = s.IntegerField(source='monitoring_port',
required=False,
min_value=1,
max_value=65535)
useip = s.BooleanField(source='monitoring_useip', required=False)
proxy = s.CharField(source='monitoring_proxy',
required=False,
min_length=1,
max_length=128)
templates = s.ArrayField(source='monitoring_templates',
max_items=32,
required=False,
default=[])
hostgroups = s.ArrayField(
source='monitoring_hostgroups',
max_items=16,
required=False,
default=[],
validators=(RegexValidator(
regex=MonitoringBackend.RE_MONITORING_HOSTGROUPS), ))
def __init__(self, request, vm, *args, **kwargs):
super(VmMonitoringSerializer, self).__init__(request, vm, *args,
**kwargs)
self.dc_settings = dc_settings = request.dc.settings
self.fields['dns'].default = vm.hostname
self.fields['port'].default = dc_settings.MON_ZABBIX_HOST_VM_PORT
self.fields['useip'].default = dc_settings.MON_ZABBIX_HOST_VM_USEIP
self.fields['proxy'].default = dc_settings.MON_ZABBIX_HOST_VM_PROXY
def validate_useip(self, attrs, source):
# null value will remove the useip parameter in monitoring_useip property => the default value will be used
if source in attrs and self.init_data.get('useip', True) is None:
attrs[source] = None
return attrs
# Allow to use only available templates
validate_templates = VmDefineSerializer.validate_monitoring_templates.im_func
# Allow to use only available hostgroups
validate_hostgroups = VmDefineSerializer.validate_monitoring_hostgroups.im_func
class NodeSerializer(s.Serializer):
"""
Node details serializer (read-only).
"""
hostname = s.Field()
address = s.Field()
status = s.IntegerChoiceField(choices=Node.STATUS_DB, read_only=True)
node_status = s.DisplayChoiceField(source='status',
choices=Node.STATUS_DB,
read_only=True)
owner = s.SlugRelatedField(slug_field='username', read_only=True)
is_head = s.BooleanField(read_only=True)
cpu = s.IntegerField(source='cpu_total', read_only=True)
ram = s.IntegerField(source='ram_total', read_only=True)
cpu_free = s.IntegerField(read_only=True)
ram_free = s.IntegerField(read_only=True)
ram_kvm_overhead = s.IntegerField(read_only=True)
class VmStatusSerializer(s.Serializer):
hostname = s.CharField(read_only=True)
uuid = s.CharField(read_only=True)
alias = s.CharField(read_only=True)
status = s.DisplayChoiceField(choices=Vm.STATUS, read_only=True)
status_change = s.DateTimeField(read_only=True)
node_status = s.DisplayChoiceField(source='node.status', choices=Node.STATUS_DB, read_only=True)
tasks = s.CharField(source='tasks', read_only=True)
uptime = s.IntegerField(source='uptime_actual', read_only=True)
class SliverSerializer(serializers.UriHyperlinkedModelSerializer):
id = serializers.Field(source='api_id')
interfaces = SliverIfaceSerializer(required=False, many=True, allow_add_remove=True)
properties = serializers.PropertyField()
data_uri = FakeFileField(field='data', required=False)
instance_sn = serializers.IntegerField(read_only=True)
mgmt_net = serializers.Field()
# FIXME remove when api.aggregate supports nested serializers
# is only required because SliverDefaultsSerializer imports resources
# serializers, and breaks api.aggregate functionality based on
# api._registry (see class SliverDefaultsSerializer)
if is_installed('resources'):
from resources.serializers import ResourceReqSerializer
resources = ResourceReqSerializer(many=True, required=False)
class Meta:
model = Sliver
exclude = ('data',)
def to_native(self, obj):
""" hack for implementing dynamic file_uri's on FakeFile """
self.__object__ = obj
return super(SliverSerializer, self).to_native(obj)
def validate(self, attrs):
""" workaround about nested serialization
sliverifaces need to be validated with an associated sliver
"""
super(SliverSerializer, self).validate(attrs)
ifaces = attrs.get('interfaces', []) or []
for iface in ifaces:
Sliver.get_registered_ifaces()[iface.type].clean_model(iface)
return attrs
def validate_interfaces(self, attrs, source):
"""Check that one interface of type private has been defined."""
interfaces = attrs.get(source, [])
# check that mandatory private interface has been defined
priv_ifaces = 0
for iface in interfaces:
if iface.type == 'private':
priv_ifaces += 1
if priv_ifaces > 1:
raise serializers.ValidationError('There can only be one interface of type private.')
if priv_ifaces == 0:
raise serializers.ValidationError('There must exist one interface of type private.')
validate_private_iface(interfaces)
for name, iface_cls in Sliver.get_registered_ifaces().items():
validate_ifaces_nr(name, iface_cls, interfaces)
return attrs
class VmSerializer(VmBaseSerializer):
"""
VM details (read-only)
"""
hostname = s.Field()
uuid = s.CharField(read_only=True)
alias = s.Field()
node = s.SlugRelatedField(slug_field='hostname',
read_only=True,
required=False)
owner = s.SlugRelatedField(slug_field='username', read_only=True)
status = s.DisplayChoiceField(choices=Vm.STATUS, read_only=True)
node_status = s.DisplayChoiceField(source='node.status',
choices=Node.STATUS_DB,
read_only=True)
vcpus = s.IntegerField(read_only=True)
ram = s.IntegerField(read_only=True)
disk = s.IntegerField(read_only=True)
ips = s.ArrayField(read_only=True)
uptime = s.IntegerField(source='uptime_actual', read_only=True)
locked = s.BooleanField(read_only=True)
class TaskLogReportSerializer(s.Serializer):
"""
Display task log stats.
"""
pending = s.IntegerField(read_only=True)
revoked = s.IntegerField(read_only=True)
succeeded = s.IntegerField(read_only=True)
failed = s.IntegerField(read_only=True)
@classmethod
def get_report(cls, basequery):
def get_count(status):
return basequery.filter(status=status).aggregate(
count=Count('id')).get('count', 0)
return {
'pending': get_count(states.PENDING),
'revoked': get_count(states.REVOKED),
'succeeded': get_count(states.SUCCESS),
'failed': get_count(states.FAILURE),
}
class ExtendedNetworkSerializer(NetworkSerializer):
_free_ip_subquery = '"vms_ipaddress"."vm_id" IS NULL AND "vms_ipaddress"."usage" = %d '\
'AND "vms_ipaddress_vms"."vm_id" IS NULL' % IPAddress.VM
ips_free_query = 'SELECT COUNT(*) FROM "vms_ipaddress" LEFT OUTER JOIN '\
'"vms_ipaddress_vms" ON ("vms_ipaddress"."id" = "vms_ipaddress_vms"."ipaddress_id") ' \
'WHERE "vms_subnet"."uuid" = "vms_ipaddress"."subnet_id" '\
'AND %s' % _free_ip_subquery
ips_used_query = 'SELECT COUNT(*) FROM "vms_ipaddress" LEFT OUTER JOIN '\
'"vms_ipaddress_vms" ON ("vms_ipaddress"."id" = "vms_ipaddress_vms"."ipaddress_id") ' \
'WHERE "vms_subnet"."uuid" = "vms_ipaddress"."subnet_id" '\
'AND NOT (%s)' % _free_ip_subquery
extra_select = frozendict({
'ips_free': ips_free_query,
'ips_used': ips_used_query
})
dcs = s.DcsField()
ips_free = s.IntegerField(read_only=True)
ips_used = s.IntegerField(read_only=True)
class ExtendedNodeStorageSerializer(NodeStorageSerializer):
size_vms = s.IntegerField(read_only=True)
size_snapshots = s.IntegerField(read_only=True)
size_rep_snapshots = s.IntegerField(read_only=True)
size_backups = s.IntegerField(read_only=True)
# size_images = s.IntegerField(read_only=True) # TODO: fix size_images implementation and enable
snapshots = s.IntegerField(read_only=True, source='snapshot_count')
backups = s.IntegerField(read_only=True, source='backup_count')
images = s.IntegerField(read_only=True, source='image_count')
dcs = s.DcsField()
vms = s.ArrayField(read_only=True)
class DcNodeStorageSerializer(s.InstanceSerializer):
"""
vms.models.NodeStorage
"""
_model_ = NodeStorage
node = s.Field(source='node.hostname')
zpool = s.Field()
alias = s.Field(source='storage.alias')
owner = s.Field(source='storage.owner.username')
access = s.IntegerField(source='storage.access', read_only=True)
type = s.IntegerField(source='storage.type', read_only=True)
size = s.IntegerField(
read_only=True) # storage.size_total or dc_node.disk if local storage
size_free = s.IntegerField(
read_only=True
) # storage.size_free or dc_node.disk_free if local storage
desc = s.Field(source='storage.desc')
def detail_dict(self, **kwargs):
# Add dc into detail dict
return {'dc': self.request.dc}
class SnapshotRestoreSerializer(s.Serializer):
target_hostname_or_uuid = s.RegexField(r'^[A-Za-z0-9][A-Za-z0-9\._-]*$',
required=False)
# we're using DISK_ID_MAX_BHYVE because it's bigger
target_disk_id = s.IntegerField(max_value=DISK_ID_MAX_BHYVE,
min_value=DISK_ID_MIN,
required=False)
force = s.BooleanField(default=True)
def __init__(self, request, vm, *args, **kwargs):
self.request = request
self.vm = vm
self.target_vm = vm
self.target_vm_disk_id = None
self.target_vm_real_disk_id = None
self.target_vm_disk_zfs_filesystem = None
super(SnapshotRestoreSerializer, self).__init__(*args, **kwargs)
def validate(self, attrs):
target_hostname_or_uuid = attrs.get('target_hostname_or_uuid', None)
target_disk_id = attrs.get('target_disk_id', None)
if target_hostname_or_uuid and not target_disk_id:
err_msg = _(
'This field is required when target_hostname_or_uuid is specified.'
)
self._errors['target_disk_id'] = s.ErrorList([err_msg])
return attrs
elif not target_hostname_or_uuid and target_disk_id:
err_msg = _(
'This field is required when target_disk_id is specified.')
self._errors['target_hostname_or_uuid'] = s.ErrorList([err_msg])
return attrs
elif target_hostname_or_uuid and target_disk_id:
try:
self.target_vm = get_vm(self.request,
target_hostname_or_uuid,
exists_ok=True,
noexists_fail=True,
check_node_status=None)
except ObjectNotFound as exc:
self._errors['target_hostname_or_uuid'] = s.ErrorList(
[exc.detail])
else:
try:
self.target_vm_disk_id, self.target_vm_real_disk_id, self.target_vm_disk_zfs_filesystem = \
get_disk_id(self.request, self.target_vm, disk_id=target_disk_id)
except InvalidInput as exc:
self._errors['target_disk_id'] = s.ErrorList([exc.detail])
return attrs
class ExtendedNodeSerializer(NodeSerializer):
"""
Extended node details serializer (read-only).
"""
extra_select = frozendict({
'vms':
'''SELECT COUNT(*) FROM "vms_vm" WHERE "vms_node"."uuid" = "vms_vm"."node_id"''',
'real_vms':
'''SELECT COUNT(*) FROM "vms_vm" LEFT OUTER JOIN "vms_slavevm" ON
( "vms_vm"."uuid" = "vms_slavevm"."vm_id" ) WHERE "vms_node"."uuid" = "vms_vm"."node_id" AND
"vms_slavevm"."id" IS NULL''',
'snapshots':
'''SELECT COUNT(*) FROM "vms_snapshot" LEFT OUTER JOIN "vms_vm" ON
( "vms_vm"."uuid" = "vms_snapshot"."vm_id" ) WHERE "vms_node"."uuid" = "vms_vm"."node_id"''',
'backups':
'''SELECT COUNT(*) FROM "vms_backup" WHERE "vms_node"."uuid" = "vms_backup"."node_id"'''
})
dcs = s.DcsField()
vms = s.IntegerField(read_only=True)
snapshots = s.IntegerField(read_only=True)
backups = s.IntegerField(read_only=True)
real_vms = s.IntegerField(read_only=True)
class BackupSerializer(_HideNodeSerializer):
"""
vms.models.Backup
"""
_model_ = Backup
_update_fields_ = ('note', )
_default_fields_ = ('hostname', 'vm', 'dc', 'name', 'disk_id')
hostname = s.CharField(source='vm_hostname', read_only=True)
vm_uuid = s.CharField(source='vm.uuid', read_only=True)
vm = s.CharField(source='vm', required=False, read_only=True)
dc = s.CharField(source='dc', read_only=True)
define = s.CharField(source='define.name', read_only=True)
name = s.RegexField(r'^[A-Za-z0-9][A-Za-z0-9\._-]*$',
max_length=24,
min_length=1)
disk_id = s.IntegerField(source='array_disk_id',
max_value=DISK_ID_MAX,
min_value=DISK_ID_MIN)
type = s.IntegerChoiceField(choices=Backup.TYPE, read_only=True)
node = s.CharField(source='node.hostname', read_only=True)
zpool = s.CharField(source='zpool.zpool', read_only=True)
created = s.DateTimeField(read_only=True, required=False)
status = s.IntegerChoiceField(choices=Backup.STATUS,
read_only=True,
required=False)
size = s.IntegerField(read_only=True)
time = s.IntegerField(read_only=True)
file_path = s.CharField(read_only=True)
note = s.SafeCharField(max_length=128, required=False)
def __init__(self, request, instance, node_view=False, *args, **kwargs):
super(BackupSerializer, self).__init__(request, instance, *args,
**kwargs)
if not node_view:
del self.fields['dc']
class NetworkVmMonHistorySerializer(MonHistorySerializer):
"""
Used by VmHistoryView to validate nic_id value.
"""
nic_id = s.IntegerField(required=True, min_value=NIC_ID_MIN + 1, max_value=NIC_ID_MAX + 1)
def validate(self, attrs):
nic_id = attrs.get('nic_id')
assert nic_id
try:
self.item_id = self.obj.get_real_nic_id(self.obj.json_active_get_nics()[nic_id - 1])
except IndexError:
raise s.ValidationError(_('NIC ID not defined on VM.'))
return attrs
class ExtendedVmSerializer(VmSerializer):
"""
Extended VM details (read-only)
"""
extra_select = frozendict({
'snapshots':
'''SELECT COUNT(*) FROM "vms_snapshot" WHERE "vms_vm"."uuid" = "vms_snapshot"."vm_id"''',
'backups':
'''SELECT COUNT(*) FROM "vms_backup" WHERE "vms_vm"."uuid" = "vms_backup"."vm_id"''',
'snapshot_define_active':
'''SELECT COUNT(*) FROM "vms_snapshotdefine"
LEFT OUTER JOIN "djcelery_periodictask" ON ("vms_snapshotdefine"."periodic_task_id" = "djcelery_periodictask"."id")
WHERE "vms_snapshotdefine"."vm_id" = "vms_vm"."uuid" AND "djcelery_periodictask"."enabled" = True''',
'snapshot_define_inactive':
'''SELECT COUNT(*) FROM "vms_snapshotdefine"
LEFT OUTER JOIN "djcelery_periodictask" ON ("vms_snapshotdefine"."periodic_task_id" = "djcelery_periodictask"."id")
WHERE "vms_snapshotdefine"."vm_id" = "vms_vm"."uuid" AND "djcelery_periodictask"."enabled" = False''',
'backup_define_active':
'''SELECT COUNT(*) FROM "vms_backupdefine"
LEFT OUTER JOIN "djcelery_periodictask" ON ("vms_backupdefine"."periodic_task_id" = "djcelery_periodictask"."id")
WHERE "vms_backupdefine"."vm_id" = "vms_vm"."uuid" AND "djcelery_periodictask"."enabled" = True''',
'backup_define_inactive':
'''SELECT COUNT(*) FROM "vms_backupdefine"
LEFT OUTER JOIN "djcelery_periodictask" ON ("vms_backupdefine"."periodic_task_id" = "djcelery_periodictask"."id")
WHERE "vms_backupdefine"."vm_id" = "vms_vm"."uuid" AND "djcelery_periodictask"."enabled" = False''',
'slaves':
'''SELECT COUNT(*) FROM "vms_slavevm" WHERE "vms_vm"."uuid" = "vms_slavevm"."master_vm_id"''',
})
tags = s.TagField(required=False, default=[])
snapshot_define_inactive = s.IntegerField(read_only=True)
snapshot_define_active = s.IntegerField(read_only=True)
snapshots = s.IntegerField(read_only=True)
backup_define_inactive = s.IntegerField(read_only=True)
backup_define_active = s.IntegerField(read_only=True)
backups = s.IntegerField(read_only=True)
slaves = s.IntegerField(read_only=True)
size_snapshots = s.IntegerField(read_only=True)
size_backups = s.IntegerField(read_only=True)
class DiskVmMonHistorySerializer(MonHistorySerializer):
"""
Used by VmHistoryView to validate disk_id value.
"""
disk_id = s.IntegerField(required=True, min_value=DISK_ID_MIN + 1, max_value=DISK_ID_MAX + 1)
def validate(self, attrs):
disk_id = attrs.get('disk_id')
assert disk_id
try:
self.item_id = disk_id - 1 # KVM IO templates are using "array_disk_id"
self.obj.get_real_disk_id(self.obj.json_active_get_disks()[self.item_id])
except IndexError:
raise s.ValidationError(_('Disk ID not defined on VM.'))
return attrs
class SliverDefaultsSerializer(serializers.ModelSerializer):
instance_sn = serializers.IntegerField(read_only=True)
data_uri = FakeFileField(field='data', required=False)
template = serializers.RelHyperlinkedRelatedField(view_name='template-detail')
# FIXME refactor move to resources app when api.aggregate supports nested serializers
if is_installed('resources'):
from resources.serializers import ResourceReqSerializer
resources = ResourceReqSerializer(source='slice_resources', many=True, required=False)
class Meta:
model = SliverDefaults
exclude = ('id', 'slice', 'data')
def to_native(self, obj):
""" hack for implementing dynamic file_uri's on FakeFile """
self.__object__ = obj
return super(SliverDefaultsSerializer, self).to_native(obj)
class NodeCreateSerializer(serializers.UriHyperlinkedModelSerializer):
id = serializers.Field()
properties = serializers.PropertyField()
arch = serializers.ChoiceField(choices=settings.NODES_NODE_ARCHS, required=True)
slivers = serializers.RelHyperlinkedRelatedField(many=True, read_only=True,
view_name='sliver-detail')
direct_ifaces = DirectIfaceSerializer(required=False, many=True, allow_add_remove=True)
cert = serializers.Field(source='api.cert')
boot_sn = serializers.IntegerField(read_only=True)
api = NodeApiSerializer(required=False)
class Meta:
model = Node
exclude = ('set_state',) + FW_CONFIG_FIELDS
def get_fields(self, *args, **kwargs):
"""
Filter groups: the user creating this node must be a
group or node administrator of this group, and the group
must have node creation allowed (/allow_nodes=true).
"""
fields = super(NodeCreateSerializer, self).get_fields(*args, **kwargs)
try:
user = self.context['view'].request.user
except KeyError: # avoid error when used out of Rest API
return fields
queryset = fields['group'].queryset
if not user.is_superuser:
msg = " Check if you have group or node administrator roles at the provided group."
fields['group'].error_messages['does_not_exist'] += msg
# bug #321: filter by user.id (None for Anonymous users)
fields['group'].queryset = queryset.filter(
Q(roles__is_group_admin=True) | Q(roles__is_node_admin=True),
allow_nodes=True, roles__user=user.id)
return fields
def validate_tinc(self, attrs, source):
from tinc.serializers import validate_tinc
return validate_tinc(self, attrs, source)
class ExtendedDcNodeStorageSerializer(DcNodeStorageSerializer):
size_vms = s.IntegerField(read_only=True, source='size_dc_vms')
size_snapshots = s.IntegerField(read_only=True, source='size_dc_snapshots')
size_backups = s.IntegerField(read_only=True, source='size_dc_backups')
class DefaultDcSettingsSerializer(DcSettingsSerializer):
"""
vms.models.DefaultDc.settings
"""
_global_settings = None
default_dc_third_party_modules = [] # Class level storage, updated only with the decorator function
default_dc_third_party_settings = [] # Class level storage, updated only with the decorator function
ACL_ENABLED = s.BooleanField(label=_('Advanced User Management')) # Global Module
API_ENABLED = s.BooleanField(label=_('API access')) # Global Module
VMS_DC_ENABLED = s.BooleanField(label=_('Virtual Datacenters')) # Global Module
SMS_ENABLED = s.BooleanField(label=_('SMS')) # Global Module
VMS_NODE_SSH_KEYS_SYNC = s.BooleanField(label='VMS_NODE_SSH_KEYS_SYNC',
help_text=_('WARNING: Do not disable this unless '
'you know what you are doing!'))
VMS_NODE_SSH_KEYS_DEFAULT = s.ArrayField(label='VMS_NODE_SSH_KEYS_DEFAULT',
help_text=_('List of SSH keys to be added to compute nodes by default'))
VMS_IMAGE_VM = s.SafeCharField(label='VMS_IMAGE_VM', required=False,
help_text=_('Global image server (hostname or uuid) - primary IMGAPI source on all '
'compute nodes. Empty value means that most of the image-related '
'operations will be performed only in the DB.'))
VMS_IMAGE_VM_NIC = s.IntegerField(label='VMS_IMAGE_VM_NIC', min_value=NIC_ID_MIN, max_value=NIC_ID_MAX,
help_text=_('Image server\'s NIC ID, which will be used to determine the IP '
'address for constructing the IMGAPI source set on all compute '
'nodes.'))
VMS_IMAGE_SOURCES = s.ArrayField(label='VMS_IMAGE_SOURCES', required=False, max_items=16,
help_text=_('List of additional IMGAPI sources that will be set on all '
'compute nodes.'))
VMS_IMAGE_REPOSITORIES = s.URLDictField(label='VMS_IMAGE_REPOSITORIES', required=False, max_items=16,
help_text=_('Object (key=name, value=URL) with remote disk image '
'repositories available in every virtual datacenter.'))
DNS_DOMAIN_TYPE_DEFAULT = s.ChoiceField(label='DNS_DOMAIN_TYPE_DEFAULT', choices=Domain.TYPE_MASTER,
help_text='Default PowerDNS replication type of newly created domain.')
DNS_HOSTMASTER = s.EmailField(label='DNS_HOSTMASTER', max_length=255,
help_text=_('Default hostmaster email address used for SOA records '
'of newly created domains.'))
DNS_NAMESERVERS = s.ArrayField(label='DNS_NAMESERVERS', max_items=8,
help_text=_('List of DNS servers used for NS records of newly created domains.'
' Set to an empty list to disable automatic creation of NS records.'))
DNS_SOA_DEFAULT = s.CharField(label='DNS_SOA_DEFAULT', max_length=255, min_length=0, required=False,
help_text=_('Default value for the SOA record of newly created domains. '
'Available placeholders are: '
'{nameserver} (replaced by first nameserver in DNS_NAMESERVERS) and '
'{hostmaster} (replaced by DNS_HOSTMASTER). '
'Set to an empty value to disable automatic creation of SOA records.'))
EMAIL_HOST = s.SafeCharField(label='EMAIL_HOST',
help_text=_('Hostname or IP address of the SMTP server used for all outgoing emails.'))
EMAIL_PORT = s.IntegerField(label='EMAIL_PORT', min_value=1, max_value=65535,
help_text=_('Port of the SMTP server.'))
EMAIL_USE_TLS = s.BooleanField(label='EMAIL_USE_TLS',
help_text=_('Whether to use an explicit TLS (secure) SMTP connection (STARTTLS).'))
EMAIL_USE_SSL = s.BooleanField(label='EMAIL_USE_SSL',
help_text=_('Whether to use an implicit TLS (secure) SMTP connection.'))
EMAIL_HOST_USER = s.CharField(label='EMAIL_HOST_USER', max_length=255, required=False,
help_text=_('Username for SMTP authentication.'))
EMAIL_HOST_PASSWORD = s.CharField(label='EMAIL_HOST_PASSWORD', max_length=255, required=False,
help_text=_('Password for SMTP authentication.'))
SHADOW_EMAIL = s.EmailField(label='SHADOW_EMAIL', required=False,
help_text=_('Email address to which hidden copies of all outgoing emails are sent.'))
PROFILE_SSH_KEY_LIMIT = s.IntegerField(label='PROFILE_SSH_KEY_LIMIT', max_value=64,
help_text=_('Maximum number of public SSH keys '
'that can be stored in one user profile.'))
PROFILE_COUNTRY_CODE_DEFAULT = s.ChoiceField(label='PROFILE_COUNTRY_CODE_DEFAULT', choices=UserProfile.COUNTRIES,
help_text=_("Default country in user's profile."))
PROFILE_PHONE_PREFIX_DEFAULT = s.ChoiceField(label='PROFILE_PHONE_PREFIX_DEFAULT',
choices=UserProfile.PHONE_PREFIXES,
help_text=_("Default country phone prefix in user's profile."))
PROFILE_TIME_ZONE_DEFAULT = s.ChoiceField(label='PROFILE_TIME_ZONE_DEFAULT', choices=UserProfile.TIMEZONES,
help_text=_("Default time zone in user's profile."))
MON_ZABBIX_NODE_SYNC = s.BooleanField(label='MON_ZABBIX_NODE_SYNC',
help_text=_('Whether compute nodes should be automatically '
'synchronized with the monitoring server.'))
MON_ZABBIX_NODE_SLA = s.BooleanField(label='MON_ZABBIX_NODE_SLA',
help_text=_('Whether to fetch and display the SLA value of compute nodes.'))
MON_ZABBIX_HOSTGROUP_NODE = s.SafeCharField(label='MON_ZABBIX_HOSTGROUP_NODE', max_length=255,
help_text=_('Existing Zabbix host group, which will be used for all '
'monitored compute nodes.'))
MON_ZABBIX_HOSTGROUPS_NODE = s.ArrayField(label='MON_ZABBIX_HOSTGROUPS_NODE', max_items=32, required=False,
help_text=_('List of other Zabbix host groups, which will be '
'used for all monitored compute nodes.'))
MON_ZABBIX_TEMPLATES_NODE = s.ArrayField(label='MON_ZABBIX_TEMPLATES_NODE', max_items=128, required=False,
help_text=_('List of existing Zabbix templates, which will be used for all'
' monitored compute nodes.'))
SMS_PREFERRED_SERVICE = s.ChoiceField(label='SMS_PREFERRED_SERVICE', choices=get_services(),
help_text=_('Currently used SMS provider.'))
SMS_SERVICE_USERNAME = s.CharField(label='SMS_SERVICE_USERNAME', max_length=255, required=False,
help_text=_('Username required for the selected SMS provider.'))
SMS_SERVICE_PASSWORD = s.CharField(label='SMS_SERVICE_PASSWORD', max_length=255, required=False,
help_text=_('Password required for the selected SMS provider.'))
SMS_FROM_NUMBER = s.SafeCharField(label='SMS_FROM_NUMBER', max_length=64, required=False,
help_text=_('Phone number used as sender for outgoing text messages.'))
SMS_REGISTRATION_ENABLED = s.BooleanField(label='SMS_REGISTRATION_ENABLED',
help_text=_("Whether to verify user's phone number during registration "
"and phone number change"))
# noinspection PyMethodMayBeStatic,PyPep8Naming
def validate_VMS_NODE_SSH_KEYS_DEFAULT(self, attrs, source):
try:
value = attrs[source]
except KeyError:
pass
else:
for key in value:
validate_ssh_key(key)
return attrs
# noinspection PyPep8Naming
def validate_VMS_IMAGE_VM(self, attrs, source):
try:
value = attrs[source]
except KeyError:
pass
else:
if value:
try:
vm = get_vm(self.request, value, exists_ok=True, noexists_fail=True, dc_bound=False)
except ObjectNotFound as exc:
raise s.ValidationError(exc.detail)
else:
if vm.status not in (Vm.RUNNING, Vm.STOPPED):
raise s.ValidationError(_('Invalid VM status; VM must be running or stopped.'))
if vm.ostype != Vm.SUNOS_ZONE:
raise s.ValidationError(_('Invalid OS type; VM must be a SunOS Zone.'))
attrs[source] = vm.uuid
return attrs
# noinspection PyMethodMayBeStatic,PyPep8Naming
def validate_DNS_SOA_DEFAULT(self, attrs, source):
try:
value = attrs[source]
except KeyError:
return attrs
if not value:
attrs[source] = ''
return attrs
testvalue = placeholder_validator(value, nameserver='ns01.example.com', hostmaster='hostmaster.example.com')
# {nameserver} {hostmaster} 2013010100 28800 7200 604800 86400
RegexValidator(r'^([A-Za-z0-9\._/-]+)\s+([A-Za-z0-9\._-]+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)$')(testvalue)
return attrs
def validate(self, attrs):
if attrs.get('EMAIL_USE_TLS', None) and attrs.get('EMAIL_USE_SSL', None):
self._errors['EMAIL_USE_TLS'] = self._errors['EMAIL_USE_SSL'] = s.ErrorList([
_('Cannot enable EMAIL_USE_TLS and EMAIL_USE_SSL together.')
])
# Do not allow SMS registration without the SMS module
if (attrs.get('SMS_REGISTRATION_ENABLED', None) and
not attrs.get('SMS_ENABLED', self.request.dc.settings.SMS_ENABLED)):
self._errors['SMS_REGISTRATION_ENABLED'] = s.ErrorList([_('SMS support must be enabled first.')])
return super(DefaultDcSettingsSerializer, self).validate(attrs)
class DcSettingsSerializer(s.InstanceSerializer):
"""
vms.models.Dc.settings
"""
_global_settings = None
_model_ = Dc
modules = settings.MODULES # Used in gui forms
third_party_modules = [] # Class level storage, updated only with the decorator function
third_party_settings = [] # Class level storage, updated only with the decorator function
# List of settings which cannot be changed when set to False in (local_)settings.py (booleans only)
_override_disabled_ = settings.MODULES
_blank_fields_ = frozenset({
'SITE_LOGO',
'SITE_ICON',
'SHADOW_EMAIL',
'SUPPORT_PHONE',
'VMS_DISK_IMAGE_DEFAULT',
'VMS_DISK_IMAGE_ZONE_DEFAULT',
'VMS_DISK_IMAGE_LX_ZONE_DEFAULT',
'VMS_NET_DEFAULT',
'VMS_STORAGE_DEFAULT',
'MON_ZABBIX_HTTP_USERNAME',
'MON_ZABBIX_HTTP_PASSWORD',
'MON_ZABBIX_HOST_VM_PROXY',
'DNS_SOA_DEFAULT',
'EMAIL_HOST_USER',
'EMAIL_HOST_PASSWORD',
'SMS_FROM_NUMBER',
'SMS_SERVICE_USERNAME',
'SMS_SERVICE_PASSWORD',
})
_null_fields_ = frozenset({
'VMS_VM_DEFINE_LIMIT',
'VMS_VM_SNAPSHOT_DEFINE_LIMIT',
'VMS_VM_SNAPSHOT_LIMIT_AUTO',
'VMS_VM_SNAPSHOT_LIMIT_MANUAL',
'VMS_VM_SNAPSHOT_LIMIT_MANUAL_DEFAULT',
'VMS_VM_SNAPSHOT_SIZE_LIMIT',
'VMS_VM_SNAPSHOT_SIZE_LIMIT_DEFAULT',
'VMS_VM_SNAPSHOT_DC_SIZE_LIMIT',
'VMS_VM_BACKUP_DEFINE_LIMIT',
'VMS_VM_BACKUP_LIMIT',
'VMS_VM_BACKUP_DC_SIZE_LIMIT',
'VMS_NET_LIMIT',
'VMS_IMAGE_VM',
'VMS_IMAGE_LIMIT',
'VMS_ISO_LIMIT'
})
dc = s.CharField(label=_('Datacenter'), read_only=True)
# Modules
VMS_VM_SNAPSHOT_ENABLED = s.BooleanField(label=_('Snapshots'))
VMS_VM_BACKUP_ENABLED = s.BooleanField(label=_('Backups'))
MON_ZABBIX_ENABLED = s.BooleanField(label=_('Monitoring'))
DNS_ENABLED = s.BooleanField(label=_('DNS'))
SUPPORT_ENABLED = s.BooleanField(label=_('Support'))
REGISTRATION_ENABLED = s.BooleanField(label=_('Registration'))
FAQ_ENABLED = s.BooleanField(label=_('FAQ')) # Not part of MODULES (can be overridden even if disabled in settings)
# Advanced settings
VMS_VM_DOMAIN_DEFAULT = s.RegexField(r'^[A-Za-z0-9][A-Za-z0-9\._/-]*$', label='VMS_VM_DOMAIN_DEFAULT',
max_length=255, min_length=3,
help_text=_('Default domain part of the hostname of a newly '
'created virtual server.'))
COMPANY_NAME = s.CharField(label='COMPANY_NAME', max_length=255,
help_text=_('Name of the company using this virtual datacenter.'))
SITE_NAME = s.CharField(label='SITE_NAME', max_length=255,
help_text=_('Name of this site used mostly in email and text message templates.'))
SITE_LINK = s.CharField(label='SITE_LINK', max_length=255,
help_text=_('Link to this site used mostly in email and text message templates.'))
SITE_SIGNATURE = s.CharField(label='SITE_SIGNATURE', max_length=255,
help_text=_('Signature attached to outgoing emails related '
'to this virtual datacenter.'))
SITE_LOGO = s.URLField(label='SITE_LOGO', max_length=2048, required=False,
help_text=_('URL pointing to an image, which will be displayed as a logo on the main page. '
'If empty the default Danube Cloud logo will be used.'))
SITE_ICON = s.URLField(label='SITE_ICON', max_length=2048, required=False,
help_text=_('URL pointing to an image, which will be displayed as an icon in the navigation '
'bar. If empty the default Danube Cloud icon will be used.'))
SUPPORT_EMAIL = s.EmailField(label='SUPPORT_EMAIL', max_length=255,
help_text=_('Destination email address used for all support tickets '
'related to this virtual datacenter.'))
SUPPORT_PHONE = s.CharField(label='SUPPORT_PHONE', max_length=255, required=False,
help_text=_('Phone number displayed in the support contact details.'))
SUPPORT_USER_CONFIRMATION = s.BooleanField(label='SUPPORT_USER_CONFIRMATION',
help_text=_('Whether to send a confirmation email to the user after '
'a support ticket has been sent to SUPPORT_EMAIL.'))
DEFAULT_FROM_EMAIL = s.EmailField(label='DEFAULT_FROM_EMAIL', max_length=255,
help_text=_('Email address used as the "From" address for all outgoing emails '
'related to this virtual datacenter.'))
EMAIL_ENABLED = s.BooleanField(label='EMAIL_ENABLED',
help_text=_('Whether to completely disable sending of emails '
'related to this virtual datacenter.'))
API_LOG_USER_CALLBACK = s.BooleanField(label='API_LOG_USER_CALLBACK',
help_text=_('Whether to log API user callback requests into the tasklog.'))
VMS_ZONE_ENABLED = s.BooleanField(label='VMS_ZONE_ENABLED', # Module
help_text=_('Whether to enable support for SunOS and Linux zones in '
'this virtual datacenter.'))
VMS_VM_DEFINE_LIMIT = s.IntegerField(label='VMS_VM_DEFINE_LIMIT', required=False,
help_text=_('Maximum number of virtual servers that can be defined in '
'this virtual datacenter.'))
VMS_VM_CPU_CAP_REQUIRED = s.BooleanField(label='VMS_VM_CPU_CAP_REQUIRED',
help_text='When disabled, the vCPUs server parameter on SunOS and Linux '
'Zones can be set to 0, which removes the compute node CPU '
'limit (cpu_cap) for the virtual server.')
VMS_VM_STOP_TIMEOUT_DEFAULT = s.IntegerField(label='VMS_VM_STOP_TIMEOUT_DEFAULT',
help_text='Default time period (in seconds) for a graceful VM stop or '
'reboot, after which a force stop/reboot is send to the VM '
'(KVM only).')
VMS_VM_STOP_WIN_TIMEOUT_DEFAULT = s.IntegerField(label='VMS_VM_STOP_WIN_TIMEOUT_DEFAULT',
help_text='This is the same setting as VMS_VM_STOP_TIMEOUT_DEFAULT'
' but for a VM with Windows OS type, which usually takes'
' longer to shutdown.')
VMS_VM_OSTYPE_DEFAULT = s.IntegerChoiceField(label='VMS_VM_OSTYPE_DEFAULT', choices=Vm.OSTYPE,
help_text=_('Default operating system type. One of: 1 - Linux VM, '
'2 - SunOS VM, 3 - BSD VM, 4 - Windows VM, '
'5 - SunOS Zone, 6 - Linux Zone.'))
VMS_VM_MONITORED_DEFAULT = s.BooleanField(label='VMS_VM_MONITORED_DEFAULT',
help_text=_('Controls whether server synchronization with the monitoring '
'system is enabled by default.'))
VMS_VM_CPU_SHARES_DEFAULT = s.IntegerField(label='VMS_VM_CPU_SHARES_DEFAULT', min_value=0, max_value=1048576,
help_text=_("Default value of the server's CPU shares, "
"relative to other servers."))
VMS_VM_ZFS_IO_PRIORITY_DEFAULT = s.IntegerField(label='VMS_VM_ZFS_IO_PRIORITY_DEFAULT', min_value=0, max_value=1024,
help_text=_("Default value of the server's IO throttling "
"priority, relative to other servers."))
VMS_VM_RESOLVERS_DEFAULT = s.IPAddressArrayField(label='VMS_VM_RESOLVERS_DEFAULT', max_items=8,
help_text=_('Default DNS resolvers used for newly '
'created servers.'))
VMS_VM_SSH_KEYS_DEFAULT = s.ArrayField(label='VMS_VM_SSH_KEYS_DEFAULT', max_items=32, required=False,
help_text=_('List of public SSH keys added to every virtual machine '
'in this virtual datacenter.'))
VMS_VM_MDATA_DEFAULT = s.MetadataField(label='VMS_VM_MDATA_DEFAULT', required=False,
validators=(validate_mdata(Vm.RESERVED_MDATA_KEYS),),
help_text=_('Default VM metadata (key=value string pairs).'))
VMS_DISK_MODEL_DEFAULT = s.ChoiceField(label='VMS_DISK_MODEL_DEFAULT', choices=Vm.DISK_MODEL,
help_text=_('Default disk model of newly created server disks. One of: '
'virtio, ide, scsi.'))
VMS_DISK_COMPRESSION_DEFAULT = s.ChoiceField(label='VMS_DISK_COMPRESSION_DEFAULT', choices=Vm.DISK_COMPRESSION,
help_text=_('Default disk compression algorithm. '
'One of: off, lzjb, gzip, gzip-N, zle, lz4.'))
VMS_DISK_IMAGE_DEFAULT = s.CharField(label='VMS_DISK_IMAGE_DEFAULT', max_length=64, required=False,
help_text=_('Name of the default disk image used for '
'newly created server disks.'))
VMS_DISK_IMAGE_ZONE_DEFAULT = s.CharField(label='VMS_DISK_IMAGE_ZONE_DEFAULT', max_length=64, required=False,
help_text=_('Name of the default disk image used for '
'newly created SunOS zone servers.'))
VMS_DISK_IMAGE_LX_ZONE_DEFAULT = s.CharField(label='VMS_DISK_IMAGE_LX_ZONE_DEFAULT', max_length=64, required=False,
help_text=_('Name of the default disk image used for '
'newly created Linux zone servers.'))
VMS_NIC_MODEL_DEFAULT = s.ChoiceField(label='VMS_NIC_MODEL_DEFAULT', choices=Vm.NIC_MODEL,
help_text=_('Default virtual NIC model of newly created server NICs. '
'One of: virtio, e1000, rtl8139.'))
VMS_NIC_MONITORING_DEFAULT = s.IntegerField(label='VMS_NIC_MONITORING_DEFAULT', min_value=NIC_ID_MIN,
max_value=NIC_ID_MAX,
help_text=_('Default NIC ID, which will be used for '
'external monitoring.'))
VMS_NET_DEFAULT = s.CharField(label='VMS_NET_DEFAULT', max_length=64, required=False,
help_text=_('Name of the default network used for newly created server NICs.'))
VMS_NET_LIMIT = s.IntegerField(label='VMS_NET_LIMIT', required=False,
help_text=_('Maximum number of DC-bound networks that can be created in '
'this virtual datacenter.'))
VMS_NET_VLAN_RESTRICT = s.BooleanField(label='VMS_NET_VLAN_RESTRICT',
help_text=_('Whether to restrict VLAN IDs to the '
'VMS_NET_VLAN_ALLOWED list.'))
VMS_NET_VLAN_ALLOWED = s.IntegerArrayField(label='VMS_NET_VLAN_ALLOWED', required=False,
help_text=_('List of VLAN IDs available for newly created DC-bound '
'networks in this virtual datacenter.'))
VMS_NET_VXLAN_RESTRICT = s.BooleanField(label='VMS_NET_VXLAN_RESTRICT',
help_text=_('Whether to restrict VXLAN IDs to the '
'VMS_NET_VXLAN_ALLOWED list.'))
VMS_NET_VXLAN_ALLOWED = s.IntegerArrayField(label='VMS_NET_VXLAN_ALLOWED', required=False,
help_text=_('List of VXLAN IDs available for newly created DC-bound '
'networks in this virtual datacenter.'))
VMS_IMAGE_LIMIT = s.IntegerField(label='VMS_IMAGE_LIMIT', required=False,
help_text=_('Maximum number of DC-bound server images that can be created in '
'this virtual datacenter.'))
VMS_ISO_LIMIT = s.IntegerField(label='VMS_ISO_LIMIT', required=False,
help_text=_('Maximum number of DC-bound ISO images that can be created in '
'this virtual datacenter.'))
VMS_STORAGE_DEFAULT = s.CharField(label='VMS_STORAGE_DEFAULT', max_length=64, required=False,
help_text=_('Name of the default storage used for newly created servers '
'and server disks.'))
VMS_VGA_MODEL_DEFAULT = s.ChoiceField(label='VMS_VGA_MODEL_DEFAULT', choices=Vm.VGA_MODEL,
help_text=_('Default VGA emulation driver of newly created servers. '
'One of: std, cirrus, vmware.'))
VMS_VM_SNAPSHOT_DEFINE_LIMIT = s.IntegerField(label='VMS_VM_SNAPSHOT_DEFINE_LIMIT', required=False,
help_text=_('Maximum number of snapshot definitions per server.'))
VMS_VM_SNAPSHOT_LIMIT_AUTO = s.IntegerField(label='VMS_VM_SNAPSHOT_LIMIT_AUTO', required=False,
help_text=_('Maximum number of automatic snapshots per server.'))
VMS_VM_SNAPSHOT_LIMIT_MANUAL = s.IntegerField(label='VMS_VM_SNAPSHOT_LIMIT_MANUAL', required=False,
help_text=_('Maximum number of manual snapshots per server.'))
VMS_VM_SNAPSHOT_LIMIT_MANUAL_DEFAULT = s.IntegerField(label='VMS_VM_SNAPSHOT_LIMIT_MANUAL_DEFAULT', required=False,
help_text=_('Predefined manual snapshot limit '
'for new servers.'))
VMS_VM_SNAPSHOT_SIZE_LIMIT = s.IntegerField(label='VMS_VM_SNAPSHOT_SIZE_LIMIT', required=False,
help_text=_('Maximum size (MB) of all snapshots per server.'))
VMS_VM_SNAPSHOT_SIZE_LIMIT_DEFAULT = s.IntegerField(label='VMS_VM_SNAPSHOT_SIZE_LIMIT_DEFAULT', required=False,
help_text=_('Predefined snapshot size limit (MB) for new '
'servers.'))
VMS_VM_SNAPSHOT_DC_SIZE_LIMIT = s.IntegerField(label='VMS_VM_SNAPSHOT_DC_SIZE_LIMIT', required=False,
help_text=_('Maximum size (MB) of all snapshots in this '
'virtual datacenter.'))
VMS_VM_BACKUP_DEFINE_LIMIT = s.IntegerField(label='VMS_VM_BACKUP_DEFINE_LIMIT', required=False,
help_text=_('Maximum number of backup definitions per server.'))
VMS_VM_BACKUP_LIMIT = s.IntegerField(label='VMS_VM_BACKUP_LIMIT', required=False,
help_text=_('Upper retention limit used for new backup definitions.'))
VMS_VM_BACKUP_DC_SIZE_LIMIT = s.IntegerField(label='VMS_VM_BACKUP_DC_SIZE_LIMIT', required=False,
help_text=_('Maximum size (MB) of all backups in this '
'virtual datacenter.'))
VMS_VM_BACKUP_COMPRESSION_DEFAULT = s.ChoiceField(label='VMS_VM_BACKUP_COMPRESSION_DEFAULT',
choices=BackupDefine.COMPRESSION,
help_text=_('Predefined compression algorithm for '
'new file backups.'))
DNS_PTR_DEFAULT = s.CharField(label='DNS_PTR_DEFAULT', max_length=255, min_length=4,
help_text=_("Default value used for reverse DNS records of virtual server "
"NIC's IP addresses. Available placeholders are: "
"{ipaddr}, {hostname}, {alias}."))
MON_ZABBIX_SERVER = s.RegexField(r'^https?://.*$', label='MON_ZABBIX_SERVER', max_length=1024,
help_text=_('URL address of Zabbix server used for external monitoring of servers '
'in this virtual datacenter. WARNING: Changing this and other '
'MON_ZABBIX_* values in default virtual datacenter will '
'affect the built-in internal monitoring of servers and '
'compute nodes.'))
MON_ZABBIX_SERVER_SSL_VERIFY = s.BooleanField(label='MON_ZABBIX_SERVER_SSL_VERIFY',
help_text=_('Whether to perform HTTPS certificate verification when '
'connecting to the Zabbix API.'))
MON_ZABBIX_TIMEOUT = s.IntegerField(label='MON_ZABBIX_TIMEOUT', min_value=1, max_value=180,
help_text=_('Timeout in seconds used for connections to the Zabbix API.'))
MON_ZABBIX_USERNAME = s.CharField(label='MON_ZABBIX_USERNAME', max_length=255,
help_text=_('Username used for connecting to the Zabbix API.'))
MON_ZABBIX_PASSWORD = s.CharField(label='MON_ZABBIX_PASSWORD', max_length=255,
help_text=_('Password used for connecting to the Zabbix API.'))
MON_ZABBIX_HTTP_USERNAME = s.CharField(label='MON_ZABBIX_HTTP_USERNAME', max_length=255, required=False,
help_text=_('Username used for the HTTP basic authentication required for '
'connections to the Zabbix API.'))
MON_ZABBIX_HTTP_PASSWORD = s.CharField(label='MON_ZABBIX_HTTP_PASSWORD', max_length=255, required=False,
help_text=_('Password used for the HTTP basic authentication required for '
'connections to the Zabbix API.'))
MON_ZABBIX_VM_SLA = s.BooleanField(label='MON_ZABBIX_VM_SLA',
help_text=_('Whether to fetch and display the SLA value of virtual servers.'))
MON_ZABBIX_VM_SYNC = s.BooleanField(label='MON_ZABBIX_VM_SYNC',
help_text=_('Whether newly created virtual servers can be automatically '
'synchronized with the monitoring server.'))
MON_ZABBIX_HOSTGROUP_VM = s.SafeCharField(label='MON_ZABBIX_HOSTGROUP_VM', max_length=255,
help_text=_('Existing Zabbix host group, which will be used for all '
'monitored servers in this virtual datacenter.'))
MON_ZABBIX_HOSTGROUPS_VM = s.ArrayField(label='MON_ZABBIX_HOSTGROUPS_VM', max_items=32, required=False,
help_text=_('List of Zabbix host groups, which will be used '
'for all monitored servers in this virtual datacenter. '
'Available placeholders are: {ostype}, {ostype_text}, '
'{disk_image}, {disk_image_abbr}, {dc_name}.'))
MON_ZABBIX_HOSTGROUPS_VM_RESTRICT = s.BooleanField(label='MON_ZABBIX_HOSTGROUPS_VM_RESTRICT',
help_text=_('Whether to restrict Zabbix host group names to the '
'MON_ZABBIX_HOSTGROUPS_VM_ALLOWED list.'))
MON_ZABBIX_HOSTGROUPS_VM_ALLOWED = s.ArrayField(label='MON_ZABBIX_HOSTGROUPS_VM_ALLOWED', max_items=32,
required=False,
help_text=_('List of Zabbix host groups that can be used by servers'
' in this virtual datacenter. Available placeholders'
' are: {ostype}, {ostype_text}, {disk_image},'
' {disk_image_abbr}, {dc_name}.'))
MON_ZABBIX_TEMPLATES_VM = s.ArrayField(label='MON_ZABBIX_TEMPLATES_VM', max_items=128, required=False,
help_text=_('List of existing Zabbix templates, which will be used for all '
'monitored servers in this virtual datacenter. '
'Available placeholders are: {ostype}, {ostype_text}, '
'{disk_image}, {disk_image_abbr}, {dc_name}.'))
MON_ZABBIX_TEMPLATES_VM_MAP_TO_TAGS = s.BooleanField(label='MON_ZABBIX_TEMPLATES_VM_MAP_TO_TAGS',
help_text=_('Whether to find and use existing Zabbix templates'
' according to tags of a monitored '
'virtual server.'))
MON_ZABBIX_TEMPLATES_VM_RESTRICT = s.BooleanField(label='MON_ZABBIX_TEMPLATES_VM_RESTRICT',
help_text=_('Whether to restrict Zabbix template names to the '
'MON_ZABBIX_TEMPLATES_VM_ALLOWED list.'))
MON_ZABBIX_TEMPLATES_VM_ALLOWED = s.ArrayField(label='MON_ZABBIX_TEMPLATES_VM_ALLOWED', max_items=128,
required=False,
help_text=_('List of Zabbix templates that can be used by servers '
'in this virtual datacenter. Available placeholders are:'
' {ostype}, {ostype_text}, {disk_image},'
' {disk_image_abbr}, {dc_name}.'))
MON_ZABBIX_TEMPLATES_VM_NIC = s.ArrayField(label='MON_ZABBIX_TEMPLATES_VM_NIC', max_items=16, required=False,
help_text=_('List of Zabbix templates that will be used for all '
'monitored servers, for every virtual NIC of a server. '
'Available placeholders are: {net}, {nic_id} + '
'MON_ZABBIX_TEMPLATES_VM placeholders.'))
MON_ZABBIX_TEMPLATES_VM_DISK = s.ArrayField(label='MON_ZABBIX_TEMPLATES_VM_DISK', max_items=16, required=False,
help_text=_('List of Zabbix templates that will be used for all '
'monitored servers, for every virtual disk of a server. '
'Available placeholders: {disk}, {disk_id} + '
'MON_ZABBIX_TEMPLATES_VM placeholders.'))
MON_ZABBIX_HOST_VM_PROXY = s.CharField(label='MON_ZABBIX_HOST_VM_PROXY', min_length=1, max_length=128,
required=False,
help_text=_('Name or ID of the monitoring proxy, which will be used to '
'monitor all monitored virtual servers.'))
def __init__(self, request, dc, *args, **kwargs):
# noinspection PyNoneFunctionAssignment
global_settings = self.get_global_settings()
if global_settings and not dc.is_default(): # Displaying global settings for non default DC
dc1_settings = DefaultDc().settings # These setting should be read-only and read from default DC
dc_settings = DefAttrDict(dc.custom_settings, defaults=dc1_settings) # instance
else:
dc1_settings = None
dc_settings = dc.settings # instance
self.dc_settings = dc_settings
dc_settings['dc'] = dc.name
super(DcSettingsSerializer, self).__init__(request, dc_settings, *args, **kwargs)
self._update_fields_ = self.fields.keys()
self._update_fields_.remove('dc')
self.settings = {}
self.dc = dc
if dc1_settings is not None:
for i in global_settings:
self.fields[i].read_only = True
@classmethod
def get_global_settings(cls):
if cls._global_settings is None:
# noinspection PyUnresolvedReferences
cls._global_settings = frozenset(set(cls.base_fields.keys()) - set(DcSettingsSerializer.base_fields.keys()))
return cls._global_settings
@staticmethod
def _filter_sensitive_data(dictionary):
"""Replace sensitive data in input dict with ***"""
for key in dictionary.keys():
if any([i in key for i in SENSITIVE_FIELD_NAMES]):
dictionary[key] = SENSITIVE_FIELD_VALUE
return dictionary
def _setattr(self, instance, source, value):
# noinspection PyProtectedMember
super(DcSettingsSerializer, self)._setattr(instance, source, value)
self.settings[source] = value
def detail_dict(self, **kwargs):
# Remove sensitive data from detail dict
return self._filter_sensitive_data(super(DcSettingsSerializer, self).detail_dict(**kwargs))
@property
def data(self):
if self._data is None:
# Remove sensitive data from output
self._data = self._filter_sensitive_data(super(DcSettingsSerializer, self).data)
return self._data
# noinspection PyPep8Naming
def validate_VMS_VM_DOMAIN_DEFAULT(self, attrs, source):
if self.dc_settings.DNS_ENABLED:
try:
value = attrs[source]
except KeyError:
pass
else:
try:
domain = Domain.objects.get(name=value)
except Domain.DoesNotExist:
raise s.ValidationError(_('Object with name=%s does not exist.') % value)
else:
if not self.dc.domaindc_set.filter(domain_id=domain.id).exists():
raise s.ValidationError(_('Domain is not available in this datacenter.'))
return attrs
# noinspection PyMethodMayBeStatic,PyPep8Naming
def validate_VMS_VM_SSH_KEYS_DEFAULT(self, attrs, source):
try:
value = attrs[source]
except KeyError:
pass
else:
for key in value:
validate_ssh_key(key)
return attrs
# noinspection PyMethodMayBeStatic,PyPep8Naming
def validate_DNS_PTR_DEFAULT(self, attrs, source):
try:
value = attrs[source]
except KeyError:
pass
else:
testvalue = placeholder_validator(value, ipaddr='test', hostname='test', alias='test')
RegexValidator(r'^[a-z0-9][a-z0-9\.-]+[a-z0-9]$')(testvalue)
return attrs
# noinspection PyMethodMayBeStatic,PyPep8Naming
def validate_MON_ZABBIX_HOSTGROUPS_VM(self, attrs, source):
return validate_array_placeholders(attrs, source, VM_KWARGS)
# noinspection PyMethodMayBeStatic,PyPep8Naming
def validate_MON_ZABBIX_HOSTGROUPS_VM_ALLOWED(self, attrs, source):
return validate_array_placeholders(attrs, source, VM_KWARGS)
# noinspection PyMethodMayBeStatic,PyPep8Naming
def validate_MON_ZABBIX_TEMPLATES_VM(self, attrs, source):
return validate_array_placeholders(attrs, source, VM_KWARGS)
# noinspection PyMethodMayBeStatic,PyPep8Naming
def validate_MON_ZABBIX_TEMPLATES_VM_ALLOWED(self, attrs, source):
return validate_array_placeholders(attrs, source, VM_KWARGS)
# noinspection PyMethodMayBeStatic,PyPep8Naming
def validate_MON_ZABBIX_TEMPLATES_VM_NIC(self, attrs, source):
return validate_array_placeholders(attrs, source, VM_KWARGS_NIC)
# noinspection PyMethodMayBeStatic,PyPep8Naming
def validate_MON_ZABBIX_TEMPLATES_VM_DISK(self, attrs, source):
return validate_array_placeholders(attrs, source, VM_KWARGS_DISK)
def validate(self, attrs):
# Check if it is possible to override a boolean setting
for source, value in attrs.items():
if source in self._override_disabled_ and not getattr(settings, source, False) and value:
self._errors[source] = s.ErrorList([_('Cannot override global setting.')])
del attrs[source]
return attrs
class ImageSerializer(s.InstanceSerializer):
"""
vms.models.Image
Also used in api.dc.image.serializers.
"""
_backup_attrs_map_ = {
'owner': 'owner_id',
'dc_bound': 'dc_bound_id',
}
_model_ = Image
_update_fields_ = ('alias', 'version', 'dc_bound', 'owner', 'access',
'desc', 'resize', 'deploy', 'tags')
# TODO: 'nic_model', 'disk_model'
_default_fields_ = ('name', 'alias', 'owner')
name = s.RegexField(r'^[A-Za-z0-9][A-Za-z0-9\._-]*$', max_length=32)
uuid = s.CharField(read_only=True)
alias = s.SafeCharField(max_length=32)
version = s.SafeCharField(max_length=16, default='1.0')
owner = s.SlugRelatedField(slug_field='username', queryset=User.objects)
access = s.IntegerChoiceField(choices=Image.ACCESS, default=Image.PRIVATE)
desc = s.SafeCharField(max_length=128, required=False)
ostype = s.IntegerChoiceField(choices=Image.OSTYPE, read_only=True)
size = s.IntegerField(read_only=True)
resize = s.BooleanField(default=False)
deploy = s.BooleanField(default=False)
# nic_model = s.ChoiceField(choices=Vm.NIC_MODEL) # KVM only
# disk_model = s.ChoiceField(choices=Vm.DISK_MODEL) # KVM only
tags = s.TagField(required=False, default=[])
dc_bound = s.BooleanField(source='dc_bound_bool', default=True)
status = s.IntegerChoiceField(choices=Image.STATUS,
read_only=True,
required=False)
created = s.DateTimeField(read_only=True, required=False)
def __init__(self, request, img, *args, **kwargs):
super(ImageSerializer, self).__init__(request, img, *args, **kwargs)
if not kwargs.get('many', False):
self.update_manifest = True
self._dc_bound = img.dc_bound
self.fields['owner'].queryset = get_owners(request, all=True)
def create_img_backup(self):
"""Creates a dictionary that maps Image object attributes to its values;
this will be used as a backup in case the update should fail"""
items = self._backup_attrs_map_
return {
items.get(attr, attr): getattr(self.object, items.get(attr, attr))
for attr in self._update_fields_
}
def _normalize(self, attr, value):
if attr == 'dc_bound':
return self._dc_bound
# noinspection PyProtectedMember
return super(ImageSerializer, self)._normalize(attr, value)
def validate_owner(self, attrs, source):
"""Cannot change owner while pending tasks exist"""
validate_owner(self.object, attrs.get(source, None), _('Image'))
return attrs
def validate_dc_bound(self, attrs, source):
try:
value = bool(attrs[source])
except KeyError:
pass
else:
if value != self.object.dc_bound_bool:
self._dc_bound = validate_dc_bound(self.request, self.object,
value, _('Image'))
return attrs
def validate(self, attrs):
db_only_manifest_keys = {'dc_bound', 'dc_bound_bool', 'owner'}
if db_only_manifest_keys.issuperset(attrs.keys()):
self.update_manifest = False
try:
alias = attrs['alias']
except KeyError:
alias = self.object.alias
try:
version = attrs['version']
except KeyError:
version = self.object.version
qs = Image.objects
if self.object.pk:
qs = qs.exclude(pk=self.object.pk)
if qs.filter(alias__iexact=alias, version=version).exists():
self._errors['alias'] = s.ErrorList([
_('This alias is already in use. '
'Please supply a different alias or version.')
])
if self.request.method == 'POST' and self._dc_bound:
limit = self._dc_bound.settings.VMS_IMAGE_LIMIT
if limit is not None:
if Image.objects.filter(
dc_bound=self._dc_bound).count() >= int(limit):
raise s.ValidationError(
_('Maximum number of server disk images reached'))
return attrs
class ExtendedBackupDefineSerializer(BackupDefineSerializer):
"""Add backup count to BackupDefineSerializer"""
backups = s.IntegerField(read_only=True)