sig_cloud/diskimage-builder
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6c0eb3d905
diskimage-builder/diskimage_builder/elements/svc-map
History
Ian Wienand 97c01e48ed Move elements & lib relative to diskimage_builder package 
Currently we have all our elements and library files in a top-level
directory and install them into
<root>/share/diskimage-builder/[elements|lib] (where root is either /
or the root of a virtualenv).

The problem with this is that editable/development installs (pip -e)
do *not* install data_files.  Thus we have no canonical location to
look for elements -- leading to the various odd things we do such as a
whole bunch of guessing at the top of disk-image-create and having a
special test-loader in tests/test_elements.py so we can run python
unit tests on those elements that have it.

data_files is really the wrong thing to use for what are essentially
assets of the program.  data_files install works well for things like
config-files, init.d files or dropping documentation files.

By moving the elements under the diskimage_builder package, we always
know where they are relative to where we import from.  In fact,
pkg_resources has an api for this which we wrap in the new
diskimage_builder/paths.py helper [1].

We use this helper to find the correct path in the couple of places we
need to find the base-elements dir, and for the paths to import the
library shell functions.

Elements such as svc-map and pkg-map include python unit-tests, which
we do not need tests/test_elements.py to special-case load any more.
They just get found automatically by the normal subunit loader.

I have a follow-on change (I69ca3d26fede0506a6353c077c69f735c8d84d28)
to move disk-image-create to a regular python entry-point.

Unfortunately, this has to move to work with setuptools.  You'd think
a symlink under diskimage_builder/[elements|lib] would work, but it
doesn't.

[1] this API handles stuff like getting files out of .zip archive
modules, which we don't do.  Essentially for us it's returning
__file__.

Change-Id: I5e3e3c97f385b1a4ff2031a161a55b231895df5b
2016-11-01 17:27:41 -07:00
..
bin Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
extra-data.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
tests Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
package-installs.yaml Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
pkg-map Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
README.rst Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00

README.rst 

=======
svc-map
=======
Map service names to distro specific services.

Provides the following:

 * bin/svc-map

   usage: svc-map [-h] SERVICE

   Translate service name to distro specific name.

   optional arguments:
     -h, --help         show this help message and exit

 * Any element may create its own svc-map YAML config file using
   the one of 3 sections for the distro/family/ and or default.
   The family is set automatically within svc-map based on
   the supplied distro name. Families include:

     + redhat: includes centos, fedora, and rhel distros
     + debian: includes debian and ubuntu distros
     + suse: includes the opensuse distro

   The most specific section takes priority. Example for Nova and Glance
   (NOTE: default is using the common value for redhat and suse families)

   The key used for the service name should always be the same name used for
   the source installation of the service.  The svc-map script will check for
   the source name against systemd and upstart and return that name if it
   exists instead of the mapped name.

    Example format for Nova::

      nova-api:
        default: openstack-nova-api
        debian: nova-api
      nova-cert:
        default: openstack-nova-cert
        debian:  nova-cert
      nova-compute:
        default: openstack-nova-compute
        debian: nova-compute
      nova-conductor:
        default: openstack-nova-conductor
        debian: nova-conductor
      nova-consoleauth:
        default: openstack-nova-console
        debian: nova-console


    Example format for Glance::

      glance-api:
        debian: glance-api
        default: openstack-glance-api
      glance-reg:
        debian: glance-reg
        default: openstack-glance-registry


    If the distro is of the debian family the combined services file would be::

        nova-cert: nova-cert
        nova-compute: nova-compute
        glance-api: glance-api
        nova-conductor: nova-conductor
        nova-api: nova-api
        glance-reg: glance-reg
        nova-consoleauth: nova-console


    If the distro is of the suse or redhat families the combined services file would be::

        nova-cert: openstack-nova-cert
        nova-compute: openstack-nova-compute
        glance-reg: openstack-glance-registry
        nova-conductor: openstack-nova-conductor
        glance-api: openstack-glance-api
        nova-consoleauth: openstack-nova-console
        nova-api: openstack-nova-api


   Example commands using this format::

       svc-map nova-compute

       Returns: openstack-nova-compute

       svc-map nova-compute

       Returns: openstack-nova-compute

       svc-map nova-compute

       Returns: nova-compute

 * This output can be used to filter what other tools actually install
   (install-services can be modified to use this for example)

 * If you pass more than one service argument, the result for each service
   is printed on its own line.

 * Individual svc-map files live within each element. For example
   if you have created an Apache element your svc-map YAML file
   should be created at elements/apache/svc-map.