Bug 1740401 - [Docs] The EC2 Metadata IP 169.254.169.254 is problematic with routed spine/leaf
Summary: [Docs] The EC2 Metadata IP 169.254.169.254 is problematic with routed spine/leaf
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 13.0 (Queens)
Hardware: Unspecified
OS: Unspecified
low
high
Target Milestone: zstream
: 13.0 (Queens)
Assignee: Greg Rakauskas
QA Contact: RHOS Documentation Team
URL:
Whiteboard: docs-accepted
Depends On: 1659596
Blocks: 1742202 1742203
TreeView+ depends on / blocked
 
Reported: 2019-08-12 20:12 UTC by Greg Rakauskas
Modified: 2019-08-16 20:22 UTC (History)
9 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
: 1742202 1742203 (view as bug list)
Environment:
Last Closed: 2019-08-16 19:32:27 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1635370 0 high CLOSED TLS everywhere is not compatible with routed spine/leaf 2021-02-22 00:41:40 UTC

Description Greg Rakauskas 2019-08-12 20:12:29 UTC
This is a documentation BZ for Engineering BZs (1633782 and 1635370), and in response to an rhos-tech email list thread (subject: "[rhos-tech] OSP 13 Spine Leaf undercloud metadata issue").

The customer-facing RHOSP documentation, "Spine and Leaf Networking," instructs admins to set up Compute service (nova) metadata IPs. This is not supported. If data needs to go to a node, admins should instead use config-drive.

Comment 6 Greg Rakauskas 2019-08-16 16:47:46 UTC
Hi,

In the RHOSP 13 "Spine Leaf Networking" document, I have removed all references 
to the metadata service. 

