On 12/03/2015 12:54 PM, Petr Vobornik wrote:
On 12/03/2015 12:06 PM, Tomas Babej wrote:
Hi,

this patch updates the man page for the ipa-replica-install given the
latest changes (including the Jan's OTP patch).

Tomas



Questions/suggestions:

1. "you cannot provide an replica file"

It's true, but wouldn't it be better to say that "you don't need to". Or
communicate that it is a good thing. Cannot sounds too negative to me.

2. Why options: --password, --admin-password are in 'BASIC OPTIONS'
section and not also in new 'ENROLLMENT OPTIONS' section together with
--principal, --keytab, etc..? Maybe 'ENROLLMENT OPTIONS' should be
before "BASIC OPTIONS" and "BASIC OPTIONS" renamed.


General ideas, not related to this patch:
"""
        If the installation fails you may need to run ipa-server-install
--uninstall and ipa-client-install before running ipa-replica-install
again.

        The installation will fail if the host you are installing the
replica on exists as a host in IPA or an existing replication agreement
exists (for example, from a previously failed installation)
"""

I believe validators check this situation, right? So do we need to write
it in the man page.


Attaching updated patch which reflects off-line cooperation with Tomas.

New option sections were added:
DOMAIN LEVEL 1 OPTIONS
DOMAIN LEVEL 1 CLIENT ENROLLMENT OPTIONS
DOMAIN LEVEL 0 OPTIONS
--
Petr Vobornik
From a3b28d5c14063fe4ff8190251285166c53fb12d9 Mon Sep 17 00:00:00 2001
From: Tomas Babej <tba...@redhat.com>
Date: Thu, 3 Dec 2015 11:42:03 +0100
Subject: [PATCH] man: Update the ipa-replica-install manpage with promotion
 related info

---
 install/tools/man/ipa-replica-install.1 | 71 +++++++++++++++++++++++++++------
 1 file changed, 58 insertions(+), 13 deletions(-)

diff --git a/install/tools/man/ipa-replica-install.1 b/install/tools/man/ipa-replica-install.1
index df01c616c89abeb5c1f421c6e29b1034b2ec9ea7..6b323c55cfbac6f9035291832a5efff348cdc403 100644
--- a/install/tools/man/ipa-replica-install.1
+++ b/install/tools/man/ipa-replica-install.1
@@ -20,34 +20,75 @@
 .SH "NAME"
 ipa\-replica\-install \- Create an IPA replica
 .SH "SYNOPSIS"
+.SS "DOMAIN LEVEL 0"
+.TP
 ipa\-replica\-install [\fIOPTION\fR]... replica_file
+.SS "DOMAIN LEVEL 1"
+.TP
+ipa\-replica\-install [\fIOPTION\fR]...
 .SH "DESCRIPTION"
-Configures a new IPA server that is a replica of the server that generated it. Once it has been created it is an exact copy of the original IPA server and is an equal master. Changes made to any master are automatically replicated to other masters.
+Configures a new IPA server that is a replica of the server. Once it has been created it is an exact copy of the original IPA server and is an equal master. Changes made to any master are automatically replicated to other masters.
 
-The replica_file is created using the ipa\-replica\-prepare utility.
+To create a replica in a domain at domain level 0, you need to provide an replica file. The replica_file is created using the ipa\-replica\-prepare utility.
 
-If the installation fails you may need to run ipa\-server\-install \-\-uninstall before running ipa\-replica\-install again.
+To create a replica in a domain at domain level 1, you don't have to provide a replica file, the machine only needs to be enrolled in the FreeIPA domain first. This process of turning the IPA client into a replica is also referred to as replica promotion.
+
+If you're starting with an existing IPA client, simply run ipa\-replica\-install to have it promoted into a replica.
+
+To promote a blank machine into a replica, you have two options, you can either run ipa\-client\-install in a separate step, or pass the enrollment related options to the ipa\-replica\-install (see DOMAIN LEVEL 1 CLIENT ENROLLMENT OPTIONS). In the latter case, ipa\-replica\-install will join the machine to the IPA realm automatically and will proceed with the promotion step.
+
+If the installation fails you may need to run ipa\-server\-install \-\-uninstall and ipa\-client\-install before running ipa\-replica\-install again.
 
 The installation will fail if the host you are installing the replica on exists as a host in IPA or an existing replication agreement exists (for example, from a previously failed installation).
 
 A replica should only be installed on the same or higher version of IPA on the remote system.
 .SH "OPTIONS"
+.SS "DOMAIN LEVEL 1 OPTIONS"
+.TP
+\fB\-P\fR, \fB\-\-principal\fR
+The user principal which will be used to promote the client to the replica and enroll the client itself, if necessary.
+.TP
+\fB\-w\fR, \fB\-\-admin\-password\fR
+The Kerberos password for the given principal.
+
+.SS "DOMAIN LEVEL 1 CLIENT ENROLLMENT OPTIONS"
+To install client and promote it to replica using a host keytab or One Time Password, the host needs to be a member of ipaservers group. This requires to create a host entry and add it to the host group prior replica installation.
+
+--server, --domain, --realm  options are autodiscovered via DNS records by default.
+
+.TP
+\fB\-p\fR \fIPASSWORD\fR, \fB\-\-password\fR=\fIPASSWORD\fR
+One Time Password for joining a machine to the IPA realm.
+.TP
+\fB\-k\fR, \fB\-\-keytab\fR
+Path to host keytab.
+.TP
+\fB\-\-server\fR
+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.
+.TP
+\fB\-d\fR, \fB\-\-realm\fR=\fIREALM_NAME\fR
+Set the IPA realm name to REALM_NAME.
+.TP
+\fB\-\-hostname\fR
+The hostname of this machine (FQDN). If specified, the hostname will be set and the system configuration will be updated to persist over reboot.
+
+.SS "DOMAIN LEVEL 0 OPTIONS"
+.TP
+\fB\-p\fR \fIPASSWORD\fR, \fB\-\-password\fR=\fIPASSWORD\fR
+Directory Manager (existing master) password
+.TP
+\fB\-w\fR, \fB\-\-admin\-password\fR
+Admin user Kerberos password used for connection check
+
 .SS "BASIC OPTIONS"
 .TP
-\fB\-\-setup\-ca\fR
-Install and configure a CA on this replica. If a CA is not configured then
-certificate operations will be forwarded to a master with a CA installed.
-.TP
 \fB\-\-ip\-address\fR=\fIIP_ADDRESS\fR
 The IP address of this server. If this address does not match the address the host resolves to and \-\-setup\-dns is not selected the installation will fail. If the server hostname is not resolvable, a record for the hostname and IP_ADDRESS is added to /etc/hosts.
 This this option can be used multiple times to specify more IP addresses of the server (e.g. multihomed and/or dualstacked server).
 .TP
-\fB\-p\fR \fIDM_PASSWORD\fR, \fB\-\-password\fR=\fIDM_PASSWORD\fR
-Directory Manager (existing master) password
-.TP
-\fB\-w\fR \fIADMIN_PASSWORD\fR, \fB\-\-admin\-password\fR=\fIADMIN_PASSWORD\fR
-Admin user Kerberos password used for connection check
-.TP
 \fB\-\-mkhomedir\fR
 Create home directories for users on their first login
 .TP
@@ -80,6 +121,10 @@ The path to LDIF file that will be used to modify configuration of dse.ldif duri
 
 .SS "CERTIFICATE SYSTEM OPTIONS"
 .TP
+\fB\-\-setup\-ca\fR
+Install and configure a CA on this replica. If a CA is not configured then
+certificate operations will be forwarded to a master with a CA installed.
+.TP
 \fB\-\-no\-pkinit\fR
 Disables pkinit setup steps
 .TP
-- 
2.4.3

-- 
Manage your subscription for the Freeipa-devel mailing list:
https://www.redhat.com/mailman/listinfo/freeipa-devel
Contribute to FreeIPA: http://www.freeipa.org/page/Contribute/Code

Reply via email to