OC-SET-BUILD-HOOK(1)

🎀 NAME ✨

okay bestie, this is the OC SET(1) page for oc set build-hook, straight from the Openshift CLI User Manuals — it literally updates a build hook on a build config. 💅

🛠 SYNOPSIS 💅

oc set build-hook [OPTIONS]

🌸 DESCRIPTION 🦋

Set or remove a build hook on a build config. build hooks are the lil' mechanism that lets behavior get injected into the build process — no cap. ✨

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. important caveat, bestie: 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. periodt. 💀

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). iykyk. 🫶

💅 OPTIONS ✨

• --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="none" — must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.
• --field-manager="kubectl-set" — name of the manager used to track field ownership.
• -f, --filename=[] — filename, directory, or URL to files to use to edit the resource.
• -k, --kustomize="" — process the kustomization directory. This flag can't be used together with -f or -R.
• --local=false — if true, set image will NOT contact api-server but run locally.
• -o, --output="" — output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
• --post-commit=false — if true, set the post-commit build hook on a build config.
• -R, --recursive=false — process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
• --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.
• --show-managed-fields=false — if true, keep the managedFields when printing objects in JSON or YAML format.
• --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⟩].

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

these are inherited from the parent commands, bestie — not invented by this command, iykyk. 💜

• --as="" — username to impersonate for the operation. User could be a regular user or a service account in a namespace.
• --as-group=[] — group to impersonate for the operation, this flag can be repeated to specify multiple groups.
• --as-uid="" — UID to impersonate for the operation.
• --as-user-extra=[] — user extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key.
• --cache-dir="/homeless-shelter/.kube/cache" — default cache directory.
• --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.
• --context="" — the name of the kubeconfig context to use.
• --disable-compression=false — if true, opt-out of response compression for all requests to the server.
• --insecure-skip-tls-verify=false — if true, the server's certificate will not be checked for validity. 🚨 This will make your HTTPS connections insecure.
• --kubeconfig="" — path to the kubeconfig file to use for CLI requests.
• --kuberc="" — path to the kuberc file to use for preferences. This can be disabled by exporting KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off.
• --match-server-version=false — require server version to match client version.
• -n, --namespace="" — if present, the namespace scope for this CLI request.
• --profile="none" — name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex).
• --profile-output="profile.pprof" — name of the file to write the profile to.
• --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.
• -s, --server="" — the address and port of the Kubernetes API server.
• --tls-server-name="" — server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used.
• --token="" — bearer token for authentication to the API server.
• --user="" — the name of the kubeconfig user to use.
• --warnings-as-errors=false — treat warnings received from the server as errors and exit with a non-zero exit code.

🍓 EXAMPLE 🌟

okay here are the examples, copied exactly — no edits, no vibes-only approximations. 💖

# 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"

🧚 SEE ALSO 💜

oc-set(1), — go check that one out too, bestie. 🫶

👑 HISTORY ⭐

June 2016 — ported from the Kubernetes man-doc generator. that's the whole lore. 💀

---

okay bye bestie 💖 this iconic lil' page is from Openshift CLI User Manuals, Openshift, dated June 2016 — mwah, slay. ✨