/** * ============LICENSE_START======================================================= * org.onap.aai * ================================================================================ * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. * Copyright © 2017-2018 European Software Marketing Ltd. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * ============LICENSE_END========================================================= */ package org.onap.aai.babel.csar.vnfcatalog; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; import java.util.ArrayList; import java.util.List; import java.util.Map; import java.util.Map.Entry; import java.util.Objects; import java.util.function.Consumer; import java.util.stream.Collectors; import org.apache.commons.io.FileUtils; import org.apache.commons.lang3.time.StopWatch; import org.apache.commons.lang3.tuple.ImmutablePair; import org.apache.commons.lang3.tuple.Pair; import org.onap.aai.babel.logging.ApplicationMsgs; import org.onap.aai.babel.logging.LogHelper; import org.onap.aai.babel.service.data.BabelArtifact; import org.onap.sdc.tosca.parser.api.ISdcCsarHelper; import org.onap.sdc.tosca.parser.exceptions.SdcToscaParserException; import org.onap.sdc.tosca.parser.impl.SdcToscaParserFactory; import org.onap.sdc.tosca.parser.impl.SdcTypes; import org.onap.sdc.toscaparser.api.NodeTemplate; import org.onap.sdc.toscaparser.api.SubstitutionMappings; /** * This class is responsible for extracting Virtual Network Function (VNF) information from a TOSCA 1.1 CSAR package. * *
* CSAR is a compressed format that stores multiple TOSCA files. Each TOSCA file may define Topology Templates and/or * Node Templates along with other model data. * *
* A VNF is a virtualized functional capability (e.g. a Router) that may be defined by an external Vendor. Within the * model defined by the TOSCA files the VNF is considered to be a Resource (part of a Service). * *
* A VNF is specified by a Topology Template. Because this TOSCA construct does not allow properties to be defined * directly, Node Templates are defined (identified by a VNF type value) storing the VNF metadata and properties. * *
* A VNF may be composed of multiple images, each running on its own Virtual Machine. The function of a deployed image * is designated the Virtual Function Component (VFC). A VFC is a sub-component of the VNF. A VFC may have different * "Flavors" (see the Deployment Flavors description below). * *
* An individual VNF (template) may be deployed with varying configuration values, according to * environment/customer/business needs. For example, a VNF deployed in a testing environment would typically use fewer * computational resources than in a production setting. * *
* A Vendor may define one or more "Deployment Flavors". A Deployment Flavor describes a set of pre-determined * parameterised values for a specific aspect of the model. Within the TOSCA model there is a DeploymentFlavor * definition, which has its own data types, and also an ImageInfo definition. */ public class VnfVendorImageExtractor { private static LogHelper applicationLogger = LogHelper.INSTANCE; private static final String AN_ERROR_OCCURRED = "An error occurred trying to get the vnf catalog from a csar file."; // The following constants describe the expected naming conventions for TOSCA Node Templates which // store the VNF // configuration and the VFC data items. // The name of the property (for a VNF Configuration type) storing the Images Information private static final String IMAGES = "images"; // Name of property key that contains the value of the software version private static final String SOFTWARE_VERSION = "software_version"; // The name of the property (for a VNF Configuration type) storing the Vendor Information private static final String VNF_CONF_TYPE_PROPERTY_VENDOR_INFO_CONTAINER = "allowed_flavors"; // Name of property key that contains the value of model of the vendor application private static final String VENDOR_MODEL = "vendor_model"; /** * This method is responsible for parsing the vnfConfiguration entity in the same topology_template (there's an * assumption that there's only one per file, awaiting verification). * *
* It is possible that csar file does not contain a vnfConfiguration and this is valid. * *
* Where multiple vnfConfigurations are found an exception will be thrown. * *
* The ASDC model anticipates the following permutations of vnfConfiguration and multiflavorVFC: * *
** * All ImageInfo sections found apply to all "Deployment Flavors", therefore we can apply a cross product of * "Deployment Flavors" x "ImageInfo" - concretely * * @param csar compressed format that stores multiple TOSCA files and in particular a vnfConfiguration * @return BabelArtifact VendorImageConfiguration objects created during processing represented as the Babel service * public data structure */ public BabelArtifact extract(byte[] csar) throws ToscaToCatalogException { StopWatch stopwatch = new StopWatch(); stopwatch.start(); Objects.requireNonNull(csar, "A CSAR file must be supplied"); applicationLogger.info(ApplicationMsgs.DISTRIBUTION_EVENT, "Starting to find and extract any vnf configuration data"); List*
*- Single vnfConfiguration, single multiFlavorVFC with multiple images.
*- Single vnfConfiguration, multi multiFlavorVFC with single images.
*