openstack
/
diskimage-builder
Code Issues Proposed changes
diskimage-builder/diskimage_builder/elements/pkg-map
History
Ian Wienand 28ebd24844 Uncap hacking 
This causes problems for other projects incorporating dib; we don't
have a specific need for a cap.

Fix a few issues, mostly spacing or regex matches.  No functional
changes.

W503 and W504 relate to leaving artithmetic operators at the start or
end of lines, and are mutually exclusive and, due to "ignore"
overriding the defaults both get enabled.  It seems everyone gets this
wrong (https://gitlab.com/pycqa/flake8/issues/466).  Don't take a
position on this and ignore both.

Use double # around comments including YAML snippets using "# type: "
which now gets detected as PEP484/mypy type hints.

Change-Id: I8b7ce6dee02dcce31c82427a2441c931d136ef57
 		2020-02-24 10:34:46 +11:00
..
bin Uncap hacking 2020-02-24 10:34:46 +11:00
extra-data.d Turn down pkg-map and hook copy tracing output 2018-10-18 11:03:17 +11:00
README.rst Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
element-deps Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00

README.rst

pkg-map

Map package names to distro specific packages.

Provides the following:

  • bin/pkg-map:

    usage: pkg-map [-h] [--element ELEMENT] [--distro DISTRO]

Translate package name to distro specific name.

optional arguments:
  -h, --help         show this help message and exit
  --element ELEMENT  The element (namespace) to use for translation.
  --distro DISTRO    The distro name to use for translation. Defaults to
                     DISTRO_NAME
  --release RELEASE  The release to use for translation.  Defaults to
                     DIB_RELEASE

  • Any element may create its own pkg-map JSON config file using the one of 4 sections for the release/distro/family/ and or default. The family is set automatically within pkg-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 release is a specification of distro; i.e. the distro and release must mach for a translation.

    The most specific section takes priority.

    An empty package list can be provided.

    Example for Nova and Glance (NOTE: using fictitious package names for Fedora and package mapping for suse family to provide a good example!)

    Example format:

    {
  "release": {
    "fedora": {
      "23": {
        "nova_package": "foo" "bar"
      }
    }
  },
  "distro": {
    "fedora": {
      "nova_package": "openstack-compute",
      "glance_package": "openstack-image"
    }
  },
  "family": {
    "redhat": {
      "nova_package": "openstack-nova",
      "glance_package": "openstack-glance"
    },
    "suse": {
      "nova_package": ""
    }
  },
  "default": {
    "nova_package": "nova",
    "glance_package": "glance"
  }
}

    Example commands using this format:

    pkg-map --element nova-compute --distro fedora nova_package

    Returns: openstack-compute

    pkg-map --element nova-compute --distro rhel nova_package

    Returns: openstack-nova

    pkg-map --element nova-compute --distro ubuntu nova_package

    Returns: nova

    pkg-map --element nova-compute --distro opensuse nova_package

    Returns:

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

  • Individual pkg-map files live within each element. For example if you are created an Apache element your pkg-map JSON file should be created at elements/apache/pkg-map.