openstack/heat
Code Issues Proposed changes

Don't reference OS::Nova::FloatingIP in the docs

Browse Source 
Nova-network is long gone and this resource type has been hidden for
many, many releases.

Change-Id: Id6fd24dad04c5d547368ca54f7210429f27e2b37
Story: 2008978
Task: 42622
This commit is contained in:
Zane Bitter 2021-06-24 16:31:45 -04:00
parent 8a5a18322f
commit 0d1976c988
2 changed files with 2 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/source/template_guide/basic_resources.rst
View File

@ -137,45 +137,6 @@ port:
Create and associate a floating IP to an instance
-------------------------------------------------
You can use two sets of resources to create and associate floating IPs to
instances.
OS::Nova resources
++++++++++++++++++
Use the :ref:`OS::Nova::FloatingIP` resource to create a floating IP, and
the :ref:`OS::Nova::FloatingIPAssociation` resource to associate the
floating IP to an instance.
The following example creates an instance and a floating IP, and associate the
floating IP to the instance:
.. code-block:: yaml
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: inst1 }
OS::Neutron resources
+++++++++++++++++++++
.. note::
The Networking service (neutron) must be enabled on your OpenStack
deployment to use these resources.
Use the :ref:`OS::Neutron::FloatingIP` resource to create a floating IP, and
the :ref:`OS::Neutron::FloatingIPAssociation` resource to associate the

4
doc/source/template_guide/environment.rst
View File

@ -170,10 +170,10 @@ identifier, and must reference either another resource's ID or the URL of an
existing template file.
The following example maps a new ``OS::Networking::FloatingIP``
resource to an existing ``OS::Nova::FloatingIP`` resource::
resource to an existing ``OS::Neutron::FloatingIP`` resource::
resource_registry:
"OS::Networking::FloatingIP": "OS::Nova::FloatingIP"
"OS::Networking::FloatingIP": "OS::Neutron::FloatingIP"
You can use wildcards to map multiple resources, for example to map all
``OS::Neutron`` resources to ``OS::Network``::