1. Documentation
×

v1.ImageStreamImport

Description

The image stream import resource provides an easy way for a user to find and import Docker images from other Docker registries into the server. Individual images or an entire image repository may be imported, and users may choose to see the results of the import prior to tagging the resulting images into the specified image stream.

This API is intended for end-user tools that need to see the metadata of the image prior to import (for instance, to generate an application from it). Clients that know the desired image can continue to create spec.tags directly into their image streams.

Object Schema

Expand or mouse-over a field for more information about it.

apiVersion:

kind:

Collapse all
metadata:

Collapse all
  annotations:

    [string]:

  clusterName:

  creationTimestamp:

  deletionGracePeriodSeconds:

  deletionTimestamp:

Collapse all
  finalizers:

  - [string]:

  generateName:

  generation:

Collapse all
  initializers:

Collapse all
    pending:

    - name:

Collapse all
    result:

      apiVersion:

      code:

Collapse all
      details:

Collapse all
        causes:

        - field:

          message:

          reason:

        group:

        kind:

        name:

        retryAfterSeconds:

        uid:

      kind:

      message:

Collapse all
      metadata:

        resourceVersion:

        selfLink:

      reason:

      status:

Collapse all
  labels:

    [string]:

  name:

  namespace:

Collapse all
  ownerReferences:

  - apiVersion:

    blockOwnerDeletion:

    controller:

    kind:

    name:

    uid:

  resourceVersion:

  selfLink:

  uid:

Collapse all
spec:

Collapse all
  images:

Collapse all
  - from:

  -   apiVersion:

      fieldPath:

      kind:

      name:

      namespace:

      resourceVersion:

      uid:

Collapse all
    importPolicy:

      insecure:

      scheduled:

    includeManifest:

Collapse all
    referencePolicy:

      type:

Collapse all
    to:

      name:

  import:

Collapse all
  repository:

Collapse all
    from:

      apiVersion:

      fieldPath:

      kind:

      name:

      namespace:

      resourceVersion:

      uid:

Collapse all
    importPolicy:

      insecure:

      scheduled:

    includeManifest:

Collapse all
    referencePolicy:

      type:

Collapse all
status:

Collapse all
  images:

Collapse all
  - image:

  -   apiVersion:

      dockerImageConfig:

Collapse all
      dockerImageLayers:

      - mediaType:

        name:

        size:

      dockerImageManifest:

      dockerImageManifestMediaType:

Collapse all
      dockerImageMetadata:

        Raw:

      dockerImageMetadataVersion:

      dockerImageReference:

Collapse all
      dockerImageSignatures:

      - [string]:

      kind:

Collapse all
      metadata:

Collapse all
        annotations:

          [string]:

        clusterName:

        creationTimestamp:

        deletionGracePeriodSeconds:

        deletionTimestamp:

Collapse all
        finalizers:

        - [string]:

        generateName:

        generation:

Collapse all
        initializers:

Collapse all
          pending:

          - name:

Collapse all
          result:

            apiVersion:

            code:

Collapse all
            details:

Collapse all
              causes:

              - field:

                message:

                reason:

              group:

              kind:

              name:

              retryAfterSeconds:

              uid:

            kind:

            message:

Collapse all
            metadata:

              resourceVersion:

              selfLink:

            reason:

            status:

Collapse all
        labels:

          [string]:

        name:

        namespace:

Collapse all
        ownerReferences:

        - apiVersion:

          blockOwnerDeletion:

          controller:

          kind:

          name:

          uid:

        resourceVersion:

        selfLink:

        uid:

Collapse all
      signatures:

      - apiVersion:

Collapse all
        conditions:

        - lastProbeTime:

          lastTransitionTime:

          message:

          reason:

          status:

          type:

        content:

        created:

        imageIdentity:

Collapse all
        issuedBy:

          commonName:

          organization:

Collapse all
        issuedTo:

          commonName:

          organization:

          publicKeyID:

        kind:

Collapse all
        metadata:

Collapse all
          annotations:

            [string]:

          clusterName:

          creationTimestamp:

          deletionGracePeriodSeconds:

          deletionTimestamp:

Collapse all
          finalizers:

          - [string]:

          generateName:

          generation:

Collapse all
          initializers:

Collapse all
            pending:

            - name:

Collapse all
            result:

              apiVersion:

              code:

Collapse all
              details:

Collapse all
                causes:

                - field:

                  message:

                  reason:

                group:

                kind:

                name:

                retryAfterSeconds:

                uid:

              kind:

              message:

Collapse all
              metadata:

                resourceVersion:

                selfLink:

              reason:

              status:

Collapse all
          labels:

            [string]:

          name:

          namespace:

Collapse all
          ownerReferences:

          - apiVersion:

            blockOwnerDeletion:

            controller:

            kind:

            name:

            uid:

          resourceVersion:

          selfLink:

          uid:

Collapse all
        signedClaims:

          [string]:

        type:

Collapse all
    status:

      apiVersion:

      code:

Collapse all
      details:

Collapse all
        causes:

        - field:

          message:

          reason:

        group:

        kind:

        name:

        retryAfterSeconds:

        uid:

      kind:

      message:

Collapse all
      metadata:

        resourceVersion:

        selfLink:

      reason:

      status:

    tag:

Collapse all
  import:

    apiVersion:

    kind:

Collapse all
    metadata:

Collapse all
      annotations:

        [string]:

      clusterName:

      creationTimestamp:

      deletionGracePeriodSeconds:

      deletionTimestamp:

Collapse all
      finalizers:

      - [string]:

      generateName:

      generation:

Collapse all
      initializers:

