oc-set-triggers man page

oc set triggers — Update the triggers on one or more objects

Synopsis

oc set triggers [Options]

Description

Set or remove triggers

Build configs, deployment configs, and most Kubernetes workload objects may have a set of triggers that result in a new deployment or build being created when an image changes. This command enables you to alter those triggers - making them automatic or manual, adding new entries, or changing existing entries.

Deployments support triggering off of image changes and on config changes. Config changes are any alterations to the pod template, while image changes will result in the container image value being updated whenever an image stream tag is updated. You may also trigger Kubernetes stateful sets, daemon sets, deployments, and cron jobs from images. Disabling the config change trigger is equivalent to pausing most objects. Deployment configs will not perform their first deployment until all image change triggers have been submitted.

Build configs support triggering off of image changes, config changes, and webhooks. The config change trigger for a build config will only trigger the first build.

Options

--all=false

If true, select all resources in the namespace of the specified resource types

--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.

--auto=false

If true, enable all triggers, or just the specified trigger

-c, --containers=""

Comma delimited list of container names this trigger applies to on deployments; defaults to the name of the only container

--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.

--from-bitbucket=false

If true, a Bitbucket webhook - a secret value will be generated automatically

--from-config=false

If set, configuration changes will result in a change

--from-github=false

If true, a GitHub webhook - a secret value will be generated automatically

--from-gitlab=false

If true, a GitLab webhook - a secret value will be generated automatically

--from-image=""

An image stream tag to trigger off of

--from-webhook=false

If true, a generic webhook - a secret value will be generated automatically

--from-webhook-allow-env=false

If true, a generic webhook which can provide environment variables - a secret value will be generated automatically

--local=false

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

--manual=false

If true, set all triggers to manual, or just the specified trigger

--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⟩].

--remove=false

If true, remove the specified trigger(s).

--remove-all=false

If true, remove all triggers.

-l, --selector=""

Selector (label query) to filter on

-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⟩].

Options Inherited from Parent Commands

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

Example

  # Print the triggers on the registry
  oc set triggers dc/registry
  
  # Set all triggers to manual
  oc set triggers dc/registry --manual
  
  # Enable all automatic triggers
  oc set triggers dc/registry --auto
  
  # Reset the GitHub webhook on a build to a new, generated secret
  oc set triggers bc/webapp --from-github
  oc set triggers bc/webapp --from-webhook
  
  # Remove all triggers
  oc set triggers bc/webapp --remove-all
  
  # Stop triggering on config change
  oc set triggers dc/registry --from-config --remove
  
  # Add an image trigger to a build config
  oc set triggers bc/webapp --from-image=namespace1/image:latest
  
  # Add an image trigger to a stateful set on the main container
  oc set triggers statefulset/db --from-image=namespace1/image:latest -c main

See Also

oc-set(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

oc-set(1).

Openshift CLI User Manuals June 2016