fuel/build/f_example_packadd/README

   1 ##############################################################################
   2 # Copyright (c) 2015 Ericsson AB and others.
   3 # stefan.k.berg@ericsson.com
   4 # jonas.bjurel@ericsson.com
   5 # All rights reserved. This program and the accompanying materials
   6 # are made available under the terms of the Apache License, Version 2.0
   7 # which accompanies this distribution, and is available at
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 ##############################################################################
  10
  11 This is an example of a an addition of an arbitrary debian package: foobar
  12 It adds the debian package foobar_1.0-1 to the fuel .iso image and deploys it
  13 to the controllers and the computes.
  14
  15 The f_example_packadd has the following structure:
  16 .
  17 +--------+----------+-----------+------------+
  18          |          |           |            |
  19       puppet/    Makefile     README    foobar_1.0-1/
  20          |                  (this file)  (deb pack)
  21          |
  22          |
  23       modules/
  24          |
  25          |
  26          |
  27        opnfv/
  28          |
  29          |
  30          |
  31      manifests/
  32          |
  33          |
  34          |
  35      foobar.pp
  36
  37 Makefile:
  38 Invoked by the git root Makefile, based on the foobar_1.0-1 deb pack artifacts, and the pupet manifests, it builds a deb package
  39 and adds it together with the manifest to a fuel build artifact directory, such that it eventually gets built into the new fuel .iso
  40
  41 foobar_1.0-1:
  42 Contains arbitrary debian package artifacts
  43
  44 foobar.pp:
  45 Controls the installation and configuration of foobar
  46
  47 To activate this example feature, add "SUBDIRS += f_example_packadd" in the git root Makefile.