Documentation
¶
Index ¶
- Constants
- Variables
- func AddToScheme(scheme *runtime.Scheme)
- type DockerImageReference
- type Image
- type ImageImportSpec
- type ImageImportStatus
- type ImageLayer
- type ImageList
- type ImageStream
- type ImageStreamImage
- type ImageStreamImport
- type ImageStreamImportSpec
- type ImageStreamImportStatus
- type ImageStreamList
- type ImageStreamMapping
- type ImageStreamSpec
- type ImageStreamStatus
- type ImageStreamTag
- type ImageStreamTagList
- type NamedTagEventList
- type RepositoryImportSpec
- type RepositoryImportStatus
- type TagEvent
- type TagEventCondition
- type TagEventConditionType
- type TagImportPolicy
- type TagReference
Constants ¶
const GroupName = ""
Variables ¶
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: "v1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func AddToScheme ¶ added in v1.1.3
func AddToScheme(scheme *runtime.Scheme)
Types ¶
type DockerImageReference ¶
type DockerImageReference struct {
// Registry is the registry that contains the Docker image
Registry string
// Namespace is the namespace that contains the Docker image
Namespace string
// Name is the name of the Docker image
Name string
// Tag is which tag of the Docker image is being referenced
Tag string
// ID is the identifier for the Docker image
ID string
}
DockerImageReference points to a Docker image.
func (DockerImageReference) SwaggerDoc ¶ added in v1.1.4
func (DockerImageReference) SwaggerDoc() map[string]string
type Image ¶
type Image struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
kapi.ObjectMeta `json:"metadata,omitempty"`
// DockerImageReference is the string that can be used to pull this image.
DockerImageReference string `json:"dockerImageReference,omitempty"`
// DockerImageMetadata contains metadata about this image
DockerImageMetadata runtime.RawExtension `json:"dockerImageMetadata,omitempty"`
// DockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"
DockerImageMetadataVersion string `json:"dockerImageMetadataVersion,omitempty"`
// DockerImageManifest is the raw JSON of the manifest
DockerImageManifest string `json:"dockerImageManifest,omitempty"`
// DockerImageLayers represents the layers in the image. May not be set if the image does not define that data.
DockerImageLayers []ImageLayer `json:"dockerImageLayers"`
}
Image is an immutable representation of a Docker image and metadata at a point in time.
func (*Image) GetObjectKind ¶ added in v1.1.3
func (obj *Image) GetObjectKind() unversioned.ObjectKind
func (Image) SwaggerDoc ¶ added in v1.1.4
func (Image) SwaggerDoc() map[string]string
type ImageImportSpec ¶ added in v1.1.2
type ImageImportSpec struct {
// From is the source of an image to import; only kind DockerImage is allowed
From kapi.ObjectReference `json:"from"`
// To is a tag in the current image stream to assign the imported image to, if name is not specified the default tag from from.name will be used
To *kapi.LocalObjectReference `json:"to,omitempty"`
// ImportPolicy is the policy controlling how the image is imported
ImportPolicy TagImportPolicy `json:"importPolicy,omitempty"`
// IncludeManifest determines if the manifest for each image is returned in the response
IncludeManifest bool `json:"includeManifest,omitempty"`
}
ImageImportSpec describes a request to import a specific image.
func (ImageImportSpec) SwaggerDoc ¶ added in v1.1.4
func (ImageImportSpec) SwaggerDoc() map[string]string
type ImageImportStatus ¶ added in v1.1.2
type ImageImportStatus struct {
// Status is the status of the image import, including errors encountered while retrieving the image
Status unversioned.Status `json:"status"`
// Image is the metadata of that image, if the image was located
Image *Image `json:"image,omitempty"`
// Tag is the tag this image was located under, if any
Tag string `json:"tag,omitempty"`
}
ImageImportStatus describes the result of an image import.
func (ImageImportStatus) SwaggerDoc ¶ added in v1.1.4
func (ImageImportStatus) SwaggerDoc() map[string]string
type ImageLayer ¶ added in v1.1.2
type ImageLayer struct {
// Name of the layer as defined by the underlying store.
Name string `json:"name"`
// Size of the layer as defined by the underlying store.
Size int64 `json:"size"`
}
ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.
func (ImageLayer) SwaggerDoc ¶ added in v1.1.4
func (ImageLayer) SwaggerDoc() map[string]string
type ImageList ¶
type ImageList struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
unversioned.ListMeta `json:"metadata,omitempty"`
// Items is a list of images
Items []Image `json:"items"`
}
ImageList is a list of Image objects.
func (*ImageList) GetObjectKind ¶ added in v1.1.3
func (obj *ImageList) GetObjectKind() unversioned.ObjectKind
func (ImageList) SwaggerDoc ¶ added in v1.1.4
func (ImageList) SwaggerDoc() map[string]string
type ImageStream ¶
type ImageStream struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
kapi.ObjectMeta `json:"metadata,omitempty"`
// Spec describes the desired state of this stream
Spec ImageStreamSpec `json:"spec"`
// Status describes the current state of this stream
Status ImageStreamStatus `json:"status,omitempty"`
}
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.
func (*ImageStream) GetObjectKind ¶ added in v1.1.3
func (obj *ImageStream) GetObjectKind() unversioned.ObjectKind
func (ImageStream) SwaggerDoc ¶ added in v1.1.4
func (ImageStream) SwaggerDoc() map[string]string
type ImageStreamImage ¶
type ImageStreamImage struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
kapi.ObjectMeta `json:"metadata,omitempty"`
// Image associated with the ImageStream and image name.
Image Image `json:"image"`
}
ImageStreamImage represents an Image that is retrieved by image name from an ImageStream.
func (*ImageStreamImage) GetObjectKind ¶ added in v1.1.3
func (obj *ImageStreamImage) GetObjectKind() unversioned.ObjectKind
func (ImageStreamImage) SwaggerDoc ¶ added in v1.1.4
func (ImageStreamImage) SwaggerDoc() map[string]string
type ImageStreamImport ¶ added in v1.1.2
type ImageStreamImport struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
kapi.ObjectMeta `json:"metadata,omitempty"`
// Spec is a description of the images that the user wishes to import
Spec ImageStreamImportSpec `json:"spec"`
// Status is the the result of importing the image
Status ImageStreamImportStatus `json:"status"`
}
ImageStreamImport imports an image from remote repositories into OpenShift.
func (*ImageStreamImport) GetObjectKind ¶ added in v1.1.3
func (obj *ImageStreamImport) GetObjectKind() unversioned.ObjectKind
func (ImageStreamImport) SwaggerDoc ¶ added in v1.1.4
func (ImageStreamImport) SwaggerDoc() map[string]string
type ImageStreamImportSpec ¶ added in v1.1.2
type ImageStreamImportSpec struct {
// Import indicates whether to perform an import - if so, the specified tags are set on the spec
// and status of the image stream defined by the type meta.
Import bool `json:"import"`
// Repository is an optional import of an entire Docker image repository. A maximum limit on the
// number of tags imported this way is imposed by the server.
Repository *RepositoryImportSpec `json:"repository,omitempty"`
// Images are a list of individual images to import.
Images []ImageImportSpec `json:"images,omitempty"`
}
ImageStreamImportSpec defines what images should be imported.
func (ImageStreamImportSpec) SwaggerDoc ¶ added in v1.1.4
func (ImageStreamImportSpec) SwaggerDoc() map[string]string
type ImageStreamImportStatus ¶ added in v1.1.2
type ImageStreamImportStatus struct {
// Import is the image stream that was successfully updated or created when 'to' was set.
Import *ImageStream `json:"import,omitempty"`
// Repository is set if spec.repository was set to the outcome of the import
Repository *RepositoryImportStatus `json:"repository,omitempty"`
// Images is set with the result of importing spec.images
Images []ImageImportStatus `json:"images,omitempty"`
}
ImageStreamImportStatus contains information about the status of an image stream import.
func (ImageStreamImportStatus) SwaggerDoc ¶ added in v1.1.4
func (ImageStreamImportStatus) SwaggerDoc() map[string]string
type ImageStreamList ¶
type ImageStreamList struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
unversioned.ListMeta `json:"metadata,omitempty"`
// Items is a list of imageStreams
Items []ImageStream `json:"items"`
}
ImageStreamList is a list of ImageStream objects.
func (*ImageStreamList) GetObjectKind ¶ added in v1.1.3
func (obj *ImageStreamList) GetObjectKind() unversioned.ObjectKind
func (ImageStreamList) SwaggerDoc ¶ added in v1.1.4
func (ImageStreamList) SwaggerDoc() map[string]string
type ImageStreamMapping ¶
type ImageStreamMapping struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
kapi.ObjectMeta `json:"metadata,omitempty"`
// Image is a Docker image.
Image Image `json:"image"`
// Tag is a string value this image can be located with inside the stream.
Tag string `json:"tag"`
}
ImageStreamMapping represents a mapping from a single tag to a Docker image as well as the reference to the Docker image stream the image came from.
func (*ImageStreamMapping) GetObjectKind ¶ added in v1.1.3
func (obj *ImageStreamMapping) GetObjectKind() unversioned.ObjectKind
func (ImageStreamMapping) SwaggerDoc ¶ added in v1.1.4
func (ImageStreamMapping) SwaggerDoc() map[string]string
type ImageStreamSpec ¶
type ImageStreamSpec struct {
// DockerImageRepository is optional, if specified this stream is backed by a Docker repository on this server
DockerImageRepository string `json:"dockerImageRepository,omitempty"`
// Tags map arbitrary string values to specific image locators
Tags []TagReference `json:"tags,omitempty"`
}
ImageStreamSpec represents options for ImageStreams.
func (ImageStreamSpec) SwaggerDoc ¶ added in v1.1.4
func (ImageStreamSpec) SwaggerDoc() map[string]string
type ImageStreamStatus ¶
type ImageStreamStatus struct {
// DockerImageRepository represents the effective location this stream may be accessed at.
// May be empty until the server determines where the repository is located
DockerImageRepository string `json:"dockerImageRepository"`
// Tags are a historical record of images associated with each tag. The first entry in the
// TagEvent array is the currently tagged image.
Tags []NamedTagEventList `json:"tags,omitempty"`
}
ImageStreamStatus contains information about the state of this image stream.
func (ImageStreamStatus) SwaggerDoc ¶ added in v1.1.4
func (ImageStreamStatus) SwaggerDoc() map[string]string
type ImageStreamTag ¶
type ImageStreamTag struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
kapi.ObjectMeta `json:"metadata,omitempty"`
// Tag is the spec tag associated with this image stream tag, and it may be null
// if only pushes have occured to this image stream.
Tag *TagReference `json:"tag"`
// Generation is the current generation of the tagged image - if tag is provided
// and this value is not equal to the tag generation, a user has requested an
// import that has not completed, or Conditions will be filled out indicating any
// error.
Generation int64 `json:"generation"`
// Conditions is an array of conditions that apply to the image stream tag.
Conditions []TagEventCondition `json:"conditions,omitempty"`
// Image associated with the ImageStream and tag.
Image Image `json:"image"`
}
ImageStreamTag represents an Image that is retrieved by tag name from an ImageStream.
func (*ImageStreamTag) GetObjectKind ¶ added in v1.1.3
func (obj *ImageStreamTag) GetObjectKind() unversioned.ObjectKind
func (ImageStreamTag) SwaggerDoc ¶ added in v1.1.4
func (ImageStreamTag) SwaggerDoc() map[string]string
type ImageStreamTagList ¶ added in v1.0.8
type ImageStreamTagList struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
unversioned.ListMeta `json:"metadata,omitempty"`
// Items is the list of image stream tags
Items []ImageStreamTag `json:"items"`
}
ImageStreamTagList is a list of ImageStreamTag objects.
func (*ImageStreamTagList) GetObjectKind ¶ added in v1.1.3
func (obj *ImageStreamTagList) GetObjectKind() unversioned.ObjectKind
func (ImageStreamTagList) SwaggerDoc ¶ added in v1.1.4
func (ImageStreamTagList) SwaggerDoc() map[string]string
type NamedTagEventList ¶
type NamedTagEventList struct {
// Tag is the tag for which the history is recorded
Tag string `json:"tag"`
// Standard object's metadata.
Items []TagEvent `json:"items"`
// Conditions is an array of conditions that apply to the tag event list.
Conditions []TagEventCondition `json:"conditions,omitempty"`
}
NamedTagEventList relates a tag to its image history.
func (NamedTagEventList) SwaggerDoc ¶ added in v1.1.4
func (NamedTagEventList) SwaggerDoc() map[string]string
type RepositoryImportSpec ¶ added in v1.1.2
type RepositoryImportSpec struct {
// From is the source for the image repository to import; only kind DockerImage and a name of a Docker image repository is allowed
From kapi.ObjectReference `json:"from"`
// ImportPolicy is the policy controlling how the image is imported
ImportPolicy TagImportPolicy `json:"importPolicy,omitempty"`
// IncludeManifest determines if the manifest for each image is returned in the response
IncludeManifest bool `json:"includeManifest,omitempty"`
}
RepositoryImportSpec describes a request to import images from a Docker image repository.
func (RepositoryImportSpec) SwaggerDoc ¶ added in v1.1.4
func (RepositoryImportSpec) SwaggerDoc() map[string]string
type RepositoryImportStatus ¶ added in v1.1.2
type RepositoryImportStatus struct {
// Status reflects whether any failure occurred during import
Status unversioned.Status `json:"status,omitempty"`
// Images is a list of images successfully retrieved by the import of the repository.
Images []ImageImportStatus `json:"images,omitempty"`
// AdditionalTags are tags that exist in the repository but were not imported because
// a maximum limit of automatic imports was applied.
AdditionalTags []string `json:"additionalTags,omitempty"`
}
RepositoryImportStatus describes the result of an image repository import
func (RepositoryImportStatus) SwaggerDoc ¶ added in v1.1.4
func (RepositoryImportStatus) SwaggerDoc() map[string]string
type TagEvent ¶
type TagEvent struct {
// Created holds the time the TagEvent was created
Created unversioned.Time `json:"created"`
// DockerImageReference is the string that can be used to pull this image
DockerImageReference string `json:"dockerImageReference"`
// Image is the image
Image string `json:"image"`
// Generation is the spec tag generation that resulted in this tag being updated
Generation int64 `json:"generation"`
}
TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag.
func (TagEvent) SwaggerDoc ¶ added in v1.1.4
func (TagEvent) SwaggerDoc() map[string]string
type TagEventCondition ¶ added in v1.1.2
type TagEventCondition struct {
// Type of tag event condition, currently only ImportSuccess
Type TagEventConditionType `json:"type"`
// Status of the condition, one of True, False, Unknown.
Status kapi.ConditionStatus `json:"status"`
// LastTransitionTIme is the time the condition transitioned from one status to another.
LastTransitionTime unversioned.Time `json:"lastTransitionTime,omitempty"`
// Reason is a brief machine readable explanation for the condition's last transition.
Reason string `json:"reason,omitempty"`
// Message is a human readable description of the details about last transition, complementing reason.
Message string `json:"message,omitempty"`
// Generation is the spec tag generation that this status corresponds to
Generation int64 `json:"generation"`
}
TagEventCondition contains condition information for a tag event.
func (TagEventCondition) SwaggerDoc ¶ added in v1.1.4
func (TagEventCondition) SwaggerDoc() map[string]string
type TagEventConditionType ¶ added in v1.1.2
type TagEventConditionType string
const (
// ImportSuccess with status False means the import of the specific tag failed
ImportSuccess TagEventConditionType = "ImportSuccess"
)
These are valid conditions of TagEvents.
type TagImportPolicy ¶ added in v1.1.2
type TagImportPolicy struct {
// Insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.
Insecure bool `json:"insecure,omitempty"`
// Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported
Scheduled bool `json:"scheduled,omitempty"`
}
TagImportPolicy describes the tag import policy
func (TagImportPolicy) SwaggerDoc ¶ added in v1.1.4
func (TagImportPolicy) SwaggerDoc() map[string]string
type TagReference ¶ added in v1.1.2
type TagReference struct {
// Name of the tag
Name string `json:"name"`
// Annotations associated with images using this tag
Annotations map[string]string `json:"annotations"`
// From is a reference to an image stream tag or image stream this tag should track
From *kapi.ObjectReference `json:"from,omitempty"`
// Reference states if the tag will be imported. Default value is false, which means the tag will be imported.
Reference bool `json:"reference,omitempty"`
// Generation is the image stream generation that updated this tag - setting it to 0 is an indication that the generation must be updated.
// Legacy clients will send this as nil, which means the client doesn't know or care.
Generation *int64 `json:"generation"`
// Import is information that controls how images may be imported by the server.
ImportPolicy TagImportPolicy `json:"importPolicy,omitempty"`
}
TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.
func (TagReference) SwaggerDoc ¶ added in v1.1.4
func (TagReference) SwaggerDoc() map[string]string