Skip to content

Commit

Permalink
Update generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fabianofranz committed Oct 5, 2016
1 parent 5a09a4d commit 1587637
Show file tree
Hide file tree
Showing 465 changed files with 2,472 additions and 4,481 deletions.
288 changes: 134 additions & 154 deletions docs/generated/oadm_by_example_content.adoc

Large diffs are not rendered by default.

766 changes: 359 additions & 407 deletions docs/generated/oc_by_example_content.adoc

Large diffs are not rendered by default.

8 changes: 3 additions & 5 deletions docs/man/man1/oadm-build-chain.1
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ oadm build\-chain \- Output the inputs and dependencies of your builds
Output the inputs and dependencies of your builds

.PP
Supported formats for the generated graph are dot and a human\-readable output.
Tag and namespace are optional and if they are not specified, 'latest' and the
default namespace will be used respectively.
Supported formats for the generated graph are dot and a human\-readable output.Tag and namespace are optional and if they are not specified, 'latest' and thedefault namespace will be used respectively.


.SH OPTIONS
Expand Down Expand Up @@ -112,10 +110,10 @@ default namespace will be used respectively.
.nf
# Build the dependency tree for the 'latest' tag in <image\-stream>
oadm build\-chain <image\-stream>

# Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility
oadm build\-chain <image\-stream>:v2 \-o dot | dot \-T svg \-o deps.svg

# Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace
oadm build\-chain <image\-stream> \-n test \-\-all

Expand Down
8 changes: 1 addition & 7 deletions docs/man/man1/oadm-ca-create-key-pair.1
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,8 @@ Create an RSA key pair and generate PEM\-encoded public/private key files
Example: Creating service account signing and authenticating key files:

.PP
.RS

.nf
CONFIG=openshift.local.config/master
oadm ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key

.fi
.RE
oadm ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key


.SH OPTIONS
Expand Down
59 changes: 16 additions & 43 deletions docs/man/man1/oadm-ca-create-master-certs.1
Original file line number Diff line number Diff line change
Expand Up @@ -16,66 +16,39 @@ oadm ca create\-master\-certs \- Create certificates and keys for a master
Create keys and certificates for a master

.PP
This command creates keys and certs necessary to run a secure master.
It also creates keys, certificates, and configuration necessary for most
related infrastructure components that are clients to the master.
See the related "create\-node\-config" command for generating per\-node config.
This command creates keys and certs necessary to run a secure master.It also creates keys, certificates, and configuration necessary for mostrelated infrastructure components that are clients to the master.See the related "create\-node\-config" command for generating per\-node config.

.PP
All files are expected or created in standard locations under the cert\-dir.

.PP
.RS

.nf
openshift.local.config/master/
ca.{crt,key,serial.txt}
master.server.{crt,key}
openshift\-router.{crt,key,kubeconfig}
admin.{crt,key,kubeconfig}
...

.fi
.RE
ca.{crt,key,serial.txt}
master.server.{crt,key}
openshift\-router.{crt,key,kubeconfig}
admin.{crt,key,kubeconfig}
...

.PP
Note that the certificate authority (CA aka "signer") generated automatically
is self\-signed. In production usage, administrators are more likely to
want to generate signed certificates separately rather than rely on a
generated CA. Alternatively, start with an existing signed CA and
have this command use it to generate valid certificates.
Note that the certificate authority (CA aka "signer") generated automaticallyis self\-signed. In production usage, administrators are more likely towant to generate signed certificates separately rather than rely on agenerated CA. Alternatively, start with an existing signed CA andhave this command use it to generate valid certificates.

.PP
This command would usually only be used once at installation. If you
need to regenerate the master server cert, DO NOT use \-\-overwrite as this
would recreate ALL certs including the CA cert, invalidating any existing
infrastructure or client configuration. Instead, delete/rename the existing
server cert and run the command to fill it in:
This command would usually only be used once at installation. If youneed to regenerate the master server cert, DO NOT use \-\-overwrite as thiswould recreate ALL certs including the CA cert, invalidating any existinginfrastructure or client configuration. Instead, delete/rename the existingserver cert and run the command to fill it in:

.PP
.RS

.nf
mv openshift.local.config/master/master.server.crt{,.old}
oadm ca create\-master\-certs \-\-cert\-dir=... \\
\-\-master=https://internal.master.fqdn:8443 \\
\-\-public\-master=https://external.master.fqdn:8443 \\
\-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local

.fi
.RE
oadm ca create\-master\-certs \-\-cert\-dir=... \\
\-\-master=
\[la]https://internal.master.fqdn:8443\[ra] \\
\-\-public\-master=
\[la]https://external.master.fqdn:8443\[ra] \\
\-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local

.PP
Alternatively, use the related "ca create\-server\-cert" command to explicitly
create a certificate.
Alternatively, use the related "ca create\-server\-cert" command to explicitlycreate a certificate.