Collapse all
        pending:

        - name:

Collapse all
        result:

          apiVersion:

          code:

Collapse all
          details:

Collapse all
            causes:

            - field:

              message:

              reason:

            group:

            kind:

            name:

            retryAfterSeconds:

            uid:

          kind:

          message:

Collapse all
          metadata:

            resourceVersion:

            selfLink:

          reason:

          status:

Collapse all
      labels:

        [string]:

      name:

      namespace:

Collapse all
      ownerReferences:

      - apiVersion:

        blockOwnerDeletion:

        controller:

        kind:

        name:

        uid:

      resourceVersion:

      selfLink:

      uid:

Collapse all
    spec:

      dockerImageRepository:

Collapse all
      lookupPolicy:

        local:

Collapse all
      tags:

Collapse all
      - annotations:

      -   [string]:

Collapse all
        from:

          apiVersion:

          fieldPath:

          kind:

          name:

          namespace:

          resourceVersion:

          uid:

        generation:

Collapse all
        importPolicy:

          insecure:

          scheduled:

        name:

        reference:

Collapse all
        referencePolicy:

          type:

Collapse all
    status:

      dockerImageRepository:

      publicDockerImageRepository:

Collapse all
      tags:

Collapse all
      - conditions:

      - - generation:

          lastTransitionTime:

          message:

          reason:

          status:

          type:

Collapse all
        items:

        - created:

          dockerImageReference:

          generation:

          image:

        tag:

Collapse all
  repository:

Collapse all
    additionalTags:

    - [string]:

Collapse all
    images:

Collapse all
    - image:

    -   apiVersion:

        dockerImageConfig:

Collapse all
        dockerImageLayers:

        - mediaType:

          name:

          size:

        dockerImageManifest:

        dockerImageManifestMediaType:

Collapse all
        dockerImageMetadata:

          Raw:

        dockerImageMetadataVersion:

        dockerImageReference:

Collapse all
        dockerImageSignatures:

        - [string]:

        kind:

Collapse all
        metadata:

Collapse all
          annotations:

            [string]:

          clusterName:

          creationTimestamp:

          deletionGracePeriodSeconds:

          deletionTimestamp:

Collapse all
          finalizers:

          - [string]:

          generateName:

          generation:

Collapse all
          initializers:

Collapse all
            pending:

            - name:

Collapse all
            result:

              apiVersion:

              code:

Collapse all
              details:

Collapse all
                causes:

                - field:

                  message:

                  reason:

                group:

                kind:

                name:

                retryAfterSeconds:

                uid:

              kind:

              message:

Collapse all
              metadata:

                resourceVersion:

                selfLink:

              reason:

              status:

Collapse all
          labels:

            [string]:

          name:

          namespace:

Collapse all
          ownerReferences:

          - apiVersion:

            blockOwnerDeletion:

            controller:

            kind:

            name:

            uid:

          resourceVersion:

          selfLink:

          uid:

Collapse all
        signatures:

        - apiVersion:

Collapse all
          conditions:

          - lastProbeTime:

            lastTransitionTime:

            message:

            reason:

            status:

            type:

          content:

          created:

          imageIdentity:

Collapse all
          issuedBy:

            commonName:

            organization:

Collapse all
          issuedTo:

            commonName:

            organization:

            publicKeyID:

          kind:

Collapse all
          metadata:

Collapse all
            annotations:

              [string]:

            clusterName:

            creationTimestamp:

            deletionGracePeriodSeconds:

            deletionTimestamp:

Collapse all
            finalizers:

            - [string]:

            generateName:

            generation:

Collapse all
            initializers:

Collapse all
              pending:

              - name:

Collapse all
              result:

                apiVersion:

                code:

Collapse all
                details:

Collapse all
                  causes:

                  - field:

                    message:

                    reason:

                  group:

                  kind:

                  name:

                  retryAfterSeconds:

                  uid:

                kind:

                message:

Collapse all
                metadata:

                  resourceVersion:

                  selfLink:

                reason:

                status:

Collapse all
            labels:

              [string]:

            name:

            namespace:

Collapse all
            ownerReferences:

            - apiVersion:

              blockOwnerDeletion:

              controller:

              kind:

              name:

              uid:

            resourceVersion:

            selfLink:

            uid:

Collapse all
          signedClaims:

            [string]:

          type:

Collapse all
      status:

        apiVersion:

        code:

Collapse all
        details:

Collapse all
          causes:

          - field:

            message:

            reason:

          group:

          kind:

          name:

          retryAfterSeconds:

          uid:

        kind:

        message:

Collapse all
        metadata:

          resourceVersion:

          selfLink:

        reason:

        status:

      tag:

Collapse all
    status:

      apiVersion:

      code:

Collapse all
      details:

Collapse all
        causes:

        - field:

          message:

          reason:

        group:

        kind:

        name:

        retryAfterSeconds:

        uid:

      kind:

      message:

Collapse all
      metadata:

        resourceVersion:

        selfLink:

      reason:

      status:

Operations

Create a ImageStreamImport

Create an ImageStreamImport

HTTP request

POST /oapi/v1/imagestreamimports HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ImageStreamImport",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/oapi/v1/imagestreamimports <<'EOF'
{
  "kind": "ImageStreamImport",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.ImageStreamImport

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.ImageStreamImport

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create a ImageStreamImport in a namespace

Create an ImageStreamImport

HTTP request

POST /oapi/v1/namespaces/$NAMESPACE/imagestreamimports HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ImageStreamImport",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/imagestreamimports <<'EOF'
{
  "kind": "ImageStreamImport",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.ImageStreamImport

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.ImageStreamImport

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf