Skip to content

Commit e1c05f4

Browse files
smarterclaytonsmarterclayton
committed
generated: docs
1 parent a8ce83d commit e1c05f4

11 files changed

+443
-2
lines changed

‎contrib/completions/bash/oc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13032,6 +13032,51 @@ _oc_secrets()
1303213032
noun_aliases=()
1303313033
}
1303413034

13035+
_oc_serviceaccounts_create-kubeconfig()
13036+
{
13037+
last_command="oc_serviceaccounts_create-kubeconfig"
13038+
commands=()
13039+
13040+
flags=()
13041+
two_word_flags=()
13042+
local_nonpersistent_flags=()
13043+
flags_with_completion=()
13044+
flags_completion=()
13045+
13046+
flags+=("--with-namespace=")
13047+
local_nonpersistent_flags+=("--with-namespace=")
13048+
flags+=("--as=")
13049+
flags+=("--certificate-authority=")
13050+
flags_with_completion+=("--certificate-authority")
13051+
flags_completion+=("_filedir")
13052+
flags+=("--client-certificate=")
13053+
flags_with_completion+=("--client-certificate")
13054+
flags_completion+=("_filedir")
13055+
flags+=("--client-key=")
13056+
flags_with_completion+=("--client-key")
13057+
flags_completion+=("_filedir")
13058+
flags+=("--cluster=")
13059+
flags+=("--config=")
13060+
flags_with_completion+=("--config")
13061+
flags_completion+=("_filedir")
13062+
flags+=("--context=")
13063+
flags+=("--insecure-skip-tls-verify")
13064+
flags+=("--log-flush-frequency=")
13065+
flags+=("--loglevel=")
13066+
flags+=("--logspec=")
13067+
flags+=("--match-server-version")
13068+
flags+=("--namespace=")
13069+
two_word_flags+=("-n")
13070+
flags+=("--request-timeout=")
13071+
flags+=("--server=")
13072+
flags+=("--token=")
13073+
flags+=("--user=")
13074+
13075+
must_have_one_flag=()
13076+
must_have_one_noun=()
13077+
noun_aliases=()
13078+
}
13079+
1303513080
_oc_serviceaccounts_get-token()
1303613081
{
1303713082
last_command="oc_serviceaccounts_get-token"
@@ -13127,6 +13172,7 @@ _oc_serviceaccounts()
1312713172
{
1312813173
last_command="oc_serviceaccounts"
1312913174
commands=()
13175+
commands+=("create-kubeconfig")
1313013176
commands+=("get-token")
1313113177
commands+=("new-token")
1313213178

‎contrib/completions/bash/openshift

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17703,6 +17703,52 @@ _openshift_cli_secrets()
1770317703
noun_aliases=()
1770417704
}
1770517705

17706+
_openshift_cli_serviceaccounts_create-kubeconfig()
17707+
{
17708+
last_command="openshift_cli_serviceaccounts_create-kubeconfig"
17709+
commands=()
17710+
17711+
flags=()
17712+
two_word_flags=()
17713+
local_nonpersistent_flags=()
17714+
flags_with_completion=()
17715+
flags_completion=()
17716+
17717+
flags+=("--with-namespace=")
17718+
local_nonpersistent_flags+=("--with-namespace=")
17719+
flags+=("--as=")
17720+
flags+=("--certificate-authority=")
17721+
flags_with_completion+=("--certificate-authority")
17722+
flags_completion+=("_filedir")
17723+
flags+=("--client-certificate=")
17724+
flags_with_completion+=("--client-certificate")
17725+
flags_completion+=("_filedir")
17726+
flags+=("--client-key=")
17727+
flags_with_completion+=("--client-key")
17728+
flags_completion+=("_filedir")
17729+
flags+=("--cluster=")
17730+
flags+=("--config=")
17731+
flags_with_completion+=("--config")
17732+
flags_completion+=("_filedir")
17733+
flags+=("--context=")
17734+
flags+=("--google-json-key=")
17735+
flags+=("--insecure-skip-tls-verify")
17736+
flags+=("--log-flush-frequency=")
17737+
flags+=("--loglevel=")
17738+
flags+=("--logspec=")
17739+
flags+=("--match-server-version")
17740+
flags+=("--namespace=")
17741+
two_word_flags+=("-n")
17742+
flags+=("--request-timeout=")
17743+
flags+=("--server=")
17744+
flags+=("--token=")
17745+
flags+=("--user=")
17746+
17747+
must_have_one_flag=()
17748+
must_have_one_noun=()
17749+
noun_aliases=()
17750+
}
17751+
1770617752
_openshift_cli_serviceaccounts_get-token()
1770717753
{
1770817754
last_command="openshift_cli_serviceaccounts_get-token"
@@ -17800,6 +17846,7 @@ _openshift_cli_serviceaccounts()
1780017846
{
1780117847
last_command="openshift_cli_serviceaccounts"
1780217848
commands=()
17849+
commands+=("create-kubeconfig")
1780317850
commands+=("get-token")
1780417851
commands+=("new-token")
1780517852

‎contrib/completions/zsh/oc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13193,6 +13193,51 @@ _oc_secrets()
1319313193
noun_aliases=()
1319413194
}
1319513195

13196+
_oc_serviceaccounts_create-kubeconfig()
13197+
{
13198+
last_command="oc_serviceaccounts_create-kubeconfig"
13199+
commands=()
13200+
13201+
flags=()
13202+
two_word_flags=()
13203+
local_nonpersistent_flags=()
13204+
flags_with_completion=()
13205+
flags_completion=()
13206+
13207+
flags+=("--with-namespace=")
13208+
local_nonpersistent_flags+=("--with-namespace=")
13209+
flags+=("--as=")
13210+
flags+=("--certificate-authority=")
13211+
flags_with_completion+=("--certificate-authority")
13212+
flags_completion+=("_filedir")
13213+
flags+=("--client-certificate=")
13214+
flags_with_completion+=("--client-certificate")
13215+
flags_completion+=("_filedir")
13216+
flags+=("--client-key=")
13217+
flags_with_completion+=("--client-key")
13218+
flags_completion+=("_filedir")
13219+
flags+=("--cluster=")
13220+
flags+=("--config=")
13221+
flags_with_completion+=("--config")
13222+
flags_completion+=("_filedir")
13223+
flags+=("--context=")
13224+
flags+=("--insecure-skip-tls-verify")
13225+
flags+=("--log-flush-frequency=")
13226+
flags+=("--loglevel=")
13227+
flags+=("--logspec=")
13228+
flags+=("--match-server-version")
13229+
flags+=("--namespace=")
13230+
two_word_flags+=("-n")
13231+
flags+=("--request-timeout=")
13232+
flags+=("--server=")
13233+
flags+=("--token=")
13234+
flags+=("--user=")
13235+
13236+
must_have_one_flag=()
13237+
must_have_one_noun=()
13238+
noun_aliases=()
13239+
}
13240+
1319613241
_oc_serviceaccounts_get-token()
1319713242
{
1319813243
last_command="oc_serviceaccounts_get-token"
@@ -13288,6 +13333,7 @@ _oc_serviceaccounts()
1328813333
{
1328913334
last_command="oc_serviceaccounts"
1329013335
commands=()
13336+
commands+=("create-kubeconfig")
1329113337
commands+=("get-token")
1329213338
commands+=("new-token")
1329313339

‎contrib/completions/zsh/openshift

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17864,6 +17864,52 @@ _openshift_cli_secrets()
1786417864
noun_aliases=()
1786517865
}
1786617866

17867+
_openshift_cli_serviceaccounts_create-kubeconfig()
17868+
{
17869+
last_command="openshift_cli_serviceaccounts_create-kubeconfig"
17870+
commands=()
17871+
17872+
flags=()
17873+
two_word_flags=()
17874+
local_nonpersistent_flags=()
17875+
flags_with_completion=()
17876+
flags_completion=()
17877+
17878+
flags+=("--with-namespace=")
17879+
local_nonpersistent_flags+=("--with-namespace=")
17880+
flags+=("--as=")
17881+
flags+=("--certificate-authority=")
17882+
flags_with_completion+=("--certificate-authority")
17883+
flags_completion+=("_filedir")
17884+
flags+=("--client-certificate=")
17885+
flags_with_completion+=("--client-certificate")
17886+
flags_completion+=("_filedir")
17887+
flags+=("--client-key=")
17888+
flags_with_completion+=("--client-key")
17889+
flags_completion+=("_filedir")
17890+
flags+=("--cluster=")
17891+
flags+=("--config=")
17892+
flags_with_completion+=("--config")
17893+
flags_completion+=("_filedir")
17894+
flags+=("--context=")
17895+
flags+=("--google-json-key=")
17896+
flags+=("--insecure-skip-tls-verify")
17897+
flags+=("--log-flush-frequency=")
17898+
flags+=("--loglevel=")
17899+
flags+=("--logspec=")
17900+
flags+=("--match-server-version")
17901+
flags+=("--namespace=")
17902+
two_word_flags+=("-n")
17903+
flags+=("--request-timeout=")
17904+
flags+=("--server=")
17905+
flags+=("--token=")
17906+
flags+=("--user=")
17907+
17908+
must_have_one_flag=()
17909+
must_have_one_noun=()
17910+
noun_aliases=()
17911+
}
17912+
1786717913
_openshift_cli_serviceaccounts_get-token()
1786817914
{
1786917915
last_command="openshift_cli_serviceaccounts_get-token"
@@ -17961,6 +18007,7 @@ _openshift_cli_serviceaccounts()
1796118007
{
1796218008
last_command="openshift_cli_serviceaccounts"
1796318009
commands=()
18010+
commands+=("create-kubeconfig")
1796418011
commands+=("get-token")
1796518012
commands+=("new-token")
1796618013

‎docs/generated/oc_by_example_content.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2472,6 +2472,19 @@ Detach secrets from a ServiceAccount
24722472
====
24732473

24742474

2475+
== oc serviceaccounts create-kubeconfig
2476+
Create a .kubeconfig file for a service account
2477+
2478+
====
2479+
2480+
[options="nowrap"]
2481+
----
2482+
# Create a kubeconfig file for service account 'default'
2483+
oc serviceaccounts create-kubeconfig 'default' > default.kubeconfig
2484+
----
2485+
====
2486+
2487+
24752488
== oc serviceaccounts get-token
24762489
Get a token assigned to a service account.
24772490

‎docs/man/man1/.files_generated_oc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ oc-secrets-new-sshauth.1
201201
oc-secrets-new.1
202202
oc-secrets-unlink.1
203203
oc-secrets.1
204+
oc-serviceaccounts-create-kubeconfig.1
204205
oc-serviceaccounts-get-token.1
205206
oc-serviceaccounts-new-token.1
206207
oc-serviceaccounts.1

‎docs/man/man1/.files_generated_openshift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,7 @@ openshift-cli-secrets-new-sshauth.1
290290
openshift-cli-secrets-new.1
291291
openshift-cli-secrets-unlink.1
292292
openshift-cli-secrets.1
293+
openshift-cli-serviceaccounts-create-kubeconfig.1
293294
openshift-cli-serviceaccounts-get-token.1
294295
openshift-cli-serviceaccounts-new-token.1
295296
openshift-cli-serviceaccounts.1

‎docs/man/man1/oc-serviceaccounts-create-kubeconfig.1

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
.TH "OC SERVICEACCOUNTS" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" ""
2+
3+
4+
.SH NAME
5+
.PP
6+
oc serviceaccounts create\-kubeconfig \- Create a .kubeconfig file for a service account
7+
8+
9+
.SH SYNOPSIS
10+
.PP
11+
\fBoc serviceaccounts create\-kubeconfig\fP [OPTIONS]
12+
13+
14+
.SH DESCRIPTION
15+
.PP
16+
Generate a kubeconfig file that will utilize this service account.
17+
18+
.PP
19+
The .kubeconfig will reference the service account token and use the current server, namespace, and cluster contact info. If the service account has multiple tokens, the first token found will be returned. The generated file will be output to STDOUT.
20+
21+
.PP
22+
Service account API tokens are used by service accounts to authenticate to the API. Client actions using a service account token will be executed as if the service account itself were making the actions.
23+
24+
25+
.SH OPTIONS
26+
.PP
27+
\fB\-\-with\-namespace\fP=""
28+
Namespace for this context in .kubeconfig.
29+
30+
31+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
32+
.PP
33+
\fB\-\-api\-version\fP=""
34+
DEPRECATED: The API version to use when talking to the server
35+
36+
.PP
37+
\fB\-\-as\fP=""
38+
Username to impersonate for the operation
39+
40+
.PP
41+
\fB\-\-certificate\-authority\fP=""
42+
Path to a cert. file for the certificate authority
43+
44+
.PP
45+
\fB\-\-client\-certificate\fP=""
46+
Path to a client certificate file for TLS
47+
48+
.PP
49+
\fB\-\-client\-key\fP=""
50+
Path to a client key file for TLS
51+
52+
.PP
53+
\fB\-\-cluster\fP=""
54+
The name of the kubeconfig cluster to use
55+
56+
.PP
57+
\fB\-\-config\fP=""
58+
Path to the config file to use for CLI requests.
59+
60+
.PP
61+
\fB\-\-context\fP=""
62+
The name of the kubeconfig context to use
63+
64+
.PP
65+
\fB\-\-google\-json\-key\fP=""
66+
The Google Cloud Platform Service Account JSON Key to use for authentication.
67+
68+
.PP
69+
\fB\-\-insecure\-skip\-tls\-verify\fP=false
70+
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
71+
72+
.PP
73+
\fB\-\-log\-flush\-frequency\fP=0
74+
Maximum number of seconds between log flushes
75+
76+
.PP
77+
\fB\-\-match\-server\-version\fP=false
78+
Require server version to match client version
79+
80+
.PP
81+
\fB\-n\fP, \fB\-\-namespace\fP=""
82+
If present, the namespace scope for this CLI request
83+
84+
.PP
85+
\fB\-\-request\-timeout\fP="0"
86+
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.
87+
88+
.PP
89+
\fB\-\-server\fP=""
90+
The address and port of the Kubernetes API server
91+
92+
.PP
93+
\fB\-\-token\fP=""
94+
Bearer token for authentication to the API server
95+
96+
.PP
97+
\fB\-\-user\fP=""
98+
The name of the kubeconfig user to use
99+
100+
101+
.SH EXAMPLE
102+
.PP
103+
.RS
104+
105+
.nf
106+
# Create a kubeconfig file for service account 'default'
107+
oc serviceaccounts create\-kubeconfig 'default' > default.kubeconfig
108+
109+
.fi
110+
.RE
111+
112+
113+
.SH SEE ALSO
114+
.PP
115+
\fBoc\-serviceaccounts(1)\fP,
116+
117+
118+
.SH HISTORY
119+
.PP
120+
June 2016, Ported from the Kubernetes man\-doc generator

0 commit comments

Comments
 (0)