Deprecate redundant DockerNovaMigrationSshdPort

Currently we have the following two parameters to control the tcp port
for ssh connection used by nova migration feature.

1) MigrationSshPort
This parameter determines the tcp port defined in ssh client
configuration and also the one allowed by firewall rule.

2) DockerNovaMigrationSshdPort
This parameter determines tcp port which sshd for nova migration
listens on.

This is very redundant, especially considering the fact that users
should update these two parameters consistently to change port number
from the default one.

This change deprecates the DockerNovaMigrationSshdPort parameter, so
that we can replace that by MigrationSshPort in a future release, and
provide only that single parameter.

Also, some constraints about port number has been added, to accept
a value within the valid range.

Change-Id: Ia80c8b8711cda4d6189051d75eb13967a44dc40d

deployment/deprecated/nova/nova-libvirt-container-puppet.yaml

@@ -209,6 +209,8 @@ parameters:
     default: 2022
     description: Target port for migration over ssh
     type: number
+    constraints:
+    - range: { min: 1, max: 65535 }
   LibvirtTLSPassword:
     description: The password for the libvirt service when TLS is enabled
     type: string

deployment/nova/nova-compute-container-puppet.yaml

@@ -375,6 +375,8 @@ parameters:
     default: 2022
     description: Target port for migration over ssh
     type: number
+    constraints:
+    - range: { min: 1, max: 65535 }
   VerifyGlanceSignatures:
     default: False
     description: Whether to verify image signatures.

deployment/nova/nova-migration-target-container-puppet.yaml

@@ -37,11 +37,6 @@ parameters:
     description: Mapping of service endpoint -> protocol. Typically set
                  via parameter_defaults in the resource registry.
     type: json
-  DockerNovaMigrationSshdPort:
-    default: 2022
-    description: Port that dockerized nova migration target sshd service
-                 binds to.
-    type: number
   MigrationSshKey:
     type: json
     description: >
@@ -55,6 +50,27 @@ parameters:
     default: 2022
     description: Target port for migration over ssh
     type: number
+    constraints:
+    - range: { min: 1, max: 65535 }
+
+  # DEPRECATED: the following options are deprecated and are currently maintained
+  # for backwards compatibility. They will be removed in future release.
+  DockerNovaMigrationSshdPort:
+    default: 0
+    description: Port that dockerized nova migration target sshd service
+                 binds to.
+    type: number
+    constraints:
+    - range: { min: 0, max: 65535 }
+
+parameter_groups:
+- label: deprecated
+  description: Do not use deprecated params, they will be removed.
+  parameters:
+    - DockerNovaMigrationSshdPort
+
+conditions:
+  docker_nova_migration_ssh_port_set: {not: {equals: [{get_param: DockerNovaMigrationSshdPort}, 0]}}
 
 resources:
   ContainersCommon:
@@ -158,7 +174,11 @@ outputs:
             str_replace:
               template: "/usr/sbin/sshd -D -p SSHDPORT"
               params:
-                SSHDPORT: {get_param: DockerNovaMigrationSshdPort}
+                SSHDPORT:
+                  if:
+                    - docker_nova_migration_ssh_port_set
+                    - {get_param: DockerNovaMigrationSshdPort}
+                    - {get_param: MigrationSshPort}
           config_files:
             - source: "/var/lib/kolla/config_files/src/*"
               dest: "/"

deployment/nova/nova-modular-libvirt-container-puppet.yaml

@@ -213,6 +213,8 @@ parameters:
     default: 2022
     description: Target port for migration over ssh
     type: number
+    constraints:
+    - range: { min: 1, max: 65535 }
   LibvirtTLSPassword:
     description: The password for the libvirt service when TLS is enabled
     type: string

releasenotes/notes/deprecate-docker_nova_migration_sshd_port-b99c1ba0ac012276.yaml

@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``DockerNovaMigrationSshdPort`` parameter has been deprecated. This
+    will be completely merged to the ``MigrationSshPort`` parameter.