Skip to content

Commit 100fc3f

Browse files
authored
Merge pull request #6498 from adellape/revert-qi
Reverting quick installer changes
2 parents 4210362 + 2e0a6f7 commit 100fc3f

26 files changed

+755
-90
lines changed

_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,8 @@ Topics:
282282
File: host_preparation
283283
- Name: Installing on Containerized Hosts
284284
File: rpm_vs_containerized
285+
- Name: Quick Installation
286+
File: quick_install
285287
- Name: Advanced Installation
286288
File: advanced_install
287289
- Name: Disconnected Installation

admin_guide/backup_restore.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ nodes they get rescheduled to.
5151
reinstallation, save all the files used in the initial installation. This may
5252
include:
5353
+
54+
- *_~/.config/openshift/installer.cfg.yml_* (from the
55+
xref:../install_config/install/quick_install.adoc#install-config-install-quick-install[Quick Installation]
56+
method)
5457
- Ansible playbooks and inventory files (from the
5558
xref:../install_config/install/advanced_install.adoc#install-config-install-advanced-install[Advanced
5659
Installation] method)

admin_guide/manage_nodes.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,12 @@ certificates, and other important steps. See the
115115
xref:../install_config/adding_hosts_to_existing_cluster.adoc#adding-nodes-advanced[advanced
116116
installation] method for instructions on running the playbook directly.
117117

118+
ifdef::openshift-enterprise[]
119+
Alternatively, if you used the quick installation method, you can
120+
xref:../install_config/adding_hosts_to_existing_cluster.adoc#adding-nodes-or-reinstalling-quick[re-run
121+
the installer to add nodes], which performs the same steps.
122+
endif::[]
123+
118124
[[deleting-nodes]]
119125
== Deleting Nodes
120126

admin_guide/managing_networking.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -290,8 +290,8 @@ The egress firewall always allows pods access to the external interface of the
290290
node the pod is on for DNS resolution. If your DNS resolution is not handled by
291291
something on the local node, then you will need to add egress firewall rules
292292
allowing access to the DNS server's IP addresses if you are using domain names
293-
in your pods. The default installer sets up a local dnsmasq, so if you are using
294-
that setup you will not need to add extra rules.
293+
in your pods. The xref:../install_config/install/quick_install.adoc#install-config-install-quick-install[default installer]
294+
sets up a local dnsmasq, so if you are using that setup you will not need to add extra rules.
295295
====
296296

297297

admin_solutions/master_node_config.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ xref:../architecture/infrastructure_components/kubernetes_infrastructure.adoc#no
3131

3232
[[master-node-config-prereq]]
3333
== Prerequisites
34+
For testing environments deployed via the
35+
xref:../install_config/install/quick_install.adoc#install-config-install-quick-install[quick install], one master should be sufficient. The quick installation method should not be used for production environments.
3436

3537
Production environments should be installed using the
3638
xref:../install_config/install/advanced_install.adoc#install-config-install-advanced-install[advanced install]. In production environments, it is a good idea to use
@@ -49,16 +51,17 @@ The only way to successfully run only two masters is if you install etcd on host
4951
[[master-node-config-masters-nodes]]
5052
== Configuring Masters and Nodes
5153

52-
The method you use to configure your master and node configuration files must match the method that was used to install your {product-title} cluster. If you followed the xref:../install_config/install/advanced_install.adoc#install-config-install-advanced-install[Advanced installation]
54+
The method you use to configure your master and node configuration files must match the method that was used to install your {product-title} cluster. If you followed the:
55+
56+
- xref:../install_config/install/advanced_install.adoc#install-config-install-advanced-install[Advanced installation]
5357
method using Ansible, then make your configuration changes
5458
xref:../admin_solutions/master_node_config.adoc#master-node-config-ansible[in the Ansible playbook].
59+
- xref:../install_config/install/quick_install.adoc#install-config-install-quick-install[Quick installation]
5560
ifdef::openshift-origin[]
56-
If you followed the
57-
xref:../getting_started/administrators.adoc#getting-started-administrators[Manual
58-
installation] method, then make your changes
59-
xref:../admin_solutions/master_node_config.adoc#master-node-config-manual[manually
60-
in the configuration files] themselves.
61-
endif::[]
61+
or link:https://docs.openshift.org/latest/getting_started/administrators.html[Manual installation]
62+
endif::openshift-origin[]
63+
method, then make your changes
64+
xref:../admin_solutions/master_node_config.adoc#master-node-config-manual[manually in the configuration files] themselves.
6265

