1
0
mirror of https://github.com/openshift/installer.git synced 2026-02-05 06:46:36 +01:00

Add docs/dev/pinned-coreos.md

Briefly describe the history and future of the pinned {RHEL, Fedora} CoreOS
metadata in the installer.

Co-authored-by: Matthew Staebler <staebler@redhat.com>
This commit is contained in:
Colin Walters
2021-03-23 14:10:12 +00:00
parent 3ba64bc352
commit 7a7b055d32
3 changed files with 55 additions and 22 deletions

52
docs/dev/pinned-coreos.md Normal file
View File

@@ -0,0 +1,52 @@
# CoreOS and the installer
A key decision made before the release of OpenShift 4 is to pin the CoreOS bootimage in
the installer: https://github.com/openshift/installer/commit/e080f0494708b2674fe37af02f670c8030c32bf6
That is still the case today; when one gets an `openshift-install` binary, that
binary contains the 2-tuple `(CoreOS, release image)`, meaning the result of an
install will be the same thing each time.
More background:
- https://github.com/openshift/enhancements/pull/201
- https://github.com/openshift/machine-config-operator/blob/master/docs/OSUpgrades.md
## Stream metadata
As of 4.8 the [stream metadata enhancement](https://github.com/openshift/enhancements/blobmaster/enhancements/coreos-bootimages.md)
is in progress which provides a standardized JSON format and injects
that data into the cluster as well.
### Updating pinned stream metadata
To update the bootimage for one or more architectures, use e.g.
```
$ plume cosa2stream --target data/data/rhcos-stream.json --distro rhcos x86_64=48.83.202102230316-0 s390x=47.83.202102090311-0 ppc64le=47.83.202102091015-0
```
For more information on this command, see:
- https://github.com/coreos/coreos-assembler/pull/2000
- https://github.com/coreos/coreos-assembler/pull/2052
### Updating pinned legacy metadata
To update the legacy metadata, use:
```
./hack/update-rhcos-bootimage.py https://releases-art-rhcos.svc.ci.openshift.org/art/storage/releases/rhcos-4.6/46.82.202008260918-0/x86_64/meta.json amd64
```
This will hopefully be removed soon.
### Origin of stream metadata
For historical reference, the initial file `data/data/rhcos-stream.json` was generated this way:
```
$ plume cosa2stream --name rhcos-4.8 --distro rhcos x86_64=48.83.202102230316-0 s390x=47.83.202102090311-0 ppc64le=47.83.202102091015-0 > data/data/rhcos-stream.json
```