OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history
×

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:

metadata:

  annotations:

    [string]:

  clusterName:

  creationTimestamp:

  deletionGracePeriodSeconds:

  deletionTimestamp:

  finalizers:

  - [string]:

  generateName:

  generation:

  initializers:

    pending:

    - name:

    result:

      apiVersion:

      code:

      details:

        causes:

        - field:

          message:

          reason:

        group:

        kind:

        name:

        retryAfterSeconds:

        uid:

      kind:

      message:

      metadata:

        resourceVersion:

        selfLink:

      reason:

      status:

  labels:

    [string]:

  name:

  namespace:

  ownerReferences:

  - apiVersion:

    blockOwnerDeletion:

    controller:

    kind:

    name:

    uid:

  resourceVersion:

  selfLink:

  uid:

spec:

  images:

  - from:

  -   apiVersion:

      fieldPath:

      kind:

      name:

      namespace:

      resourceVersion:

      uid:

    importPolicy:

      insecure:

      scheduled:

    includeManifest:

    referencePolicy:

      type:

    to:

      name:

  import:

  repository:

    from:

      apiVersion:

      fieldPath:

      kind:

      name:

      namespace:

      resourceVersion:

      uid:

    importPolicy:

      insecure:

      scheduled:

    includeManifest:

    referencePolicy:

      type:

status:

  images:

  - image:

  -   apiVersion:

      dockerImageConfig:

      dockerImageLayers:

      - mediaType:

        name:

        size:

      dockerImageManifest:

      dockerImageManifestMediaType:

      dockerImageMetadata:

        Raw:

      dockerImageMetadataVersion:

      dockerImageReference:

      dockerImageSignatures:

      - [string]:

      kind:

      metadata:

        annotations:

          [string]:

        clusterName:

        creationTimestamp:

        deletionGracePeriodSeconds:

        deletionTimestamp:

        finalizers:

        - [string]:

        generateName:

        generation:

        initializers:

          pending:

          - name:

          result:

            apiVersion:

            code:

            details:

              causes:

              - field:

                message:

                reason:

              group:

              kind:

              name:

              retryAfterSeconds:

              uid:

            kind:

            message:

            metadata:

              resourceVersion:

              selfLink:

            reason:

            status:

        labels:

          [string]:

        name:

        namespace:

        ownerReferences:

        - apiVersion:

          blockOwnerDeletion:

          controller:

          kind:

          name:

          uid:

        resourceVersion:

        selfLink:

        uid:

      signatures:

      - apiVersion:

        conditions:

        - lastProbeTime:

          lastTransitionTime:

          message:

          reason:

          status:

          type:

        content:

        created:

        imageIdentity:

        issuedBy:

          commonName:

          organization:

        issuedTo:

          commonName:

          organization:

          publicKeyID:

        kind:

        metadata:

          annotations:

            [string]:

          clusterName:

          creationTimestamp:

          deletionGracePeriodSeconds:

          deletionTimestamp:

          finalizers:

          - [string]:

          generateName:

          generation:

          initializers:

            pending:

            - name:

            result:

              apiVersion:

              code:

              details:

                causes:

                - field:

                  message:

                  reason:

                group:

                kind:

                name:

                retryAfterSeconds:

                uid:

              kind:

              message:

              metadata:

                resourceVersion:

                selfLink:

              reason:

              status:

          labels:

            [string]:

          name:

          namespace:

          ownerReferences:

          - apiVersion:

            blockOwnerDeletion:

            controller:

            kind:

            name:

            uid:

          resourceVersion:

          selfLink:

          uid:

        signedClaims:

          [string]:

        type:

    status:

      apiVersion:

      code:

      details:

        causes:

        - field:

          message:

          reason:

        group:

        kind:

        name:

        retryAfterSeconds:

        uid:

      kind:

      message:

      metadata:

        resourceVersion:

        selfLink:

      reason:

      status:

    tag:

  import:

    apiVersion:

    kind:

    metadata:

      annotations:

        [string]:

      clusterName:

      creationTimestamp:

      deletionGracePeriodSeconds:

      deletionTimestamp:

      finalizers:

      - [string]:

      generateName:

      generation:

      initializers:

        pending:

        - name:

        result:

          apiVersion:

          code:

          details:

            causes:

            - field:

              message:

              reason:

            group:

            kind:

            name:

            retryAfterSeconds:

            uid:

          kind:

          message:

          metadata:

            resourceVersion:

            selfLink:

          reason:

          status:

      labels:

        [string]:

      name:

      namespace:

      ownerReferences:

      - apiVersion:

        blockOwnerDeletion:

        controller:

        kind:

        name:

        uid:

      resourceVersion:

      selfLink:

      uid:

    spec:

      dockerImageRepository:

      lookupPolicy:

        local:

      tags:

      - annotations:

      -   [string]:

        from:

          apiVersion:

          fieldPath:

          kind:

          name:

          namespace:

          resourceVersion:

          uid:

        generation:

        importPolicy:

          insecure:

          scheduled:

        name:

        reference:

        referencePolicy:

          type:

    status:

      dockerImageRepository:

      publicDockerImageRepository:

      tags:

      - conditions:

      - - generation:

          lastTransitionTime:

          message:

          reason:

          status:

          type:

        items:

        - created:

          dockerImageReference:

          generation:

          image:

        tag:

  repository:

    additionalTags:

    - [string]:

    images:

    - image:

    -   apiVersion:

        dockerImageConfig:

        dockerImageLayers:

        - mediaType:

          name:

          size:

        dockerImageManifest:

        dockerImageManifestMediaType:

        dockerImageMetadata:

          Raw:

        dockerImageMetadataVersion:

        dockerImageReference:

        dockerImageSignatures:

        - [string]:

        kind:

        metadata:

          annotations:

            [string]:

          clusterName:

          creationTimestamp:

          deletionGracePeriodSeconds:

          deletionTimestamp:

          finalizers:

          - [string]:

          generateName:

          generation:

          initializers:

            pending:

            - name:

            result:

              apiVersion:

              code:

              details:

                causes:

                - field:

                  message:

                  reason:

                group:

                kind:

                name:

                retryAfterSeconds:

                uid:

              kind:

              message:

              metadata:

                resourceVersion:

                selfLink:

              reason:

              status:

          labels:

            [string]:

          name:

          namespace:

          ownerReferences:

          - apiVersion:

            blockOwnerDeletion:

            controller:

            kind:

            name:

            uid:

          resourceVersion:

          selfLink:

          uid:

        signatures:

        - apiVersion:

          conditions:

          - lastProbeTime:

            lastTransitionTime:

            message:

            reason:

            status:

            type:

          content:

          created:

          imageIdentity:

          issuedBy:

            commonName:

            organization:

          issuedTo:

            commonName:

            organization:

            publicKeyID:

          kind:

          metadata:

            annotations:

              [string]:

            clusterName:

            creationTimestamp:

            deletionGracePeriodSeconds:

            deletionTimestamp:

            finalizers:

            - [string]:

            generateName:

            generation:

            initializers:

              pending:

              - name:

              result:

                apiVersion:

                code:

                details:

                  causes:

                  - field:

                    message:

                    reason:

                  group:

                  kind:

                  name:

                  retryAfterSeconds:

                  uid:

                kind:

                message:

                metadata:

                  resourceVersion:

                  selfLink:

                reason:

                status:

            labels:

              [string]:

            name:

            namespace:

            ownerReferences:

            - apiVersion:

              blockOwnerDeletion:

              controller:

              kind:

              name:

              uid:

            resourceVersion:

            selfLink:

            uid:

          signedClaims:

            [string]:

          type:

      status:

        apiVersion:

        code:

        details:

          causes:

          - field:

            message:

            reason:

          group:

          kind:

          name:

          retryAfterSeconds:

          uid:

        kind:

        message:

        metadata:

          resourceVersion:

          selfLink:

        reason:

        status:

      tag:

    status:

      apiVersion:

      code:

      details:

        causes:

        - field:

          message:

          reason:

        group:

        kind:

        name:

        retryAfterSeconds:

        uid:

      kind:

      message:

      metadata:

        resourceVersion:

        selfLink:

      reason:

      status:

Operations

Create a ImageStreamImport

Create an ImageStreamImport

HTTP request

POST /apis/image.openshift.io/v1/imagestreamimports HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ImageStreamImport",
  "apiVersion": "image.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/image.openshift.io/v1/imagestreamimports <<'EOF'
{
  "kind": "ImageStreamImport",
  "apiVersion": "image.openshift.io/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 /apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamimports HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ImageStreamImport",
  "apiVersion": "image.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamimports <<'EOF'
{
  "kind": "ImageStreamImport",
  "apiVersion": "image.openshift.io/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