6366
[[master-node-config-ansible]]
6467
=== Making Configuration Changes Using Ansible
@@ -241,8 +244,9 @@ For more information on the `htpasswd` command, see xref:../install_config/confi
241244
[[master-node-config-manual]]
242245
=== Making Manual Configuration Changes
243246

244-
You can make manual modifications to the master and node configuration files to
245-
customize your cluster.
247+
After installing {product-title} using the
248+
xref:../install_config/install/quick_install.adoc#install-config-install-quick-install[quick install],
249+
you can make modifications to the master and node configuration files to customize your cluster.
246250

247251
*Use Case: Configure the cluster to use HTPasswd authentication*
248252

install_config/adding_hosts_to_existing_cluster.adoc

Lines changed: 107 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,92 @@ toc::[]
1313

1414
== Overview
1515

16-
You can add new hosts (either nodes or masters) to your installation using the
17-
*_scaleup.yml_* playbook for advanced installations.
16+
Depending on how your {product-title} cluster was installed, you can add new
17+
hosts (either nodes or masters) to your installation by using the install tool
18+
for quick installations, or by using the *_scaleup.yml_* playbook for advanced
19+
installations.
20+
21+
[[adding-nodes-or-reinstalling-quick]]
22+
== Adding Hosts Using the Quick Installer Tool
23+
24+
If you used the quick install tool to install your {product-title} cluster, you
25+
can use the quick install tool to add a new node host to your existing cluster.
26+
27+
[NOTE]
28+
====
29+
Currently, you can not use the quick installer tool to add new master hosts. You
30+
must use the
31+
xref:../install_config/install/advanced_install.adoc#install-config-install-advanced-install[advanced
32+
installation] method to do so.
33+
====
34+
35+
If you used the installer in either
36+
xref:../install_config/install/quick_install.adoc#running-an-interactive-installation[interactive] or
37+
xref:../install_config/install/quick_install.adoc#running-an-unattended-installation[unattended] mode, you can re-run the
38+
installation as long as you have an
39+
xref:../install_config/install/quick_install.adoc#defining-an-installation-configuration-file[installation configuration
40+
file] at *_~/.config/openshift/installer.cfg.yml_* (or specify a different
41+
location with the `-c` option).
42+
43+
////
44+
If you installed using the
45+
xref:../install_config/install/advanced_install.adoc#install-config-install-advanced-install[advanced
46+
installation] method and therefore do not have an installation configuration
47+
file, you can either try
48+
xref:../install_config/install/quick_install.adoc#defining-an-installation-configuration-file[creating your own] based on
49+
your cluster's current configuration, or see the advanced installation method on
50+
how to
51+
xref:adding-nodes-advanced[run the playbook for adding new nodes directly].
52+
////
53+
54+
[IMPORTANT]
55+
====
56+
The recommended maximum number of nodes is 300.
57+
====
58+
59+
To add nodes to your installation:
60+
61+
. Ensure you have the latest installer and playbooks by updating the
62+
*atomic-openshift-utils* package:
63+
+
64+
----
65+
# yum update atomic-openshift-utils
66+
----
67+
68+
. Run the installer with the `scaleup` subcommand in interactive or
69+
unattended mode:
70+
+
71+
----
72+
# atomic-openshift-installer [-u] [-c </path/to/file>] scaleup
73+
----
74+
75+
. The installer detects your current environment and allows you to add additional nodes:
76+
+
77+
----
78+
*** Installation Summary ***
79+
80+
Hosts:
81+
- 100.100.1.1
82+
- OpenShift master
83+
- OpenShift node
84+
- Etcd (Embedded)
85+
- Storage
86+
87+
Total OpenShift masters: 1
88+
Total OpenShift nodes: 1
89+
90+
91+
---
92+
93+
We have detected this previously installed OpenShift environment.
94+
95+
This tool will guide you through the process of adding additional
96+
nodes to your cluster.
97+
98+
Are you ready to continue? [y/N]:
99+
----
100+
+
101+
Choose (y) and follow the on-screen instructions to complete your desired task.
18102

