search

OpenNebula / addon-context-linux

Linux VM Contextualization
Apache License 2.0
56 stars 73 forks source link

readme

⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[!IMPORTANT] This repository is being moved to a new location https://github.com/OpenNebula/one-apps During the transition the repository is in read-only mode

OpenNebula Linux VM Contextualization

Description

This addon provides contextualization packages for the Linux (and, other Unix-like) guest virtual machines running in the OpenNebula cloud. Based on the provided contextualization parameters, the packages prepare the networking in the running guest virt. machine, configure SSH keys, set passwords, run custom start scripts, and many others.

Download

Latest versions can be downloaded from the release page. Check the supported OpenNebula versions for each release.

Install

Documentation on packages installation and guest contextualization can be found in the latest stable OpenNebula Operation Guide. For beta releases, refer to the latest development documentation.

Tested platforms

List of tested platforms only:

Platform Versions
AlmaLinux 8, 9
Alpine Linux 3.15, 3.16, 3.17
ALT Linux 9, 10
Amazon Linux 2
CentOS 7, 8 Stream
Debian 10, 11
Devuan 3, 4
Fedora 37
FreeBSD 12, 13
openSUSE 15
Oracle Linux 7, 8, 9
Red Hat Enterprise Linux 7, 8, 9
Rocky Linux 8, 9
Ubuntu 20.04, 22.04
Ubuntu Minimal 20.04, 22.04

(the packages might work on other versions or flavours, but those aren't tested)

Guest Network Configuration

NOTE: Available since context packages version 6.2.0.

The context scripts support selectable guest network management service (a component in guest OS responsible for assigning IP addresses, routes, and bringing interfaces up). Following network configuration types can be selected by setting the context variable NETCFG_TYPE (empty default fallbacks to autodetection of the most suitable one for a particular platform):

Interface IP address configuration method can be customized as well. Following IPv4 configuration methods are supported via NIC attribute METHOD:

Following IPv6 configuration methods are supported via NIC attribute IP6_METHOD:

Selectable configuration types and IP configuration methods are supported only on the following platforms:

Platform Network Type (NETCFG_TYPE)
Alpine Linux 3.15+ interfaces
ALT Linux p10, Sisyphus networkd, nm
Amazon Linux 2 scripts
Debian 10+ interfaces, netplan, nm, networkd
Devuan 3 interfaces
Fedora 36+ scripts, nm, networkd
FreeBSD 12+ bsd
openSUSE 15 scripts
RHEL-like 7 (CentOS, Oracle Linux) scripts
RHEL-like 8 (CentOS, Oracle/Rocky/AlmaLinux) scripts, nm, networkd
RHEL-like 9 (CentOS Stream 9, Oracle/Rocky/AlmaLinux) nm, networkd
Ubuntu 18.04, 20.04, 22.04 interfaces, netplan, nm, networkd

(other than listed platforms are not supported for using NETCFG_TYPE nor METHOD/IP6_METHOD!):

Known Issues:

Build own package

Packages for each release for supported guests are available in the release page. Also, any version can be built by the scripts provided in this repository.

Requirements

Steps

The script generate.sh is able to create all package types and can be configured to include more files in the package or change some of its parameters. Package type and content are configured by the env. variable TARGET, the corresponding target must be defined in target.sh. Target describes the package format, name, dependencies, and files. Files are selected by the tags. Set of required tags is defined for the target (in targets.sh), each file has a list of corresponding tags right in its filename (divided by the regular name by 2 hashes ##, dot-separated).

Package name or version can be overridden by env. variables NAME and VERSION.

Examples:

$ TARGET=deb ./generate.sh
$ TARGET=el7 NAME=my-one-context ./generate.sh
$ TARGET=alpine ./generate.sh
$ TARGET=freebsd VERSION=5.7.85 ./generate.sh

NOTE: The generator must be executed from the same directory it resides.

Check generate.sh for general package metadata and targets.sh for the list of targets and their metadata. Most of the parameters can be overriden by the appropriate environment variable.

Development

To contribute bug patches or new features, you can use the github Pull Request model. It is assumed that code and documentation are contributed under the Apache License 2.0.

More info:

Repository structure

All code is located under src/ and structure follows the installation directory structure. Files for different environments/targets are picked by the tag, tags are part of the filename separated from the installation name by 2 hashes (##). Tags are dot-separated.

Examples:

Contextualization scripts

Contextualization scripts, which are executed on every boot and during the reconfiguration, are located in src/etc/one-context.d/. Scripts are divided into following 2 parts:

All other scripts, which are not prefixed with loc- or net-, are executed as a first during the post-networking contextualization stage.

License

Copyright 2002-2022, OpenNebula Project, OpenNebula Systems (formerly C12G Labs)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.