package
4.1.0+incompatible
Repository: https://github.com/openshift/origin.git
Documentation: pkg.go.dev

# Packages

Package docker10 provides types used by docker/distribution and moby/moby.
Package dockerpre012 is the dockerpre012 version of the API.
+groupName=image.openshift.io Package v1 is the v1 version of the API.

# Functions

AddTagEventToImageStream attempts to update the given image stream with a tag event.
Convert_api_to_public_DockerConfig ensures that out has all of the fields set from in or returns an error.
Convert_api_to_public_DockerImage ensures that out has all of the fields set from in or returns an error.
Convert_imageconfig_to_api_DockerImage takes a Docker registry digest (schema 2.1) and converts it to the external API version of Image.
Convert_imageconfig_to_api_DockerImage takes a Docker registry digest (schema 2.2) and converts it to the external API version of Image.
Convert_public_to_api_DockerConfig ensures that out has all of the fields set from in or returns an error.
Convert_public_to_api_DockerImage ensures that out has all of the fields set from in or returns an error.
DifferentTagEvent returns true if the supplied tag event matches the current stream tag event.
DifferentTagEvent compares the generation on tag's spec vs its status.
DigestOrImageMatch matches the digest in the image name.
DockerImageReferenceForImage returns the docker reference for specified image.
DockerImageReferenceForStream returns a DockerImageReference that represents the ImageStream or false, if no valid reference exists.
FollowTagReference walks through the defined tags on a stream, following any referential tags in the stream.
HasTagCondition returns true if the specified image stream tag has a condition with the same type, status, and reason (does not check generation, date, or message).
IndexOfImageSignature returns index of signature identified by type and blob in the image if present.
IndexOfImageSignatureByName returns an index of signature identified by name in the image if present.
JoinImageSignatureName joins image name and custom signature name into one string with @ separator.
JoinImageStreamImage creates a name for image stream image object from an image stream name and an id.
JoinImageStreamTag turns a name and tag into the name of an ImageStreamTag.
LatestImageTagEvent returns the most recent TagEvent and the tag for the specified image.
LatestObservedTagGeneration returns the generation value for the given tag that has been observed by the controller monitoring the image stream.
LatestTaggedImage returns the most recent TagEvent for the specified image repository and tag.
MostAccuratePullSpec returns a docker image reference that uses the current ID if possible, the current tag otherwise, and returns false if the reference if the spec could not be parsed.
NormalizeImageStreamTag normalizes an image stream tag by defaulting to 'latest' if no tag has been specified.
ParseDockerImageReference parses a Docker pull spec string into a DockerImageReference.
ParseImageStreamImageName splits a string into its name component and ID component, and returns an error if the string is not in the right form.
ParseImageStreamTagName splits a string into its name component and tag component, and returns an error if the string is not in the right form.
PrioritizeTags orders a set of image tags with a few conventions: 1.
ResolveImageID returns latest TagEvent for specified imageID and an error if there's more than one image matching the ID or when one does not exist.
ResolveLatestTaggedImage returns the appropriate pull spec for a given tag in the image stream, handling the tag's reference policy if necessary to return a resolved image.
ResolveReferenceForTagEvent applies the tag reference rules for a stream, tag, and tag event for that tag.
ResolveTagReference applies the tag reference rules for a stream, tag, and tag event for that tag.
Resource kept for generated code DEPRECATED.
SetTagConditions applies the specified conditions to the status of the given tag.
ShortDockerImageID returns a short form of the provided DockerImage ID for display.
SortStatusTags sorts the status tags of an image stream based on the latest created.
SplitImageSignatureName splits given signature name into image name and signature name.
SplitImageStreamImage turns the name of an ImageStreamImage into Name and ID.
SplitImageStreamTag turns the name of an ImageStreamTag into Name and Tag.
UpdateChangedTrackingTags identifies any tags in the status that have changed and ensures any referenced tracking tags are also updated.
UpdateTrackingTags sets updatedImage as the most recent TagEvent for all tags in stream.spec.tags that have from.kind = "ImageStreamTag" and the tag in from.name = updatedTag.
ValidateRegistryURL returns error if the given input is not a valid registry URL.

# Constants

DefaultImageTag is used when an image tag is needed and the configuration does not specify a tag to use.
DockerDefaultNamespace is the value for namespace when a single segment name is provided.
DockerDefaultRegistry is the value for the registry when none was provided.
DockerDefaultV1Registry is the host name of the default v1 registry.
DockerDefaultV2Registry is the host name of the default v2 registry.
DockerImageLayersOrderAnnotation describes layers order in the docker image.
DockerImageLayersOrderAscending indicates that image layers are sorted in the order of their addition (from oldest to latest).
DockerImageLayersOrderDescending indicates that layers are sorted in reversed order of their addition (from newest to oldest).
DockerImageRepositoryCheckAnnotation indicates that OpenShift has attempted to import tag and image information from an external Docker image repository.
ExcludeImageSecretAnnotation indicates that a secret should not be returned by imagestream/secrets.
ImageManifestBlobStoredAnnotation indicates that manifest and config blobs of image are stored in on storage of integrated Docker registry.
The supported type of image signature.
ImporterPreferArchAnnotation represents an architecture that should be selected if an image uses a manifest list and it should be downconverted.
ImporterPreferOSAnnotation represents an operation system that should be selected if an image uses a manifest list and it should be downconverted.
ImportSuccess with status False means the import of the specific tag failed.
InsecureRepositoryAnnotation may be set true on an image stream to allow insecure access to pull content.
Limit that applies to images.
Limit that applies to image streams.
LocalTagReferencePolicy indicates the image should prefer to pull via the local integrated registry, falling back to the remote location if the integrated registry has not been configured.
ManagedByOpenShiftAnnotation indicates that an image is managed by OpenShift's registry.
ResourceImageStreamImages represents a number of unique references to images in all image stream statuses of a project.
ResourceImageStreams represents a number of image streams in a project.
ResourceImageStreamTags represents a number of unique references to images in all image stream specs of a project.
SignatureExpired means the signature or its signing key or certificate had been expired at the probe time.
SignatureForImage means the signature matches image object containing it.
SignatureRevoked means the signature or its signing key or certificate has been revoked.
SignatureTrusted means the signing key or certificate was valid and the signature matched the image at the probe time.
SourceTagReferencePolicy indicates the image's original location should be used when the image stream tag is resolved into other resources (builds and deployment configurations).
TagReferenceAnnotationTagHidden indicates that a given TagReference is hidden from search results.

# Variables

DEPRECATED kept for generated code.
ErrCircularReference is an error when reference tag is circular.
ErrCrossImageStreamReference is an error when reference tag points to another imagestream.
ErrImageStreamImportUnsupported is an error client receive when the import failed.
ErrInvalidReference is an error when reference tag is invalid.
ErrNotFoundReference is an error when reference tag is not found.
DEPRECATED kept for generated code.

# Structs

Image is an immutable representation of a Docker image and metadata at a point in time.
ImageBlobReferences describes the blob references within an image.
ImageImportSpec defines how an image is imported.
ImageImportStatus describes the result of an image import.
ImageLayer represents a single layer of the image.
ImageLayerData contains metadata about an image layer.
ImageList is a list of Image objects.
ImageLookupPolicy describes how an image stream can be used to override the image references used by pods, builds, and other resources in a namespace.
ImageSignature holds a signature of an image.
ImageStream stores a mapping of tags to images, metadata overrides that are applied when images are tagged in a stream, and an optional reference to a Docker image repository on a registry.
ImageStreamImage represents an Image that is retrieved by image name from an ImageStream.
ImageStreamImport allows a caller to request information about a set of images for possible import into an image stream, or actually tag the images into the image stream.
ImageStreamImportSpec defines what images should be imported.
ImageStreamImportStatus contains information about the status of an image stream import.
ImageStreamLayers describes information about the layers referenced by images in this image stream.
ImageStreamList is a list of ImageStream objects.
ImageStreamMapping represents a mapping from a single tag to a Docker image as well as the reference to the Docker image repository the image came from.
ImageStreamSpec represents options for ImageStreams.
ImageStreamStatus contains information about the state of this image stream.
ImageStreamTag has a .Name in the format <stream name>:<tag>.
ImageStreamTagList is a list of ImageStreamTag objects.
RepositoryImportSpec indicates to load a set of tags from a given Docker image repository.
RepositoryImportStatus describes the outcome of the repository import.
SignatureCondition describes an image signature condition of particular kind at particular probe time.
SignatureGenericEntity holds a generic information about a person or entity who is an issuer or a subject of signing certificate or key.
SignatureIssuer holds information about an issuer of signing certificate or key.
SignatureSubject holds information about a person or entity who created the signature.
TagEvent is used by ImageRepositoryStatus to keep a historical record of images associated with a tag.
TagEventCondition contains condition information for a tag event.
TagEventList contains a historical record of images associated with a tag.
TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.
TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved.

# Type aliases

DockerConfig is the list of configuration options used when creating a container.
DockerImage is the type representing a docker image and its various properties when retrieved from the Docker client API.
DockerImageReference points to a Docker image.
SignatureConditionType is a type of image signature condition.
TagReferencePolicyType describes how pull-specs for images in an image stream tag are generated when image change triggers are fired.