v1.BuildConfig

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

Description

Build configurations define a build process for new Docker images. There are three types of builds possible - a Docker build using a Dockerfile, a Source-to-Image build that uses a specially prepared base image that accepts source code that it can make runnable, and a custom build that can run // arbitrary Docker images as a base and accept the build parameters. Builds run on the cluster and on completion are pushed to the Docker registry specified in the “output” section. A build can be triggered via a webhook, when the base image changes, or when a user manually requests a new build be // created.

Each build created by a build configuration is numbered and refers back to its parent configuration. Multiple builds can be triggered at once. Builds that do not have “output” set can be used to test code or run a verification build.

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:
  completionDeadlineSeconds:
  failedBuildsHistoryLimit:
  nodeSelector:
    [string]:
  output:
    imageLabels:
    - name:
      value:
    pushSecret:
      name:
    to:
      apiVersion:
      fieldPath:
      kind:
      name:
      namespace:
      resourceVersion:
      uid:
  postCommit:
    args:
    - [string]:
    command:
    - [string]:
    script:
  resources:
    limits:
      [string]:
    requests:
      [string]:
  revision:
    git:
      author:
        email:
        name:
      commit:
      committer:
        email:
        name:
      message:
    type:
  runPolicy:
  serviceAccount:
  source:
    binary:
      asFile:
    contextDir:
    dockerfile:
    git:
      httpProxy:
      httpsProxy:
      noProxy:
      ref:
      uri:
    images:
    - from:
    -   apiVersion:
        fieldPath:
        kind:
        name:
        namespace:
        resourceVersion:
        uid:
      paths:
      - destinationDir:
        sourcePath:
      pullSecret:
        name:
    secrets:
    - destinationDir:
      secret:
        name:
    sourceSecret:
      name:
    type:
  strategy:
    customStrategy:
      buildAPIVersion:
      env:
      - name:
        value:
        valueFrom:
          configMapKeyRef:
            key:
            name:
            optional:
          fieldRef:
            apiVersion:
            fieldPath:
          resourceFieldRef:
            containerName:
            divisor:
            resource:
          secretKeyRef:
            key:
            name:
            optional:
      exposeDockerSocket:
      forcePull:
      from:
        apiVersion:
        fieldPath:
        kind:
        name:
        namespace:
        resourceVersion:
        uid:
      pullSecret:
        name:
      secrets:
      - mountPath:
        secretSource:
          name:
    dockerStrategy:
      buildArgs:
      - name:
        value:
        valueFrom:
          configMapKeyRef:
            key:
            name:
            optional:
          fieldRef:
            apiVersion:
            fieldPath:
          resourceFieldRef:
            containerName:
            divisor:
            resource:
          secretKeyRef:
            key:
            name:
            optional:
      dockerfilePath:
      env:
      - name:
        value:
        valueFrom:
          configMapKeyRef:
            key:
            name:
            optional:
          fieldRef:
            apiVersion:
            fieldPath:
          resourceFieldRef:
            containerName:
            divisor:
            resource:
          secretKeyRef:
            key:
            name:
            optional:
      forcePull:
      from:
        apiVersion:
        fieldPath:
        kind:
        name:
        namespace:
        resourceVersion:
        uid:
      imageOptimizationPolicy:
      noCache:
      pullSecret:
        name:
    jenkinsPipelineStrategy:
      env:
      - name:
        value:
        valueFrom:
          configMapKeyRef:
            key:
            name:
            optional:
          fieldRef:
            apiVersion:
            fieldPath:
          resourceFieldRef:
            containerName:
            divisor:
            resource:
          secretKeyRef:
            key:
            name:
            optional:
      jenkinsfile:
      jenkinsfilePath:
    sourceStrategy:
      env:
      - name:
        value:
        valueFrom:
          configMapKeyRef:
            key:
            name:
            optional:
          fieldRef:
            apiVersion:
            fieldPath:
          resourceFieldRef:
            containerName:
            divisor:
            resource:
          secretKeyRef:
            key:
            name:
            optional:
      forcePull:
      from:
        apiVersion:
        fieldPath:
        kind:
        name:
        namespace:
        resourceVersion:
        uid:
      incremental:
      pullSecret:
        name:
      runtimeArtifacts:
      - destinationDir:
        sourcePath:
      runtimeImage:
        apiVersion:
        fieldPath:
        kind:
        name:
        namespace:
        resourceVersion:
        uid:
      scripts:
    type:
  successfulBuildsHistoryLimit:
  triggers:
  - bitbucket:
  -   allowEnv:
      secret:
    generic:
      allowEnv:
      secret:
    github:
      allowEnv:
      secret:
    gitlab:
      allowEnv:
      secret:
    imageChange:
      from:
        apiVersion:
        fieldPath:
        kind:
        name:
        namespace:
        resourceVersion:
        uid:
      lastTriggeredImageID:
    type:
