Merge ~gilles-dartiguelongue/cloud-init:gentoo-fixes into cloud-init:master

[Gilles Dartiguelongue]

Fix various issues with Gentoo distribution and templates

A couple of issues with gentoo support that are now fixed:
 - locale is now at /etc/env.d/02locale
 - packages: provide 'emerge' command as a list not string to subp
 - cloud.cfg template supports gentoo now
 - Do not use 'emerge --upgrade world' unless a full upgrade is requested
 - only use --sync before package installs

LP: #1799544

[Ryan Harper (raharper)]

Are there existing gentoo cloud-init enable images? if not, which lxd gentoo image did you start with and how were you getting cloud-init installed?

[Gilles Dartiguelongue (gilles-dartiguelongue)]

I'm working on creating cloud-init enabled lxd images using packer from the gentoo lxc template. I can push the required json file somewhere as I intend to make this public when I'm satisfied with the result.

[Ryan Harper (raharper)]

I pointed CI at this branch:

https://jenkins.ubuntu.com/server/job/cloud-init-ci/513/

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:7868b97507d0dd7d7721ad5c4539e22c67635f92
https://jenkins.ubuntu.com/server/job/cloud-init-ci/513/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    IN_PROGRESS: Declarative: Post Actions

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/513/rebuild

review: Approve (continuous-integration)

[Chad Smith (chad.smith)]

Hi,
Thank you for contributing to cloud-init.

To contribute, you must sign the Canonical Contributor License Agreement
(CLA) [1].

If you have already signed it as an individual, your Launchpad user will
be listed in the contributor-agreement-canonical launchpad group [2].
Unfortunately there is no easy way to check if an organization or company
you are doing work for has signed. If you are unsure or have questions,
email <email address hidden> or ping chad.smith, raharper or powersj
in #cloud-init channel via freenode.

For information on how to sign, please see the HACKING document [3].

Thanks again, and please feel free to reach out with any questions.

–
[1] http://www.canonical.com/contributors
[2] https://launchpad.net/~contributor-agreement-canonical/+members
[3] http://cloudinit.readthedocs.io/en/latest/topics/hacking.html

[Chad Smith (chad.smith)]

Thanks again for this branch Gilles.

Can you comment on my inline question and mention whether you have signed the CLA then we can go ahead an land this branch .

review: Needs Information

[Chad Smith (chad.smith)]

I updated the commit message at the top of the merge proposal. Please review it to see if it works for you. Thanks again

[Chad Smith (chad.smith)]

This branch can land in tip, but we haven't yet gotten confirmation that the CLA is signed per comment https://code.launchpad.net/~gilles-dartiguelongue/cloud-init/+git/cloud-init/+merge/358777/comments/941288

As soon as you get a chance to confirm that you've signed this we will land this branch.

Much thanks!

Unmerged commits

7868b97... by Gilles Dartiguelongue <email address hidden> on 2018-11-14

gentoo: add support for package_upgrade

b15c4c4... by Gilles Dartiguelongue <email address hidden> on 2018-11-14

gentoo: fix update_package_sources function

Method is meant to update packages repository, not to update the system.

3756cde... by Gilles Dartiguelongue <email address hidden> on 2018-11-14

gentoo: fix filename for storing locale

There must have been a misunderstanding as locale.gen is meant to
contain locales to be generated if no argument is passed to locale-gen.

When using openrc, Gentoo stores system locale in /etc/env.d/02locale
which is generally manipulated through eselect.

823454f... by Gilles Dartiguelongue <email address hidden> on 2018-10-24

Add support for gentoo in cloud.cfg and templates

85459ea... by Gilles Dartiguelongue <email address hidden> on 2018-10-23

gentoo: fix package installation command

diff --git a/cloudinit/distros/gentoo.py b/cloudinit/distros/gentoo.py
index dc57717..22ad2cf 100644
--- a/cloudinit/distros/gentoo.py
+++ b/cloudinit/distros/gentoo.py
@@ -20,7 +20,7 @@ LOG = logging.getLogger(__name__)
 
 
 class Distro(distros.Distro):
