Skip to content
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

installation-user-infra-machines-advanced: tweak wording around live Ignition config #28199

Closed
wants to merge 1 commit into from
+6 −9
Closed

installation-user-infra-machines-advanced: tweak wording around live Ignition config #28199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 6 additions & 9 deletions modules/installation-user-infra-machines-advanced.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,10 +248,12 @@ coreos.inst.save_partindex=6
== Identifying Ignition configs
When doing an {op-system} bare metal installation, there are two types of Ignition configs that you can provide, with different reasons for providing each one:

* **Permanent install Ignition config**: Every bare metal {op-system} installation
needs to pass one of the Ignition config files generated by `openshift-installer`,
* **Permanent install Ignition config**: Every bare metal {op-system} installed system
needs to be passed one of the Ignition config files generated by `openshift-installer`,
such as `bootstrap.ign`, `master.ign` and `worker.ign`, to carry out the
installation.
installation. This Ignition config is usually written by `coreos-installer` at
installation time, so that it is available to the installed system on its first
boot.
+
[IMPORTANT]
====
Expand All @@ -264,7 +266,7 @@ the shell prompt, you identify the Ignition config on the `coreos-installer`
command line with the `--ignition-url=` option.
+

* **Live install Ignition config**: This type must be created manually and should be avoided if possible, as it is not supported by Red Hat. With this method, the Ignition config passes to the live install medium, runs immediately upon booting, and performs setup tasks before and/or after the {op-system} system installs to disk. This method should only be used for performing tasks that must be performed once and not applied again later, such as with advanced partitioning that cannot be done using a machine config.
* **Live install Ignition config**: The live environment itself, whether PXE or ISO, can be passed an Ignition config. This config applies directly to the live environment and can be used to customize the installation process, for example performing setup tasks before and/or after the {op-system} system is installed to the disk by `coreos-installer`. It is also useful for automating the live ISO installation so as to avoid interrupting the boot or interacting at the prompt. In general, customizations to the installed system should be done via MachineConfig objects. However, some things can only be done at installation time, like partition saving or some advanced network configurations.
+
For PXE or ISO boots, you can create the Ignition config
and `APPEND` the `ignition.config.url=` option to identify the location of
Expand All @@ -276,11 +278,6 @@ or the `ignition.config.url` option will be ignored.
You can embed a live install Ignition config directly in an {op-system} ISO image. When
the ISO image is booted, the embedded config will be applied automatically.

[IMPORTANT]
====
This type of configuration must be created manually and should be avoided if possible, as it is not supported by Red Hat.
====

.Procedure

. Download the `coreos-installer` binary from the following image mirror page: https://mirror.openshift.com/pub/openshift-v4/clients/coreos-installer/latest/.
Expand Down