Merge lp:~macgreagoir/charms/trusty/heat/instance_user into lp:~openstack-charmers-archive/charms/trusty/heat/next

[Mick Gregg]

[macgreagoir] Make heat.conf instance_user item configurable.

Made heat.conf instance_user configurable, as required for Icehouse

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #4410 heat-next for macgreagoir mp258385
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/4410/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #4135 heat-next for macgreagoir mp258385
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/4135/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #4009 heat-next for macgreagoir mp258385
    AMULET FAIL: amulet-test missing

AMULET Results (max last 2 lines):
INFO:root:Search string not found in makefile target commands.
ERROR:root:No make target was executed.

Full amulet test output: http://paste.ubuntu.com/10997560/
Build: http://10.245.162.77:8080/job/charm_amulet_test/4009/

[Ryan Beisner (1chb1n)]

Please see this example and adjust the proposed Makefile accordingly:
http://bazaar.launchpad.net/~openstack-charmers/charms/trusty/keystone/next/view/head:/Makefile#L12

You can take that section verbatim.

Thanks again!

review: Needs Fixing

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #4411 heat-next for macgreagoir mp258385
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/4411/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #4136 heat-next for macgreagoir mp258385
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/4136/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #4010 heat-next for macgreagoir mp258385
    AMULET OK: passed

Build: http://10.245.162.77:8080/job/charm_amulet_test/4010/

[Ryan Beisner (1chb1n)]

Woot! FYI, full amulet output @ http://paste.ubuntu.com/10997892/

[Ryan Beisner (1chb1n)]

I have work in progress about to land for heat amulet coverage, but if this MP lands first, that is ok. I'm happy to rebase and resolve any conflicts on my side.

However, if my stuff lands first, then this MP will likely have conflicts and the contributor will have to rework this MP a bit.

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #7870 heat-next for macgreagoir mp258385
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/7870/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #7291 heat-next for macgreagoir mp258385
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/7291/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5760 heat-next for macgreagoir mp258385
    AMULET FAIL: amulet-test failed

AMULET Results (max last 2 lines):
make: *** [functional_test] Error 1
ERROR:root:Make target returned non-zero.

Full amulet test output: http://paste.ubuntu.com/12057843/
Build: http://10.245.162.77:8080/job/charm_amulet_test/5760/

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #13105 heat-next for macgreagoir mp276499
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/13105/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #12217 heat-next for macgreagoir mp276499
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/12217/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #7721 heat-next for macgreagoir mp276499
    AMULET OK: passed

Build: http://10.245.162.77:8080/job/charm_amulet_test/7721/

[Ryan Beisner (1chb1n)]

Thank you for your work on this.

I wonder if the heat.conf template file will need to be split by OpenStack release, so that instance_user is not rendered after Juno? I see that the option is still present as of the Kilo Heat docs, and that it has been dropped as of the Liberty Heat docs.

The amulet test for heat doesn't yet exercise Liberty, so we don't know the impact of using or not using this option at that version. I imagine it will handle it gracefully, but we should confirm.

Otherwise, these look like sound changes to me.

For reference:
http://docs.openstack.org/juno/config-reference/content/ch_configuring-openstack-orchestration.html

http://docs.openstack.org/kilo/config-reference/content/ch_configuring-openstack-orchestration.html

http://docs.openstack.org/liberty/config-reference/content/ch_configuring-openstack-orchestration.html

[Liam Young (gnuoy)]

Hi, thanks for the MP! I agree with Ryan, if the setting is not used for Juno and above can we either split the templates up into Openstack series specific folders as we have with the other openstack charms or change the context so that the instance_user is only added to the context if Openstack release < Juno and update the template to only add an instance_user setting if instance user variable is set

review: Needs Fixing

[lp:~macgreagoir/charms/trusty/heat/instance_user]

47. By Mick Gregg on 2015-12-02

Merged with next

48. By Mick Gregg on 2015-12-02

[macgreagoir] Moved instance_user heat.conf change to icehouse/ template; updated kilo/ template

[Mick Gregg (macgreagoir)]

The setting is still used up to Juno, and requires the 'instance_user=' option in heat.conf. I've added a template for icehouse and updated the kilo one, with both using the new config option.

[Mick Gregg (macgreagoir)]

