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