Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
    2. history
×

v1.DeploymentConfig

Description

Deployment Configs define the template for a pod and manages deploying new images or configuration changes. A single deployment configuration is usually analogous to a single micro-service. Can support many different deployment patterns, including full restart, customizable rolling updates, and fully custom behaviors, as well as pre- and post- deployment hooks. Each individual deployment is represented as a replication controller.

A deployment is "triggered" when its configuration is changed or a tag in an Image Stream is changed. Triggers can be disabled to allow manual control over a deployment. The "strategy" determines how the deployment is carried out and may be changed at any time. The latestVersion field is updated when a new deployment is triggered by any means.

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:

  minReadySeconds:

  paused:

  replicas:

  revisionHistoryLimit:

  selector:

    [string]:

  strategy:

    activeDeadlineSeconds:

    annotations:

      [string]:

    customParams:

      command:

      - [string]:

      environment:

      - name:

        value:

        valueFrom:

          configMapKeyRef:

            key:

            name:

            optional:

          fieldRef:

            apiVersion:

            fieldPath:

          resourceFieldRef:

            containerName:

            divisor:

            resource:

          secretKeyRef:

            key:

            name:

            optional:

      image:

    labels:

      [string]:

    recreateParams:

      mid:

        execNewPod:

          command:

          - [string]:

          containerName:

          env:

          - name:

            value:

            valueFrom:

              configMapKeyRef:

                key:

                name:

                optional:

              fieldRef:

                apiVersion:

                fieldPath:

              resourceFieldRef:

                containerName:

                divisor:

                resource:

              secretKeyRef:

                key:

                name:

                optional:

          volumes:

          - [string]:

        failurePolicy:

        tagImages:

        - containerName:

          to:

            apiVersion:

            fieldPath:

            kind:

            name:

            namespace:

            resourceVersion:

            uid:

      post:

        execNewPod:

          command:

          - [string]:

          containerName:

          env:

          - name:

            value:

            valueFrom:

              configMapKeyRef:

                key:

                name:

                optional:

              fieldRef:

                apiVersion:

                fieldPath:

              resourceFieldRef:

                containerName:

                divisor:

                resource:

              secretKeyRef:

                key:

                name:

                optional:

          volumes:

          - [string]:

        failurePolicy:

        tagImages:

        - containerName:

          to:

            apiVersion:

            fieldPath:

            kind:

            name:

            namespace:

            resourceVersion:

            uid:

      pre:

        execNewPod:

          command:

          - [string]:

          containerName:

          env:

          - name:

            value:

            valueFrom:

              configMapKeyRef:

                key:

                name:

                optional:

              fieldRef:

                apiVersion:

                fieldPath:

              resourceFieldRef:

                containerName:

                divisor:

                resource:

              secretKeyRef:

                key:

                name:

                optional:

          volumes:

          - [string]:

        failurePolicy:

        tagImages:

        - containerName:

          to:

            apiVersion:

            fieldPath:

            kind:

            name:

            namespace:

            resourceVersion:

            uid:

      timeoutSeconds:

    resources:

      limits:

        [string]:

      requests:

        [string]:

    rollingParams:

      intervalSeconds:

      maxSurge:

      maxUnavailable:

      post:

        execNewPod:

          command:

          - [string]:

          containerName:

          env:

          - name:

            value:

            valueFrom:

              configMapKeyRef:

                key:

                name:

                optional:

              fieldRef:

                apiVersion:

                fieldPath:

              resourceFieldRef:

                containerName:

                divisor:

                resource:

              secretKeyRef:

                key:

                name:

                optional:

          volumes:

          - [string]:

        failurePolicy:

        tagImages:

        - containerName:

          to:

            apiVersion:

            fieldPath:

            kind:

            name:

            namespace:

            resourceVersion:

            uid:

      pre:

        execNewPod:

          command:

          - [string]:

          containerName:

          env:

          - name:

            value:

            valueFrom:

              configMapKeyRef:

                key:

                name:

                optional:

              fieldRef:

                apiVersion:

                fieldPath:

              resourceFieldRef:

                containerName:

                divisor:

                resource:

              secretKeyRef:

                key:

                name:

                optional:

          volumes:

          - [string]:

        failurePolicy:

        tagImages:

        - containerName:

          to:

            apiVersion:

            fieldPath:

            kind:

            name:

            namespace:

            resourceVersion:

            uid:

      timeoutSeconds:

      updatePeriodSeconds:

    type:

  template:

    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:

      activeDeadlineSeconds:

      affinity:

        nodeAffinity:

          preferredDuringSchedulingIgnoredDuringExecution:

          - preference:

          -   matchExpressions:

          -   - key:

                operator:

                values:

                - [string]:

            weight:

          requiredDuringSchedulingIgnoredDuringExecution:

            nodeSelectorTerms:

            - matchExpressions:

            - - key:

                operator:

                values:

                - [string]:

        podAffinity:

          preferredDuringSchedulingIgnoredDuringExecution:

          - podAffinityTerm:

          -   labelSelector:

          -     matchExpressions:

          -     - key:

                  operator:

                  values:

                  - [string]:

                matchLabels:

                  [string]:

              namespaces:

              - [string]:

              topologyKey:

            weight:

          requiredDuringSchedulingIgnoredDuringExecution:

          - labelSelector:

          -   matchExpressions:

          -   - key:

                operator:

                values:

                - [string]:

              matchLabels:

                [string]:

            namespaces:

            - [string]:

            topologyKey:

        podAntiAffinity:

          preferredDuringSchedulingIgnoredDuringExecution:

          - podAffinityTerm:

          -   labelSelector:

          -     matchExpressions:

          -     - key:

                  operator:

                  values:

                  - [string]:

                matchLabels:

                  [string]:

              namespaces:

              - [string]:

              topologyKey:

            weight:

          requiredDuringSchedulingIgnoredDuringExecution:

          - labelSelector:

          -   matchExpressions:

          -   - key:

                operator:

                values:

                - [string]:

              matchLabels:

                [string]:

            namespaces:

            - [string]:

            topologyKey:

      automountServiceAccountToken:

      containers:

      - args:

      - - [string]:

        command:

        - [string]:

        env:

        - name:

          value:

          valueFrom:

            configMapKeyRef:

              key:

              name:

              optional:

            fieldRef:

              apiVersion:

              fieldPath:

            resourceFieldRef:

              containerName:

              divisor:

              resource:

            secretKeyRef:

              key:

              name:

              optional:

        envFrom:

        - configMapRef:

        -   name:

            optional:

          prefix:

          secretRef:

            name:

            optional:

        image:

        imagePullPolicy:

        lifecycle:

          postStart:

            exec:

              command:

              - [string]:

            httpGet:

              host:

              httpHeaders:

              - name:

                value:

              path:

              port:

              scheme:

            tcpSocket:

              host:

              port:

          preStop:

            exec:

              command:

              - [string]:

            httpGet:

              host:

              httpHeaders:

              - name:

                value:

              path:

              port:

              scheme:

            tcpSocket:

              host:

              port:

        livenessProbe:

          exec:

            command:

            - [string]:

          failureThreshold:

          httpGet:

            host:

            httpHeaders:

            - name:

              value:

            path:

            port:

            scheme:

          initialDelaySeconds:

          periodSeconds:

          successThreshold:

          tcpSocket:

            host:

            port:

          timeoutSeconds:

        name:

        ports:

        - containerPort:

          hostIP:

          hostPort:

          name:

          protocol:

        readinessProbe:

          exec:

            command:

            - [string]:

          failureThreshold:

          httpGet:

            host:

            httpHeaders:

            - name:

              value:

            path:

            port:

            scheme:

          initialDelaySeconds:

          periodSeconds:

          successThreshold:

          tcpSocket:

            host:

            port:

          timeoutSeconds:

        resources:

          limits:

            [string]:

          requests:

            [string]:

        securityContext:

          capabilities:

            add:

            - [string]:

            drop:

            - [string]:

          privileged:

          readOnlyRootFilesystem:

          runAsNonRoot:

          runAsUser:

          seLinuxOptions:

            level:

            role:

            type:

            user:

        stdin:

        stdinOnce:

        terminationMessagePath:

        terminationMessagePolicy:

        tty:

        volumeMounts:

        - mountPath:

          name:

          readOnly:

          subPath:

        workingDir:

      dnsPolicy:

      hostAliases:

      - hostnames:

      - - [string]:

        ip:

      hostIPC:

      hostNetwork:

      hostPID:

      hostname:

      imagePullSecrets:

      - name:

      initContainers:

      - args:

      - - [string]:

        command:

        - [string]:

        env:

        - name:

          value:

          valueFrom:

            configMapKeyRef:

              key:

              name:

              optional:

            fieldRef:

              apiVersion:

              fieldPath:

            resourceFieldRef:

              containerName:

              divisor:

              resource:

            secretKeyRef:

              key:

              name:

              optional:

        envFrom:

        - configMapRef:

        -   name:

            optional:

          prefix:

          secretRef:

            name:

            optional:

        image:

        imagePullPolicy:

        lifecycle:

          postStart:

            exec:

              command:

              - [string]:

            httpGet:

              host:

              httpHeaders:

              - name:

                value:

              path:

              port:

              scheme:

            tcpSocket:

              host:

              port:

          preStop:

            exec:

              command:

              - [string]:

            httpGet:

              host:

              httpHeaders:

              - name:

                value:

              path:

              port:

              scheme:

            tcpSocket:

              host:

              port:

        livenessProbe:

          exec:

            command:

            - [string]:

          failureThreshold:

          httpGet:

            host:

            httpHeaders:

            - name:

              value:

            path:

            port:

            scheme:

          initialDelaySeconds:

          periodSeconds:

          successThreshold:

          tcpSocket:

            host:

            port:

          timeoutSeconds:

        name:

        ports:

        - containerPort:

          hostIP:

          hostPort:

          name:

          protocol:

        readinessProbe:

          exec:

            command:

            - [string]:

          failureThreshold:

          httpGet:

            host:

            httpHeaders:

            - name:

              value:

            path:

            port:

            scheme:

          initialDelaySeconds:

          periodSeconds:

          successThreshold:

          tcpSocket:

            host:

            port:

          timeoutSeconds:

        resources:

          limits:

            [string]:

          requests:

            [string]:

        securityContext:

          capabilities:

            add:

            - [string]:

            drop:

            - [string]:

          privileged:

          readOnlyRootFilesystem:

          runAsNonRoot:

          runAsUser:

          seLinuxOptions:

            level:

            role:

            type:

            user:

        stdin:

        stdinOnce:

        terminationMessagePath:

        terminationMessagePolicy:

        tty:

        volumeMounts:

        - mountPath:

          name:

          readOnly:

          subPath:

        workingDir:

      nodeName:

      nodeSelector:

        [string]:

      restartPolicy:

      schedulerName:

      securityContext:

        fsGroup:

        runAsNonRoot:

        runAsUser:

        seLinuxOptions:

          level:

          role:

          type:

          user:

        supplementalGroups:

        - [integer]:

      serviceAccount:

      serviceAccountName:

      subdomain:

      terminationGracePeriodSeconds:

      tolerations:

      - effect:

        key:

        operator:

        tolerationSeconds:

        value:

      volumes:

      - awsElasticBlockStore:

      -   fsType:

          partition:

          readOnly:

          volumeID:

        azureDisk:

          cachingMode:

          diskName:

          diskURI:

          fsType:

          kind:

          readOnly:

        azureFile:

          readOnly:

          secretName:

          shareName:

        cephfs:

          monitors:

          - [string]:

          path:

          readOnly:

          secretFile:

          secretRef:

            name:

          user:

        cinder:

          fsType:

          readOnly:

          volumeID:

        configMap:

          defaultMode:

          items:

          - key:

            mode:

            path:

          name:

          optional:

        downwardAPI:

          defaultMode:

          items:

          - fieldRef:

          -   apiVersion:

              fieldPath:

            mode:

            path:

            resourceFieldRef:

              containerName:

              divisor:

              resource:

        emptyDir:

          medium:

          sizeLimit:

        fc:

          fsType:

          lun:

          readOnly:

          targetWWNs:

          - [string]:

        flexVolume:

          driver:

          fsType:

          options:

            [string]:

          readOnly:

          secretRef:

            name:

        flocker:

          datasetName:

          datasetUUID:

        gcePersistentDisk:

          fsType:

          partition:

          pdName:

          readOnly:

        gitRepo:

          directory:

          repository:

          revision:

        glusterfs:

          endpoints:

          path:

          readOnly:

        hostPath:

          path:

        iscsi:

          chapAuthDiscovery:

          chapAuthSession:

          fsType:

          iqn:

          iscsiInterface:

          lun:

          portals:

          - [string]:

          readOnly:

          secretRef:

            name:

          targetPortal:

        name:

        nfs:

          path:

          readOnly:

          server:

        persistentVolumeClaim:

          claimName:

          readOnly:

        photonPersistentDisk:

          fsType:

          pdID:

        portworxVolume:

          fsType:

          readOnly:

          volumeID:

        projected:

          defaultMode:

          sources:

          - configMap:

          -   items:

          -   - key:

                mode:

                path:

              name:

              optional:

            downwardAPI:

              items:

              - fieldRef:

              -   apiVersion:

                  fieldPath:

                mode:

                path:

                resourceFieldRef:

                  containerName:

                  divisor:

                  resource:

            secret:

              items:

              - key:

                mode:

                path:

              name:

              optional:

        quobyte:

          group:

          readOnly:

          registry:

          user:

          volume:

        rbd:

          fsType:

          image:

          keyring:

          monitors:

          - [string]:

          pool:

          readOnly:

          secretRef:

            name:

          user:

        scaleIO:

          fsType:

          gateway:

          protectionDomain:

          readOnly:

          secretRef:

            name:

          sslEnabled:

          storageMode:

          storagePool:

          system:

          volumeName:

        secret:

          defaultMode:

          items:

          - key:

            mode:

            path:

          optional:

          secretName:

        storageos:

          fsType:

          readOnly:

          secretRef:

            name:

          volumeName:

          volumeNamespace:

        vsphereVolume:

          fsType:

          storagePolicyID:

          storagePolicyName:

          volumePath:

  test:

  triggers:

  - imageChangeParams:

  -   automatic:

      containerNames:

      - [string]:

      from:

        apiVersion:

        fieldPath:

        kind:

        name:

        namespace:

        resourceVersion:

        uid:

      lastTriggeredImage:

    type:

status:

  availableReplicas:

  conditions:

  - lastTransitionTime:

    lastUpdateTime:

    message:

    reason:

    status:

    type:

  details:

    causes:

    - imageTrigger:

    -   from:

    -     apiVersion:

          fieldPath:

          kind:

          name:

          namespace:

          resourceVersion:

          uid:

      type:

    message:

  latestVersion:

  observedGeneration:

  readyReplicas:

  replicas:

  unavailableReplicas:

  updatedReplicas:

Operations

Create a DeploymentConfig

Create a DeploymentConfig

HTTP request

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

{
  "kind": "DeploymentConfig",
  "apiVersion": "apps.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/apps.openshift.io/v1/deploymentconfigs <<'EOF'
{
  "kind": "DeploymentConfig",
  "apiVersion": "apps.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeploymentConfig

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v1.DeploymentConfig

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create a DeploymentConfig in a namespace

Create a DeploymentConfig

HTTP request

POST /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "DeploymentConfig",
  "apiVersion": "apps.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/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs <<'EOF'
{
  "kind": "DeploymentConfig",
  "apiVersion": "apps.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeploymentConfig

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.DeploymentConfig

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get a DeploymentConfig in a namespace

Read the specified DeploymentConfig

HTTP request

GET /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME

Path parameters

Parameter Description

name

name of the DeploymentConfig

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.

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

export

Should this value be exported. Export strips fields that a user can not specify.

Responses

HTTP Code Schema

200 OK

v1.DeploymentConfig

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get all DeploymentConfigs

List or watch objects of kind DeploymentConfig

HTTP request

GET /apis/apps.openshift.io/v1/deploymentconfigs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/deploymentconfigs

Query parameters

Parameter Description

pretty

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

fieldSelector

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

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

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

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

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

Responses

HTTP Code Schema

200 OK

v1.DeploymentConfigList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Get all DeploymentConfigs in a namespace

List or watch objects of kind DeploymentConfig

HTTP request

GET /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs

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.

fieldSelector

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

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

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

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

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

Responses

HTTP Code Schema

200 OK

v1.DeploymentConfigList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Watch a DeploymentConfig in a namespace

Watch changes to an object of kind DeploymentConfig

HTTP request

GET /apis/apps.openshift.io/v1/watch/namespaces/$NAMESPACE/deploymentconfigs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/watch/namespaces/$NAMESPACE/deploymentconfigs/$NAME

Path parameters

Parameter Description

name

name of the DeploymentConfig

namespace

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

Query parameters

Parameter Description

fieldSelector

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

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

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

pretty

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

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

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

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Watch all DeploymentConfigs

Watch individual changes to a list of DeploymentConfig

HTTP request

GET /apis/apps.openshift.io/v1/watch/deploymentconfigs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/watch/deploymentconfigs

Query parameters

Parameter Description

fieldSelector

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

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

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

pretty

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

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

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

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Watch all DeploymentConfigs in a namespace

Watch individual changes to a list of DeploymentConfig

HTTP request

GET /apis/apps.openshift.io/v1/watch/namespaces/$NAMESPACE/deploymentconfigs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/watch/namespaces/$NAMESPACE/deploymentconfigs

Path parameters

Parameter Description

namespace

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

Query parameters

Parameter Description

fieldSelector

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

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

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

pretty

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

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

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

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Update a DeploymentConfig in a namespace

Replace the specified DeploymentConfig

HTTP request

PUT /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "DeploymentConfig",
  "apiVersion": "apps.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME <<'EOF'
{
  "kind": "DeploymentConfig",
  "apiVersion": "apps.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeploymentConfig

Path parameters

Parameter Description

name

name of the DeploymentConfig

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.DeploymentConfig

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch a DeploymentConfig in a namespace

Partially update the specified DeploymentConfig

HTTP request

PATCH /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'

{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the DeploymentConfig

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.DeploymentConfig

401 Unauthorized

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Delete a DeploymentConfig in a namespace

Delete a DeploymentConfig

HTTP request

DELETE /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  ...
}

Curl request

$ curl -k \
    -X DELETE \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeleteOptions

Path parameters

Parameter Description

name

name of the DeploymentConfig

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.

gracePeriodSeconds

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

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

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.

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Delete all DeploymentConfigs in a namespace

Delete collection of DeploymentConfig

HTTP request

DELETE /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs

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.

fieldSelector

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

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

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

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

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

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create instantiate of a DeploymentConfig in a namespace

Create instantiate of a DeploymentRequest

HTTP request

POST /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/instantiate HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "DeploymentRequest",
  "apiVersion": "apps.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/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/instantiate <<'EOF'
{
  "kind": "DeploymentRequest",
  "apiVersion": "apps.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeploymentRequest

Path parameters

Parameter Description

name

name of the DeploymentRequest

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.DeploymentRequest

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get log of a DeploymentConfig in a namespace

Read log of the specified DeploymentLog

HTTP request

GET /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/log HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/log

Path parameters

Parameter Description

name

name of the DeploymentLog

namespace

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

Query parameters

Parameter Description

container

The container for which to stream logs. Defaults to only container if there is one container in the pod.

follow

Follow if true indicates that the build log should be streamed until the build terminates.

limitBytes

If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.

nowait

NoWait if true causes the call to return immediately even if the deployment is not available yet. Otherwise the server will wait until the deployment has started.

pretty

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

previous

Return previous deployment logs. Defaults to false.

sinceSeconds

A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.

tailLines

If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime

timestamps

If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

version

Version of the deployment for which to view logs.

Responses

HTTP Code Schema

200 OK

v1.DeploymentLog

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create rollback of a DeploymentConfig in a namespace

Create rollback of a DeploymentConfigRollback

HTTP request

POST /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/rollback HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "DeploymentConfigRollback",
  "apiVersion": "apps.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/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/rollback <<'EOF'
{
  "kind": "DeploymentConfigRollback",
  "apiVersion": "apps.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeploymentConfigRollback

Path parameters

Parameter Description

name

name of the DeploymentConfigRollback

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.DeploymentConfigRollback

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get scale of a DeploymentConfig in a namespace

Read scale of the specified Scale

HTTP request

GET /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/scale HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/scale

Path parameters

Parameter Description

name

name of the Scale

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

v1beta1.Scale

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Update scale of a DeploymentConfig in a namespace

Replace scale of the specified Scale

HTTP request

PUT /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/scale HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Scale",
  "apiVersion": "apps.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/scale <<'EOF'
{
  "kind": "Scale",
  "apiVersion": "apps.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1beta1.Scale

Path parameters

Parameter Description

name

name of the Scale

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

v1beta1.Scale

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch scale of a DeploymentConfig in a namespace

Partially update scale of the specified Scale

HTTP request

PATCH /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/scale HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'

{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/scale <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the Scale

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

v1beta1.Scale

401 Unauthorized

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get status of a DeploymentConfig in a namespace

Read status of the specified DeploymentConfig

HTTP request

GET /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/status

Path parameters

Parameter Description

name

name of the DeploymentConfig

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.DeploymentConfig

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Update status of a DeploymentConfig in a namespace

Replace status of the specified DeploymentConfig

HTTP request

PUT /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "DeploymentConfig",
  "apiVersion": "apps.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/status <<'EOF'
{
  "kind": "DeploymentConfig",
  "apiVersion": "apps.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeploymentConfig

Path parameters

Parameter Description

name

name of the DeploymentConfig

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.DeploymentConfig

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch status of a DeploymentConfig in a namespace

Partially update status of the specified DeploymentConfig

HTTP request

PATCH /apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'

{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/apis/apps.openshift.io/v1/namespaces/$NAMESPACE/deploymentconfigs/$NAME/status <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the DeploymentConfig

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.DeploymentConfig

401 Unauthorized

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf