Enable persistent search by default

From IPA version 3.0, the persistent search is a preferred mechanism
to for DNS zone list management. It will be also a requirement for
several bind-dyndb-ldap features, like SOA serial automatic updates
or DNSSEC.

Make this mechanism default in ipa-server-install and ipa-dns-istall.

https://fedorahosted.org/freeipa/ticket/2524

4 files changed, 34 insertions, 27 deletions

diff --git a/install/tools/ipa-dns-install b/install/tools/ipa-dns-install
index 063cf5bf5..6e9b99897 100755
--- a/install/tools/ipa-dns-install
+++ b/install/tools/ipa-dns-install
@@ -27,7 +27,7 @@ from ipapython import version
 from ipapython import ipautil, sysrestore
 from ipalib import api, errors, util
 from ipapython.config import IPAOptionParser
-from ipalib.constants import DNS_ZONE_REFRESH
+from optparse import OptionGroup, SUPPRESS_HELP
 import krbV
 import ldap
 from ipapython.ipa_log_manager import *
@@ -52,14 +52,16 @@ def parse_options():
     parser.add_option("--zonemgr", action="callback", callback=bindinstance.zonemgr_callback,
                       type="string",
                       help="DNS zone manager e-mail address. Defaults to hostmaster@DOMAIN")
+    # this option name has been deprecated, persistent search has been enabled by default
     parser.add_option("--zone-notif", dest="zone_notif",
-                      action="store_true", default=False,
-                      help="Let name server receive notification when a new zone is added." \
-                           "Zone refresh is turned off when zone notification is enabled")
+                      action="store_true", default=False, help=SUPPRESS_HELP)
+    parser.add_option("--no-persistent-search", dest="persistent_search",
+                      default=True, action="store_false",
+                      help="Do not enable persistent search feature in the name server")
     parser.add_option("--zone-refresh", dest="zone_refresh",
-                      default=DNS_ZONE_REFRESH, type="int",
-                      help="A delay between checks for new DNS zones. Defaults to %d" \
-                              % DNS_ZONE_REFRESH)
+                      default=0, type="int",
+                      help="When set to non-zero the name server will use DNS zone "
+                           "detection based on polling instead of a persistent search")
     parser.add_option("-U", "--unattended", dest="unattended", action="store_true",
                       default=False, help="unattended installation never prompts the user")
 
@@ -77,9 +79,11 @@ def parse_options():
 
     if options.zone_refresh < 0:
         parser.error("negative numbers not allowed for --zone-refresh")
+    elif options.zone_refresh > 0:
+        options.persistent_search = False   # mutually exclusive features
 
-    if options.zone_notif:   # mutually exclusive features
-        options.zone_refresh = 0
+    if options.zone_notif:
+        print >>sys.stderr, "WARNING: --zone-notif option is deprecated and has no effect"
 
     return safe_options, options
 
@@ -220,7 +224,7 @@ def main():
     bind.setup(api.env.host, ip_address, api.env.realm, api.env.domain,
                dns_forwarders, conf_ntp, reverse_zone, zonemgr=options.zonemgr,
                zone_refresh=options.zone_refresh,
-               zone_notif=options.zone_notif)
+               persistent_search=options.persistent_search)
     bind.create_instance()
 
     # Restart http instance to make sure that python-dns has the right resolver
diff --git a/install/tools/ipa-server-install b/install/tools/ipa-server-install
index 61c2b9d8c..6dc02f684 100755
--- a/install/tools/ipa-server-install
+++ b/install/tools/ipa-server-install
@@ -38,7 +38,7 @@ import pickle
 import random
 import tempfile
 import nss.error
-from optparse import OptionGroup, OptionValueError
+from optparse import OptionGroup, OptionValueError, SUPPRESS_HELP
 
 from ipaserver.install import dsinstance
 from ipaserver.install import krbinstance
@@ -62,7 +62,6 @@ from ipalib import api, errors, util
 from ipapython.config import IPAOptionParser
 from ipalib.dn import DN
 from ipalib.x509 import load_certificate_from_file, load_certificate_chain_from_file
-from ipalib.constants import DNS_ZONE_REFRESH
 from ipalib.util import validate_domain_name
 from ipapython import services as ipaservices
 from ipapython.ipa_log_manager import *
@@ -197,14 +196,16 @@ def parse_options():
     dns_group.add_option("--zonemgr", action="callback", callback=bindinstance.zonemgr_callback,
                       type="string",
                       help="DNS zone manager e-mail address. Defaults to hostmaster@DOMAIN")
+    # this option name has been deprecated, persistent search has been enabled by default
     dns_group.add_option("--zone-notif", dest="zone_notif",
-                      action="store_true", default=False,
-                      help="Let name server receive notification when a new zone is added." \
-                           "Zone refresh is turned off when zone notification is enabled")
+                      action="store_true", default=False, help=SUPPRESS_HELP)
+    dns_group.add_option("--no-persistent-search", dest="persistent_search",
+                      default=True, action="store_false",
+                      help="Do not enable persistent search feature in the name server")
     dns_group.add_option("--zone-refresh", dest="zone_refresh",
-                      default=DNS_ZONE_REFRESH, type="int",
-                      help="A delay between checks for new DNS zones. Defaults to %d" \
-                              % DNS_ZONE_REFRESH)
+                      default=0, type="int",
+                      help="When set to non-zero the name server will use DNS zone "
+                           "detection based on polling instead of a persistent search")
     dns_group.add_option("--no-host-dns", dest="no_host_dns", action="store_true",
                       default=False,
                       help="Do not use DNS for hostname lookup during installation")
@@ -300,9 +301,11 @@ def parse_options():
 
     if options.zone_refresh < 0:
         parser.error("negative numbers not allowed for --zone-refresh")
+    elif options.zone_refresh > 0:
+        options.persistent_search = False   # mutually exclusive features
 
-    if options.zone_notif:   # these 2 features are mutually exclusive
-        options.zone_refresh = 0
+    if options.zone_notif:
+        print >>sys.stderr, "WARNING: --zone-notif option is deprecated and has no effect"
 
     return safe_options, options
 
@@ -1033,7 +1036,7 @@ def main():
     bind.setup(host_name, ip_address, realm_name, domain_name, dns_forwarders,
                options.conf_ntp, reverse_zone, zonemgr=options.zonemgr,
                zone_refresh=options.zone_refresh,
-               zone_notif=options.zone_notif)
+               persistent_search=options.persistent_search)
     if options.setup_dns:
         api.Backend.ldap2.connect(bind_dn="cn=Directory Manager", bind_pw=dm_password)
 
diff --git a/install/tools/man/ipa-dns-install.1 b/install/tools/man/ipa-dns-install.1
index 3f40ab7ab..9fe89ed1e 100644
--- a/install/tools/man/ipa-dns-install.1
+++ b/install/tools/man/ipa-dns-install.1
@@ -49,11 +49,11 @@ Do not create new reverse DNS zone. If used on a replica and a reverse DNS zone
 \fB\-\-zonemgr\fR
 The e\-mail address of the DNS zone manager. Defaults to hostmaster@DOMAIN
 .TP
-\fB\-\-zone\-notif\fR
-Let name server receive notifications when a new zone is added. New zone is then immediately loaded by the name server. This feature uses an LDAP Persistent Search mechanism to receive the data. Zone refresh is turned off when zone notifications are enabled.
+\fB\-\-no\-persistent\-search\fR
+Do not enable persistent search mechanism for updating the list of DNS zones in the name server. When persistent search is disabled and \fB\-\-zone\-refresh\fR option is not set to non-zero value, new zones won't be resolvable until the name server is reloaded.
 .TP
 \fB\-\-zone\-refresh=\fIZONE_REFRESH\fR
-Number of seconds between regular checks for new DNS zones. When set to 0 the name server does not check for new zones and it needs to be reloaded when a new DNS zone is added.
+When set to non-zero value, persistent search zone update mechanism will be disabled and the name server will use a polling mechanism to load new DNS zones every \fIZONE_REFRESH\fR seconds.
 .TP
 \fB\-U\fR, \fB\-\-unattended\fR
 An unattended installation that will never prompt for user input
diff --git a/install/tools/man/ipa-server-install.1 b/install/tools/man/ipa-server-install.1
index b69c72059..77d406850 100644
--- a/install/tools/man/ipa-server-install.1
+++ b/install/tools/man/ipa-server-install.1
@@ -145,11 +145,11 @@ Do not create reverse DNS zone
 \fB\-\-zonemgr\fR
 The e\-mail address of the DNS zone manager. Defaults to hostmaster@DOMAIN
 .TP
-\fB\-\-zone\-notif\fR
-Let name server receive notifications when a new zone is added. New zone is then immediately loaded by the name server. This feature uses an LDAP Persistent Search mechanism to receive the data. Zone refresh is turned off when zone notifications are enabled.
+\fB\-\-no\-persistent\-search\fR
+Do not enable persistent search mechanism for updating the list of DNS zones in the name server. When persistent search is disabled and \fB\-\-zone\-refresh\fR option is not set to non-zero value, new zones won't be resolvable until the name server is reloaded.
 .TP
 \fB\-\-zone\-refresh=\fIZONE_REFRESH\fR
-Number of seconds between regular checks for new DNS zones. When set to 0 the name server does not check for new zones and it needs to be reloaded when a new DNS zone is added.
+When set to non-zero value, persistent search zone update mechanism will be disabled and the name server will use a polling mechanism to load new DNS zones every \fIZONE_REFRESH\fR seconds.
 .TP
 \fB\-\-no\-host\-dns\fR
 Do not use DNS for hostname lookup during installation