Documentation
¶
Overview ¶
Package rhcos contains helpers for RHCOS related operations.
Index ¶
- Constants
- func AMIRegions(architecture types.Architecture, osImageStream types.OSImageStream) sets.Set[string]
- func FetchCoreOSBuild(ctx context.Context, osImageStream types.OSImageStream) (*stream.Stream, error)
- func FetchRawCoreOSStream(ctx context.Context, osImageStream types.OSImageStream) ([]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)
- func GetPayloadImageStreamTag(stream types.OSImageStream) string
Constants ¶
const ( // DefaultOSImageStream is the OS image stream used when the install-config // does not specify one. DefaultOSImageStream = types.OSImageStreamRHCOS9 )
Variables ¶
This section is empty.
Functions ¶
func AMIRegions ¶ added in v0.4.15
func AMIRegions(architecture types.Architecture, osImageStream types.OSImageStream) sets.Set[string]
AMIRegions returns the AWS regions in which an RHCOS AMI for the specified architecture is published.
func FetchCoreOSBuild ¶ added in v0.4.15
func FetchCoreOSBuild(ctx context.Context, osImageStream types.OSImageStream) (*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 ¶ added in v0.4.15
FetchRawCoreOSStream returns the raw stream metadata for the bootimages embedded in the installer.
func FindArtifactURL ¶ added in v0.4.15
func FindArtifactURL(artifacts stream.PlatformArtifacts) (string, error)
FindArtifactURL returns a single "disk" artifact type; this mainly abstracts over different compression formats like `qcow2.xz` and `qcow2.gz`.
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 ¶ added in v0.4.15
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 ¶ added in v0.4.15
GenerateOpenStackImageName returns Glance image name for instances.
func GetPayloadImageStreamTag ¶
func GetPayloadImageStreamTag(stream types.OSImageStream) string
GetPayloadImageStreamTag returns the payload image stream tag corresponding to the given OS image stream.
Types ¶
This section is empty.