Documentation
      ¶
    
    
  
    
  
    Index ¶
- Variables
 - type DockerImageReference
 - type Image
 - type ImageLayer
 - type ImageList
 - type ImageStream
 - type ImageStreamImage
 - type ImageStreamList
 - type ImageStreamMapping
 - type ImageStreamSpec
 - type ImageStreamStatus
 - type ImageStreamTag
 - type ImageStreamTagList
 - type NamedTagEventList
 - type TagEvent
 - type TagEventCondition
 - type TagEventConditionType
 - type TagImportPolicy
 - type TagReference
 
Constants ¶
This section is empty.
Variables ¶
var Codec = runtime.CodecFor(api.Scheme, SchemeGroupVersion.String())
    Codec encodes internal objects to the v1beta3 scheme
var SchemeGroupVersion = unversioned.GroupVersion{Group: "", Version: "v1beta3"}
    SchemeGroupVersion is group version used to register these objects
Functions ¶
This section is empty.
Types ¶
type DockerImageReference ¶
type DockerImageReference struct {
	Registry  string
	Namespace string
	Name      string
	Tag       string
	ID        string
}
    DockerImageReference points to a Docker image.
type Image ¶
type Image struct {
	unversioned.TypeMeta `json:",inline"`
	kapi.ObjectMeta      `json:"metadata,omitempty"`
	// The string that can be used to pull this image.
	DockerImageReference string `json:"dockerImageReference,omitempty"`
	// Metadata about this image
	DockerImageMetadata runtime.RawExtension `json:"dockerImageMetadata,omitempty"`
	// This attribute conveys the version of the object, which if empty defaults to "1.0"
	DockerImageMetadataVersion string `json:"dockerImageMetadataVersion,omitempty"`
	// 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" description:"a list of the image layers from lowest to highest"`
}
    Image is an immutable representation of a Docker image and metadata at a point in time.
func (*Image) IsAnAPIObject ¶
func (*Image) IsAnAPIObject()
type ImageLayer ¶ added in v1.1.2
type ImageLayer struct {
	// Name of the layer as defined by the underlying store.
	Name string `json:"name" description:"the name of the layer (blob, in Docker parlance)"`
	// Size of the layer as defined by the underlying store.
	Size int64 `json:"size" description:"size of the layer in bytes"`
}
    ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.
type ImageList ¶
type ImageList struct {
	unversioned.TypeMeta `json:",inline"`
	unversioned.ListMeta `json:"metadata,omitempty"`
	Items []Image `json:"items"`
}
    ImageList is a list of Image objects.
func (*ImageList) IsAnAPIObject ¶
func (*ImageList) IsAnAPIObject()
type ImageStream ¶
type ImageStream struct {
	unversioned.TypeMeta `json:",inline"`
	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) IsAnAPIObject ¶
func (*ImageStream) IsAnAPIObject()
type ImageStreamImage ¶
ImageStreamImage represents an Image that is retrieved by image name from an ImageStream.
func (*ImageStreamImage) IsAnAPIObject ¶ added in v1.1.2
func (*ImageStreamImage) IsAnAPIObject()
type ImageStreamList ¶
type ImageStreamList struct {
	unversioned.TypeMeta `json:",inline"`
	unversioned.ListMeta `json:"metadata,omitempty"`
	Items []ImageStream `json:"items"`
}
    ImageStreamList is a list of ImageStream objects.
func (*ImageStreamList) IsAnAPIObject ¶
func (*ImageStreamList) IsAnAPIObject()
type ImageStreamMapping ¶
type ImageStreamMapping struct {
	unversioned.TypeMeta `json:",inline"`
	kapi.ObjectMeta      `json:"metadata,omitempty"`
	// A Docker image.
	Image Image `json:"image"`
	// A string value this image can be located with inside the repository.
	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 repository the image came from.
func (*ImageStreamMapping) IsAnAPIObject ¶
func (*ImageStreamMapping) IsAnAPIObject()
type ImageStreamSpec ¶
type ImageStreamSpec struct {
	// 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.
type ImageStreamStatus ¶
type ImageStreamStatus struct {
	// 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"`
	// 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.
type ImageStreamTag ¶
ImageStreamTag represents an Image that is retrieved by tag name from an ImageStream.
func (*ImageStreamTag) IsAnAPIObject ¶
func (*ImageStreamTag) IsAnAPIObject()
type ImageStreamTagList ¶ added in v1.0.8
type ImageStreamTagList struct {
	unversioned.TypeMeta `json:",inline"`
	unversioned.ListMeta `json:"metadata,omitempty"`
	Items []ImageStreamTag `json:"items"`
}
    ImageStreamTagList is a list of ImageStreamTag objects.
func (*ImageStreamTagList) IsAnAPIObject ¶ added in v1.0.8
func (*ImageStreamTagList) IsAnAPIObject()
type NamedTagEventList ¶
type NamedTagEventList struct {
	Tag   string     `json:"tag"`
	Items []TagEvent `json:"items"`
	// Conditions is an array of conditions that apply to the tag event list.
	Conditions []TagEventCondition `json:"conditions" description:"the set of conditions that apply to this tag"`
}
    NamedTagEventList relates a tag to its image history.
type TagEvent ¶
type TagEvent struct {
	// Created holds the time the TagEvent was created
	Created unversioned.Time `json:"created" description:"when the event was created"`
	// DockerImageReference is the string that can be used to pull this image
	DockerImageReference string `json:"dockerImageReference" description:"the string that can be used to pull this image"`
	// Image is the image
	Image string `json:"image" description:"the image"`
	// Generation is the spec tag generation that resulted in this tag being updated
	Generation int64 `json:"generation" description:"the generation of the image stream spec tag this tag event represents"`
}
    TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag.
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"`
	// Last time the condition transit from one status to another.
	LastTransitionTime unversioned.Time `json:"lastTransitionTime,omitempty"`
	// (brief) reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`
	// Human readable message indicating details about last transition.
	Message string `json:"message,omitempty"`
	// Generation is the spec tag generation that this status corresponds to
	Generation int64 `json:"generation" description:"the generation of the image stream spec tag this tag event represents"`
}
    TagEventCondition contains condition information for a tag event.
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 `` /* 145-byte string literal not displayed */
	// 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" description:"if true, the server will periodically check to ensure this tag is up to date"`
}
    type TagReference ¶ added in v1.1.2
type TagReference struct {
	Name        string                `json:"name"`
	Annotations map[string]string     `json:"annotations,omitempty"`
	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 `` /* 137-byte string literal not displayed */
	// 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" description:"the generation of the image stream this was updated to"`
	// Import is information that controls how images may be imported by the server.
	ImportPolicy TagImportPolicy `json:"importPolicy,omitempty" description:"attributes controlling how this reference is imported"`
}
    TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.