oc-process man page

oc process — Process a template into list of resources


oc process [Options]


Process template into a list of resources specified in filename 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.


-f, --filename=""

Filename or URL to file to read a template


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


If true process the template locally instead of contacting the server.

-o, --output="json"

Output format. One of: describe|json|yaml|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...


Output the formatted object with the given version (default api-version).

-p, --param=[]

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


File containing template parameter values to set/override in the template.


If true, do not process but only print available parameters


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

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

-t, --template=""

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

Options Inherited from Parent Commands


Username to impersonate for the operation


Group to impersonate for the operation, this flag can be repeated to specify multiple groups.


Path to the file container Azure container registry configuration information.


Default HTTP cache directory


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


Require server version to match client version

-n, --namespace=""

If present, the namespace scope for this CLI request


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.


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


Print version information and quit


  # Convert template.json file into 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 stored template into resource list
  oc process foo
  # Convert stored template into resource list by setting/overriding parameter values
  oc process foo PARM1=VALUE1 PARM2=VALUE2
  # Convert template stored in different namespace into a resource list
  oc process openshift//foo
  # Convert template.json into resource list
  cat template.json | oc process -f -

See Also



June 2016, Ported from the Kubernetes man-doc generator

Referenced By


Openshift CLI User Manuals June 2016