Bug 1329765

Summary: [Docs] Improve the Predictable IP Address Documentation
Product: Red Hat OpenStack Reporter: Dan Sneddon <dsneddon>
Component: documentationAssignee: Dan Macpherson <dmacpher>
Status: CLOSED DUPLICATE QA Contact: RHOS Documentation Team <rhos-docs>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 8.0 (Liberty)CC: dbecker, dmacpher, dsneddon, mburns, mcornea, morazi, rhel-osp-director-maint, srevivo, vcojot
Target Milestone: gaKeywords: Documentation, Reopened
Target Release: 9.0 (Mitaka)   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: DFG:Docs Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-08-02 06:04:33 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Dan Sneddon 2016-04-22 22:46:56 UTC
Description of problem:
The predictable IP address documentation could use the following improvements:

* Mention that the IP addresses chosen must be outside the AllocationPool for the VIPs when not using external load balancer.
* Link to the external load balancer document, since people who are selecting IP addresses may also wish to select the VIP IP addresses (they don't need an external load balancer to use those templates to preselect a VIP).

Version-Release number of selected component (if applicable):
8.0 GA

Actual results:

These things aren't mentioned

Expected results:

Some people expect that OSP-Director is smart enough to avoid IP conflicts. It's not, so we should warn users.

Additional info:
Documentation URL that needs to be updated:

https://access.redhat.com/documentation/en/red-hat-openstack-platform/version-8/director-installation-and-usage/#sect-Predictable_IPs

Comment 2 Dan Macpherson 2016-04-29 05:59:36 UTC
Hi Dan,

I added a paragraph to that section:

Make sure the chosen IP addresses fall outside the allocation pools for each network defined in your network environment file (see Section 6.2.2, “Creating a Network Environment File”). For example, make sure the internal_api assignments fall outside of the InternalApiAllocationPools range. This avoids any conflicts with the VIPs chosen for each network. Likewise, make sure the IP assignments do not conflict with the VIP configuration defined for external load balancing (see Section 6.5, “Configuring External Load Balancing”). 

https://access.redhat.com/documentation/en/red-hat-openstack-platform/version-8/director-installation-and-usage/#sect-Predictable_IPs

Was this what you were after? Let me know if anything else is needed.

Comment 3 Dan Macpherson 2016-06-10 01:56:56 UTC
No response in over a month. Closing this BZ. However, if further changes are required, please feel free to reopen this BZ.

Comment 4 Marius Cornea 2016-07-01 14:57:17 UTC
Hi Dan,

We need to also append to the docs how to assign static IPs for the VIPs. In addition to the existing ips-from-pool-all.yaml something like this should be added:

resource_registry:
 # Port assignments for the VIPs
  OS::TripleO::Network::Ports::NetVipMap: ../network/ports/net_vip_map_external.yaml
  OS::TripleO::Network::Ports::ExternalVipPort: ../network/ports/noop.yaml
  OS::TripleO::Network::Ports::InternalApiVipPort: ../network/ports/noop.yaml
  OS::TripleO::Network::Ports::StorageVipPort: ../network/ports/noop.yaml
  OS::TripleO::Network::Ports::StorageMgmtVipPort: ../network/ports/noop.yaml
  OS::TripleO::Network::Ports::RedisVipPort: ../network/ports/from_service.yaml
  ...
parameter_defaults: 
  ControlPlaneIP: 192.168.200.100
  ExternalNetworkVip: 192.168.225.100
  InternalApiNetworkVip: 192.168.221.100
  StorageNetworkVip: 192.168.223.100
  StorageMgmtNetworkVip: 192.168.224.100
  ServiceVips:
    redis: 192.168.221.101

Comment 5 Dan Sneddon 2016-07-01 17:51:11 UTC
(In reply to Marius Cornea from comment #4)
> Hi Dan,
> 
> We need to also append to the docs how to assign static IPs for the VIPs. In
> addition to the existing ips-from-pool-all.yaml something like this should
> be added:

Thanks for the suggestion. We already have the external loadbalancer template, but that is used to select the controller IPs as well as the VIPs. You want to just set the IP on the VIPs.

I suppose we could add another environment file example that only set the VIPs. I'll submit a review.

In the mean time I added content to the network reference architecture. This might be worth documenting in the official installation guide, so I'll make sure that the docs group is aware of my documentation.

Comment 6 Dan Macpherson 2016-08-02 06:04:33 UTC
Marius, Dan,

I'll close this BZ as a duplicate but copy you both as CCs on the other BZ.

- Dan

*** This bug has been marked as a duplicate of bug 1348859 ***