diff --git a/README.md b/README.md
index 6f7e4c9922a..462e32049a7 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,7 @@ get in contact with that distribution and send them our way!
| Supported OSes | Supported Public Clouds | Supported Private Clouds |
| --- | --- | --- |
-| Alpine Linux
ArchLinux
Debian
DragonFlyBSD
Fedora
FreeBSD
Gentoo Linux
NetBSD
OpenBSD
RHEL/CentOS/AlmaLinux/Rocky
SLES/openSUSE
Ubuntu
| Amazon Web Services
Microsoft Azure
Google Cloud Platform
Oracle Cloud Infrastructure
Softlayer
Rackspace Public Cloud
IBM Cloud
DigitalOcean
Bigstep
Hetzner
Joyent
CloudSigma
Alibaba Cloud
OVH
OpenNebula
Exoscale
Scaleway
CloudStack
AltCloud
SmartOS
HyperOne
Vultr
Rootbox
| Bare metal installs
OpenStack
LXD
KVM
Metal-as-a-Service (MAAS)
|
+| Alpine Linux
ArchLinux
Debian
DragonFlyBSD
Fedora
FreeBSD
Gentoo Linux
NetBSD
OpenBSD
RHEL/CentOS/AlmaLinux/Rocky/PhotonOS
SLES/openSUSE
Ubuntu
| Amazon Web Services
Microsoft Azure
Google Cloud Platform
Oracle Cloud Infrastructure
Softlayer
Rackspace Public Cloud
IBM Cloud
DigitalOcean
Bigstep
Hetzner
Joyent
CloudSigma
Alibaba Cloud
OVH
OpenNebula
Exoscale
Scaleway
CloudStack
AltCloud
SmartOS
HyperOne
Vultr
Rootbox
| Bare metal installs
OpenStack
LXD
KVM
Metal-as-a-Service (MAAS)
|
## To start developing cloud-init
diff --git a/cloudinit/cmd/devel/net_convert.py b/cloudinit/cmd/devel/net_convert.py
index 0668ffa3962..5c649fd056b 100755
--- a/cloudinit/cmd/devel/net_convert.py
+++ b/cloudinit/cmd/devel/net_convert.py
@@ -11,7 +11,7 @@
from cloudinit.sources import DataSourceOVF as ovf
from cloudinit import distros, safeyaml
-from cloudinit.net import eni, netplan, network_state, sysconfig
+from cloudinit.net import eni, netplan, networkd, network_state, sysconfig
from cloudinit import log
NAME = 'net-convert'
@@ -51,7 +51,7 @@ def get_parser(parser=None):
parser.add_argument("--debug", action='store_true',
help='enable debug logging to stderr.')
parser.add_argument("-O", "--output-kind",
- choices=['eni', 'netplan', 'sysconfig'],
+ choices=['eni', 'netplan', 'networkd', 'sysconfig'],
required=True,
help="The network config format to emit")
return parser
@@ -118,9 +118,14 @@ def handle_args(name, args):
config['netplan_path'] = config['netplan_path'][1:]
# enable some netplan features
config['features'] = ['dhcp-use-domains', 'ipv6-mtu']
- else:
+ elif args.output_kind == "networkd":
+ r_cls = networkd.Renderer
+ config = distro.renderer_configs.get('networkd')
+ elif args.output_kind == "sysconfig":
r_cls = sysconfig.Renderer
config = distro.renderer_configs.get('sysconfig')
+ else:
+ raise RuntimeError("Invalid output_kind")
r = r_cls(config=config)
sys.stderr.write(''.join([
diff --git a/cloudinit/config/cc_ntp.py b/cloudinit/config/cc_ntp.py
index 70c246104d4..acf3251df5c 100644
--- a/cloudinit/config/cc_ntp.py
+++ b/cloudinit/config/cc_ntp.py
@@ -25,7 +25,7 @@
NTP_CONF = '/etc/ntp.conf'
NR_POOL_SERVERS = 4
distros = ['almalinux', 'alpine', 'centos', 'debian', 'fedora', 'opensuse',
- 'rhel', 'rocky', 'sles', 'ubuntu']
+ 'photon', 'rhel', 'rocky', 'sles', 'ubuntu']
NTP_CLIENT_CONFIG = {
'chrony': {
@@ -80,24 +80,37 @@
'confpath': '/etc/chrony/chrony.conf',
},
},
- 'rhel': {
+ 'opensuse': {
+ 'chrony': {
+ 'service_name': 'chronyd',
+ },
'ntp': {
+ 'confpath': '/etc/ntp.conf',
'service_name': 'ntpd',
},
- 'chrony': {
- 'service_name': 'chronyd',
+ 'systemd-timesyncd': {
+ 'check_exe': '/usr/lib/systemd/systemd-timesyncd',
},
},
- 'opensuse': {
+ 'photon': {
'chrony': {
'service_name': 'chronyd',
},
'ntp': {
- 'confpath': '/etc/ntp.conf',
'service_name': 'ntpd',
+ 'confpath': '/etc/ntp.conf'
},
'systemd-timesyncd': {
'check_exe': '/usr/lib/systemd/systemd-timesyncd',
+ 'confpath': '/etc/systemd/timesyncd.conf',
+ },
+ },
+ 'rhel': {
+ 'ntp': {
+ 'service_name': 'ntpd',
+ },
+ 'chrony': {
+ 'service_name': 'chronyd',
},
},
'sles': {
@@ -551,7 +564,6 @@ def handle(name, cfg, cloud, log, _args):
# Select which client is going to be used and get the configuration
ntp_client_config = select_ntp_client(ntp_cfg.get('ntp_client'),
cloud.distro)
-
# Allow user ntp config to override distro configurations
ntp_client_config = util.mergemanydict(
[ntp_client_config, ntp_cfg.get('config', {})], reverse=True)
diff --git a/cloudinit/config/cc_resolv_conf.py b/cloudinit/config/cc_resolv_conf.py
index 466dad03c5b..c51967e25ca 100644
--- a/cloudinit/config/cc_resolv_conf.py
+++ b/cloudinit/config/cc_resolv_conf.py
@@ -30,7 +30,7 @@
**Module frequency:** per instance
-**Supported distros:** alpine, fedora, rhel, sles
+**Supported distros:** alpine, fedora, photon, rhel, sles
**Config keys**::
@@ -47,18 +47,23 @@
"""
from cloudinit import log as logging
-from cloudinit.settings import PER_INSTANCE
from cloudinit import templater
+from cloudinit.settings import PER_INSTANCE
from cloudinit import util
LOG = logging.getLogger(__name__)
frequency = PER_INSTANCE
-distros = ['alpine', 'fedora', 'opensuse', 'rhel', 'sles']
+distros = ['alpine', 'fedora', 'opensuse', 'photon', 'rhel', 'sles']
+
+RESOLVE_CONFIG_TEMPLATE_MAP = {
+ '/etc/resolv.conf': 'resolv.conf',
+ '/etc/systemd/resolved.conf': 'systemd.resolved.conf',
+}
-def generate_resolv_conf(template_fn, params, target_fname="/etc/resolv.conf"):
+def generate_resolv_conf(template_fn, params, target_fname):
flags = []
false_flags = []
@@ -104,12 +109,18 @@ def handle(name, cfg, cloud, log, _args):
if "resolv_conf" not in cfg:
log.warning("manage_resolv_conf True but no parameters provided!")
- template_fn = cloud.get_template_filename('resolv.conf')
- if not template_fn:
+ try:
+ template_fn = cloud.get_template_filename(
+ RESOLVE_CONFIG_TEMPLATE_MAP[cloud.distro.resolv_conf_fn])
+ except KeyError:
log.warning("No template found, not rendering /etc/resolv.conf")
return
- generate_resolv_conf(template_fn=template_fn, params=cfg["resolv_conf"])
+ generate_resolv_conf(
+ template_fn=template_fn,
+ params=cfg["resolv_conf"],
+ target_fname=cloud.disro.resolve_conf_fn
+ )
return
# vi: ts=4 expandtab
diff --git a/cloudinit/config/cc_yum_add_repo.py b/cloudinit/config/cc_yum_add_repo.py
index 7daa6bd94d4..67f0968680e 100644
--- a/cloudinit/config/cc_yum_add_repo.py
+++ b/cloudinit/config/cc_yum_add_repo.py
@@ -18,7 +18,7 @@
**Module frequency:** per always
-**Supported distros:** almalinux, centos, fedora, rhel, rocky
+**Supported distros:** almalinux, centos, fedora, photon, rhel, rocky
**Config keys**::
@@ -36,7 +36,7 @@
from cloudinit import util
-distros = ['almalinux', 'centos', 'fedora', 'rhel', 'rocky']
+distros = ['almalinux', 'centos', 'fedora', 'photon', 'rhel', 'rocky']
def _canonicalize_id(repo_id):
diff --git a/cloudinit/config/tests/test_resolv_conf.py b/cloudinit/config/tests/test_resolv_conf.py
index 6546a0b5ba8..45a06c22127 100644
--- a/cloudinit/config/tests/test_resolv_conf.py
+++ b/cloudinit/config/tests/test_resolv_conf.py
@@ -1,9 +1,8 @@
-from unittest import mock
-
import pytest
+from unittest import mock
from cloudinit.config.cc_resolv_conf import generate_resolv_conf
-
+from tests.unittests.test_distros.test_create_users import MyBaseDistro
EXPECTED_HEADER = """\
# Your system has been configured with 'manage-resolv-conf' set to true.
@@ -14,22 +13,28 @@
class TestGenerateResolvConf:
+
+ dist = MyBaseDistro()
+ tmpl_fn = "templates/resolv.conf.tmpl"
+
@mock.patch("cloudinit.config.cc_resolv_conf.templater.render_to_file")
- def test_default_target_fname_is_etc_resolvconf(self, m_render_to_file):
- generate_resolv_conf("templates/resolv.conf.tmpl", mock.MagicMock())
+ def test_dist_resolv_conf_fn(self, m_render_to_file):
+ self.dist.resolve_conf_fn = "/tmp/resolv-test.conf"
+ generate_resolv_conf(self.tmpl_fn,
+ mock.MagicMock(),
+ self.dist.resolve_conf_fn)
assert [
- mock.call(mock.ANY, "/etc/resolv.conf", mock.ANY)
+ mock.call(mock.ANY, self.dist.resolve_conf_fn, mock.ANY)
] == m_render_to_file.call_args_list
@mock.patch("cloudinit.config.cc_resolv_conf.templater.render_to_file")
def test_target_fname_is_used_if_passed(self, m_render_to_file):
- generate_resolv_conf(
- "templates/resolv.conf.tmpl", mock.MagicMock(), "/use/this/path"
- )
+ path = "/use/this/path"
+ generate_resolv_conf(self.tmpl_fn, mock.MagicMock(), path)
assert [
- mock.call(mock.ANY, "/use/this/path", mock.ANY)
+ mock.call(mock.ANY, path, mock.ANY)
] == m_render_to_file.call_args_list
# Patch in templater so we can assert on the actual generated content
@@ -75,7 +80,8 @@ def test_target_fname_is_used_if_passed(self, m_render_to_file):
def test_flags_and_options(
self, m_write_file, params, expected_extra_line
):
- generate_resolv_conf("templates/resolv.conf.tmpl", params)
+ target_fn = "/etc/resolv.conf"
+ generate_resolv_conf(self.tmpl_fn, params, target_fn)
expected_content = EXPECTED_HEADER
if expected_extra_line is not None:
diff --git a/cloudinit/distros/__init__.py b/cloudinit/distros/__init__.py
index 57e336212f0..4991f42bc3d 100755
--- a/cloudinit/distros/__init__.py
+++ b/cloudinit/distros/__init__.py
@@ -46,7 +46,8 @@
'debian': ['debian', 'ubuntu'],
'freebsd': ['freebsd'],
'gentoo': ['gentoo'],
- 'redhat': ['almalinux', 'amazon', 'centos', 'fedora', 'rhel', 'rocky'],
+ 'redhat': ['almalinux', 'amazon', 'centos', 'fedora', 'photon', 'rhel',
+ 'rocky'],
'suse': ['opensuse', 'sles'],
}
@@ -80,6 +81,7 @@ class Distro(persistence.CloudInitPickleMixin, metaclass=abc.ABCMeta):
_ci_pkl_version = 1
prefer_fqdn = False
+ resolve_conf_fn = "/etc/resolv.conf"
def __init__(self, name, cfg, paths):
self._paths = paths
diff --git a/cloudinit/distros/arch.py b/cloudinit/distros/arch.py
index f8385f7f6c4..246e6fe79af 100644
--- a/cloudinit/distros/arch.py
+++ b/cloudinit/distros/arch.py
@@ -25,7 +25,6 @@
class Distro(distros.Distro):
locale_gen_fn = "/etc/locale.gen"
network_conf_dir = "/etc/netctl"
- resolve_conf_fn = "/etc/resolv.conf"
init_cmd = ['systemctl'] # init scripts
renderer_configs = {
"netplan": {"netplan_path": "/etc/netplan/50-cloud-init.yaml",
diff --git a/cloudinit/distros/gentoo.py b/cloudinit/distros/gentoo.py
index e9b82602acd..68c03e7fe93 100644
--- a/cloudinit/distros/gentoo.py
+++ b/cloudinit/distros/gentoo.py
@@ -23,7 +23,6 @@
class Distro(distros.Distro):
locale_conf_fn = '/etc/locale.gen'
network_conf_fn = '/etc/conf.d/net'
- resolve_conf_fn = '/etc/resolv.conf'
hostname_conf_fn = '/etc/conf.d/hostname'
init_cmd = ['rc-service'] # init scripts
diff --git a/cloudinit/distros/opensuse.py b/cloudinit/distros/opensuse.py
index 7ca0ef99951..270cc18927f 100644
--- a/cloudinit/distros/opensuse.py
+++ b/cloudinit/distros/opensuse.py
@@ -27,7 +27,6 @@ class Distro(distros.Distro):
locale_conf_fn = '/etc/sysconfig/language'
network_conf_fn = '/etc/sysconfig/network/config'
network_script_tpl = '/etc/sysconfig/network/ifcfg-%s'
- resolve_conf_fn = '/etc/resolv.conf'
route_conf_tpl = '/etc/sysconfig/network/ifroute-%s'
systemd_hostname_conf_fn = '/etc/hostname'
systemd_locale_conf_fn = '/etc/locale.conf'
diff --git a/cloudinit/distros/photon.py b/cloudinit/distros/photon.py
new file mode 100644
index 00000000000..8b78f98f856
--- /dev/null
+++ b/cloudinit/distros/photon.py
@@ -0,0 +1,355 @@
+#!/usr/bin/env python3
+# vi: ts=4 expandtab
+#
+# Copyright (C) 2021 VMware Inc.
+#
+# This file is part of cloud-init. See LICENSE file for license information.
+
+from cloudinit import util
+from cloudinit import subp
+from cloudinit import distros
+from cloudinit import helpers
+from cloudinit import log as logging
+from cloudinit.distros import net_util
+from cloudinit.settings import PER_INSTANCE
+from cloudinit.distros import rhel_util as rhutil
+from cloudinit.net.network_state import mask_to_net_prefix
+from cloudinit.distros.parsers.hostname import HostnameConf
+
+LOG = logging.getLogger(__name__)
+
+
+class Distro(distros.Distro):
+ hostname_conf_fn = '/etc/hostname'
+ network_conf_dir = '/etc/systemd/network/'
+ systemd_locale_conf_fn = '/etc/locale.conf'
+ resolve_conf_fn = '/etc/systemd/resolved.conf'
+
+ renderer_configs = {
+ 'networkd': {
+ 'resolv_conf_fn': resolve_conf_fn,
+ 'network_conf_dir': network_conf_dir,
+ }
+ }
+
+ # Should be fqdn if we can use it
+ prefer_fqdn = True
+
+ def __init__(self, name, cfg, paths):
+ distros.Distro.__init__(self, name, cfg, paths)
+ # This will be used to restrict certain
+ # calls from repeatly happening (when they
+ # should only happen say once per instance...)
+ self._runner = helpers.Runners(paths)
+ self.osfamily = 'photon'
+ self.init_cmd = ['systemctl']
+
+ def exec_cmd(self, cmd, capture=False):
+ LOG.debug('Attempting to run: %s', cmd)
+ try:
+ (out, err) = subp.subp(cmd, capture=capture)
+ if err:
+ LOG.warning('Running %s resulted in stderr output: %s',
+ cmd, err)
+ return True, out, err
+ except subp.ProcessExecutionError:
+ util.logexc(LOG, 'Command %s failed', cmd)
+ return False, None, None
+
+ def apply_locale(self, locale, out_fn=None):
+ # This has a dependancy on glibc-i18n, user need to manually install it
+ # and enable the option in cloud.cfg
+ if not out_fn:
+ out_fn = self.systemd_locale_conf_fn
+
+ locale_cfg = {
+ 'LANG': locale,
+ }
+
+ rhutil.update_sysconfig_file(out_fn, locale_cfg)
+
+ # rhutil will modify /etc/locale.conf
+ # For locale change to take effect, reboot is needed or we can restart
+ # systemd-localed. This is equivalent of localectl
+ cmd = ['systemctl', 'restart', 'systemd-localed']
+ _ret, _out, _err = self.exec_cmd(cmd)
+
+ def install_packages(self, pkglist):
+ # self.update_package_sources()
+ self.package_command('install', pkgs=pkglist)
+
+ def _write_network_config(self, netconfig):
+ if isinstance(netconfig, str):
+ self._write_network_(netconfig)
+ return
+ return self._supported_write_network_config(netconfig)
+
+ def _bring_up_interfaces(self, device_names):
+ cmd = ['systemctl', 'restart', 'systemd-networkd', 'systemd-resolved']
+ LOG.debug('Attempting to run bring up interfaces using command %s',
+ cmd)
+ ret, _out, _err = self.exec_cmd(cmd)
+ return ret
+
+ def _write_hostname(self, hostname, out_fn):
+ conf = None
+ try:
+ # Try to update the previous one
+ # Let's see if we can read it first.
+ conf = HostnameConf(util.load_file(out_fn))
+ conf.parse()
+ except IOError:
+ pass
+ if not conf:
+ conf = HostnameConf('')
+ conf.set_hostname(hostname)
+ util.write_file(out_fn, str(conf), mode=0o644)
+
+ def _read_system_hostname(self):
+ sys_hostname = self._read_hostname(self.hostname_conf_fn)
+ return (self.hostname_conf_fn, sys_hostname)
+
+ def _read_hostname(self, filename, default=None):
+ _ret, out, _err = self.exec_cmd(['hostname'])
+
+ return out if out else default
+
+ def _get_localhost_ip(self):
+ return '127.0.1.1'
+
+ def set_timezone(self, tz):
+ distros.set_etc_timezone(tz=tz, tz_file=self._find_tz_file(tz))
+
+ def package_command(self, command, args=None, pkgs=None):
+ if pkgs is None:
+ pkgs = []
+
+ cmd = ['tdnf', '-y']
+ if args and isinstance(args, str):
+ cmd.append(args)
+ elif args and isinstance(args, list):
+ cmd.extend(args)
+
+ cmd.append(command)
+
+ pkglist = util.expand_package_list('%s-%s', pkgs)
+ cmd.extend(pkglist)
+
+ # Allow the output of this to flow outwards (ie not be captured)
+ _ret, _out, _err = self.exec_cmd(cmd, capture=False)
+
+ def update_package_sources(self):
+ self._runner.run('update-sources', self.package_command,
+ ['makecache'], freq=PER_INSTANCE)
+
+ def _generate_resolv_conf(self):
+ resolv_conf_fn = self.resolve_conf_fn
+ resolv_templ_fn = 'systemd.resolved.conf'
+
+ return resolv_conf_fn, resolv_templ_fn
+
+ def _write_network_(self, settings):
+ entries = net_util.translate_network(settings)
+ LOG.debug('Translated ubuntu style network settings %s into %s',
+ settings, entries)
+ route_entries = []
+ route_entries = translate_routes(settings)
+ dev_names = entries.keys()
+ nameservers = []
+ searchdomains = []
+ # Format for systemd
+ for (dev, info) in entries.items():
+ if 'dns-nameservers' in info:
+ nameservers.extend(info['dns-nameservers'])
+ if 'dns-search' in info:
+ searchdomains.extend(info['dns-search'])
+ if dev == 'lo':
+ continue
+
+ net_fn = self.network_conf_dir + '10-cloud-init-' + dev
+ net_fn += '.network'
+ dhcp_enabled = 'no'
+ if info.get('bootproto') == 'dhcp':
+ if (settings.find('inet dhcp') >= 0 and
+ settings.find('inet6 dhcp') >= 0):
+ dhcp_enabled = 'yes'
+ else:
+ if info.get('inet6') is True:
+ dhcp_enabled = 'ipv6'
+ else:
+ dhcp_enabled = 'ipv4'
+
+ net_cfg = {
+ 'Name': dev,
+ 'DHCP': dhcp_enabled,
+ }
+
+ if info.get('hwaddress'):
+ net_cfg['MACAddress'] = info.get('hwaddress')
+ if info.get('address'):
+ net_cfg['Address'] = '%s' % (info.get('address'))
+ if info.get('netmask'):
+ net_cfg['Address'] += '/%s' % (
+ mask_to_net_prefix(info.get('netmask')))
+ if info.get('gateway'):
+ net_cfg['Gateway'] = info.get('gateway')
+ if info.get('dns-nameservers'):
+ net_cfg['DNS'] = str(
+ tuple(info.get('dns-nameservers'))).replace(',', '')
+ if info.get('dns-search'):
+ net_cfg['Domains'] = str(
+ tuple(info.get('dns-search'))).replace(',', '')
+ route_entry = []
+ if dev in route_entries:
+ route_entry = route_entries[dev]
+ route_index = 0
+ found = True
+ while found:
+ route_name = 'routes.' + str(route_index)
+ if route_name in route_entries[dev]:
+ val = str(tuple(route_entries[dev][route_name]))
+ val = val.replace(',', '')
+ if val:
+ net_cfg[route_name] = val
+ else:
+ found = False
+ route_index += 1
+
+ if info.get('auto'):
+ self._write_interface_file(net_fn, net_cfg, route_entry)
+
+ resolve_data = []
+ new_resolve_data = []
+ with open(self.resolve_conf_fn, 'r') as rf:
+ resolve_data = rf.readlines()
+ LOG.debug('Old Resolve Data\n')
+ LOG.debug('%s', resolve_data)
+ for item in resolve_data:
+ if ((nameservers and ('DNS=' in item)) or
+ (searchdomains and ('Domains=' in item))):
+ continue
+ else:
+ new_resolve_data.append(item)
+
+ new_resolve_data = new_resolve_data + \
+ convert_resolv_conf(nameservers, searchdomains)
+ LOG.debug('New resolve data\n')
+ LOG.debug('%s', new_resolve_data)
+ if nameservers or searchdomains:
+ util.write_file(self.resolve_conf_fn, ''.join(new_resolve_data))
+
+ return dev_names
+
+ def _write_interface_file(self, net_fn, net_cfg, route_entry):
+ if not net_cfg['Name']:
+ return
+ content = '[Match]\n'
+ content += 'Name=%s\n' % (net_cfg['Name'])
+ if 'MACAddress' in net_cfg:
+ content += 'MACAddress=%s\n' % (net_cfg['MACAddress'])
+ content += '[Network]\n'
+
+ if 'DHCP' in net_cfg and net_cfg['DHCP'] in {'yes', 'ipv4', 'ipv6'}:
+ content += 'DHCP=%s\n' % (net_cfg['DHCP'])
+ else:
+ if 'Address' in net_cfg:
+ content += 'Address=%s\n' % (net_cfg['Address'])
+ if 'Gateway' in net_cfg:
+ content += 'Gateway=%s\n' % (net_cfg['Gateway'])
+ if 'DHCP' in net_cfg and net_cfg['DHCP'] == 'no':
+ content += 'DHCP=%s\n' % (net_cfg['DHCP'])
+
+ route_index = 0
+ found = True
+ if route_entry:
+ while found:
+ route_name = 'routes.' + str(route_index)
+ if route_name in route_entry:
+ content += '[Route]\n'
+ if len(route_entry[route_name]) != 2:
+ continue
+ content += 'Gateway=%s\n' % (
+ route_entry[route_name][0])
+ content += 'Destination=%s\n' % (
+ route_entry[route_name][1])
+ else:
+ found = False
+ route_index += 1
+
+ util.write_file(net_fn, content)
+
+
+def convert_resolv_conf(nameservers, searchdomains):
+ ''' Returns a string formatted for resolv.conf '''
+ result = []
+ if nameservers:
+ nslist = 'DNS='
+ for ns in nameservers:
+ nslist = nslist + '%s ' % ns
+ nslist = nslist + '\n'
+ result.append(str(nslist))
+ if searchdomains:
+ sdlist = 'Domains='
+ for sd in searchdomains:
+ sdlist = sdlist + '%s ' % sd
+ sdlist = sdlist + '\n'
+ result.append(str(sdlist))
+ return result
+
+
+def translate_routes(settings):
+ entries = []
+ for line in settings.splitlines():
+ line = line.strip()
+ if not line or line.startswith('#'):
+ continue
+ split_up = line.split(None, 1)
+ if len(split_up) <= 1:
+ continue
+ entries.append(split_up)
+ consume = {}
+ ifaces = []
+ for (cmd, args) in entries:
+ if cmd == 'iface':
+ if consume:
+ ifaces.append(consume)
+ consume = {}
+ consume[cmd] = args
+ else:
+ consume[cmd] = args
+
+ absorb = False
+ for (cmd, args) in consume.items():
+ if cmd == 'iface':
+ absorb = True
+ if absorb:
+ ifaces.append(consume)
+ out_ifaces = {}
+ for info in ifaces:
+ if 'iface' not in info:
+ continue
+ iface_details = info['iface'].split(None)
+ dev_name = None
+ if len(iface_details) >= 1:
+ dev = iface_details[0].strip().lower()
+ if dev:
+ dev_name = dev
+ if not dev_name:
+ continue
+ route_info = {}
+ route_index = 0
+ found = True
+ while found:
+ route_name = 'routes.' + str(route_index)
+ if route_name in info:
+ val = info[route_name].split()
+ if val:
+ route_info[route_name] = val
+ else:
+ found = False
+ route_index += 1
+ if dev_name in out_ifaces:
+ out_ifaces[dev_name].update(route_info)
+ else:
+ out_ifaces[dev_name] = route_info
+ return out_ifaces
diff --git a/cloudinit/distros/rhel.py b/cloudinit/distros/rhel.py
index 0c00a531e79..80a6f1d8e60 100644
--- a/cloudinit/distros/rhel.py
+++ b/cloudinit/distros/rhel.py
@@ -36,7 +36,6 @@ class Distro(distros.Distro):
hostname_conf_fn = "/etc/sysconfig/network"
systemd_hostname_conf_fn = "/etc/hostname"
network_script_tpl = '/etc/sysconfig/network-scripts/ifcfg-%s'
- resolve_conf_fn = "/etc/resolv.conf"
tz_local_fn = "/etc/localtime"
usr_lib_exec = "/usr/libexec"
renderer_configs = {
diff --git a/cloudinit/net/networkd.py b/cloudinit/net/networkd.py
new file mode 100644
index 00000000000..71f87995884
--- /dev/null
+++ b/cloudinit/net/networkd.py
@@ -0,0 +1,246 @@
+#!/usr/bin/env python3
+# vi: ts=4 expandtab
+#
+# Copyright (C) 2021 VMware Inc.
+#
+# Author: Shreenidhi Shedi
+#
+# This file is part of cloud-init. See LICENSE file for license information.
+
+import os
+
+
+from . import renderer
+from cloudinit import util
+from cloudinit import subp
+from cloudinit import log as logging
+from collections import OrderedDict
+
+LOG = logging.getLogger(__name__)
+
+
+class CfgParser:
+ def __init__(self):
+ self.conf_dict = OrderedDict({
+ 'Match': [],
+ 'Link': [],
+ 'Network': [],
+ 'DHCPv4': [],
+ 'DHCPv6': [],
+ 'Address': [],
+ 'Route': [],
+ })
+
+ def update_section(self, sec, key, val):
+ for k in self.conf_dict.keys():
+ if k == sec:
+ self.conf_dict[k].append(key+'='+str(val))
+ self.conf_dict[k].sort()
+
+ def get_final_conf(self):
+ contents = ''
+ for k, v in self.conf_dict.items():
+ if not v:
+ continue
+ contents += '['+k+']\n'
+ for e in v:
+ contents += e + '\n'
+ contents += '\n'
+
+ return contents
+
+ def dump_data(self, target_fn):
+ if not target_fn:
+ LOG.warning('Target file not given')
+ return
+
+ contents = self.get_final_conf()
+ LOG.debug('Final content: %s', contents)
+ util.write_file(target_fn, contents)
+
+
+class Renderer(renderer.Renderer):
+ """
+ Renders network information in /etc/systemd/network
+
+ This Renderer is currently experimental and doesn't support all the
+ use cases supported by the other renderers yet.
+ """
+
+ def __init__(self, config=None):
+ if not config:
+ config = {}
+ self.resolved_conf = config.get('resolved_conf_fn',
+ '/etc/systemd/resolved.conf')
+ self.network_conf_dir = config.get('network_conf_dir',
+ '/etc/systemd/network/')
+
+ def generate_match_section(self, iface, cfg):
+ sec = 'Match'
+ match_dict = {
+ 'name': 'Name',
+ 'driver': 'Driver',
+ 'mac_address': 'MACAddress'
+ }
+
+ if not iface:
+ return
+
+ for k, v in match_dict.items():
+ if k in iface and iface[k]:
+ cfg.update_section(sec, v, iface[k])
+
+ return iface['name']
+
+ def generate_link_section(self, iface, cfg):
+ sec = 'Link'
+
+ if not iface:
+ return
+
+ if 'mtu' in iface and iface['mtu']:
+ cfg.update_section(sec, 'MTUBytes', iface['mtu'])
+
+ def parse_routes(self, conf, cfg):
+ sec = 'Route'
+ for k, v in conf.items():
+ if k == 'gateway':
+ cfg.update_section(sec, 'Gateway', v)
+ elif k == 'network':
+ tmp = v
+ if 'prefix' in conf:
+ tmp += '/' + str(conf['prefix'])
+ cfg.update_section(sec, 'Destination', tmp)
+ elif k == 'metric':
+ cfg.update_section(sec, 'Metric', v)
+
+ def parse_subnets(self, iface, cfg):
+ dhcp = 'no'
+ for e in iface.get('subnets', []):
+ t = e['type']
+ if t == 'dhcp4' or t == 'dhcp':
+ if dhcp == 'no':
+ dhcp = 'ipv4'
+ elif dhcp == 'ipv6':
+ dhcp = 'yes'
+ elif t == 'dhcp6':
+ if dhcp == 'no':
+ dhcp = 'ipv6'
+ elif dhcp == 'ipv4':
+ dhcp = 'yes'
+ if 'routes' in e and e['routes']:
+ for i in e['routes']:
+ self.parse_routes(i, cfg)
+ elif 'address' in e:
+ for k, v in e.items():
+ if k == 'address':
+ tmp = v
+ if 'prefix' in e:
+ tmp += '/' + str(e['prefix'])
+ cfg.update_section('Address', 'Address', tmp)
+ elif k == 'gateway':
+ cfg.update_section('Route', 'Gateway', v)
+ elif k == 'dns_nameservers':
+ cfg.update_section('Network', 'DNS', ' '.join(v))
+ elif k == 'dns_search':
+ cfg.update_section('Network', 'Domains', ' '.join(v))
+
+ cfg.update_section('Network', 'DHCP', dhcp)
+
+ # This is to accommodate extra keys present in VMware config
+ def dhcp_domain(self, d, cfg):
+ for item in ['dhcp4domain', 'dhcp6domain']:
+ if item not in d:
+ continue
+ ret = str(d[item]).casefold()
+ try:
+ ret = util.translate_bool(ret)
+ ret = 'yes' if ret else 'no'
+ except ValueError:
+ if ret != 'route':
+ LOG.warning('Invalid dhcp4domain value - %s', ret)
+ ret = 'no'
+ if item == 'dhcp4domain':
+ section = 'DHCPv4'
+ else:
+ section = 'DHCPv6'
+ cfg.update_section(section, 'UseDomains', ret)
+
+ def parse_dns(self, iface, cfg, ns):
+ sec = 'Network'
+
+ dns_cfg_map = {
+ 'search': 'Domains',
+ 'nameservers': 'DNS',
+ 'addresses': 'DNS',
+ }
+
+ dns = iface.get('dns')
+ if not dns and ns.version == 1:
+ dns = {
+ 'search': ns.dns_searchdomains,
+ 'nameservers': ns.dns_nameservers,
+ }
+ elif not dns and ns.version == 2:
+ return
+
+ for k, v in dns_cfg_map.items():
+ if k in dns and dns[k]:
+ cfg.update_section(sec, v, ' '.join(dns[k]))
+
+ def create_network_file(self, link, conf, nwk_dir):
+ net_fn_owner = 'systemd-network'
+
+ LOG.debug('Setting Networking Config for %s', link)
+
+ net_fn = nwk_dir + '10-cloud-init-' + link + '.network'
+ util.write_file(net_fn, conf)
+ util.chownbyname(net_fn, net_fn_owner, net_fn_owner)
+
+ def render_network_state(self, network_state, templates=None, target=None):
+ fp_nwkd = self.network_conf_dir
+ if target:
+ fp_nwkd = subp.target_path(target) + fp_nwkd
+
+ util.ensure_dir(os.path.dirname(fp_nwkd))
+
+ ret_dict = self._render_content(network_state)
+ for k, v in ret_dict.items():
+ self.create_network_file(k, v, fp_nwkd)
+
+ def _render_content(self, ns):
+ ret_dict = {}
+ for iface in ns.iter_interfaces():
+ cfg = CfgParser()
+
+ link = self.generate_match_section(iface, cfg)
+ self.generate_link_section(iface, cfg)
+ self.parse_subnets(iface, cfg)
+ self.parse_dns(iface, cfg, ns)
+
+ for route in ns.iter_routes():
+ self.parse_routes(route, cfg)
+
+ if ns.version == 2:
+ name = iface['name']
+ # network state doesn't give dhcp domain info
+ # using ns.config as a workaround here
+ self.dhcp_domain(ns.config['ethernets'][name], cfg)
+
+ ret_dict.update({link: cfg.get_final_conf()})
+
+ return ret_dict
+
+
+def available(target=None):
+ expected = ['systemctl']
+ search = ['/usr/bin', '/bin']
+ for p in expected:
+ if not subp.which(p, search=search, target=target):
+ return False
+ return True
+
+
+def network_state_to_networkd(ns):
+ renderer = Renderer({})
+ return renderer._render_content(ns)
diff --git a/cloudinit/net/renderers.py b/cloudinit/net/renderers.py
index e2de4d55c94..c3931a98d99 100644
--- a/cloudinit/net/renderers.py
+++ b/cloudinit/net/renderers.py
@@ -4,6 +4,7 @@
from . import freebsd
from . import netbsd
from . import netplan
+from . import networkd
from . import RendererNotFoundError
from . import openbsd
from . import sysconfig
@@ -13,12 +14,13 @@
"freebsd": freebsd,
"netbsd": netbsd,
"netplan": netplan,
+ "networkd": networkd,
"openbsd": openbsd,
"sysconfig": sysconfig,
}
DEFAULT_PRIORITY = ["eni", "sysconfig", "netplan", "freebsd",
- "netbsd", "openbsd"]
+ "netbsd", "openbsd", "networkd"]
def search(priority=None, target=None, first=False):
diff --git a/cloudinit/tests/test_util.py b/cloudinit/tests/test_util.py
index f9bc31beb26..a1ccb1dc2be 100644
--- a/cloudinit/tests/test_util.py
+++ b/cloudinit/tests/test_util.py
@@ -177,6 +177,17 @@
UBUNTU_CODENAME=xenial\n
""")
+OS_RELEASE_PHOTON = ("""\
+ NAME="VMware Photon OS"
+ VERSION="4.0"
+ ID=photon
+ VERSION_ID=4.0
+ PRETTY_NAME="VMware Photon OS/Linux"
+ ANSI_COLOR="1;34"
+ HOME_URL="https://vmware.github.io/photon/"
+ BUG_REPORT_URL="https://github.com/vmware/photon/issues"
+""")
+
class FakeCloud(object):
@@ -609,6 +620,15 @@ def test_get_linux_opensuse_tw(self, m_os_release, m_path_exists):
self.assertEqual(
('opensuse-tumbleweed', '20180920', platform.machine()), dist)
+ @mock.patch('cloudinit.util.load_file')
+ def test_get_linux_photon_os_release(self, m_os_release, m_path_exists):
+ """Verify we get the correct name and machine arch on PhotonOS"""
+ m_os_release.return_value = OS_RELEASE_PHOTON
+ m_path_exists.side_effect = TestGetLinuxDistro.os_release_exists
+ dist = util.get_linux_distro()
+ self.assertEqual(
+ ('photon', '4.0', 'VMware Photon OS/Linux'), dist)
+
@mock.patch('platform.system')
@mock.patch('platform.dist', create=True)
def test_get_linux_distro_no_data(self, m_platform_dist,
diff --git a/cloudinit/util.py b/cloudinit/util.py
index f95dc435179..7995c6c830d 100644
--- a/cloudinit/util.py
+++ b/cloudinit/util.py
@@ -483,6 +483,8 @@ def get_linux_distro():
# which will include both version codename and architecture
# on all distributions.
flavor = platform.machine()
+ elif distro_name == 'photon':
+ flavor = os_release.get('PRETTY_NAME', '')
else:
flavor = os_release.get('VERSION_CODENAME', '')
if not flavor:
@@ -531,7 +533,7 @@ def system_info():
linux_dist = info['dist'][0].lower()
if linux_dist in (
'almalinux', 'alpine', 'arch', 'centos', 'debian', 'fedora',
- 'rhel', 'rocky', 'suse'):
+ 'photon', 'rhel', 'rocky', 'suse'):
var = linux_dist
elif linux_dist in ('ubuntu', 'linuxmint', 'mint'):
var = 'ubuntu'
diff --git a/config/cloud.cfg.tmpl b/config/cloud.cfg.tmpl
index 586384e41f1..d6dbb833852 100644
--- a/config/cloud.cfg.tmpl
+++ b/config/cloud.cfg.tmpl
@@ -11,11 +11,21 @@ syslog_fix_perms: root:root
# when a 'default' entry is found it will reference the 'default_user'
# from the distro configuration specified below
users:
+{% if variant in ["photon"] %}
+ - name: root
+ lock_passwd: false
+{% else %}
- default
+{% endif %}
+
+# VMware guest customization.
+{% if variant in ["photon"] %}
+disable_vmware_customization: true
+{% endif %}
# If this is set, 'root' will not be able to ssh in and they
# will get a message to login instead as the default $user
-{% if variant in ["freebsd"] %}
+{% if variant in ["freebsd", "photon"] %}
disable_root: false
{% else %}
disable_root: true
@@ -38,6 +48,16 @@ preserve_hostname: false
# This should not be required, but leave it in place until the real cause of
# not finding -any- datasources is resolved.
datasource_list: ['NoCloud', 'ConfigDrive', 'Azure', 'OpenStack', 'Ec2']
+{% elif variant in ["photon"] %}
+# Datasources to check for cloud-config
+datasource_list: [
+ NoCloud,
+ ConfigDrive,
+ OVF,
+ OpenStack,
+ VMwareGuestInfo,
+ None
+ ]
{% endif %}
# Example datasource config
# datasource:
@@ -72,11 +92,13 @@ cloud_init_modules:
- set_hostname
- update_hostname
- update_etc_hosts
-{% if variant in ["alpine"] %}
+{% if variant in ["alpine", "photon"] %}
- resolv_conf
{% endif %}
{% if not variant.endswith("bsd") %}
+{% if variant not in ["photon"] %}
- ca-certs
+{% endif %}
- rsyslog
{% endif %}
- users-groups
@@ -90,11 +112,15 @@ cloud_config_modules:
- emit_upstart
- snap
{% endif %}
+{% if variant not in ["photon"] %}
- ssh-import-id
- locale
+{% endif %}
- set-passwords
-{% if variant in ["rhel", "fedora"] %}
+{% if variant in ["rhel", "fedora", "photon"] %}
+{% if variant not in ["photon"] %}
- spacewalk
+{% endif %}
- yum-add-repo
{% endif %}
{% if variant in ["ubuntu", "unknown", "debian"] %}
@@ -155,8 +181,8 @@ cloud_final_modules:
system_info:
# This will affect which distro class gets used
{% if variant in ["almalinux", "alpine", "amazon", "arch", "centos", "debian",
- "fedora", "freebsd", "netbsd", "openbsd", "rhel", "rocky",
- "suse", "ubuntu"] %}
+ "fedora", "freebsd", "netbsd", "openbsd", "photon", "rhel",
+ "rocky", "suse", "ubuntu"] %}
distro: {{ variant }}
{% elif variant in ["dragonfly"] %}
distro: dragonflybsd
@@ -276,6 +302,22 @@ system_info:
groups: [wheel]
sudo: ["ALL=(ALL) NOPASSWD:ALL"]
shell: /bin/ksh
+{% elif variant == "photon" %}
+ default_user:
+ name: photon
+ lock_passwd: True
+ gecos: PhotonOS
+ groups: [wheel]
+ sudo: ["ALL=(ALL) NOPASSWD:ALL"]
+ shell: /bin/bash
+ # Other config here will be given to the distro class and/or path classes
+ paths:
+ cloud_dir: /var/lib/cloud/
+ templates_dir: /etc/cloud/templates/
+
+ ssh_svcname: sshd
+
+#manage_etc_hosts: true
{% endif %}
{% if variant in ["freebsd", "netbsd", "openbsd"] %}
network:
diff --git a/systemd/cloud-init.service.tmpl b/systemd/cloud-init.service.tmpl
index 4da1a905bbe..c773e4112dc 100644
--- a/systemd/cloud-init.service.tmpl
+++ b/systemd/cloud-init.service.tmpl
@@ -1,7 +1,9 @@
## template:jinja
[Unit]
Description=Initial cloud-init job (metadata service crawler)
+{% if variant not in ["photon"] %}
DefaultDependencies=no
+{% endif %}
Wants=cloud-init-local.service
Wants=sshd-keygen.service
Wants=sshd.service
diff --git a/templates/chrony.conf.photon.tmpl b/templates/chrony.conf.photon.tmpl
new file mode 100644
index 00000000000..8551f793cee
--- /dev/null
+++ b/templates/chrony.conf.photon.tmpl
@@ -0,0 +1,48 @@
+## template:jinja
+# Use public servers from the pool.ntp.org project.
+# Please consider joining the pool (http://www.pool.ntp.org/join.html).
+{% if pools %}# pools
+{% endif %}
+{% for pool in pools -%}
+pool {{pool}} iburst
+{% endfor %}
+{%- if servers %}# servers
+{% endif %}
+{% for server in servers -%}
+server {{server}} iburst
+{% endfor %}
+
+# Record the rate at which the system clock gains/losses time.
+driftfile /var/lib/chrony/drift
+
+# Allow the system clock to be stepped in the first three updates
+# if its offset is larger than 1 second.
+makestep 1.0 3
+
+# Enable kernel synchronization of the real-time clock (RTC).
+rtcsync
+
+# Enable hardware timestamping on all interfaces that support it.
+#hwtimestamp *
+
+# Increase the minimum number of selectable sources required to adjust
+# the system clock.
+#minsources 2
+
+# Allow NTP client access from local network.
+#allow 192.168.0.0/16
+
+# Serve time even if not synchronized to a time source.
+#local stratum 10
+
+# Specify file containing keys for NTP authentication.
+#keyfile /etc/chrony.keys
+
+# Get TAI-UTC offset and leap seconds from the system tz database.
+leapsectz right/UTC
+
+# Specify directory for log files.
+logdir /var/log/chrony
+
+# Select which information is logged.
+#log measurements statistics tracking
diff --git a/templates/hosts.photon.tmpl b/templates/hosts.photon.tmpl
new file mode 100644
index 00000000000..0fd6f72294f
--- /dev/null
+++ b/templates/hosts.photon.tmpl
@@ -0,0 +1,22 @@
+## template:jinja
+{#
+This file /etc/cloud/templates/hosts.photon.tmpl is only utilized
+if enabled in cloud-config. Specifically, in order to enable it
+you need to add the following to config:
+ manage_etc_hosts: True
+-#}
+# Your system has configured 'manage_etc_hosts' as True.
+# As a result, if you wish for changes to this file to persist
+# then you will need to either
+# a.) make changes to the master file in /etc/cloud/templates/hosts.photon.tmpl
+# b.) change or remove the value of 'manage_etc_hosts' in
+# /etc/cloud/cloud.cfg or cloud-config from user-data
+#
+# The following lines are desirable for IPv4 capable hosts
+127.0.0.1 {{fqdn}} {{hostname}}
+127.0.0.1 localhost.localdomain localhost
+127.0.0.1 localhost4.localdomain4 localhost4
+
+# The following lines are desirable for IPv6 capable hosts
+::1 {{fqdn}} {{hostname}}
+::1 localhost6.localdomain6 localhost6
diff --git a/templates/ntp.conf.photon.tmpl b/templates/ntp.conf.photon.tmpl
new file mode 100644
index 00000000000..4d4910d1f7c
--- /dev/null
+++ b/templates/ntp.conf.photon.tmpl
@@ -0,0 +1,61 @@
+## template:jinja
+
+# For more information about this file, see the man pages
+# ntp.conf(5), ntp_acc(5), ntp_auth(5), ntp_clock(5), ntp_misc(5), ntp_mon(5).
+
+driftfile /var/lib/ntp/drift
+
+# Permit time synchronization with our time source, but do not
+# permit the source to query or modify the service on this system.
+restrict default kod nomodify notrap nopeer noquery
+restrict -6 default kod nomodify notrap nopeer noquery
+
+# Permit all access over the loopback interface. This could
+# be tightened as well, but to do so would effect some of
+# the administrative functions.
+restrict 127.0.0.1
+restrict -6 ::1
+
+# Hosts on local network are less restricted.
+#restrict 192.168.1.0 mask 255.255.255.0 nomodify notrap
+
+# Use public servers from the pool.ntp.org project.
+# Please consider joining the pool (http://www.pool.ntp.org/join.html).
+{% if pools %}# pools
+{% endif %}
+{% for pool in pools -%}
+pool {{pool}} iburst
+{% endfor %}
+{%- if servers %}# servers
+{% endif %}
+{% for server in servers -%}
+server {{server}} iburst
+{% endfor %}
+
+#broadcast 192.168.1.255 autokey # broadcast server
+#broadcastclient # broadcast client
+#broadcast 224.0.1.1 autokey # multicast server
+#multicastclient 224.0.1.1 # multicast client
+#manycastserver 239.255.254.254 # manycast server
+#manycastclient 239.255.254.254 autokey # manycast client
+
+# Enable public key cryptography.
+#crypto
+
+includefile /etc/ntp/crypto/pw
+
+# Key file containing the keys and key identifiers used when operating
+# with symmetric key cryptography.
+keys /etc/ntp/keys
+
+# Specify the key identifiers which are trusted.
+#trustedkey 4 8 42
+
+# Specify the key identifier to use with the ntpdc utility.
+#requestkey 8
+
+# Specify the key identifier to use with the ntpq utility.
+#controlkey 8
+
+# Enable writing of statistics records.
+#statistics clockstats cryptostats loopstats peerstats
diff --git a/templates/resolv.conf.tmpl b/templates/resolv.conf.tmpl
index f870be672da..72a37bf7acd 100644
--- a/templates/resolv.conf.tmpl
+++ b/templates/resolv.conf.tmpl
@@ -22,7 +22,7 @@ domain {{domain}}
sortlist {% for sort in sortlist %}{{sort}} {% endfor %}
{% endif %}
{#
- Flags and options are required to be on the
+ Flags and options are required to be on the
same line preceded by "options" keyword
#}
{% if options or flags %}
diff --git a/templates/systemd.resolved.conf.tmpl b/templates/systemd.resolved.conf.tmpl
new file mode 100644
index 00000000000..fca50d37a48
--- /dev/null
+++ b/templates/systemd.resolved.conf.tmpl
@@ -0,0 +1,15 @@
+## template:jinja
+# Your system has been configured with 'manage-resolv-conf' set to true.
+# As a result, cloud-init has written this file with configuration data
+# that it has been provided. Cloud-init, by default, will write this file
+# a single time (PER_ONCE).
+#
+[Resolve]
+LLMNR=false
+{% if nameservers is defined %}
+DNS={% for server in nameservers %}{{server}} {% endfor %}
+{% endif %}
+
+{% if searchdomains is defined %}
+Domains={% for search in searchdomains %}{{search}} {% endfor %}
+{% endif %}
diff --git a/tests/cloud_tests/util.py b/tests/cloud_tests/util.py
index 7dcccbddd80..49baadb07a1 100644
--- a/tests/cloud_tests/util.py
+++ b/tests/cloud_tests/util.py
@@ -23,7 +23,7 @@
OS_FAMILY_MAPPING = {
'debian': ['debian', 'ubuntu'],
- 'redhat': ['centos', 'rhel', 'fedora'],
+ 'redhat': ['centos', 'photon', 'rhel', 'fedora'],
'gentoo': ['gentoo'],
'freebsd': ['freebsd'],
'suse': ['sles'],
diff --git a/tests/unittests/test_cli.py b/tests/unittests/test_cli.py
index fbc6ec11c3a..fdb4026c58d 100644
--- a/tests/unittests/test_cli.py
+++ b/tests/unittests/test_cli.py
@@ -225,7 +225,7 @@ def test_wb_devel_schema_subcommand_doc_content(self):
expected_doc_sections = [
'**Supported distros:** all',
('**Supported distros:** almalinux, alpine, centos, debian, '
- 'fedora, opensuse, rhel, rocky, sles, ubuntu'),
+ 'fedora, opensuse, photon, rhel, rocky, sles, ubuntu'),
'**Config schema**:\n **resize_rootfs:** (true/false/noblock)',
'**Examples**::\n\n runcmd:\n - [ ls, -l, / ]\n'
]
diff --git a/tests/unittests/test_distros/test_netconfig.py b/tests/unittests/test_distros/test_netconfig.py
index a1df066a9b5..562ee04a4d6 100644
--- a/tests/unittests/test_distros/test_netconfig.py
+++ b/tests/unittests/test_distros/test_netconfig.py
@@ -2,6 +2,7 @@
import copy
import os
+import re
from io import StringIO
from textwrap import dedent
from unittest import mock
@@ -15,7 +16,6 @@
from cloudinit import subp
from cloudinit import util
-
BASE_NET_CFG = '''
auto lo
iface lo inet loopback
@@ -771,6 +771,103 @@ def test_apply_network_config_v1_with_netplan(self):
with_netplan=True)
+class TestNetCfgDistroPhoton(TestNetCfgDistroBase):
+
+ def setUp(self):
+ super(TestNetCfgDistroPhoton, self).setUp()
+ self.distro = self._get_distro('photon', renderers=['networkd'])
+
+ def create_conf_dict(self, contents):
+ content_dict = {}
+ for line in contents:
+ if line:
+ line = line.strip()
+ if line and re.search(r'^\[(.+)\]$', line):
+ content_dict[line] = []
+ key = line
+ elif line:
+ assert key
+ content_dict[key].append(line)
+
+ return content_dict
+
+ def compare_dicts(self, actual, expected):
+ for k, v in actual.items():
+ self.assertEqual(sorted(expected[k]), sorted(v))
+
+ def _apply_and_verify(self, apply_fn, config, expected_cfgs=None,
+ bringup=False):
+ if not expected_cfgs:
+ raise ValueError('expected_cfg must not be None')
+
+ tmpd = None
+ with mock.patch('cloudinit.net.networkd.available') as m_avail:
+ m_avail.return_value = True
+ with self.reRooted(tmpd) as tmpd:
+ apply_fn(config, bringup)
+
+ results = dir2dict(tmpd)
+ for cfgpath, expected in expected_cfgs.items():
+ actual = self.create_conf_dict(results[cfgpath].splitlines())
+ self.compare_dicts(actual, expected)
+ self.assertEqual(0o644, get_mode(cfgpath, tmpd))
+
+ def nwk_file_path(self, ifname):
+ return '/etc/systemd/network/10-cloud-init-%s.network' % ifname
+
+ def net_cfg_1(self, ifname):
+ ret = """\
+ [Match]
+ Name=%s
+ [Network]
+ DHCP=no
+ [Address]
+ Address=192.168.1.5/24
+ [Route]
+ Gateway=192.168.1.254""" % ifname
+ return ret
+
+ def net_cfg_2(self, ifname):
+ ret = """\
+ [Match]
+ Name=%s
+ [Network]
+ DHCP=ipv4""" % ifname
+ return ret
+
+ def test_photon_network_config_v1(self):
+ tmp = self.net_cfg_1('eth0').splitlines()
+ expected_eth0 = self.create_conf_dict(tmp)
+
+ tmp = self.net_cfg_2('eth1').splitlines()
+ expected_eth1 = self.create_conf_dict(tmp)
+
+ expected_cfgs = {
+ self.nwk_file_path('eth0'): expected_eth0,
+ self.nwk_file_path('eth1'): expected_eth1,
+ }
+
+ self._apply_and_verify(self.distro.apply_network_config,
+ V1_NET_CFG,
+ expected_cfgs.copy())
+
+ def test_photon_network_config_v2(self):
+ tmp = self.net_cfg_1('eth7').splitlines()
+ expected_eth7 = self.create_conf_dict(tmp)
+
+ tmp = self.net_cfg_2('eth9').splitlines()
+ expected_eth9 = self.create_conf_dict(tmp)
+
+ expected_cfgs = {
+ self.nwk_file_path('eth7'): expected_eth7,
+ self.nwk_file_path('eth9'): expected_eth9,
+ }
+
+ self._apply_and_verify(self.distro.apply_network_config,
+ V2_NET_CFG,
+ expected_cfgs.copy())
+
+
def get_mode(path, target=None):
return os.stat(subp.target_path(target, path)).st_mode & 0o777
diff --git a/tests/unittests/test_handler/test_handler_set_hostname.py b/tests/unittests/test_handler/test_handler_set_hostname.py
index 73641b70437..32ca3b7e23b 100644
--- a/tests/unittests/test_handler/test_handler_set_hostname.py
+++ b/tests/unittests/test_handler/test_handler_set_hostname.py
@@ -120,6 +120,32 @@ def test_write_hostname_sles(self, m_uses_systemd):
contents = util.load_file(distro.hostname_conf_fn)
self.assertEqual('blah', contents.strip())
+ @mock.patch('cloudinit.distros.Distro.uses_systemd', return_value=False)
+ def test_photon_hostname(self, m_uses_systemd):
+ cfg1 = {
+ 'hostname': 'photon',
+ 'prefer_fqdn_over_hostname': True,
+ 'fqdn': 'test1.vmware.com',
+ }
+ cfg2 = {
+ 'hostname': 'photon',
+ 'prefer_fqdn_over_hostname': False,
+ 'fqdn': 'test2.vmware.com',
+ }
+
+ ds = None
+ distro = self._fetch_distro('photon', cfg1)
+ paths = helpers.Paths({'cloud_dir': self.tmp})
+ cc = cloud.Cloud(ds, paths, {}, distro, None)
+ self.patchUtils(self.tmp)
+ for c in [cfg1, cfg2]:
+ cc_set_hostname.handle('cc_set_hostname', c, cc, LOG, [])
+ contents = util.load_file(distro.hostname_conf_fn, decode=True)
+ if c['prefer_fqdn_over_hostname']:
+ self.assertEqual(contents.strip(), c['fqdn'])
+ else:
+ self.assertEqual(contents.strip(), c['hostname'])
+
def test_multiple_calls_skips_unchanged_hostname(self):
"""Only new hostname or fqdn values will generate a hostname call."""
distro = self._fetch_distro('debian')
diff --git a/tests/unittests/test_net.py b/tests/unittests/test_net.py
index b72a62b8ac4..b2ddbf9985d 100644
--- a/tests/unittests/test_net.py
+++ b/tests/unittests/test_net.py
@@ -5,7 +5,7 @@
from cloudinit.net import cmdline
from cloudinit.net import (
eni, interface_has_own_mac, natural_sort_key, netplan, network_state,
- renderers, sysconfig)
+ renderers, sysconfig, networkd)
from cloudinit.sources.helpers import openstack
from cloudinit import temp_utils
from cloudinit import subp
@@ -821,6 +821,28 @@
NETWORK_CONFIGS = {
'small': {
+ 'expected_networkd_eth99': textwrap.dedent("""\
+ [Match]
+ Name=eth99
+ MACAddress=c0:d6:9f:2c:e8:80
+ [Network]
+ DHCP=ipv4
+ Domains=wark.maas
+ DNS=1.2.3.4 5.6.7.8
+ [Route]
+ Gateway=65.61.151.37
+ Destination=0.0.0.0/0
+ Metric=10000
+ """).rstrip(' '),
+ 'expected_networkd_eth1': textwrap.dedent("""\
+ [Match]
+ Name=eth1
+ MACAddress=cf:d6:af:48:e8:80
+ [Network]
+ DHCP=no
+ Domains=wark.maas
+ DNS=1.2.3.4 5.6.7.8
+ """).rstrip(' '),
'expected_eni': textwrap.dedent("""\
auto lo
iface lo inet loopback
@@ -938,6 +960,12 @@
"""),
},
'v4_and_v6': {
+ 'expected_networkd': textwrap.dedent("""\
+ [Match]
+ Name=iface0
+ [Network]
+ DHCP=yes
+ """).rstrip(' '),
'expected_eni': textwrap.dedent("""\
auto lo
iface lo inet loopback
@@ -973,6 +1001,17 @@
""").rstrip(' '),
},
'v4_and_v6_static': {
+ 'expected_networkd': textwrap.dedent("""\
+ [Match]
+ Name=iface0
+ [Link]
+ MTUBytes=8999
+ [Network]
+ DHCP=no
+ [Address]
+ Address=192.168.14.2/24
+ Address=2001:1::1/64
+ """).rstrip(' '),
'expected_eni': textwrap.dedent("""\
auto lo
iface lo inet loopback
@@ -1059,6 +1098,12 @@
""").rstrip(' '),
},
'dhcpv6_only': {
+ 'expected_networkd': textwrap.dedent("""\
+ [Match]
+ Name=iface0
+ [Network]
+ DHCP=ipv6
+ """).rstrip(' '),
'expected_eni': textwrap.dedent("""\
auto lo
iface lo inet loopback
@@ -4986,26 +5031,199 @@ def testsimple_render_bond(self):
files['/etc/network/interfaces'].splitlines())
+class TestNetworkdNetRendering(CiTestCase):
+
+ def create_conf_dict(self, contents):
+ content_dict = {}
+ for line in contents:
+ if line:
+ line = line.strip()
+ if line and re.search(r'^\[(.+)\]$', line):
+ content_dict[line] = []
+ key = line
+ elif line:
+ content_dict[key].append(line)
+
+ return content_dict
+
+ def compare_dicts(self, actual, expected):
+ for k, v in actual.items():
+ self.assertEqual(sorted(expected[k]), sorted(v))
+
+ @mock.patch("cloudinit.net.util.chownbyname", return_value=True)
+ @mock.patch("cloudinit.net.util.get_cmdline", return_value="root=myroot")
+ @mock.patch("cloudinit.net.sys_dev_path")
+ @mock.patch("cloudinit.net.read_sys_net")
+ @mock.patch("cloudinit.net.get_devicelist")
+ def test_networkd_default_generation(self, mock_get_devicelist,
+ mock_read_sys_net,
+ mock_sys_dev_path,
+ m_get_cmdline,
+ m_chown):
+ tmp_dir = self.tmp_dir()
+ _setup_test(tmp_dir, mock_get_devicelist,
+ mock_read_sys_net, mock_sys_dev_path)
+
+ network_cfg = net.generate_fallback_config()
+ ns = network_state.parse_net_config_data(network_cfg,
+ skip_broken=False)
+
+ render_dir = os.path.join(tmp_dir, "render")
+ os.makedirs(render_dir)
+
+ render_target = 'etc/systemd/network/10-cloud-init-eth1000.network'
+ renderer = networkd.Renderer({})
+ renderer.render_network_state(ns, target=render_dir)
+
+ self.assertTrue(os.path.exists(os.path.join(render_dir,
+ render_target)))
+ with open(os.path.join(render_dir, render_target)) as fh:
+ contents = fh.readlines()
+
+ actual = self.create_conf_dict(contents)
+ print(actual)
+
+ expected = textwrap.dedent("""\
+ [Match]
+ Name=eth1000
+ MACAddress=07-1c-c6-75-a4-be
+ [Network]
+ DHCP=ipv4""").rstrip(' ')
+
+ expected = self.create_conf_dict(expected.splitlines())
+
+ self.compare_dicts(actual, expected)
+
+
+class TestNetworkdRoundTrip(CiTestCase):
+
+ def create_conf_dict(self, contents):
+ content_dict = {}
+ for line in contents:
+ if line:
+ line = line.strip()
+ if line and re.search(r'^\[(.+)\]$', line):
+ content_dict[line] = []
+ key = line
+ elif line:
+ content_dict[key].append(line)
+
+ return content_dict
+
+ def compare_dicts(self, actual, expected):
+ for k, v in actual.items():
+ self.assertEqual(sorted(expected[k]), sorted(v))
+
+ def _render_and_read(self, network_config=None, state=None, nwkd_path=None,
+ dir=None):
+ if dir is None:
+ dir = self.tmp_dir()
+
+ if network_config:
+ ns = network_state.parse_net_config_data(network_config)
+ elif state:
+ ns = state
+ else:
+ raise ValueError("Expected data or state, got neither")
+
+ if not nwkd_path:
+ nwkd_path = '/etc/systemd/network/'
+
+ renderer = networkd.Renderer(config={'network_conf_dir': nwkd_path})
+
+ renderer.render_network_state(ns, target=dir)
+ return dir2dict(dir)
+
+ @mock.patch("cloudinit.net.util.chownbyname", return_value=True)
+ def testsimple_render_small_networkd(self, m_chown):
+ nwk_fn1 = '/etc/systemd/network/10-cloud-init-eth99.network'
+ nwk_fn2 = '/etc/systemd/network/10-cloud-init-eth1.network'
+ entry = NETWORK_CONFIGS['small']
+ files = self._render_and_read(network_config=yaml.load(entry['yaml']))
+
+ actual = files[nwk_fn1].splitlines()
+ actual = self.create_conf_dict(actual)
+
+ expected = entry['expected_networkd_eth99'].splitlines()
+ expected = self.create_conf_dict(expected)
+
+ self.compare_dicts(actual, expected)
+
+ actual = files[nwk_fn2].splitlines()
+ actual = self.create_conf_dict(actual)
+
+ expected = entry['expected_networkd_eth1'].splitlines()
+ expected = self.create_conf_dict(expected)
+
+ self.compare_dicts(actual, expected)
+
+ @mock.patch("cloudinit.net.util.chownbyname", return_value=True)
+ def testsimple_render_v4_and_v6(self, m_chown):
+ nwk_fn = '/etc/systemd/network/10-cloud-init-iface0.network'
+ entry = NETWORK_CONFIGS['v4_and_v6']
+ files = self._render_and_read(network_config=yaml.load(entry['yaml']))
+
+ actual = files[nwk_fn].splitlines()
+ actual = self.create_conf_dict(actual)
+
+ expected = entry['expected_networkd'].splitlines()
+ expected = self.create_conf_dict(expected)
+
+ self.compare_dicts(actual, expected)
+
+ @mock.patch("cloudinit.net.util.chownbyname", return_value=True)
+ def testsimple_render_v4_and_v6_static(self, m_chown):
+ nwk_fn = '/etc/systemd/network/10-cloud-init-iface0.network'
+ entry = NETWORK_CONFIGS['v4_and_v6_static']
+ files = self._render_and_read(network_config=yaml.load(entry['yaml']))
+
+ actual = files[nwk_fn].splitlines()
+ actual = self.create_conf_dict(actual)
+
+ expected = entry['expected_networkd'].splitlines()
+ expected = self.create_conf_dict(expected)
+
+ self.compare_dicts(actual, expected)
+
+ @mock.patch("cloudinit.net.util.chownbyname", return_value=True)
+ def testsimple_render_dhcpv6_only(self, m_chown):
+ nwk_fn = '/etc/systemd/network/10-cloud-init-iface0.network'
+ entry = NETWORK_CONFIGS['dhcpv6_only']
+ files = self._render_and_read(network_config=yaml.load(entry['yaml']))
+
+ actual = files[nwk_fn].splitlines()
+ actual = self.create_conf_dict(actual)
+
+ expected = entry['expected_networkd'].splitlines()
+ expected = self.create_conf_dict(expected)
+
+ self.compare_dicts(actual, expected)
+
+
class TestRenderersSelect:
@pytest.mark.parametrize(
- 'renderer_selected,netplan,eni,nm,scfg,sys', (
+ 'renderer_selected,netplan,eni,nm,scfg,sys,networkd', (
# -netplan -ifupdown -nm -scfg -sys raises error
- (net.RendererNotFoundError, False, False, False, False, False),
+ (net.RendererNotFoundError, False, False, False, False, False,
+ False),
# -netplan +ifupdown -nm -scfg -sys selects eni
- ('eni', False, True, False, False, False),
+ ('eni', False, True, False, False, False, False),
# +netplan +ifupdown -nm -scfg -sys selects eni
- ('eni', True, True, False, False, False),
+ ('eni', True, True, False, False, False, False),
# +netplan -ifupdown -nm -scfg -sys selects netplan
- ('netplan', True, False, False, False, False),
+ ('netplan', True, False, False, False, False, False),
# Ubuntu with Network-Manager installed
# +netplan -ifupdown +nm -scfg -sys selects netplan
- ('netplan', True, False, True, False, False),
+ ('netplan', True, False, True, False, False, False),
# Centos/OpenSuse with Network-Manager installed selects sysconfig
# -netplan -ifupdown +nm -scfg +sys selects netplan
- ('sysconfig', False, False, True, False, True),
+ ('sysconfig', False, False, True, False, True, False),
+ # -netplan -ifupdown -nm -scfg -sys +networkd selects networkd
+ ('networkd', False, False, False, False, False, True),
),
)
+ @mock.patch("cloudinit.net.renderers.networkd.available")
@mock.patch("cloudinit.net.renderers.netplan.available")
@mock.patch("cloudinit.net.renderers.sysconfig.available")
@mock.patch("cloudinit.net.renderers.sysconfig.available_sysconfig")
@@ -5013,7 +5231,8 @@ class TestRenderersSelect:
@mock.patch("cloudinit.net.renderers.eni.available")
def test_valid_renderer_from_defaults_depending_on_availability(
self, m_eni_avail, m_nm_avail, m_scfg_avail, m_sys_avail,
- m_netplan_avail, renderer_selected, netplan, eni, nm, scfg, sys
+ m_netplan_avail, m_networkd_avail, renderer_selected,
+ netplan, eni, nm, scfg, sys, networkd
):
"""Assert proper renderer per DEFAULT_PRIORITY given availability."""
m_eni_avail.return_value = eni # ifupdown pkg presence
@@ -5021,6 +5240,7 @@ def test_valid_renderer_from_defaults_depending_on_availability(
m_scfg_avail.return_value = scfg # sysconfig presence
m_sys_avail.return_value = sys # sysconfig/ifup/down presence
m_netplan_avail.return_value = netplan # netplan presence
+ m_networkd_avail.return_value = networkd # networkd presence
if isinstance(renderer_selected, str):
(renderer_name, _rnd_class) = renderers.select(
priority=renderers.DEFAULT_PRIORITY
@@ -5094,6 +5314,12 @@ def test_sysconfig_available_uses_variant_mapping(self, m_distro, m_avail):
result = sysconfig.available()
self.assertTrue(result)
+ @mock.patch("cloudinit.net.renderers.networkd.available")
+ def test_networkd_available(self, m_nwkd_avail):
+ m_nwkd_avail.return_value = True
+ found = renderers.search(priority=['networkd'], first=False)
+ self.assertEqual('networkd', found[0][0])
+
@mock.patch(
"cloudinit.net.is_openvswitch_internal_interface",
diff --git a/tests/unittests/test_render_cloudcfg.py b/tests/unittests/test_render_cloudcfg.py
index 495e2669e65..275879af704 100644
--- a/tests/unittests/test_render_cloudcfg.py
+++ b/tests/unittests/test_render_cloudcfg.py
@@ -10,7 +10,8 @@
# TODO(Look to align with tools.render-cloudcfg or cloudinit.distos.OSFAMILIES)
DISTRO_VARIANTS = ["amazon", "arch", "centos", "debian", "fedora", "freebsd",
- "netbsd", "openbsd", "rhel", "suse", "ubuntu", "unknown"]
+ "netbsd", "openbsd", "photon", "rhel", "suse", "ubuntu",
+ "unknown"]
@pytest.mark.allow_subp_for(sys.executable)
diff --git a/tools/render-cloudcfg b/tools/render-cloudcfg
index 9ec554bd2ee..7e667de4b09 100755
--- a/tools/render-cloudcfg
+++ b/tools/render-cloudcfg
@@ -5,8 +5,8 @@ import os
import sys
VARIANTS = ["almalinux", "alpine", "amazon", "arch", "centos", "debian",
- "fedora", "freebsd", "netbsd", "openbsd", "rhel", "suse", "rocky",
- "ubuntu", "unknown"]
+ "fedora", "freebsd", "netbsd", "openbsd", "photon", "rhel",
+ "suse","rocky", "ubuntu", "unknown"]
if "avoid-pep8-E402-import-not-top-of-file":