Clarify meaning of --domain and --realm in installers #352
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Man pages need bigger overhaul. Take this as hot-fix for FAQ. https://fedorahosted.org/freeipa/ticket/6574
frasertweedale
requested changes
Dec 20, 2016
| .\" along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| .\" | ||
| .\" Author: Rob Crittenden <rcritten@redhat.com> | ||
| .\" A man page for ipa-server-install |
There was a problem hiding this comment.
copy-paste error? this is ipa-dns-install.1.
| @@ -1,22 +1,7 @@ | |||
| .\" A man page for ipa-replica-install | |||
| .\" Copyright (C) 2008-2012 Red Hat, Inc. | |||
| .\" A man page for ipa-server-install | |||
There was a problem hiding this comment.
Copy-paste error? This is ipa-replica-install.1.
| @@ -103,7 +103,8 @@ class ServiceInstallInterface(common.Installable, | |||
|
|
|||
| domain_name = knob( | |||
| str, None, | |||
| description="domain name", | |||
| description="primary DNS domain of the IPA deployment " | |||
| "(not necessairly related to current hostname)", | |||
There was a problem hiding this comment.
typo; should say necessarily
|
|
||
| When no \-\-server option is specified, this domain will be used by the installer to discover all available servers via DNS SRV record autodiscovery (see DNS Autodiscovery section for details). | ||
|
|
||
| Default value used by the installer is domain part of the hostname. This option needs to be specified if the primary IPA DNS domain is different than the default value. |
There was a problem hiding this comment.
grammar nit: s/different than/different from/.
There was a problem hiding this comment.
"The default value...". There's more issues with the articles but this one I'd insist on.
stlaz
requested changes
Dec 21, 2016
|
|
||
| When no \-\-server option is specified, this domain will be used by the installer to discover all available servers via DNS SRV record autodiscovery (see DNS Autodiscovery section for details). | ||
|
|
||
| Default value used by the installer is domain part of the hostname. This option needs to be specified if the primary IPA DNS domain is different than the default value. |
There was a problem hiding this comment.
"The default value...". There's more issues with the articles but this one I'd insist on.
|
|
||
| IPA provides an integrated DNS server which can be used to ease IPA deployment. If you decide to use it, IPA will automatically maintain SRV and other service records when you change your topology. | ||
|
|
||
| DNS component in FreeIPA is optional and you may choose to manage all your DNS records manually in other third party DNS server. IPA DNS is not a general-purpose DNS server. If you need advanced features like DNS views, do not deploy IPA DNS. |
| @@ -67,10 +54,11 @@ Path to host keytab. | |||
| The fully qualified domain name of the IPA server to enroll to. | |||
| .TP | |||
| \fB\-n\fR, \fB\-\-domain\fR=\fIDOMAIN\fR | |||
| Set the domain name to DOMAIN. | |||
| The primary DNS domain of existing IPA deployment e.g. example.com. | |||
There was a problem hiding this comment.
Please add a comma before e.g.
| @@ -84,13 +69,21 @@ Consequences of the re\-enrollment on the host entry: | |||
| .SS "BASIC OPTIONS" | |||
| .TP | |||
| \fB\-\-domain\fR=\fIDOMAIN\fR | |||
| Set the domain name to DOMAIN. When no \-\-server option is specified, the installer will try to discover all available servers via DNS SRV record autodiscovery (see DNS Autodiscovery section for details). | |||
| The primary DNS domain of existing IPA deployment e.g. example.com. This DNS domain should contain the SRV records generated by IPA server installer. Usually the name is lower-cased name of IPA Kerberos realm name. | |||
There was a problem hiding this comment.
Please add a comma before e.g.
|
The fixes to raised issues are fixed in #362 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Man pages need bigger overhaul. Take this as hot-fix for FAQ.
https://fedorahosted.org/freeipa/ticket/6574