Merge "builder: support setting diskimage env-vars in secure configuration"

doc/source/installation.rst

@@ -58,11 +58,17 @@ The Nodepool configuration file is described in :ref:`configuration`.
 
 There is support for a secure file that is used to store nodepool
 configurations that contain sensitive data. It currently only supports
-specifying ZooKeeper credentials. If ZooKeeper credentials are defined in
+specifying ZooKeeper credentials and diskimage env-vars.
-both configuration files, the data in the secure file takes precedence.
+If ZooKeeper credentials or diskimage env-vars are defined in both
+configuration files, the data in the secure file takes precedence.
 The secure file location can be changed with the ``-s`` option and follows
 the same file format as the Nodepool configuration file.
 
+Secrets stored in diskimage env-vars may be leaked by the elements or in
+the image build logs. Before using sensitive information in env-vars, please
+carefully audit the elements that are enabled and ensure they are handling
+the environment safely.
+
 There is an optional logging configuration file, specified with the ``-l``
 option. The logging configuration file can accept either:
 

nodepool/config.py

@@ -120,6 +120,14 @@ class Config(ConfigValue):
             d.username = diskimage.get('username', 'zuul')
             self.diskimages[d.name] = d
 
+    def setSecureDiskimageEnv(self, diskimages, secure_config_path):
+        for diskimage in diskimages:
+            if diskimage['name'] not in self.diskimages:
+                raise Exception('%s: unknown diskimage %s' %
+                                (secure_config_path, diskimage['name']))
+            self.diskimages[diskimage['name']].env_vars.update(
+                diskimage['env-vars'])
+
     def setLabels(self, labels_cfg):
         if not labels_cfg:
             return
@@ -268,3 +276,5 @@ def loadSecureConfig(config, secure_config_path):
 
     # TODO(Shrews): Support ZooKeeper auth
     config.setZooKeeperServers(secure.get('zookeeper-servers'))
+    config.setSecureDiskimageEnv(
+        secure.get('diskimages', []), secure_config_path)

nodepool/tests/fixtures/secure_file_secure.yaml

@@ -2,3 +2,8 @@ zookeeper-servers:
   - host: {zookeeper_host}
     port: {zookeeper_port}
     chroot: {zookeeper_chroot}
+
+diskimages:
+  - name: fake-image
+    env-vars:
+      REG_PASSWORD: secret

nodepool/tests/test_launcher.py

@@ -1144,6 +1144,10 @@ class TestLauncher(tests.DBTestCase):
         pool.start()
         self.wait_for_config(pool)
 
+        fake_image = pool.config.diskimages['fake-image']
+        self.assertIn('REG_PASSWORD', fake_image.env_vars)
+        self.assertEqual('secret', fake_image.env_vars['REG_PASSWORD'])
+
         zk_servers = pool.config.zookeeper_servers
         self.assertEqual(1, len(zk_servers))
         key = list(zk_servers.keys())[0]

releasenotes/notes/secure-dib-env-c6013bab90406988.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Diskimages env-vars can be set in the secure.conf file.