> The setting is still used up to Juno, and requires the 'instance_user=' option
> in heat.conf. I've added a template for icehouse and updated the kilo one,
> with both using the new config option.

Correction: "still used up to Kilo", hence the kilo template update

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #13758 heat-next for macgreagoir mp276499
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/13758/

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #14755 heat-next for macgreagoir mp276499
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/14755/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #8076 heat-next for macgreagoir mp276499
    AMULET FAIL: amulet-test failed

AMULET Results (max last 2 lines):
make: *** [functional_test] Error 1
ERROR:root:Make target returned non-zero.

Full amulet test output: http://paste.ubuntu.com/13629060/
Build: http://10.245.162.77:8080/job/charm_amulet_test/8076/

[lp:~macgreagoir/charms/trusty/heat/instance_user]

49. By Mick Gregg on 2016-01-05

Merge with next

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #16599 heat-next for macgreagoir mp276499
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/16599/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #15502 heat-next for macgreagoir mp276499
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/15502/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #8521 heat-next for macgreagoir mp276499
    AMULET OK: passed

Build: http://10.245.162.77:8080/job/charm_amulet_test/8521/

[Liam Young (gnuoy)]

Hi Mick,

Thanks for your work on this. approved

Liam

review: Approve

=== modified file 'config.yaml'
--- config.yaml	2015-11-16 09:14:33 +0000
+++ config.yaml	2016-01-05 15:04:28 +0000
@@ -40,6 +40,13 @@
     default: heat
     type: string
     description: Database name
+  instance-user:
+    default:
+    type: string
+    description: |
+      The default user for new instances. This option is deprecated as of Juno.
+      If left empty, Heat will use the default user set up with your cloud
+      image (for OS::Nova::Server) or 'ec2-user' (for AWS::EC2::Instance).
   region:
     default: RegionOne
     type: string

=== modified file 'hooks/heat_context.py'
--- hooks/heat_context.py	2015-04-02 12:25:23 +0000
+++ hooks/heat_context.py	2016-01-05 15:04:28 +0000
@@ -96,3 +96,15 @@
 
     external_ports = API_PORTS.values()
     service_namespace = 'heat'
+
+
+class InstanceUserContext(context.OSContextGenerator):
+
+    def __call__(self):
+        ctxt = {}
+
+        instance_user = ''
+        if config('instance-user'):
+            instance_user = config('instance-user')
+        ctxt['instance_user'] = instance_user
+        return ctxt

=== modified file 'hooks/heat_utils.py'
--- hooks/heat_utils.py	2015-11-16 09:14:33 +0000
+++ hooks/heat_utils.py	2016-01-05 15:04:28 +0000
@@ -38,6 +38,7 @@
     API_PORTS,
     HeatIdentityServiceContext,
     EncryptionContext,
+    InstanceUserContext,
     HeatApacheSSLContext,
     HeatHAProxyContext,
 )
@@ -86,6 +87,7 @@
                      HeatIdentityServiceContext(service=SVC, service_user=SVC),
                      HeatHAProxyContext(),
                      EncryptionContext(),
+                     InstanceUserContext(),
                      context.SyslogContext(),
                      context.LogLevelContext(),
                      context.BindHostContext()]

