| Name | glean JSON |
| Version |
1.24.0
JSON |
| download |
| home_page | https://www.openstack.org/ |
| Summary | Simple program to write static config from config-drive |
| upload_time | 2024-04-24 17:12:11 |
| maintainer | None |
| docs_url | None |
| author | OpenStack |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=====
glean
=====
Glean is a program intended to configure a system based on
configuration provided in a `configuration drive
<http://docs.openstack.org/user-guide/cli_config_drive.html>`__.
Why would you want glean?
-------------------------
Different cloud providers have different ways of providing networking
and other configuration to guest virtual-machines. Many use DHCP but
others, notably Rackspace, use configuration provided via a
configuration drive.
What does glean do?
-------------------
Broadly, glean checks for configuration drive based information and,
if found, uses that to configure the network. If config-drive is not
found, it falls back to configuring any available interfaces with
DHCP.
Specifically, it will mount the special block-device with label
`config-2` and parse the `network_info.json` and `vendor_info.json`
files within. If appropriate network configuration is found, it will
write out network configuration files.
The format of the `network_info.json` file is documented `here
<http://specs.openstack.org/openstack/nova-specs/specs/liberty/implemented/metadata-service-network-info.html#rest-api-impact>`__.
Please note that glean does not implement every feature listed.
If no network info is found there, available interfaces can be probed
from `/sys/class/net` and any that appear to be up will be configured
for use with DHCP.
It will also handle `authorized_keys` and host-name info provided from
`meta_data.json`.
How does glean do this?
+++++++++++++++++++++++
Glean determines the network configuration environment for the running
platform and configures the interfaces appropriately.
systemd environment
===================
On platforms where systemd is detected `glean-install` will add a
`udev` rules file (`99-glean.rules`) that triggers on any network
device being added. This will run the `glean@.service` systemd
template for the interface specified.
This systemd unit firstly determines if there is already a
`/etc/sysconfig/network/` configuration for the interface; if so, the
interface is considered configured and skipped.
If not, glean is started with the interface that triggered this event
specified as an argument. The configuration drive is probed to see if
network configuration for the interface is available. If so, it will
be added, otherwise the interface will configured for DHCP.
.. note ::
By default glean provides configuration for the network init
scripts service ``network.service`` on RedHat platforms (or the
equivalent on other platforms). You should ensure this service is
enabled and other tools such as NetworkManager are disabled for
correct operation in this mode. Note on Fedora 29 onwards, this is
in a separate package `network-scripts` and is considered
deprecated.
Alternatively, to use NetworkManager with the `ifcfg-rh` plugin
with to manage the interfaces, call `glean-install` with the
`--use-nm` flag. In this case, ensure NetworkManager is installed.
This will trigger glean to write out configuration files that are
suitable for use with NetworkManager and use a slightly different
service file that doesn't trigger legacy tools like `ifup`.
networkd
========
`networkd` support is implemented as a separate distribution type.
Currently it is only supported on Gentoo, and will be automatically
selected by `glean-install`. It will similarly install a systemd
service file or openrc config file (both are supported on Gentoo) and
udev rules to call glean.
Other platforms
===============
`upstart` and `sysv` environments are also supported. These will have
init scripts installed to run glean at boot.
How do I use glean?
-------------------
Glean ships `glean-install`, a script which install glean into your
system startup environment. It should handle `sysv`, `upstart` and
`systemd` to cover all major distributions. This should be run once,
during install or image build.
The startup environment will be modified as described above to
configure any found interfaces.
Differences to cloud-init?
--------------------------
Glean differs to `cloud-init` mainly in its very reduced dependency
footprint. In a dynamic CI environment such as OpenStack, many of the
python dependencies for `cloud-init` can cause conflicts with packages
or versions required for testing.
Glean also better supports static IP allocation within config-drive,
particuarly important within the Rackspace environment.
More details
------------
* Free software: Apache license
* Documentation: http://docs.openstack.org/infra/glean
* Source: http://git.openstack.org/cgit/openstack-infra/glean
* Bugs: http://storyboard.openstack.org
Raw data
{
"_id": null,
"home_page": "https://www.openstack.org/",
"name": "glean",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/e5/c8/058748b64c1ca7d00e1906714d48e5210bc9ceb7956f4dc0c8ad4fa05ee1/glean-1.24.0.tar.gz",
"platform": null,
"description": "=====\nglean\n=====\n\nGlean is a program intended to configure a system based on\nconfiguration provided in a `configuration drive\n<http://docs.openstack.org/user-guide/cli_config_drive.html>`__.\n\nWhy would you want glean?\n-------------------------\n\nDifferent cloud providers have different ways of providing networking\nand other configuration to guest virtual-machines. Many use DHCP but\nothers, notably Rackspace, use configuration provided via a\nconfiguration drive.\n\nWhat does glean do?\n-------------------\n\nBroadly, glean checks for configuration drive based information and,\nif found, uses that to configure the network. If config-drive is not\nfound, it falls back to configuring any available interfaces with\nDHCP.\n\nSpecifically, it will mount the special block-device with label\n`config-2` and parse the `network_info.json` and `vendor_info.json`\nfiles within. If appropriate network configuration is found, it will\nwrite out network configuration files.\n\nThe format of the `network_info.json` file is documented `here\n<http://specs.openstack.org/openstack/nova-specs/specs/liberty/implemented/metadata-service-network-info.html#rest-api-impact>`__.\nPlease note that glean does not implement every feature listed.\n\nIf no network info is found there, available interfaces can be probed\nfrom `/sys/class/net` and any that appear to be up will be configured\nfor use with DHCP.\n\nIt will also handle `authorized_keys` and host-name info provided from\n`meta_data.json`.\n\nHow does glean do this?\n+++++++++++++++++++++++\n\nGlean determines the network configuration environment for the running\nplatform and configures the interfaces appropriately.\n\nsystemd environment\n===================\n\nOn platforms where systemd is detected `glean-install` will add a\n`udev` rules file (`99-glean.rules`) that triggers on any network\ndevice being added. This will run the `glean@.service` systemd\ntemplate for the interface specified.\n\nThis systemd unit firstly determines if there is already a\n`/etc/sysconfig/network/` configuration for the interface; if so, the\ninterface is considered configured and skipped.\n\nIf not, glean is started with the interface that triggered this event\nspecified as an argument. The configuration drive is probed to see if\nnetwork configuration for the interface is available. If so, it will\nbe added, otherwise the interface will configured for DHCP.\n\n.. note ::\n\n By default glean provides configuration for the network init\n scripts service ``network.service`` on RedHat platforms (or the\n equivalent on other platforms). You should ensure this service is\n enabled and other tools such as NetworkManager are disabled for\n correct operation in this mode. Note on Fedora 29 onwards, this is\n in a separate package `network-scripts` and is considered\n deprecated.\n\n Alternatively, to use NetworkManager with the `ifcfg-rh` plugin\n with to manage the interfaces, call `glean-install` with the\n `--use-nm` flag. In this case, ensure NetworkManager is installed.\n This will trigger glean to write out configuration files that are\n suitable for use with NetworkManager and use a slightly different\n service file that doesn't trigger legacy tools like `ifup`.\n\n\nnetworkd\n========\n\n`networkd` support is implemented as a separate distribution type.\nCurrently it is only supported on Gentoo, and will be automatically\nselected by `glean-install`. It will similarly install a systemd\nservice file or openrc config file (both are supported on Gentoo) and\nudev rules to call glean.\n\nOther platforms\n===============\n\n`upstart` and `sysv` environments are also supported. These will have\ninit scripts installed to run glean at boot.\n\nHow do I use glean?\n-------------------\n\nGlean ships `glean-install`, a script which install glean into your\nsystem startup environment. It should handle `sysv`, `upstart` and\n`systemd` to cover all major distributions. This should be run once,\nduring install or image build.\n\nThe startup environment will be modified as described above to\nconfigure any found interfaces.\n\nDifferences to cloud-init?\n--------------------------\n\nGlean differs to `cloud-init` mainly in its very reduced dependency\nfootprint. In a dynamic CI environment such as OpenStack, many of the\npython dependencies for `cloud-init` can cause conflicts with packages\nor versions required for testing.\n\nGlean also better supports static IP allocation within config-drive,\nparticuarly important within the Rackspace environment.\n\nMore details\n------------\n\n* Free software: Apache license\n* Documentation: http://docs.openstack.org/infra/glean\n* Source: http://git.openstack.org/cgit/openstack-infra/glean\n* Bugs: http://storyboard.openstack.org\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Simple program to write static config from config-drive",
"version": "1.24.0",
"project_urls": {
"Homepage": "https://www.openstack.org/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a8d3a1f64251820b802c1b2f27d1537cea7ff9127c45838b594303764d0b3ef6",
"md5": "b32480275b2b401963025a525b5bfeb4",
"sha256": "3a000d7695ac31f99ca1cb1edaaf05c1c52584e7f9b302038105b2e053e18ce7"
},
"downloads": -1,
"filename": "glean-1.24.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b32480275b2b401963025a525b5bfeb4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 111957,
"upload_time": "2024-04-24T17:12:08",
"upload_time_iso_8601": "2024-04-24T17:12:08.340386Z",
"url": "https://files.pythonhosted.org/packages/a8/d3/a1f64251820b802c1b2f27d1537cea7ff9127c45838b594303764d0b3ef6/glean-1.24.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5c8058748b64c1ca7d00e1906714d48e5210bc9ceb7956f4dc0c8ad4fa05ee1",
"md5": "cb25ee073a4d294680a1c9a2b65b549f",
"sha256": "df2788d7fe1178b56694f2983b288f8e8457aa62723b960acb7fd26a440f0c10"
},
"downloads": -1,
"filename": "glean-1.24.0.tar.gz",
"has_sig": false,
"md5_digest": "cb25ee073a4d294680a1c9a2b65b549f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 76586,
"upload_time": "2024-04-24T17:12:11",
"upload_time_iso_8601": "2024-04-24T17:12:11.032256Z",
"url": "https://files.pythonhosted.org/packages/e5/c8/058748b64c1ca7d00e1906714d48e5210bc9ceb7956f4dc0c8ad4fa05ee1/glean-1.24.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 17:12:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "glean"
}
