README

   1 #
   2 #   Copyright 2016 RIFT.IO Inc
   3 #
   4 #   Licensed under the Apache License, Version 2.0 (the "License");
   5 #   you may not use this file except in compliance with the License.
   6 #   You may obtain a copy of the License at
   7 #
   8 #       http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #   Unless required by applicable law or agreed to in writing, software
  11 #   distributed under the License is distributed on an "AS IS" BASIS,
  12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #   See the License for the specific language governing permissions and
  14 #   limitations under the License.
  15 #
  16 # Author(s): Austin Cormier
  17 # Creation Date: 2016/05/23
  18
  19
  20 Generates the MWC16 NSD and VNFD descriptor packages from source.
  21
  22 To generate the packages type "make". The VNF and NSD packages will be located
  23 build/vnfd_pkgs and build/nsd_pkgs.
  24
  25 To clean, type 'make clean'.
  26
  27 You need to install charm tools to compile the charms required for the packages.
  28 On Fedora, install using: pip install charm-tools
  29 On Ubuntu, install using: apt install charm-tools
  30 For other platforms, check https://jujucharms.com/docs/2.0/tools-charm-tools
  31
  32 Due to license issues, for the IMS VNFD package, the IMS charm is fetched
  33 extracted from the respective git repository prior to packaging.  Because of
  34 this, internet access is required to reach github.