docs

openshift · Oct 5, 2016 · d8e41d3 · d8e41d3
1 parent 1052e80
commit d8e41d3
Show file tree

Hide file tree

Showing 399 changed files with 2,279 additions and 3,239 deletions.
diff --git a/docs/generated/oadm_by_example_content.adoc b/docs/generated/oadm_by_example_content.adoc
diff --git a/docs/generated/oc_by_example_content.adoc b/docs/generated/oc_by_example_content.adoc
diff --git a/docs/man/man1/oadm-build-chain.1 b/docs/man/man1/oadm-build-chain.1
@@ -16,7 +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
@@ -110,10 +110,10 @@ Supported formats for the generated graph are dot and a human\-readable output.
 .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
 

diff --git a/docs/man/man1/oadm-ca-create-key-pair.1 b/docs/man/man1/oadm-ca-create-key-pair.1
@@ -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

diff --git a/docs/man/man1/oadm-ca-create-master-certs.1 b/docs/man/man1/oadm-ca-create-master-certs.1
@@ -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

diff --git a/docs/man/man1/oadm-ca-create-server-cert.1 b/docs/man/man1/oadm-ca-create-server-cert.1
@@ -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

diff --git a/docs/man/man1/oadm-ca-decrypt.1 b/docs/man/man1/oadm-ca-decrypt.1
@@ -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

diff --git a/docs/man/man1/oadm-ca-encrypt.1 b/docs/man/man1/oadm-ca-encrypt.1
@@ -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

diff --git a/docs/man/man1/oadm-completion.1 b/docs/man/man1/oadm-completion.1
@@ -13,7 +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
@@ -90,18 +90,19 @@ This command prints shell code which must be evaluated to provide interactive co
   # 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

diff --git a/docs/man/man1/oadm-config.1 b/docs/man/man1/oadm-config.1
@@ -16,7 +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: 

diff --git a/docs/man/man1/oadm-cordon.1 b/docs/man/man1/oadm-cordon.1
@@ -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

diff --git a/docs/man/man1/oadm-create-api-client-config.1 b/docs/man/man1/oadm-create-api-client-config.1
@@ -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

diff --git a/docs/man/man1/oadm-create-error-template.1 b/docs/man/man1/oadm-create-error-template.1
@@ -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

diff --git a/docs/man/man1/oadm-create-key-pair.1 b/docs/man/man1/oadm-create-key-pair.1
@@ -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 create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key
-
-.fi
-.RE
+  oadm create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key
 
 
 .SH OPTIONS

diff --git a/docs/man/man1/oadm-create-kubeconfig.1 b/docs/man/man1/oadm-create-kubeconfig.1
@@ -13,36 +13,36 @@ oadm create\-kubeconfig \- Create a basic .kubeconfig file from client certs
 
 .SH DESCRIPTION
 .PP
-Create's a .kubeconfig file at <\-\-kubeconfig> that looks like this:
+Create's a .kubeconfig file at<\-\-kubeconfig> that looks like this:
 
 .PP
 clusters:
-\- cluster:
-    certificate\-authority\-data: <contents of --certificate-authority>
-    server: <\-\-master>
+  \- cluster:
+  certificate\-authority\-data: <contents of --certificate-authority>
+  server: <\-\-master>
   name: <\-\-cluster>
-\- cluster:
-    certificate\-authority\-data: <contents of --certificate-authority>
-    server: <\-\-public\-master>
+  \- cluster:
+  certificate\-authority\-data: <contents of --certificate-authority>
+  server: <\-\-public\-master>
   name: public\-<\-\-cluster>
-contexts:
-\- context:
-    cluster: <\-\-cluster>
-    user: <\-\-user>
-    namespace: <\-\-namespace>
+  contexts:
+  \- context:
+  cluster: <\-\-cluster>
+  user: <\-\-user>
+  namespace: <\-\-namespace>
   name: <\-\-context>
-\- context:
-    cluster: public\-<\-\-cluster>
-    user: <\-\-user>
-    namespace: <\-\-namespace>
+  \- context:
+  cluster: public\-<\-\-cluster>
+  user: <\-\-user>
+  namespace: <\-\-namespace>
   name: public\-<\-\-context>
-current\-context: <\-\-context>
-kind: Config
-users:
-\- name: <\-\-user>
+  current\-context: <\-\-context>
+  kind: Config
+  users:
+  \- name: <\-\-user>
   user:
-    client\-certificate\-data: <contents of --client-certificate>
-    client\-key\-data: <contents of --client-key>
+  client\-certificate\-data: <contents of --client-certificate>
+  client\-key\-data: <contents of --client-key>
 
 
 .SH OPTIONS

diff --git a/docs/man/man1/oadm-create-login-template.1 b/docs/man/man1/oadm-create-login-template.1
@@ -16,25 +16,15 @@ oadm create\-login\-template \- Create a login template
 Create a template for customizing the login page
 
 .PP
-This command creates a basic template to use as a starting point for
-customizing the login page. Save the output to a file and edit the template to
-change the look and feel or add content. Be careful not to remove any parameter
-values inside curly braces.
+This command creates a basic template to use as a starting point forcustomizing the login page. Save the output to a file and edit the template tochange the look and feel or add content. Be careful not to remove any parametervalues inside curly braces.
 
 .PP
-To use the template, set oauthConfig.templates.login in the master
-configuration to point to the template file. For example,
+To use the template, set oauthConfig.templates.login in the masterconfiguration to point to the template file. For example,
 
 .PP
-.RS
-
-.nf
 oauthConfig:
-  templates:
-    login: templates/login.html
-
-.fi
-.RE
+    templates:
+      login: templates/login.html
 
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS