Skip to content

Commit

Permalink
Document the cluster os image override
Browse files Browse the repository at this point in the history
  • Loading branch information
Fedosin committed Feb 24, 2020
1 parent dfe9450 commit 1dc40ef
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/user/openstack/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Beyond the [platform-agnostic `install-config.yaml` properties](../customization
* [Examples](#examples)
* [Minimal](#minimal)
* [Custom-machine-pools](#custom-machine-pools)
* [Image Overrides](#image-overrides)
* [Further customization](#further-customization)

## Cluster-scoped properties
Expand Down Expand Up @@ -90,6 +91,37 @@ pullSecret: '{"auths": ...}'
sshKey: ssh-ed25519 AAAA...
```

## Image Overrides

When doing a disconnected installation, the OpenStack platform has the additional requirement that we have locations to download the RHCOS images. The installer downloads these from a location described in
[/data/data/rhcos.json](/data/data/rhcos.json), but they can be overridden to point to a local mirror.

To do so and upload binary data from a custom location the user may set `clusterOSImage` parameter in the install config that points to that location, and then start the installation. In all other respects the process will be consistent with the default.

**NOTE:** For this to work, the parameter value must be a valid http(s) URL.

**NOTE:** The optional `sha256` query parameter can be attach to the URL, which will force the installer to check the image file checksum before uploading it into Glance.

Example:

```yaml
platform:
openstack:
clusterOSImage: http://mirror.example.com/images/rhcos-43.81.201912131630.0-openstack.x86_64.qcow2.gz?sha256=ffebbd68e8a1f2a245ca19522c16c86f67f9ac8e4e0c1f0a812b068b16f7265d
```

If the user wants to reuse an existing Glance image without any uploading of binary data, then it is possible to set `clusterOSImage` install config parameter that specifies the Glance image name. In this case no new Glance images will be created, and the image will stay when the cluster is destroyed.

Example:

```yaml
platform:
openstack:
clusterOSImage: my-rhcos
```

**NOTE:** The only difference in behavior with the previous example is that the value here is not an http(s) URL.

## Further customization

For customizing the installation beyond what is possible with `openshift-install`, refer to the [UPI (User Provided Infrastructure) documentation](./install_upi.md).

0 comments on commit 1dc40ef

Please sign in to comment.