97c01e48ed
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
38 lines
1.2 KiB
ReStructuredText
38 lines
1.2 KiB
ReStructuredText
===========
|
|
hwdiscovery
|
|
===========
|
|
A ramdisk to report the hardware of a machine to an inventory service.
|
|
|
|
This will collect up some basic information about the hardware it
|
|
boots on:
|
|
|
|
* CPU cores
|
|
* RAM
|
|
* Disk
|
|
* NIC mac address
|
|
|
|
This information will then be collated into a JSON document, base64
|
|
encoded and passed, via HTTP POST, to a URL that you must specify on
|
|
the kernel commandline, thus:
|
|
|
|
HW_DISCOVERY_URL=http://1.2.3.4:56/hw_script.asp
|
|
|
|
|
|
This is currently fairly fragile as there can be a huge variability in
|
|
the number of disks/NICs in servers and how they are configured.
|
|
|
|
If other elements wish to inject data into the hardware discovery data,
|
|
they can - they should be specified before hwdiscovery to the image
|
|
building script, and they should contain something like this in their
|
|
init fragment:
|
|
|
|
_vendor_hwdiscovery_data="$_vendor_hwdiscovery_data
|
|
\"some vendor key\" : \"some data you care about\",
|
|
\"some other vendor key\" : \"some other data you care about\","
|
|
|
|
Note that you are essentially feeding JSON into the main hwdiscovery
|
|
JSON.
|
|
|
|
This will allow any number of vendor specific hwdiscovery elements to
|
|
chain together their JSON fragments and maintain consistency.
|
|
|