openshift-cli-set-build-hook man page

openshift cli set build-hook — Update a build hook on a build config


openshift cli 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).


Select all build configs in the namespace
If true, set the entrypoint of the hook container to the given command
-f, --filename=[]
Filename, directory, or URL to file to use to edit the resource.
When using the default output, don't print headers.
-o, --output=""
Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [ ⟨http://golang.org/pkg/text/template/#pk…⟩] and jsonpath template [ ⟨http://releases.k8s.io/release-1.3/docs…⟩].
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
If true, set the post-commit build hook on a build config
If true, remove the build hook.
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.)
When printing, show all labels as the last column (default hide labels column)
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 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/#pk…⟩].

Options Inherited from Parent Commands

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

Username to impersonate for the operation.

Path to a cert. file for the certificate authority.

Path to a client certificate file for TLS.

Path to a client key file for TLS.

The name of the kubeconfig cluster to use

Path to the config file to use for CLI requests.

The name of the kubeconfig context to use

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

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

Maximum number of seconds between log flushes

Require server version to match client version

-n, --namespace=""
If present, the namespace scope for this CLI request.

The address and port of the Kubernetes API server

Bearer token for authentication to the API server.

The name of the kubeconfig user to use


# Clear post-commit hook on a build config
openshift cli set build-hook bc/mybuild --post-commit --remove

# Set the post-commit hook to execute a test suite using a new entrypoint
openshift cli 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
openshift cli 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
openshift cli set build-hook bc/mybuild --post-commit  -- arg1 arg2

See Also



June 2016, Ported from the Kubernetes man-doc generator

Referenced By


Explore man page connections for openshift-cli-set-build-hook(1).

Openshift Openshift CLI User Manuals June 2016