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

105 lines
3.0 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
=======
svc-map
=======
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +00:00
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:
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
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +00:00
+ 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.
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 for Nova::
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +00:00
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
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 for Glance::
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +00:00
glance-api:
debian: glance-api
default: openstack-glance-api
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
If the distro is of the debian family the combined services file would be::
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +00:00
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
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
If the distro is of the suse or redhat families the combined services file would be::
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +00:00
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
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 commands using this format::
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +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
svc-map nova-compute
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +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
Returns: openstack-nova-compute
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +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
svc-map nova-compute
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +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
Returns: openstack-nova-compute
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +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
svc-map nova-compute
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +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
Returns: nova-compute
Add svc-map element. Adds a new svc-map element which can be used to install services based on an in element 'svc-map' YAML config file format. This change is intended to decouple elements from DIB and allow new elements to support multiple distributions (with various service naming schemes) without having to constantly maintain DIB's various bin/map-services files. This patch ensures all of the YAML files are compiled into a single file without namespaces. The YAML compilation process occurs during image creation time and errors if conflicting mappings are found. Change-Id: Id11433ea342aace71a358936a7ca3151ec11d506
2014-05-30 13:53:06 +00:00
* 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.
Reference in New Issue Copy Permalink