sig_cloud/diskimage-builder
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
diskimage-builder/diskimage_builder/elements/pkg-map/README.rst

97 lines
2.6 KiB
ReStructuredText
Raw Permalink Normal View History

Create docs site containing element READMEs We currently do not have the ability to create a docs site which outlines all the elements. Change-Id: I77ccf61e0c4b1509b3e7ce9b8f15ea5ccfd50d9b
2015-02-07 10:30:02 +00:00
=======
pkg-map
=======
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
Map package names to distro specific packages.
Provides the following:
Turn docs warnings into errors and fix issues Set the pbr option 'warnerrors' to make build_sphinx turns warnings into error. Fix all warnings. `tox -edocs` will thus abort whenever someone introduce a new error. Change-Id: Id6d09768a241866e1fdc1a1e2bf90336f5c5087d
2015-04-27 14:50:37 +00:00
* bin/pkg-map::
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
Turn docs warnings into errors and fix issues Set the pbr option 'warnerrors' to make build_sphinx turns warnings into error. Fix all warnings. `tox -edocs` will thus abort whenever someone introduce a new error. Change-Id: Id6d09768a241866e1fdc1a1e2bf90336f5c5087d
2015-04-27 14:50:37 +00:00
usage: pkg-map [-h] [--element ELEMENT] [--distro DISTRO]
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
Turn docs warnings into errors and fix issues Set the pbr option 'warnerrors' to make build_sphinx turns warnings into error. Fix all warnings. `tox -edocs` will thus abort whenever someone introduce a new error. Change-Id: Id6d09768a241866e1fdc1a1e2bf90336f5c5087d
2015-04-27 14:50:37 +00:00
Translate package name to distro specific name.
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
Turn docs warnings into errors and fix issues Set the pbr option 'warnerrors' to make build_sphinx turns warnings into error. Fix all warnings. `tox -edocs` will thus abort whenever someone introduce a new error. Change-Id: Id6d09768a241866e1fdc1a1e2bf90336f5c5087d
2015-04-27 14:50:37 +00:00
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
Add release to pkg-map Add ability to filter in pkg-map on release, which defaults to DIB_RELEASE. As per the examples, release is a more specific target than distro, but distro still has to match. Added a debug flag and ability to use a pkg-map directly for debugging/development. Change-Id: Ie282f96966e46236b06bc276de0168fc7a66c5da
2016-05-20 04:26:25 +00:00
--release RELEASE The release to use for translation. Defaults to
DIB_RELEASE
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
Add release to pkg-map Add ability to filter in pkg-map on release, which defaults to DIB_RELEASE. As per the examples, release is a more specific target than distro, but distro still has to match. Added a debug flag and ability to use a pkg-map directly for debugging/development. Change-Id: Ie282f96966e46236b06bc276de0168fc7a66c5da
2016-05-20 04:26:25 +00:00
* 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:
Turn docs warnings into errors and fix issues Set the pbr option 'warnerrors' to make build_sphinx turns warnings into error. Fix all warnings. `tox -edocs` will thus abort whenever someone introduce a new error. Change-Id: Id6d09768a241866e1fdc1a1e2bf90336f5c5087d
2015-04-27 14:50:37 +00:00
Introduce openEuler distro Add openeuler-minimal element and add CI functional tests for both x86_64 and arm64. OpenEuler is an open source community driven YUM/DNF distro like Fedora. It references Fedora and CentOS a lot for the rpm packages building. So somewhat it can be treated as a redhat family distro and reuse the YUM/DNF related elements to help build openEuler images. For more info about openEuler, see: https://openeuler.org/en Depends-On: https://review.opendev.org/c/zuul/zuul-jobs/+/803413 Change-Id: I3e06e49b524364c3a4edeba8bce7a8c06b9c7b76
2021-04-01 02:13:12 +00:00
+ redhat: includes centos, fedora, openeuler and rhel distros
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
+ debian: includes debian and ubuntu distros
+ suse: includes the opensuse distro
Add release to pkg-map Add ability to filter in pkg-map on release, which defaults to DIB_RELEASE. As per the examples, release is a more specific target than distro, but distro still has to match. Added a debug flag and ability to use a pkg-map directly for debugging/development. Change-Id: Ie282f96966e46236b06bc276de0168fc7a66c5da
2016-05-20 04:26:25 +00:00
The release is a specification of distro; i.e. the distro and
release must mach for a translation.
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
The most specific section takes priority.
Add release to pkg-map Add ability to filter in pkg-map on release, which defaults to DIB_RELEASE. As per the examples, release is a more specific target than distro, but distro still has to match. Added a debug flag and ability to use a pkg-map directly for debugging/development. Change-Id: Ie282f96966e46236b06bc276de0168fc7a66c5da
2016-05-20 04:26:25 +00:00
Allow to specify an empty package list in pkg_map An empty package list can be provided in a pkg_map file for those cases were there is no need to install the package. Change-Id: I0df8c6848ec4ac9e0f90790f14e8eb5399650339
2014-08-11 12:35:13 +00:00
An empty package list can be provided.
Add release to pkg-map Add ability to filter in pkg-map on release, which defaults to DIB_RELEASE. As per the examples, release is a more specific target than distro, but distro still has to match. Added a debug flag and ability to use a pkg-map directly for debugging/development. Change-Id: Ie282f96966e46236b06bc276de0168fc7a66c5da
2016-05-20 04:26:25 +00:00
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
Example for Nova and Glance (NOTE: using fictitious package names
Allow to specify an empty package list in pkg_map An empty package list can be provided in a pkg_map file for those cases were there is no need to install the package. Change-Id: I0df8c6848ec4ac9e0f90790f14e8eb5399650339
2014-08-11 12:35:13 +00:00
for Fedora and package mapping for suse family to provide a good
example!)
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
Turn docs warnings into errors and fix issues Set the pbr option 'warnerrors' to make build_sphinx turns warnings into error. Fix all warnings. `tox -edocs` will thus abort whenever someone introduce a new error. Change-Id: Id6d09768a241866e1fdc1a1e2bf90336f5c5087d
2015-04-27 14:50:37 +00:00
Example format::
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
{
Add release to pkg-map Add ability to filter in pkg-map on release, which defaults to DIB_RELEASE. As per the examples, release is a more specific target than distro, but distro still has to match. Added a debug flag and ability to use a pkg-map directly for debugging/development. Change-Id: Ie282f96966e46236b06bc276de0168fc7a66c5da
2016-05-20 04:26:25 +00:00
"release": {
"fedora": {
"23": {
"nova_package": "foo" "bar"
}
}
},
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
"distro": {
"fedora": {
"nova_package": "openstack-compute",
"glance_package": "openstack-image"
}
},
"family": {
"redhat": {
"nova_package": "openstack-nova",
"glance_package": "openstack-glance"
Allow to specify an empty package list in pkg_map An empty package list can be provided in a pkg_map file for those cases were there is no need to install the package. Change-Id: I0df8c6848ec4ac9e0f90790f14e8eb5399650339
2014-08-11 12:35:13 +00:00
},
"suse": {
"nova_package": ""
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
}
},
"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
Allow to specify an empty package list in pkg_map An empty package list can be provided in a pkg_map file for those cases were there is no need to install the package. Change-Id: I0df8c6848ec4ac9e0f90790f14e8eb5399650339
2014-08-11 12:35:13 +00:00
pkg-map --element nova-compute --distro opensuse nova_package
Returns:
Add pkg-map element. Adds a new pkg-map element which can be used to install packages based on an in element 'pkg-map' JSON config file format. As part of this change we expose DIB's IMAGE_ELEMENT variable so that we can have access to the element names which are being installed in a clean manner. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various package naming schemes) without having to constantly maintain DIB's various bin/map-packages files. Change-Id: Ic0a061995e2ae708c95a535cba6237bff58f7d93
2014-05-01 16:13:47 +00:00
* 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.
Reference in New Issue Copy Permalink