Merge "Add update yaml backward compatibe with PublicVirtualIP on ctlplane"

[apex-tripleo-heat-templates.git] / network / config / single-nic-vlans / README.md

diff --git a/network/config/single-nic-vlans/README.md b/network/config/single-nic-vlans/README.md
index e3e1657..f9c2e51 100644 (file)
--- a/network/config/single-nic-vlans/README.md
+++ b/network/config/single-nic-vlans/README.md
@@ -1,5 +1,10 @@
 This directory contains Heat templates to help configure
-Vlans on a single NICs for each Overcloud role.
+Vlans on a single NIC for each Overcloud role.
+
+There are two versions of the controller role template, one with
+an external network interface, and another without. If the
+external network interface is not configured, the ctlplane address
+ranges will be used for external (public) network traffic.
 
 Configuration
 -------------
@@ -17,3 +22,28 @@ something like this:
 Or use this Heat environment file:
 
   environments/net-single-nic-with-vlans.yaml
+
+Configuration with no External Network
+--------------------------------------
+
+Same as above except set the following value for the controller role:
+
+    OS::TripleO::Controller::Net::SoftwareConfig: network/config/single-nic-vlans/controller-no-external.yaml
+
+Configuration with System Management Network
+--------------------------------------------
+
+To enable the optional System Management network, create a Heat environment
+that looks something like this:
+
+  resource\_registry:
+    OS::TripleO::Network::Management: ../network/management.yaml
+    OS::TripleO::Controller::Ports::ManagementPort: ../network/ports/management.yaml
+    OS::TripleO::Compute::Ports::ManagementPort: ../network/ports/management.yaml
+    OS::TripleO::CephStorage::Ports::ManagementPort: ../network/ports/management.yaml
+    OS::TripleO::SwiftStorage::Ports::ManagementPort: ../network/ports/management.yaml
+    OS::TripleO::BlockStorage::Ports::ManagementPort: ../network/ports/management.yaml
+
+Or use this Heat environment file:
+
+  environments/network-management.yaml