status:
  lastVersion:

Operations

Create a BuildConfig

Create a BuildConfig

HTTP request

POST /apis/build.openshift.io/v1/buildconfigs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "BuildConfig",
  "apiVersion": "build.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/build.openshift.io/v1/buildconfigs <<'EOF'
{
  "kind": "BuildConfig",
  "apiVersion": "build.openshift.io/v1",
  ...
}
EOF

HTTP body

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Create a BuildConfig in a namespace

Create a BuildConfig

HTTP request

POST /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "BuildConfig",
  "apiVersion": "build.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/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs <<'EOF'
{
  "kind": "BuildConfig",
  "apiVersion": "build.openshift.io/v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Get a BuildConfig in a namespace

Read the specified BuildConfig

HTTP request

GET /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$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/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Get all BuildConfigs

List or watch objects of kind BuildConfig

HTTP request

GET /apis/build.openshift.io/v1/buildconfigs 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/build.openshift.io/v1/buildconfigs

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

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

Get all BuildConfigs in a namespace

List or watch objects of kind BuildConfig

HTTP request

GET /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs 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/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

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

Watch a BuildConfig in a namespace

Watch changes to an object of kind BuildConfig

HTTP request

GET /apis/build.openshift.io/v1/watch/namespaces/$NAMESPACE/buildconfigs/$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/build.openshift.io/v1/watch/namespaces/$NAMESPACE/buildconfigs/$NAME

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

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

Watch all BuildConfigs

Watch individual changes to a list of BuildConfig

HTTP request

GET /apis/build.openshift.io/v1/watch/buildconfigs 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/build.openshift.io/v1/watch/buildconfigs

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

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

Watch all BuildConfigs in a namespace

Watch individual changes to a list of BuildConfig

HTTP request

GET /apis/build.openshift.io/v1/watch/namespaces/$NAMESPACE/buildconfigs 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/build.openshift.io/v1/watch/namespaces/$NAMESPACE/buildconfigs

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

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

Update a BuildConfig in a namespace

Replace the specified BuildConfig

HTTP request

PUT /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "BuildConfig",
  "apiVersion": "build.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/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME <<'EOF'
{
  "kind": "BuildConfig",
  "apiVersion": "build.openshift.io/v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Patch a BuildConfig in a namespace

Partially update the specified BuildConfig

HTTP request

PATCH /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$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/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

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 BuildConfig in a namespace

Delete a BuildConfig

HTTP request

DELETE /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$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/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Delete all BuildConfigs in a namespace

Delete collection of BuildConfig

HTTP request

DELETE /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs 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/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Create instantiate of a BuildConfig in a namespace

Create instantiate of a BuildRequest

HTTP request

POST /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME/instantiate HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "BuildRequest",
  "apiVersion": "build.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/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME/instantiate <<'EOF'
{
  "kind": "BuildRequest",
  "apiVersion": "build.openshift.io/v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Create instantiatebinary of a BuildConfig in a namespace

Connect POST requests to instantiatebinary of BinaryBuildRequestOptions

HTTP request

POST /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME/instantiatebinary HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X POST \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME/instantiatebinary

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• */*

Create webhooks of a BuildConfig in a namespace

Connect POST requests to webhooks of Build

HTTP request

POST /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME/webhooks HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X POST \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME/webhooks

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• */*

Create webhooks/{path} of a BuildConfig in a namespace

Connect POST requests to webhooks of Build

HTTP request

POST /apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME/webhooks/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X POST \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/build.openshift.io/v1/namespaces/$NAMESPACE/buildconfigs/$NAME/webhooks/$PATH

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• */*