Simple program to write static config from config-drive
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins 7aef6858dc OpenDev Migration Patch 1 month ago
doc/source Use openstackdocstheme. 1 month ago
glean Ignore Wireguard interfaces 1 month ago
.coveragerc Change ignore-errors to ignore_errors 3 years ago
.gitignore Add coverage generated files to .gitignore 2 years ago
.gitreview OpenDev Migration Patch 1 month ago
.mailmap Initial Cookiecutter Commit. 4 years ago
.testr.conf Initial Cookiecutter Commit. 4 years ago
CONTRIBUTING.rst Reference storyboard instead of launchpad 4 years ago
HACKING.rst gleam is taken, let's do glean instead 4 years ago
LICENSE Initial Cookiecutter Commit. 4 years ago
MANIFEST.in Initial Cookiecutter Commit. 4 years ago
README.rst Add NetworkManager distro plugin support 5 months ago
rebuild-test-output.sh Support explicitly configured DHCP interfaces 3 years ago
setup.cfg Change openstack-dev to openstack-discuss 5 months ago
setup.py Import content from project-config patch 4 years ago
test-requirements.txt Use openstackdocstheme. 1 month ago
tox.ini fix tox python3 overrides 5 months ago

README.rst

glean

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