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>__.
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.
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.
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 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.
upstart and sysv environments are also supported. These will have
init scripts installed to run glean at boot.
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.
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.
FAQs
Simple program to write static config from config-drive
We found that glean demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.