.PP
Regardless of \-\-overwrite, the master server key/cert will be updated
if \-\-hostnames does not match the current certificate.
Regardless of \-\-overwrite, .kubeconfig files will be updated every time this
command is run, so always specify \-\-master (and if needed, \-\-public\-master).
This is designed to match the behavior of "start" which rewrites certs/confs
for certain configuration changes.
Regardless of \-\-overwrite, the master server key/cert will be updatedif \-\-hostnames does not match the current certificate.Regardless of \-\-overwrite, .kubeconfig files will be updated every time thiscommand is run, so always specify \-\-master (and if needed, \-\-public\-master).This is designed to match the behavior of "start" which rewrites certs/confsfor certain configuration changes.


.SH OPTIONS
Expand Down
20 changes: 6 additions & 14 deletions docs/man/man1/oadm-ca-create-server-cert.1
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,18 @@ oadm ca create\-server\-cert \- Create a signed server certificate and key
Create a key and server certificate

.PP
Create a key and server certificate valid for the specified hostnames,
signed by the specified CA. These are useful for securing infrastructure
components such as the router, authentication server, etc.
Create a key and server certificate valid for the specified hostnames,signed by the specified CA. These are useful for securing infrastructurecomponents such as the router, authentication server, etc.

.PP
Example: Creating a secure router certificate.

.PP
.RS

.nf
CA=openshift.local.config/master
oadm ca create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\
\-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\
\-\-hostnames='*.cloudapps.example.com' \\
\-\-cert=cloudapps.crt \-\-key=cloudapps.key
cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem

.fi
.RE
oadm ca create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\
\-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\
\-\-hostnames='*.cloudapps.example.com' \\
\-\-cert=cloudapps.crt \-\-key=cloudapps.key
cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem


.SH OPTIONS
Expand Down
11 changes: 5 additions & 6 deletions docs/man/man1/oadm-ca-decrypt.1
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,11 @@ Decrypt data encrypted with "oadm ca encrypt"
.RS

.nf
# Decrypt an encrypted file to a cleartext file:
oadm ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted

# Decrypt from stdin to stdout:
oadm ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted

# Decrypt an encrypted file to a cleartext file:
oadm ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted

# Decrypt from stdin to stdout:
oadm ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted

.fi
.RE
Expand Down
11 changes: 5 additions & 6 deletions docs/man/man1/oadm-ca-encrypt.1
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,11 @@ Encrypt data with AES\-256\-CBC encryption
.RS

.nf
# Encrypt the content of secret.txt with a generated key:
oadm ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted

# Encrypt the content of secret2.txt with an existing key:
oadm ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted

# Encrypt the content of secret.txt with a generated key:
oadm ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted

# Encrypt the content of secret2.txt with an existing key:
oadm ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted

.fi
.RE
Expand Down
14 changes: 7 additions & 7 deletions docs/man/man1/oadm-completion.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ oadm completion \- Output shell completion code for the given shell (bash or zsh

.SH DESCRIPTION
.PP
This command prints shell code which must be evaluated to provide interactive
completion of oadm commands.
This command prints shell code which must be evaluated to provide interactivecompletion of oadm commands.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down Expand Up @@ -91,18 +90,19 @@ completion of oadm commands.
# Generate the oadm completion code for bash
oadm completion bash > bash\_completion.sh
source bash\_completion.sh

# The above example depends on the bash\-completion framework.
It must be sourced before sourcing the openshift cli completion, i.e. on the Mac:

# It must be sourced before sourcing the openshift cli completion,
# i.e. on the Mac:

brew install bash\-completion
source $(brew \-\-prefix)/etc/bash\_completion
oadm completion bash > bash\_completion.sh
source bash\_completion.sh

# In zsh*, the following will load openshift cli zsh completion:
source <(oadm completion zsh)

* zsh completions are only supported in versions of zsh >= 5.2

.fi
Expand Down
1 change: 0 additions & 1 deletion docs/man/man1/oadm-config-current-context.1
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ Displays the current\-context
.RS

.nf

# Display the current\-context
oadm config current\-context

Expand Down
4 changes: 1 addition & 3 deletions docs/man/man1/oadm-config-set-cluster.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ oadm config set\-cluster \- Sets a cluster entry in kubeconfig

.SH DESCRIPTION
.PP
Sets a cluster entry in kubeconfig.
Specifying a name that already exists will merge new fields on top of existing values for those fields.
Sets a cluster entry in kubeconfig.Specifying a name that already exists will merge new fields on top of existing values for those fields.


.SH OPTIONS
Expand Down Expand Up @@ -94,7 +93,6 @@ Specifying a name that already exists will merge new fields on top of existing v
.RS

.nf

# Set only the server field on the e2e cluster entry without touching other values.
oadm config set\-cluster e2e \-\-server=https://1.2.3.4

Expand Down
4 changes: 1 addition & 3 deletions docs/man/man1/oadm-config-set-context.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ oadm config set\-context \- Sets a context entry in kubeconfig

.SH DESCRIPTION
.PP
Sets a context entry in kubeconfig
Specifying a name that already exists will merge new fields on top of existing values for those fields.
Sets a context entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values for those fields.


.SH OPTIONS
Expand Down Expand Up @@ -90,7 +89,6 @@ Specifying a name that already exists will merge new fields on top of existing v
.RS

.nf

# Set the user field on the gce context entry without touching other values
oadm config set\-context gce \-\-user=cluster\-admin

Expand Down
13 changes: 4 additions & 9 deletions docs/man/man1/oadm-config-set-credentials.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,16 @@ oadm config set\-credentials \- Sets a user entry in kubeconfig

.SH DESCRIPTION
.PP
Sets a user entry in kubeconfig
Specifying a name that already exists will merge new fields on top of existing values.
Sets a user entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values.

.PP
Client\-certificate flags:
\-\-client\-certificate=certfile \-\-client\-key=keyfile
Client\-certificate flags:\-\-client\-certificate=certfile \-\-client\-key=keyfile

.PP
Bearer token flags:
\-\-token=bearer\_token
Bearer token flags:\-\-token=bearer\_token

.PP
Basic auth flags:
\-\-username=basic\_user \-\-password=basic\_password
Basic auth flags:\-\-username=basicuser \-\-password=basicpassword

.PP
Bearer token and basic auth are mutually exclusive.
Expand Down Expand Up @@ -125,7 +121,6 @@ Bearer token and basic auth are mutually exclusive.
.RS

.nf

# Set only the "client\-key" field on the "cluster\-admin"
# entry, without touching other values:
oadm config set\-credentials cluster\-admin \-\-client\-key=\~/.kube/admin.key
Expand Down
4 changes: 1 addition & 3 deletions docs/man/man1/oadm-config-set.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@ oadm config set \- Sets an individual value in a kubeconfig file

.SH DESCRIPTION
.PP
Sets an individual value in a kubeconfig file
PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
PROPERTY\_VALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used.
Sets an individual value in a kubeconfig filePROPERTYNAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.PROPERTYVALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used.


.SH OPTIONS
Expand Down
3 changes: 1 addition & 2 deletions docs/man/man1/oadm-config-unset.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ oadm config unset \- Unsets an individual value in a kubeconfig file

.SH DESCRIPTION
.PP
Unsets an individual value in a kubeconfig file
PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
Unsets an individual value in a kubeconfig filePROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
1 change: 0 additions & 1 deletion docs/man/man1/oadm-config-view.1
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,6 @@ You can use \-\-output jsonpath={...} to extract specific values using a jsonpat
.RS

.nf

# Show Merged kubeconfig settings.
oadm config view

Expand Down
4 changes: 1 addition & 3 deletions docs/man/man1/oadm-config.1
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ oadm config \- Change configuration files for the client
Manage the client config files

.PP
The client stores configuration in the current user's home directory (under the .kube directory as
config). When you login the first time, a new config file is created, and subsequent project changes with the
'project' command will set the current context. These subcommands allow you to manage the config directly.
The client stores configuration in the current user's home directory (under the .kube directory asconfig). When you login the first time, a new config file is created, and subsequent project changes with the'project' command will set the current context. These subcommands allow you to manage the config directly.

.PP
Reference:
Expand Down
6 changes: 2 additions & 4 deletions docs/man/man1/oadm-cordon.1
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,8 @@ Mark node as unschedulable.
.RS

.nf

# Mark node "foo" as unschedulable.
oadm cordon foo

# Mark node "foo" as unschedulable.
oadm cordon foo

.fi
.RE
Expand Down
4 changes: 1 addition & 3 deletions docs/man/man1/oadm-create-api-client-config.1
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ oadm create\-api\-client\-config \- Create a config file for connecting to the s
Create a client configuration for connecting to the server

.PP
This command creates a folder containing a client certificate, a client key,
a server certificate authority, and a .kubeconfig file for connecting to the
master as the provided user.
This command creates a folder containing a client certificate, a client key,a server certificate authority, and a .kubeconfig file for connecting to themaster as the provided user.


.SH OPTIONS
Expand Down
17 changes: 4 additions & 13 deletions docs/man/man1/oadm-create-error-template.1
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,15 @@ oadm create\-error\-template \- Create an error page template
Create a template for customizing the error page

.PP
This command creates a basic template to use as a starting point for
customizing the authentication error page. Save the output to a file and edit
the template to change the look and feel or add content.
This command creates a basic template to use as a starting point forcustomizing the authentication error page. Save the output to a file and editthe template to change the look and feel or add content.

.PP
To use the template, set oauthConfig.templates.error in the master
configuration to point to the template file. For example,
To use the template, set oauthConfig.templates.error in the masterconfiguration to point to the template file. For example,

.PP
.RS

.nf
oauthConfig:
templates:
error: templates/error.html

.fi
.RE
templates:
error: templates/error.html


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
Loading

0 comments on commit 1587637

Please sign in to comment.