Skip to content

Commit

Permalink
Apply docs changes based on initial feedback from Matt Bach and Andy …
Browse files Browse the repository at this point in the history
…Krohg

Signed-off-by: Jared Hocutt <jhocutt@redhat.com>
  • Loading branch information
jaredhocutt committed Feb 12, 2024
1 parent ff2caaa commit 65faac9
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 12 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ simulated disconnected environment that you can use to try it out. To assist in
illustrating how to use this tool, this documentation will take advantage of an
environment created using that CloudFormation script.

If you are providing your own environment, you can skip ahead to the
[Bundle Content](docs/bundle_content.md) section.

At a high level, the process for using this tool to deploy an OpenShift cluster
in a disconnected environment looks like this:

Expand Down Expand Up @@ -59,7 +62,7 @@ Once your key pair is in place, create the simulated disconnected environment
using the CloudFormation script.

```bash
curl https://raw.githubusercontent.com/jaredhocutt/ocp4-disconnected/main/hack/cloudformation.yaml -o /tmp/ocp4-disconnected-cf.yaml
curl https://raw.githubusercontent.com/RedHatGov/ocp4-disconnected/main/hack/cloudformation.yaml -o /tmp/ocp4-disconnected-cf.yaml

aws cloudformation create-stack \
--stack-name ocp4-disconnected \
Expand Down Expand Up @@ -87,6 +90,4 @@ aws cloudformation describe-stacks --stack-name ocp4-disconnected --query 'Stack
However, as we go through this walkthrough, the commands to grab the value from
the outputs will be provided.

TODO: Insert diagram of VPC + EC2

[Next: Bundle Content >>](docs/bundle_content.md)
38 changes: 29 additions & 9 deletions docs/bundle_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,28 @@ when you get ready to run the tool.
### Download and Package Content

We will now run this tool the download and package the content we'll need in
order to perform an install of OpenShift in a disconnected environment in the nxext step This
.tool accepts a few parameters and will prompt for any that are not passed in.
For this walkthrough, we will use the tool in that method and have it prompt us
for the required input.
order to perform an install of OpenShift in a disconnected environment in the
next step This .tool accepts a few parameters and will prompt for any that are
not passed in. For this walkthrough, we will use the tool in that method and
have it prompt us for the required input.

```text
Usage: python -m ocp4_disconnected.bundle [OPTIONS]
Bundle all of the artifacts needed for an OpenShift 4 install in a disconnected / air-gapped
environment.
When prompted for your Pull Secret, it can be found at:
https://console.redhat.com/openshift/install/pull-secret
Options:
--openshift-version TEXT The version of OpenShift (e.g. 4.12, 4.12.23, latest) you would like
to create an air-gapped package for [required]
--output-dir TEXT The directory to output the content needed for an air-gapped install
[required]
--pull-secret TEXT The pull secret used to pull images from Red Hat
-h, --help Show this message and exit.
```

> [!WARNING]
> If you choose to specify parameters via the CLI instead of being prompted, it
Expand All @@ -51,9 +69,11 @@ for the required input.
> a volume in your `podman run` (as seen below) to `/mnt/data` to ensure your
> data persists.
The information that we need to give the tool is the OpenShift version to
download content for and our pull secret from above. The pull secret only needs
to be specified on the first run as it will be saved and used for future runs.
The information that we need to give the tool is:

- The OpenShift version to download content for, and
- Our pull secret from above. The pull secret only needsto be specified on the
first run as it will be saved and used for future runs.

If you do not specify the OpenShift version when prompted, it will default to
the latest stable version. You can also specify the version in the format of
Expand All @@ -62,9 +82,9 @@ want a specific z-stream release, you can also specify the version as `x.y.z`
(e.g. `4.12.30`).

```bash
podman pull ghcr.io/jaredhocutt/ocp4-disconnected:latest
podman pull ghcr.io/RedHatGov/ocp4-disconnected:latest

podman run -it --rm --name ocp4-disconnected --platform linux/amd64 --volume /mnt/ocp4_data:/mnt/data:z ghcr.io/jaredhocutt/ocp4-disconnected:latest
podman run -it --rm --name ocp4-disconnected --platform linux/amd64 --volume /mnt/ocp4_data:/mnt/data:z ghcr.io/RedHatGov/ocp4-disconnected:latest
```

After the tool finishes, all of the content we need is in a single tar file at
Expand Down

0 comments on commit 65faac9

Please sign in to comment.