19103
[[adding-nodes-advanced]]
20104
== Adding Hosts Using the Advanced Install
@@ -24,13 +108,27 @@ cluster by running the *_scaleup.yml_* playbook. This playbook queries the
24108
master, generates and distributes new certificates for the new hosts, then runs
25109
the configuration playbooks on the new hosts only. Before running the
26110
*_scaleup.yml_* playbook, complete all prerequisite
27-
xref:../install_config/install/host_preparation.adoc#install-config-install-host-preparation[host preparation] steps.
111+
xref:../install_config/install/host_preparation.adoc#install-config-install-host-preparation[host
112+
preparation] steps.
113+
114+
115+
ifdef::openshift-enterprise[]
116+
This process is similar to re-running the installer in the
117+
xref:adding-nodes-or-reinstalling-quick[quick installation method to add nodes],
118+
however you have more configuration options available when using the advanced
119+
method and when running the playbooks directly.
120+
endif::[]
28121

29122
You must have an existing inventory file (for example, *_/etc/ansible/hosts_*)
30123
that is representative of your current cluster configuration in order to run the
31124
*_scaleup.yml_* playbook.
32125
ifdef::openshift-enterprise[]
33-
126+
If you previously used the `atomic-openshift-installer` command to run your
127+
installation, you can check *_~/.config/openshift/hosts_* (previously located at
128+
*_~/.config/openshift/.ansible/hosts_*) for the last inventory file that the
129+
installer generated, and use or modify that as needed as your inventory file.
130+
You must then specify the file location with `-i` when calling
131+
`ansible-playbook` later.
34132
endif::[]
35133

36134
[IMPORTANT]
@@ -40,11 +138,11 @@ The recommended maximum number of nodes is 300.
40138

41139
To add a host to an existing cluster:
42140

43-
. Ensure you have the latest playbooks by updating the *openshift-ansible*
44-
packages:
141+
. Ensure you have the latest playbooks by updating the *atomic-openshift-utils*
142+
package:
45143
+
46144
----
47-
# yum update openshift-ansible
145+
# yum update atomic-openshift-utils
48146
----
49147

50148
. Edit your *_/etc/ansible/hosts_* file and add *new_<host_type>* to the
@@ -165,11 +263,11 @@ preparation] steps.
165263

166264
To add an etcd host to an existing cluster:
167265

168-
. Ensure you have the latest playbooks by updating the *openshift-ansible* packages:
266+
. Ensure you have the latest playbooks by updating the *atomic-openshift-utils* package:
169267
+
170268
[source, bash]
171269
----
172-
$ yum update openshift-ansible
270+
$ yum update atomic-openshift-utils
173271
----
174272

175273
. Edit your *_/etc/ansible/hosts_* file, add *new_<host_type>* to the

install_config/configuring_authentication.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,13 @@ xref:identity-providers[identity provider].
2626
This can be done during an
2727
xref:../install_config/install/advanced_install.adoc#configuring-cluster-variables[advanced installation] or configured after installation.
2828

29-
If you installed {product-title} using the
30-
xref:../install_config/install/advanced_install.adoc#install-config-install-advanced-install[Advanced Installation] method, the
29+
If you installed {product-title} using
30+
the
31+
ifdef::openshift-enterprise[]
32+
xref:../install_config/install/quick_install.adoc#install-config-install-quick-install[Quick Installation] or
33+
endif::[]
34+
xref:../install_config/install/advanced_install.adoc#install-config-install-advanced-install[Advanced Installation]
35+
method, the
3136
ifdef::openshift-enterprise[]
3237
xref:DenyAllPasswordIdentityProvider[Deny All] identity provider is
3338
used by default, which denies access for all user names and

install_config/configuring_sdn.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ xref:../install_config/install/advanced_install.adoc#configuring-cluster-variabl
7272
which is configurable in the Ansible inventory file.
7373

7474
.Example SDN Configuration with Ansible
75+
====
76+
7577
----
7678
# Configure the multi-tenant SDN plugin (default is 'redhat/openshift-ovs-subnet')
7779
# os_sdn_network_plugin_name='redhat/openshift-ovs-multitenant'
@@ -107,6 +109,15 @@ which is configurable in the Ansible inventory file.
107109
# or userspace for the userspace proxy.
108110
#openshift_node_proxy_mode=iptables
109111
----
112+
====
113+
114+
ifdef::openshift-enterprise[]
115+
For initial xref:../install_config/install/quick_install.adoc#install-config-install-quick-install[quick installations],
116+
the *ovs-subnet* plug-in is installed and configured by default as well, and can
117+
be
118+
xref:../install_config/master_node_configuration.adoc#master-configuration-files[reconfigured post-installation]
119+
using the `*networkConfig*` stanza of the *_master-config.yaml_* file.
120+
endif::[]
110121

