package
0.0.0-20250403192851-34a345b3f333
Repository: https://github.com/openshift/ci-tools.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BuildGraph returns a graph or graphs that include all steps given.
BuildPartialGraph returns a graph or graphs that include only the dependencies of the named steps.
BuildsAnyOfficialImages determines if a configuration will result in official images being built.
BuildsOfficialImages determines if a configuration will result in official images being built.
No description provided by the author
ClusterProfiles are all valid cluster profiles.
No description provided by the author
DomainForService returns the DNS domain name for the service.
No description provided by the author
No description provided by the author
GetDefaultClusterProfileSecretName returns the default secret name for the profile.
GitHubUserGroup returns the group name for a GitHub user.
No description provided by the author
No description provided by the author
No description provided by the author
ImageTargets returns image targets.
No description provided by the author
No description provided by the author
No description provided by the author
InternalImageLink describes a dependency on a tag in the pipeline stream.
No description provided by the author
IsCiopConfigCM returns true if a given name is a valid ci-operator config ConfigMap.
IsCreatedForClusterBotJob returns true if the given namespace is created for a job from the cluster bot.
No description provided by the author
IsPromotionJob determines if a given ProwJob is a PromotionJob.
IsReleasePayloadStream determines if the ImageStream holds release payload images.
IsReleaseStream determines if the ImageStream was created from an import or assembly of a release.
LeasesForTest aggregates all the lease configurations in a test.
LeaseTypeFromClusterType maps cluster types to lease types.
LinkForImage determines what dependent link is required for the user's image dependency.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PromotesOfficialImage determines if a configuration will promote promotionName and if it belongs to any official stream.
PromotesOfficialImages determines if a configuration will result in official images being promoted.
PromotionTargets adapts the single-target configuration to the multi-target paradigm.
QuayImage returns the image in quay.io for an image stream tag which is used to push the image.
QuayImageReference returns the image in quay.io for an image stream tag which is used to pull the image.
RefersToOfficialImage determines if an image is official.
No description provided by the author
ReleaseImagesLink describes the content of a stable(-foo)? ImageStream in the test namespace.
ReleaseImageTagLink describes a specific tag in a stable(-foo)? ImageStream in the test namespace.
ReleaseNameFrom determines the named release that was imported or assembled into an ImageStream.
No description provided by the author
ReleaseStreamFor determines the ImageStream into which a named release will be imported or assembled.
ResolveConsoleHost resolves the console host.
ResolveImageRegistryHost resolves the image registry host.
ResolveMultiArch traverses the graph of StepNodes and updates the multiArch field of each node.
ResolveSpecFromEnv will determine the Refs being tested in by parsing Prow environment variable contents.
No description provided by the author
SaveArtifact saves the data under the path relative to the artifact directory.
StepGraphJSONURL takes a base url like https://storage.googleapis.com/test-platform-results/pr-logs/pull/openshift_ci-tools/999/pull-ci-openshift-ci-tools-master-validate-vendor/1283812971092381696 and returns the full url for the step graph json document.
No description provided by the author
URLForService returns the URL for the service including scheme.
ValidClusterName checks if a cluster name is valid.
# Constants
No description provided by the author
No description provided by the author
BundlePrefix is the prefix used by ci-operator for bundle images without an explicitly configured name.
No description provided by the author
CIOperatorInrepoConfigFileName is the name of the file that contains the build root images pullspec.
No description provided by the author
CliEnv if the env we use to expose the path to the cli.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DefaultRPMLocation is the default relative directory for Origin-based projects to put their built RPMs.
DPTPRequesterLabel is the label on a Kubernates CR whose value indicates the automated tool that requests the CR.
No description provided by the author
No description provided by the author
HiveAdminKubeconfigSecret is the name of the secret in ci-op-<hash> namespace that stores the Admin's kubeconfig for the ephemeral cluster provisioned by Hive.
HiveAdminKubeconfigSecretKey is the key to the kubeconfig in the secret HiveAdminKubeconfigSecret.
HiveAdminPasswordSecret the name of the secret in ci-op-<hash> namespace that stores the password for the user "kubeadmin" for the ephemeral cluster provisioned by Hive.
HiveAdminPasswordSecretKey is the key to the password in the secret HiveAdminKubeconfigSecret.
HiveCluster is the cluster where Hive is deployed.
HiveControlPlaneKubeconfigSecret is the name of the secret that stores kubeconfig to contact the cluster where Hive is deployed.
HiveControlPlaneKubeconfigSecretArg is the flag to ci-operator.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
InitialReleaseName is the name of the special initial stream we copy at import to keep for upgrade tests.
No description provided by the author
LatestReleaseName is the name of the special latest stable stream, images in this stream are held in the StableImageStream.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PipelineImageStream is the name of the ImageStream used to hold images built to cache build steps in the pipeline.
No description provided by the author
PipelineImageStreamTagReferenceBundleSourceName is the name of the bundle source image built by the CI.
PipelineImageStreamTagReferenceIndexImage is the name of the index image built by ci-operator.
PipelineImageStreamTagReferenceIndexImageGenerator is the name of the index image generator built by ci-operator.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The fields in ReleaseBuildConfiguration which originate each pipeline image.
The fields in ReleaseBuildConfiguration which originate each pipeline image.
The fields in ReleaseBuildConfiguration which originate each pipeline image.
The fields in ReleaseBuildConfiguration which originate each pipeline image.
PromotionJobLabelKey marks promotion jobs as such.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReasonPending is the error reason for pods not scheduled in time.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
heterogeneous payload.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReleaseConfigAnnotation is the name of annotation created by the release controller.
ReleaseImageStream is the name of the ImageStream used to hold built or imported release payload images.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RPMServeLocation is the location from which we will serve RPMs after they are built.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServiceDomain is the domain under which services are routed for the current service cluster.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SkipCensoringLabel is the label we use to mark a secret as not needing to be censored.
StableImageStream is the ImageStream used to hold build outputs from the repository under test and the associated images imported from integration streams.
No description provided by the author
No description provided by the author
# Variables
DefaultMirrorFunc is the default mirroring function.
DefaultTargetNameFunc is the default target name function.
QuayMirrorFunc is the mirroring function for quay.io.
QuayTargetNameFunc is the target name function for quay.io.
# Structs
No description provided by the author
BuildRootImageConfiguration holds the two ways of using a base image that the pipeline will caches on.
Bundle contains the data needed to build a bundle from the bundle source image and update an index to include the new bundle.
BundleSourceStepConfiguration describes a step that performs a set of substitutions on all yaml files in the `src` image so that the pullspecs in the operator manifests point to images inside the CI registry.
Candidate describes a validated candidate release payload.
No description provided by the author
+k8s:deepcopy-gen=false.
+k8s:deepcopy-gen=false.
No description provided by the author
ClusterClaim claims an OpenShift cluster for the job.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ClusterTestConfiguration describes a test that provisions a cluster and runs a command in it.
ContainerTestConfiguration describes a test that runs a command in one of the previously built images.
CredentialReference defines a secret to mount into a step and where to mount it.
+k8s:deepcopy-gen=false.
ExternalImage describes the external image that is imported into the pipeline.
GraphConfiguration contains step data used to build the execution graph.
ImageBuildInputs is a subset of the v1 OpenShift Build API object defining an input source.
ImageSourcePath maps a path in the source image into a destination path in the context.
No description provided by the author
ImageStreamTagReference identifies an ImageStreamTag.
IndexGeneratorStepConfiguration describes a step that creates an index database and Dockerfile to build an operator index that uses the generated database based on bundle names provided in OperatorIndex.
InputConfiguration contains the set of image inputs to a build and can be used as an override to the canonical inputs by a local process.
No description provided by the author
InputImageTagStepConfiguration describes a step that tags an externalImage image in to the build pipeline.
Integration is an ImageStream holding the latest images from development builds of OCP.
JobSpec is a superset of the upstream spec.
LiteralTestStep is the external representation of a test step allowing users to define new test steps.
MemoryBackedVolume describes a tmpfs (memory backed volume) that will be mounted into a test container at /tmp/volume.
Metadata describes the source repo for which a config is written.
No description provided by the author
MultiStageTestConfiguration is a flexible configuration mode that allows tighter control over the multiple stages of end to end tests.
MultiStageTestConfigurationLiteral is a form of the MultiStageTestConfiguration that does not include references.
Observer is the configuration for an observer Pod that will run in parallel with a multi-stage test job.
Observers is a configuration for which observer pods should and should not be run during a job.
OpenshiftAnsible40ClusterTestConfiguration describes a test that provisions a cluster using new installer and openshift-ansible.
OpenshiftAnsibleClusterTestConfiguration describes a test that provisions a cluster using openshift-ansible and runs conformance tests.
OpenshiftAnsibleCustomClusterTestConfiguration describes a test that provisions a cluster using openshift-ansible's custom provisioner, and runs conformance tests.
OpenshiftAnsibleSrcClusterTestConfiguration describes a test that provisions a cluster using openshift-ansible and executes a command in the `src` image.
OpenshiftInstallerClusterTestConfiguration describes a test that provisions a cluster using openshift-installer and runs conformance tests.
OpenshiftInstallerConsoleClusterTestConfiguration describes a test that provisions a cluster using openshift-installer and executes a command in the `console-test` image.
OpenshiftInstallerCustomTestImageClusterTestConfiguration describes a test that provisions a cluster using openshift-installer and executes a command in the image specified by the job configuration.
OpenshiftInstallerGCPNestedVirtCustomTestImageClusterTestConfiguration describes a test that provisions a gcp cluster using openshift-installer with nested virt enabled and executes a command in the image specified by the job configuration.
OpenshiftInstallerRandomClusterTestConfiguration describes a that provisions a cluster using openshift-installer in a provider chosen randomly and runs conformance tests.
OpenshiftInstallerSrcClusterTestConfiguration describes a test that provisions a cluster using openshift-installer and executes a command in the `src` image.
OpenshiftInstallerUPIClusterTestConfiguration describes a test that provisions machines using installer-upi image and installs the cluster using UPI flow.
OpenshiftInstallerUPISrcClusterTestConfiguration describes a test that provisions machines using installer-upi image and installs the cluster using UPI flow.
OperatorStepConfiguration describes the locations of operator bundle information, bundle build dockerfiles, and images the operator(s) depends on that must be substituted to run in a CI test cluster.
OutputImageTagStepConfiguration describes a step that tags a pipeline image out from the build pipeline.
PipelineImageCacheStepConfiguration describes a step that builds a container image to cache the output of commands.
Prerelease describes a validated release payload before it is exposed.
ProjectDirectoryImageBuildInputs holds inputs for an image build from the repo under test.
ProjectDirectoryImageBuildStepConfiguration describes an image build from a directory in a component project.
PromotionConfiguration describes where images created by this config should be published to.
No description provided by the author
PullSpecSubstitution contains a name of a pullspec that needs to be substituted with the name of a different pullspec.
RefCommands pairs a ref (in org/repo format) with commands.
RefLocation pairs a ref (in org/repo format) with a location.
RefRepository pairs a ref (in org/repo format) with a repository.
RegistryChain contains the array of steps, name, and documentation for a step chain.
RegistryChainConfig is the struct that chain references are unmarshalled into.
RegistryInfo contains metadata about a registry component that is useful for the web UI of the step registry +k8s:deepcopy-gen=false.
RegistryObserver contains the configuration and documentation for an observer.
RegistryObserverConfig is the struct that observer configs are unmarshalled into.
RegistryReference contains the LiteralTestStep of a reference as well as the documentation for the step.
RegistryReferenceConfig is the struct that step references are unmarshalled into.
RegistryWorkflow contains the MultiStageTestConfiguration, name, and documentation for a workflow.
RegistryWorkflowConfig is the struct that workflow references are unmarshalled into.
Release describes a generally available release payload.
ReleaseBuildConfiguration describes how release artifacts are built from a repository of source code.
ReleaseConfiguration records a resolved release with its name.
ReleaseDescriptor holds common data for different types of release payloads.
ReleaseTagConfiguration describes how a release is assembled from release artifacts.
ResourceRequirements are resource requests and limits applied to the individual steps in the job.
RPMImageInjectionStepConfiguration describes a step that updates injects an RPM repo into an image.
RPMServeStepConfiguration describes a step that launches a server from an image with RPMs and exposes it to the web.
Secret describes a secret to be mounted inside a test container.
SourceStepConfiguration describes a step that clones the source repositories required for jobs.
StepConfiguration holds one step configuration.
StepDependency defines a dependency on an image and the environment variable used to expose the image's pull spec to the step.
StepDNSConfig defines a resource that needs to be acquired prior to execution.
StepLease defines a resource that needs to be acquired prior to execution.
No description provided by the author
+k8s:deepcopy-gen=false.
StepParameter is a variable set by the test, with an optional default.
TestStep is the struct that a user's configuration gets unmarshalled into.
TestStepConfiguration describes a step that runs a command in one of the previously built images and then gathers artifacts from that step.
UnresolvedRelease describes a semantic release payload identifier we need to resolve to a pull spec.
VersionBounds describe the upper and lower bounds and stream on a version search.
# Interfaces
CommonStep is a self-contained bit of work that the build pipeline needs to do.
MultiArchStep is a step that can be executed for multiple architectures.
Parameters allows a step to read values set by other steps.
Step holds a common step +k8s:deepcopy-gen=false.
StepLink abstracts the types of links that steps require and create.
# Type aliases
+k8s:deepcopy-gen=false.
Cloud is the name of a cloud provider, e.g., aws cluster topology, etc.
Cluster is the name of a cluster in CI build farm.
No description provided by the author
ClusterProfile is the name of a set of input variables provided to the installer defining the target cloud, cluster topology, etc.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IndexUpdate specifies the update mode for an operator being added to an index.
No description provided by the author
NodeArchitecture describes the architecture for the node.
No description provided by the author
+k8s:deepcopy-gen=false OrderedStepList is a topologically-ordered sequence of steps Edges are determined based on the Creates/Requires methods.
+k8s:deepcopy-gen=false.
PipelineImageStreamTagReference is a tag on the ImageStream corresponding to the code under test.
RegistryMetadata maps the registry info for each step in the registry by filename +k8s:deepcopy-gen=false.
ReleaseArchitecture describes the architecture for the product.
No description provided by the author
ReleaseProduct describes the product being released.
No description provided by the author
ResourceConfiguration defines resource overrides for jobs run by the operator.
ResourceList is a map of string resource names and resource quantities, as defined on Kubernetes objects.
No description provided by the author
+k8s:deepcopy-gen=false StepGraph is a DAG of steps referenced by its roots.
+k8s:deepcopy-gen=false.
TestDependencies has the values of dependency overrides for multi-stage tests.
TestEnvironment has the values of parameters for multi-stage tests.