Merge "Add output for host entries"
[apex-tripleo-heat-templates.git] / network / ports / vip.yaml
index ab72083..ab6cd2c 100644 (file)
@@ -2,6 +2,7 @@ heat_template_version: 2015-04-30
 
 description: >
   Creates a port for a VIP on the isolated network NetworkName.
+  The IP address will be chosen automatically if FixedIPs is empty.
 
 parameters:
   NetworkName:
@@ -12,21 +13,28 @@ parameters:
     description: Name of the port
     default: ''
     type: string
-  ControlPlaneIP: # Here for compatability with noop.yaml
+  ControlPlaneIP: # Here for compatibility with noop.yaml
     description: IP address on the control plane
+    default: ''
     type: string
   ControlPlaneNetwork:
     description: The name of the undercloud Neutron control plane
     default: ctlplane
     type: string
+  FixedIPs:
+    description: >
+        Control the IP allocation for the VIP port. E.g.
+        [{'ip_address':'1.2.3.4'}]
+    default: []
+    type: json
 
 resources:
-
   VipPort:
     type: OS::Neutron::Port
     properties:
       network: {get_param: NetworkName}
       name: {get_param: PortName}
+      fixed_ips: {get_param: FixedIPs}
       replacement_policy: AUTO
 
 outputs:
@@ -35,7 +43,7 @@ outputs:
     value: {get_attr: [VipPort, fixed_ips, 0, ip_address]}
   ip_subnet:
     # FIXME: this assumes a 2 digit subnet CIDR (need more heat functions?)
-    description: IP/Subnet CIDR for the internal API network IP
+    description: IP/Subnet CIDR for the network associated with this IP
     value:
           list_join:
             - ''