Discrepancy in Instances section of the template guide

Bug #1487757 reported by Chris Buccella
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Heat
Fix Released
Undecided
Peter Razumovsky

Bug Description

There is a discrepancy, or at least some confusion on http://docs.openstack.org/developer/heat/template_guide/basic_resources.html

In the Instances section, under "Connect an instance to a network":

------------------------------------
network
    The name or ID of an existing network. You don’t need to create an OS::Neutron::Port resource if you use this property, but you will not be able to associate a floating IP with the instance interface in the template.
-------------------------------------

But farther down the page (http://docs.openstack.org/developer/heat/template_guide/basic_resources.html#os-nova-resources), it shows an example template associating a floating IP to an instance using the "network" key:

 resources:
   floating_ip:
     type: OS::Nova::FloatingIP
     properties:
       pool: public

   inst1:
     type: OS::Nova::Server
     properties:
       flavor: m1.small
       image: ubuntu-trusty-x86_64
       networks:
         - network: private

   association:
     type: OS::Nova::FloatingIPAssociation
     properties:
       floating_ip: { get_resource: floating_ip }
       server_id: { get_resource: instance }

Changed in heat:
assignee: nobody → Peter Razumovsky (prazumovsky)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to heat (master)

Fix proposed to branch: master
Review: https://review.openstack.org/220977

Changed in heat:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to heat (master)

Reviewed: https://review.openstack.org/220977
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=e9cedf5abdc18190d57577d89bc3d6daf3c987e4
Submitter: Jenkins
Branch: master

commit e9cedf5abdc18190d57577d89bc3d6daf3c987e4
Author: Peter Razumovsky <email address hidden>
Date: Mon Sep 7 15:30:14 2015 +0300

    Clarify definition of server network prop in doc

    There is confusing description for network property
    of OS::Nova::Server. Clarify this description.

    Change-Id: I137ef18afae0527c114f037fe607ddf65513adea
    Closes-bug: #1487757

Changed in heat:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in heat:
milestone: none → liberty-rc1
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in heat:
milestone: liberty-rc1 → 5.0.0
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.