Skip to content

Commit

Permalink
update docs - remove .../install/ dir for install-config.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsimcall committed May 5, 2024
1 parent 91dfd8b commit 56dc227
Show file tree
Hide file tree
Showing 5 changed files with 198 additions and 121 deletions.
14 changes: 8 additions & 6 deletions content/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ Welcome to the OpenShift **__Disco__**nnected Workshop!
In this workshop you will: learn about, prepare for, install and operate an OpenShift 4 cluster in a disconnected network.
This is also known as installing OpenShift in a https://docs.openshift.com/container-platform/{openshift_version}/installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.html#installation-about-restricted-networks_installing-restricted-networks-aws-installer-provisioned[_restricted network_ or an _air gap network_,window=_blank].
The workshop environment (illustrated below) gives you access to several servers/systems in different networks. The instructions and environments were created using OpenShift version `{openshift_min_version}`.
The workshop environment (illustrated below) gives you access to several systems in different networks.
The instructions and environments were created using OpenShift version `{openshift_min_version}`.
[TIP]
--
Expand All @@ -28,11 +30,11 @@ Before we begin let's consider a few use-cases for disconnected networks:

== Understanding our lab environment

The image below illustrates the various networks, systems, and connections this workshop provides.
The diagram will be simplifed and explained in more detail in later chapters.
The workshop instructions will help you prepare the [.lowside]#jump system# to download the installation content, setup the [.highside]#highside system# to host the content, and create the [.highside]#openshift.disco.lab cluster# -- which doesn't exist yet.
The diagram below illustrates the various networks, systems, and connections this workshop provides.
The diagram will be simplifed and explained in more detail later.
The workshop instructions will help you prepare the [.lowside]#jump system# to download the installation content, setup the [.highside]#highside system# to host the content, and create an [.highside]#openshift.disco.lab cluster# -- which doesn't exist yet.

The [.salsa]#salsa network# and its systems are built automatically when the workshop environment is created.
The [.salsa]#salsa network# and its systems were built automatically when the workshop environment was created.
You can log into the [.salsa]#salsa systems# to compare your systems with functional disconnected systems.

image::disco-4.svg[disco diagram,800]
Expand Down Expand Up @@ -64,7 +66,7 @@ echo 'Run this command on the "highside" system'
Use the *Copy* button in the corner of the command boxes to your advantage!

[%hardbreaks]
On Linux, press **Ctrl + Shift + V** to paste.
Press **Ctrl + Shift + V** to paste.
Using **Ctrl + Insert** (copy) and **Shift + Insert** (paste) also works.
--

Expand Down
50 changes: 27 additions & 23 deletions content/modules/ROOT/pages/lab02.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ You can refer to the https://docs.openshift.com/container-platform/{openshift_ve
{counter:steps}. Prepare a system ([.lowside]#jump#) that can download the mirroring tools and the OpenShift installation images
** Use `oc-mirror` to download the content
** Use `oc-mirror` to download the installation images
{counter:steps}. Move the mirroring tools and installation images from the [.lowside]#jump system# to the [.highside]#highside system#
** We'll use `rsync` in this workshop
** Many people use DVDs and actually walk the content between systems and over air gaps
** Many people use DVDs or USBs to walk content between systems and over air gaps
*** This is known as https://en.wikipedia.org/wiki/Sneakernet[👟 _sneaker net_ 👟,window=_blank]
{counter:steps}. Setup a system ([.highside]#highside#) that can _serve the installation images_ in the disconnected network
Expand All @@ -23,9 +23,9 @@ You can refer to the https://docs.openshift.com/container-platform/{openshift_ve
{counter:steps}. Tell the OpenShift installation program (`openshift-install`) where to find the installation images

** Make a few changes to the default `install-config.yaml` file
*** Add the TLS certificate data for the `mirror-registry`
*** Add credentials (`pull secret`) for the `mirror-registry`
*** Add the `mirror-registry` as an approved mirror source
*** Trust the TLS certificate of the `mirror-registry`
{counter:steps}. After OpenShift has been installed...
Expand Down Expand Up @@ -74,37 +74,37 @@ The previous tool, `oc adm release mirror ...`, is still available but not recom

[NOTE]
--
Disconnected OpenShift installations can use any _image registry_ that supports the Docker v2 API, [.underline]#provide TLS encryption, and require authenticated image pulls#, such as:
Disconnected OpenShift installations can use any _image registry_ that supports the Docker v2 API, [.underline]#provide TLS encryption#, and [.underline]#require authenticated image pulls#, such as:

* Harbor
* JFrog Artifactory
* Sonatype Nexus Repository
* Red Hat Quay Registry (enterprise)
--

Please begin by changing your directory to `/mnt/low-side-data/`
[.lowside,source,bash,role=execute,subs="attributes"]
----
cd /mnt/low-side-data/
----


[TIP]
--
Click the *Copy* button to quickly grab all of the commands in the code blocks.

On Linux, press **Ctrl + Shift + V** to paste.
[%hardbreaks]
Press **Ctrl + Shift + V** to paste.
Using **Ctrl + Insert** (copy) and **Shift + Insert** (paste) also works.

The pasted commands won't run immediately.
You must to hit Enter/Return yourself.
--

Use the following commands to download and extract the following tools.
[%hardbreaks]
Please begin by changing your directory to `/mnt/low-side-data/`
Then use the following commands to download and extract the required tools.

* `oc-mirror`: A plugin to the `oc` command for mirorring OpenShift releases, apps / Operators, additional images, and Helm charts

[.lowside,source,bash,role=execute,subs="attributes"]
----
cd /mnt/low-side-data/
curl -L -o oc-mirror.tar.gz https://mirror.openshift.com/pub/openshift-v4/clients/ocp/{openshift_min_version}/oc-mirror.tar.gz
tar -xzf oc-mirror.tar.gz
rm -f oc-mirror.tar.gz
Expand Down Expand Up @@ -142,17 +142,17 @@ rm -f openshift-install.tar.gz

Now that the mirroring and installation tools have been downloaded and extracted, it's time to put `oc-mirror` to work! Let's start with a brief overview of using `oc-mirror`:

{counter:mirror}. Provide your access credentials (a **_pull secret_**)
{counter:mirror}. Provide access credentials (a **_pull secret_**)

** Credentials are required to download OpenShift installation images

{counter:mirror}. Create a YAML file that describes:
{counter:mirror}. Create an `ImageSetConfiguration` YAML file that describes:

** What to download (OpenShift itself, an Operator, and an image)
** What versions (e.g. everything between {openshift_min_version} and {openshift_max_version})
** Where to store the download content

{counter:mirror}. Run `oc-mirror`
{counter:mirror}. Run `oc-mirror` with the YAML file

** This process downloads ~25 GB of data and takes about 15 minutes in this workshop environment
** We will run this process in the background so that you can keep working.
Expand All @@ -162,9 +162,9 @@ Now that the mirroring and installation tools have been downloaded and extracted
A **_pull secret_** is JSON-formated data that combines authentication information for one or more Image Registries into a single file.
You can find your own _pull secret_ in the https://console.redhat.com/openshift/install/pull-secret[Red Hat Hybrid Cloud Console,window=_blank].

More information about _pull secrets_ can be found in the xref:appendix01.adoc#pull-secrets[Appendix].

This workshop provides a generic _pull secret_ in order to avoid delays and frustrations using `vi` or `nano`.

More information about _pull secrets_ can be found in the xref:appendix01.adoc#pull-secrets[Appendix].
--

Please begin by copying the provided _pull secret_ into the default location.
Expand All @@ -175,7 +175,7 @@ mkdir -v ~/.docker
cp -v ~/pull-secret-example.json ~/.docker/config.json
----

Next, we need to create an `ImageSetConfiguration` that describes what needs to be downloaded.
Next, we need to create an `ImageSetConfiguration` YAML file that describes what needs to be downloaded.
**To save time and storage, we're only going to download two versions of OpenShift**.
We will also only download one extra app/Operator, the `Web Terminal` Operator.
And one additional image, `registry.redhat.io/rhel8/support-tools`.
Expand Down Expand Up @@ -221,12 +221,12 @@ EOF

[WARNING]
--
Please run the next `oc-mirror` command in a `tmux` screen.
**It takes ~15 minutes to download the installation images in this workshop environment.**

Please run the next `oc-mirror` command in a `tmux` session.
This will allow you to move on to the next section while `oc-mirror` downloads ~25 GB of data.

Your workshop environment has configured `tmux` to be as user-friendly as possible.

**The download takes about 15 minutes in this workshop environment.**
--

Let's create a `tmux` session and begin the `oc-mirror` download.
Expand All @@ -236,9 +236,6 @@ You can drag the line that divides the panes to resize them.

If you use your scroll wheel, please press `q` to return to the bottom and continue typing.

[TIP]
For more information on tmux, xref:appendix-tmux.adoc[check out the Appendix]

[.lowside,source,bash,role=execute]
----
tmux
Expand All @@ -259,6 +256,13 @@ tmux
Mouse mode has been turned on. Click to select your window/pane. Resize works too. Hold shift when selecting text.
----

[TIP]
--
[%hardbreaks]
If you get disconnected from tmux, you can re-attach by typing: `tmux attach`
For more information on tmux, xref:appendix-tmux.adoc[check out the Appendix]
--

Now that `tmux` is running, choose one of the _panes_ to run the `oc-mirror` command.
`oc-mirror` is run with an argument to specify the `ImageSetConfig` file and the output URL.

Expand Down
Loading

0 comments on commit 56dc227

Please sign in to comment.