Skip to content

Commit

Permalink
generated: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
smarterclayton committed Dec 1, 2016
1 parent f08173d commit a684052
Show file tree
Hide file tree
Showing 11 changed files with 443 additions and 2 deletions.
46 changes: 46 additions & 0 deletions contrib/completions/bash/oc
Original file line number Diff line number Diff line change
Expand Up @@ -13032,6 +13032,51 @@ _oc_secrets()
noun_aliases=()
}

_oc_serviceaccounts_create-kubeconfig()
{
last_command="oc_serviceaccounts_create-kubeconfig"
commands=()

flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()

flags+=("--with-namespace=")
local_nonpersistent_flags+=("--with-namespace=")
flags+=("--as=")
flags+=("--certificate-authority=")
flags_with_completion+=("--certificate-authority")
flags_completion+=("_filedir")
flags+=("--client-certificate=")
flags_with_completion+=("--client-certificate")
flags_completion+=("_filedir")
flags+=("--client-key=")
flags_with_completion+=("--client-key")
flags_completion+=("_filedir")
flags+=("--cluster=")
flags+=("--config=")
flags_with_completion+=("--config")
flags_completion+=("_filedir")
flags+=("--context=")
flags+=("--insecure-skip-tls-verify")
flags+=("--log-flush-frequency=")
flags+=("--loglevel=")
flags+=("--logspec=")
flags+=("--match-server-version")
flags+=("--namespace=")
two_word_flags+=("-n")
flags+=("--request-timeout=")
flags+=("--server=")
flags+=("--token=")
flags+=("--user=")

must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}

