Bug 1250658 - [Docs] [Heat] Documentation Red Hat Openstack 6 Heat
Summary: [Docs] [Heat] Documentation Red Hat Openstack 6 Heat
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 6.0 (Juno)
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: z4
: 6.0 (Juno)
Assignee: Don Domingo
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks: 1257000
TreeView+ depends on / blocked
 
Reported: 2015-08-05 17:09 UTC by ahernand
Modified: 2019-07-11 09:46 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-08-16 02:59:51 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description ahernand 2015-08-05 17:09:57 UTC
Description of problem:

While the documentation is "correct", it's misleading

Version-Release number of selected component (if applicable):
Red Hat Openstack 6


Actual results:
(StrOpt) The default user for new instances. This option is deprecated and will be removed in the Juno release. If it's empty, Heat will use the default user set up with your cloud image (for OS::Nova::Server) or 'ec2-user' (for AWS::EC2::Instance). 

Expected results:
Should probably become

 	(StrOpt) The default user for new instances. This option is deprecated and may be removed after the Kilo release. If it's explicitly set to an empty string Heat will use the default user set up with your cloud image (for OS::Nova::Server) or 'ec2-user' (for AWS::EC2::Instance). 


Because it has a "default" simply not setting it doesn't get you the "empty" effect.

Additional info:

You can refer to SFDC 01454679
https://c.na7.visual.force.com/apex/Case_View?id=500A000000RPa6e&sfdc.override=1

https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux_OpenStack_Platform/6/html-single/Configuration_Reference_Guide/index.html

Comment 3 Jack Waterworth 2015-08-05 17:38:16 UTC
Heat appears to use ec2-user as default, which appears to be contradictory to the documentation.

https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux_OpenStack_Platform/6/html-single/Configuration_Reference_Guide/index.html#ch_configuring-openstack-orchestration

instance_user = ec2-user
--------------------
(StrOpt) The default user for new instances. This option is deprecated and will be removed in the Juno release. If it's empty, Heat will use the default user set up with your cloud image (for OS::Nova::Server) or 'ec2-user' (for AWS::EC2::Instance).
--------------------

This options has NOT been removed.  Additionally, the ec2-user appears to be hard coded default:

http://git.openstack.org/cgit/openstack/heat/tree/heat/engine/resources/instance.py?h=stable/juno#n606
-----------------------
        # FIXME(shadower): the instance_user config option is deprecated. Once
        # it's gone, we should always use ec2-user for compatibility with
        # CloudFormation.
        if cfg.CONF.instance_user:
            instance_user = cfg.CONF.instance_user
        else:
            instance_user = 'ec2-user'
-----------------------

So while the documentation says: "If it's empty, Heat will use the default user set up with your cloud image (for OS::Nova::Server)" means it it is set to an empty string, not if it is unspecified. unspecified will default to ec2-user

it's technically correct but could definitely be clearer

Comment 5 Andrew Dahms 2015-08-07 02:38:28 UTC
Assigning to Don for review.

Comment 8 Andrew Dahms 2015-08-16 02:59:51 UTC
This content is now live on the Customer Portal.

Closing.


Note You need to log in before you can comment on or make changes to this bug.