Skip to main content

Simple program to write static config from config-drive

Project description

Glean is a program intended to configure a system based on configuration provided in a configuration drive.

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. 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.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

glean-1.24.0.tar.gz (76.6 kB view details)

Uploaded Source

Built Distribution

glean-1.24.0-py3-none-any.whl (112.0 kB view details)

Uploaded Python 3

File details

Details for the file glean-1.24.0.tar.gz.

File metadata

  • Download URL: glean-1.24.0.tar.gz
  • Upload date:
  • Size: 76.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for glean-1.24.0.tar.gz
Algorithm Hash digest
SHA256 df2788d7fe1178b56694f2983b288f8e8457aa62723b960acb7fd26a440f0c10
MD5 cb25ee073a4d294680a1c9a2b65b549f
BLAKE2b-256 e5c8058748b64c1ca7d00e1906714d48e5210bc9ceb7956f4dc0c8ad4fa05ee1

See more details on using hashes here.

File details

Details for the file glean-1.24.0-py3-none-any.whl.

File metadata

  • Download URL: glean-1.24.0-py3-none-any.whl
  • Upload date:
  • Size: 112.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for glean-1.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a000d7695ac31f99ca1cb1edaaf05c1c52584e7f9b302038105b2e053e18ce7
MD5 b32480275b2b401963025a525b5bfeb4
BLAKE2b-256 a8d3a1f64251820b802c1b2f27d1537cea7ff9127c45838b594303764d0b3ef6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page