_oc_serviceaccounts_get-token()
{
last_command="oc_serviceaccounts_get-token"
Expand Down Expand Up @@ -13127,6 +13172,7 @@ _oc_serviceaccounts()
{
last_command="oc_serviceaccounts"
commands=()
commands+=("create-kubeconfig")
commands+=("get-token")
commands+=("new-token")

Expand Down
47 changes: 47 additions & 0 deletions contrib/completions/bash/openshift
Original file line number Diff line number Diff line change
Expand Up @@ -17703,6 +17703,52 @@ _openshift_cli_secrets()
noun_aliases=()
}

_openshift_cli_serviceaccounts_create-kubeconfig()
{
last_command="openshift_cli_serviceaccounts_create-kubeconfig"
commands=()

flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()

flags+=("--with-namespace=")
local_nonpersistent_flags+=("--with-namespace=")
flags+=("--as=")
flags+=("--certificate-authority=")
flags_with_completion+=("--certificate-authority")
flags_completion+=("_filedir")
flags+=("--client-certificate=")
flags_with_completion+=("--client-certificate")
flags_completion+=("_filedir")
flags+=("--client-key=")
flags_with_completion+=("--client-key")
flags_completion+=("_filedir")
flags+=("--cluster=")
flags+=("--config=")
flags_with_completion+=("--config")
flags_completion+=("_filedir")
flags+=("--context=")
flags+=("--google-json-key=")
flags+=("--insecure-skip-tls-verify")
flags+=("--log-flush-frequency=")
flags+=("--loglevel=")
flags+=("--logspec=")
flags+=("--match-server-version")
flags+=("--namespace=")
two_word_flags+=("-n")
flags+=("--request-timeout=")
flags+=("--server=")
flags+=("--token=")
flags+=("--user=")

must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}

_openshift_cli_serviceaccounts_get-token()
{
last_command="openshift_cli_serviceaccounts_get-token"
Expand Down Expand Up @@ -17800,6 +17846,7 @@ _openshift_cli_serviceaccounts()
{
last_command="openshift_cli_serviceaccounts"
commands=()
commands+=("create-kubeconfig")
commands+=("get-token")
commands+=("new-token")

Expand Down
46 changes: 46 additions & 0 deletions contrib/completions/zsh/oc
Original file line number Diff line number Diff line change
Expand Up @@ -13193,6 +13193,51 @@ _oc_secrets()
noun_aliases=()
}

_oc_serviceaccounts_create-kubeconfig()
{
last_command="oc_serviceaccounts_create-kubeconfig"
commands=()

flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()

flags+=("--with-namespace=")
local_nonpersistent_flags+=("--with-namespace=")
flags+=("--as=")
flags+=("--certificate-authority=")
flags_with_completion+=("--certificate-authority")
flags_completion+=("_filedir")
flags+=("--client-certificate=")
flags_with_completion+=("--client-certificate")
flags_completion+=("_filedir")
flags+=("--client-key=")
flags_with_completion+=("--client-key")
flags_completion+=("_filedir")
flags+=("--cluster=")
flags+=("--config=")
flags_with_completion+=("--config")
flags_completion+=("_filedir")
flags+=("--context=")
flags+=("--insecure-skip-tls-verify")
flags+=("--log-flush-frequency=")
flags+=("--loglevel=")
flags+=("--logspec=")
flags+=("--match-server-version")
flags+=("--namespace=")
two_word_flags+=("-n")
flags+=("--request-timeout=")
flags+=("--server=")
flags+=("--token=")
flags+=("--user=")

must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}

_oc_serviceaccounts_get-token()
{
last_command="oc_serviceaccounts_get-token"
Expand Down Expand Up @@ -13288,6 +13333,7 @@ _oc_serviceaccounts()
{
last_command="oc_serviceaccounts"
commands=()
commands+=("create-kubeconfig")
commands+=("get-token")
commands+=("new-token")

Expand Down
47 changes: 47 additions & 0 deletions contrib/completions/zsh/openshift
Original file line number Diff line number Diff line change
Expand Up @@ -17864,6 +17864,52 @@ _openshift_cli_secrets()
noun_aliases=()
}

_openshift_cli_serviceaccounts_create-kubeconfig()
{
last_command="openshift_cli_serviceaccounts_create-kubeconfig"
commands=()

flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()

flags+=("--with-namespace=")
local_nonpersistent_flags+=("--with-namespace=")
flags+=("--as=")
flags+=("--certificate-authority=")
flags_with_completion+=("--certificate-authority")
flags_completion+=("_filedir")
flags+=("--client-certificate=")
flags_with_completion+=("--client-certificate")
flags_completion+=("_filedir")
flags+=("--client-key=")
flags_with_completion+=("--client-key")
flags_completion+=("_filedir")
flags+=("--cluster=")
flags+=("--config=")
flags_with_completion+=("--config")
flags_completion+=("_filedir")
flags+=("--context=")
flags+=("--google-json-key=")
flags+=("--insecure-skip-tls-verify")
flags+=("--log-flush-frequency=")
flags+=("--loglevel=")
flags+=("--logspec=")
flags+=("--match-server-version")
flags+=("--namespace=")
two_word_flags+=("-n")
flags+=("--request-timeout=")
flags+=("--server=")
flags+=("--token=")
flags+=("--user=")

must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}

_openshift_cli_serviceaccounts_get-token()
{
last_command="openshift_cli_serviceaccounts_get-token"
Expand Down Expand Up @@ -17961,6 +18007,7 @@ _openshift_cli_serviceaccounts()
{
last_command="openshift_cli_serviceaccounts"
commands=()
commands+=("create-kubeconfig")
commands+=("get-token")
commands+=("new-token")

Expand Down
13 changes: 13 additions & 0 deletions docs/generated/oc_by_example_content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2472,6 +2472,19 @@ Detach secrets from a ServiceAccount
====


== oc serviceaccounts create-kubeconfig
Create a .kubeconfig file for a service account

====
[options="nowrap"]
----
# Create a .kubeconfig for service account 'default'
oc serviceaccounts create-kubeconfig 'default'
----
====


== oc serviceaccounts get-token
Get a token assigned to a service account.

Expand Down
1 change: 1 addition & 0 deletions docs/man/man1/.files_generated_oc
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ oc-secrets-new-sshauth.1
oc-secrets-new.1
oc-secrets-unlink.1
oc-secrets.1
oc-serviceaccounts-create-kubeconfig.1
oc-serviceaccounts-get-token.1
oc-serviceaccounts-new-token.1
oc-serviceaccounts.1
Expand Down
1 change: 1 addition & 0 deletions docs/man/man1/.files_generated_openshift
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,7 @@ openshift-cli-secrets-new-sshauth.1
openshift-cli-secrets-new.1
openshift-cli-secrets-unlink.1
openshift-cli-secrets.1
openshift-cli-serviceaccounts-create-kubeconfig.1
openshift-cli-serviceaccounts-get-token.1
openshift-cli-serviceaccounts-new-token.1
openshift-cli-serviceaccounts.1
Expand Down
120 changes: 120 additions & 0 deletions docs/man/man1/oc-serviceaccounts-create-kubeconfig.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
.TH "OC SERVICEACCOUNTS" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" ""


.SH NAME
.PP
oc serviceaccounts create\-kubeconfig \- Create a .kubeconfig file for a service account


.SH SYNOPSIS
.PP
\fBoc serviceaccounts create\-kubeconfig\fP [OPTIONS]


.SH DESCRIPTION
.PP
Create a .kubeconfig file that will utilize this service account.

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

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


.SH OPTIONS
.PP
\fB\-\-with\-namespace\fP=""
Namespace for this context in .kubeconfig.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-api\-version\fP=""
DEPRECATED: The API version to use when talking to the server

.PP
\fB\-\-as\fP=""
Username to impersonate for the operation

.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority

.PP
\fB\-\-client\-certificate\fP=""
Path to a client certificate file for TLS

.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS

.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use

.PP
\fB\-\-config\fP=""
Path to the config file to use for CLI requests.

.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use

.PP
\fB\-\-google\-json\-key\fP=""
The Google Cloud Platform Service Account JSON Key to use for authentication.

.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

.PP
\fB\-\-log\-flush\-frequency\fP=0
Maximum number of seconds between log flushes

.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version

.PP
\fB\-n\fP, \fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request

.PP
\fB\-\-request\-timeout\fP="0"
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.

.PP
\fB\-\-server\fP=""
The address and port of the Kubernetes API server

.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server

.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use


.SH EXAMPLE
.PP
.RS

.nf
# Create a .kubeconfig for service account 'default'
oc serviceaccounts create\-kubeconfig 'default'

.fi
.RE


.SH SEE ALSO
.PP
\fBoc\-serviceaccounts(1)\fP,


.SH HISTORY
.PP
June 2016, Ported from the Kubernetes man\-doc generator
Loading

0 comments on commit a684052

Please sign in to comment.