Skip to content

Update release-payload docs now that installers are included #757

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
hardys merged 1 commit into from
Aug 28, 2019
Merged

Update release-payload docs now that installers are included #757

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
82 changes: 59 additions & 23 deletions docs/release-payload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,53 @@
# Publishing a KNI Release Payload
# Baremetal installer in OpenShift releases

OpenShift publishes a release payload image which includes information
about cluster operator images and their resource manifests, along with
references to installer and CLI images. The recommended method for
obtaining an installer binary is to first choose a release version and
then use the `oc adm release extract --tools` command to extract the
installer binary from the release payload.
then use the `oc adm release extract` command to extract the installer
binary from the release payload.

Since KNI has temporarily forked the installer, we build custom and
publish custom release payloads that include a reference to the forked
installer.
Since 4.2, an image named `baremetal-installer` is included with each
release payload, which contains an openshift-installer compiled by with
the `baremetal` and `libvirt` build tags.

```sh
$ oc adm release info registry.svc.ci.openshift.org/ocp/release:4.2 | grep baremetal-installer
baremetal-installer sha256:fa2c82f8d88d375f048b8da6fc823ffc8a99da4560e7478bc6a63f83f6721ca3
```

This image is included in each release via a reference in the
[cluster-samples-operator](https://github.com/openshift/cluster-samples-operator/blob/ee4165c89d53119e541fe9b8141d01cab7207560/manifests/image-references#L17-L20).
It gets built from a [Dockerfile](https://github.com/openshift/installer/blob/master/images/baremetal/Dockerfile.ci) in the installer repo.

## Extracting the openshift-install binary

To extract the openshift-install binary that includes support for the
baremetal IPI platform, you can use the `oc adm release extract`
commands. Note that openshift-baremetal-installer is optional, and isn't
included when extracting all tools with the `--tools` option; it must be
explicitly stated.

To get just the binary:

```
oc adm release extract --registry-config <pull secret> --command=openshift-baremetal-install --to /tmp
```

To get a tarball:

```
oc adm release extract --registry-config <pull secret> --command=openshift-baremetal-install --command-os='*' --to /tmp
```

# Building a custom release

Occassionally, it may be neccessary to build a custom release payload,
that includes changes to the installer, or other images such as Ironic.
You may use the `kni` workspace in OpenShift CI to do this. Be aware,
that CI releases are garbage collected after a period of time, and in
order to avoid this happening you must ask ART to pin the CI or nightly
release you are using to base your custom payload on.

## Preparation and Configuration

Expand Down Expand Up @@ -44,7 +82,7 @@ for our installer builds and our custom release payloads:

```
$ oc --config=release-kubeconfig create imagestream release
$ oc --config=release-kubeconfig create imagestream installer
$ oc --config=release-kubeconfig create imagestream baremetal-installer
```

We need to create a ```docker-registry``` secret so the image stream
Expand All @@ -65,39 +103,37 @@ about all of the above:
$ cat > release_config_$USER.sh <<EOF
RELEASE_NAMESPACE=kni
RELEASE_STREAM=release
INSTALLER_STREAM=installer
INSTALLER_STREAM=baremetal-installer
RELEASE_KUBECONFIG=release-kubeconfig
RELEASE_PULLSECRET=release-pullsecret
INSTALLER_GIT_URI=https://github.com/openshift/installer.git
INSTALLER_GIT_REF=master
EOF
```

## Building an Installer and Payload
## Building an Installer

When we want to move to a newer OpenShift release, we pick a release
payload, and then build an installer image with the baremetal platform
enabled:
If you want to build a custom installer with your changes, update the
`INSTALLER_GIT_URI` and `INSTALLER_GIT_REF` parameters in your
`release_config_$USER.sh`, and use the build-installer script.

```
$ oc adm release info quay.io/openshift-release-dev/ocp-release:4.1.0-rc.3 -a release-pullsecret -o json | jq -r .metadata.version
4.1.0-rc.3
```

Kick off a build, with the resulting image tagged into the installer
image stream using the supplied version as the tag:
Find the most recent CI release that's green from [the release
dashboard](https://openshift-release.svc.ci.openshift.org/), then
build an installer image with the baremetal platform enabled:

```
$ ./build_installer.sh 4.1.0-rc.3-kni.0
$ ./build_installer.sh 4.2.0-0.ci-2019-08-21-085721-kni.0
```

## Building a release payload

Now, finally, we can build a new payload referencing our installer,
and tag it into the release imagestream:

```
$ ./prep_release.sh \
4.1.0-rc.3-kni.1 \
quay.io/openshift-release-dev/ocp-release:4.1.0-rc.3 \
installer=registry.svc.ci.openshift.org/kni/installer:4.1.0-rc.3-kni.0 \
4.2.0-0.ci-2019-08-21-085721-kni.0 \
registry.svc.ci.openshift.org/ocp/release:4.2.0-0.ci-2019-08-21-085721 \
baremetal-installer=registry.svc.ci.openshift.org/kni/baremetal-installer:4.2.0-0.ci-2019-08-21-085721-kni.0 \
baremetal-machine-controllers=quay.io/openshift-metal3/baremetal-machine-controllers@sha256:1faf4a863b261c948f5f38c148421603f51c74cbf44142882826ee6cb37d8bd3
```