Add environment for setting a custom domain name

Just setting CloudDomain won't make the domains used consistent.
There are a number of CloudName parameters that must be set as well.
This change adds a sample environment that includes all of those
parameters so it is easy to set everything consistently.

Also fixes the description of CloudNameCtlplane to reflect the
actual use for that parameter.

Change-Id: I56d1c1c5619f83c16c4e8350aa84fccc3d748425

environments/predictable-placement/custom-domain.yaml

@@ -0,0 +1,35 @@
+# *******************************************************************
+# This file was created automatically by the sample environment
+# generator. Developers should use `tox -e genconfig` to update it.
+# Users are recommended to make changes to a copy of the file instead
+# of the original, if any customizations are needed.
+# *******************************************************************
+# title: Custom Domain Name
+# description: |
+#   This environment contains the parameters that need to be set in order to
+#   use a custom domain name and have all of the various FQDNs reflect it.
+parameter_defaults:
+  # The DNS domain used for the hosts. This must match the overcloud_domain_name configured on the undercloud.
+  # Type: string
+  CloudDomain: localdomain
+
+  # The DNS name of this cloud. E.g. ci-overcloud.tripleo.org
+  # Type: string
+  CloudName: overcloud.localdomain
+
+  # The DNS name of this cloud's provisioning network endpoint. E.g. 'ci-overcloud.ctlplane.tripleo.org'.
+  # Type: string
+  CloudNameCtlplane: overcloud.ctlplane.localdomain
+
+  # The DNS name of this cloud's internal API endpoint. E.g. 'ci-overcloud.internalapi.tripleo.org'.
+  # Type: string
+  CloudNameInternal: overcloud.internalapi.localdomain
+
+  # The DNS name of this cloud's storage endpoint. E.g. 'ci-overcloud.storage.tripleo.org'.
+  # Type: string
+  CloudNameStorage: overcloud.storage.localdomain
+
+  # The DNS name of this cloud's storage management endpoint. E.g. 'ci-overcloud.storagemgmt.tripleo.org'.
+  # Type: string
+  CloudNameStorageManagement: overcloud.storagemgmt.localdomain
+

extraconfig/nova_metadata/krb-service-principals.yaml

@@ -32,8 +32,8 @@ parameters:
   CloudNameCtlplane:
     default: overcloud.ctlplane.localdomain
     description: >
-      The DNS name of this cloud's storage management endpoint. E.g.
+      The DNS name of this cloud's provisioning network endpoint. E.g.
-      'ci-overcloud.management.tripleo.org'.
+      'ci-overcloud.ctlplane.tripleo.org'.
     type: string
 
 resources:

overcloud.j2.yaml

@@ -46,8 +46,8 @@ parameters:
   CloudNameCtlplane:
     default: overcloud.ctlplane.localdomain
     description: >
-      The DNS name of this cloud's storage management endpoint. E.g.
+      The DNS name of this cloud's provisioning network endpoint. E.g.
-      'ci-overcloud.management.tripleo.org'.
+      'ci-overcloud.ctlplane.tripleo.org'.
     type: string
   ControlFixedIPs:
     default: []

sample-env-generator/predictable-placement.yaml

@@ -15,3 +15,18 @@ environments:
       Note %index% is translated into the index of the node, e.g 0/1/2 etc
       and %stackname% is replaced with OS::stack_name in the template below.
       If you want to use the heat generated names, pass '' (empty string).
+  -
+    name: predictable-placement/custom-domain
+    title: Custom Domain Name
+    files:
+      overcloud.yaml:
+        parameters:
+          - CloudDomain
+          - CloudName
+          - CloudNameInternal
+          - CloudNameStorage
+          - CloudNameStorageManagement
+          - CloudNameCtlplane
+    description: |
+      This environment contains the parameters that need to be set in order to
+      use a custom domain name and have all of the various FQDNs reflect it.