=== added directory 'templates/icehouse'
=== added file 'templates/icehouse/heat.conf'
--- templates/icehouse/heat.conf	1970-01-01 00:00:00 +0000
+++ templates/icehouse/heat.conf	2016-01-05 15:04:28 +0000
@@ -0,0 +1,79 @@
+[DEFAULT]
+use_syslog = {{ use_syslog }}
+verbose = {{ verbose }}
+debug = {{ debug }}
+log_dir = /var/log/heat
+# Icehouse expects 'instance_user=' to allow the image's default user
+# Not including instance_user at all results in 'ec2-user' being used
+instance_user={{ instance_user }}
+instance_driver=heat.engine.nova
+plugin_dirs=/usr/lib64/heat,/usr/lib/heat
+environment_dir=/etc/heat/environment.d
+deferred_auth_method=password
+host=heat
+auth_encryption_key={{ encryption_key }}
+
+{% if database_host -%}
+# < Icehouse db config
+sql_connection = {{ database_type }}://{{ database_user }}:{{ database_password }}@{{ database_host }}/{{ database }}{% if database_ssl_ca %}?ssl_ca={{ database_ssl_ca }}{% if database_ssl_cert %}&ssl_cert={{ database_ssl_cert }}&ssl_key={{ database_ssl_key }}{% endif %}{% endif %}
+{% endif %}
+
+{% if rabbitmq_host or rabbitmq_hosts -%}
+rabbit_userid = {{ rabbitmq_user }}
+rabbit_virtual_host = {{ rabbitmq_virtual_host }}
+rabbit_password = {{ rabbitmq_password }}
+{% if rabbitmq_hosts -%}
+rabbit_hosts = {{ rabbitmq_hosts }}
+{% if rabbitmq_ha_queues -%}
+rabbit_ha_queues = True
+rabbit_durable_queues = False
+{% endif -%}
+{% else -%}
+rabbit_host = {{ rabbitmq_host }}
+{% endif -%}
+{% if rabbit_ssl_port -%}
+rabbit_use_ssl = True
+rabbit_port = {{ rabbit_ssl_port }}
+{% if rabbit_ssl_ca -%}
+kombu_ssl_ca_certs = {{ rabbit_ssl_ca }}
+{% endif -%}
+{% endif -%}
+{% endif %}
+
+{% if auth_host -%}
+[keystone_authtoken]
+auth_uri = {{ service_protocol }}://{{ service_host }}:{{ service_port }}/v2.0
+auth_host = {{ auth_host }}
+auth_port = {{ auth_port }}
+auth_protocol = {{ auth_protocol }}
+admin_tenant_name = {{ admin_tenant_name }}
+admin_user = {{ admin_user }}
+admin_password = {{ admin_password }}
+signing_dir = {{ signing_dir }}
+{% endif %}
+
+[ec2_authtoken]
+auth_uri = {{service_protocol }}://{{ service_host }}:{{ service_port }}/v2.0
+keystone_ec2_uri = {{service_protocol }}://{{ service_host }}:{{ service_port }}/v2.0/ec2tokens
+
+{% if database_host -%}
+[database]
+connection = {{ database_type }}://{{ database_user }}:{{ database_password }}@{{ database_host }}/{{ database }}{% if database_ssl_ca %}?ssl_ca={{ database_ssl_ca }}{% if database_ssl_cert %}&ssl_cert={{ database_ssl_cert }}&ssl_key={{ database_ssl_key }}{% endif %}{% endif %}
+{% endif -%}
+
+[paste_deploy]
+api_paste_config=/etc/heat/api-paste.ini
+
+[heat_api]
+{% if api_listen_port -%} 
+bind_port={{ api_listen_port }}
+{% else -%}
+bind_port=8004
+{% endif %}
+
+[heat_api_cfn]
+{% if api_cfn_listen_port -%}
+bind_port={{ api_cfn_listen_port }}
+{% else -%}
+bind_port=8000
+{% endif %}

=== modified file 'templates/kilo/heat.conf'
--- templates/kilo/heat.conf	2015-10-30 10:53:01 +0000
+++ templates/kilo/heat.conf	2016-01-05 15:04:28 +0000
@@ -3,7 +3,7 @@
 debug = False
 verbose = False
 log_dir = /var/log/heat
-instance_user=ec2-user
+instance_user={{ instance_user }}
 instance_driver=heat.engine.nova
 plugin_dirs=/usr/lib64/heat,/usr/lib/heat
 environment_dir=/etc/heat/environment.d

=== modified file 'unit_tests/test_heat_context.py'
--- unit_tests/test_heat_context.py	2014-04-16 08:19:26 +0000
+++ unit_tests/test_heat_context.py	2016-01-05 15:04:28 +0000
@@ -4,7 +4,8 @@
 
 TO_PATCH = [
     'get_encryption_key',
-    'generate_ec2_tokens'
+    'generate_ec2_tokens',
+    'config'
 ]
 
 
@@ -19,6 +20,12 @@
             heat_context.EncryptionContext()(),
             {'encryption_key': 'key'})
 
+    def test_instance_user_empty_configuration(self):
+        self.config.return_value = None
+        self.assertEquals(
+            heat_context.InstanceUserContext()(),
+            {'instance_user': ''})
+
     @patch('charmhelpers.contrib.openstack.'
            'context.IdentityServiceContext.__call__')
     def test_identity_configuration(self, __call__):