Image [image.openshift.io/v1]

    Image is an immutable representation of a container image and metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users instead access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents.

    Type

    Required

    • dockerImageLayers

    .dockerImageLayers

    Description

    DockerImageLayers represents the layers in the image. May not be set if the image does not define that data.

    Type

    array

    .dockerImageLayers[]

    Description

    ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.

    Type

    object

    Required

    • name

    • mediaType

    PropertyTypeDescription

    mediaType

    string

    MediaType of the referenced object.

    name

    string

    Name of the layer as defined by the underlying store.

    size

    integer

    Size of the layer in bytes as defined by the underlying store.

    .signatures

    Description

    Signatures holds all signatures of the image.

    Type

    array

    .signatures[]

    Description

    ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature’s content by the server. They serve just an informative purpose.

    Type

    object

    Required

    • type

    • content

    PropertyTypeDescription

    apiVersion

    string

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

    conditions

    array

    Conditions represent the latest available observations of a signature’s current state.

    conditions[]

    object

    SignatureCondition describes an image signature condition of particular kind at particular probe time.

    content

    string

    Required: An opaque binary string which is an image’s signature.

    created

    If specified, it is the time of signature’s creation.

    imageIdentity

    string

    A human readable string representing image’s identity. It could be a product name and version, or an image pull spec (e.g. “registry.access.redhat.com/rhel7/rhel:7.2”).

    issuedBy

    object

    SignatureIssuer holds information about an issuer of signing certificate or key.

    issuedTo

    object

    SignatureSubject holds information about a person or entity who created the signature.

    kind

    string

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

    metadata

    signedClaims

    object (string)

    Contains claims from the signature.

    type

    string

    Required: Describes a type of stored blob.

    .signatures[].conditions

    Description

    Conditions represent the latest available observations of a signature’s current state.

    Type

    .signatures[].conditions[]

    Description

    Type

    object

    Required

    • type

    • status

    PropertyTypeDescription

    lastProbeTime

    Time meta/v1

    Last time the condition was checked.

    lastTransitionTime

    Last time the condition transit from one status to another.

    message

    string

    Human readable message indicating details about last transition.

    reason

    string

    (brief) reason for the condition’s last transition.

    status

    string

    Status of the condition, one of True, False, Unknown.

    type

    string

    Type of signature condition, Complete or Failed.

    .signatures[].issuedBy

    Description

    SignatureIssuer holds information about an issuer of signing certificate or key.

    Type

    object

    PropertyTypeDescription

    commonName

    string

    Common name (e.g. openshift-signing-service).

    organization

    string

    Organization name.

    .signatures[].issuedTo

    Description

    SignatureSubject holds information about a person or entity who created the signature.

    Type

    object

    Required

    • publicKeyID
    PropertyTypeDescription

    commonName

    string

    Common name (e.g. openshift-signing-service).

    organization

    string

    Organization name.

    publicKeyID

    string

    If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key’s fingerprint (e.g. 0x685ebe62bf278440).

    API endpoints

    The following API endpoints are available:

    • /apis/image.openshift.io/v1/images/{name}

      • DELETE: delete an Image

      • GET: read the specified Image

      • PUT: replace the specified Image

    Table 1. Global guery parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    DELETE

    Description

    delete collection of Image

    Table 2. Query parameters
    ParameterTypeDescription

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    gracePeriodSeconds

    integer

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    labelSelector

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    orphanDependents

    boolean

    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    propagationPolicy

    string

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    Table 3. Body parameters
    ParameterTypeDescription

    body

    HTTP method

    GET

    Description

    list or watch objects of kind Image

    Table 5. Query parameters
    ParameterTypeDescription

    allowWatchBookmarks

    allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    watch

    boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    Table 6. HTTP responses
    HTTP codeReponse body

    200 - OK

    ImageList image.openshift.io/v1

    401 - Unauthorized

    Empty

    HTTP method

    POST

    Description

    create an Image

    Table 7. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    Table 8. Body parameters
    ParameterTypeDescription

    body

    Image image.openshift.io/v1

    Table 9. HTTP responses
    HTTP codeReponse body

    200 - OK

    201 - Created

    Image image.openshift.io/v1

    202 - Accepted

    401 - Unauthorized

    Empty

    /apis/image.openshift.io/v1/images/{name}

    Table 10. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the Image

    Table 11. Global guery parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    DELETE

    Description

    delete an Image

    Table 12. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    gracePeriodSeconds

    integer

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    orphanDependents

    boolean

    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    propagationPolicy

    string

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

    Table 14. HTTP responses
    HTTP codeReponse body

    200 - OK

    202 - Accepted

    Status meta/v1

    401 - Unauthorized

    Empty

    HTTP method

    GET

    Description

    read the specified Image

    Table 15. Query parameters
    ParameterTypeDescription

    exact

    boolean

    Should the export be exact. Exact export maintains cluster-specific fields like ‘Namespace’. Deprecated. Planned for removal in 1.18.

    export

    boolean

    Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18.

    Table 16. HTTP responses
    HTTP codeReponse body

    200 - OK

    401 - Unauthorized

    Empty

    HTTP method

    PATCH

    Description

    partially update the specified Image

    Table 17. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    force

    boolean

    Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    Table 18. Body parameters
    ParameterTypeDescription

    body

    Table 19. HTTP responses
    HTTP codeReponse body

    200 - OK

    Image image.openshift.io/v1

    401 - Unauthorized

    Empty

    HTTP method

    PUT

    Description

    replace the specified Image

    Table 20. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    Table 21. Body parameters
    ParameterTypeDescription

    body

    Image image.openshift.io/v1