Specifically, these changes are:

   A. In the the topic, "4.3. Creating a custom NIC Configuration:"

      i. Removed step #4:

         4. Scroll to the EC2MetadataIp parameter in the parameters section. 
            This parameter resembles the following snippet:

            EC2MetadataIp: # Override this via parameter_defaults
            description: The IP address of the EC2 metadata server.
            type: string

            Modify this parameter to suit Leaf0:

            Leaf0EC2MetadataIp: # Override this via parameter_defaults
            description: The IP address of the EC2 metadata server.
            type: string

      ii. In (former) step 6, now step 5, removed:

          - ip_netmask: 169.254.169.254/32
            next_hop:
             get_param: Leaf0EC2MetadataIp

      iii. Removed `Leaf0EC2MetadataIp` from this paragraph:

           Note that the parameters used in this case are specific to Leaf0: 
           `ControlPlane0SubnetCidr`, `Leaf0EC2MetadataIp`, and 
           `ControlPlane0DefaultRoute`. Also note the use of the CIDR for Leaf0 
           on the provisioning network (192.168.10.0/24), which is used as a 
           route.


   B. In the topic, "4.4. Creating custom Compute NIC configurations:"

      i. Removed step #4:

	 4. Scroll to the EC2MetadataIp parameter in the parameters section.
            This parameter resembles the following snippet:

            EC2MetadataIp: # Override this via parameter_defaults
            description: The IP address of the EC2 metadata server.
            type: string

            Modify this parameter to suit Leaf0:

            Leaf0EC2MetadataIp: # Override this via parameter_defaults
            description: The IP address of the EC2 metadata server.
            type: string

      ii. In (former) step 6, now step 5, removed:

          - ip_netmask: 169.254.169.254/32
            next_hop:
             get_param: Leaf0EC2MetadataIp
  
      iii. Removed `Leaf0EC2MetadataIp` from this paragraph:

           Note that the parameters used in this case are specific to Leaf0: 
           `ControlPlane0SubnetCidr`, `Leaf0EC2MetadataIp`, and 
           `ControlPlane0DefaultRoute`. Also note the use of the CIDR for Leaf0 
           on the provisioning network (192.168.10.0/24), which is used as a 
           route.

      iv. In (former) step 9, now step 8, removed this bullet item:

          - Change EC2MetadataIp to Leaf1EC2MetadataIp.

      v. In (former) step 10, now step 9, removed this bullet item:

         - Change EC2MetadataIp to Leaf2EC2MetadataIp.


   C. In the the topic, "4.5. Creating custom Ceph Storage NIC configurations:"

      i. Removed step #3:

	 3. Scroll to the EC2MetadataIp parameter in the parameters section.
            This parameter resembles the following snippet:

            EC2MetadataIp: # Override this via parameter_defaults
            description: The IP address of the EC2 metadata server.
            type: string

            Modify this parameter to suit Leaf0:

            Leaf0EC2MetadataIp: # Override this via parameter_defaults
            description: The IP address of the EC2 metadata server.
            type: string

      ii. In (former) step 5, now step 4, removed:

          - ip_netmask: 169.254.169.254/32
            next_hop:
             get_param: Leaf0EC2MetadataIp
  
      iii. Removed `Leaf0EC2MetadataIp` from this paragraph:

           Note that the parameters used in this case are specific to Leaf0: 
           `ControlPlane0SubnetCidr`, `Leaf0EC2MetadataIp`, and 
           `ControlPlane0DefaultRoute`. Also note the use of the CIDR for Leaf0 
           on the provisioning network (192.168.10.0/24), which is used as a 
           route.

      iv. In (former) step 8, now step 9, removed this bullet item:

          - Change EC2MetadataIp to Leaf1EC2MetadataIp.

      v. In (former) step 9, now step 8, removed this bullet item:

         - Change EC2MetadataIp to Leaf2EC2MetadataIp.


   D. In the the topic, "4.10. Setting control plane parameters:"

      i. From the example NIC template, removed:

         - ip_netmask: 169.254.169.254/32
           next_hop:
            get_param: Leaf0EC2MetadataIp

      ii. Removed "metadata IP" from this paragraph:

          In this instance, we need to define the IP, subnet, metadata IP, and
          default route for the respective Control Plane network on Leaf 0.

      iii. Removed step #2d:

           d. Add the parameters for the EC2 metadata IPs:

              parameter_defaults:
              ...
              Leaf0EC2MetadataIp: 192.168.10.1
              Leaf1EC2MetadataIp: 192.168.11.1
              Leaf2EC2MetadataIp: 192.168.12.1

              These act as routes through the control plane for the EC2 metadata 
              service (169.254.169.254/32) and you should typically set these to
              the respective gateway for each leaf on the provisioning network.


   D. In Appendix B, "Custom NIC template:"

      i. Removed this section:
         
         # EC2 metadata server IPs
         Leaf0EC2MetadataIp:
         type: string
         Leaf1EC2MetadataIp:
         type: string
         Leaf2EC2MetadataIp:
         type: string

In Appendix C, "Example roles_data file," I found these references, which I left
UNMODIFIED:

      I. Under, "# Role: Controller0:"

         - OS::TripleO::Services::NovaMetadata


      II. Under, "# Role: Compute0:"

          deprecated_param_metadata: 'NovaComputeServerMetadata'


      III. Under, "# Role: Compute1:"

           deprecated_param_metadata: 'NovaComputeServerMetadata'


The latest OSP 13 Spine Leaf Networking doc is here:

   https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html/spine_leaf_networking/configuring-the-overcloud#creating-a-custom-nic-configuration

If further changes are required, please reopen this BZ.

Thanks,
--Greg

Comment 7 Dan Sneddon 2019-08-16 17:52:02 UTC
I'm very sorry, but it appears I was mistaken about these changes being backported to OSP 13. The original language should remain in the OSP 13 docs, but should be removed from OSP 14+ documentation.

Moving back to Assigned until the OSP 13 changes are reverted.

Comment 8 Greg Rakauskas 2019-08-16 19:32:27 UTC
Hi,
0--------1---------2---------3---------4---------5---------6---------7---------8
Per Dan's instructions, the Compute metadata service parameter have been added
back in to the RHOSP 13 Spine Leaf Networking doc topics.

However, this information has been removed in RHOSP 14 and 15 per BZs 1742202
and 1742202, respectively.

Thanks,
--Greg


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