1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
atomic-openshift-installer(1)
=============================
:man source: atomic-openshift-utils
:man version: %VERSION%
:man manual: atomic-openshift-installer
NAME
----
atomic-openshift-installer - Interactive OpenShift Container Platform (OCP) installer
SYNOPSIS
--------
atomic-openshift-installer [OPTIONS] COMMAND [OPTS]
DESCRIPTION
-----------
**atomic-openshift-installer** makes the process for installing OCP
easier by interactively gathering the data needed to run on each
host. It can also be run in unattended mode if provided with a
configuration file.
OPTIONS
-------
The following options are common to all commands.
*-u*, *--unattended*::
Run installer in **unattended** mode. You will not be prompted to
answer any questions.
*-c*, *--configuration* 'PATH'::
Provide an alternate 'PATH' to an 'installer.cfg.yml' file.
*-a* 'DIRECTORY', *--ansible-playbook-directory* 'DIRECTORY'::
Manually set the 'DIRECTORY' in which to look for Ansible playbooks.
*--ansible-log-path* 'PATH'::
Specify the 'PATH' of the directory in which to save Ansible logs.
*-v*, *--verbose*::
Run the installer with more verbosity.
*-d*, *--debug*::
Enable installer debugging. Logs are saved in '/tmp/installer.txt'.
*-h*, *--help*::
Show the usage help and exit.
COMMANDS
--------
**atomic-openshift-installer** has four modes of operation:
* **install**
* **uninstall**
* **upgrade**
* **scaleup**
The options specific to each command are described in the following
sections.
INSTALL
-------
The **install** command will guide you through steps required to
install an OCP cluster. After all of the required information has been
collected (target hosts, storage options, high-availability), the
installation will begin.
*-f*, *--force*::
Forces an installation. This means that hosts with existing
installations will be reinstalled if required.
*--gen-inventory*::
Generate an Ansible inventory file and exit. The default location for
the inventory file is '~/.config/openshift/hosts'.
UNINSTALL
---------
The **uninstall** command will uninstall OCP from your target
hosts. This command has no additional options.
UPGRADE
-------
The **upgrade** command will upgrade a cluster of hosts to a newer
version of OCP.
*-l*, *--latest-minor*::
Upgrade to the latest minor version. For example, if you are running
version **3.2.1** then this could upgrade you to **3.2.2**.
*-n*, *--next-major*::
Upgrade to the latest major version. For example, if you are running
version **3.2** then this could upgrade you to **3.3**.
SCALEUP
-------
The **scaleup** command is used to add new nodes to an existing cluster.
This command has no additional options.
FILES
-----
*~/.config/openshift/installer.cfg.yml* -- Installer configuration
file. Can be used to generate an inventory later or start an
unattended installation.
*~/.config/openshift/hosts* -- Generated Ansible inventory file. Used
to run the Ansible playbooks for install, uninstall, and upgrades.
*/tmp/ansible.log* -- The default location of the ansible log file.
*/tmp/installer.txt* -- The location of the log file for debugging the
installer.
AUTHOR
------
Red Hat OpenShift Productization team
For a complete list of contributors, please visit the GitHub charts
page.
COPYRIGHT
---------
Copyright © 2016 Red Hat, Inc.
**atomic-openshift-installer** is released under the terms of the ASL
2.0 license.
SEE ALSO
--------
*ansible*(1), *ansible-playbook*(1)
*The openshift-ansible GitHub Project* -- <https://github.com/openshift/openshift-ansible/>
*The atomic-openshift-installer Documentation* -- <https://docs.openshift.com/container-platform/3.3/install_config/install/quick_install.html>
|
