opendev
/
glean
Code Issues Proposed changes
Simple program to write static config from config-drive
117 Commits 1 Branch 42 Tags 2.8 MiB
Python 96.6%
Shell 3.4%
Go to file
Clark Boylan 833df4a99c Ignore hacking rules 
Infra has long ignored hacking rules because they enforce sillyness that
only pushes pain onto devs. We don't care about periods at the end of
commit message titles or the minute details of comments and docstrings.

Change-Id: I71b260b9a416dccbb7663a676ec196e8727588c7
 		2016-07-05 17:57:47 -07:00
doc/source Update documentation 2015-12-15 12:57:57 +11:00
glean Merge "Add support for bonded interfaces with a static IP." 2016-06-29 16:32:45 +00:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:23:11 +00:00
.gitignore Initial Cookiecutter Commit. 2015-03-02 19:05:03 -05:00
.gitreview gleam is taken, let's do glean instead 2015-04-12 16:06:41 -04:00
.mailmap Initial Cookiecutter Commit. 2015-03-02 19:05:03 -05:00
.testr.conf Initial Cookiecutter Commit. 2015-03-02 19:05:03 -05:00
CONTRIBUTING.rst Reference storyboard instead of launchpad 2015-04-12 15:56:20 -04:00
HACKING.rst gleam is taken, let's do glean instead 2015-04-12 16:06:41 -04:00
LICENSE Initial Cookiecutter Commit. 2015-03-02 19:05:03 -05:00
MANIFEST.in Initial Cookiecutter Commit. 2015-03-02 19:05:03 -05:00
README.rst Add link to documentation on network_info.json 2016-02-03 16:59:08 -08:00
rebuild-test-output.sh Support explicitly configured DHCP interfaces 2015-07-17 19:53:15 +00:00
setup.cfg Move init scripts and installation of them in tree 2015-06-29 09:27:05 -04:00
setup.py Import content from project-config patch 2015-03-02 20:12:23 -05:00
test-requirements.txt Add testing 2015-04-12 15:47:07 -04:00
tox.ini Ignore hacking rules 2016-07-05 17:57:47 -07:00

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?

systemd environment

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

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