-    locale_conf_fn = '/etc/locale.gen'
+    locale_conf_fn = '/etc/env.d/02locale'
     network_conf_fn = '/etc/conf.d/net'
     resolve_conf_fn = '/etc/resolv.conf'
     hostname_conf_fn = '/etc/conf.d/hostname'
@@ -189,30 +189,33 @@ class Distro(distros.Distro):
         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 = list('emerge')
+        cmd = ['emerge']
         # Redirect output
         cmd.append("--quiet")
 
-        if args and isinstance(args, str):
-            cmd.append(args)
-        elif args and isinstance(args, list):
-            cmd.extend(args)
+        if command == "upgrade":
+            cmd.extend(["--update", "world"])
+        else:
+            if pkgs is None:
+                pkgs = []
+
+            if args and isinstance(args, str):
+                cmd.append(args)
+            elif args and isinstance(args, list):
+                cmd.extend(args)
 
-        if command:
-            cmd.append(command)
+            if command:
+                cmd.append(command)
 
-        pkglist = util.expand_package_list('%s-%s', pkgs)
-        cmd.extend(pkglist)
+            pkglist = util.expand_package_list('%s-%s', pkgs)
+            cmd.extend(pkglist)
 
         # Allow the output of this to flow outwards (ie not be captured)
         util.subp(cmd, capture=False)
 
     def update_package_sources(self):
         self._runner.run("update-sources", self.package_command,
-                         ["-u", "world"], freq=PER_INSTANCE)
+                         ["--sync"], freq=PER_INSTANCE)
 
 
 def convert_resolv_conf(settings):
diff --git a/config/cloud.cfg.tmpl b/config/cloud.cfg.tmpl
index 1fef133..3f5a41a 100644
--- a/config/cloud.cfg.tmpl
+++ b/config/cloud.cfg.tmpl
@@ -134,7 +134,7 @@ cloud_final_modules:
 # (not accessible to handlers/transforms)
 system_info:
    # This will affect which distro class gets used
-{% if variant in ["centos", "debian", "fedora", "rhel", "suse", "ubuntu", "freebsd"] %}
+{% if variant in ["centos", "debian", "fedora", "rhel", "suse", "ubuntu", "freebsd", "gentoo"] %}
    distro: {{ variant }}
 {% else %}
    # Unknown/fallback distro.
@@ -172,7 +172,7 @@ system_info:
          primary: http://ports.ubuntu.com/ubuntu-ports
          security: http://ports.ubuntu.com/ubuntu-ports
    ssh_svcname: ssh
-{% elif variant in ["centos", "rhel", "fedora", "suse"] %}
+{% elif variant in ["centos", "rhel", "fedora", "suse", "gentoo"] %}
    # Default user name + that default users groups (if added/used)
    default_user:
      name: {{ variant }}
@@ -180,6 +180,10 @@ system_info:
      gecos: {{ variant }} Cloud User
 {% if variant == "suse" %}
      groups: [cdrom, users]
+{% elif variant == "gentoo" %}
+     groups: [users, wheel]
+     primary_group: users
+     no_user_group: true
 {% else %}
      groups: [wheel, adm, systemd-journal]
 {% endif %}
diff --git a/templates/hosts.gentoo.tmpl b/templates/hosts.gentoo.tmpl
new file mode 100644
index 0000000..cd045fa
--- /dev/null
+++ b/templates/hosts.gentoo.tmpl
@@ -0,0 +1,24 @@
+## template:jinja
+{#
+This file /etc/cloud/templates/hosts.gentoo.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.gentoo.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 localhost.localdomain localhost
+::1 localhost6.localdomain6 localhost6
+
diff --git a/tools/render-cloudcfg b/tools/render-cloudcfg
index 8b7cb87..d109044 100755
--- a/tools/render-cloudcfg
+++ b/tools/render-cloudcfg
@@ -4,7 +4,7 @@ import argparse
 import os
 import sys
 
-VARIANTS = ["bsd", "centos", "fedora", "rhel", "suse", "ubuntu", "unknown"]
+VARIANTS = ["bsd", "centos", "fedora", "gentoo", "rhel", "suse", "ubuntu", "unknown"]
 
 if "avoid-pep8-E402-import-not-top-of-file":
     _tdir = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))