Browse code

generated: docs

Clayton Coleman authored on 2016/12/01 12:15:24
Showing 11 changed files
... ...
@@ -13032,6 +13032,51 @@ _oc_secrets()
13032 13032
     noun_aliases=()
13033 13033
 }
13034 13034
 
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
+
13035 13080
 _oc_serviceaccounts_get-token()
13036 13081
 {
13037 13082
     last_command="oc_serviceaccounts_get-token"
... ...
@@ -13127,6 +13172,7 @@ _oc_serviceaccounts()
13127 13127
 {
13128 13128
     last_command="oc_serviceaccounts"
13129 13129
     commands=()
13130
+    commands+=("create-kubeconfig")
13130 13131
     commands+=("get-token")
13131 13132
     commands+=("new-token")
13132 13133
 
... ...
@@ -17703,6 +17703,52 @@ _openshift_cli_secrets()
17703 17703
     noun_aliases=()
17704 17704
 }
17705 17705
 
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
+
17706 17752
 _openshift_cli_serviceaccounts_get-token()
17707 17753
 {
17708 17754
     last_command="openshift_cli_serviceaccounts_get-token"
... ...
@@ -17800,6 +17846,7 @@ _openshift_cli_serviceaccounts()
17800 17800
 {
17801 17801
     last_command="openshift_cli_serviceaccounts"
17802 17802
     commands=()
17803
+    commands+=("create-kubeconfig")
17803 17804
     commands+=("get-token")
17804 17805
     commands+=("new-token")
17805 17806
 
... ...
@@ -13193,6 +13193,51 @@ _oc_secrets()
13193 13193
     noun_aliases=()
13194 13194
 }
13195 13195
 
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
+
13196 13241
 _oc_serviceaccounts_get-token()
13197 13242
 {
13198 13243
     last_command="oc_serviceaccounts_get-token"
... ...
@@ -13288,6 +13333,7 @@ _oc_serviceaccounts()
13288 13288
 {
13289 13289
     last_command="oc_serviceaccounts"
13290 13290
     commands=()
13291
+    commands+=("create-kubeconfig")
13291 13292
     commands+=("get-token")
13292 13293
     commands+=("new-token")
13293 13294
 
... ...
@@ -17864,6 +17864,52 @@ _openshift_cli_secrets()
17864 17864
     noun_aliases=()
17865 17865
 }
17866 17866
 
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
+
17867 17913
 _openshift_cli_serviceaccounts_get-token()
17868 17914
 {
17869 17915
     last_command="openshift_cli_serviceaccounts_get-token"
... ...
@@ -17961,6 +18007,7 @@ _openshift_cli_serviceaccounts()
17961 17961
 {
17962 17962
     last_command="openshift_cli_serviceaccounts"
17963 17963
     commands=()
17964
+    commands+=("create-kubeconfig")
17964 17965
     commands+=("get-token")
17965 17966
     commands+=("new-token")
17966 17967
 
... ...
@@ -2472,6 +2472,19 @@ Detach secrets from a ServiceAccount
2472 2472
 ====
2473 2473
 
2474 2474
 
2475
+== oc serviceaccounts create-kubeconfig
2476
+Generate 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
+
2475 2488
 == oc serviceaccounts get-token
2476 2489
 Get a token assigned to a service account.
2477 2490
 
... ...
@@ -201,6 +201,7 @@ oc-secrets-new-sshauth.1
201 201
 oc-secrets-new.1
202 202
 oc-secrets-unlink.1
203 203
 oc-secrets.1
204
+oc-serviceaccounts-create-kubeconfig.1
204 205
 oc-serviceaccounts-get-token.1
205 206
 oc-serviceaccounts-new-token.1
206 207
 oc-serviceaccounts.1
... ...
@@ -290,6 +290,7 @@ openshift-cli-secrets-new-sshauth.1
290 290
 openshift-cli-secrets-new.1
291 291
 openshift-cli-secrets-unlink.1
292 292
 openshift-cli-secrets.1
293
+openshift-cli-serviceaccounts-create-kubeconfig.1
293 294
 openshift-cli-serviceaccounts-get-token.1
294 295
 openshift-cli-serviceaccounts-new-token.1
295 296
 openshift-cli-serviceaccounts.1
296 297
new file mode 100644
... ...
@@ -0,0 +1,120 @@
0
+.TH "OC SERVICEACCOUNTS" "1" " Openshift CLI User Manuals" "Openshift" "June 2016"  ""
1
+
2
+
3
+.SH NAME
4
+.PP
5
+oc serviceaccounts create\-kubeconfig \- Generate a kubeconfig file for a service account
6
+
7
+
8
+.SH SYNOPSIS
9
+.PP
10
+\fBoc serviceaccounts create\-kubeconfig\fP [OPTIONS]
11
+
12
+
13
+.SH DESCRIPTION
14
+.PP
15
+Generate a kubeconfig file that will utilize this service account.
16
+
17
+.PP
18
+The kubeconfig file 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.
19
+
20
+.PP
21
+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.
22
+
23
+
24
+.SH OPTIONS
25
+.PP
26
+\fB\-\-with\-namespace\fP=""
27
+    Namespace for this context in .kubeconfig.
28
+
29
+
30
+.SH OPTIONS INHERITED FROM PARENT COMMANDS
31
+.PP
32
+\fB\-\-api\-version\fP=""
33
+    DEPRECATED: The API version to use when talking to the server
34
+
35
+.PP
36
+\fB\-\-as\fP=""
37
+    Username to impersonate for the operation
38
+
39
+.PP
40
+\fB\-\-certificate\-authority\fP=""
41
+    Path to a cert. file for the certificate authority
42
+
43
+.PP
44
+\fB\-\-client\-certificate\fP=""
45
+    Path to a client certificate file for TLS
46
+
47
+.PP
48
+\fB\-\-client\-key\fP=""
49
+    Path to a client key file for TLS
50
+
51
+.PP
52
+\fB\-\-cluster\fP=""
53
+    The name of the kubeconfig cluster to use
54
+
55
+.PP
56
+\fB\-\-config\fP=""
57
+    Path to the config file to use for CLI requests.
58
+
59
+.PP
60
+\fB\-\-context\fP=""
61
+    The name of the kubeconfig context to use
62
+
63
+.PP
64
+\fB\-\-google\-json\-key\fP=""
65
+    The Google Cloud Platform Service Account JSON Key to use for authentication.
66
+
67
+.PP
68
+\fB\-\-insecure\-skip\-tls\-verify\fP=false
69
+    If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
70
+
71
+.PP
72
+\fB\-\-log\-flush\-frequency\fP=0
73
+    Maximum number of seconds between log flushes
74
+
75
+.PP
76
+\fB\-\-match\-server\-version\fP=false
77
+    Require server version to match client version
78
+
79
+.PP
80
+\fB\-n\fP, \fB\-\-namespace\fP=""
81
+    If present, the namespace scope for this CLI request
82
+
83
+.PP
84
+\fB\-\-request\-timeout\fP="0"
85
+    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.
86
+
87
+.PP
88
+\fB\-\-server\fP=""
89
+    The address and port of the Kubernetes API server
90
+
91
+.PP
92
+\fB\-\-token\fP=""
93
+    Bearer token for authentication to the API server
94
+
95
+.PP
96
+\fB\-\-user\fP=""
97
+    The name of the kubeconfig user to use
98
+
99
+
100
+.SH EXAMPLE
101
+.PP
102
+.RS
103
+
104
+.nf
105
+  # Create a kubeconfig file for service account 'default'
106
+  oc serviceaccounts create\-kubeconfig 'default' > default.kubeconfig
107
+
108
+.fi
109
+.RE
110
+
111
+
112
+.SH SEE ALSO
113
+.PP
114
+\fBoc\-serviceaccounts(1)\fP,
115
+
116
+
117
+.SH HISTORY
118
+.PP
119
+June 2016, Ported from the Kubernetes man\-doc generator
... ...
@@ -91,7 +91,7 @@ Service accounts allow system components to access the API.
91 91
 
92 92
 .SH SEE ALSO
93 93
 .PP
94
-\fBoc(1)\fP, \fBoc\-serviceaccounts\-get\-token(1)\fP, \fBoc\-serviceaccounts\-new\-token(1)\fP,
94
+\fBoc(1)\fP, \fBoc\-serviceaccounts\-create\-kubeconfig(1)\fP, \fBoc\-serviceaccounts\-get\-token(1)\fP, \fBoc\-serviceaccounts\-new\-token(1)\fP,
95 95
 
96 96
 
97 97
 .SH HISTORY
98 98
new file mode 100644
... ...
@@ -0,0 +1,120 @@
0
+.TH "OPENSHIFT CLI SERVICEACCOUNTS" "1" " Openshift CLI User Manuals" "Openshift" "June 2016"  ""
1
+
2
+
3
+.SH NAME
4
+.PP
5
+openshift cli serviceaccounts create\-kubeconfig \- Generate a kubeconfig file for a service account
6
+
7
+
8
+.SH SYNOPSIS
9
+.PP
10
+\fBopenshift cli serviceaccounts create\-kubeconfig\fP [OPTIONS]
11
+
12
+
13
+.SH DESCRIPTION
14
+.PP
15
+Generate a kubeconfig file that will utilize this service account.
16
+
17
+.PP
18
+The kubeconfig file 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.
19
+
20
+.PP
21
+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.
22
+
23
+
24
+.SH OPTIONS
25
+.PP
26
+\fB\-\-with\-namespace\fP=""
27
+    Namespace for this context in .kubeconfig.
28
+
29
+
30
+.SH OPTIONS INHERITED FROM PARENT COMMANDS
31
+.PP
32
+\fB\-\-api\-version\fP=""
33
+    DEPRECATED: The API version to use when talking to the server
34
+
35
+.PP
36
+\fB\-\-as\fP=""
37
+    Username to impersonate for the operation
38
+
39
+.PP
40
+\fB\-\-certificate\-authority\fP=""
41
+    Path to a cert. file for the certificate authority
42
+
43
+.PP
44
+\fB\-\-client\-certificate\fP=""
45
+    Path to a client certificate file for TLS
46
+
47
+.PP
48
+\fB\-\-client\-key\fP=""
49
+    Path to a client key file for TLS
50
+
51
+.PP
52
+\fB\-\-cluster\fP=""
53
+    The name of the kubeconfig cluster to use
54
+
55
+.PP
56
+\fB\-\-config\fP=""
57
+    Path to the config file to use for CLI requests.
58
+
59
+.PP
60
+\fB\-\-context\fP=""
61
+    The name of the kubeconfig context to use
62
+
63
+.PP
64
+\fB\-\-google\-json\-key\fP=""
65
+    The Google Cloud Platform Service Account JSON Key to use for authentication.
66
+
67
+.PP
68
+\fB\-\-insecure\-skip\-tls\-verify\fP=false
69
+    If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
70
+
71
+.PP
72
+\fB\-\-log\-flush\-frequency\fP=0
73
+    Maximum number of seconds between log flushes
74
+
75
+.PP
76
+\fB\-\-match\-server\-version\fP=false
77
+    Require server version to match client version
78
+
79
+.PP
80
+\fB\-n\fP, \fB\-\-namespace\fP=""
81
+    If present, the namespace scope for this CLI request
82
+
83
+.PP
84
+\fB\-\-request\-timeout\fP="0"
85
+    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.
86
+
87
+.PP
88
+\fB\-\-server\fP=""
89
+    The address and port of the Kubernetes API server
90
+
91
+.PP
92
+\fB\-\-token\fP=""
93
+    Bearer token for authentication to the API server
94
+
95
+.PP
96
+\fB\-\-user\fP=""
97
+    The name of the kubeconfig user to use
98
+
99
+
100
+.SH EXAMPLE
101
+.PP
102
+.RS
103
+
104
+.nf
105
+  # Create a kubeconfig file for service account 'default'
106
+  openshift cli serviceaccounts create\-kubeconfig 'default' > default.kubeconfig
107
+
108
+.fi
109
+.RE
110
+
111
+
112
+.SH SEE ALSO
113
+.PP
114
+\fBopenshift\-cli\-serviceaccounts(1)\fP,
115
+
116
+
117
+.SH HISTORY
118
+.PP
119
+June 2016, Ported from the Kubernetes man\-doc generator
... ...
@@ -91,7 +91,7 @@ Service accounts allow system components to access the API.
91 91
 
92 92
 .SH SEE ALSO
93 93
 .PP
94
-\fBopenshift\-cli(1)\fP, \fBopenshift\-cli\-serviceaccounts\-get\-token(1)\fP, \fBopenshift\-cli\-serviceaccounts\-new\-token(1)\fP,
94
+\fBopenshift\-cli(1)\fP, \fBopenshift\-cli\-serviceaccounts\-create\-kubeconfig(1)\fP, \fBopenshift\-cli\-serviceaccounts\-get\-token(1)\fP, \fBopenshift\-cli\-serviceaccounts\-new\-token(1)\fP,
95 95
 
96 96
 
97 97
 .SH HISTORY