.spec
- Description
-
Spec holds user-settable values for the build controller configuration
- Type
-
object
Property |
Type |
Description |
additionalTrustedCA
|
object
|
AdditionalTrustedCA is a reference to a configmap containing additional CAs that should be trusted for image pushes and pulls during builds. The namespace for this config map is openshift-config.
DEPRECATED: Additional CAs for image pull and push should be set on image.config.openshift.io/cluster instead. |
buildDefaults
|
object
|
BuildDefaults controls the default information for Builds |
buildOverrides
|
object
|
BuildOverrides controls override settings for builds |
.spec.additionalTrustedCA
- Description
-
AdditionalTrustedCA is a reference to a configmap containing additional CAs that should be trusted for image pushes and pulls during builds. The namespace for this config map is openshift-config.
DEPRECATED: Additional CAs for image pull and push should be set on image.config.openshift.io/cluster instead.
- Type
-
object
- Required
-
Property |
Type |
Description |
name
|
string
|
name is the metadata.name of the referenced config map |
.spec.buildDefaults
- Description
-
BuildDefaults controls the default information for Builds
- Type
-
object
Property |
Type |
Description |
defaultProxy
|
object
|
DefaultProxy contains the default proxy settings for all build operations, including image pull/push and source download.
Values can be overrode by setting the HTTP_PROXY , HTTPS_PROXY , and NO_PROXY environment variables in the build config’s strategy. |
env
|
array
|
Env is a set of default environment variables that will be applied to the build if the specified variables do not exist on the build |
env[]
|
object
|
EnvVar represents an environment variable present in a Container. |
gitProxy
|
object
|
GitProxy contains the proxy settings for git operations only. If set, this will override any Proxy settings for all git commands, such as git clone.
Values that are not set here will be inherited from DefaultProxy. |
imageLabels
|
array
|
ImageLabels is a list of docker labels that are applied to the resulting image. User can override a default label by providing a label with the same name in their Build/BuildConfig. |
imageLabels[]
|
object
|
|
resources
|
object
|
Resources defines resource requirements to execute the build. |
.spec.buildDefaults.defaultProxy
- Description
-
DefaultProxy contains the default proxy settings for all build operations, including image pull/push and source download.
Values can be overrode by setting the HTTP_PROXY
, HTTPS_PROXY
, and NO_PROXY
environment variables in the build config’s strategy.
- Type
-
object
Property |
Type |
Description |
httpProxy
|
string
|
httpProxy is the URL of the proxy for HTTP requests. Empty means unset and will not result in an env var. |
httpsProxy
|
string
|
httpsProxy is the URL of the proxy for HTTPS requests. Empty means unset and will not result in an env var. |
noProxy
|
string
|
noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used. Empty means unset and will not result in an env var. |
readinessEndpoints
|
array (string)
|
readinessEndpoints is a list of endpoints used to verify readiness of the proxy. |
trustedCA
|
object
|
trustedCA is a reference to a configmap containing a CA certificate bundle. The trustedCA field should only be consumed by a proxy validator. The validator is responsible for reading the certificate bundle from the required key "ca-bundle.crt", merging it with the system default trust bundle, and writing the merged trust bundle to a configmap named "trusted-ca-bundle" in the "openshift-config-managed" namespace. Clients that expect to make proxy connections must use the trusted-ca-bundle for all HTTPS requests to the proxy, and may use the trusted-ca-bundle for non-proxy HTTPS requests as well.
The namespace for the configmap referenced by trustedCA is "openshift-config". Here is an example configmap (in yaml):
apiVersion: v1 kind: configmap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE----- |
.spec.buildDefaults.defaultProxy.trustedCA
- Description
-
trustedCA is a reference to a configmap containing a CA certificate bundle. The trustedCA field should only be consumed by a proxy validator. The validator is responsible for reading the certificate bundle from the required key "ca-bundle.crt", merging it with the system default trust bundle, and writing the merged trust bundle to a configmap named "trusted-ca-bundle" in the "openshift-config-managed" namespace. Clients that expect to make proxy connections must use the trusted-ca-bundle for all HTTPS requests to the proxy, and may use the trusted-ca-bundle for non-proxy HTTPS requests as well.
The namespace for the configmap referenced by trustedCA is "openshift-config". Here is an example configmap (in yaml):
apiVersion: v1 kind: configmap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----
- Type
-
object
- Required
-
Property |
Type |
Description |
name
|
string
|
name is the metadata.name of the referenced config map |
.spec.buildDefaults.env
- Description
-
Env is a set of default environment variables that will be applied to the build if the specified variables do not exist on the build
- Type
-
array
.spec.buildDefaults.env[]
- Description
-
EnvVar represents an environment variable present in a Container.
- Type
-
object
- Required
-
Property |
Type |
Description |
name
|
string
|
Name of the environment variable. Must be a C_IDENTIFIER. |
value
|
string
|
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
valueFrom
|
object
|
Source for the environment variable’s value. Cannot be used if value is not empty. |
.spec.buildDefaults.env[].valueFrom
- Description
-
Source for the environment variable’s value. Cannot be used if value is not empty.
- Type
-
object
Property |
Type |
Description |
configmapKeyRef
|
object
|
Selects a key of a configmap. |
fieldRef
|
object
|
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'] , metadata.annotations['<KEY>'] , spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
resourceFieldRef
|
object
|
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
secretKeyRef
|
object
|
Selects a key of a secret in the pod’s namespace |
.spec.buildDefaults.env[].valueFrom.configmapKeyRef
- Description
-
Selects a key of a configmap.
- Type
-
object
- Required
-
.spec.buildDefaults.env[].valueFrom.fieldRef
- Description
-
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>']
, metadata.annotations['<KEY>']
, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- Type
-
object
- Required
-
Property |
Type |
Description |
apiVersion
|
string
|
Version of the schema the FieldPath is written in terms of, defaults to "v1". |
fieldPath
|
string
|
Path of the field to select in the specified API version. |
.spec.buildDefaults.env[].valueFrom.resourceFieldRef
- Description
-
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- Type
-
object
- Required
-
Property |
Type |
Description |
containerName
|
string
|
Container name: required for volumes, optional for env vars |
divisor
|
integer-or-string
|
Specifies the output format of the exposed resources, defaults to "1" |
resource
|
string
|
Required: resource to select |
.spec.buildDefaults.env[].valueFrom.secretKeyRef
- Description
-
Selects a key of a secret in the pod’s namespace
- Type
-
object
- Required
-
.spec.buildDefaults.gitProxy
- Description
-
GitProxy contains the proxy settings for git operations only. If set, this will override any Proxy settings for all git commands, such as git clone.
Values that are not set here will be inherited from DefaultProxy.
- Type
-
object
Property |
Type |
Description |
httpProxy
|
string
|
httpProxy is the URL of the proxy for HTTP requests. Empty means unset and will not result in an env var. |
httpsProxy
|
string
|
httpsProxy is the URL of the proxy for HTTPS requests. Empty means unset and will not result in an env var. |
noProxy
|
string
|
noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used. Empty means unset and will not result in an env var. |
readinessEndpoints
|
array (string)
|
readinessEndpoints is a list of endpoints used to verify readiness of the proxy. |
trustedCA
|
object
|
trustedCA is a reference to a configmap containing a CA certificate bundle. The trustedCA field should only be consumed by a proxy validator. The validator is responsible for reading the certificate bundle from the required key "ca-bundle.crt", merging it with the system default trust bundle, and writing the merged trust bundle to a configmap named "trusted-ca-bundle" in the "openshift-config-managed" namespace. Clients that expect to make proxy connections must use the trusted-ca-bundle for all HTTPS requests to the proxy, and may use the trusted-ca-bundle for non-proxy HTTPS requests as well.
The namespace for the configmap referenced by trustedCA is "openshift-config". Here is an example configmap (in yaml):
apiVersion: v1 kind: configmap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE----- |
.spec.buildDefaults.gitProxy.trustedCA
- Description
-
trustedCA is a reference to a configmap containing a CA certificate bundle. The trustedCA field should only be consumed by a proxy validator. The validator is responsible for reading the certificate bundle from the required key "ca-bundle.crt", merging it with the system default trust bundle, and writing the merged trust bundle to a configmap named "trusted-ca-bundle" in the "openshift-config-managed" namespace. Clients that expect to make proxy connections must use the trusted-ca-bundle for all HTTPS requests to the proxy, and may use the trusted-ca-bundle for non-proxy HTTPS requests as well.
The namespace for the configmap referenced by trustedCA is "openshift-config". Here is an example configmap (in yaml):
apiVersion: v1 kind: configmap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----
- Type
-
object
- Required
-
Property |
Type |
Description |
name
|
string
|
name is the metadata.name of the referenced config map |
.spec.buildDefaults.imageLabels
- Description
-
ImageLabels is a list of docker labels that are applied to the resulting image. User can override a default label by providing a label with the same name in their Build/BuildConfig.
- Type
-
array
.spec.buildDefaults.imageLabels[]
- Description
-
- Type
-
object
Property |
Type |
Description |
name
|
string
|
Name defines the name of the label. It must have non-zero length. |
value
|
string
|
Value defines the literal value of the label. |
.spec.buildDefaults.resources
- Description
-
Resources defines resource requirements to execute the build.
- Type
-
object
.spec.buildOverrides
- Description
-
BuildOverrides controls override settings for builds
- Type
-
object
Property |
Type |
Description |
forcePull
|
boolean
|
ForcePull overrides, if set, the equivalent value in the builds, i.e. false disables force pull for all builds, true enables force pull for all builds, independently of what each build specifies itself |
imageLabels
|
array
|
ImageLabels is a list of docker labels that are applied to the resulting image. If user provided a label in their Build/BuildConfig with the same name as one in this list, the user’s label will be overwritten. |
imageLabels[]
|
object
|
|
nodeSelector
|
object (string)
|
NodeSelector is a selector which must be true for the build pod to fit on a node |
tolerations
|
array
|
Tolerations is a list of Tolerations that will override any existing tolerations set on a build pod. |
tolerations[]
|
object
|
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. |
.spec.buildOverrides.imageLabels
- Description
-
ImageLabels is a list of docker labels that are applied to the resulting image. If user provided a label in their Build/BuildConfig with the same name as one in this list, the user’s label will be overwritten.
- Type
-
array
.spec.buildOverrides.imageLabels[]
- Description
-
- Type
-
object
Property |
Type |
Description |
name
|
string
|
Name defines the name of the label. It must have non-zero length. |
value
|
string
|
Value defines the literal value of the label. |
.spec.buildOverrides.tolerations
- Description
-
Tolerations is a list of Tolerations that will override any existing tolerations set on a build pod.
- Type
-
array
.spec.buildOverrides.tolerations[]
- Description
-
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
- Type
-
object
Property |
Type |
Description |
effect
|
string
|
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
key
|
string
|
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
operator
|
string
|
Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
tolerationSeconds
|
integer
|
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
value
|
string
|
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |