openshift-cli-process man page

openshift cli process — Process a template into list of resources

Synopsis

openshift cli process [Options]

Description

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.

Options

-f, --filename=""
Filename or URL to file to read a template
-l, --labels=""
Label to set in all resources for this template
-o, --output="json"
Output format. One of: describe|json|yaml|name|template|templatefile.
--output-version=""
Output the formatted object with the given version (default api-version).
--parameters=false
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
-t, --template=""
Template string or path to template file to use when -o=template or -o=templatefile. The template format is golang templates [ ⟨http://golang.org/pkg/text/template/#pk…⟩]
-v, --value=[]
Specify a list of key-value pairs (eg. -v FOO=BAR,BAR=FOO) to set/override parameter values

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.

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

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

# Convert template.json file into resource list and pass to create
openshift cli process -f template.json | openshift cli create -f -

# Process template while passing a user-defined label
openshift cli process -f template.json -l name=mytemplate

# Convert stored template into resource list
openshift cli process foo

# Convert stored template into resource list by setting/overriding parameter values
openshift cli process foo PARM1=VALUE1 PARM2=VALUE2

# Convert template stored in different namespace into a resource list
openshift cli process openshift//foo

# Convert template.json into resource list
cat template.json | openshift cli process -f -

See Also

openshift-cli(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-cli(1).

Openshift CLI User Manuals Openshift June 2016