lcm/ns_vnfs/serializers/serializers.py

   1 # Copyright 2018 ZTE Corporation.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #         http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 from rest_framework import serializers
  16
  17
  18 class InstVnfReqSerializer(serializers.Serializer):
  19     vnfIndex = serializers.CharField(help_text="Index of VNF", required=True)
  20     nsInstanceId = serializers.CharField(help_text="ID of NS instance", required=True)
  21     additionalParamForVnf = serializers.CharField(help_text="Additional param for VNF", required=False, allow_null=True)
  22
  23
  24 class InstVnfRespSerializer(serializers.Serializer):
  25     vnfInstId = serializers.CharField(help_text="ID of VNF instance", required=True)
  26     jobId = serializers.CharField(help_text="ID of Job", required=True)
  27
  28
  29 class GetVnfRespSerializer(serializers.Serializer):
  30     vnfInstId = serializers.CharField(help_text="ID of VNF instance", required=True)
  31     vnfName = serializers.CharField(help_text="Name of VNF instance", required=True)
  32     vnfStatus = serializers.CharField(help_text="Status of VNF instance", required=True)
  33
  34
  35 class TerminateVnfReqSerializer(serializers.Serializer):
  36     terminationType = serializers.CharField(help_text="Termination Type", required=False, allow_null=True)
  37     gracefulTerminationTimeout = serializers.CharField(help_text="Graceful Termination Timeout", required=False, allow_null=True)
  38
  39
  40 class TerminateVnfRespSerializer(serializers.Serializer):
  41     jobId = serializers.CharField(help_text="ID of Job", required=True)
  42
  43
  44 class ResourceChangeSerializer(serializers.Serializer):
  45     type = serializers.ChoiceField(help_text="Change Type", choices=["VDU"], required=True)
  46     resourceDefinitionId = serializers.CharField(help_text="Identifier of resource", required=False, allow_null=True)
  47     vdu = serializers.CharField(help_text="Identifier identifier of VDU", required=False, allow_null=True)
  48
  49
  50 class GrantVnfReqSerializer(serializers.Serializer):
  51     vnfInstanceId = serializers.CharField(help_text="ID of VNF instance", required=True)
  52     vnfDescriptorId = serializers.CharField(help_text="ID of VNF Descriptor", required=False, allow_null=True)
  53     lifecycleOperation = serializers.ChoiceField(
  54         help_text="Lifecycle Operation",
  55         choices=["Terminal", "Instantiate", "Scalein", "Scaleout", "Scaledown", "Scaleup", "Heal"],
  56         required=True
  57     )
  58     jobId = serializers.CharField(help_text="ID of Job", required=False, allow_null=True)
  59     addResource = ResourceChangeSerializer(help_text="Add resources", many=True)
  60     removeResource = ResourceChangeSerializer(help_text="Remove resources", many=True)
  61     additionalParam = serializers.DictField(
  62         help_text="Additional parameters passed to the NFVO, specific to the VNF and the LCM operation. The currently interpreted keys are the following: vimId",
  63         child=serializers.CharField(help_text="Additional parameters", allow_blank=True),
  64         required=False,
  65         allow_null=True
  66     )
  67
  68
  69 class AccessinfoSerializer(serializers.Serializer):
  70     tenant = serializers.CharField(help_text="Name of tenant", required=True)
  71
  72
  73 class VimSerializer(serializers.Serializer):
  74     vimid = serializers.CharField(help_text="ID of VIM", required=True)
  75     accessinfo = AccessinfoSerializer(help_text="Access Info", required=False)
  76     accessInfo = AccessinfoSerializer(help_text="Access Info", required=False)
  77
  78
  79 class GrantVnfRespSerializer(serializers.Serializer):
  80     vnfInstanceId = serializers.CharField(help_text="ID of VNF instance", required=False, allow_null=True)
  81     vim = VimSerializer(help_text="VIM Info", required=True)
  82
  83
  84 class AffectedVnfcSerializer(serializers.Serializer):
  85     vnfcInstanceId = serializers.CharField(help_text="ID of VNFC instance", required=False, allow_null=True)
  86     vduId = serializers.CharField(help_text="ID of VDU in VNFD", required=False, allow_null=True)
  87     changeType = serializers.ChoiceField(
  88         help_text="Type of Change",
  89         choices=["added", "removed", "modified"],
  90         required=True
  91     )
  92     vimId = serializers.CharField(help_text="ID of VIM", required=False, allow_null=True)
  93     vmId = serializers.CharField(help_text="ID of virtual machine", required=False, allow_null=True)
  94     vmName = serializers.CharField(help_text="Name of virtual machine", required=False, allow_null=True)
  95
  96
  97 class NetworkResourceSerializer(serializers.Serializer):
  98     resourceType = serializers.ChoiceField(
  99         help_text="Type of Resource",
 100         choices=["network", "port"],
 101         required=True
 102     )
 103     resourceId = serializers.CharField(help_text="ID of network resource", required=False, allow_null=True)
 104     resourceName = serializers.CharField(help_text="Name of network resource", required=False, allow_null=True)
 105
 106
 107 class AffectedVirtualLinkSerializer(serializers.Serializer):
 108     vlInstanceId = serializers.CharField(help_text="ID of VL instance", required=False, allow_null=True)
 109     vldId = serializers.CharField(help_text="ID of VLD in VNFD", required=False, allow_null=True)
 110     changeType = serializers.ChoiceField(
 111         help_text="Type of Change",
 112         choices=["added", "removed", "modified"],
 113         required=True
 114     )
 115     networkResource = NetworkResourceSerializer(help_text="Network Resource", required=False, allow_null=True)
 116
 117
 118 class PortResourceSerializer(serializers.Serializer):
 119     vimId = serializers.CharField(help_text="ID of VIM", required=False, allow_null=True)
 120     resourceId = serializers.CharField(help_text="ID of Resource", required=False, allow_null=True)
 121     resourceName = serializers.CharField(help_text="Name of Resource", required=False, allow_null=True)
 122     tenant = serializers.CharField(help_text="ID of Tenant", required=False, allow_null=True)
 123     ipAddress = serializers.CharField(help_text="IP address of port", required=False, allow_null=True)
 124     macAddress = serializers.CharField(help_text="MAC address of port", required=False, allow_null=True)
 125     instId = serializers.CharField(help_text="Instance id of server to which the port is attached to", required=False, allow_null=True)
 126
 127
 128 class AffectedCpSerializer(serializers.Serializer):
 129     changeType = serializers.ChoiceField(
 130         help_text="Type of Change",
 131         choices=["added", "removed", "modified"],
 132         required=True
 133     )
 134     virtualLinkInstanceId = serializers.CharField(help_text="ID of VL instance", required=False, allow_null=True)
 135     cpInstanceId = serializers.CharField(help_text="ID of CP instance", required=False, allow_null=True)
 136     cpdId = serializers.CharField(help_text="ID of CPD in VNFD", required=False, allow_null=True)
 137     ownerType = serializers.CharField(help_text="Type of Owner", required=False, allow_null=True)
 138     ownerId = serializers.CharField(help_text="ID of Owner", required=False, allow_null=True)
 139     portResource = PortResourceSerializer(help_text="Port Resource", required=False, allow_null=True)
 140
 141
 142 class AffectedVirtualStorage(serializers.Serializer):
 143     pass
 144
 145
 146 class NotifyLcmReqSerializer(serializers.Serializer):
 147     status = serializers.ChoiceField(
 148         help_text="Status of operation",
 149         choices=["result", "start"],
 150         required=True
 151     )
 152     operation = serializers.ChoiceField(
 153         help_text="Lifecycle Operation",
 154         choices=["Terminal", "Instantiate", "Scalein", "Scaleout", "Scaledown", "Scaleup", "Heal"],
 155         required=True
 156     )
 157     jobId = serializers.CharField(help_text="ID of Job", required=False, allow_null=True)
 158     vnfdmodule = serializers.CharField(help_text="VNFD Module", required=False, allow_null=True)
 159     affectedVnfc = AffectedVnfcSerializer(help_text="Affected VNFC", many=True)
 160     affectedVl = AffectedVirtualLinkSerializer(help_text="Affected VL", many=True)
 161     affectedCp = AffectedCpSerializer(help_text="Affected CP", many=True)
 162     affectedVirtualStorage = AffectedVirtualStorage(help_text="Affected Virtual Storage(Not supported)", many=True)
 163
 164
 165 class ScaleVnfDataSerializer(serializers.Serializer):
 166     type = serializers.ChoiceField(
 167         help_text="Direction of the scaling",
 168         choices=["SCALE_IN", "SCALE_OUT"],
 169         required=True
 170     )
 171     aspectId = serializers.CharField(help_text="Aspect ID of the VNF that is requested to be scaled", required=False, allow_null=True)
 172     numberOfSteps = serializers.CharField(help_text="Number of scaling steps to be executed as part of this ScaleVnf operation", required=False, allow_null=True)
 173     additionalParam = serializers.DictField(
 174         help_text="Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled",
 175         child=serializers.CharField(help_text="Additional parameters", allow_blank=True),
 176         required=False,
 177         allow_null=True
 178     )
 179
 180
 181 class ScaleVnfReqSerializer(serializers.Serializer):
 182     scaleVnfData = ScaleVnfDataSerializer(help_text="Scale data", many=False)
 183
 184
 185 class ScaleVnfRespSerializer(serializers.Serializer):
 186     jobId = serializers.CharField(help_text="ID of Job", required=True)
 187
 188
 189 class VerifyVnfReqSerializer(serializers.Serializer):
 190     PackageID = serializers.CharField(help_text="ID of Package", required=True)
 191
 192
 193 class VerifyVnfRespSerializer(serializers.Serializer):
 194     jobId = serializers.CharField(help_text="ID of Job", required=True)
 195
 196
 197 class VnfmInfoRespSerializer(serializers.Serializer):
 198     vnfmId = serializers.CharField(help_text="ID of VNFM", required=True)
 199     name = serializers.CharField(help_text="Name of VNFM", required=True)
 200     type = serializers.CharField(help_text="Type of VNFM", required=True)
 201     vimId = serializers.CharField(help_text="ID of VIM", required=True)
 202     vendor = serializers.CharField(help_text="Vendor of VNFM", required=False, allow_null=True, allow_blank=True)
 203     version = serializers.CharField(help_text="Version of VNFM", required=False, allow_null=True, allow_blank=True)
 204     description = serializers.CharField(help_text="Description of VNFM", required=False, allow_null=True, allow_blank=True)
 205     certificateUrl = serializers.CharField(help_text="Certificate PEM of VNFM", required=False, allow_null=True, allow_blank=True)
 206     url = serializers.CharField(help_text="url of VNFM", required=False, allow_null=True, allow_blank=True)
 207     userName = serializers.CharField(help_text="User Name of VNFM", required=False, allow_null=True, allow_blank=True)
 208     password = serializers.CharField(help_text="Password of VNFM", required=False, allow_null=True, allow_blank=True)
 209     createTime = serializers.CharField(help_text="Create Time of VNFM", required=False, allow_null=True, allow_blank=True)
 210
 211
 212 class VimInfoRespSerializer(serializers.Serializer):
 213     vimId = serializers.CharField(help_text="ID of VIM", required=True)
 214     name = serializers.CharField(help_text="Name of VIM", required=True)
 215     url = serializers.CharField(help_text="Url of VIM", required=True)
 216     userName = serializers.CharField(help_text="User Name of VIM", required=True)
 217     password = serializers.CharField(help_text="Password of VIM", required=True)
 218     tenantId = serializers.CharField(help_text="Tenant ID of VIM", required=False, allow_null=True, allow_blank=True)
 219     tenant = serializers.CharField(help_text="Default Tenant of VIM", required=False, allow_null=True, allow_blank=True)
 220     vendor = serializers.CharField(help_text="Vendor of VIM", required=False, allow_null=True, allow_blank=True)
 221     version = serializers.CharField(help_text="Version of VIM", required=False, allow_null=True, allow_blank=True)
 222     description = serializers.CharField(help_text="Description of VIM", required=False, allow_null=True, allow_blank=True)
 223     domain = serializers.CharField(help_text="Domain of VIM", required=False, allow_null=True, allow_blank=True)
 224     type = serializers.CharField(help_text="Type of VIM", required=True)
 225     createTime = serializers.CharField(help_text="Create Time of VIM", required=False, allow_null=True, allow_blank=True)
 226     sslCacert = serializers.CharField(help_text="SSL Cacert of VIM", required=False, allow_null=True, allow_blank=True)
 227     sslInsecure = serializers.CharField(help_text="SSL Insecure of VIM", required=False, allow_null=True, allow_blank=True)
 228     status = serializers.CharField(help_text="Status of VIM", required=False, allow_null=True, allow_blank=True)
 229
 230
 231 class CandidateSerializer(serializers.Serializer):
 232     identifierType = serializers.ChoiceField(
 233         help_text="The type of a candidate",
 234         choices=["serviceInstanceId", "vnfName", "cloudRegionId", "vimId"],
 235         required=True
 236     )
 237     identifiers = serializers.ListField(
 238         help_text="A list of identifiers",
 239         child=serializers.CharField(help_text="One identifier", required=True),
 240         required=True
 241     )
 242     cloudOwner = serializers.CharField(
 243         help_text="The name of a cloud owner. Only required if identifier Type is cloudRegionId", required=False)
 244
 245
 246 class LicenseSolutionSerializer(serializers.Serializer):
 247     resourceModuleName = serializers.CharField(help_text="Name of Resource as defined in the Service Model",
 248                                                required=True)
 249     serviceResourceId = serializers.CharField(help_text="Resource Id defined in the Service Model", required=True)
 250     entitlementPoolUUID = serializers.ListField(
 251         help_text="A list of entitlementPoolUUIDs",
 252         child=serializers.CharField(help_text="entitlementPoolUUID", required=True),
 253         required=True
 254     )
 255     licenseKeyGroupUUID = serializers.ListField(
 256         help_text="A list of licenseKeyGroupUUID",
 257         child=serializers.CharField(help_text="licenseKeyGroupUUID", required=True),
 258         required=True
 259     )
 260     entitlementPoolInvariantUUID = serializers.ListField(
 261         help_text="A list of entitlementPoolInvariantUUIDs",
 262         child=serializers.CharField(help_text="entitlementPoolInvariantUUID", required=True),
 263         required=True
 264     )
 265     licenseKeyGroupInvariantUUID = serializers.ListField(
 266         help_text="A list of licenseKeyGroupInvariantUUID",
 267         child=serializers.CharField(help_text="licenseKeyGroupInvariantUUID", required=True),
 268         required=True
 269     )
 270
 271
 272 class AssignmentInfoSerializer(serializers.Serializer):
 273     key = serializers.CharField(help_text="Any attribute Key needed", required=True)
 274     value = serializers.CharField(help_text="Attribute value for that key", required=True)
 275
 276
 277 class PlacementSolutionSerializer(serializers.Serializer):
 278     resourceModuleName = serializers.CharField(help_text="Name of Resource as defined in the Service Model",
 279                                                required=True)
 280     serviceResourceId = serializers.CharField(help_text="Resource Id defined in the Service Model", required=True)
 281     solution = CandidateSerializer(help_text="The Placement Solution", required=True)
 282     assignmentInfo = AssignmentInfoSerializer(help_text="Additonal information related to a candidate",
 283                                               required=False, many=True)
 284
 285
 286 class ComprehensiveSolutionSerializer(serializers.Serializer):
 287     child = serializers.ListField(
 288         help_text="A list of placement solutions",
 289         child=PlacementSolutionSerializer(help_text="A list of placement solutions"),
 290         allow_empty=True,
 291         required=True)
 292
 293
 294 class SolutionSerializer(serializers.Serializer):
 295     placementSolutions = ComprehensiveSolutionSerializer(help_text="A list of Placement Solutions",
 296                                                          required=True, many=True)
 297     licenseSolutions = LicenseSolutionSerializer(help_text="A list of License Solutions",
 298                                                  required=True, many=True)
 299
 300
 301 class PlaceVnfReqSerializer(serializers.Serializer):
 302     requestId = serializers.UUIDField(help_text="ID of Homing Request", required=True)
 303     transactionId = serializers.UUIDField(help_text="ID of Homing Transaction", required=True, allow_null=False)
 304     statusMessage = serializers.CharField(help_text="Status Message of Request", required=False, allow_null=True)
 305     requestStatus = serializers.ChoiceField(
 306         help_text="The Status of a Request",
 307         choices=["completed", "failed", "pending"],
 308         required=True,
 309         allow_null=False
 310     )
 311     solutions = SolutionSerializer(help_text="Request Solutions", required=True, allow_null=False)