oc-set-build-hook man page

oc set build-hook [Options]

Set or remove a build hook on a build config

Build hooks allow behavior to be injected into the build process.

A post-commit build hook is executed after a build has committed an image but before the image has been pushed to a registry. It can be used to execute tests on the image and verify it before it is made available in a registry or for any other logic that is needed to execute before the image is pushed to the registry. A new container with the recently built image is launched with the build hook command. If the command or script run by the build hook returns a non-zero exit code, the resulting image will not be pushed to the registry.

The command for a build hook may be specified as a shell script (with the --script argument), as a new entrypoint command on the image with the --command argument, or as a set of arguments to the image's entrypoint (default).

--all=false

If true, select all build configs in the namespace

--allow-missing-template-keys=true

If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.

--command=false

If true, set the entrypoint of the hook container to the given command

--dry-run=false

If true, only print the object that would be sent, without sending it.

-f, --filename=[]

Filename, directory, or URL to file to use to edit the resource.

--local=false

If true, set image will NOT contact api-server but run locally.

--no-headers=false

When using the default or custom-column output format, don't print headers (default print headers).

-o, --output=""

Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [ ⟨http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns⟩], golang template [ ⟨http://golang.org/pkg/text/template/#pkg-overview⟩] and jsonpath template [ ⟨http://kubernetes.io/docs/user-guide/jsonpath⟩].

--post-commit=false

If true, set the post-commit build hook on a build config

--remove=false

If true, remove the build hook.

--script=""

Specify a script to run for the build-hook

-l, --selector=""

Selector (label query) to filter build configs

-a, --show-all=true

When printing, show all resources (false means hide terminated pods.)

--show-labels=false

When printing, show all labels as the last column (default hide labels column)

--sort-by=""

If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.

--template=""

Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [ ⟨http://golang.org/pkg/text/template/#pkg-overview⟩].

--api-version=""

DEPRECATED: The API version to use when talking to the server

--as=""

Username to impersonate for the operation

--azure-container-registry-config=""

Path to the file container Azure container registry configuration information.

--certificate-authority=""

Path to a cert. file for the certificate authority

--client-certificate=""

Path to a client certificate file for TLS

--client-key=""

Path to a client key file for TLS

--cluster=""

The name of the kubeconfig cluster to use

--config=""

Path to the config file to use for CLI requests.

--context=""

The name of the kubeconfig context to use

--google-json-key=""

The Google Cloud Platform Service Account JSON Key to use for authentication.

--insecure-skip-tls-verify=false

If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

--log-flush-frequency=0

Maximum number of seconds between log flushes

--match-server-version=false

Require server version to match client version

-n, --namespace=""

If present, the namespace scope for this CLI request

--request-timeout="0"

The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

--server=""

The address and port of the Kubernetes API server

--token=""

Bearer token for authentication to the API server

--user=""

The name of the kubeconfig user to use

  # Clear post-commit hook on a build config
  oc set build-hook bc/mybuild --post-commit --remove
  
  # Set the post-commit hook to execute a test suite using a new entrypoint
  oc set build-hook bc/mybuild --post-commit --command -- /bin/bash -c /var/lib/test-image.sh
  
  # Set the post-commit hook to execute a shell script
  oc set build-hook bc/mybuild --post-commit --script="/var/lib/test-image.sh param1 param2  /var/lib/done.sh"
  
  # Set the post-commit hook as a set of arguments to the default image entrypoint
  oc set build-hook bc/mybuild --post-commit  -- arg1 arg2

oc-set(1),

June 2016, Ported from the Kubernetes man-doc generator

oc-set(1).