Documentation
¶
Index ¶
- type DockerImageReference
- type Image
- type ImageList
- type ImageRepository
- type ImageRepositoryList
- type ImageRepositoryMapping
- type ImageRepositoryStatus
- type ImageRepositoryTag
- type ImageStream
- type ImageStreamImage
- type ImageStreamList
- type ImageStreamMapping
- type ImageStreamSpec
- type ImageStreamStatus
- type ImageStreamTag
- type NamedTagEventList
- type NamedTagReference
- type TagEvent
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DockerImageReference ¶ added in v0.4.3
type DockerImageReference struct {
Registry string
Namespace string
Name string
Tag string
ID string
}
DockerImageReference points to a Docker image.
type Image ¶
type Image struct {
kapi.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"`
}
Image is an immutable representation of a Docker image and metadata at a point in time.
func (*Image) IsAnAPIObject ¶
func (*Image) IsAnAPIObject()
type ImageList ¶
type ImageList struct {
kapi.TypeMeta `json:",inline"`
kapi.ListMeta `json:"metadata,omitempty"`
Items []Image `json:"items"`
}
ImageList is a list of Image objects.
func (*ImageList) IsAnAPIObject ¶
func (*ImageList) IsAnAPIObject()
type ImageRepository ¶
type ImageRepository struct {
kapi.TypeMeta `json:",inline"`
kapi.ObjectMeta `json:"metadata,omitempty"`
// Optional, if specified this repository is backed by a Docker repository on this server
DockerImageRepository string `json:"dockerImageRepository,omitempty"`
// Tags map arbitrary string values to specific image locators
Tags map[string]string `json:"tags,omitempty"`
// Status describes the current state of this repository
Status ImageRepositoryStatus `json:"status,omitempty"`
}
ImageRepository stores a mapping of tags to images, metadata overrides that are applied when images are tagged in a repository, and an optional reference to a Docker image repository on a registry.
ImageRepository is DEPRECATED; use ImageStream instead.
func (*ImageRepository) IsAnAPIObject ¶
func (*ImageRepository) IsAnAPIObject()
type ImageRepositoryList ¶
type ImageRepositoryList struct {
kapi.TypeMeta `json:",inline"`
kapi.ListMeta `json:"metadata,omitempty"`
Items []ImageRepository `json:"items"`
}
ImageRepositoryList is a list of ImageRepository objects.
ImageRepositoryList is DEPRECATED; use ImageStreamList instead.
func (*ImageRepositoryList) IsAnAPIObject ¶
func (*ImageRepositoryList) IsAnAPIObject()
type ImageRepositoryMapping ¶
type ImageRepositoryMapping struct {
kapi.TypeMeta `json:",inline"`
kapi.ObjectMeta `json:"metadata,omitempty"`
// The Docker image repository the specified image is located in
DockerImageRepository string `json:"dockerImageRepository"`
// A Docker image.
Image Image `json:"image"`
// A string value this image can be located with inside the repository.
Tag string `json:"tag"`
}
ImageRepositoryMapping 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.
ImageRepositoryMapping is DEPRECATED; use ImageStreamMapping instead.
func (*ImageRepositoryMapping) IsAnAPIObject ¶
func (*ImageRepositoryMapping) IsAnAPIObject()
type ImageRepositoryStatus ¶ added in v0.2.1
type ImageRepositoryStatus struct {
// Represents the effective location this repository 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"`
}
ImageRepositoryStatus contains information about the state of this image repository.
ImageRepositoryStatus is DEPRECATED; use ImageStreamStatus instead.
type ImageRepositoryTag ¶ added in v0.4.2
type ImageRepositoryTag struct {
Image `json:",inline"`
}
ImageRepositoryTag exists to allow calls to `osc get imageRepositoryTag ...` to function.
ImageRepositoryTag is DEPRECATED; use ImageStreamTag instead.
type ImageStream ¶ added in v0.4.3
type ImageStream struct {
kapi.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 ¶ added in v0.4.3
func (*ImageStream) IsAnAPIObject()
type ImageStreamImage ¶ added in v0.4.2
type ImageStreamImage struct {
Image `json:",inline"`
}
ImageStreamImage exists to allow calls to `osc get imageStreamImage ...` to function.
type ImageStreamList ¶ added in v0.4.3
type ImageStreamList struct {
kapi.TypeMeta `json:",inline"`
kapi.ListMeta `json:"metadata,omitempty"`
Items []ImageStream `json:"items"`
}
ImageStreamList is a list of ImageStream objects.
func (*ImageStreamList) IsAnAPIObject ¶ added in v0.4.3
func (*ImageStreamList) IsAnAPIObject()
type ImageStreamMapping ¶ added in v0.4.3
type ImageStreamMapping struct {
kapi.TypeMeta `json:",inline"`
kapi.ObjectMeta `json:"metadata,omitempty"`
// The Docker image repository the specified image is located in
DockerImageRepository string `json:"dockerImageRepository"`
// 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 ¶ added in v0.4.3
func (*ImageStreamMapping) IsAnAPIObject()
type ImageStreamSpec ¶ added in v0.4.3
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 []NamedTagReference `json:"tags,omitempty"`
}
ImageStreamSpec represents options for ImageStreams.
type ImageStreamStatus ¶ added in v0.4.3
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 ¶ added in v0.4.3
ImageStreamTag exists to allow calls to `osc get imageStreamTag ...` to function.
func (*ImageStreamTag) IsAnAPIObject ¶ added in v0.4.3
func (*ImageStreamTag) IsAnAPIObject()
type NamedTagEventList ¶ added in v0.4.2
NamedTagEventList relates a tag to its image history.
type NamedTagReference ¶ added in v0.4.3
type NamedTagReference struct {
Name string `json:"name"`
Annotations map[string]string `json:"annotations,omitempty"`
DockerImageReference string `json:"dockerImageReference,omitempty"`
From *kapi.ObjectReference `json:"from,omitempty"`
}
NamedTagReference allows a user to TODO.
type TagEvent ¶ added in v0.4.2
type TagEvent struct {
// When the TagEvent was created
Created util.Time `json:"created"`
// The string that can be used to pull this image
DockerImageReference string `json:"dockerImageReference"`
// The image
Image string `json:"image"`
}
TagEvent is used by ImageRepositoryStatus to keep a historical record of images associated with a tag.