Skip to content

Commit 4b0a081

Browse files
generated: CLI docs and completions
1 parent 5a4e351 commit 4b0a081

File tree

7 files changed

+31
-0
lines changed

7 files changed

+31
-0
lines changed

contrib/completions/bash/oc

+2
Original file line numberDiff line numberDiff line change
@@ -12405,6 +12405,8 @@ _oc_process()
1240512405
flags+=("--labels=")
1240612406
two_word_flags+=("-l")
1240712407
local_nonpersistent_flags+=("--labels=")
12408+
flags+=("--local")
12409+
local_nonpersistent_flags+=("--local")
1240812410
flags+=("--output=")
1240912411
two_word_flags+=("-o")
1241012412
local_nonpersistent_flags+=("--output=")

contrib/completions/bash/openshift

+2
Original file line numberDiff line numberDiff line change
@@ -17514,6 +17514,8 @@ _openshift_cli_process()
1751417514
flags+=("--labels=")
1751517515
two_word_flags+=("-l")
1751617516
local_nonpersistent_flags+=("--labels=")
17517+
flags+=("--local")
17518+
local_nonpersistent_flags+=("--local")
1751717519
flags+=("--output=")
1751817520
two_word_flags+=("-o")
1751917521
local_nonpersistent_flags+=("--output=")

contrib/completions/zsh/oc

+2
Original file line numberDiff line numberDiff line change
@@ -12553,6 +12553,8 @@ _oc_process()
1255312553
flags+=("--labels=")
1255412554
two_word_flags+=("-l")
1255512555
local_nonpersistent_flags+=("--labels=")
12556+
flags+=("--local")
12557+
local_nonpersistent_flags+=("--local")
1255612558
flags+=("--output=")
1255712559
two_word_flags+=("-o")
1255812560
local_nonpersistent_flags+=("--output=")

contrib/completions/zsh/openshift

+2
Original file line numberDiff line numberDiff line change
@@ -17662,6 +17662,8 @@ _openshift_cli_process()
1766217662
flags+=("--labels=")
1766317663
two_word_flags+=("-l")
1766417664
local_nonpersistent_flags+=("--labels=")
17665+
flags+=("--local")
17666+
local_nonpersistent_flags+=("--local")
1766517667
flags+=("--output=")
1766617668
two_word_flags+=("-o")
1766717669
local_nonpersistent_flags+=("--output=")

docs/generated/oc_by_example_content.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -2115,6 +2115,9 @@ Process a template into list of resources
21152115
# Convert template.json file into resource list and pass to create
21162116
oc process -f template.json | oc create -f -
21172117
2118+
# Process a file locally instead of contacting the server
2119+
oc process -f template.json --local -o yaml
2120+
21182121
# Process template while passing a user-defined label
21192122
oc process -f template.json -l name=mytemplate
21202123

docs/man/man1/oc-process.1

+10
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ Templates allow parameterization of resources prior to being sent to the server
2121
.PP
2222
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.
2323

24+
.PP
25+
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.
26+
2427

2528
.SH OPTIONS
2629
.PP
@@ -31,6 +34,10 @@ The output of the process command is always a list of one or more resources. You
3134
\fB\-l\fP, \fB\-\-labels\fP=""
3235
Label to set in all resources for this template
3336

37+
.PP
38+
\fB\-\-local\fP=false
39+
If true process the template locally instead of contacting the server.
40+
3441
.PP
3542
\fB\-o\fP, \fB\-\-output\fP="json"
3643
Output format. One of: describe|json|yaml|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=...
@@ -143,6 +150,9 @@ The output of the process command is always a list of one or more resources. You
143150
# Convert template.json file into resource list and pass to create
144151
oc process \-f template.json | oc create \-f \-
145152

153+
# Process a file locally instead of contacting the server
154+
oc process \-f template.json \-\-local \-o yaml
155+
146156
# Process template while passing a user\-defined label
147157
oc process \-f template.json \-l name=mytemplate
148158

docs/man/man1/openshift-cli-process.1

+10
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ Templates allow parameterization of resources prior to being sent to the server
2121
.PP
2222
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.
2323

24+
.PP
25+
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.
26+
2427

2528
.SH OPTIONS
2629
.PP
@@ -31,6 +34,10 @@ The output of the process command is always a list of one or more resources. You
3134
\fB\-l\fP, \fB\-\-labels\fP=""
3235
Label to set in all resources for this template
3336

37+
.PP
38+
\fB\-\-local\fP=false
39+
If true process the template locally instead of contacting the server.
40+
3441
.PP
3542
\fB\-o\fP, \fB\-\-output\fP="json"
3643
Output format. One of: describe|json|yaml|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=...
@@ -143,6 +150,9 @@ The output of the process command is always a list of one or more resources. You
143150
# Convert template.json file into resource list and pass to create
144151
openshift cli process \-f template.json | openshift cli create \-f \-
145152

153+
# Process a file locally instead of contacting the server
154+
openshift cli process \-f template.json \-\-local \-o yaml
155+
146156
# Process template while passing a user\-defined label
147157
openshift cli process \-f template.json \-l name=mytemplate
148158

0 commit comments

Comments
 (0)