NAME¶

oc process - Process a template into list of resources

SYNOPSIS¶

oc process [OPTIONS]

DESCRIPTION¶

Process template into a list of resources specified in a file name or stdin.

Templates allow parameterization of resources prior to being sent to the server for creation or update. Templates have "parameters", which may either be generated on creation or set by the user, as well as metadata describing the template.

The output of the process command is always a list of one or more resources. You may pipe the output to the create command over STDIN (using the '-f -' option) or redirect it to a file.

Process resolves the template on the server, but you may pass --local to parameterize the template locally. When running locally be aware that the version of your client tools will determine what template transformations are supported, rather than the server.

OPTIONS¶

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

-f, --filename=""
Filename or URL to file to read a template

--ignore-unknown-parameters=false
If true, will not stop processing if a provided parameter does not exist in the template.

-l, --labels=""
Label to set in all resources for this template

--local=false
If true process the template locally instead of contacting the server.

-o, --output="json"
Output format. One of: (json, yaml, name, describe, go-template-file, templatefile, template, go-template, jsonpath, jsonpath-file).

-p, --param=[]
Specify a key-value pair (eg. -p FOO=BAR) to set/override a parameter value in the template.

--param-file=[]
File containing template parameter values to set/override in the template.

--parameters=false
If true, do not process but only print available parameters

--raw=false
If true, output the processed template instead of the template's objects. Implied by -o describe

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

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

--cache-dir="/home/abuild/.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.

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

  # Convert the template.json file into a resource list and pass to create


  oc process -f template.json | oc create -f -


  


  # Process a file locally instead of contacting the server


  oc process -f template.json --local -o yaml


  


  # Process template while passing a user-defined label


  oc process -f template.json -l name=mytemplate


  


  # Convert a stored template into a resource list


  oc process foo


  


  # Convert a stored template into a resource list by setting/overriding parameter values


  oc process foo PARM1=VALUE1 PARM2=VALUE2


  


  # Convert a template stored in different namespace into a resource list


  oc process openshift//foo


  


  # Convert template.json into a resource list


  cat template.json | oc process -f -

SEE ALSO¶

oc(1),

HISTORY¶

June 2016, Ported from the Kubernetes man-doc generator