Merge "Align template defaults with the client"

[apex-tripleo-heat-templates.git] / network / config / bond-with-vlans / README.md

diff --git a/network/config/bond-with-vlans/README.md b/network/config/bond-with-vlans/README.md
index 1679df3..afe7177 100644 (file)
--- a/network/config/bond-with-vlans/README.md
+++ b/network/config/bond-with-vlans/README.md
@@ -1,6 +1,11 @@
 This directory contains Heat templates to help configure
 Vlans on a bonded pair of NICs 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
 -------------
 
@@ -13,3 +18,32 @@ something like this:
     OS::TripleO::Controller::Net::SoftwareConfig: network/config/bond-with-vlans/controller.yaml
     OS::TripleO::ObjectStorage::Net::SoftwareConfig: network/config/bond-with-vlans/swift-storage.yaml
     OS::TripleO::CephStorage::Net::SoftwareConfig: network/config/bond-with-vlans/ceph-storage.yaml
+
+Or use this Heat environment file:
+
+  environments/net-bond-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/bond-with-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