Skip to content

Updated bare metal install for coreos-installer #25709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bobfuru merged 4 commits into from
Oct 2, 2020
Merged

Updated bare metal install for coreos-installer #25709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a6b4495
Updated bare metal install for coreos-installer
Sep 23, 2020
60d11fc
Fixed small formatting error
Sep 23, 2020
447fdaf
Incorporated comments to PR
Oct 2, 2020
a2ca7ba
Merge branch 'master' into OSDOCS-1431
Oct 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 38 additions & 2 deletions installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,48 @@ Before you install a cluster on bare metal infrastructure that you provision,
you must create {op-system} machines for it to use. Follow either the steps
to use an ISO image or network PXE booting to create the machines.

include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]
There are several methods of configuring {op-system} during ISO and
PXE installations. These include:

* Kernel arguments: For a PXE install, you can `APPEND` arguments to the
kernel of the live installer. For an ISO install, you can interrupt the
live install boot process to add kernel arguments. In both cases, you can use
special `coreos-inst*` arguments to direct the installer, as well as
standard boot arguments for turning standard kernel services
on or off.

* Ignition configs: You need to generate an {product-title} Ignition config
(*.ign) file for the type of node you are installing (worker, control plane,
or bootstrap). You pass the location of the Ignition config to the installed
system so that it takes effect on first boot. You can also embed that Ignition
Config into the ISO before you boot it. In special cases, you can create a
separate, limited Ignition config to pass to the live system. That limited
Ignition config could do a limited
set of tasks, like reporting reporting success to a provisioning system
after completing installation.
This special Ignition config is consumed by the installer and should not
be used to include the standard `worker` and `master` Ignition configs.

* coreos-installer: You can boot the live ISO installer to a shell prompt,
Copy link
Contributor

@bobfuru bobfuru Sep 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here and elsewhere we agreed coreos-installer should be in back ticks.

which allows you to prepare the permanent system in a variety of ways
before first boot. In particular, you can manually run the `coreos-installer`
command from a shell prompt, passing it options to configure
some details of the installed system.

Whether to use an ISO or PXE install depends on your situation.
A PXE install requires an available DHCP service and more preparation,
but can make the installation process more automated. An ISO install
is a more manual process and can be inconvenient if you are setting
up more than a few machines.

include::modules/installation-user-infra-machines-static-network.adoc[leveloffset=+3]
include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-pxe.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-advanced.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-static-network.adoc[leveloffset=+3]

include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]

include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
Expand Down
44 changes: 42 additions & 2 deletions installing/installing_bare_metal/installing-bare-metal.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,52 @@ Before you install a cluster on bare metal infrastructure that you provision,
you must create {op-system} machines for it to use. Follow either the steps
to use an ISO image or network PXE booting to create the machines.

include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]
There are several methods of configuring {op-system} during ISO and
PXE installations. These include:

* Kernel arguments: For a PXE install, you can `APPEND` arguments to the
kernel of the live installer. For an ISO install, you can interrupt the
live install boot process to add kernel arguments. In both cases, you can use
`special coreos-inst*` arguments, to direct the live installer, as well as
standard installation boot arguments, for turning standard kernel services
on or off.

* Ignition configs: You need to generate an {product-title} Ignition config
(*.ign) file for the type of node you are installing (worker, control plane,
or bootstrap). You pass the location of the Ignition config to the installed
system, so it takes effect on first boot. You can also embed that Ignition
Config into the ISO before you boot it. In special cases, you can create a
separate Ignition config to pass to the live system, to do things like disk
configuration before installing the system.

* coreos-installer: You can boot the live ISO installer to a shell prompt,
which allows you to prepare the permanent system in a variety of ways
before first boot. In particular, you can run the `coreos-installer`
command to identify various artifacts to include, work with disk partitions,
and set up networking. In some cases, you can configure features on
the live system and copy them to the installed system.

Whether to use an ISO or PXE install depends on your situation.
A PXE install requires an available DHCP service and more preparation,
but can make the installation process more automated. An ISO install
is a more manual process and can be inconvenient if you are setting
up more than a few machines.

[NOTE]
====
As of {product-title} 4.6, the {op-system} ISO and other installation artifacts
provide support for installation on disks with 4k sectors.
Copy link
Contributor

@bobfuru bobfuru Sep 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/4k/4K/

====

include::modules/installation-user-infra-machines-static-network.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-pxe.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-advanced.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-static-network.adoc[leveloffset=+3]

include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]

include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
Expand Down
37 changes: 35 additions & 2 deletions installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,45 @@ Before you install a cluster on bare metal infrastructure that you provision,
you must create {op-system} machines for it to use. Follow either the steps
to use an ISO image or network PXE booting to create the machines.

include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]
There are several methods of configuring {op-system} during ISO and
PXE installations. These include:

* Kernel arguments: For a PXE install, you can `APPEND` arguments to the
kernel of the live installer. For an ISO install, you can interrupt the
live install boot process to add kernel arguments. In both cases, you can use
`special coreos-inst*` arguments, to direct the live installer, as well as
standard installation boot arguments, for turning standard kernel services
on or off.

* Ignition configs: You need to generate an {product-title} Ignition config
(*.ign) file for the type of node you are installing (worker, control plane,
or bootstrap). You pass the location of the Ignition config to the installed
system, so it takes effect on first boot. You can also embed that Ignition
Config into the ISO before you boot it. In special cases, you can create a
separate Ignition config to pass to the live system, to do things like disk
configuration before installing the system.

* coreos-installer: You can boot the live ISO installer to a shell prompt,
which allows you to prepare the permanent system in a variety of ways
before first boot. In particular, you can run the `coreos-installer`
command to identify various artifacts to include, work with disk partitions,
and set up networking. In some cases, you can configure features on
Copy link
Contributor

@bgilbert bgilbert Oct 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This text has also not been updated in a couple places.

the live system and copy them to the installed system.

Whether to use an ISO or PXE install depends on your situation.
A PXE install requires an available DHCP service and more preparation,
but can make the installation process more automated. An ISO install
is a more manual process and can be inconvenient if you are setting
up more than a few machines.

include::modules/installation-user-infra-machines-static-network.adoc[leveloffset=+3]
include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-pxe.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-advanced.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-static-network.adoc[leveloffset=+3]

include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]

include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion modules/digging-into-machine-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// * architecture/architecture_rhcos.adoc

[id="digging-into-machine-config_{context}"]
= Changing Ignition Configs after installation
= Changing Ignition configs after installation

Machine Config Pools manage a cluster of nodes and their corresponding Machine
Configs. Machine Configs contain configuration information for a cluster.
Expand Down
Loading