111122
[[configuring-the-pod-network-on-masters]]
112123
== Configuring the Pod Network on Masters
@@ -399,3 +410,5 @@ ONBOOT=yes
399410
DEFTROUTE=no
400411
PEERDNS=no
401412
----
413+
414+

install_config/imagestreams_templates.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@ ifdef::openshift-enterprise[]
1717
Your {product-title} installation includes useful sets of Red Hat-provided
1818
xref:../architecture/core_concepts/builds_and_image_streams.adoc#image-streams[image streams]
1919
and xref:../dev_guide/templates.adoc#dev-guide-templates[templates] to
20-
make it easy for developers to create new applications. By default, advanced installation
21-
method automatically creates these sets in the *openshift* project, which is a
20+
make it easy for developers to create new applications. By default, the
21+
xref:../install_config/install/quick_install.adoc#install-config-install-quick-install[quick] and
22+
xref:../install_config/install/advanced_install.adoc#install-config-install-advanced-install[advanced installation]
23+
methods automatically create these sets in the *openshift* project, which is a
2224
default global project to which all users have view access.
2325
endif::[]
2426

install_config/install/advanced_install.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ xref:running-the-advanced-installation-system-container[containerized version of
4343
Technology Preview feature.
4444
====
4545

46+
ifdef::openshift-enterprise[]
47+
Alternatively, you can use the xref:../../install_config/install/quick_install.adoc#install-config-install-quick-install[quick installation]
48+
method if you prefer an interactive installation experience.
49+
endif::[]
50+
4651
[NOTE]
4752
====
4853
To install {product-title} as a stand-alone registry, see

install_config/install/disconnected_install.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,8 @@ builder images:
496496
[[disconnected-running-the-openshift-installer]]
497497
=== Running the {product-title} Installer
498498

499-
You can now follow the
499+
You can now choose to follow the
500+
xref:../../install_config/install/quick_install.adoc#install-config-install-quick-install[quick] or
500501
xref:../../install_config/install/advanced_install.adoc#install-config-install-advanced-install[advanced]
501502
{product-title} installation instructions in the documentation.
502503

install_config/install/host_preparation.adoc

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,14 @@ xref:../../install_config/install/advanced_install.adoc#running-the-advanced-ins
118118

119119
.. Skip to xref:installing-docker[Installing Docker].
120120

121-
. Install the following package, which provides the Ansible playbooks and related
122-
configuration files needed for installation:
121+
. Install the following package, which provides RPM-based {product-title}
122+
installer utilities and pulls in other tools required by the
123+
xref:../../install_config/install/quick_install.adoc#install-config-install-quick-install[quick]
124+
and
125+
xref:../../install_config/install/advanced_install.adoc#install-config-install-advanced-install[advanced installation] methods, such as Ansible and related configuration files:
123126
+
124127
----
125-
# yum install openshift-ansible
128+
# yum install atomic-openshift-utils
126129
----
127130
endif::[]
128131

@@ -629,10 +632,16 @@ Logging Drivers].
629632

630633
== Ensuring Host Access
631634

632-
The xref:advanced_install.adoc#install-config-install-advanced-install[advanced
633-
installation] method requires a user that has access to all hosts. If you want
634-
to run the installer as a non-root user, passwordless *sudo* rights must be
635-
configured on each destination host.
635+
ifdef::openshift-origin[]
636+
The xref:advanced_install.adoc#install-config-install-advanced-install[advanced installation] method requires
637+
endif::[]
638+
ifdef::openshift-enterprise[]
639+
The xref:quick_install.adoc#install-config-install-quick-install[quick] and xref:advanced_install.adoc#install-config-install-advanced-install[advanced
640+
installation] methods require
641+
endif::[]
642+
a user that has access to all hosts. If you want to run the installer as a
643+
non-root user, passwordless *sudo* rights must be configured on each destination
644+
host.
636645

637646
For example, you can generate an SSH key on the host where you will invoke the
638647
installation process:
@@ -665,6 +674,7 @@ Containerized Hosts]
665674
to prepare your hosts.
666675

667676
When you are ready to proceed, you can install {product-title} using the
677+
xref:quick_install.adoc#install-config-install-quick-install[quick installation] or
668678
xref:advanced_install.adoc#install-config-install-advanced-install[advanced installation] method.
669679
endif::[]
670680

0 commit comments

Comments
 (0)