rhcos

Documentation

Overview

Package rhcos contains helpers for RHCOS related operations.

Index

• func AMIRegions(architecture types.Architecture) sets.String
• func FetchCoreOSBuild(ctx context.Context) (*stream.Stream, error)
• func FetchRawCoreOSStream(ctx context.Context) ([]byte, error)
• func FindArtifactURL(artifacts stream.PlatformArtifacts) (string, error)
• func FormatURLWithIntegrity(artifact *stream.Artifact) (string, error)
• func GenerateOpenStackImageName(rhcosImage, infraID string) (imageName string, isURL bool)

Functions

func AMIRegions

func AMIRegions(architecture types.Architecture) sets.String

AMIRegions returns the AWS regions in which an RHCOS AMI for the specified architecture is published.

func FetchCoreOSBuild

func FetchCoreOSBuild(ctx context.Context) (*stream.Stream, error)

FetchCoreOSBuild returns the pinned version of RHEL/Fedora CoreOS used by the installer to provision the bootstrap node and control plane currently. For more information, see e.g. https://github.com/openshift/enhancements/pull/201

func FetchRawCoreOSStream

func FetchRawCoreOSStream(ctx context.Context) ([]byte, error)

FetchRawCoreOSStream returns the raw stream metadata for the bootimages embedded in the installer.

func FindArtifactURL

func FindArtifactURL(artifacts stream.PlatformArtifacts) (string, error)

FindArtifactURL returns a single "disk" artifact type; this mainly abstracts over e.g. `qcow2.xz` and `qcow2.gz`. (FCOS uses xz, RHCOS uses gzip right now)

Use this function only for cases where there's a single artifact type, such as `qemu` and `openstack`.

Some platforms have multiple artifact types; for example, `metal` has an ISO as well as PXE files. This function will error in such a case.

func FormatURLWithIntegrity

func FormatURLWithIntegrity(artifact *stream.Artifact) (string, error)

FormatURLWithIntegrity squashes an artifact into a URL string with the uncompressed sha256 as a query parameter. This is necessary currently because various parts of the installer pass around this reference as a string, and it's also exposed to users via install-config overrides.

func GenerateOpenStackImageName

func GenerateOpenStackImageName(rhcosImage, infraID string) (imageName string, isURL bool)

GenerateOpenStackImageName returns Glance image name for instances.