diff --git a/docs/man/man1/oadm-build-chain.1 b/docs/man/man1/oadm-build-chain.1 index 146e50c7ed05..5b903544463f 100644 --- a/docs/man/man1/oadm-build-chain.1 +++ b/docs/man/man1/oadm-build-chain.1 @@ -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 the default namespace will be used respectively. .SH OPTIONS diff --git a/docs/man/man1/oadm-ca-decrypt.1 b/docs/man/man1/oadm-ca-decrypt.1 index 327aede17fff..5870a5042fbe 100644 --- a/docs/man/man1/oadm-ca-decrypt.1 +++ b/docs/man/man1/oadm-ca-decrypt.1 @@ -103,7 +103,7 @@ Decrypt data encrypted with "oadm ca encrypt" .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 diff --git a/docs/man/man1/oadm-ca-encrypt.1 b/docs/man/man1/oadm-ca-encrypt.1 index 306208734959..e0bcca0bcede 100644 --- a/docs/man/man1/oadm-ca-encrypt.1 +++ b/docs/man/man1/oadm-ca-encrypt.1 @@ -107,7 +107,7 @@ Encrypt data with AES\-256\-CBC encryption .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 diff --git a/docs/man/man1/oadm-completion.1 b/docs/man/man1/oadm-completion.1 index 16106186e3b9..abeb283f35f9 100644 --- a/docs/man/man1/oadm-completion.1 +++ b/docs/man/man1/oadm-completion.1 @@ -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 interactive completion of oadm commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-config.1 b/docs/man/man1/oadm-config.1 index 8961b3d2779e..2014280e84e6 100644 --- a/docs/man/man1/oadm-config.1 +++ b/docs/man/man1/oadm-config.1 @@ -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 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. .PP Reference: diff --git a/docs/man/man1/oadm-groups-prune.1 b/docs/man/man1/oadm-groups-prune.1 index dbb7572295c3..6f6949f7527a 100644 --- a/docs/man/man1/oadm-groups-prune.1 +++ b/docs/man/man1/oadm-groups-prune.1 @@ -16,13 +16,7 @@ oadm groups prune \- Prune OpenShift groups referencing missing records on an ex Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm flag. .SH OPTIONS diff --git a/docs/man/man1/oadm-groups-sync.1 b/docs/man/man1/oadm-groups-sync.1 index de0da52b8bde..e28a12b67d86 100644 --- a/docs/man/man1/oadm-groups-sync.1 +++ b/docs/man/man1/oadm-groups-sync.1 @@ -16,13 +16,7 @@ oadm groups sync \- Sync OpenShift groups with records from an external provider Sync OpenShift Groups with records from an external provider. .PP -In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish -to sync and where their records live. For instance, all or some groups may be selected from the current Groups -stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those -stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is -requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run -without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the -LDAP query templates. +In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish to sync and where their records live. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the LDAP query templates. .SH OPTIONS diff --git a/docs/man/man1/oadm-ipfailover.1 b/docs/man/man1/oadm-ipfailover.1 index 9f2b81c98c30..41221a97e96f 100644 --- a/docs/man/man1/oadm-ipfailover.1 +++ b/docs/man/man1/oadm-ipfailover.1 @@ -16,17 +16,10 @@ oadm ipfailover \- Install an IP failover group to a set of nodes Configure or view IP Failover configuration .PP -This command helps to setup an IP failover configuration for the -cluster. An administrator can configure IP failover on an entire -cluster or on a subset of nodes (as defined via a labeled selector). +This command helps to setup an IP failover configuration for the cluster. An administrator can configure IP failover on an entire cluster or on a subset of nodes (as defined via a labeled selector). .PP -If an IP failover configuration does not exist with the given name, -the \-\-create flag can be passed to create a deployment configuration that -will provide IP failover capability. If you are running in production, it is -recommended that the labeled selector for the nodes matches at least 2 nodes -to ensure you have failover protection, and that you provide a \-\-replicas= -value that matches the number of nodes for the given labeled selector. +If an IP failover configuration does not exist with the given name, the \-\-create flag can be passed to create a deployment configuration that will provide IP failover capability. If you are running in production, it is recommended that the labeled selector for the nodes matches at least 2 nodes to ensure you have failover protection, and that you provide a \-\-replicas= value that matches the number of nodes for the given labeled selector. .SH OPTIONS diff --git a/docs/man/man1/oadm-manage-node.1 b/docs/man/man1/oadm-manage-node.1 index 3f2981a363b4..346228149602 100644 --- a/docs/man/man1/oadm-manage-node.1 +++ b/docs/man/man1/oadm-manage-node.1 @@ -19,8 +19,7 @@ Manage nodes This command provides common operations on nodes for administrators. .PP -schedulable: Marking node schedulable will allow pods to be schedulable on the node and - marking node unschedulable will block pods to be scheduled on the node. +schedulable: Marking node schedulable will allow pods to be schedulable on the node and marking node unschedulable will block pods to be scheduled on the node. .PP evacuate: Migrate all/selected pod on the provided nodes. @@ -166,26 +165,26 @@ list\-pods: List all/selected pods on given/selected nodes. It can list the outp .RS .nf - # Block accepting any pods on given nodes - oadm manage\-node \-\-schedulable=false + # Block accepting any pods on given nodes + oadm manage\-node \-\-schedulable=false - # Mark selected nodes as schedulable - oadm manage\-node \-\-selector="" \-\-schedulable=true + # Mark selected nodes as schedulable + oadm manage\-node \-\-selector="" \-\-schedulable=true - # Migrate selected pods - oadm manage\-node \-\-evacuate \-\-pod\-selector="" + # Migrate selected pods + oadm manage\-node \-\-evacuate \-\-pod\-selector="" - # Migrate selected pods, use a grace period of 60 seconds - oadm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" + # Migrate selected pods, use a grace period of 60 seconds + oadm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" - # Migrate selected pods not backed by replication controller - oadm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" + # Migrate selected pods not backed by replication controller + oadm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" - # Show pods that will be migrated - oadm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" + # Show pods that will be migrated + oadm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" - # List all pods on given nodes - oadm manage\-node \-\-list\-pods + # List all pods on given nodes + oadm manage\-node \-\-list\-pods .fi .RE diff --git a/docs/man/man1/oadm-migrate-image-references.1 b/docs/man/man1/oadm-migrate-image-references.1 index 87964dff4eca..fdd8d3f5d7d9 100644 --- a/docs/man/man1/oadm-migrate-image-references.1 +++ b/docs/man/man1/oadm-migrate-image-references.1 @@ -16,34 +16,44 @@ oadm migrate image\-references \- Update embedded Docker image references Migrate references to Docker images .PP -This command updates embedded Docker image references on the server in place. By default it -will update image streams and images, and may be used to update resources with a pod template -(deployments, replication controllers, daemon sets). +This command updates embedded Docker image references on the server in place. By default it will update image streams and images, and may be used to update resources with a pod template (deployments, replication controllers, daemon sets). .PP -References are changed by providing a mapping between a source registry and name and the -desired registry and name. Either name or registry can be set to '*' to change all values. -The registry value "docker.io" is special and will handle any image reference that refers to -the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied -per resource. +References are changed by providing a mapping between a source registry and name and the desired registry and name. Either name or registry can be set to ' *' to change all values. The registry value "docker.io" is special and will handle any image reference that refers to the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied per resource. .PP The following resource types may be migrated by this command: .IP .IP -\(bu images * daemonsets +\(bu buildconfigs +.br .IP -\(bu imagestreams * jobs +\(bu daemonsets +.br .IP -\(bu buildconfigs * replicationcontrollers +\(bu deploymentconfigs +.br .IP -\(bu deploymentconfigs * pods +\(bu images +.br +.IP +\(bu imagestreams +.br +.IP +\(bu jobs +.br +.IP +\(bu pods +.br +.IP +\(bu replicationcontrollers +.br .IP \(bu secrets (docker) +.br .PP -Only images, imagestreams, and secrets are updated by default. Updating images and image -streams requires administrative privileges. +Only images, imagestreams, and secrets are updated by default. Updating images and image streams requires administrative privileges. .SH OPTIONS diff --git a/docs/man/man1/oadm-migrate-storage.1 b/docs/man/man1/oadm-migrate-storage.1 index a99328bc4408..8cd675a831ad 100644 --- a/docs/man/man1/oadm-migrate-storage.1 +++ b/docs/man/man1/oadm-migrate-storage.1 @@ -16,25 +16,16 @@ oadm migrate storage \- Update the stored version of API objects Migrate internal object storage via update .PP -This command invokes an update operation on every API object reachable by the caller. This forces -the server to write to the underlying storage if the object representation has changed. Use this -command to ensure that the most recent storage changes have been applied to all objects (storage -version, storage encoding, any newer object defaults). +This command invokes an update operation on every API object reachable by the caller. This forces the server to write to the underlying storage if the object representation has changed. Use this command to ensure that the most recent storage changes have been applied to all objects (storage version, storage encoding, any newer object defaults). .PP -To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run -the command will output a list of resources that received errors, which you can then re\-run the -command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names -to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped -resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. +To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run the command will output a list of resources that received errors, which you can then re\-run the command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. .PP -By default, events are not migrated since they expire within a very short period of time. If you -have significantly increased the expiration time of events, run a migration with \-\-include=events +By default, events are not migrated since they expire within a very short period of time. If you have significantly increased the expiration time of events, run a migration with \-\-include=events .PP -WARNING: This is a slow command and will put significant load on an API server. It may also - result in significant intra\-cluster traffic. +WARNING: This is a slow command and will put significant load on an API server. It may also result in significant intra\-cluster traffic. .SH OPTIONS diff --git a/docs/man/man1/oadm-new-project.1 b/docs/man/man1/oadm-new-project.1 index 37dbc8a5ded4..4486d75233a4 100644 --- a/docs/man/man1/oadm-new-project.1 +++ b/docs/man/man1/oadm-new-project.1 @@ -16,9 +16,7 @@ oadm new\-project \- Create a new project Create a new project .PP -Use this command to create a project. You may optionally specify metadata about the project, -an admin user (and role, if you want to use a non\-default admin role), and a node selector -to restrict which nodes pods in this project can be scheduled to. +Use this command to create a project. You may optionally specify metadata about the project, an admin user (and role, if you want to use a non\-default admin role), and a node selector to restrict which nodes pods in this project can be scheduled to. .SH OPTIONS diff --git a/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 index 6fa7c4cfb219..77b8282d75fb 100644 --- a/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 @@ -16,9 +16,7 @@ oadm policy reconcile\-cluster\-role\-bindings \- Update cluster role bindings t Update cluster role bindings to match the recommended bootstrap policy .PP -This command will inspect the cluster role bindings against the recommended bootstrap policy. -Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. -This command will not remove any additional cluster role bindings. +This command will inspect the cluster role bindings against the recommended bootstrap policy. Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. This command will not remove any additional cluster role bindings. .PP You can see which recommended cluster role bindings have changed by choosing an output type. diff --git a/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 b/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 index 74bb070b6a88..4d22b870336d 100644 --- a/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 @@ -16,9 +16,7 @@ oadm policy reconcile\-cluster\-roles \- Update cluster roles to match the recom Update cluster roles to match the recommended bootstrap policy .PP -This command will compare cluster roles against the recommended bootstrap policy. Any cluster role -that does not match will be replaced by the recommended bootstrap role. This command will not remove -any additional cluster role. +This command will compare cluster roles against the recommended bootstrap policy. Any cluster role that does not match will be replaced by the recommended bootstrap role. This command will not remove any additional cluster role. .PP Cluster roles with the annotation openshift.io/reconcile\-protect set to "true" are skipped. diff --git a/docs/man/man1/oadm-policy-reconcile-sccs.1 b/docs/man/man1/oadm-policy-reconcile-sccs.1 index a4659b5d134f..bc48baf5c531 100644 --- a/docs/man/man1/oadm-policy-reconcile-sccs.1 +++ b/docs/man/man1/oadm-policy-reconcile-sccs.1 @@ -16,12 +16,7 @@ oadm policy reconcile\-sccs \- Replace cluster SCCs to match the recommended boo Replace cluster SCCs to match the recommended bootstrap policy .PP -This command will inspect the cluster SCCs against the recommended bootstrap SCCs. -Any cluster SCC that does not match will be replaced by the recommended SCC. -This command will not remove any additional cluster SCCs. By default, this command -will not remove additional users and groups that have been granted access to the SCC and -will preserve existing priorities (but will always reconcile unset priorities and the policy -definition). +This command will inspect the cluster SCCs against the recommended bootstrap SCCs. Any cluster SCC that does not match will be replaced by the recommended SCC. This command will not remove any additional cluster SCCs. By default, this command will not remove additional users and groups that have been granted access to the SCC and will preserve existing priorities (but will always reconcile unset priorities and the policy definition). .PP You can see which cluster SCCs have recommended changes by choosing an output type. diff --git a/docs/man/man1/oadm-policy.1 b/docs/man/man1/oadm-policy.1 index f5e485eb6599..0c4ceb71dd6f 100644 --- a/docs/man/man1/oadm-policy.1 +++ b/docs/man/man1/oadm-policy.1 @@ -16,13 +16,10 @@ oadm policy \- Manage policy Manage policy on the cluster .PP -These commands allow you to assign and manage the roles and policies that apply to users. The reconcile -commands allow you to reset and upgrade your system policies to the latest default policies. +These commands allow you to assign and manage the roles and policies that apply to users. The reconcile commands allow you to reset and upgrade your system policies to the latest default policies. .PP -To see more information on roles and policies, use the 'get' and 'describe' commands on the following -resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', -and 'scc'. +To see more information on roles and policies, use the 'get' and 'describe' commands on the following resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', and 'scc'. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-prune-groups.1 b/docs/man/man1/oadm-prune-groups.1 index 7fd3aa8e5e65..3be9f543eb7b 100644 --- a/docs/man/man1/oadm-prune-groups.1 +++ b/docs/man/man1/oadm-prune-groups.1 @@ -16,13 +16,7 @@ oadm prune groups \- Prune OpenShift groups referencing missing records on an ex Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm flag. .SH OPTIONS diff --git a/docs/man/man1/oadm-prune.1 b/docs/man/man1/oadm-prune.1 index 905a0fc987df..78c58c59649e 100644 --- a/docs/man/man1/oadm-prune.1 +++ b/docs/man/man1/oadm-prune.1 @@ -16,8 +16,7 @@ oadm prune \- Remove older versions of resources from the server Remove older versions of resources from the server .PP -The commands here allow administrators to manage the older versions of resources on -the system by removing them. +The commands here allow administrators to manage the older versions of resources on the system by removing them. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-registry.1 b/docs/man/man1/oadm-registry.1 index 21ad9981e92f..b19f0895b8de 100644 --- a/docs/man/man1/oadm-registry.1 +++ b/docs/man/man1/oadm-registry.1 @@ -16,28 +16,16 @@ oadm registry \- Install the integrated Docker registry Install or configure an integrated Docker registry .PP -This command sets up a Docker registry integrated with your cluster to provide notifications when -images are pushed. With no arguments, the command will check for the existing registry service -called 'docker\-registry' and try to create it. If you want to test whether the registry has -been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not -exist. +This command sets up a Docker registry integrated with your cluster to provide notifications when images are pushed. With no arguments, the command will check for the existing registry service called 'docker\-registry' and try to create it. If you want to test whether the registry has been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not exist. .PP -To run a highly available registry, you should be using a remote storage mechanism like an -object store (several are supported by the Docker registry). The default Docker registry image -is configured to accept configuration as environment variables \- refer to the configuration file in -that image for more on setting up alternative storage. Once you've made those changes, you can -pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup -uses a local volume and the data will be lost if you delete the running pod. +To run a highly available registry, you should be using a remote storage mechanism like an object store (several are supported by the Docker registry). The default Docker registry image is configured to accept configuration as environment variables \- refer to the configuration file in that image for more on setting up alternative storage. Once you've made those changes, you can pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup uses a local volume and the data will be lost if you delete the running pod. .PP -If multiple ports are specified using the option \-\-ports, the first specified port will be -chosen for use as the REGISTRY\_HTTP\_ADDR and will be passed to Docker registry. +If multiple ports are specified using the option \-\-ports, the first specified port will be chosen for use as the REGISTRY HTTP ADDR and will be passed to Docker registry. .PP -NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new - installation. Some configuration beyond this command is still required to make - your registry persist data. +NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new installation. Some configuration beyond this command is still required to make your registry persist data. .SH OPTIONS diff --git a/docs/man/man1/oadm-router.1 b/docs/man/man1/oadm-router.1 index 0bd235485e29..c22ae5f3f7fb 100644 --- a/docs/man/man1/oadm-router.1 +++ b/docs/man/man1/oadm-router.1 @@ -16,17 +16,10 @@ oadm router \- Install a router Install or configure a router .PP -This command helps to setup a router to take edge traffic and balance it to -your application. With no arguments, the command will check for an existing router -service called 'router' and create one if it does not exist. If you want to test whether -a router has already been created add the \-\-dry\-run flag and the command will exit with -1 if the registry does not exist. +This command helps to setup a router to take edge traffic and balance it to your application. With no arguments, the command will check for an existing router service called 'router' and create one if it does not exist. If you want to test whether a router has already been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not exist. .PP -If a router does not exist with the given name, this command will -create a deployment configuration and service that will run the router. If you are -running your router in production, you should pass \-\-replicas=2 or higher to ensure -you have failover protection. +If a router does not exist with the given name, this command will create a deployment configuration and service that will run the router. If you are running your router in production, you should pass \-\-replicas=2 or higher to ensure you have failover protection. .SH OPTIONS diff --git a/docs/man/man1/oadm-top-images.1 b/docs/man/man1/oadm-top-images.1 index 67a57775e087..21a15a28c658 100644 --- a/docs/man/man1/oadm-top-images.1 +++ b/docs/man/man1/oadm-top-images.1 @@ -16,8 +16,7 @@ oadm top images \- Show usage statistics for Images Show usage statistics for Images .PP -This command analyzes all the Images managed by the platform and presents current -usage statistics. +This command analyzes all the Images managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-top-imagestreams.1 b/docs/man/man1/oadm-top-imagestreams.1 index c283919b7cd7..3816c877e078 100644 --- a/docs/man/man1/oadm-top-imagestreams.1 +++ b/docs/man/man1/oadm-top-imagestreams.1 @@ -16,8 +16,7 @@ oadm top imagestreams \- Show usage statistics for ImageStreams Show usage statistics for ImageStreams .PP -This command analyzes all the ImageStreams managed by the platform and presents current -usage statistics. +This command analyzes all the ImageStreams managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-top.1 b/docs/man/man1/oadm-top.1 index 41b94b4da541..21e07a3da239 100644 --- a/docs/man/man1/oadm-top.1 +++ b/docs/man/man1/oadm-top.1 @@ -16,8 +16,7 @@ oadm top \- Show usage statistics of resources on the server Show usage statistics of resources on the server .PP -This command analyzes resources managed by the platform and presents current -usage statistics. +This command analyzes resources managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm.1 b/docs/man/man1/oadm.1 index f84a71383bd2..5368fd3b4e26 100644 --- a/docs/man/man1/oadm.1 +++ b/docs/man/man1/oadm.1 @@ -16,8 +16,7 @@ oadm \- Tools for managing a cluster Administrative Commands .PP -Commands for managing a cluster are exposed here. Many administrative -actions involve interaction with the command\-line client as well. +Commands for managing a cluster are exposed here. Many administrative actions involve interaction with the command\-line client as well. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-build-chain.1 b/docs/man/man1/oc-adm-build-chain.1 index c347392697dd..40c4a0f3d1af 100644 --- a/docs/man/man1/oc-adm-build-chain.1 +++ b/docs/man/man1/oc-adm-build-chain.1 @@ -16,9 +16,7 @@ oc adm 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 the default namespace will be used respectively. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-ca-decrypt.1 b/docs/man/man1/oc-adm-ca-decrypt.1 index 9f904b3b0319..6c443fc72fdb 100644 --- a/docs/man/man1/oc-adm-ca-decrypt.1 +++ b/docs/man/man1/oc-adm-ca-decrypt.1 @@ -103,7 +103,7 @@ Decrypt data encrypted with "oc adm ca encrypt" .nf # Decrypt an encrypted file to a cleartext file: oc adm ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted - + # Decrypt from stdin to stdout: oc adm ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted diff --git a/docs/man/man1/oc-adm-ca-encrypt.1 b/docs/man/man1/oc-adm-ca-encrypt.1 index 05a91e51e182..e5fd70a4003c 100644 --- a/docs/man/man1/oc-adm-ca-encrypt.1 +++ b/docs/man/man1/oc-adm-ca-encrypt.1 @@ -107,7 +107,7 @@ Encrypt data with AES\-256\-CBC encryption .nf # Encrypt the content of secret.txt with a generated key: oc adm ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted - + # Encrypt the content of secret2.txt with an existing key: oc adm ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted diff --git a/docs/man/man1/oc-adm-completion.1 b/docs/man/man1/oc-adm-completion.1 index 07447d5bfd13..a7392efa3bb6 100644 --- a/docs/man/man1/oc-adm-completion.1 +++ b/docs/man/man1/oc-adm-completion.1 @@ -13,8 +13,7 @@ oc adm completion \- Output shell completion code for the given shell (bash or z .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of oc adm commands. +This command prints shell code which must be evaluated to provide interactive completion of oc adm commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-config.1 b/docs/man/man1/oc-adm-config.1 index 4e455596efa0..8088b31b968e 100644 --- a/docs/man/man1/oc-adm-config.1 +++ b/docs/man/man1/oc-adm-config.1 @@ -16,9 +16,7 @@ oc adm 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 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. .PP Reference: diff --git a/docs/man/man1/oc-adm-groups-prune.1 b/docs/man/man1/oc-adm-groups-prune.1 index b71202abdd2b..9eefcff42af9 100644 --- a/docs/man/man1/oc-adm-groups-prune.1 +++ b/docs/man/man1/oc-adm-groups-prune.1 @@ -16,13 +16,7 @@ oc adm groups prune \- Prune OpenShift groups referencing missing records on an Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm flag. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-groups-sync.1 b/docs/man/man1/oc-adm-groups-sync.1 index 96392e8f8503..d68943351eb3 100644 --- a/docs/man/man1/oc-adm-groups-sync.1 +++ b/docs/man/man1/oc-adm-groups-sync.1 @@ -16,13 +16,7 @@ oc adm groups sync \- Sync OpenShift groups with records from an external provid Sync OpenShift Groups with records from an external provider. .PP -In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish -to sync and where their records live. For instance, all or some groups may be selected from the current Groups -stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those -stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is -requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run -without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the -LDAP query templates. +In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish to sync and where their records live. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the LDAP query templates. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-ipfailover.1 b/docs/man/man1/oc-adm-ipfailover.1 index c25132502020..a94cb43cd715 100644 --- a/docs/man/man1/oc-adm-ipfailover.1 +++ b/docs/man/man1/oc-adm-ipfailover.1 @@ -16,17 +16,10 @@ oc adm ipfailover \- Install an IP failover group to a set of nodes Configure or view IP Failover configuration .PP -This command helps to setup an IP failover configuration for the -cluster. An administrator can configure IP failover on an entire -cluster or on a subset of nodes (as defined via a labeled selector). +This command helps to setup an IP failover configuration for the cluster. An administrator can configure IP failover on an entire cluster or on a subset of nodes (as defined via a labeled selector). .PP -If an IP failover configuration does not exist with the given name, -the \-\-create flag can be passed to create a deployment configuration that -will provide IP failover capability. If you are running in production, it is -recommended that the labeled selector for the nodes matches at least 2 nodes -to ensure you have failover protection, and that you provide a \-\-replicas= -value that matches the number of nodes for the given labeled selector. +If an IP failover configuration does not exist with the given name, the \-\-create flag can be passed to create a deployment configuration that will provide IP failover capability. If you are running in production, it is recommended that the labeled selector for the nodes matches at least 2 nodes to ensure you have failover protection, and that you provide a \-\-replicas= value that matches the number of nodes for the given labeled selector. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-manage-node.1 b/docs/man/man1/oc-adm-manage-node.1 index 86913ff2640f..b6e3a0175978 100644 --- a/docs/man/man1/oc-adm-manage-node.1 +++ b/docs/man/man1/oc-adm-manage-node.1 @@ -19,8 +19,7 @@ Manage nodes This command provides common operations on nodes for administrators. .PP -schedulable: Marking node schedulable will allow pods to be schedulable on the node and - marking node unschedulable will block pods to be scheduled on the node. +schedulable: Marking node schedulable will allow pods to be schedulable on the node and marking node unschedulable will block pods to be scheduled on the node. .PP evacuate: Migrate all/selected pod on the provided nodes. @@ -166,26 +165,26 @@ list\-pods: List all/selected pods on given/selected nodes. It can list the outp .RS .nf - # Block accepting any pods on given nodes - oc adm manage\-node \-\-schedulable=false + # Block accepting any pods on given nodes + oc adm manage\-node \-\-schedulable=false - # Mark selected nodes as schedulable - oc adm manage\-node \-\-selector="" \-\-schedulable=true + # Mark selected nodes as schedulable + oc adm manage\-node \-\-selector="" \-\-schedulable=true - # Migrate selected pods - oc adm manage\-node \-\-evacuate \-\-pod\-selector="" + # Migrate selected pods + oc adm manage\-node \-\-evacuate \-\-pod\-selector="" - # Migrate selected pods, use a grace period of 60 seconds - oc adm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" + # Migrate selected pods, use a grace period of 60 seconds + oc adm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" - # Migrate selected pods not backed by replication controller - oc adm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" + # Migrate selected pods not backed by replication controller + oc adm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" - # Show pods that will be migrated - oc adm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" + # Show pods that will be migrated + oc adm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" - # List all pods on given nodes - oc adm manage\-node \-\-list\-pods + # List all pods on given nodes + oc adm manage\-node \-\-list\-pods .fi .RE diff --git a/docs/man/man1/oc-adm-migrate-image-references.1 b/docs/man/man1/oc-adm-migrate-image-references.1 index 14386716628a..4f6f783271e7 100644 --- a/docs/man/man1/oc-adm-migrate-image-references.1 +++ b/docs/man/man1/oc-adm-migrate-image-references.1 @@ -16,34 +16,44 @@ oc adm migrate image\-references \- Update embedded Docker image references Migrate references to Docker images .PP -This command updates embedded Docker image references on the server in place. By default it -will update image streams and images, and may be used to update resources with a pod template -(deployments, replication controllers, daemon sets). +This command updates embedded Docker image references on the server in place. By default it will update image streams and images, and may be used to update resources with a pod template (deployments, replication controllers, daemon sets). .PP -References are changed by providing a mapping between a source registry and name and the -desired registry and name. Either name or registry can be set to '*' to change all values. -The registry value "docker.io" is special and will handle any image reference that refers to -the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied -per resource. +References are changed by providing a mapping between a source registry and name and the desired registry and name. Either name or registry can be set to ' *' to change all values. The registry value "docker.io" is special and will handle any image reference that refers to the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied per resource. .PP The following resource types may be migrated by this command: .IP .IP -\(bu images * daemonsets +\(bu buildconfigs +.br .IP -\(bu imagestreams * jobs +\(bu daemonsets +.br .IP -\(bu buildconfigs * replicationcontrollers +\(bu deploymentconfigs +.br .IP -\(bu deploymentconfigs * pods +\(bu images +.br +.IP +\(bu imagestreams +.br +.IP +\(bu jobs +.br +.IP +\(bu pods +.br +.IP +\(bu replicationcontrollers +.br .IP \(bu secrets (docker) +.br .PP -Only images, imagestreams, and secrets are updated by default. Updating images and image -streams requires administrative privileges. +Only images, imagestreams, and secrets are updated by default. Updating images and image streams requires administrative privileges. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-migrate-storage.1 b/docs/man/man1/oc-adm-migrate-storage.1 index 551b586e541b..63aa23263b81 100644 --- a/docs/man/man1/oc-adm-migrate-storage.1 +++ b/docs/man/man1/oc-adm-migrate-storage.1 @@ -16,25 +16,16 @@ oc adm migrate storage \- Update the stored version of API objects Migrate internal object storage via update .PP -This command invokes an update operation on every API object reachable by the caller. This forces -the server to write to the underlying storage if the object representation has changed. Use this -command to ensure that the most recent storage changes have been applied to all objects (storage -version, storage encoding, any newer object defaults). +This command invokes an update operation on every API object reachable by the caller. This forces the server to write to the underlying storage if the object representation has changed. Use this command to ensure that the most recent storage changes have been applied to all objects (storage version, storage encoding, any newer object defaults). .PP -To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run -the command will output a list of resources that received errors, which you can then re\-run the -command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names -to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped -resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. +To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run the command will output a list of resources that received errors, which you can then re\-run the command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. .PP -By default, events are not migrated since they expire within a very short period of time. If you -have significantly increased the expiration time of events, run a migration with \-\-include=events +By default, events are not migrated since they expire within a very short period of time. If you have significantly increased the expiration time of events, run a migration with \-\-include=events .PP -WARNING: This is a slow command and will put significant load on an API server. It may also - result in significant intra\-cluster traffic. +WARNING: This is a slow command and will put significant load on an API server. It may also result in significant intra\-cluster traffic. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-new-project.1 b/docs/man/man1/oc-adm-new-project.1 index 2747db826a90..a2180811337f 100644 --- a/docs/man/man1/oc-adm-new-project.1 +++ b/docs/man/man1/oc-adm-new-project.1 @@ -16,9 +16,7 @@ oc adm new\-project \- Create a new project Create a new project .PP -Use this command to create a project. You may optionally specify metadata about the project, -an admin user (and role, if you want to use a non\-default admin role), and a node selector -to restrict which nodes pods in this project can be scheduled to. +Use this command to create a project. You may optionally specify metadata about the project, an admin user (and role, if you want to use a non\-default admin role), and a node selector to restrict which nodes pods in this project can be scheduled to. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 index 520aae620b6c..27d3c4eab22d 100644 --- a/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 @@ -16,9 +16,7 @@ oc adm policy reconcile\-cluster\-role\-bindings \- Update cluster role bindings Update cluster role bindings to match the recommended bootstrap policy .PP -This command will inspect the cluster role bindings against the recommended bootstrap policy. -Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. -This command will not remove any additional cluster role bindings. +This command will inspect the cluster role bindings against the recommended bootstrap policy. Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. This command will not remove any additional cluster role bindings. .PP You can see which recommended cluster role bindings have changed by choosing an output type. diff --git a/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 b/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 index 0113ab4135c7..27c8109106f1 100644 --- a/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 @@ -16,9 +16,7 @@ oc adm policy reconcile\-cluster\-roles \- Update cluster roles to match the rec Update cluster roles to match the recommended bootstrap policy .PP -This command will compare cluster roles against the recommended bootstrap policy. Any cluster role -that does not match will be replaced by the recommended bootstrap role. This command will not remove -any additional cluster role. +This command will compare cluster roles against the recommended bootstrap policy. Any cluster role that does not match will be replaced by the recommended bootstrap role. This command will not remove any additional cluster role. .PP Cluster roles with the annotation openshift.io/reconcile\-protect set to "true" are skipped. diff --git a/docs/man/man1/oc-adm-policy-reconcile-sccs.1 b/docs/man/man1/oc-adm-policy-reconcile-sccs.1 index 0b6632728617..343cd0bfb61f 100644 --- a/docs/man/man1/oc-adm-policy-reconcile-sccs.1 +++ b/docs/man/man1/oc-adm-policy-reconcile-sccs.1 @@ -16,12 +16,7 @@ oc adm policy reconcile\-sccs \- Replace cluster SCCs to match the recommended b Replace cluster SCCs to match the recommended bootstrap policy .PP -This command will inspect the cluster SCCs against the recommended bootstrap SCCs. -Any cluster SCC that does not match will be replaced by the recommended SCC. -This command will not remove any additional cluster SCCs. By default, this command -will not remove additional users and groups that have been granted access to the SCC and -will preserve existing priorities (but will always reconcile unset priorities and the policy -definition). +This command will inspect the cluster SCCs against the recommended bootstrap SCCs. Any cluster SCC that does not match will be replaced by the recommended SCC. This command will not remove any additional cluster SCCs. By default, this command will not remove additional users and groups that have been granted access to the SCC and will preserve existing priorities (but will always reconcile unset priorities and the policy definition). .PP You can see which cluster SCCs have recommended changes by choosing an output type. diff --git a/docs/man/man1/oc-adm-policy.1 b/docs/man/man1/oc-adm-policy.1 index c250a5baf9ea..3479fc52fb72 100644 --- a/docs/man/man1/oc-adm-policy.1 +++ b/docs/man/man1/oc-adm-policy.1 @@ -16,13 +16,10 @@ oc adm policy \- Manage policy Manage policy on the cluster .PP -These commands allow you to assign and manage the roles and policies that apply to users. The reconcile -commands allow you to reset and upgrade your system policies to the latest default policies. +These commands allow you to assign and manage the roles and policies that apply to users. The reconcile commands allow you to reset and upgrade your system policies to the latest default policies. .PP -To see more information on roles and policies, use the 'get' and 'describe' commands on the following -resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', -and 'scc'. +To see more information on roles and policies, use the 'get' and 'describe' commands on the following resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', and 'scc'. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-prune-groups.1 b/docs/man/man1/oc-adm-prune-groups.1 index 5813d3ebb8e7..cd012b32dfd8 100644 --- a/docs/man/man1/oc-adm-prune-groups.1 +++ b/docs/man/man1/oc-adm-prune-groups.1 @@ -16,13 +16,7 @@ oc adm prune groups \- Prune OpenShift groups referencing missing records on an Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm flag. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-prune.1 b/docs/man/man1/oc-adm-prune.1 index a43671d35db2..c4e9b3ecee98 100644 --- a/docs/man/man1/oc-adm-prune.1 +++ b/docs/man/man1/oc-adm-prune.1 @@ -16,8 +16,7 @@ oc adm prune \- Remove older versions of resources from the server Remove older versions of resources from the server .PP -The commands here allow administrators to manage the older versions of resources on -the system by removing them. +The commands here allow administrators to manage the older versions of resources on the system by removing them. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-registry.1 b/docs/man/man1/oc-adm-registry.1 index d054cb331e3f..0e308c892155 100644 --- a/docs/man/man1/oc-adm-registry.1 +++ b/docs/man/man1/oc-adm-registry.1 @@ -16,28 +16,16 @@ oc adm registry \- Install the integrated Docker registry Install or configure an integrated Docker registry .PP -This command sets up a Docker registry integrated with your cluster to provide notifications when -images are pushed. With no arguments, the command will check for the existing registry service -called 'docker\-registry' and try to create it. If you want to test whether the registry has -been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not -exist. +This command sets up a Docker registry integrated with your cluster to provide notifications when images are pushed. With no arguments, the command will check for the existing registry service called 'docker\-registry' and try to create it. If you want to test whether the registry has been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not exist. .PP -To run a highly available registry, you should be using a remote storage mechanism like an -object store (several are supported by the Docker registry). The default Docker registry image -is configured to accept configuration as environment variables \- refer to the configuration file in -that image for more on setting up alternative storage. Once you've made those changes, you can -pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup -uses a local volume and the data will be lost if you delete the running pod. +To run a highly available registry, you should be using a remote storage mechanism like an object store (several are supported by the Docker registry). The default Docker registry image is configured to accept configuration as environment variables \- refer to the configuration file in that image for more on setting up alternative storage. Once you've made those changes, you can pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup uses a local volume and the data will be lost if you delete the running pod. .PP -If multiple ports are specified using the option \-\-ports, the first specified port will be -chosen for use as the REGISTRY\_HTTP\_ADDR and will be passed to Docker registry. +If multiple ports are specified using the option \-\-ports, the first specified port will be chosen for use as the REGISTRY HTTP ADDR and will be passed to Docker registry. .PP -NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new - installation. Some configuration beyond this command is still required to make - your registry persist data. +NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new installation. Some configuration beyond this command is still required to make your registry persist data. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-router.1 b/docs/man/man1/oc-adm-router.1 index 44a76af4c07d..622d65842694 100644 --- a/docs/man/man1/oc-adm-router.1 +++ b/docs/man/man1/oc-adm-router.1 @@ -16,17 +16,10 @@ oc adm router \- Install a router Install or configure a router .PP -This command helps to setup a router to take edge traffic and balance it to -your application. With no arguments, the command will check for an existing router -service called 'router' and create one if it does not exist. If you want to test whether -a router has already been created add the \-\-dry\-run flag and the command will exit with -1 if the registry does not exist. +This command helps to setup a router to take edge traffic and balance it to your application. With no arguments, the command will check for an existing router service called 'router' and create one if it does not exist. If you want to test whether a router has already been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not exist. .PP -If a router does not exist with the given name, this command will -create a deployment configuration and service that will run the router. If you are -running your router in production, you should pass \-\-replicas=2 or higher to ensure -you have failover protection. +If a router does not exist with the given name, this command will create a deployment configuration and service that will run the router. If you are running your router in production, you should pass \-\-replicas=2 or higher to ensure you have failover protection. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-top-images.1 b/docs/man/man1/oc-adm-top-images.1 index dcb5c37330a3..84ea06c89995 100644 --- a/docs/man/man1/oc-adm-top-images.1 +++ b/docs/man/man1/oc-adm-top-images.1 @@ -16,8 +16,7 @@ oc adm top images \- Show usage statistics for Images Show usage statistics for Images .PP -This command analyzes all the Images managed by the platform and presents current -usage statistics. +This command analyzes all the Images managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-top-imagestreams.1 b/docs/man/man1/oc-adm-top-imagestreams.1 index bf8e9834fe2d..069ef556ba06 100644 --- a/docs/man/man1/oc-adm-top-imagestreams.1 +++ b/docs/man/man1/oc-adm-top-imagestreams.1 @@ -16,8 +16,7 @@ oc adm top imagestreams \- Show usage statistics for ImageStreams Show usage statistics for ImageStreams .PP -This command analyzes all the ImageStreams managed by the platform and presents current -usage statistics. +This command analyzes all the ImageStreams managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-top.1 b/docs/man/man1/oc-adm-top.1 index 98a374a6ca78..5edea37b6e39 100644 --- a/docs/man/man1/oc-adm-top.1 +++ b/docs/man/man1/oc-adm-top.1 @@ -16,8 +16,7 @@ oc adm top \- Show usage statistics of resources on the server Show usage statistics of resources on the server .PP -This command analyzes resources managed by the platform and presents current -usage statistics. +This command analyzes resources managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm.1 b/docs/man/man1/oc-adm.1 index 7ca38b3abd98..a9473dc3b366 100644 --- a/docs/man/man1/oc-adm.1 +++ b/docs/man/man1/oc-adm.1 @@ -16,8 +16,7 @@ oc adm \- Tools for managing a cluster Administrative Commands .PP -Commands for managing a cluster are exposed here. Many administrative -actions involve interaction with the command\-line client as well. +Commands for managing a cluster are exposed here. Many administrative actions involve interaction with the command\-line client as well. .SH OPTIONS diff --git a/docs/man/man1/oc-annotate.1 b/docs/man/man1/oc-annotate.1 index 3fae4d9062cb..48ed4648e8c4 100644 --- a/docs/man/man1/oc-annotate.1 +++ b/docs/man/man1/oc-annotate.1 @@ -16,13 +16,7 @@ oc annotate \- Update the annotations on a resource Update the annotations on one or more resources .PP -An annotation is a key/value pair that can hold larger (compared to a label), -and possibly not human\-readable, data. It is intended to store non\-identifying -auxiliary data, especially data manipulated by tools and system extensions. If -\-\-overwrite is true, then existing annotations can be overwritten, otherwise -attempting to overwrite an annotation will result in an error. If -\-\-resource\-version is specified, then updates will use this resource version, -otherwise the existing resource\-version will be used. +An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human\-readable, data. It is intended to store non\-identifying auxiliary data, especially data manipulated by tools and system extensions. If \-\-overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error. If \-\-resource\-version is specified, then updates will use this resource version, otherwise the existing resource\-version will be used. .PP Run 'oc types' for a list of valid resources. diff --git a/docs/man/man1/oc-attach.1 b/docs/man/man1/oc-attach.1 index c57139aece9e..ac8d26ba206d 100644 --- a/docs/man/man1/oc-attach.1 +++ b/docs/man/man1/oc-attach.1 @@ -16,8 +16,7 @@ oc attach \- Attach to a running container Attach to a running container .PP -Attach the current shell to a remote container, returning output or setting up a full -terminal session. Can be used to debug containers and invoke interactive commands. +Attach the current shell to a remote container, returning output or setting up a full terminal session. Can be used to debug containers and invoke interactive commands. .SH OPTIONS diff --git a/docs/man/man1/oc-autoscale.1 b/docs/man/man1/oc-autoscale.1 index afa3c4a65314..1d9d451cca21 100644 --- a/docs/man/man1/oc-autoscale.1 +++ b/docs/man/man1/oc-autoscale.1 @@ -16,9 +16,7 @@ oc autoscale \- Autoscale a deployment config or replication controller Autoscale a deployment config or replication controller. .PP -Looks up a deployment config or replication controller by name and creates an autoscaler that uses -this deployment config or replication controller as a reference. An autoscaler can automatically -increase or decrease number of pods deployed within the system as needed. +Looks up a deployment config or replication controller by name and creates an autoscaler that uses this deployment config or replication controller as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed. .SH OPTIONS diff --git a/docs/man/man1/oc-cancel-build.1 b/docs/man/man1/oc-cancel-build.1 index 3fcd017c26a8..e07fb6895afd 100644 --- a/docs/man/man1/oc-cancel-build.1 +++ b/docs/man/man1/oc-cancel-build.1 @@ -16,8 +16,7 @@ oc cancel\-build \- Cancel running, pending, or new builds Cancel running, pending, or new builds .PP -This command requests a graceful shutdown of the build. There may be a delay between requesting -the build and the time the build is terminated. +This command requests a graceful shutdown of the build. There may be a delay between requesting the build and the time the build is terminated. .SH OPTIONS diff --git a/docs/man/man1/oc-completion.1 b/docs/man/man1/oc-completion.1 index 447509d60df6..10a1887b7efe 100644 --- a/docs/man/man1/oc-completion.1 +++ b/docs/man/man1/oc-completion.1 @@ -13,8 +13,7 @@ oc 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 oc commands. +This command prints shell code which must be evaluated to provide interactive completion of oc commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-config.1 b/docs/man/man1/oc-config.1 index 17e8e11d90d9..c2b2221709cf 100644 --- a/docs/man/man1/oc-config.1 +++ b/docs/man/man1/oc-config.1 @@ -16,9 +16,7 @@ oc 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 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. .PP Reference: diff --git a/docs/man/man1/oc-convert.1 b/docs/man/man1/oc-convert.1 index 21b9c98f9037..bcecf6d7b64e 100644 --- a/docs/man/man1/oc-convert.1 +++ b/docs/man/man1/oc-convert.1 @@ -13,17 +13,13 @@ oc convert \- Convert config files between different API versions .SH DESCRIPTION .PP -Convert config files between different API versions. Both YAML -and JSON formats are accepted. +Convert config files between different API versions. Both YAML and JSON formats are accepted. .PP -The command takes filename, directory, or URL as input, and convert it into format -of version specified by \-\-output\-version flag. If target version is not specified or -not supported, convert to latest version. +The command takes filename, directory, or URL as input, and convert it into format of version specified by \-\-output\-version flag. If target version is not specified or not supported, convert to latest version. .PP -The default output will be printed to stdout in YAML format. One can use \-o option -to change to output destination. +The default output will be printed to stdout in YAML format. One can use \-o option to change to output destination. .SH OPTIONS diff --git a/docs/man/man1/oc-create-identity.1 b/docs/man/man1/oc-create-identity.1 index 737358e91169..60c1f8a39ddc 100644 --- a/docs/man/man1/oc-create-identity.1 +++ b/docs/man/man1/oc-create-identity.1 @@ -16,13 +16,10 @@ oc create identity \- Manually create an identity (only needed if automatic crea This command can be used to create an identity object. .PP -Typically, identities are created automatically during login. If automatic -creation is disabled (by using the "lookup" mapping method), identities must -be created manually. +Typically, identities are created automatically during login. If automatic creation is disabled (by using the "lookup" mapping method), identities must be created manually. .PP -Corresponding user and useridentitymapping objects must also be created -to allow logging in with the created identity. +Corresponding user and useridentitymapping objects must also be created to allow logging in with the created identity. .SH OPTIONS diff --git a/docs/man/man1/oc-create-imagestream.1 b/docs/man/man1/oc-create-imagestream.1 index 2f05fc216c7a..c94912e33f83 100644 --- a/docs/man/man1/oc-create-imagestream.1 +++ b/docs/man/man1/oc-create-imagestream.1 @@ -16,8 +16,7 @@ oc create imagestream \- Create a new empty image stream. Create a new image stream .PP -Image streams allow you to track, tag, and import images from other registries. They also define an -access controlled destination that you can push images to. +Image streams allow you to track, tag, and import images from other registries. They also define an access controlled destination that you can push images to. .SH OPTIONS diff --git a/docs/man/man1/oc-create-route-edge.1 b/docs/man/man1/oc-create-route-edge.1 index d3d2a14444e8..cc6e7a665700 100644 --- a/docs/man/man1/oc-create-route-edge.1 +++ b/docs/man/man1/oc-create-route-edge.1 @@ -16,8 +16,7 @@ oc create route edge \- Create a route that uses edge TLS termination Create a route that uses edge TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. +Specify the service (either just its name or using type/name syntax) that the generated route should expose via the \-\-service flag. .SH OPTIONS diff --git a/docs/man/man1/oc-create-route-passthrough.1 b/docs/man/man1/oc-create-route-passthrough.1 index 92576636c3ed..9a028cc5ee1e 100644 --- a/docs/man/man1/oc-create-route-passthrough.1 +++ b/docs/man/man1/oc-create-route-passthrough.1 @@ -16,8 +16,7 @@ oc create route passthrough \- Create a route that uses passthrough TLS terminat Create a route that uses passthrough TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. +Specify the service (either just its name or using type/name syntax) that the generated route should expose via the \-\-service flag. .SH OPTIONS diff --git a/docs/man/man1/oc-create-route-reencrypt.1 b/docs/man/man1/oc-create-route-reencrypt.1 index 7b4e433bf505..e3d7eb2f5b36 100644 --- a/docs/man/man1/oc-create-route-reencrypt.1 +++ b/docs/man/man1/oc-create-route-reencrypt.1 @@ -16,9 +16,7 @@ oc create route reencrypt \- Create a route that uses reencrypt TLS termination Create a route that uses reencrypt TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. A destination CA certificate -is needed for reencrypt routes, specify one with the \-\-dest\-ca\-cert flag. +Specify the service (either just its name or using type/name syntax) that the generated route should expose via the \-\-service flag. A destination CA certificate is needed for reencrypt routes, specify one with the \-\-dest\-ca\-cert flag. .SH OPTIONS diff --git a/docs/man/man1/oc-create-route.1 b/docs/man/man1/oc-create-route.1 index 66d7e0463868..73fa0c0f928f 100644 --- a/docs/man/man1/oc-create-route.1 +++ b/docs/man/man1/oc-create-route.1 @@ -16,8 +16,7 @@ oc create route \- Expose containers externally via secured routes Expose containers externally via secured routes .PP -Three types of secured routes are supported: edge, passthrough, and reencrypt. -If you wish to create unsecured routes, see "oc expose \-h" +Three types of secured routes are supported: edge, passthrough, and reencrypt. If you wish to create unsecured routes, see "oc expose \-h" .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-create-user.1 b/docs/man/man1/oc-create-user.1 index 321c086a195c..daa27db0e4ba 100644 --- a/docs/man/man1/oc-create-user.1 +++ b/docs/man/man1/oc-create-user.1 @@ -16,13 +16,10 @@ oc create user \- Manually create a user (only needed if automatic creation is d This command can be used to create a user object. .PP -Typically, users are created automatically during login. If automatic -creation is disabled (by using the "lookup" mapping method), users must -be created manually. +Typically, users are created automatically during login. If automatic creation is disabled (by using the "lookup" mapping method), users must be created manually. .PP -Corresponding identity and useridentitymapping objects must also be created -to allow logging in as the created user. +Corresponding identity and useridentitymapping objects must also be created to allow logging in as the created user. .SH OPTIONS diff --git a/docs/man/man1/oc-create-useridentitymapping.1 b/docs/man/man1/oc-create-useridentitymapping.1 index 25e63e98452d..1f4643b7b5bc 100644 --- a/docs/man/man1/oc-create-useridentitymapping.1 +++ b/docs/man/man1/oc-create-useridentitymapping.1 @@ -13,10 +13,7 @@ oc create useridentitymapping \- Manually map an identity to a user. .SH DESCRIPTION .PP -Typically, identities are automatically mapped to users during login. If automatic -mapping is disabled (by using the "lookup" mapping method), or a mapping needs to -be manually established between an identity and a user, this command can be used -to create a useridentitymapping object. +Typically, identities are automatically mapped to users during login. If automatic mapping is disabled (by using the "lookup" mapping method), or a mapping needs to be manually established between an identity and a user, this command can be used to create a useridentitymapping object. .SH OPTIONS diff --git a/docs/man/man1/oc-debug.1 b/docs/man/man1/oc-debug.1 index 703e32d71b9e..3e642fd7143e 100644 --- a/docs/man/man1/oc-debug.1 +++ b/docs/man/man1/oc-debug.1 @@ -16,27 +16,16 @@ oc debug \- Launch a new instance of a pod for debugging Launch a command shell to debug a running application .PP -When debugging images and setup problems, it's useful to get an exact copy of a running -pod configuration and troubleshoot with a shell. Since a pod that is failing may not be -started and not accessible to 'rsh' or 'exec', the 'debug' command makes it easy to -create a carbon copy of that setup. +When debugging images and setup problems, it's useful to get an exact copy of a running pod configuration and troubleshoot with a shell. Since a pod that is failing may not be started and not accessible to 'rsh' or 'exec', the 'debug' command makes it easy to create a carbon copy of that setup. .PP -The default mode is to start a shell inside of the first container of the referenced pod, -replication controller, or deployment config. The started pod will be a copy of your -source pod, with labels stripped, the command changed to '/bin/sh', and readiness and -liveness checks disabled. If you just want to run a command, add '\-\-' and a command to -run. Passing a command will not create a TTY or send STDIN by default. Other flags are -supported for altering the container or pod in common ways. +The default mode is to start a shell inside of the first container of the referenced pod, replication controller, or deployment config. The started pod will be a copy of your source pod, with labels stripped, the command changed to '/bin/sh', and readiness and liveness checks disabled. If you just want to run a command, add '\-\-' and a command to run. Passing a command will not create a TTY or send STDIN by default. Other flags are supported for altering the container or pod in common ways. .PP -A common problem running containers is a security policy that prohibits you from running -as a root user on the cluster. You can use this command to test running a pod as -non\-root (with \-\-as\-user) or to run a non\-root pod as root (with \-\-as\-root). +A common problem running containers is a security policy that prohibits you from running as a root user on the cluster. You can use this command to test running a pod as non\-root (with \-\-as\-user) or to run a non\-root pod as root (with \-\-as\-root). .PP -The debug pod is deleted when the the remote command completes or the user interrupts -the shell. +The debug pod is deleted when the the remote command completes or the user interrupts the shell. .SH OPTIONS diff --git a/docs/man/man1/oc-delete.1 b/docs/man/man1/oc-delete.1 index 87e2143414c8..0eac1b82de38 100644 --- a/docs/man/man1/oc-delete.1 +++ b/docs/man/man1/oc-delete.1 @@ -19,13 +19,10 @@ Delete a resource JSON and YAML formats are accepted. .PP -If both a filename and command line arguments are passed, the command line -arguments are used and the filename is ignored. +If both a filename and command line arguments are passed, the command line arguments are used and the filename is ignored. .PP -Note that the delete command does NOT do resource version checks, so if someone -submits an update to a resource right when you submit a delete, their update -will be lost along with the rest of the resource. +Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource. .SH OPTIONS diff --git a/docs/man/man1/oc-deploy.1 b/docs/man/man1/oc-deploy.1 index 591c79de970d..1bd9245afa8f 100644 --- a/docs/man/man1/oc-deploy.1 +++ b/docs/man/man1/oc-deploy.1 @@ -16,36 +16,26 @@ oc deploy \- View, start, cancel, or retry a deployment View, start, cancel, or retry a deployment .PP -This command allows you to control a deployment config. Each individual deployment is exposed -as a new replication controller, and the deployment process manages scaling down old deployments -and scaling up new ones. Use 'oc rollback' to rollback to any previous deployment. +This command allows you to control a deployment config. Each individual deployment is exposed as a new replication controller, and the deployment process manages scaling down old deployments and scaling up new ones. Use 'oc rollback' to rollback to any previous deployment. .PP There are several deployment strategies defined: .IP .IP -\(bu Rolling (default) \- scales up the new deployment in stages, gradually reducing the number -of old deployments. If one of the new deployed pods never becomes "ready", the new deployment -will be rolled back (scaled down to zero). Use when your application can tolerate two versions -of code running at the same time (many web applications, scalable databases) +\(bu Rolling (default) \- scales up the new deployment in stages, gradually reducing the number of old deployments. If one of the new deployed pods never becomes "ready", the new deployment will be rolled back (scaled down to zero). Use when your application can tolerate two versions of code running at the same time (many web applications, scalable databases) +.br .IP -\(bu Recreate \- scales the old deployment down to zero, then scales the new deployment up to full. -Use when your application cannot tolerate two versions of code running at the same time +\(bu Recreate \- scales the old deployment down to zero, then scales the new deployment up to full. Use when your application cannot tolerate two versions of code running at the same time +.br .IP \(bu Custom \- run your own deployment process inside a Docker container using your own scripts. +.br .PP -If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may -never successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment. -If a deployment config has completed deploying successfully at least once in the past, it would be -automatically rolled back in the event of a new failed deployment. Note that you would still need -to update the erroneous deployment config in order to have its template persisted across your -application. +If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may never successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment. If a deployment config has completed deploying successfully at least once in the past, it would be automatically rolled back in the event of a new failed deployment. Note that you would still need to update the erroneous deployment config in order to have its template persisted across your application. .PP -If you want to cancel a running deployment, use '\-\-cancel' but keep in mind that this is a best\-effort -operation and may take some time to complete. It’s possible the deployment will partially or totally -complete before the cancellation is effective. In such a case an appropriate event will be emitted. +If you want to cancel a running deployment, use '\-\-cancel' but keep in mind that this is a best\-effort operation and may take some time to complete. It’s possible the deployment will partially or totally complete before the cancellation is effective. In such a case an appropriate event will be emitted. .PP If no options are given, shows information about the latest deployment. diff --git a/docs/man/man1/oc-describe.1 b/docs/man/man1/oc-describe.1 index d7d4c95fd872..f0da26485a13 100644 --- a/docs/man/man1/oc-describe.1 +++ b/docs/man/man1/oc-describe.1 @@ -16,8 +16,7 @@ oc describe \- Show details of a specific resource or group of resources Show details of a specific resource .PP -This command joins many API calls together to form a detailed description of a -given resource. +This command joins many API calls together to form a detailed description of a given resource. .SH OPTIONS diff --git a/docs/man/man1/oc-edit.1 b/docs/man/man1/oc-edit.1 index 9080f808587d..5430282ef723 100644 --- a/docs/man/man1/oc-edit.1 +++ b/docs/man/man1/oc-edit.1 @@ -16,25 +16,13 @@ oc edit \- Edit a resource on the server Edit a resource from the default editor .PP -The edit command allows you to directly edit any API resource you can retrieve via the -command line tools. It will open the editor defined by your OC\_EDITOR, or EDITOR environment -variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple -objects, although changes are applied one at a time. The command accepts filenames as well -as command line arguments, although the files you point to must be previously saved versions -of resources. +The edit command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your OC \_EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. .PP -The files to edit will be output in the default API version, or a version specified -by \-\-output\-version. The default format is YAML \- if you would like to edit in JSON -pass \-o json. The flag \-\-windows\-line\-endings can be used to force Windows line endings, -otherwise the default for your operating system will be used. +The files to edit will be output in the default API version, or a version specified by \-\-output\-version. The default format is YAML \- if you would like to edit in JSON pass \-o json. The flag \-\-windows\-line\-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. .PP -In the event an error occurs while updating, a temporary file will be created on disk -that contains your unapplied changes. The most common error when updating a resource -is another editor changing the resource on the server. When this occurs, you will have -to apply your changes to the newer version of the resource, or update your temporary -saved copy to include the latest resource version. +In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version. .SH OPTIONS diff --git a/docs/man/man1/oc-ex-dockerbuild.1 b/docs/man/man1/oc-ex-dockerbuild.1 index d267c2d7a80d..51b328bc8749 100644 --- a/docs/man/man1/oc-ex-dockerbuild.1 +++ b/docs/man/man1/oc-ex-dockerbuild.1 @@ -16,10 +16,7 @@ oc ex dockerbuild \- Perform a direct Docker build Build a Dockerfile into a single layer .PP -Builds the provided directory with a Dockerfile into a single layered image. -Requires that you have a working connection to a Docker engine. You may mount -secrets or config into the build with the \-\-mount flag \- these files will not -be included in the final image. +Builds the provided directory with a Dockerfile into a single layered image. Requires that you have a working connection to a Docker engine. You may mount secrets or config into the build with the \-\-mount flag \- these files will not be included in the final image. .PP Experimental: This command is under active development and may change without notice. diff --git a/docs/man/man1/oc-explain.1 b/docs/man/man1/oc-explain.1 index a3f93cbcedeb..64a25e62b6ba 100644 --- a/docs/man/man1/oc-explain.1 +++ b/docs/man/man1/oc-explain.1 @@ -16,10 +16,7 @@ oc explain \- Documentation of resources Documentation of resources. .PP -Possible resource types include: pods (po), services (svc), -replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), -limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), -resourcequotas (quota), namespaces (ns) or endpoints (ep). +Possible resource types include: pods (po), services (svc), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns) or endpoints (ep). .SH OPTIONS diff --git a/docs/man/man1/oc-export.1 b/docs/man/man1/oc-export.1 index 0e8f7b41909f..cbade5b47e74 100644 --- a/docs/man/man1/oc-export.1 +++ b/docs/man/man1/oc-export.1 @@ -16,21 +16,13 @@ oc export \- Export resources so they can be used elsewhere Export resources so they can be used elsewhere .PP -The export command makes it easy to take existing objects and convert them to configuration files -for backups or for creating elsewhere in the cluster. Fields that cannot be specified on create -will be set to empty, and any field which is assigned on creation (like a service's clusterIP, or -a deployment config's latestVersion). The status part of objects is also cleared. +The export command makes it easy to take existing objects and convert them to configuration files for backups or for creating elsewhere in the cluster. Fields that cannot be specified on create will be set to empty, and any field which is assigned on creation (like a service's clusterIP, or a deployment config's latestVersion). The status part of objects is also cleared. .PP -Some fields like clusterIP may be useful when exporting an application from one cluster to apply -to another \- assuming another service on the destination cluster does not already use that IP. -The \-\-exact flag will instruct export to not clear fields that might be useful. You may also use -\-\-raw to get the exact values for an object \- useful for converting a file on disk between API -versions. +Some fields like clusterIP may be useful when exporting an application from one cluster to apply to another \- assuming another service on the destination cluster does not already use that IP. The \-\-exact flag will instruct export to not clear fields that might be useful. You may also use \-\-raw to get the exact values for an object \- useful for converting a file on disk between API versions. .PP -Another use case for export is to create reusable templates for applications. Pass \-\-as\-template -to generate the API structure for a template to which you can add parameters and object labels. +Another use case for export is to create reusable templates for applications. Pass \-\-as\-template to generate the API structure for a template to which you can add parameters and object labels. .SH OPTIONS diff --git a/docs/man/man1/oc-expose.1 b/docs/man/man1/oc-expose.1 index fddb7ba21fec..e879605dafca 100644 --- a/docs/man/man1/oc-expose.1 +++ b/docs/man/man1/oc-expose.1 @@ -16,9 +16,7 @@ oc expose \- Expose a replicated application as a service or route Expose containers internally as services or externally via routes .PP -There is also the ability to expose a deployment configuration, replication controller, service, or pod -as a new service on a specified port. If no labels are specified, the new object will re\-use the -labels from the object it exposes. +There is also the ability to expose a deployment configuration, replication controller, service, or pod as a new service on a specified port. If no labels are specified, the new object will re\-use the labels from the object it exposes. .SH OPTIONS diff --git a/docs/man/man1/oc-extract.1 b/docs/man/man1/oc-extract.1 index 4e85485b2e1e..d43ffffdd74b 100644 --- a/docs/man/man1/oc-extract.1 +++ b/docs/man/man1/oc-extract.1 @@ -16,13 +16,10 @@ oc extract \- Extract secrets or config maps to disk Extract files out of secrets and config maps .PP -The extract command makes it easy to download the contents of a config map or secret into a directory. -Each key in the config map or secret is created as a separate file with the name of the key, as it -is when you mount a secret or config map into a container. +The extract command makes it easy to download the contents of a config map or secret into a directory. Each key in the config map or secret is created as a separate file with the name of the key, as it is when you mount a secret or config map into a container. .PP -You can limit which keys are extracted with the \-\-keys=NAME flag, or set the directory to extract to -with \-\-to=DIRECTORY. +You can limit which keys are extracted with the \-\-keys=NAME flag, or set the directory to extract to with \-\-to=DIRECTORY. .SH OPTIONS diff --git a/docs/man/man1/oc-get.1 b/docs/man/man1/oc-get.1 index 1992ab5f6a6e..e634fdfdadac 100644 --- a/docs/man/man1/oc-get.1 +++ b/docs/man/man1/oc-get.1 @@ -16,9 +16,7 @@ oc get \- Display one or many resources Display one or many resources .PP -Possible resources include builds, buildConfigs, services, pods, etc. -Some resources may omit advanced details that you can see with '\-o wide'. -If you want an even more detailed view, use 'oc describe'. +Possible resources include builds, buildConfigs, services, pods, etc. Some resources may omit advanced details that you can see with '\-o wide'. If you want an even more detailed view, use 'oc describe'. .SH OPTIONS diff --git a/docs/man/man1/oc-idle.1 b/docs/man/man1/oc-idle.1 index d55cc2b597d6..e2e7186c0a35 100644 --- a/docs/man/man1/oc-idle.1 +++ b/docs/man/man1/oc-idle.1 @@ -16,14 +16,10 @@ oc idle \- Idle scalable resources Idle scalable resources. .PP -Idling discovers the scalable resources (such as deployment configs and replication controllers) -associated with a series of services by examining the endpoints of the service. -Each service is then marked as idled, the associated resources are recorded, and the resources -are scaled down to zero replicas. +Idling discovers the scalable resources (such as deployment configs and replication controllers) associated with a series of services by examining the endpoints of the service. Each service is then marked as idled, the associated resources are recorded, and the resources are scaled down to zero replicas. .PP -Upon receiving network traffic, the services (and any associated routes) will "wake up" the -associated resources by scaling them back up to their previous scale. +Upon receiving network traffic, the services (and any associated routes) will "wake up" the associated resources by scaling them back up to their previous scale. .SH OPTIONS diff --git a/docs/man/man1/oc-import-app.json.1 b/docs/man/man1/oc-import-app.json.1 index 51a7ba951439..e17975537357 100644 --- a/docs/man/man1/oc-import-app.json.1 +++ b/docs/man/man1/oc-import-app.json.1 @@ -16,14 +16,10 @@ oc import app.json \- Import an app.json definition into OpenShift (experimental Import app.json files as OpenShift objects .PP -app.json defines the pattern of a simple, stateless web application that can be horizontally scaled. -This command will transform a provided app.json object into its OpenShift equivalent. -During transformation fields in the app.json syntax that are not relevant when running on top of -a containerized platform will be ignored and a warning printed. +app.json defines the pattern of a simple, stateless web application that can be horizontally scaled. This command will transform a provided app.json object into its OpenShift equivalent. During transformation fields in the app.json syntax that are not relevant when running on top of a containerized platform will be ignored and a warning printed. .PP -The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a -configuration file for later use. +The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a configuration file for later use. .PP Experimental: This command is under active development and may change without notice. diff --git a/docs/man/man1/oc-import-docker-compose.1 b/docs/man/man1/oc-import-docker-compose.1 index 912f095b0522..bc80e9c05ea0 100644 --- a/docs/man/man1/oc-import-docker-compose.1 +++ b/docs/man/man1/oc-import-docker-compose.1 @@ -16,14 +16,10 @@ oc import docker\-compose \- Import a docker\-compose.yml project into OpenShift Import a Docker Compose file as OpenShift objects .PP -Docker Compose files offer a container centric build and deploy pattern for simple applications. -This command will transform a provided docker\-compose.yml application into its OpenShift equivalent. -During transformation fields in the compose syntax that are not relevant when running on top of -a containerized platform will be ignored and a warning printed. +Docker Compose files offer a container centric build and deploy pattern for simple applications. This command will transform a provided docker\-compose.yml application into its OpenShift equivalent. During transformation fields in the compose syntax that are not relevant when running on top of a containerized platform will be ignored and a warning printed. .PP -The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a -configuration file for later use. +The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a configuration file for later use. .PP Experimental: This command is under active development and may change without notice. diff --git a/docs/man/man1/oc-import-image.1 b/docs/man/man1/oc-import-image.1 index 7259b240fc31..968cce514907 100644 --- a/docs/man/man1/oc-import-image.1 +++ b/docs/man/man1/oc-import-image.1 @@ -16,8 +16,7 @@ oc import\-image \- Imports images from a Docker registry Import tag and image information from an external Docker image repository .PP -Only image streams that have a value set for spec.dockerImageRepository and/or -spec.Tags may have tag and image information imported. +Only image streams that have a value set for spec.dockerImageRepository and/or spec.Tags may have tag and image information imported. .SH OPTIONS diff --git a/docs/man/man1/oc-label.1 b/docs/man/man1/oc-label.1 index 4fb0bc827a11..9bf563088a6a 100644 --- a/docs/man/man1/oc-label.1 +++ b/docs/man/man1/oc-label.1 @@ -16,11 +16,7 @@ oc label \- Update the labels on a resource Update the labels on one or more resources .PP -A valid label value is consisted of letters and/or numbers with a max length of 63 -characters. If \-\-overwrite is true, then existing labels can be overwritten, otherwise -attempting to overwrite a label will result in an error. If \-\-resource\-version is -specified, then updates will use this resource version, otherwise the existing -resource\-version will be used. +A valid label value is consisted of letters and/or numbers with a max length of 63 characters. If \-\-overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error. If \-\-resource\-version is specified, then updates will use this resource version, otherwise the existing resource\-version will be used. .SH OPTIONS diff --git a/docs/man/man1/oc-login.1 b/docs/man/man1/oc-login.1 index 1dd4a30265a9..7eab684a27bc 100644 --- a/docs/man/man1/oc-login.1 +++ b/docs/man/man1/oc-login.1 @@ -16,15 +16,10 @@ oc login \- Log in to a server Log in to your server and save login for subsequent use .PP -First\-time users of the client should run this command to connect to a server, -establish an authenticated session, and save connection to the configuration file. The -default configuration will be saved to your home directory under -".kube/config". +First\-time users of the client should run this command to connect to a server, establish an authenticated session, and save connection to the configuration file. The default configuration will be saved to your home directory under ".kube/config". .PP -The information required to login \-\- like username and password, a session token, or -the server details \-\- can be provided through flags. If not provided, the command will -prompt for user input as needed. +The information required to login \-\- like username and password, a session token, or the server details \-\- can be provided through flags. If not provided, the command will prompt for user input as needed. .SH OPTIONS diff --git a/docs/man/man1/oc-logout.1 b/docs/man/man1/oc-logout.1 index 1c4cfac660fd..234029c9c74f 100644 --- a/docs/man/man1/oc-logout.1 +++ b/docs/man/man1/oc-logout.1 @@ -16,14 +16,10 @@ oc logout \- End the current server session Log out of the active session out by clearing saved tokens .PP -An authentication token is stored in the config file after login \- this command will delete -that token on the server, and then remove the token from the configuration file. +An authentication token is stored in the config file after login \- this command will delete that token on the server, and then remove the token from the configuration file. .PP -If you are using an alternative authentication method like Kerberos or client certificates, -your ticket or client certificate will not be removed from the current system since these -are typically managed by other programs. Instead, you can delete your config file to remove -the local copy of that certificate or the record of your server login. +If you are using an alternative authentication method like Kerberos or client certificates, your ticket or client certificate will not be removed from the current system since these are typically managed by other programs. Instead, you can delete your config file to remove the local copy of that certificate or the record of your server login. .PP After logging out, if you want to log back into the server use 'oc login'. diff --git a/docs/man/man1/oc-logs.1 b/docs/man/man1/oc-logs.1 index 3402e1056f1b..c164d5543c00 100644 --- a/docs/man/man1/oc-logs.1 +++ b/docs/man/man1/oc-logs.1 @@ -16,14 +16,10 @@ oc logs \- Print the logs for a resource. Print the logs for a resource. .PP -Supported resources are builds, build configs (bc), deployment configs (dc), and pods. -When a pod is specified and has more than one container, the container name should be -specified via \-c. When a build config or deployment config is specified, you can view -the logs for a particular version of it via \-\-version. +Supported resources are builds, build configs (bc), deployment configs (dc), and pods. When a pod is specified and has more than one container, the container name should be specified via \-c. When a build config or deployment config is specified, you can view the logs for a particular version of it via \-\-version. .PP -If your pod is failing to start, you may need to use the \-\-previous option to see the -logs of the last attempt. +If your pod is failing to start, you may need to use the \-\-previous option to see the logs of the last attempt. .SH OPTIONS diff --git a/docs/man/man1/oc-new-app.1 b/docs/man/man1/oc-new-app.1 index f74a0bf3229f..49d653abd711 100644 --- a/docs/man/man1/oc-new-app.1 +++ b/docs/man/man1/oc-new-app.1 @@ -16,21 +16,13 @@ oc new\-app \- Create a new application Create a new application by specifying source code, templates, and/or images .PP -This command will try to build up the components of an application using images, templates, -or code that has a public repository. It will lookup the images on the local Docker installation -(if available), a Docker registry, an integrated image stream, or stored templates. +This command will try to build up the components of an application using images, templates, or code that has a public repository. It will lookup the images on the local Docker installation (if available), a Docker registry, an integrated image stream, or stored templates. .PP -If you specify a source code URL, it will set up a build that takes your source code and converts -it into an image that can run inside of a pod. Local source must be in a git repository that has a -remote repository that the server can see. The images will be deployed via a deployment -configuration, and a service will be connected to the first public port of the app. You may either specify -components using the various existing flags or let new\-app autodetect what kind of components -you have provided. +If you specify a source code URL, it will set up a build that takes your source code and converts it into an image that can run inside of a pod. Local source must be in a git repository that has a remote repository that the server can see. The images will be deployed via a deployment configuration, and a service will be connected to the first public port of the app. You may either specify components using the various existing flags or let new\-app autodetect what kind of components you have provided. .PP -If you provide source code, a new build will be automatically triggered. -You can use 'oc status' to check the progress. +If you provide source code, a new build will be automatically triggered. You can use 'oc status' to check the progress. .SH OPTIONS diff --git a/docs/man/man1/oc-new-build.1 b/docs/man/man1/oc-new-build.1 index 9cab29ffc793..05b0bfd7279e 100644 --- a/docs/man/man1/oc-new-build.1 +++ b/docs/man/man1/oc-new-build.1 @@ -16,18 +16,13 @@ oc new\-build \- Create a new build configuration Create a new build by specifying source code .PP -This command will try to create a build configuration for your application using images and -code that has a public repository. It will lookup the images on the local Docker installation -(if available), a Docker registry, or an image stream. +This command will try to create a build configuration for your application using images and code that has a public repository. It will lookup the images on the local Docker installation (if available), a Docker registry, or an image stream. .PP -If you specify a source code URL, it will set up a build that takes your source code and converts -it into an image that can run inside of a pod. Local source must be in a git repository that has a -remote repository that the server can see. +If you specify a source code URL, it will set up a build that takes your source code and converts it into an image that can run inside of a pod. Local source must be in a git repository that has a remote repository that the server can see. .PP -Once the build configuration is created a new build will be automatically triggered. -You can use 'oc status' to check the progress. +Once the build configuration is created a new build will be automatically triggered. You can use 'oc status' to check the progress. .SH OPTIONS diff --git a/docs/man/man1/oc-new-project.1 b/docs/man/man1/oc-new-project.1 index a8d9795dd7b2..20a985899a64 100644 --- a/docs/man/man1/oc-new-project.1 +++ b/docs/man/man1/oc-new-project.1 @@ -16,8 +16,7 @@ oc new\-project \- Request a new project Create a new project for yourself .PP -If your administrator allows self\-service, this command will create a new project for you and assign you -as the project admin. +If your administrator allows self\-service, this command will create a new project for you and assign you as the project admin. .PP After your project is created it will become the default project in your config. diff --git a/docs/man/man1/oc-observe.1 b/docs/man/man1/oc-observe.1 index 00d808f9d835..f14854d7c4d8 100644 --- a/docs/man/man1/oc-observe.1 +++ b/docs/man/man1/oc-observe.1 @@ -16,36 +16,32 @@ oc observe \- Observe changes to resources and react to them (experimental) Observe changes to resources and take action on them .PP -This command assists in building scripted reactions to changes that occur in -Kubernetes or OpenShift resources. This is frequently referred to as a -'controller' in Kubernetes and acts to ensure particular conditions are -maintained. On startup, observe will list all of the resources of a -particular type and execute the provided script on each one. Observe watches -the server for changes, and will reexecute the script for each update. +This command assists in building scripted reactions to changes that occur in Kubernetes or OpenShift resources. This is frequently referred to as a 'controller' in Kubernetes and acts to ensure particular conditions are maintained. On startup, observe will list all of the resources of a particular type and execute the provided script on each one. Observe watches the server for changes, and will reexecute the script for each update. .PP -Observe works best for problems of the form "for every resource X, make sure -Y is true". Some examples of ways observe can be used include: +Observe works best for problems of the form "for every resource X, make sure Y is true". Some examples of ways observe can be used include: .IP .IP \(bu Ensure every namespace has a quota or limit range object +.br .IP \(bu Ensure every service is registered in DNS by making calls to a DNS API +.br .IP \(bu Send an email alert whenever a node reports 'NotReady' +.br .IP \(bu Watch for the 'FailedScheduling' event and write an IRC message +.br .IP \(bu Dynamically provision persistent volumes when a new PVC is created +.br .IP \(bu Delete pods that have reached successful completion after a period of time. +.br .PP -The simplest pattern is maintaining an invariant on an object \- for instance, -"every namespace should have an annotation that indicates its owner". If the -object is deleted no reaction is necessary. A variation on that pattern is -creating another object: "every namespace should have a quota object based -on the resources allowed for an owner". +The simplest pattern is maintaining an invariant on an object \- for instance, "every namespace should have an annotation that indicates its owner". If the object is deleted no reaction is necessary. A variation on that pattern is creating another object: "every namespace should have a quota object based on the resources allowed for an owner". .PP $ cat set\_owner.sh @@ -58,23 +54,13 @@ $ cat set\_owner.sh $ oc observe namespaces \-\- ./set\_owner.sh .PP -The set\_owner.sh script is invoked with a single argument (the namespace name) -for each namespace. This simple script ensures that any user without the -"owner" annotation gets one set, but preserves any existing value. +The set \_owner.sh script is invoked with a single argument (the namespace name) for each namespace. This simple script ensures that any user without the "owner" annotation gets one set, but preserves any existing value. .PP -The next common of controller pattern is provisioning \- making changes in an -external system to match the state of a Kubernetes resource. These scripts need -to account for deletions that may take place while the observe command is not -running. You can provide the list of known objects via the \-\-names command, -which should return a newline\-delimited list of names or namespace/name pairs. -Your command will be invoked whenever observe checks the latest state on the -server \- any resources returned by \-\-names that are not found on the server -will be passed to your \-\-delete command. +The next common of controller pattern is provisioning \- making changes in an external system to match the state of a Kubernetes resource. These scripts need to account for deletions that may take place while the observe command is not running. You can provide the list of known objects via the \-\-names command, which should return a newline\-delimited list of names or namespace/name pairs. Your command will be invoked whenever observe checks the latest state on the server \- any resources returned by \-\-names that are not found on the server will be passed to your \-\-delete command. .PP -For example, you may wish to ensure that every node that is added to Kubernetes -is added to your cluster inventory along with its IP: +For example, you may wish to ensure that every node that is added to Kubernetes is added to your cluster inventory along with its IP: .PP $ cat add\_to\_inventory.sh @@ -96,27 +82,18 @@ $ cat known\_nodes.sh .PP $ oc observe nodes \-a '{ .status.addresses[0].address }' \\ - \-\-names ./known\_nodes.sh \\ - \-\-delete ./remove\_from\_inventory.sh \\ - \-\- ./add\_to\_inventory.sh + \-\-names ./known\_nodes.sh \\ + \-\-delete ./remove\_from\_inventory.sh \\ + \-\- ./add\_to\_inventory.sh .PP -If you stop the observe command and then delete a node, when you launch observe -again the contents of inventory will be compared to the list of nodes from the -server, and any node in the inventory file that no longer exists will trigger -a call to remove\_from\_inventory.sh with the name of the node. +If you stop the observe command and then delete a node, when you launch observe again the contents of inventory will be compared to the list of nodes from the server, and any node in the inventory file that no longer exists will trigger a call to remove from inventory.sh with the name of the node. .PP -Important: when handling deletes, the previous state of the object may not be - available and only the name/namespace of the object will be passed to your - \-\-delete command as arguments (all custom arguments are omitted). +Important: when handling deletes, the previous state of the object may not be available and only the name/namespace of the object will be passed to your \-\-delete command as arguments (all custom arguments are omitted). .PP -More complicated interactions build on the two examples above \- your inventory -script could make a call to allocate storage on your infrastructure as a -service, or register node names in DNS, or set complex firewalls. The more -complex your integration, the more important it is to record enough data in the -remote system that you can identify when resources on either side are deleted. +More complicated interactions build on the two examples above \- your inventory script could make a call to allocate storage on your infrastructure as a service, or register node names in DNS, or set complex firewalls. The more complex your integration, the more important it is to record enough data in the remote system that you can identify when resources on either side are deleted. .PP Experimental: This command is under active development and may change without notice. @@ -263,11 +240,11 @@ Experimental: This command is under active development and may change without no .RS .nf - # observe changes to services - oc observe services + # Observe changes to services + oc observe services - # observe changes to services, including the clusterIP and invoke a script for each - oc observe services \-a '{ .spec.clusterIP }' \-\- register\_dns.sh + # Observe changes to services, including the clusterIP and invoke a script for each + oc observe services \-a '{ .spec.clusterIP }' \-\- register\_dns.sh .fi diff --git a/docs/man/man1/oc-process.1 b/docs/man/man1/oc-process.1 index 0d8f9ec692ab..d254116ea4b4 100644 --- a/docs/man/man1/oc-process.1 +++ b/docs/man/man1/oc-process.1 @@ -16,13 +16,10 @@ oc process \- Process a template into list of resources Process template into a list of resources specified in filename or stdin .PP -Templates allow parameterization of resources prior to being sent to the server for creation or -update. Templates have "parameters", which may either be generated on creation or set by the user, -as well as metadata describing the template. +Templates allow parameterization of resources prior to being sent to the server for creation or update. Templates have "parameters", which may either be generated on creation or set by the user, as well as metadata describing the template. .PP -The output of the process command is always a list of one or more resources. You may pipe the -output to the create command over STDIN (using the '\-f \-' option) or redirect it to a file. +The output of the process command is always a list of one or more resources. You may pipe the output to the create command over STDIN (using the '\-f \-' option) or redirect it to a file. .SH OPTIONS diff --git a/docs/man/man1/oc-project.1 b/docs/man/man1/oc-project.1 index 380c2040fff4..f4ccdc267d87 100644 --- a/docs/man/man1/oc-project.1 +++ b/docs/man/man1/oc-project.1 @@ -16,16 +16,10 @@ oc project \- Switch to another project Switch to another project and make it the default in your configuration .PP -If no project was specified on the command line, display information about the current active -project. Since you can use this command to connect to projects on different servers, you will -occasionally encounter projects of the same name on different servers. When switching to that -project, a new local context will be created that will have a unique name \- for instance, -'myapp\-2'. If you have previously created a context with a different name than the project -name, this command will accept that context name instead. +If no project was specified on the command line, display information about the current active project. Since you can use this command to connect to projects on different servers, you will occasionally encounter projects of the same name on different servers. When switching to that project, a new local context will be created that will have a unique name \- for instance, 'myapp\-2'. If you have previously created a context with a different name than the project name, this command will accept that context name instead. .PP -For advanced configuration, or to manage the contents of your config file, use the 'config' -command. +For advanced configuration, or to manage the contents of your config file, use the 'config' command. .SH OPTIONS diff --git a/docs/man/man1/oc-projects.1 b/docs/man/man1/oc-projects.1 index 6afca2e94851..f1fcb28b9188 100644 --- a/docs/man/man1/oc-projects.1 +++ b/docs/man/man1/oc-projects.1 @@ -16,8 +16,7 @@ oc projects \- Display existing projects Display information about the current active project and existing projects on the server. .PP -For advanced configuration, or to manage the contents of your config file, use the 'config' -command. +For advanced configuration, or to manage the contents of your config file, use the 'config' command. .SH OPTIONS diff --git a/docs/man/man1/oc-rollback.1 b/docs/man/man1/oc-rollback.1 index 6fbf136d1adf..97aef523f867 100644 --- a/docs/man/man1/oc-rollback.1 +++ b/docs/man/man1/oc-rollback.1 @@ -16,24 +16,13 @@ oc rollback \- Revert part of an application back to a previous deployment Revert an application back to a previous deployment .PP -When you run this command your deployment configuration will be updated to -match a previous deployment. By default only the pod and container -configuration will be changed and scaling or trigger settings will be left as\- -is. Note that environment variables and volumes are included in rollbacks, so -if you've recently updated security credentials in your environment your -previous deployment may not have the correct values. +When you run this command your deployment configuration will be updated to match a previous deployment. By default only the pod and container configuration will be changed and scaling or trigger settings will be left as\- is. Note that environment variables and volumes are included in rollbacks, so if you've recently updated security credentials in your environment your previous deployment may not have the correct values. .PP -Any image triggers present in the rolled back configuration will be disabled -with a warning. This is to help prevent your rolled back deployment from being -replaced by a triggered deployment soon after your rollback. To re\-enable the -triggers, use the 'deploy' command. +Any image triggers present in the rolled back configuration will be disabled with a warning. This is to help prevent your rolled back deployment from being replaced by a triggered deployment soon after your rollback. To re\-enable the triggers, use the 'deploy' command. .PP -If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print -a human\-readable representation of the updated deployment configuration instead of -executing the rollback. This is useful if you're not quite sure what the outcome -will be. +If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print a human\-readable representation of the updated deployment configuration instead of executing the rollback. This is useful if you're not quite sure what the outcome will be. .SH OPTIONS diff --git a/docs/man/man1/oc-rollout-history.1 b/docs/man/man1/oc-rollout-history.1 index 2e89a02e1374..b4cac50e15c8 100644 --- a/docs/man/man1/oc-rollout-history.1 +++ b/docs/man/man1/oc-rollout-history.1 @@ -16,8 +16,7 @@ oc rollout history \- View rollout history View the history of rollouts for a specific deployment config .PP -You can also view more detailed information for a specific revision -by using the \-\-revision flag. +You can also view more detailed information for a specific revision by using the \-\-revision flag. .SH OPTIONS diff --git a/docs/man/man1/oc-rollout-pause.1 b/docs/man/man1/oc-rollout-pause.1 index fac834cbdc7b..aba81b199687 100644 --- a/docs/man/man1/oc-rollout-pause.1 +++ b/docs/man/man1/oc-rollout-pause.1 @@ -16,8 +16,7 @@ oc rollout pause \- Mark the provided resource as paused Mark the provided resource as paused .PP -Paused resources will not be reconciled by a controller. -Use \\"%[1]s rollout resume\\" to resume a paused resource. +Paused resources will not be reconciled by a controller. Use \\"% [1]s rollout resume \\" to resume a paused resource. .SH OPTIONS diff --git a/docs/man/man1/oc-rollout-resume.1 b/docs/man/man1/oc-rollout-resume.1 index dba8707e1c14..025a5493c600 100644 --- a/docs/man/man1/oc-rollout-resume.1 +++ b/docs/man/man1/oc-rollout-resume.1 @@ -16,8 +16,7 @@ oc rollout resume \- Resume a paused resource Resume a paused resource .PP -Paused resources will not be reconciled by a controller. By resuming a -resource, we allow it to be reconciled again. +Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. .SH OPTIONS diff --git a/docs/man/man1/oc-rollout-undo.1 b/docs/man/man1/oc-rollout-undo.1 index e9c169f37007..c3472ee6b5e4 100644 --- a/docs/man/man1/oc-rollout-undo.1 +++ b/docs/man/man1/oc-rollout-undo.1 @@ -16,24 +16,13 @@ oc rollout undo \- Undo a previous rollout Revert an application back to a previous deployment .PP -When you run this command your deployment configuration will be updated to -match a previous deployment. By default only the pod and container -configuration will be changed and scaling or trigger settings will be left as\- -is. Note that environment variables and volumes are included in rollbacks, so -if you've recently updated security credentials in your environment your -previous deployment may not have the correct values. +When you run this command your deployment configuration will be updated to match a previous deployment. By default only the pod and container configuration will be changed and scaling or trigger settings will be left as\- is. Note that environment variables and volumes are included in rollbacks, so if you've recently updated security credentials in your environment your previous deployment may not have the correct values. .PP -Any image triggers present in the rolled back configuration will be disabled -with a warning. This is to help prevent your rolled back deployment from being -replaced by a triggered deployment soon after your rollback. To re\-enable the -triggers, use the 'deploy \-\-enable\-triggers' command. +Any image triggers present in the rolled back configuration will be disabled with a warning. This is to help prevent your rolled back deployment from being replaced by a triggered deployment soon after your rollback. To re\-enable the triggers, use the 'deploy \-\-enable\-triggers' command. .PP -If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print -a human\-readable representation of the updated deployment configuration instead of -executing the rollback. This is useful if you're not quite sure what the outcome -will be. +If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print a human\-readable representation of the updated deployment configuration instead of executing the rollback. This is useful if you're not quite sure what the outcome will be. .SH OPTIONS diff --git a/docs/man/man1/oc-rsh.1 b/docs/man/man1/oc-rsh.1 index 084ce7c099e1..9d28d4770a12 100644 --- a/docs/man/man1/oc-rsh.1 +++ b/docs/man/man1/oc-rsh.1 @@ -16,19 +16,10 @@ oc rsh \- Start a shell session in a pod Open a remote shell session to a container .PP -This command will attempt to start a shell session in a pod for the specified resource. -It works with pods, deployment configs, jobs, daemon sets, and replication controllers. -Any of the aforementioned resources (apart from pods) will be resolved to a ready pod. -It will default to the first container if none is specified, and will attempt to use -'/bin/sh' as the default shell. You may pass an optional command after the resource name, -which will be executed instead of a login shell. A TTY will be automatically allocated -if standard input is interactive \- use \-t and \-T to override. A TERM variable is sent -to the environment where the shell (or command) will be executed. By default its value -is the same as the TERM variable from the local environment; if not set, 'xterm' is used. - -.PP -Note, some containers may not include a shell \- use 'oc exec' if you need to run commands -directly. +This command will attempt to start a shell session in a pod for the specified resource. It works with pods, deployment configs, jobs, daemon sets, and replication controllers. Any of the aforementioned resources (apart from pods) will be resolved to a ready pod. It will default to the first container if none is specified, and will attempt to use '/bin/sh' as the default shell. You may pass an optional command after the resource name, which will be executed instead of a login shell. A TTY will be automatically allocated if standard input is interactive \- use \-t and \-T to override. A TERM variable is sent to the environment where the shell (or command) will be executed. By default its value is the same as the TERM variable from the local environment; if not set, 'xterm' is used. + +.PP +Note, some containers may not include a shell \- use 'oc exec' if you need to run commands directly. .SH OPTIONS diff --git a/docs/man/man1/oc-rsync.1 b/docs/man/man1/oc-rsync.1 index 7159f40834d7..2b18ea6c40a1 100644 --- a/docs/man/man1/oc-rsync.1 +++ b/docs/man/man1/oc-rsync.1 @@ -16,16 +16,11 @@ oc rsync \- Copy files between local filesystem and a pod Copy local files to or from a pod container .PP -This command will copy local files to or from a remote container. -It only copies the changed files using the rsync command from your OS. -To ensure optimum performance, install rsync locally. In UNIX systems, -use your package manager. In Windows, install cwRsync from - +This command will copy local files to or from a remote container. It only copies the changed files using the rsync command from your OS. To ensure optimum performance, install rsync locally. In UNIX systems, use your package manager. In Windows, install cwRsync from \[la]https://www.itefix.net/cwrsync\[ra]. .PP -If no container is specified, the first container of the pod is used -for the copy. +If no container is specified, the first container of the pod is used for the copy. .SH OPTIONS diff --git a/docs/man/man1/oc-run.1 b/docs/man/man1/oc-run.1 index 6c2e22cdb6b0..7e73f3c9af17 100644 --- a/docs/man/man1/oc-run.1 +++ b/docs/man/man1/oc-run.1 @@ -16,9 +16,7 @@ oc run \- Run a particular image on the cluster Create and run a particular image, possibly replicated .PP -Creates a deployment config to manage the created container(s). You can choose to run in the -foreground for an interactive container execution. You may pass 'run/v1' to -\-\-generator to create a replication controller instead of a deployment config. +Creates a deployment config to manage the created container(s). You can choose to run in the foreground for an interactive container execution. You may pass 'run/v1' to \-\-generator to create a replication controller instead of a deployment config. .SH OPTIONS diff --git a/docs/man/man1/oc-scale.1 b/docs/man/man1/oc-scale.1 index da0fa7dfd2ef..c42de4d2091e 100644 --- a/docs/man/man1/oc-scale.1 +++ b/docs/man/man1/oc-scale.1 @@ -16,14 +16,10 @@ oc scale \- Change the number of pods in a deployment Set a new size for a deployment or replication controller .PP -Scale also allows users to specify one or more preconditions for the scale action. -If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before the -scale is attempted, and it is guaranteed that the precondition holds true when the -scale is sent to the server. +Scale also allows users to specify one or more preconditions for the scale action. If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server. .PP -Note that scaling a deployment configuration with no deployments will update the -desired replicas in the configuration template. +Note that scaling a deployment configuration with no deployments will update the desired replicas in the configuration template. .SH OPTIONS diff --git a/docs/man/man1/oc-secrets-link.1 b/docs/man/man1/oc-secrets-link.1 index 5925e445d685..373a0e5daf48 100644 --- a/docs/man/man1/oc-secrets-link.1 +++ b/docs/man/man1/oc-secrets-link.1 @@ -16,7 +16,7 @@ oc secrets link \- Link secrets to a ServiceAccount Link secrets to a service account .PP -Linking a secret enables a service account to automatically use that secret for some forms of authentication +Linking a secret enables a service account to automatically use that secret for some forms of authentication. .SH OPTIONS diff --git a/docs/man/man1/oc-secrets-new-basicauth.1 b/docs/man/man1/oc-secrets-new-basicauth.1 index 1119bbcd024e..b812eb8250ac 100644 --- a/docs/man/man1/oc-secrets-new-basicauth.1 +++ b/docs/man/man1/oc-secrets-new-basicauth.1 @@ -19,9 +19,7 @@ Create a new basic authentication secret Basic authentication secrets are used to authenticate against SCM servers. .PP -When creating applications, you may have a SCM server that requires basic authentication \- username, password. -In order for the nodes to clone source code on your behalf, they have to have the credentials. You can provide -this information by creating a 'basicauth' secret and attaching it to your service account. +When creating applications, you may have a SCM server that requires basic authentication \- username, password. In order for the nodes to clone source code on your behalf, they have to have the credentials. You can provide this information by creating a 'basicauth' secret and attaching it to your service account. .SH OPTIONS diff --git a/docs/man/man1/oc-secrets-new-dockercfg.1 b/docs/man/man1/oc-secrets-new-dockercfg.1 index 146823359723..e96b1ee77009 100644 --- a/docs/man/man1/oc-secrets-new-dockercfg.1 +++ b/docs/man/man1/oc-secrets-new-dockercfg.1 @@ -19,15 +19,10 @@ Create a new dockercfg secret Dockercfg secrets are used to authenticate against Docker registries. .PP -When using the Docker command line to push images, you can authenticate to a given registry by running - 'docker login DOCKER\_REGISTRY\_SERVER \-\-username=DOCKER\_USER \-\-password=DOCKER\_PASSWORD \-\-email=DOCKER\_EMAIL'. -That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to -authenticate to the registry. +When using the Docker command line to push images, you can authenticate to a given registry by running 'docker login DOCKER REGISTRY SERVER \-\-username=DOCKER USER \-\-password=DOCKER PASSWORD \-\-email=DOCKER \_EMAIL'. That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry. .PP -When creating applications, you may have a Docker registry that requires authentication. In order for the -nodes to pull images on your behalf, they have to have the credentials. You can provide this information -by creating a dockercfg secret and attaching it to your service account. +When creating applications, you may have a Docker registry that requires authentication. In order for the nodes to pull images on your behalf, they have to have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account. .SH OPTIONS diff --git a/docs/man/man1/oc-secrets-new-sshauth.1 b/docs/man/man1/oc-secrets-new-sshauth.1 index fa965c744c7f..9cbf8b2cf25b 100644 --- a/docs/man/man1/oc-secrets-new-sshauth.1 +++ b/docs/man/man1/oc-secrets-new-sshauth.1 @@ -19,9 +19,7 @@ Create a new SSH authentication secret SSH authentication secrets are used to authenticate against SCM servers. .PP -When creating applications, you may have a SCM server that requires SSH authentication \- private SSH key. -In order for the nodes to clone source code on your behalf, they have to have the credentials. You can -provide this information by creating a 'sshauth' secret and attaching it to your service account. +When creating applications, you may have a SCM server that requires SSH authentication \- private SSH key. In order for the nodes to clone source code on your behalf, they have to have the credentials. You can provide this information by creating a 'sshauth' secret and attaching it to your service account. .SH OPTIONS diff --git a/docs/man/man1/oc-secrets-new.1 b/docs/man/man1/oc-secrets-new.1 index 4f66d7a542b3..531b2f812657 100644 --- a/docs/man/man1/oc-secrets-new.1 +++ b/docs/man/man1/oc-secrets-new.1 @@ -16,9 +16,7 @@ oc secrets new \- Create a new secret based on a key file or on files within a d Create a new secret based on a file or directory .PP -Key files can be specified using their file path, in which case a default name will be given to them, or optionally -with a name and file path, in which case the given name will be used. Specifying a directory will create a secret -using with all valid keys in that directory. +Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will create a secret using with all valid keys in that directory. .SH OPTIONS diff --git a/docs/man/man1/oc-secrets.1 b/docs/man/man1/oc-secrets.1 index 1c74aba4b1d5..fbc2acdca395 100644 --- a/docs/man/man1/oc-secrets.1 +++ b/docs/man/man1/oc-secrets.1 @@ -16,9 +16,7 @@ oc secrets \- Manage secrets Manage secrets in your project .PP -Secrets are used to store confidential information that should not be contained inside of an image. -They are commonly used to hold things like keys for authentication to other internal systems like -Docker registries. +Secrets are used to store confidential information that should not be contained inside of an image. They are commonly used to hold things like keys for authentication to other internal systems like Docker registries. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-serviceaccounts-get-token.1 b/docs/man/man1/oc-serviceaccounts-get-token.1 index 5806a2f10186..7e5b9abfa398 100644 --- a/docs/man/man1/oc-serviceaccounts-get-token.1 +++ b/docs/man/man1/oc-serviceaccounts-get-token.1 @@ -19,9 +19,7 @@ Get a token assigned to a service account. 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. +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 INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-serviceaccounts-new-token.1 b/docs/man/man1/oc-serviceaccounts-new-token.1 index 18847fe186b0..e441fd880a8f 100644 --- a/docs/man/man1/oc-serviceaccounts-new-token.1 +++ b/docs/man/man1/oc-serviceaccounts-new-token.1 @@ -16,11 +16,7 @@ oc serviceaccounts new\-token \- Generate a new token for a service account. Generate a new token for a service account. .PP -Service account API tokens are used by service accounts to authenticate to the API. -This command will generate a new token, which could be used to compartmentalize service -account actions by executing them with distinct tokens, to rotate out pre\-existing token -on the service account, or for use by an external client. If a label is provided, it will -be applied to any created token so that tokens created with this command can be idenitifed. +Service account API tokens are used by service accounts to authenticate to the API. This command will generate a new token, which could be used to compartmentalize service account actions by executing them with distinct tokens, to rotate out pre\-existing token on the service account, or for use by an external client. If a label is provided, it will be applied to any created token so that tokens created with this command can be idenitifed. .SH OPTIONS diff --git a/docs/man/man1/oc-set-build-hook.1 b/docs/man/man1/oc-set-build-hook.1 index f3a4ba7fbfe5..d17140edb791 100644 --- a/docs/man/man1/oc-set-build-hook.1 +++ b/docs/man/man1/oc-set-build-hook.1 @@ -19,17 +19,10 @@ Set or remove a build hook on a build config Build hooks allow behavior to be injected into the build process. .PP -A post\-commit build hook is executed after a build has committed an image but before the -image has been pushed to a registry. It can be used to execute tests on the image and verify -it before it is made available in a registry or for any other logic that is needed to execute -before the image is pushed to the registry. A new container with the recently built image is -launched with the build hook command. If the command or script run by the build hook returns a -non\-zero exit code, the resulting image will not be pushed to the registry. +A post\-commit build hook is executed after a build has committed an image but before the image has been pushed to a registry. It can be used to execute tests on the image and verify it before it is made available in a registry or for any other logic that is needed to execute before the image is pushed to the registry. A new container with the recently built image is launched with the build hook command. If the command or script run by the build hook returns a non\-zero exit code, the resulting image will not be pushed to the registry. .PP -The command for a build hook may be specified as a shell script (with the \-\-script argument), -as a new entrypoint command on the image with the \-\-command argument, or as a set of -arguments to the image's entrypoint (default). +The command for a build hook may be specified as a shell script (with the \-\-script argument), as a new entrypoint command on the image with the \-\-command argument, or as a set of arguments to the image's entrypoint (default). .SH OPTIONS diff --git a/docs/man/man1/oc-set-deployment-hook.1 b/docs/man/man1/oc-set-deployment-hook.1 index 7078c91f64d1..ce52fd4f36ad 100644 --- a/docs/man/man1/oc-set-deployment-hook.1 +++ b/docs/man/man1/oc-set-deployment-hook.1 @@ -16,29 +16,19 @@ oc set deployment\-hook \- Update a deployment hook on a deployment config Set or remove a deployment hook on a deployment config .PP -Deployment configs allow hooks to execute at different points in the lifecycle of the -deployment, depending on the deployment strategy. +Deployment configs allow hooks to execute at different points in the lifecycle of the deployment, depending on the deployment strategy. .PP -For deployments with a Recreate strategy, a Pre, Mid, and Post hook can be specified. -The Pre hook will execute before the deployment starts. The Mid hook will execute once the -previous deployment has been scaled down to 0, but before the new one ramps up. -The Post hook will execute once the deployment has completed. +For deployments with a Recreate strategy, a Pre, Mid, and Post hook can be specified. The Pre hook will execute before the deployment starts. The Mid hook will execute once the previous deployment has been scaled down to 0, but before the new one ramps up. The Post hook will execute once the deployment has completed. .PP -For deployments with a Rolling strategy, a Pre and Post hook can be specified. -The Pre hook will execute before the deployment starts and the Post hook will execute once -the deployment has completed. +For deployments with a Rolling strategy, a Pre and Post hook can be specified. The Pre hook will execute before the deployment starts and the Post hook will execute once the deployment has completed. .PP -For each hook, a new pod will be started using one of the containers in the deployment's pod -template with a specific command to execute. Additional environment variables may be specified -for the hook, as well as which volumes from the pod template will be mounted on the hook pod. +For each hook, a new pod will be started using one of the containers in the deployment's pod template with a specific command to execute. Additional environment variables may be specified for the hook, as well as which volumes from the pod template will be mounted on the hook pod. .PP -Each hook can have its own cancellation policy. One of: abort, retry, or ignore. Not all cancellation -policies can be set on all hooks. For example, a Post hook on a rolling strategy does not support -the abort policy, because at that point the deployment has already happened. +Each hook can have its own cancellation policy. One of: abort, retry, or ignore. Not all cancellation policies can be set on all hooks. For example, a Post hook on a rolling strategy does not support the abort policy, because at that point the deployment has already happened. .SH OPTIONS diff --git a/docs/man/man1/oc-set-env.1 b/docs/man/man1/oc-set-env.1 index 32ccc55b9d81..0dc19666351e 100644 --- a/docs/man/man1/oc-set-env.1 +++ b/docs/man/man1/oc-set-env.1 @@ -16,17 +16,10 @@ oc set env \- Update environment variables on a pod template Update environment variables on a pod template or a build config .PP -List environment variable definitions in one or more pods, pod templates or build -configuration. -Add, update, or remove container environment variable definitions in one or -more pod templates (within replication controllers or deployment configurations) or -build configurations. -View or modify the environment variable definitions on all containers in the -specified pods or pod templates, or just those that match a wildcard. +List environment variable definitions in one or more pods, pod templates or build configuration. Add, update, or remove container environment variable definitions in one or more pod templates (within replication controllers or deployment configurations) or build configurations. View or modify the environment variable definitions on all containers in the specified pods or pod templates, or just those that match a wildcard. .PP -If "\-\-env \-" is passed, environment variables can be read from STDIN using the standard env -syntax. +If "\-\-env \-" is passed, environment variables can be read from STDIN using the standard env syntax. .SH OPTIONS diff --git a/docs/man/man1/oc-set-probe.1 b/docs/man/man1/oc-set-probe.1 index d332287032ef..f5639d60af9d 100644 --- a/docs/man/man1/oc-set-probe.1 +++ b/docs/man/man1/oc-set-probe.1 @@ -16,13 +16,7 @@ oc set probe \- Update a probe on a pod template Set or remove a liveness or readiness probe from a pod or pod template .PP -Each container in a pod may define one or more probes that are used for general health -checking. A liveness probe is checked periodically to ensure the container is still healthy: -if the probe fails, the container is restarted. Readiness probes set or clear the ready -flag for each container, which controls whether the container's ports are included in the list -of endpoints for a service and whether a deployment can proceed. A readiness check should -indicate when your container is ready to accept incoming traffic or begin handling work. -Setting both liveness and readiness probes for each container is highly recommended. +Each container in a pod may define one or more probes that are used for general health checking. A liveness probe is checked periodically to ensure the container is still healthy: if the probe fails, the container is restarted. Readiness probes set or clear the ready flag for each container, which controls whether the container's ports are included in the list of endpoints for a service and whether a deployment can proceed. A readiness check should indicate when your container is ready to accept incoming traffic or begin handling work. Setting both liveness and readiness probes for each container is highly recommended. .PP The three probe types are: @@ -30,14 +24,15 @@ The three probe types are: .IP \(bu Open a TCP socket on the pod IP +.br .IP \(bu Perform an HTTP GET against a URL on a container that must return 200 OK +.br .IP \(bu Run a command in the container that must return exit code 0 +.br .PP -Containers that take a variable amount of time to start should set generous -initial\-delay\-seconds values, otherwise as your application evolves you may suddenly begin -to fail. +Containers that take a variable amount of time to start should set generous initial\-delay\-seconds values, otherwise as your application evolves you may suddenly begin to fail. .SH OPTIONS diff --git a/docs/man/man1/oc-set-route-backends.1 b/docs/man/man1/oc-set-route-backends.1 index 4c09918acfa2..13d3fe62d376 100644 --- a/docs/man/man1/oc-set-route-backends.1 +++ b/docs/man/man1/oc-set-route-backends.1 @@ -16,34 +16,19 @@ oc set route\-backends \- Update the backends for a route Set and adjust route backends .PP -Routes may have one or more optional backend services with weights controlling how much -traffic flows to each service. Traffic is assigned proportional to the combined weights -of each backend. A weight of zero means that the backend will receive no traffic. If all -weights are zero the route will not send traffic to any backends. +Routes may have one or more optional backend services with weights controlling how much traffic flows to each service. Traffic is assigned proportional to the combined weights of each backend. A weight of zero means that the backend will receive no traffic. If all weights are zero the route will not send traffic to any backends. .PP -When setting backends, the first backend is the primary and the other backends are -considered alternates. For example: +When setting backends, the first backend is the primary and the other backends are considered alternates. For example: .PP -.RS - -.nf $ oc set route\-backends web prod=99 canary=1 -.fi -.RE - .PP -will set the primary backend to service "prod" with a weight of 99 and the first -alternate backend to service "canary" with a weight of 1. This means 99% of traffic will -be sent to the service "prod". +will set the primary backend to service "prod" with a weight of 99 and the first alternate backend to service "canary" with a weight of 1. This means 99% of traffic will be sent to the service "prod". .PP -The \-\-adjust flag allows you to alter the weight of an individual service relative to -itself or to the primary backend. Specifying a percentage will adjust the backend -relative to either the primary or the first alternate (if you specify the primary). -If there are other backends their weights will be kept proportional to the changed. +The \-\-adjust flag allows you to alter the weight of an individual service relative to itself or to the primary backend. Specifying a percentage will adjust the backend relative to either the primary or the first alternate (if you specify the primary). If there are other backends their weights will be kept proportional to the changed. .PP Not all routers may support multiple or weighted backends. diff --git a/docs/man/man1/oc-set-triggers.1 b/docs/man/man1/oc-set-triggers.1 index 98913179ba3b..22dbfd54ae69 100644 --- a/docs/man/man1/oc-set-triggers.1 +++ b/docs/man/man1/oc-set-triggers.1 @@ -16,18 +16,13 @@ oc set triggers \- Update the triggers on a build or deployment config Set or remove triggers for build configs and deployment configs .PP -All build configs and deployment configs may have a set of triggers that result in a new deployment -or build being created. This command enables you to alter those triggers \- making them automatic or -manual, adding new entries, or changing existing entries. +All build configs and deployment configs may have a set of triggers that result in a new deployment or build being created. This command enables you to alter those triggers \- making them automatic or manual, adding new entries, or changing existing entries. .PP -Deployments support triggering off of image changes and on config changes. Config changes are any -alterations to the pod template, while image changes will result in the container image value being -updated whenever an image stream tag is updated. +Deployments support triggering off of image changes and on config changes. Config changes are any alterations to the pod template, while image changes will result in the container image value being updated whenever an image stream tag is updated. .PP -Build configs support triggering off of image changes, config changes, and webhooks (both GitHub\-specific -and generic). The config change trigger for a build config will only trigger the first build. +Build configs support triggering off of image changes, config changes, and webhooks (both GitHub\-specific and generic). The config change trigger for a build config will only trigger the first build. .SH OPTIONS diff --git a/docs/man/man1/oc-set-volumes.1 b/docs/man/man1/oc-set-volumes.1 index 1552624659e7..04ca1149b626 100644 --- a/docs/man/man1/oc-set-volumes.1 +++ b/docs/man/man1/oc-set-volumes.1 @@ -16,36 +16,27 @@ oc set volumes \- Update volumes on a pod template Update volumes on a pod template .PP -This command can add, update or remove volumes from containers for any object -that has a pod template (deployment configs, replication controllers, or pods). -You can list volumes in pod or any object that has a pod template. You can -specify a single object or multiple, and alter volumes on all containers or -just those that match a given name. +This command can add, update or remove volumes from containers for any object that has a pod template (deployment configs, replication controllers, or pods). You can list volumes in pod or any object that has a pod template. You can specify a single object or multiple, and alter volumes on all containers or just those that match a given name. .PP -If you alter a volume setting on a deployment config, a deployment will be -triggered. Changing a replication controller will not affect running pods, and -you cannot change a pod's volumes once it has been created. +If you alter a volume setting on a deployment config, a deployment will be triggered. Changing a replication controller will not affect running pods, and you cannot change a pod's volumes once it has been created. .PP Volume types include: .IP .IP -\(bu emptydir (empty directory) \fIdefault\fP -A directory allocated when the pod is created on a local host, is removed when -the pod is deleted and is not copied across servers +\(bu emptydir (empty directory) default : A directory allocated when the pod is created on a local host, is removed when the pod is deleted and is not copied across servers +.br .IP -\(bu hostdir (host directory) -A directory with specific path on any host (requires elevated privileges) +\(bu hostdir (host directory): A directory with specific path on any host (requires elevated privileges) +.br .IP -\(bu persistentvolumeclaim or pvc (persistent volume claim) -Link the volume directory in the container to a persistent volume claim you have -allocated by name \- a persistent volume claim is a request to allocate storage. -Note that if your claim hasn't been bound, your pods will not start. +\(bu persistentvolumeclaim or pvc (persistent volume claim): Link the volume directory in the container to a persistent volume claim you have allocated by name \- a persistent volume claim is a request to allocate storage. Note that if your claim hasn't been bound, your pods will not start. +.br .IP -\(bu secret (mounted secret) -Secret volumes mount a named secret to the provided directory. +\(bu secret (mounted secret): Secret volumes mount a named secret to the provided directory. +.br .PP For descriptions on other volume types, see \[la]https://docs.openshift.com\[ra] diff --git a/docs/man/man1/oc-start-build.1 b/docs/man/man1/oc-start-build.1 index cf29cc568131..89e0424311c7 100644 --- a/docs/man/man1/oc-start-build.1 +++ b/docs/man/man1/oc-start-build.1 @@ -16,17 +16,10 @@ oc start\-build \- Start a new build Start a build .PP -This command starts a new build for the provided build config or copies an existing build using -\-\-from\-build=. Pass the \-\-follow flag to see output from the build. +This command starts a new build for the provided build config or copies an existing build using \-\-from\-build= . Pass the \-\-follow flag to see output from the build. .PP -In addition, you can pass a file, directory, or source code repository with the \-\-from\-file, -\-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the build -and override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can be -used to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, the -file is placed in the root of an empty directory with the same filename. Note that builds -triggered from binary input will not preserve the source on the server, so rebuilds triggered by -base image changes will use the source specified on the build config. +In addition, you can pass a file, directory, or source code repository with the \-\-from\-file, \-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the build and override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can be used to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, the file is placed in the root of an empty directory with the same filename. Note that builds triggered from binary input will not preserve the source on the server, so rebuilds triggered by base image changes will use the source specified on the build config. .SH OPTIONS diff --git a/docs/man/man1/oc-status.1 b/docs/man/man1/oc-status.1 index a3088c84df03..3986dbecaec8 100644 --- a/docs/man/man1/oc-status.1 +++ b/docs/man/man1/oc-status.1 @@ -16,14 +16,10 @@ oc status \- Show an overview of the current project Show a high level overview of the current project .PP -This command will show services, deployment configs, build configurations, and active deployments. -If you have any misconfigured components information about them will be shown. For more information -about individual items, use the describe command (e.g. oc describe buildConfig, -oc describe deploymentConfig, oc describe service). +This command will show services, deployment configs, build configurations, and active deployments. If you have any misconfigured components information about them will be shown. For more information about individual items, use the describe command (e.g. oc describe buildConfig, oc describe deploymentConfig, oc describe service). .PP -You can specify an output format of "\-o dot" to have this command output the generated status -graph in DOT format that is suitable for use by the "dot" command. +You can specify an output format of "\-o dot" to have this command output the generated status graph in DOT format that is suitable for use by the "dot" command. .SH OPTIONS diff --git a/docs/man/man1/oc-tag.1 b/docs/man/man1/oc-tag.1 index f2183afb1468..667579981515 100644 --- a/docs/man/man1/oc-tag.1 +++ b/docs/man/man1/oc-tag.1 @@ -16,17 +16,10 @@ oc tag \- Tag existing images into image streams Tag existing images into image streams .PP -The tag command allows you to take an existing tag or image from an image -stream, or a Docker image pull spec, and set it as the most recent image for a -tag in 1 or more other image streams. It is similar to the 'docker tag' -command, but it operates on image streams instead. +The tag command allows you to take an existing tag or image from an image stream, or a Docker image pull spec, and set it as the most recent image for a tag in 1 or more other image streams. It is similar to the 'docker tag' command, but it operates on image streams instead. .PP -Pass the \-\-insecure flag if your external registry does not have a valid HTTPS -certificate, or is only served over HTTP. Pass \-\-scheduled to have the server -regularly check the tag for updates and import the latest version (which can -then trigger builds and deployments). Note that \-\-scheduled is only allowed for -Docker images. +Pass the \-\-insecure flag if your external registry does not have a valid HTTPS certificate, or is only served over HTTP. Pass \-\-scheduled to have the server regularly check the tag for updates and import the latest version (which can then trigger builds and deployments). Note that \-\-scheduled is only allowed for Docker images. .SH OPTIONS diff --git a/docs/man/man1/oc-whoami.1 b/docs/man/man1/oc-whoami.1 index 7c9899317ee8..e3c84c11e52e 100644 --- a/docs/man/man1/oc-whoami.1 +++ b/docs/man/man1/oc-whoami.1 @@ -16,9 +16,7 @@ oc whoami \- Return information about the current session Show information about the current session .PP -The default options for this command will return the currently authenticated user name -or an empty string. Other flags support returning the currently used token or the -user context. +The default options for this command will return the currently authenticated user name or an empty string. Other flags support returning the currently used token or the user context. .SH OPTIONS diff --git a/docs/man/man1/oc.1 b/docs/man/man1/oc.1 index 65b973c14cb7..32a7d1dbe5f9 100644 --- a/docs/man/man1/oc.1 +++ b/docs/man/man1/oc.1 @@ -16,9 +16,7 @@ oc \- Command line tools for managing applications OpenShift Client .PP -This client helps you develop, build, deploy, and run your applications on any OpenShift or -Kubernetes compatible platform. It also includes the administrative commands for managing a -cluster under the 'adm' subcommand. +This client helps you develop, build, deploy, and run your applications on any OpenShift or Kubernetes compatible platform. It also includes the administrative commands for managing a cluster under the 'adm' subcommand. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-build-chain.1 b/docs/man/man1/openshift-admin-build-chain.1 index 0bcd8e8e36cf..8abce7b90090 100644 --- a/docs/man/man1/openshift-admin-build-chain.1 +++ b/docs/man/man1/openshift-admin-build-chain.1 @@ -16,9 +16,7 @@ openshift admin build\-chain \- Output the inputs and dependencies of your build 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 the default namespace will be used respectively. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-ca-decrypt.1 b/docs/man/man1/openshift-admin-ca-decrypt.1 index 9251bc619474..28a88de5cec6 100644 --- a/docs/man/man1/openshift-admin-ca-decrypt.1 +++ b/docs/man/man1/openshift-admin-ca-decrypt.1 @@ -103,7 +103,7 @@ Decrypt data encrypted with "openshift admin ca encrypt" .nf # Decrypt an encrypted file to a cleartext file: openshift admin ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted - + # Decrypt from stdin to stdout: openshift admin ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted diff --git a/docs/man/man1/openshift-admin-ca-encrypt.1 b/docs/man/man1/openshift-admin-ca-encrypt.1 index 7c995762b3c1..a0f3b32a140f 100644 --- a/docs/man/man1/openshift-admin-ca-encrypt.1 +++ b/docs/man/man1/openshift-admin-ca-encrypt.1 @@ -107,7 +107,7 @@ Encrypt data with AES\-256\-CBC encryption .nf # Encrypt the content of secret.txt with a generated key: openshift admin ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted - + # Encrypt the content of secret2.txt with an existing key: openshift admin ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted diff --git a/docs/man/man1/openshift-admin-completion.1 b/docs/man/man1/openshift-admin-completion.1 index a63b59fcd5d0..0005054611c3 100644 --- a/docs/man/man1/openshift-admin-completion.1 +++ b/docs/man/man1/openshift-admin-completion.1 @@ -13,8 +13,7 @@ openshift admin completion \- Output shell completion code for the given shell ( .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of openshift admin commands. +This command prints shell code which must be evaluated to provide interactive completion of openshift admin commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-config.1 b/docs/man/man1/openshift-admin-config.1 index 19a5b8d330de..bf31031d5942 100644 --- a/docs/man/man1/openshift-admin-config.1 +++ b/docs/man/man1/openshift-admin-config.1 @@ -16,9 +16,7 @@ openshift admin 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 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. .PP Reference: diff --git a/docs/man/man1/openshift-admin-groups-prune.1 b/docs/man/man1/openshift-admin-groups-prune.1 index e1d9af538eac..be7afc0e0831 100644 --- a/docs/man/man1/openshift-admin-groups-prune.1 +++ b/docs/man/man1/openshift-admin-groups-prune.1 @@ -16,13 +16,7 @@ openshift admin groups prune \- Prune OpenShift groups referencing missing recor Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-groups-sync.1 b/docs/man/man1/openshift-admin-groups-sync.1 index b4e14245d503..23a6bb1d5728 100644 --- a/docs/man/man1/openshift-admin-groups-sync.1 +++ b/docs/man/man1/openshift-admin-groups-sync.1 @@ -16,13 +16,7 @@ openshift admin groups sync \- Sync OpenShift groups with records from an extern Sync OpenShift Groups with records from an external provider. .PP -In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish -to sync and where their records live. For instance, all or some groups may be selected from the current Groups -stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those -stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is -requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run -without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the -LDAP query templates. +In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish to sync and where their records live. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the LDAP query templates. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-ipfailover.1 b/docs/man/man1/openshift-admin-ipfailover.1 index 7114bf8345fa..d210a37dc600 100644 --- a/docs/man/man1/openshift-admin-ipfailover.1 +++ b/docs/man/man1/openshift-admin-ipfailover.1 @@ -16,17 +16,10 @@ openshift admin ipfailover \- Install an IP failover group to a set of nodes Configure or view IP Failover configuration .PP -This command helps to setup an IP failover configuration for the -cluster. An administrator can configure IP failover on an entire -cluster or on a subset of nodes (as defined via a labeled selector). +This command helps to setup an IP failover configuration for the cluster. An administrator can configure IP failover on an entire cluster or on a subset of nodes (as defined via a labeled selector). .PP -If an IP failover configuration does not exist with the given name, -the \-\-create flag can be passed to create a deployment configuration that -will provide IP failover capability. If you are running in production, it is -recommended that the labeled selector for the nodes matches at least 2 nodes -to ensure you have failover protection, and that you provide a \-\-replicas= -value that matches the number of nodes for the given labeled selector. +If an IP failover configuration does not exist with the given name, the \-\-create flag can be passed to create a deployment configuration that will provide IP failover capability. If you are running in production, it is recommended that the labeled selector for the nodes matches at least 2 nodes to ensure you have failover protection, and that you provide a \-\-replicas= value that matches the number of nodes for the given labeled selector. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-manage-node.1 b/docs/man/man1/openshift-admin-manage-node.1 index 39dc6473cff1..ee1cfaa3331e 100644 --- a/docs/man/man1/openshift-admin-manage-node.1 +++ b/docs/man/man1/openshift-admin-manage-node.1 @@ -19,8 +19,7 @@ Manage nodes This command provides common operations on nodes for administrators. .PP -schedulable: Marking node schedulable will allow pods to be schedulable on the node and - marking node unschedulable will block pods to be scheduled on the node. +schedulable: Marking node schedulable will allow pods to be schedulable on the node and marking node unschedulable will block pods to be scheduled on the node. .PP evacuate: Migrate all/selected pod on the provided nodes. @@ -166,26 +165,26 @@ list\-pods: List all/selected pods on given/selected nodes. It can list the outp .RS .nf - # Block accepting any pods on given nodes - openshift admin manage\-node \-\-schedulable=false + # Block accepting any pods on given nodes + openshift admin manage\-node \-\-schedulable=false - # Mark selected nodes as schedulable - openshift admin manage\-node \-\-selector="" \-\-schedulable=true + # Mark selected nodes as schedulable + openshift admin manage\-node \-\-selector="" \-\-schedulable=true - # Migrate selected pods - openshift admin manage\-node \-\-evacuate \-\-pod\-selector="" + # Migrate selected pods + openshift admin manage\-node \-\-evacuate \-\-pod\-selector="" - # Migrate selected pods, use a grace period of 60 seconds - openshift admin manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" + # Migrate selected pods, use a grace period of 60 seconds + openshift admin manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" - # Migrate selected pods not backed by replication controller - openshift admin manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" + # Migrate selected pods not backed by replication controller + openshift admin manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" - # Show pods that will be migrated - openshift admin manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" + # Show pods that will be migrated + openshift admin manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" - # List all pods on given nodes - openshift admin manage\-node \-\-list\-pods + # List all pods on given nodes + openshift admin manage\-node \-\-list\-pods .fi .RE diff --git a/docs/man/man1/openshift-admin-migrate-image-references.1 b/docs/man/man1/openshift-admin-migrate-image-references.1 index 24a995842928..9eddeff71378 100644 --- a/docs/man/man1/openshift-admin-migrate-image-references.1 +++ b/docs/man/man1/openshift-admin-migrate-image-references.1 @@ -16,34 +16,44 @@ openshift admin migrate image\-references \- Update embedded Docker image refere Migrate references to Docker images .PP -This command updates embedded Docker image references on the server in place. By default it -will update image streams and images, and may be used to update resources with a pod template -(deployments, replication controllers, daemon sets). +This command updates embedded Docker image references on the server in place. By default it will update image streams and images, and may be used to update resources with a pod template (deployments, replication controllers, daemon sets). .PP -References are changed by providing a mapping between a source registry and name and the -desired registry and name. Either name or registry can be set to '*' to change all values. -The registry value "docker.io" is special and will handle any image reference that refers to -the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied -per resource. +References are changed by providing a mapping between a source registry and name and the desired registry and name. Either name or registry can be set to ' *' to change all values. The registry value "docker.io" is special and will handle any image reference that refers to the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied per resource. .PP The following resource types may be migrated by this command: .IP .IP -\(bu images * daemonsets +\(bu buildconfigs +.br .IP -\(bu imagestreams * jobs +\(bu daemonsets +.br .IP -\(bu buildconfigs * replicationcontrollers +\(bu deploymentconfigs +.br .IP -\(bu deploymentconfigs * pods +\(bu images +.br +.IP +\(bu imagestreams +.br +.IP +\(bu jobs +.br +.IP +\(bu pods +.br +.IP +\(bu replicationcontrollers +.br .IP \(bu secrets (docker) +.br .PP -Only images, imagestreams, and secrets are updated by default. Updating images and image -streams requires administrative privileges. +Only images, imagestreams, and secrets are updated by default. Updating images and image streams requires administrative privileges. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-migrate-storage.1 b/docs/man/man1/openshift-admin-migrate-storage.1 index 2f5e34eae891..9130fb1deb2f 100644 --- a/docs/man/man1/openshift-admin-migrate-storage.1 +++ b/docs/man/man1/openshift-admin-migrate-storage.1 @@ -16,25 +16,16 @@ openshift admin migrate storage \- Update the stored version of API objects Migrate internal object storage via update .PP -This command invokes an update operation on every API object reachable by the caller. This forces -the server to write to the underlying storage if the object representation has changed. Use this -command to ensure that the most recent storage changes have been applied to all objects (storage -version, storage encoding, any newer object defaults). +This command invokes an update operation on every API object reachable by the caller. This forces the server to write to the underlying storage if the object representation has changed. Use this command to ensure that the most recent storage changes have been applied to all objects (storage version, storage encoding, any newer object defaults). .PP -To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run -the command will output a list of resources that received errors, which you can then re\-run the -command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names -to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped -resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. +To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run the command will output a list of resources that received errors, which you can then re\-run the command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. .PP -By default, events are not migrated since they expire within a very short period of time. If you -have significantly increased the expiration time of events, run a migration with \-\-include=events +By default, events are not migrated since they expire within a very short period of time. If you have significantly increased the expiration time of events, run a migration with \-\-include=events .PP -WARNING: This is a slow command and will put significant load on an API server. It may also - result in significant intra\-cluster traffic. +WARNING: This is a slow command and will put significant load on an API server. It may also result in significant intra\-cluster traffic. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-new-project.1 b/docs/man/man1/openshift-admin-new-project.1 index bb8127e07eaa..e49976feb4f1 100644 --- a/docs/man/man1/openshift-admin-new-project.1 +++ b/docs/man/man1/openshift-admin-new-project.1 @@ -16,9 +16,7 @@ openshift admin new\-project \- Create a new project Create a new project .PP -Use this command to create a project. You may optionally specify metadata about the project, -an admin user (and role, if you want to use a non\-default admin role), and a node selector -to restrict which nodes pods in this project can be scheduled to. +Use this command to create a project. You may optionally specify metadata about the project, an admin user (and role, if you want to use a non\-default admin role), and a node selector to restrict which nodes pods in this project can be scheduled to. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 index e820605cbe64..21100f6cc937 100644 --- a/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 @@ -16,9 +16,7 @@ openshift admin policy reconcile\-cluster\-role\-bindings \- Update cluster role Update cluster role bindings to match the recommended bootstrap policy .PP -This command will inspect the cluster role bindings against the recommended bootstrap policy. -Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. -This command will not remove any additional cluster role bindings. +This command will inspect the cluster role bindings against the recommended bootstrap policy. Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. This command will not remove any additional cluster role bindings. .PP You can see which recommended cluster role bindings have changed by choosing an output type. diff --git a/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 b/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 index e4d2560fdea9..e3f39acebdfb 100644 --- a/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 @@ -16,9 +16,7 @@ openshift admin policy reconcile\-cluster\-roles \- Update cluster roles to matc Update cluster roles to match the recommended bootstrap policy .PP -This command will compare cluster roles against the recommended bootstrap policy. Any cluster role -that does not match will be replaced by the recommended bootstrap role. This command will not remove -any additional cluster role. +This command will compare cluster roles against the recommended bootstrap policy. Any cluster role that does not match will be replaced by the recommended bootstrap role. This command will not remove any additional cluster role. .PP Cluster roles with the annotation openshift.io/reconcile\-protect set to "true" are skipped. diff --git a/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 b/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 index 502ee16517af..4a9304f8ec32 100644 --- a/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 +++ b/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 @@ -16,12 +16,7 @@ openshift admin policy reconcile\-sccs \- Replace cluster SCCs to match the reco Replace cluster SCCs to match the recommended bootstrap policy .PP -This command will inspect the cluster SCCs against the recommended bootstrap SCCs. -Any cluster SCC that does not match will be replaced by the recommended SCC. -This command will not remove any additional cluster SCCs. By default, this command -will not remove additional users and groups that have been granted access to the SCC and -will preserve existing priorities (but will always reconcile unset priorities and the policy -definition). +This command will inspect the cluster SCCs against the recommended bootstrap SCCs. Any cluster SCC that does not match will be replaced by the recommended SCC. This command will not remove any additional cluster SCCs. By default, this command will not remove additional users and groups that have been granted access to the SCC and will preserve existing priorities (but will always reconcile unset priorities and the policy definition). .PP You can see which cluster SCCs have recommended changes by choosing an output type. diff --git a/docs/man/man1/openshift-admin-policy.1 b/docs/man/man1/openshift-admin-policy.1 index 1743df74a546..5396696af8bb 100644 --- a/docs/man/man1/openshift-admin-policy.1 +++ b/docs/man/man1/openshift-admin-policy.1 @@ -16,13 +16,10 @@ openshift admin policy \- Manage policy Manage policy on the cluster .PP -These commands allow you to assign and manage the roles and policies that apply to users. The reconcile -commands allow you to reset and upgrade your system policies to the latest default policies. +These commands allow you to assign and manage the roles and policies that apply to users. The reconcile commands allow you to reset and upgrade your system policies to the latest default policies. .PP -To see more information on roles and policies, use the 'get' and 'describe' commands on the following -resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', -and 'scc'. +To see more information on roles and policies, use the 'get' and 'describe' commands on the following resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', and 'scc'. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-prune-groups.1 b/docs/man/man1/openshift-admin-prune-groups.1 index f3d8b09210a5..47411f1609ef 100644 --- a/docs/man/man1/openshift-admin-prune-groups.1 +++ b/docs/man/man1/openshift-admin-prune-groups.1 @@ -16,13 +16,7 @@ openshift admin prune groups \- Prune OpenShift groups referencing missing recor Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-prune.1 b/docs/man/man1/openshift-admin-prune.1 index 80c6b13267d6..70151459cdde 100644 --- a/docs/man/man1/openshift-admin-prune.1 +++ b/docs/man/man1/openshift-admin-prune.1 @@ -16,8 +16,7 @@ openshift admin prune \- Remove older versions of resources from the server Remove older versions of resources from the server .PP -The commands here allow administrators to manage the older versions of resources on -the system by removing them. +The commands here allow administrators to manage the older versions of resources on the system by removing them. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-registry.1 b/docs/man/man1/openshift-admin-registry.1 index dae6f5d8f4b4..bb80ccb8aeb7 100644 --- a/docs/man/man1/openshift-admin-registry.1 +++ b/docs/man/man1/openshift-admin-registry.1 @@ -16,28 +16,16 @@ openshift admin registry \- Install the integrated Docker registry Install or configure an integrated Docker registry .PP -This command sets up a Docker registry integrated with your cluster to provide notifications when -images are pushed. With no arguments, the command will check for the existing registry service -called 'docker\-registry' and try to create it. If you want to test whether the registry has -been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not -exist. +This command sets up a Docker registry integrated with your cluster to provide notifications when images are pushed. With no arguments, the command will check for the existing registry service called 'docker\-registry' and try to create it. If you want to test whether the registry has been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not exist. .PP -To run a highly available registry, you should be using a remote storage mechanism like an -object store (several are supported by the Docker registry). The default Docker registry image -is configured to accept configuration as environment variables \- refer to the configuration file in -that image for more on setting up alternative storage. Once you've made those changes, you can -pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup -uses a local volume and the data will be lost if you delete the running pod. +To run a highly available registry, you should be using a remote storage mechanism like an object store (several are supported by the Docker registry). The default Docker registry image is configured to accept configuration as environment variables \- refer to the configuration file in that image for more on setting up alternative storage. Once you've made those changes, you can pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup uses a local volume and the data will be lost if you delete the running pod. .PP -If multiple ports are specified using the option \-\-ports, the first specified port will be -chosen for use as the REGISTRY\_HTTP\_ADDR and will be passed to Docker registry. +If multiple ports are specified using the option \-\-ports, the first specified port will be chosen for use as the REGISTRY HTTP ADDR and will be passed to Docker registry. .PP -NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new - installation. Some configuration beyond this command is still required to make - your registry persist data. +NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new installation. Some configuration beyond this command is still required to make your registry persist data. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-router.1 b/docs/man/man1/openshift-admin-router.1 index c89580846107..d227f9bdf878 100644 --- a/docs/man/man1/openshift-admin-router.1 +++ b/docs/man/man1/openshift-admin-router.1 @@ -16,17 +16,10 @@ openshift admin router \- Install a router Install or configure a router .PP -This command helps to setup a router to take edge traffic and balance it to -your application. With no arguments, the command will check for an existing router -service called 'router' and create one if it does not exist. If you want to test whether -a router has already been created add the \-\-dry\-run flag and the command will exit with -1 if the registry does not exist. +This command helps to setup a router to take edge traffic and balance it to your application. With no arguments, the command will check for an existing router service called 'router' and create one if it does not exist. If you want to test whether a router has already been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not exist. .PP -If a router does not exist with the given name, this command will -create a deployment configuration and service that will run the router. If you are -running your router in production, you should pass \-\-replicas=2 or higher to ensure -you have failover protection. +If a router does not exist with the given name, this command will create a deployment configuration and service that will run the router. If you are running your router in production, you should pass \-\-replicas=2 or higher to ensure you have failover protection. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-top-images.1 b/docs/man/man1/openshift-admin-top-images.1 index 31fec38d52c2..6d3d01350ea4 100644 --- a/docs/man/man1/openshift-admin-top-images.1 +++ b/docs/man/man1/openshift-admin-top-images.1 @@ -16,8 +16,7 @@ openshift admin top images \- Show usage statistics for Images Show usage statistics for Images .PP -This command analyzes all the Images managed by the platform and presents current -usage statistics. +This command analyzes all the Images managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-top-imagestreams.1 b/docs/man/man1/openshift-admin-top-imagestreams.1 index 981597a7b109..76c9b89d0f90 100644 --- a/docs/man/man1/openshift-admin-top-imagestreams.1 +++ b/docs/man/man1/openshift-admin-top-imagestreams.1 @@ -16,8 +16,7 @@ openshift admin top imagestreams \- Show usage statistics for ImageStreams Show usage statistics for ImageStreams .PP -This command analyzes all the ImageStreams managed by the platform and presents current -usage statistics. +This command analyzes all the ImageStreams managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-top.1 b/docs/man/man1/openshift-admin-top.1 index 00b14d0e7e34..8b3f2258e0be 100644 --- a/docs/man/man1/openshift-admin-top.1 +++ b/docs/man/man1/openshift-admin-top.1 @@ -16,8 +16,7 @@ openshift admin top \- Show usage statistics of resources on the server Show usage statistics of resources on the server .PP -This command analyzes resources managed by the platform and presents current -usage statistics. +This command analyzes resources managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin.1 b/docs/man/man1/openshift-admin.1 index 1e1e8c7e6b8a..22604c7dd4c5 100644 --- a/docs/man/man1/openshift-admin.1 +++ b/docs/man/man1/openshift-admin.1 @@ -16,8 +16,7 @@ openshift admin \- Tools for managing a cluster Administrative Commands .PP -Commands for managing a cluster are exposed here. Many administrative -actions involve interaction with the command\-line client as well. +Commands for managing a cluster are exposed here. Many administrative actions involve interaction with the command\-line client as well. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-build-chain.1 b/docs/man/man1/openshift-cli-adm-build-chain.1 index c0182cc5a918..7024a5ec04c4 100644 --- a/docs/man/man1/openshift-cli-adm-build-chain.1 +++ b/docs/man/man1/openshift-cli-adm-build-chain.1 @@ -16,9 +16,7 @@ openshift cli adm build\-chain \- Output the inputs and dependencies of your bui 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 the default namespace will be used respectively. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-ca-decrypt.1 b/docs/man/man1/openshift-cli-adm-ca-decrypt.1 index bce23d1286aa..f0142ac9a5ae 100644 --- a/docs/man/man1/openshift-cli-adm-ca-decrypt.1 +++ b/docs/man/man1/openshift-cli-adm-ca-decrypt.1 @@ -103,7 +103,7 @@ Decrypt data encrypted with "openshift cli adm ca encrypt" .nf # Decrypt an encrypted file to a cleartext file: openshift cli adm ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted - + # Decrypt from stdin to stdout: openshift cli adm ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted diff --git a/docs/man/man1/openshift-cli-adm-ca-encrypt.1 b/docs/man/man1/openshift-cli-adm-ca-encrypt.1 index d844bb979a1e..2853cf583a9b 100644 --- a/docs/man/man1/openshift-cli-adm-ca-encrypt.1 +++ b/docs/man/man1/openshift-cli-adm-ca-encrypt.1 @@ -107,7 +107,7 @@ Encrypt data with AES\-256\-CBC encryption .nf # Encrypt the content of secret.txt with a generated key: openshift cli adm ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted - + # Encrypt the content of secret2.txt with an existing key: openshift cli adm ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted diff --git a/docs/man/man1/openshift-cli-adm-completion.1 b/docs/man/man1/openshift-cli-adm-completion.1 index 4e9d5ba0a94a..b0835c3440f1 100644 --- a/docs/man/man1/openshift-cli-adm-completion.1 +++ b/docs/man/man1/openshift-cli-adm-completion.1 @@ -13,8 +13,7 @@ openshift cli adm completion \- Output shell completion code for the given shell .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of openshift cli adm commands. +This command prints shell code which must be evaluated to provide interactive completion of openshift cli adm commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-config.1 b/docs/man/man1/openshift-cli-adm-config.1 index 8bc2109379c4..6f33172bdd66 100644 --- a/docs/man/man1/openshift-cli-adm-config.1 +++ b/docs/man/man1/openshift-cli-adm-config.1 @@ -16,9 +16,7 @@ openshift cli adm 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 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. .PP Reference: diff --git a/docs/man/man1/openshift-cli-adm-groups-prune.1 b/docs/man/man1/openshift-cli-adm-groups-prune.1 index c0d1f2e96f60..501b48d9a053 100644 --- a/docs/man/man1/openshift-cli-adm-groups-prune.1 +++ b/docs/man/man1/openshift-cli-adm-groups-prune.1 @@ -16,13 +16,7 @@ openshift cli adm groups prune \- Prune OpenShift groups referencing missing rec Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-groups-sync.1 b/docs/man/man1/openshift-cli-adm-groups-sync.1 index 30c80194b7d1..f499a7fd52b9 100644 --- a/docs/man/man1/openshift-cli-adm-groups-sync.1 +++ b/docs/man/man1/openshift-cli-adm-groups-sync.1 @@ -16,13 +16,7 @@ openshift cli adm groups sync \- Sync OpenShift groups with records from an exte Sync OpenShift Groups with records from an external provider. .PP -In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish -to sync and where their records live. For instance, all or some groups may be selected from the current Groups -stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those -stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is -requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run -without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the -LDAP query templates. +In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish to sync and where their records live. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the LDAP query templates. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-ipfailover.1 b/docs/man/man1/openshift-cli-adm-ipfailover.1 index 6bd7a6428c77..c37aee68aa48 100644 --- a/docs/man/man1/openshift-cli-adm-ipfailover.1 +++ b/docs/man/man1/openshift-cli-adm-ipfailover.1 @@ -16,17 +16,10 @@ openshift cli adm ipfailover \- Install an IP failover group to a set of nodes Configure or view IP Failover configuration .PP -This command helps to setup an IP failover configuration for the -cluster. An administrator can configure IP failover on an entire -cluster or on a subset of nodes (as defined via a labeled selector). +This command helps to setup an IP failover configuration for the cluster. An administrator can configure IP failover on an entire cluster or on a subset of nodes (as defined via a labeled selector). .PP -If an IP failover configuration does not exist with the given name, -the \-\-create flag can be passed to create a deployment configuration that -will provide IP failover capability. If you are running in production, it is -recommended that the labeled selector for the nodes matches at least 2 nodes -to ensure you have failover protection, and that you provide a \-\-replicas= -value that matches the number of nodes for the given labeled selector. +If an IP failover configuration does not exist with the given name, the \-\-create flag can be passed to create a deployment configuration that will provide IP failover capability. If you are running in production, it is recommended that the labeled selector for the nodes matches at least 2 nodes to ensure you have failover protection, and that you provide a \-\-replicas= value that matches the number of nodes for the given labeled selector. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-manage-node.1 b/docs/man/man1/openshift-cli-adm-manage-node.1 index d25a1c40127c..909aba9f7efd 100644 --- a/docs/man/man1/openshift-cli-adm-manage-node.1 +++ b/docs/man/man1/openshift-cli-adm-manage-node.1 @@ -19,8 +19,7 @@ Manage nodes This command provides common operations on nodes for administrators. .PP -schedulable: Marking node schedulable will allow pods to be schedulable on the node and - marking node unschedulable will block pods to be scheduled on the node. +schedulable: Marking node schedulable will allow pods to be schedulable on the node and marking node unschedulable will block pods to be scheduled on the node. .PP evacuate: Migrate all/selected pod on the provided nodes. @@ -166,26 +165,26 @@ list\-pods: List all/selected pods on given/selected nodes. It can list the outp .RS .nf - # Block accepting any pods on given nodes - openshift cli adm manage\-node \-\-schedulable=false + # Block accepting any pods on given nodes + openshift cli adm manage\-node \-\-schedulable=false - # Mark selected nodes as schedulable - openshift cli adm manage\-node \-\-selector="" \-\-schedulable=true + # Mark selected nodes as schedulable + openshift cli adm manage\-node \-\-selector="" \-\-schedulable=true - # Migrate selected pods - openshift cli adm manage\-node \-\-evacuate \-\-pod\-selector="" + # Migrate selected pods + openshift cli adm manage\-node \-\-evacuate \-\-pod\-selector="" - # Migrate selected pods, use a grace period of 60 seconds - openshift cli adm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" + # Migrate selected pods, use a grace period of 60 seconds + openshift cli adm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" - # Migrate selected pods not backed by replication controller - openshift cli adm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" + # Migrate selected pods not backed by replication controller + openshift cli adm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" - # Show pods that will be migrated - openshift cli adm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" + # Show pods that will be migrated + openshift cli adm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" - # List all pods on given nodes - openshift cli adm manage\-node \-\-list\-pods + # List all pods on given nodes + openshift cli adm manage\-node \-\-list\-pods .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-migrate-image-references.1 b/docs/man/man1/openshift-cli-adm-migrate-image-references.1 index ef73c2788783..ddc15b7b21b2 100644 --- a/docs/man/man1/openshift-cli-adm-migrate-image-references.1 +++ b/docs/man/man1/openshift-cli-adm-migrate-image-references.1 @@ -16,34 +16,44 @@ openshift cli adm migrate image\-references \- Update embedded Docker image refe Migrate references to Docker images .PP -This command updates embedded Docker image references on the server in place. By default it -will update image streams and images, and may be used to update resources with a pod template -(deployments, replication controllers, daemon sets). +This command updates embedded Docker image references on the server in place. By default it will update image streams and images, and may be used to update resources with a pod template (deployments, replication controllers, daemon sets). .PP -References are changed by providing a mapping between a source registry and name and the -desired registry and name. Either name or registry can be set to '*' to change all values. -The registry value "docker.io" is special and will handle any image reference that refers to -the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied -per resource. +References are changed by providing a mapping between a source registry and name and the desired registry and name. Either name or registry can be set to ' *' to change all values. The registry value "docker.io" is special and will handle any image reference that refers to the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied per resource. .PP The following resource types may be migrated by this command: .IP .IP -\(bu images * daemonsets +\(bu buildconfigs +.br .IP -\(bu imagestreams * jobs +\(bu daemonsets +.br .IP -\(bu buildconfigs * replicationcontrollers +\(bu deploymentconfigs +.br .IP -\(bu deploymentconfigs * pods +\(bu images +.br +.IP +\(bu imagestreams +.br +.IP +\(bu jobs +.br +.IP +\(bu pods +.br +.IP +\(bu replicationcontrollers +.br .IP \(bu secrets (docker) +.br .PP -Only images, imagestreams, and secrets are updated by default. Updating images and image -streams requires administrative privileges. +Only images, imagestreams, and secrets are updated by default. Updating images and image streams requires administrative privileges. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-migrate-storage.1 b/docs/man/man1/openshift-cli-adm-migrate-storage.1 index c387b449cda5..f994a8f89119 100644 --- a/docs/man/man1/openshift-cli-adm-migrate-storage.1 +++ b/docs/man/man1/openshift-cli-adm-migrate-storage.1 @@ -16,25 +16,16 @@ openshift cli adm migrate storage \- Update the stored version of API objects Migrate internal object storage via update .PP -This command invokes an update operation on every API object reachable by the caller. This forces -the server to write to the underlying storage if the object representation has changed. Use this -command to ensure that the most recent storage changes have been applied to all objects (storage -version, storage encoding, any newer object defaults). +This command invokes an update operation on every API object reachable by the caller. This forces the server to write to the underlying storage if the object representation has changed. Use this command to ensure that the most recent storage changes have been applied to all objects (storage version, storage encoding, any newer object defaults). .PP -To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run -the command will output a list of resources that received errors, which you can then re\-run the -command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names -to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped -resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. +To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run the command will output a list of resources that received errors, which you can then re\-run the command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. .PP -By default, events are not migrated since they expire within a very short period of time. If you -have significantly increased the expiration time of events, run a migration with \-\-include=events +By default, events are not migrated since they expire within a very short period of time. If you have significantly increased the expiration time of events, run a migration with \-\-include=events .PP -WARNING: This is a slow command and will put significant load on an API server. It may also - result in significant intra\-cluster traffic. +WARNING: This is a slow command and will put significant load on an API server. It may also result in significant intra\-cluster traffic. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-new-project.1 b/docs/man/man1/openshift-cli-adm-new-project.1 index 08b13a793393..5fa5e2050aeb 100644 --- a/docs/man/man1/openshift-cli-adm-new-project.1 +++ b/docs/man/man1/openshift-cli-adm-new-project.1 @@ -16,9 +16,7 @@ openshift cli adm new\-project \- Create a new project Create a new project .PP -Use this command to create a project. You may optionally specify metadata about the project, -an admin user (and role, if you want to use a non\-default admin role), and a node selector -to restrict which nodes pods in this project can be scheduled to. +Use this command to create a project. You may optionally specify metadata about the project, an admin user (and role, if you want to use a non\-default admin role), and a node selector to restrict which nodes pods in this project can be scheduled to. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 index 3507b2004b94..2193e77ba0ba 100644 --- a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 @@ -16,9 +16,7 @@ openshift cli adm policy reconcile\-cluster\-role\-bindings \- Update cluster ro Update cluster role bindings to match the recommended bootstrap policy .PP -This command will inspect the cluster role bindings against the recommended bootstrap policy. -Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. -This command will not remove any additional cluster role bindings. +This command will inspect the cluster role bindings against the recommended bootstrap policy. Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. This command will not remove any additional cluster role bindings. .PP You can see which recommended cluster role bindings have changed by choosing an output type. diff --git a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 index 1381401c3872..79c8346b3e44 100644 --- a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 @@ -16,9 +16,7 @@ openshift cli adm policy reconcile\-cluster\-roles \- Update cluster roles to ma Update cluster roles to match the recommended bootstrap policy .PP -This command will compare cluster roles against the recommended bootstrap policy. Any cluster role -that does not match will be replaced by the recommended bootstrap role. This command will not remove -any additional cluster role. +This command will compare cluster roles against the recommended bootstrap policy. Any cluster role that does not match will be replaced by the recommended bootstrap role. This command will not remove any additional cluster role. .PP Cluster roles with the annotation openshift.io/reconcile\-protect set to "true" are skipped. diff --git a/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 b/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 index 3ac7eee237eb..e0f06e45311e 100644 --- a/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 +++ b/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 @@ -16,12 +16,7 @@ openshift cli adm policy reconcile\-sccs \- Replace cluster SCCs to match the re Replace cluster SCCs to match the recommended bootstrap policy .PP -This command will inspect the cluster SCCs against the recommended bootstrap SCCs. -Any cluster SCC that does not match will be replaced by the recommended SCC. -This command will not remove any additional cluster SCCs. By default, this command -will not remove additional users and groups that have been granted access to the SCC and -will preserve existing priorities (but will always reconcile unset priorities and the policy -definition). +This command will inspect the cluster SCCs against the recommended bootstrap SCCs. Any cluster SCC that does not match will be replaced by the recommended SCC. This command will not remove any additional cluster SCCs. By default, this command will not remove additional users and groups that have been granted access to the SCC and will preserve existing priorities (but will always reconcile unset priorities and the policy definition). .PP You can see which cluster SCCs have recommended changes by choosing an output type. diff --git a/docs/man/man1/openshift-cli-adm-policy.1 b/docs/man/man1/openshift-cli-adm-policy.1 index acd0ec600bbb..5a7daa14f56f 100644 --- a/docs/man/man1/openshift-cli-adm-policy.1 +++ b/docs/man/man1/openshift-cli-adm-policy.1 @@ -16,13 +16,10 @@ openshift cli adm policy \- Manage policy Manage policy on the cluster .PP -These commands allow you to assign and manage the roles and policies that apply to users. The reconcile -commands allow you to reset and upgrade your system policies to the latest default policies. +These commands allow you to assign and manage the roles and policies that apply to users. The reconcile commands allow you to reset and upgrade your system policies to the latest default policies. .PP -To see more information on roles and policies, use the 'get' and 'describe' commands on the following -resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', -and 'scc'. +To see more information on roles and policies, use the 'get' and 'describe' commands on the following resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', and 'scc'. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-prune-groups.1 b/docs/man/man1/openshift-cli-adm-prune-groups.1 index c0fae63b50de..e7d3b4bc7c0e 100644 --- a/docs/man/man1/openshift-cli-adm-prune-groups.1 +++ b/docs/man/man1/openshift-cli-adm-prune-groups.1 @@ -16,13 +16,7 @@ openshift cli adm prune groups \- Prune OpenShift groups referencing missing rec Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-prune.1 b/docs/man/man1/openshift-cli-adm-prune.1 index 75d4898a72fb..91a6aef3a04b 100644 --- a/docs/man/man1/openshift-cli-adm-prune.1 +++ b/docs/man/man1/openshift-cli-adm-prune.1 @@ -16,8 +16,7 @@ openshift cli adm prune \- Remove older versions of resources from the server Remove older versions of resources from the server .PP -The commands here allow administrators to manage the older versions of resources on -the system by removing them. +The commands here allow administrators to manage the older versions of resources on the system by removing them. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-registry.1 b/docs/man/man1/openshift-cli-adm-registry.1 index 5ebf979b1aa7..73a52a06a203 100644 --- a/docs/man/man1/openshift-cli-adm-registry.1 +++ b/docs/man/man1/openshift-cli-adm-registry.1 @@ -16,28 +16,16 @@ openshift cli adm registry \- Install the integrated Docker registry Install or configure an integrated Docker registry .PP -This command sets up a Docker registry integrated with your cluster to provide notifications when -images are pushed. With no arguments, the command will check for the existing registry service -called 'docker\-registry' and try to create it. If you want to test whether the registry has -been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not -exist. +This command sets up a Docker registry integrated with your cluster to provide notifications when images are pushed. With no arguments, the command will check for the existing registry service called 'docker\-registry' and try to create it. If you want to test whether the registry has been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not exist. .PP -To run a highly available registry, you should be using a remote storage mechanism like an -object store (several are supported by the Docker registry). The default Docker registry image -is configured to accept configuration as environment variables \- refer to the configuration file in -that image for more on setting up alternative storage. Once you've made those changes, you can -pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup -uses a local volume and the data will be lost if you delete the running pod. +To run a highly available registry, you should be using a remote storage mechanism like an object store (several are supported by the Docker registry). The default Docker registry image is configured to accept configuration as environment variables \- refer to the configuration file in that image for more on setting up alternative storage. Once you've made those changes, you can pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup uses a local volume and the data will be lost if you delete the running pod. .PP -If multiple ports are specified using the option \-\-ports, the first specified port will be -chosen for use as the REGISTRY\_HTTP\_ADDR and will be passed to Docker registry. +If multiple ports are specified using the option \-\-ports, the first specified port will be chosen for use as the REGISTRY HTTP ADDR and will be passed to Docker registry. .PP -NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new - installation. Some configuration beyond this command is still required to make - your registry persist data. +NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new installation. Some configuration beyond this command is still required to make your registry persist data. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-router.1 b/docs/man/man1/openshift-cli-adm-router.1 index 19e3792b44bd..55068f277f19 100644 --- a/docs/man/man1/openshift-cli-adm-router.1 +++ b/docs/man/man1/openshift-cli-adm-router.1 @@ -16,17 +16,10 @@ openshift cli adm router \- Install a router Install or configure a router .PP -This command helps to setup a router to take edge traffic and balance it to -your application. With no arguments, the command will check for an existing router -service called 'router' and create one if it does not exist. If you want to test whether -a router has already been created add the \-\-dry\-run flag and the command will exit with -1 if the registry does not exist. +This command helps to setup a router to take edge traffic and balance it to your application. With no arguments, the command will check for an existing router service called 'router' and create one if it does not exist. If you want to test whether a router has already been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not exist. .PP -If a router does not exist with the given name, this command will -create a deployment configuration and service that will run the router. If you are -running your router in production, you should pass \-\-replicas=2 or higher to ensure -you have failover protection. +If a router does not exist with the given name, this command will create a deployment configuration and service that will run the router. If you are running your router in production, you should pass \-\-replicas=2 or higher to ensure you have failover protection. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-top-images.1 b/docs/man/man1/openshift-cli-adm-top-images.1 index b80ffe2806fc..d4ddf0819702 100644 --- a/docs/man/man1/openshift-cli-adm-top-images.1 +++ b/docs/man/man1/openshift-cli-adm-top-images.1 @@ -16,8 +16,7 @@ openshift cli adm top images \- Show usage statistics for Images Show usage statistics for Images .PP -This command analyzes all the Images managed by the platform and presents current -usage statistics. +This command analyzes all the Images managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-top-imagestreams.1 b/docs/man/man1/openshift-cli-adm-top-imagestreams.1 index bb281eef85ad..16ad60aed086 100644 --- a/docs/man/man1/openshift-cli-adm-top-imagestreams.1 +++ b/docs/man/man1/openshift-cli-adm-top-imagestreams.1 @@ -16,8 +16,7 @@ openshift cli adm top imagestreams \- Show usage statistics for ImageStreams Show usage statistics for ImageStreams .PP -This command analyzes all the ImageStreams managed by the platform and presents current -usage statistics. +This command analyzes all the ImageStreams managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-top.1 b/docs/man/man1/openshift-cli-adm-top.1 index b6242ff1f6a1..5561276831c1 100644 --- a/docs/man/man1/openshift-cli-adm-top.1 +++ b/docs/man/man1/openshift-cli-adm-top.1 @@ -16,8 +16,7 @@ openshift cli adm top \- Show usage statistics of resources on the server Show usage statistics of resources on the server .PP -This command analyzes resources managed by the platform and presents current -usage statistics. +This command analyzes resources managed by the platform and presents current usage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm.1 b/docs/man/man1/openshift-cli-adm.1 index 29a3c705776a..5f6fce081b9d 100644 --- a/docs/man/man1/openshift-cli-adm.1 +++ b/docs/man/man1/openshift-cli-adm.1 @@ -16,8 +16,7 @@ openshift cli adm \- Tools for managing a cluster Administrative Commands .PP -Commands for managing a cluster are exposed here. Many administrative -actions involve interaction with the command\-line client as well. +Commands for managing a cluster are exposed here. Many administrative actions involve interaction with the command\-line client as well. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-annotate.1 b/docs/man/man1/openshift-cli-annotate.1 index e044660a9383..2d84a05ec327 100644 --- a/docs/man/man1/openshift-cli-annotate.1 +++ b/docs/man/man1/openshift-cli-annotate.1 @@ -16,13 +16,7 @@ openshift cli annotate \- Update the annotations on a resource Update the annotations on one or more resources .PP -An annotation is a key/value pair that can hold larger (compared to a label), -and possibly not human\-readable, data. It is intended to store non\-identifying -auxiliary data, especially data manipulated by tools and system extensions. If -\-\-overwrite is true, then existing annotations can be overwritten, otherwise -attempting to overwrite an annotation will result in an error. If -\-\-resource\-version is specified, then updates will use this resource version, -otherwise the existing resource\-version will be used. +An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human\-readable, data. It is intended to store non\-identifying auxiliary data, especially data manipulated by tools and system extensions. If \-\-overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error. If \-\-resource\-version is specified, then updates will use this resource version, otherwise the existing resource\-version will be used. .PP Run 'openshift cli types' for a list of valid resources. diff --git a/docs/man/man1/openshift-cli-attach.1 b/docs/man/man1/openshift-cli-attach.1 index 130959ef89d3..f21ea0b9403b 100644 --- a/docs/man/man1/openshift-cli-attach.1 +++ b/docs/man/man1/openshift-cli-attach.1 @@ -16,8 +16,7 @@ openshift cli attach \- Attach to a running container Attach to a running container .PP -Attach the current shell to a remote container, returning output or setting up a full -terminal session. Can be used to debug containers and invoke interactive commands. +Attach the current shell to a remote container, returning output or setting up a full terminal session. Can be used to debug containers and invoke interactive commands. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-autoscale.1 b/docs/man/man1/openshift-cli-autoscale.1 index 889c3e5525c2..1684f48ff261 100644 --- a/docs/man/man1/openshift-cli-autoscale.1 +++ b/docs/man/man1/openshift-cli-autoscale.1 @@ -16,9 +16,7 @@ openshift cli autoscale \- Autoscale a deployment config or replication controll Autoscale a deployment config or replication controller. .PP -Looks up a deployment config or replication controller by name and creates an autoscaler that uses -this deployment config or replication controller as a reference. An autoscaler can automatically -increase or decrease number of pods deployed within the system as needed. +Looks up a deployment config or replication controller by name and creates an autoscaler that uses this deployment config or replication controller as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-cancel-build.1 b/docs/man/man1/openshift-cli-cancel-build.1 index db263be6189b..702f7e222905 100644 --- a/docs/man/man1/openshift-cli-cancel-build.1 +++ b/docs/man/man1/openshift-cli-cancel-build.1 @@ -16,8 +16,7 @@ openshift cli cancel\-build \- Cancel running, pending, or new builds Cancel running, pending, or new builds .PP -This command requests a graceful shutdown of the build. There may be a delay between requesting -the build and the time the build is terminated. +This command requests a graceful shutdown of the build. There may be a delay between requesting the build and the time the build is terminated. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-completion.1 b/docs/man/man1/openshift-cli-completion.1 index 2124752cf2cc..72d807168153 100644 --- a/docs/man/man1/openshift-cli-completion.1 +++ b/docs/man/man1/openshift-cli-completion.1 @@ -13,8 +13,7 @@ openshift cli completion \- Output shell completion code for the given shell (ba .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of openshift cli commands. +This command prints shell code which must be evaluated to provide interactive completion of openshift cli commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-config.1 b/docs/man/man1/openshift-cli-config.1 index d9a72eede07b..129516849dac 100644 --- a/docs/man/man1/openshift-cli-config.1 +++ b/docs/man/man1/openshift-cli-config.1 @@ -16,9 +16,7 @@ openshift cli 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 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. .PP Reference: diff --git a/docs/man/man1/openshift-cli-convert.1 b/docs/man/man1/openshift-cli-convert.1 index ef223c7d11c7..6ea210118f2d 100644 --- a/docs/man/man1/openshift-cli-convert.1 +++ b/docs/man/man1/openshift-cli-convert.1 @@ -13,17 +13,13 @@ openshift cli convert \- Convert config files between different API versions .SH DESCRIPTION .PP -Convert config files between different API versions. Both YAML -and JSON formats are accepted. +Convert config files between different API versions. Both YAML and JSON formats are accepted. .PP -The command takes filename, directory, or URL as input, and convert it into format -of version specified by \-\-output\-version flag. If target version is not specified or -not supported, convert to latest version. +The command takes filename, directory, or URL as input, and convert it into format of version specified by \-\-output\-version flag. If target version is not specified or not supported, convert to latest version. .PP -The default output will be printed to stdout in YAML format. One can use \-o option -to change to output destination. +The default output will be printed to stdout in YAML format. One can use \-o option to change to output destination. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-identity.1 b/docs/man/man1/openshift-cli-create-identity.1 index afd8a46b3bd4..a9d616503a9c 100644 --- a/docs/man/man1/openshift-cli-create-identity.1 +++ b/docs/man/man1/openshift-cli-create-identity.1 @@ -16,13 +16,10 @@ openshift cli create identity \- Manually create an identity (only needed if aut This command can be used to create an identity object. .PP -Typically, identities are created automatically during login. If automatic -creation is disabled (by using the "lookup" mapping method), identities must -be created manually. +Typically, identities are created automatically during login. If automatic creation is disabled (by using the "lookup" mapping method), identities must be created manually. .PP -Corresponding user and useridentitymapping objects must also be created -to allow logging in with the created identity. +Corresponding user and useridentitymapping objects must also be created to allow logging in with the created identity. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-imagestream.1 b/docs/man/man1/openshift-cli-create-imagestream.1 index abc1870b8abf..1e1e991ae4ca 100644 --- a/docs/man/man1/openshift-cli-create-imagestream.1 +++ b/docs/man/man1/openshift-cli-create-imagestream.1 @@ -16,8 +16,7 @@ openshift cli create imagestream \- Create a new empty image stream. Create a new image stream .PP -Image streams allow you to track, tag, and import images from other registries. They also define an -access controlled destination that you can push images to. +Image streams allow you to track, tag, and import images from other registries. They also define an access controlled destination that you can push images to. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-route-edge.1 b/docs/man/man1/openshift-cli-create-route-edge.1 index 4076cb8cab15..ef310cbd0d57 100644 --- a/docs/man/man1/openshift-cli-create-route-edge.1 +++ b/docs/man/man1/openshift-cli-create-route-edge.1 @@ -16,8 +16,7 @@ openshift cli create route edge \- Create a route that uses edge TLS termination Create a route that uses edge TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. +Specify the service (either just its name or using type/name syntax) that the generated route should expose via the \-\-service flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-route-passthrough.1 b/docs/man/man1/openshift-cli-create-route-passthrough.1 index fc9bf0aa7cb7..e0eac0eb1780 100644 --- a/docs/man/man1/openshift-cli-create-route-passthrough.1 +++ b/docs/man/man1/openshift-cli-create-route-passthrough.1 @@ -16,8 +16,7 @@ openshift cli create route passthrough \- Create a route that uses passthrough T Create a route that uses passthrough TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. +Specify the service (either just its name or using type/name syntax) that the generated route should expose via the \-\-service flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-route-reencrypt.1 b/docs/man/man1/openshift-cli-create-route-reencrypt.1 index cedff409c5d5..69a4af9bd5a0 100644 --- a/docs/man/man1/openshift-cli-create-route-reencrypt.1 +++ b/docs/man/man1/openshift-cli-create-route-reencrypt.1 @@ -16,9 +16,7 @@ openshift cli create route reencrypt \- Create a route that uses reencrypt TLS t Create a route that uses reencrypt TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. A destination CA certificate -is needed for reencrypt routes, specify one with the \-\-dest\-ca\-cert flag. +Specify the service (either just its name or using type/name syntax) that the generated route should expose via the \-\-service flag. A destination CA certificate is needed for reencrypt routes, specify one with the \-\-dest\-ca\-cert flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-route.1 b/docs/man/man1/openshift-cli-create-route.1 index 0e2a9b3b7024..099953d8cdb9 100644 --- a/docs/man/man1/openshift-cli-create-route.1 +++ b/docs/man/man1/openshift-cli-create-route.1 @@ -16,8 +16,7 @@ openshift cli create route \- Expose containers externally via secured routes Expose containers externally via secured routes .PP -Three types of secured routes are supported: edge, passthrough, and reencrypt. -If you wish to create unsecured routes, see "openshift cli expose \-h" +Three types of secured routes are supported: edge, passthrough, and reencrypt. If you wish to create unsecured routes, see "openshift cli expose \-h" .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-create-user.1 b/docs/man/man1/openshift-cli-create-user.1 index 2d40e83701f2..e163411c29bb 100644 --- a/docs/man/man1/openshift-cli-create-user.1 +++ b/docs/man/man1/openshift-cli-create-user.1 @@ -16,13 +16,10 @@ openshift cli create user \- Manually create a user (only needed if automatic cr This command can be used to create a user object. .PP -Typically, users are created automatically during login. If automatic -creation is disabled (by using the "lookup" mapping method), users must -be created manually. +Typically, users are created automatically during login. If automatic creation is disabled (by using the "lookup" mapping method), users must be created manually. .PP -Corresponding identity and useridentitymapping objects must also be created -to allow logging in as the created user. +Corresponding identity and useridentitymapping objects must also be created to allow logging in as the created user. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-useridentitymapping.1 b/docs/man/man1/openshift-cli-create-useridentitymapping.1 index 1ab32cdb8a76..00a153e6bc48 100644 --- a/docs/man/man1/openshift-cli-create-useridentitymapping.1 +++ b/docs/man/man1/openshift-cli-create-useridentitymapping.1 @@ -13,10 +13,7 @@ openshift cli create useridentitymapping \- Manually map an identity to a user. .SH DESCRIPTION .PP -Typically, identities are automatically mapped to users during login. If automatic -mapping is disabled (by using the "lookup" mapping method), or a mapping needs to -be manually established between an identity and a user, this command can be used -to create a useridentitymapping object. +Typically, identities are automatically mapped to users during login. If automatic mapping is disabled (by using the "lookup" mapping method), or a mapping needs to be manually established between an identity and a user, this command can be used to create a useridentitymapping object. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-debug.1 b/docs/man/man1/openshift-cli-debug.1 index c73077322d0e..0906a02305b5 100644 --- a/docs/man/man1/openshift-cli-debug.1 +++ b/docs/man/man1/openshift-cli-debug.1 @@ -16,27 +16,16 @@ openshift cli debug \- Launch a new instance of a pod for debugging Launch a command shell to debug a running application .PP -When debugging images and setup problems, it's useful to get an exact copy of a running -pod configuration and troubleshoot with a shell. Since a pod that is failing may not be -started and not accessible to 'rsh' or 'exec', the 'debug' command makes it easy to -create a carbon copy of that setup. +When debugging images and setup problems, it's useful to get an exact copy of a running pod configuration and troubleshoot with a shell. Since a pod that is failing may not be started and not accessible to 'rsh' or 'exec', the 'debug' command makes it easy to create a carbon copy of that setup. .PP -The default mode is to start a shell inside of the first container of the referenced pod, -replication controller, or deployment config. The started pod will be a copy of your -source pod, with labels stripped, the command changed to '/bin/sh', and readiness and -liveness checks disabled. If you just want to run a command, add '\-\-' and a command to -run. Passing a command will not create a TTY or send STDIN by default. Other flags are -supported for altering the container or pod in common ways. +The default mode is to start a shell inside of the first container of the referenced pod, replication controller, or deployment config. The started pod will be a copy of your source pod, with labels stripped, the command changed to '/bin/sh', and readiness and liveness checks disabled. If you just want to run a command, add '\-\-' and a command to run. Passing a command will not create a TTY or send STDIN by default. Other flags are supported for altering the container or pod in common ways. .PP -A common problem running containers is a security policy that prohibits you from running -as a root user on the cluster. You can use this command to test running a pod as -non\-root (with \-\-as\-user) or to run a non\-root pod as root (with \-\-as\-root). +A common problem running containers is a security policy that prohibits you from running as a root user on the cluster. You can use this command to test running a pod as non\-root (with \-\-as\-user) or to run a non\-root pod as root (with \-\-as\-root). .PP -The debug pod is deleted when the the remote command completes or the user interrupts -the shell. +The debug pod is deleted when the the remote command completes or the user interrupts the shell. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-delete.1 b/docs/man/man1/openshift-cli-delete.1 index ce018bf7db0a..681c08e757e9 100644 --- a/docs/man/man1/openshift-cli-delete.1 +++ b/docs/man/man1/openshift-cli-delete.1 @@ -19,13 +19,10 @@ Delete a resource JSON and YAML formats are accepted. .PP -If both a filename and command line arguments are passed, the command line -arguments are used and the filename is ignored. +If both a filename and command line arguments are passed, the command line arguments are used and the filename is ignored. .PP -Note that the delete command does NOT do resource version checks, so if someone -submits an update to a resource right when you submit a delete, their update -will be lost along with the rest of the resource. +Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-deploy.1 b/docs/man/man1/openshift-cli-deploy.1 index 784585db556a..3619fa946b24 100644 --- a/docs/man/man1/openshift-cli-deploy.1 +++ b/docs/man/man1/openshift-cli-deploy.1 @@ -16,36 +16,26 @@ openshift cli deploy \- View, start, cancel, or retry a deployment View, start, cancel, or retry a deployment .PP -This command allows you to control a deployment config. Each individual deployment is exposed -as a new replication controller, and the deployment process manages scaling down old deployments -and scaling up new ones. Use 'openshift cli rollback' to rollback to any previous deployment. +This command allows you to control a deployment config. Each individual deployment is exposed as a new replication controller, and the deployment process manages scaling down old deployments and scaling up new ones. Use 'openshift cli rollback' to rollback to any previous deployment. .PP There are several deployment strategies defined: .IP .IP -\(bu Rolling (default) \- scales up the new deployment in stages, gradually reducing the number -of old deployments. If one of the new deployed pods never becomes "ready", the new deployment -will be rolled back (scaled down to zero). Use when your application can tolerate two versions -of code running at the same time (many web applications, scalable databases) +\(bu Rolling (default) \- scales up the new deployment in stages, gradually reducing the number of old deployments. If one of the new deployed pods never becomes "ready", the new deployment will be rolled back (scaled down to zero). Use when your application can tolerate two versions of code running at the same time (many web applications, scalable databases) +.br .IP -\(bu Recreate \- scales the old deployment down to zero, then scales the new deployment up to full. -Use when your application cannot tolerate two versions of code running at the same time +\(bu Recreate \- scales the old deployment down to zero, then scales the new deployment up to full. Use when your application cannot tolerate two versions of code running at the same time +.br .IP \(bu Custom \- run your own deployment process inside a Docker container using your own scripts. +.br .PP -If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may -never successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment. -If a deployment config has completed deploying successfully at least once in the past, it would be -automatically rolled back in the event of a new failed deployment. Note that you would still need -to update the erroneous deployment config in order to have its template persisted across your -application. +If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may never successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment. If a deployment config has completed deploying successfully at least once in the past, it would be automatically rolled back in the event of a new failed deployment. Note that you would still need to update the erroneous deployment config in order to have its template persisted across your application. .PP -If you want to cancel a running deployment, use '\-\-cancel' but keep in mind that this is a best\-effort -operation and may take some time to complete. It’s possible the deployment will partially or totally -complete before the cancellation is effective. In such a case an appropriate event will be emitted. +If you want to cancel a running deployment, use '\-\-cancel' but keep in mind that this is a best\-effort operation and may take some time to complete. It’s possible the deployment will partially or totally complete before the cancellation is effective. In such a case an appropriate event will be emitted. .PP If no options are given, shows information about the latest deployment. diff --git a/docs/man/man1/openshift-cli-describe.1 b/docs/man/man1/openshift-cli-describe.1 index 1324f46626a8..654ea95f3786 100644 --- a/docs/man/man1/openshift-cli-describe.1 +++ b/docs/man/man1/openshift-cli-describe.1 @@ -16,8 +16,7 @@ openshift cli describe \- Show details of a specific resource or group of resour Show details of a specific resource .PP -This command joins many API calls together to form a detailed description of a -given resource. +This command joins many API calls together to form a detailed description of a given resource. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-edit.1 b/docs/man/man1/openshift-cli-edit.1 index 32e8def08722..7799b02c7cfd 100644 --- a/docs/man/man1/openshift-cli-edit.1 +++ b/docs/man/man1/openshift-cli-edit.1 @@ -16,25 +16,13 @@ openshift cli edit \- Edit a resource on the server Edit a resource from the default editor .PP -The edit command allows you to directly edit any API resource you can retrieve via the -command line tools. It will open the editor defined by your OC\_EDITOR, or EDITOR environment -variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple -objects, although changes are applied one at a time. The command accepts filenames as well -as command line arguments, although the files you point to must be previously saved versions -of resources. +The edit command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your OC \_EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. .PP -The files to edit will be output in the default API version, or a version specified -by \-\-output\-version. The default format is YAML \- if you would like to edit in JSON -pass \-o json. The flag \-\-windows\-line\-endings can be used to force Windows line endings, -otherwise the default for your operating system will be used. +The files to edit will be output in the default API version, or a version specified by \-\-output\-version. The default format is YAML \- if you would like to edit in JSON pass \-o json. The flag \-\-windows\-line\-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. .PP -In the event an error occurs while updating, a temporary file will be created on disk -that contains your unapplied changes. The most common error when updating a resource -is another editor changing the resource on the server. When this occurs, you will have -to apply your changes to the newer version of the resource, or update your temporary -saved copy to include the latest resource version. +In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-ex-dockerbuild.1 b/docs/man/man1/openshift-cli-ex-dockerbuild.1 index 1594f9c57395..fd723dfe86dc 100644 --- a/docs/man/man1/openshift-cli-ex-dockerbuild.1 +++ b/docs/man/man1/openshift-cli-ex-dockerbuild.1 @@ -16,10 +16,7 @@ openshift cli ex dockerbuild \- Perform a direct Docker build Build a Dockerfile into a single layer .PP -Builds the provided directory with a Dockerfile into a single layered image. -Requires that you have a working connection to a Docker engine. You may mount -secrets or config into the build with the \-\-mount flag \- these files will not -be included in the final image. +Builds the provided directory with a Dockerfile into a single layered image. Requires that you have a working connection to a Docker engine. You may mount secrets or config into the build with the \-\-mount flag \- these files will not be included in the final image. .PP Experimental: This command is under active development and may change without notice. diff --git a/docs/man/man1/openshift-cli-explain.1 b/docs/man/man1/openshift-cli-explain.1 index effd695d69a2..0e40e42d8f01 100644 --- a/docs/man/man1/openshift-cli-explain.1 +++ b/docs/man/man1/openshift-cli-explain.1 @@ -16,10 +16,7 @@ openshift cli explain \- Documentation of resources Documentation of resources. .PP -Possible resource types include: pods (po), services (svc), -replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), -limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), -resourcequotas (quota), namespaces (ns) or endpoints (ep). +Possible resource types include: pods (po), services (svc), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns) or endpoints (ep). .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-export.1 b/docs/man/man1/openshift-cli-export.1 index 58233cbce3f9..0f8e399a1064 100644 --- a/docs/man/man1/openshift-cli-export.1 +++ b/docs/man/man1/openshift-cli-export.1 @@ -16,21 +16,13 @@ openshift cli export \- Export resources so they can be used elsewhere Export resources so they can be used elsewhere .PP -The export command makes it easy to take existing objects and convert them to configuration files -for backups or for creating elsewhere in the cluster. Fields that cannot be specified on create -will be set to empty, and any field which is assigned on creation (like a service's clusterIP, or -a deployment config's latestVersion). The status part of objects is also cleared. +The export command makes it easy to take existing objects and convert them to configuration files for backups or for creating elsewhere in the cluster. Fields that cannot be specified on create will be set to empty, and any field which is assigned on creation (like a service's clusterIP, or a deployment config's latestVersion). The status part of objects is also cleared. .PP -Some fields like clusterIP may be useful when exporting an application from one cluster to apply -to another \- assuming another service on the destination cluster does not already use that IP. -The \-\-exact flag will instruct export to not clear fields that might be useful. You may also use -\-\-raw to get the exact values for an object \- useful for converting a file on disk between API -versions. +Some fields like clusterIP may be useful when exporting an application from one cluster to apply to another \- assuming another service on the destination cluster does not already use that IP. The \-\-exact flag will instruct export to not clear fields that might be useful. You may also use \-\-raw to get the exact values for an object \- useful for converting a file on disk between API versions. .PP -Another use case for export is to create reusable templates for applications. Pass \-\-as\-template -to generate the API structure for a template to which you can add parameters and object labels. +Another use case for export is to create reusable templates for applications. Pass \-\-as\-template to generate the API structure for a template to which you can add parameters and object labels. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-expose.1 b/docs/man/man1/openshift-cli-expose.1 index 359ea175eee7..86dcf3cb66f5 100644 --- a/docs/man/man1/openshift-cli-expose.1 +++ b/docs/man/man1/openshift-cli-expose.1 @@ -16,9 +16,7 @@ openshift cli expose \- Expose a replicated application as a service or route Expose containers internally as services or externally via routes .PP -There is also the ability to expose a deployment configuration, replication controller, service, or pod -as a new service on a specified port. If no labels are specified, the new object will re\-use the -labels from the object it exposes. +There is also the ability to expose a deployment configuration, replication controller, service, or pod as a new service on a specified port. If no labels are specified, the new object will re\-use the labels from the object it exposes. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-extract.1 b/docs/man/man1/openshift-cli-extract.1 index 35dbab2709c8..91af3dbcbebf 100644 --- a/docs/man/man1/openshift-cli-extract.1 +++ b/docs/man/man1/openshift-cli-extract.1 @@ -16,13 +16,10 @@ openshift cli extract \- Extract secrets or config maps to disk Extract files out of secrets and config maps .PP -The extract command makes it easy to download the contents of a config map or secret into a directory. -Each key in the config map or secret is created as a separate file with the name of the key, as it -is when you mount a secret or config map into a container. +The extract command makes it easy to download the contents of a config map or secret into a directory. Each key in the config map or secret is created as a separate file with the name of the key, as it is when you mount a secret or config map into a container. .PP -You can limit which keys are extracted with the \-\-keys=NAME flag, or set the directory to extract to -with \-\-to=DIRECTORY. +You can limit which keys are extracted with the \-\-keys=NAME flag, or set the directory to extract to with \-\-to=DIRECTORY. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-get.1 b/docs/man/man1/openshift-cli-get.1 index 3b55180b1baf..8ca629307d13 100644 --- a/docs/man/man1/openshift-cli-get.1 +++ b/docs/man/man1/openshift-cli-get.1 @@ -16,9 +16,7 @@ openshift cli get \- Display one or many resources Display one or many resources .PP -Possible resources include builds, buildConfigs, services, pods, etc. -Some resources may omit advanced details that you can see with '\-o wide'. -If you want an even more detailed view, use 'openshift cli describe'. +Possible resources include builds, buildConfigs, services, pods, etc. Some resources may omit advanced details that you can see with '\-o wide'. If you want an even more detailed view, use 'openshift cli describe'. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-idle.1 b/docs/man/man1/openshift-cli-idle.1 index a391b423d620..44dad1590da1 100644 --- a/docs/man/man1/openshift-cli-idle.1 +++ b/docs/man/man1/openshift-cli-idle.1 @@ -16,14 +16,10 @@ openshift cli idle \- Idle scalable resources Idle scalable resources. .PP -Idling discovers the scalable resources (such as deployment configs and replication controllers) -associated with a series of services by examining the endpoints of the service. -Each service is then marked as idled, the associated resources are recorded, and the resources -are scaled down to zero replicas. +Idling discovers the scalable resources (such as deployment configs and replication controllers) associated with a series of services by examining the endpoints of the service. Each service is then marked as idled, the associated resources are recorded, and the resources are scaled down to zero replicas. .PP -Upon receiving network traffic, the services (and any associated routes) will "wake up" the -associated resources by scaling them back up to their previous scale. +Upon receiving network traffic, the services (and any associated routes) will "wake up" the associated resources by scaling them back up to their previous scale. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-import-app.json.1 b/docs/man/man1/openshift-cli-import-app.json.1 index a3314224a51d..10fbbf09c35b 100644 --- a/docs/man/man1/openshift-cli-import-app.json.1 +++ b/docs/man/man1/openshift-cli-import-app.json.1 @@ -16,14 +16,10 @@ openshift cli import app.json \- Import an app.json definition into OpenShift (e Import app.json files as OpenShift objects .PP -app.json defines the pattern of a simple, stateless web application that can be horizontally scaled. -This command will transform a provided app.json object into its OpenShift equivalent. -During transformation fields in the app.json syntax that are not relevant when running on top of -a containerized platform will be ignored and a warning printed. +app.json defines the pattern of a simple, stateless web application that can be horizontally scaled. This command will transform a provided app.json object into its OpenShift equivalent. During transformation fields in the app.json syntax that are not relevant when running on top of a containerized platform will be ignored and a warning printed. .PP -The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a -configuration file for later use. +The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a configuration file for later use. .PP Experimental: This command is under active development and may change without notice. diff --git a/docs/man/man1/openshift-cli-import-docker-compose.1 b/docs/man/man1/openshift-cli-import-docker-compose.1 index 1da367bf24a6..35656c4d3cf8 100644 --- a/docs/man/man1/openshift-cli-import-docker-compose.1 +++ b/docs/man/man1/openshift-cli-import-docker-compose.1 @@ -16,14 +16,10 @@ openshift cli import docker\-compose \- Import a docker\-compose.yml project int Import a Docker Compose file as OpenShift objects .PP -Docker Compose files offer a container centric build and deploy pattern for simple applications. -This command will transform a provided docker\-compose.yml application into its OpenShift equivalent. -During transformation fields in the compose syntax that are not relevant when running on top of -a containerized platform will be ignored and a warning printed. +Docker Compose files offer a container centric build and deploy pattern for simple applications. This command will transform a provided docker\-compose.yml application into its OpenShift equivalent. During transformation fields in the compose syntax that are not relevant when running on top of a containerized platform will be ignored and a warning printed. .PP -The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a -configuration file for later use. +The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a configuration file for later use. .PP Experimental: This command is under active development and may change without notice. diff --git a/docs/man/man1/openshift-cli-import-image.1 b/docs/man/man1/openshift-cli-import-image.1 index 8f584ecf6a99..4172030a17f9 100644 --- a/docs/man/man1/openshift-cli-import-image.1 +++ b/docs/man/man1/openshift-cli-import-image.1 @@ -16,8 +16,7 @@ openshift cli import\-image \- Imports images from a Docker registry Import tag and image information from an external Docker image repository .PP -Only image streams that have a value set for spec.dockerImageRepository and/or -spec.Tags may have tag and image information imported. +Only image streams that have a value set for spec.dockerImageRepository and/or spec.Tags may have tag and image information imported. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-label.1 b/docs/man/man1/openshift-cli-label.1 index 1d775856a41a..41ee045d7b9b 100644 --- a/docs/man/man1/openshift-cli-label.1 +++ b/docs/man/man1/openshift-cli-label.1 @@ -16,11 +16,7 @@ openshift cli label \- Update the labels on a resource Update the labels on one or more resources .PP -A valid label value is consisted of letters and/or numbers with a max length of 63 -characters. If \-\-overwrite is true, then existing labels can be overwritten, otherwise -attempting to overwrite a label will result in an error. If \-\-resource\-version is -specified, then updates will use this resource version, otherwise the existing -resource\-version will be used. +A valid label value is consisted of letters and/or numbers with a max length of 63 characters. If \-\-overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error. If \-\-resource\-version is specified, then updates will use this resource version, otherwise the existing resource\-version will be used. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-login.1 b/docs/man/man1/openshift-cli-login.1 index b50acfcd638d..68a41ef65e30 100644 --- a/docs/man/man1/openshift-cli-login.1 +++ b/docs/man/man1/openshift-cli-login.1 @@ -16,15 +16,10 @@ openshift cli login \- Log in to a server Log in to your server and save login for subsequent use .PP -First\-time users of the client should run this command to connect to a server, -establish an authenticated session, and save connection to the configuration file. The -default configuration will be saved to your home directory under -".kube/config". +First\-time users of the client should run this command to connect to a server, establish an authenticated session, and save connection to the configuration file. The default configuration will be saved to your home directory under ".kube/config". .PP -The information required to login \-\- like username and password, a session token, or -the server details \-\- can be provided through flags. If not provided, the command will -prompt for user input as needed. +The information required to login \-\- like username and password, a session token, or the server details \-\- can be provided through flags. If not provided, the command will prompt for user input as needed. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-logout.1 b/docs/man/man1/openshift-cli-logout.1 index 3983bebf59f4..1df5a1d09a4b 100644 --- a/docs/man/man1/openshift-cli-logout.1 +++ b/docs/man/man1/openshift-cli-logout.1 @@ -16,14 +16,10 @@ openshift cli logout \- End the current server session Log out of the active session out by clearing saved tokens .PP -An authentication token is stored in the config file after login \- this command will delete -that token on the server, and then remove the token from the configuration file. +An authentication token is stored in the config file after login \- this command will delete that token on the server, and then remove the token from the configuration file. .PP -If you are using an alternative authentication method like Kerberos or client certificates, -your ticket or client certificate will not be removed from the current system since these -are typically managed by other programs. Instead, you can delete your config file to remove -the local copy of that certificate or the record of your server login. +If you are using an alternative authentication method like Kerberos or client certificates, your ticket or client certificate will not be removed from the current system since these are typically managed by other programs. Instead, you can delete your config file to remove the local copy of that certificate or the record of your server login. .PP After logging out, if you want to log back into the server use 'openshift cli login'. diff --git a/docs/man/man1/openshift-cli-logs.1 b/docs/man/man1/openshift-cli-logs.1 index f52da96728db..8dca7b0ba2db 100644 --- a/docs/man/man1/openshift-cli-logs.1 +++ b/docs/man/man1/openshift-cli-logs.1 @@ -16,14 +16,10 @@ openshift cli logs \- Print the logs for a resource. Print the logs for a resource. .PP -Supported resources are builds, build configs (bc), deployment configs (dc), and pods. -When a pod is specified and has more than one container, the container name should be -specified via \-c. When a build config or deployment config is specified, you can view -the logs for a particular version of it via \-\-version. +Supported resources are builds, build configs (bc), deployment configs (dc), and pods. When a pod is specified and has more than one container, the container name should be specified via \-c. When a build config or deployment config is specified, you can view the logs for a particular version of it via \-\-version. .PP -If your pod is failing to start, you may need to use the \-\-previous option to see the -logs of the last attempt. +If your pod is failing to start, you may need to use the \-\-previous option to see the logs of the last attempt. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-new-app.1 b/docs/man/man1/openshift-cli-new-app.1 index 50201ad1fdd6..379c66648c27 100644 --- a/docs/man/man1/openshift-cli-new-app.1 +++ b/docs/man/man1/openshift-cli-new-app.1 @@ -16,21 +16,13 @@ openshift cli new\-app \- Create a new application Create a new application by specifying source code, templates, and/or images .PP -This command will try to build up the components of an application using images, templates, -or code that has a public repository. It will lookup the images on the local Docker installation -(if available), a Docker registry, an integrated image stream, or stored templates. +This command will try to build up the components of an application using images, templates, or code that has a public repository. It will lookup the images on the local Docker installation (if available), a Docker registry, an integrated image stream, or stored templates. .PP -If you specify a source code URL, it will set up a build that takes your source code and converts -it into an image that can run inside of a pod. Local source must be in a git repository that has a -remote repository that the server can see. The images will be deployed via a deployment -configuration, and a service will be connected to the first public port of the app. You may either specify -components using the various existing flags or let new\-app autodetect what kind of components -you have provided. +If you specify a source code URL, it will set up a build that takes your source code and converts it into an image that can run inside of a pod. Local source must be in a git repository that has a remote repository that the server can see. The images will be deployed via a deployment configuration, and a service will be connected to the first public port of the app. You may either specify components using the various existing flags or let new\-app autodetect what kind of components you have provided. .PP -If you provide source code, a new build will be automatically triggered. -You can use 'openshift cli status' to check the progress. +If you provide source code, a new build will be automatically triggered. You can use 'openshift cli status' to check the progress. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-new-build.1 b/docs/man/man1/openshift-cli-new-build.1 index 6d4ea18a10cb..9c8844155466 100644 --- a/docs/man/man1/openshift-cli-new-build.1 +++ b/docs/man/man1/openshift-cli-new-build.1 @@ -16,18 +16,13 @@ openshift cli new\-build \- Create a new build configuration Create a new build by specifying source code .PP -This command will try to create a build configuration for your application using images and -code that has a public repository. It will lookup the images on the local Docker installation -(if available), a Docker registry, or an image stream. +This command will try to create a build configuration for your application using images and code that has a public repository. It will lookup the images on the local Docker installation (if available), a Docker registry, or an image stream. .PP -If you specify a source code URL, it will set up a build that takes your source code and converts -it into an image that can run inside of a pod. Local source must be in a git repository that has a -remote repository that the server can see. +If you specify a source code URL, it will set up a build that takes your source code and converts it into an image that can run inside of a pod. Local source must be in a git repository that has a remote repository that the server can see. .PP -Once the build configuration is created a new build will be automatically triggered. -You can use 'openshift cli status' to check the progress. +Once the build configuration is created a new build will be automatically triggered. You can use 'openshift cli status' to check the progress. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-new-project.1 b/docs/man/man1/openshift-cli-new-project.1 index 6ae69945d746..ad1492ee2f5a 100644 --- a/docs/man/man1/openshift-cli-new-project.1 +++ b/docs/man/man1/openshift-cli-new-project.1 @@ -16,8 +16,7 @@ openshift cli new\-project \- Request a new project Create a new project for yourself .PP -If your administrator allows self\-service, this command will create a new project for you and assign you -as the project admin. +If your administrator allows self\-service, this command will create a new project for you and assign you as the project admin. .PP After your project is created it will become the default project in your config. diff --git a/docs/man/man1/openshift-cli-observe.1 b/docs/man/man1/openshift-cli-observe.1 index 8078cccae0aa..cceac09a9b3b 100644 --- a/docs/man/man1/openshift-cli-observe.1 +++ b/docs/man/man1/openshift-cli-observe.1 @@ -16,36 +16,32 @@ openshift cli observe \- Observe changes to resources and react to them (experim Observe changes to resources and take action on them .PP -This command assists in building scripted reactions to changes that occur in -Kubernetes or OpenShift resources. This is frequently referred to as a -'controller' in Kubernetes and acts to ensure particular conditions are -maintained. On startup, observe will list all of the resources of a -particular type and execute the provided script on each one. Observe watches -the server for changes, and will reexecute the script for each update. +This command assists in building scripted reactions to changes that occur in Kubernetes or OpenShift resources. This is frequently referred to as a 'controller' in Kubernetes and acts to ensure particular conditions are maintained. On startup, observe will list all of the resources of a particular type and execute the provided script on each one. Observe watches the server for changes, and will reexecute the script for each update. .PP -Observe works best for problems of the form "for every resource X, make sure -Y is true". Some examples of ways observe can be used include: +Observe works best for problems of the form "for every resource X, make sure Y is true". Some examples of ways observe can be used include: .IP .IP \(bu Ensure every namespace has a quota or limit range object +.br .IP \(bu Ensure every service is registered in DNS by making calls to a DNS API +.br .IP \(bu Send an email alert whenever a node reports 'NotReady' +.br .IP \(bu Watch for the 'FailedScheduling' event and write an IRC message +.br .IP \(bu Dynamically provision persistent volumes when a new PVC is created +.br .IP \(bu Delete pods that have reached successful completion after a period of time. +.br .PP -The simplest pattern is maintaining an invariant on an object \- for instance, -"every namespace should have an annotation that indicates its owner". If the -object is deleted no reaction is necessary. A variation on that pattern is -creating another object: "every namespace should have a quota object based -on the resources allowed for an owner". +The simplest pattern is maintaining an invariant on an object \- for instance, "every namespace should have an annotation that indicates its owner". If the object is deleted no reaction is necessary. A variation on that pattern is creating another object: "every namespace should have a quota object based on the resources allowed for an owner". .PP $ cat set\_owner.sh @@ -58,23 +54,13 @@ $ cat set\_owner.sh $ openshift cli observe namespaces \-\- ./set\_owner.sh .PP -The set\_owner.sh script is invoked with a single argument (the namespace name) -for each namespace. This simple script ensures that any user without the -"owner" annotation gets one set, but preserves any existing value. +The set \_owner.sh script is invoked with a single argument (the namespace name) for each namespace. This simple script ensures that any user without the "owner" annotation gets one set, but preserves any existing value. .PP -The next common of controller pattern is provisioning \- making changes in an -external system to match the state of a Kubernetes resource. These scripts need -to account for deletions that may take place while the observe command is not -running. You can provide the list of known objects via the \-\-names command, -which should return a newline\-delimited list of names or namespace/name pairs. -Your command will be invoked whenever observe checks the latest state on the -server \- any resources returned by \-\-names that are not found on the server -will be passed to your \-\-delete command. +The next common of controller pattern is provisioning \- making changes in an external system to match the state of a Kubernetes resource. These scripts need to account for deletions that may take place while the observe command is not running. You can provide the list of known objects via the \-\-names command, which should return a newline\-delimited list of names or namespace/name pairs. Your command will be invoked whenever observe checks the latest state on the server \- any resources returned by \-\-names that are not found on the server will be passed to your \-\-delete command. .PP -For example, you may wish to ensure that every node that is added to Kubernetes -is added to your cluster inventory along with its IP: +For example, you may wish to ensure that every node that is added to Kubernetes is added to your cluster inventory along with its IP: .PP $ cat add\_to\_inventory.sh @@ -96,27 +82,18 @@ $ cat known\_nodes.sh .PP $ openshift cli observe nodes \-a '{ .status.addresses[0].address }' \\ - \-\-names ./known\_nodes.sh \\ - \-\-delete ./remove\_from\_inventory.sh \\ - \-\- ./add\_to\_inventory.sh + \-\-names ./known\_nodes.sh \\ + \-\-delete ./remove\_from\_inventory.sh \\ + \-\- ./add\_to\_inventory.sh .PP -If you stop the observe command and then delete a node, when you launch observe -again the contents of inventory will be compared to the list of nodes from the -server, and any node in the inventory file that no longer exists will trigger -a call to remove\_from\_inventory.sh with the name of the node. +If you stop the observe command and then delete a node, when you launch observe again the contents of inventory will be compared to the list of nodes from the server, and any node in the inventory file that no longer exists will trigger a call to remove from inventory.sh with the name of the node. .PP -Important: when handling deletes, the previous state of the object may not be - available and only the name/namespace of the object will be passed to your - \-\-delete command as arguments (all custom arguments are omitted). +Important: when handling deletes, the previous state of the object may not be available and only the name/namespace of the object will be passed to your \-\-delete command as arguments (all custom arguments are omitted). .PP -More complicated interactions build on the two examples above \- your inventory -script could make a call to allocate storage on your infrastructure as a -service, or register node names in DNS, or set complex firewalls. The more -complex your integration, the more important it is to record enough data in the -remote system that you can identify when resources on either side are deleted. +More complicated interactions build on the two examples above \- your inventory script could make a call to allocate storage on your infrastructure as a service, or register node names in DNS, or set complex firewalls. The more complex your integration, the more important it is to record enough data in the remote system that you can identify when resources on either side are deleted. .PP Experimental: This command is under active development and may change without notice. @@ -263,11 +240,11 @@ Experimental: This command is under active development and may change without no .RS .nf - # observe changes to services - openshift cli observe services + # Observe changes to services + openshift cli observe services - # observe changes to services, including the clusterIP and invoke a script for each - openshift cli observe services \-a '{ .spec.clusterIP }' \-\- register\_dns.sh + # Observe changes to services, including the clusterIP and invoke a script for each + openshift cli observe services \-a '{ .spec.clusterIP }' \-\- register\_dns.sh .fi diff --git a/docs/man/man1/openshift-cli-process.1 b/docs/man/man1/openshift-cli-process.1 index 25839168c0f0..e3c98472fa3e 100644 --- a/docs/man/man1/openshift-cli-process.1 +++ b/docs/man/man1/openshift-cli-process.1 @@ -16,13 +16,10 @@ openshift cli process \- Process a template into list of resources Process template into a list of resources specified in filename or stdin .PP -Templates allow parameterization of resources prior to being sent to the server for creation or -update. Templates have "parameters", which may either be generated on creation or set by the user, -as well as metadata describing the template. +Templates allow parameterization of resources prior to being sent to the server for creation or update. Templates have "parameters", which may either be generated on creation or set by the user, as well as metadata describing the template. .PP -The output of the process command is always a list of one or more resources. You may pipe the -output to the create command over STDIN (using the '\-f \-' option) or redirect it to a file. +The output of the process command is always a list of one or more resources. You may pipe the output to the create command over STDIN (using the '\-f \-' option) or redirect it to a file. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-project.1 b/docs/man/man1/openshift-cli-project.1 index 00163e9a0683..2e5e3a7014d5 100644 --- a/docs/man/man1/openshift-cli-project.1 +++ b/docs/man/man1/openshift-cli-project.1 @@ -16,16 +16,10 @@ openshift cli project \- Switch to another project Switch to another project and make it the default in your configuration .PP -If no project was specified on the command line, display information about the current active -project. Since you can use this command to connect to projects on different servers, you will -occasionally encounter projects of the same name on different servers. When switching to that -project, a new local context will be created that will have a unique name \- for instance, -'myapp\-2'. If you have previously created a context with a different name than the project -name, this command will accept that context name instead. +If no project was specified on the command line, display information about the current active project. Since you can use this command to connect to projects on different servers, you will occasionally encounter projects of the same name on different servers. When switching to that project, a new local context will be created that will have a unique name \- for instance, 'myapp\-2'. If you have previously created a context with a different name than the project name, this command will accept that context name instead. .PP -For advanced configuration, or to manage the contents of your config file, use the 'config' -command. +For advanced configuration, or to manage the contents of your config file, use the 'config' command. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-projects.1 b/docs/man/man1/openshift-cli-projects.1 index 6689098be29b..e640fe13fe11 100644 --- a/docs/man/man1/openshift-cli-projects.1 +++ b/docs/man/man1/openshift-cli-projects.1 @@ -16,8 +16,7 @@ openshift cli projects \- Display existing projects Display information about the current active project and existing projects on the server. .PP -For advanced configuration, or to manage the contents of your config file, use the 'config' -command. +For advanced configuration, or to manage the contents of your config file, use the 'config' command. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-rollback.1 b/docs/man/man1/openshift-cli-rollback.1 index 9f0d6b2667bf..86474d0c3e62 100644 --- a/docs/man/man1/openshift-cli-rollback.1 +++ b/docs/man/man1/openshift-cli-rollback.1 @@ -16,24 +16,13 @@ openshift cli rollback \- Revert part of an application back to a previous deplo Revert an application back to a previous deployment .PP -When you run this command your deployment configuration will be updated to -match a previous deployment. By default only the pod and container -configuration will be changed and scaling or trigger settings will be left as\- -is. Note that environment variables and volumes are included in rollbacks, so -if you've recently updated security credentials in your environment your -previous deployment may not have the correct values. +When you run this command your deployment configuration will be updated to match a previous deployment. By default only the pod and container configuration will be changed and scaling or trigger settings will be left as\- is. Note that environment variables and volumes are included in rollbacks, so if you've recently updated security credentials in your environment your previous deployment may not have the correct values. .PP -Any image triggers present in the rolled back configuration will be disabled -with a warning. This is to help prevent your rolled back deployment from being -replaced by a triggered deployment soon after your rollback. To re\-enable the -triggers, use the 'deploy' command. +Any image triggers present in the rolled back configuration will be disabled with a warning. This is to help prevent your rolled back deployment from being replaced by a triggered deployment soon after your rollback. To re\-enable the triggers, use the 'deploy' command. .PP -If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print -a human\-readable representation of the updated deployment configuration instead of -executing the rollback. This is useful if you're not quite sure what the outcome -will be. +If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print a human\-readable representation of the updated deployment configuration instead of executing the rollback. This is useful if you're not quite sure what the outcome will be. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-rollout-history.1 b/docs/man/man1/openshift-cli-rollout-history.1 index d39042476a58..1b374bddc99e 100644 --- a/docs/man/man1/openshift-cli-rollout-history.1 +++ b/docs/man/man1/openshift-cli-rollout-history.1 @@ -16,8 +16,7 @@ openshift cli rollout history \- View rollout history View the history of rollouts for a specific deployment config .PP -You can also view more detailed information for a specific revision -by using the \-\-revision flag. +You can also view more detailed information for a specific revision by using the \-\-revision flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-rollout-pause.1 b/docs/man/man1/openshift-cli-rollout-pause.1 index 7b31206d4f0e..1e2df0c75169 100644 --- a/docs/man/man1/openshift-cli-rollout-pause.1 +++ b/docs/man/man1/openshift-cli-rollout-pause.1 @@ -16,8 +16,7 @@ openshift cli rollout pause \- Mark the provided resource as paused Mark the provided resource as paused .PP -Paused resources will not be reconciled by a controller. -Use \\"%[1]s rollout resume\\" to resume a paused resource. +Paused resources will not be reconciled by a controller. Use \\"% [1]s rollout resume \\" to resume a paused resource. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-rollout-resume.1 b/docs/man/man1/openshift-cli-rollout-resume.1 index cdcf9375e33c..3c1d9c205548 100644 --- a/docs/man/man1/openshift-cli-rollout-resume.1 +++ b/docs/man/man1/openshift-cli-rollout-resume.1 @@ -16,8 +16,7 @@ openshift cli rollout resume \- Resume a paused resource Resume a paused resource .PP -Paused resources will not be reconciled by a controller. By resuming a -resource, we allow it to be reconciled again. +Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-rollout-undo.1 b/docs/man/man1/openshift-cli-rollout-undo.1 index 2516bb5018c8..374a94329e20 100644 --- a/docs/man/man1/openshift-cli-rollout-undo.1 +++ b/docs/man/man1/openshift-cli-rollout-undo.1 @@ -16,24 +16,13 @@ openshift cli rollout undo \- Undo a previous rollout Revert an application back to a previous deployment .PP -When you run this command your deployment configuration will be updated to -match a previous deployment. By default only the pod and container -configuration will be changed and scaling or trigger settings will be left as\- -is. Note that environment variables and volumes are included in rollbacks, so -if you've recently updated security credentials in your environment your -previous deployment may not have the correct values. +When you run this command your deployment configuration will be updated to match a previous deployment. By default only the pod and container configuration will be changed and scaling or trigger settings will be left as\- is. Note that environment variables and volumes are included in rollbacks, so if you've recently updated security credentials in your environment your previous deployment may not have the correct values. .PP -Any image triggers present in the rolled back configuration will be disabled -with a warning. This is to help prevent your rolled back deployment from being -replaced by a triggered deployment soon after your rollback. To re\-enable the -triggers, use the 'deploy \-\-enable\-triggers' command. +Any image triggers present in the rolled back configuration will be disabled with a warning. This is to help prevent your rolled back deployment from being replaced by a triggered deployment soon after your rollback. To re\-enable the triggers, use the 'deploy \-\-enable\-triggers' command. .PP -If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print -a human\-readable representation of the updated deployment configuration instead of -executing the rollback. This is useful if you're not quite sure what the outcome -will be. +If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print a human\-readable representation of the updated deployment configuration instead of executing the rollback. This is useful if you're not quite sure what the outcome will be. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-rsh.1 b/docs/man/man1/openshift-cli-rsh.1 index 2a4cf999c0c7..bea4917c90bf 100644 --- a/docs/man/man1/openshift-cli-rsh.1 +++ b/docs/man/man1/openshift-cli-rsh.1 @@ -16,19 +16,10 @@ openshift cli rsh \- Start a shell session in a pod Open a remote shell session to a container .PP -This command will attempt to start a shell session in a pod for the specified resource. -It works with pods, deployment configs, jobs, daemon sets, and replication controllers. -Any of the aforementioned resources (apart from pods) will be resolved to a ready pod. -It will default to the first container if none is specified, and will attempt to use -'/bin/sh' as the default shell. You may pass an optional command after the resource name, -which will be executed instead of a login shell. A TTY will be automatically allocated -if standard input is interactive \- use \-t and \-T to override. A TERM variable is sent -to the environment where the shell (or command) will be executed. By default its value -is the same as the TERM variable from the local environment; if not set, 'xterm' is used. - -.PP -Note, some containers may not include a shell \- use 'openshift cli exec' if you need to run commands -directly. +This command will attempt to start a shell session in a pod for the specified resource. It works with pods, deployment configs, jobs, daemon sets, and replication controllers. Any of the aforementioned resources (apart from pods) will be resolved to a ready pod. It will default to the first container if none is specified, and will attempt to use '/bin/sh' as the default shell. You may pass an optional command after the resource name, which will be executed instead of a login shell. A TTY will be automatically allocated if standard input is interactive \- use \-t and \-T to override. A TERM variable is sent to the environment where the shell (or command) will be executed. By default its value is the same as the TERM variable from the local environment; if not set, 'xterm' is used. + +.PP +Note, some containers may not include a shell \- use 'openshift cli exec' if you need to run commands directly. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-rsync.1 b/docs/man/man1/openshift-cli-rsync.1 index 7eb13ecc2aaa..55c4fc92c075 100644 --- a/docs/man/man1/openshift-cli-rsync.1 +++ b/docs/man/man1/openshift-cli-rsync.1 @@ -16,16 +16,11 @@ openshift cli rsync \- Copy files between local filesystem and a pod Copy local files to or from a pod container .PP -This command will copy local files to or from a remote container. -It only copies the changed files using the rsync command from your OS. -To ensure optimum performance, install rsync locally. In UNIX systems, -use your package manager. In Windows, install cwRsync from - +This command will copy local files to or from a remote container. It only copies the changed files using the rsync command from your OS. To ensure optimum performance, install rsync locally. In UNIX systems, use your package manager. In Windows, install cwRsync from \[la]https://www.itefix.net/cwrsync\[ra]. .PP -If no container is specified, the first container of the pod is used -for the copy. +If no container is specified, the first container of the pod is used for the copy. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-run.1 b/docs/man/man1/openshift-cli-run.1 index d9a8586d85d7..33daa18776e3 100644 --- a/docs/man/man1/openshift-cli-run.1 +++ b/docs/man/man1/openshift-cli-run.1 @@ -16,9 +16,7 @@ openshift cli run \- Run a particular image on the cluster Create and run a particular image, possibly replicated .PP -Creates a deployment config to manage the created container(s). You can choose to run in the -foreground for an interactive container execution. You may pass 'run/v1' to -\-\-generator to create a replication controller instead of a deployment config. +Creates a deployment config to manage the created container(s). You can choose to run in the foreground for an interactive container execution. You may pass 'run/v1' to \-\-generator to create a replication controller instead of a deployment config. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-scale.1 b/docs/man/man1/openshift-cli-scale.1 index b9f049e317fe..ed58610e2ab0 100644 --- a/docs/man/man1/openshift-cli-scale.1 +++ b/docs/man/man1/openshift-cli-scale.1 @@ -16,14 +16,10 @@ openshift cli scale \- Change the number of pods in a deployment Set a new size for a deployment or replication controller .PP -Scale also allows users to specify one or more preconditions for the scale action. -If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before the -scale is attempted, and it is guaranteed that the precondition holds true when the -scale is sent to the server. +Scale also allows users to specify one or more preconditions for the scale action. If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server. .PP -Note that scaling a deployment configuration with no deployments will update the -desired replicas in the configuration template. +Note that scaling a deployment configuration with no deployments will update the desired replicas in the configuration template. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-secrets-link.1 b/docs/man/man1/openshift-cli-secrets-link.1 index a9f2aa8f3954..bc252559bb14 100644 --- a/docs/man/man1/openshift-cli-secrets-link.1 +++ b/docs/man/man1/openshift-cli-secrets-link.1 @@ -16,7 +16,7 @@ openshift cli secrets link \- Link secrets to a ServiceAccount Link secrets to a service account .PP -Linking a secret enables a service account to automatically use that secret for some forms of authentication +Linking a secret enables a service account to automatically use that secret for some forms of authentication. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-secrets-new-basicauth.1 b/docs/man/man1/openshift-cli-secrets-new-basicauth.1 index 3ff55115b510..d6ca3a47859e 100644 --- a/docs/man/man1/openshift-cli-secrets-new-basicauth.1 +++ b/docs/man/man1/openshift-cli-secrets-new-basicauth.1 @@ -19,9 +19,7 @@ Create a new basic authentication secret Basic authentication secrets are used to authenticate against SCM servers. .PP -When creating applications, you may have a SCM server that requires basic authentication \- username, password. -In order for the nodes to clone source code on your behalf, they have to have the credentials. You can provide -this information by creating a 'basicauth' secret and attaching it to your service account. +When creating applications, you may have a SCM server that requires basic authentication \- username, password. In order for the nodes to clone source code on your behalf, they have to have the credentials. You can provide this information by creating a 'basicauth' secret and attaching it to your service account. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-secrets-new-dockercfg.1 b/docs/man/man1/openshift-cli-secrets-new-dockercfg.1 index 8e8d6829fbeb..01ba11b1b737 100644 --- a/docs/man/man1/openshift-cli-secrets-new-dockercfg.1 +++ b/docs/man/man1/openshift-cli-secrets-new-dockercfg.1 @@ -19,15 +19,10 @@ Create a new dockercfg secret Dockercfg secrets are used to authenticate against Docker registries. .PP -When using the Docker command line to push images, you can authenticate to a given registry by running - 'docker login DOCKER\_REGISTRY\_SERVER \-\-username=DOCKER\_USER \-\-password=DOCKER\_PASSWORD \-\-email=DOCKER\_EMAIL'. -That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to -authenticate to the registry. +When using the Docker command line to push images, you can authenticate to a given registry by running 'docker login DOCKER REGISTRY SERVER \-\-username=DOCKER USER \-\-password=DOCKER PASSWORD \-\-email=DOCKER \_EMAIL'. That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry. .PP -When creating applications, you may have a Docker registry that requires authentication. In order for the -nodes to pull images on your behalf, they have to have the credentials. You can provide this information -by creating a dockercfg secret and attaching it to your service account. +When creating applications, you may have a Docker registry that requires authentication. In order for the nodes to pull images on your behalf, they have to have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-secrets-new-sshauth.1 b/docs/man/man1/openshift-cli-secrets-new-sshauth.1 index 7cee54219ab6..d5d81a08a06b 100644 --- a/docs/man/man1/openshift-cli-secrets-new-sshauth.1 +++ b/docs/man/man1/openshift-cli-secrets-new-sshauth.1 @@ -19,9 +19,7 @@ Create a new SSH authentication secret SSH authentication secrets are used to authenticate against SCM servers. .PP -When creating applications, you may have a SCM server that requires SSH authentication \- private SSH key. -In order for the nodes to clone source code on your behalf, they have to have the credentials. You can -provide this information by creating a 'sshauth' secret and attaching it to your service account. +When creating applications, you may have a SCM server that requires SSH authentication \- private SSH key. In order for the nodes to clone source code on your behalf, they have to have the credentials. You can provide this information by creating a 'sshauth' secret and attaching it to your service account. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-secrets-new.1 b/docs/man/man1/openshift-cli-secrets-new.1 index 3f887db7eaa8..42dd58bb9565 100644 --- a/docs/man/man1/openshift-cli-secrets-new.1 +++ b/docs/man/man1/openshift-cli-secrets-new.1 @@ -16,9 +16,7 @@ openshift cli secrets new \- Create a new secret based on a key file or on files Create a new secret based on a file or directory .PP -Key files can be specified using their file path, in which case a default name will be given to them, or optionally -with a name and file path, in which case the given name will be used. Specifying a directory will create a secret -using with all valid keys in that directory. +Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will create a secret using with all valid keys in that directory. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-secrets.1 b/docs/man/man1/openshift-cli-secrets.1 index b453a0026582..79b7c8ec4d6d 100644 --- a/docs/man/man1/openshift-cli-secrets.1 +++ b/docs/man/man1/openshift-cli-secrets.1 @@ -16,9 +16,7 @@ openshift cli secrets \- Manage secrets Manage secrets in your project .PP -Secrets are used to store confidential information that should not be contained inside of an image. -They are commonly used to hold things like keys for authentication to other internal systems like -Docker registries. +Secrets are used to store confidential information that should not be contained inside of an image. They are commonly used to hold things like keys for authentication to other internal systems like Docker registries. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-serviceaccounts-get-token.1 b/docs/man/man1/openshift-cli-serviceaccounts-get-token.1 index 0a41ccfb24a7..0a7813acda44 100644 --- a/docs/man/man1/openshift-cli-serviceaccounts-get-token.1 +++ b/docs/man/man1/openshift-cli-serviceaccounts-get-token.1 @@ -19,9 +19,7 @@ Get a token assigned to a service account. 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. +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 INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-serviceaccounts-new-token.1 b/docs/man/man1/openshift-cli-serviceaccounts-new-token.1 index 4186c98b3ddf..f59b5fb875ea 100644 --- a/docs/man/man1/openshift-cli-serviceaccounts-new-token.1 +++ b/docs/man/man1/openshift-cli-serviceaccounts-new-token.1 @@ -16,11 +16,7 @@ openshift cli serviceaccounts new\-token \- Generate a new token for a service a Generate a new token for a service account. .PP -Service account API tokens are used by service accounts to authenticate to the API. -This command will generate a new token, which could be used to compartmentalize service -account actions by executing them with distinct tokens, to rotate out pre\-existing token -on the service account, or for use by an external client. If a label is provided, it will -be applied to any created token so that tokens created with this command can be idenitifed. +Service account API tokens are used by service accounts to authenticate to the API. This command will generate a new token, which could be used to compartmentalize service account actions by executing them with distinct tokens, to rotate out pre\-existing token on the service account, or for use by an external client. If a label is provided, it will be applied to any created token so that tokens created with this command can be idenitifed. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-set-build-hook.1 b/docs/man/man1/openshift-cli-set-build-hook.1 index c3c2221f9149..802cfa42cbc6 100644 --- a/docs/man/man1/openshift-cli-set-build-hook.1 +++ b/docs/man/man1/openshift-cli-set-build-hook.1 @@ -19,17 +19,10 @@ Set or remove a build hook on a build config Build hooks allow behavior to be injected into the build process. .PP -A post\-commit build hook is executed after a build has committed an image but before the -image has been pushed to a registry. It can be used to execute tests on the image and verify -it before it is made available in a registry or for any other logic that is needed to execute -before the image is pushed to the registry. A new container with the recently built image is -launched with the build hook command. If the command or script run by the build hook returns a -non\-zero exit code, the resulting image will not be pushed to the registry. +A post\-commit build hook is executed after a build has committed an image but before the image has been pushed to a registry. It can be used to execute tests on the image and verify it before it is made available in a registry or for any other logic that is needed to execute before the image is pushed to the registry. A new container with the recently built image is launched with the build hook command. If the command or script run by the build hook returns a non\-zero exit code, the resulting image will not be pushed to the registry. .PP -The command for a build hook may be specified as a shell script (with the \-\-script argument), -as a new entrypoint command on the image with the \-\-command argument, or as a set of -arguments to the image's entrypoint (default). +The command for a build hook may be specified as a shell script (with the \-\-script argument), as a new entrypoint command on the image with the \-\-command argument, or as a set of arguments to the image's entrypoint (default). .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-set-deployment-hook.1 b/docs/man/man1/openshift-cli-set-deployment-hook.1 index 1ec80cee7417..56a60e4e42d2 100644 --- a/docs/man/man1/openshift-cli-set-deployment-hook.1 +++ b/docs/man/man1/openshift-cli-set-deployment-hook.1 @@ -16,29 +16,19 @@ openshift cli set deployment\-hook \- Update a deployment hook on a deployment c Set or remove a deployment hook on a deployment config .PP -Deployment configs allow hooks to execute at different points in the lifecycle of the -deployment, depending on the deployment strategy. +Deployment configs allow hooks to execute at different points in the lifecycle of the deployment, depending on the deployment strategy. .PP -For deployments with a Recreate strategy, a Pre, Mid, and Post hook can be specified. -The Pre hook will execute before the deployment starts. The Mid hook will execute once the -previous deployment has been scaled down to 0, but before the new one ramps up. -The Post hook will execute once the deployment has completed. +For deployments with a Recreate strategy, a Pre, Mid, and Post hook can be specified. The Pre hook will execute before the deployment starts. The Mid hook will execute once the previous deployment has been scaled down to 0, but before the new one ramps up. The Post hook will execute once the deployment has completed. .PP -For deployments with a Rolling strategy, a Pre and Post hook can be specified. -The Pre hook will execute before the deployment starts and the Post hook will execute once -the deployment has completed. +For deployments with a Rolling strategy, a Pre and Post hook can be specified. The Pre hook will execute before the deployment starts and the Post hook will execute once the deployment has completed. .PP -For each hook, a new pod will be started using one of the containers in the deployment's pod -template with a specific command to execute. Additional environment variables may be specified -for the hook, as well as which volumes from the pod template will be mounted on the hook pod. +For each hook, a new pod will be started using one of the containers in the deployment's pod template with a specific command to execute. Additional environment variables may be specified for the hook, as well as which volumes from the pod template will be mounted on the hook pod. .PP -Each hook can have its own cancellation policy. One of: abort, retry, or ignore. Not all cancellation -policies can be set on all hooks. For example, a Post hook on a rolling strategy does not support -the abort policy, because at that point the deployment has already happened. +Each hook can have its own cancellation policy. One of: abort, retry, or ignore. Not all cancellation policies can be set on all hooks. For example, a Post hook on a rolling strategy does not support the abort policy, because at that point the deployment has already happened. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-set-env.1 b/docs/man/man1/openshift-cli-set-env.1 index 85ba87bce5c0..09cea14fb6eb 100644 --- a/docs/man/man1/openshift-cli-set-env.1 +++ b/docs/man/man1/openshift-cli-set-env.1 @@ -16,17 +16,10 @@ openshift cli set env \- Update environment variables on a pod template Update environment variables on a pod template or a build config .PP -List environment variable definitions in one or more pods, pod templates or build -configuration. -Add, update, or remove container environment variable definitions in one or -more pod templates (within replication controllers or deployment configurations) or -build configurations. -View or modify the environment variable definitions on all containers in the -specified pods or pod templates, or just those that match a wildcard. +List environment variable definitions in one or more pods, pod templates or build configuration. Add, update, or remove container environment variable definitions in one or more pod templates (within replication controllers or deployment configurations) or build configurations. View or modify the environment variable definitions on all containers in the specified pods or pod templates, or just those that match a wildcard. .PP -If "\-\-env \-" is passed, environment variables can be read from STDIN using the standard env -syntax. +If "\-\-env \-" is passed, environment variables can be read from STDIN using the standard env syntax. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-set-probe.1 b/docs/man/man1/openshift-cli-set-probe.1 index b9567da5be94..91abe66da4fd 100644 --- a/docs/man/man1/openshift-cli-set-probe.1 +++ b/docs/man/man1/openshift-cli-set-probe.1 @@ -16,13 +16,7 @@ openshift cli set probe \- Update a probe on a pod template Set or remove a liveness or readiness probe from a pod or pod template .PP -Each container in a pod may define one or more probes that are used for general health -checking. A liveness probe is checked periodically to ensure the container is still healthy: -if the probe fails, the container is restarted. Readiness probes set or clear the ready -flag for each container, which controls whether the container's ports are included in the list -of endpoints for a service and whether a deployment can proceed. A readiness check should -indicate when your container is ready to accept incoming traffic or begin handling work. -Setting both liveness and readiness probes for each container is highly recommended. +Each container in a pod may define one or more probes that are used for general health checking. A liveness probe is checked periodically to ensure the container is still healthy: if the probe fails, the container is restarted. Readiness probes set or clear the ready flag for each container, which controls whether the container's ports are included in the list of endpoints for a service and whether a deployment can proceed. A readiness check should indicate when your container is ready to accept incoming traffic or begin handling work. Setting both liveness and readiness probes for each container is highly recommended. .PP The three probe types are: @@ -30,14 +24,15 @@ The three probe types are: .IP \(bu Open a TCP socket on the pod IP +.br .IP \(bu Perform an HTTP GET against a URL on a container that must return 200 OK +.br .IP \(bu Run a command in the container that must return exit code 0 +.br .PP -Containers that take a variable amount of time to start should set generous -initial\-delay\-seconds values, otherwise as your application evolves you may suddenly begin -to fail. +Containers that take a variable amount of time to start should set generous initial\-delay\-seconds values, otherwise as your application evolves you may suddenly begin to fail. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-set-route-backends.1 b/docs/man/man1/openshift-cli-set-route-backends.1 index 43f87775c9ba..449716c751a8 100644 --- a/docs/man/man1/openshift-cli-set-route-backends.1 +++ b/docs/man/man1/openshift-cli-set-route-backends.1 @@ -16,34 +16,19 @@ openshift cli set route\-backends \- Update the backends for a route Set and adjust route backends .PP -Routes may have one or more optional backend services with weights controlling how much -traffic flows to each service. Traffic is assigned proportional to the combined weights -of each backend. A weight of zero means that the backend will receive no traffic. If all -weights are zero the route will not send traffic to any backends. +Routes may have one or more optional backend services with weights controlling how much traffic flows to each service. Traffic is assigned proportional to the combined weights of each backend. A weight of zero means that the backend will receive no traffic. If all weights are zero the route will not send traffic to any backends. .PP -When setting backends, the first backend is the primary and the other backends are -considered alternates. For example: +When setting backends, the first backend is the primary and the other backends are considered alternates. For example: .PP -.RS - -.nf $ openshift cli set route\-backends web prod=99 canary=1 -.fi -.RE - .PP -will set the primary backend to service "prod" with a weight of 99 and the first -alternate backend to service "canary" with a weight of 1. This means 99% of traffic will -be sent to the service "prod". +will set the primary backend to service "prod" with a weight of 99 and the first alternate backend to service "canary" with a weight of 1. This means 99% of traffic will be sent to the service "prod". .PP -The \-\-adjust flag allows you to alter the weight of an individual service relative to -itself or to the primary backend. Specifying a percentage will adjust the backend -relative to either the primary or the first alternate (if you specify the primary). -If there are other backends their weights will be kept proportional to the changed. +The \-\-adjust flag allows you to alter the weight of an individual service relative to itself or to the primary backend. Specifying a percentage will adjust the backend relative to either the primary or the first alternate (if you specify the primary). If there are other backends their weights will be kept proportional to the changed. .PP Not all routers may support multiple or weighted backends. diff --git a/docs/man/man1/openshift-cli-set-triggers.1 b/docs/man/man1/openshift-cli-set-triggers.1 index eed1026dcd6f..8543184edbd2 100644 --- a/docs/man/man1/openshift-cli-set-triggers.1 +++ b/docs/man/man1/openshift-cli-set-triggers.1 @@ -16,18 +16,13 @@ openshift cli set triggers \- Update the triggers on a build or deployment confi Set or remove triggers for build configs and deployment configs .PP -All build configs and deployment configs may have a set of triggers that result in a new deployment -or build being created. This command enables you to alter those triggers \- making them automatic or -manual, adding new entries, or changing existing entries. +All build configs and deployment configs may have a set of triggers that result in a new deployment or build being created. This command enables you to alter those triggers \- making them automatic or manual, adding new entries, or changing existing entries. .PP -Deployments support triggering off of image changes and on config changes. Config changes are any -alterations to the pod template, while image changes will result in the container image value being -updated whenever an image stream tag is updated. +Deployments support triggering off of image changes and on config changes. Config changes are any alterations to the pod template, while image changes will result in the container image value being updated whenever an image stream tag is updated. .PP -Build configs support triggering off of image changes, config changes, and webhooks (both GitHub\-specific -and generic). The config change trigger for a build config will only trigger the first build. +Build configs support triggering off of image changes, config changes, and webhooks (both GitHub\-specific and generic). The config change trigger for a build config will only trigger the first build. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-set-volumes.1 b/docs/man/man1/openshift-cli-set-volumes.1 index fca6e9dce5af..ecfd69ddf871 100644 --- a/docs/man/man1/openshift-cli-set-volumes.1 +++ b/docs/man/man1/openshift-cli-set-volumes.1 @@ -16,36 +16,27 @@ openshift cli set volumes \- Update volumes on a pod template Update volumes on a pod template .PP -This command can add, update or remove volumes from containers for any object -that has a pod template (deployment configs, replication controllers, or pods). -You can list volumes in pod or any object that has a pod template. You can -specify a single object or multiple, and alter volumes on all containers or -just those that match a given name. +This command can add, update or remove volumes from containers for any object that has a pod template (deployment configs, replication controllers, or pods). You can list volumes in pod or any object that has a pod template. You can specify a single object or multiple, and alter volumes on all containers or just those that match a given name. .PP -If you alter a volume setting on a deployment config, a deployment will be -triggered. Changing a replication controller will not affect running pods, and -you cannot change a pod's volumes once it has been created. +If you alter a volume setting on a deployment config, a deployment will be triggered. Changing a replication controller will not affect running pods, and you cannot change a pod's volumes once it has been created. .PP Volume types include: .IP .IP -\(bu emptydir (empty directory) \fIdefault\fP -A directory allocated when the pod is created on a local host, is removed when -the pod is deleted and is not copied across servers +\(bu emptydir (empty directory) default : A directory allocated when the pod is created on a local host, is removed when the pod is deleted and is not copied across servers +.br .IP -\(bu hostdir (host directory) -A directory with specific path on any host (requires elevated privileges) +\(bu hostdir (host directory): A directory with specific path on any host (requires elevated privileges) +.br .IP -\(bu persistentvolumeclaim or pvc (persistent volume claim) -Link the volume directory in the container to a persistent volume claim you have -allocated by name \- a persistent volume claim is a request to allocate storage. -Note that if your claim hasn't been bound, your pods will not start. +\(bu persistentvolumeclaim or pvc (persistent volume claim): Link the volume directory in the container to a persistent volume claim you have allocated by name \- a persistent volume claim is a request to allocate storage. Note that if your claim hasn't been bound, your pods will not start. +.br .IP -\(bu secret (mounted secret) -Secret volumes mount a named secret to the provided directory. +\(bu secret (mounted secret): Secret volumes mount a named secret to the provided directory. +.br .PP For descriptions on other volume types, see \[la]https://docs.openshift.com\[ra] diff --git a/docs/man/man1/openshift-cli-start-build.1 b/docs/man/man1/openshift-cli-start-build.1 index 884d2df93394..82303e26a6fd 100644 --- a/docs/man/man1/openshift-cli-start-build.1 +++ b/docs/man/man1/openshift-cli-start-build.1 @@ -16,17 +16,10 @@ openshift cli start\-build \- Start a new build Start a build .PP -This command starts a new build for the provided build config or copies an existing build using -\-\-from\-build=. Pass the \-\-follow flag to see output from the build. +This command starts a new build for the provided build config or copies an existing build using \-\-from\-build= . Pass the \-\-follow flag to see output from the build. .PP -In addition, you can pass a file, directory, or source code repository with the \-\-from\-file, -\-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the build -and override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can be -used to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, the -file is placed in the root of an empty directory with the same filename. Note that builds -triggered from binary input will not preserve the source on the server, so rebuilds triggered by -base image changes will use the source specified on the build config. +In addition, you can pass a file, directory, or source code repository with the \-\-from\-file, \-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the build and override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can be used to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, the file is placed in the root of an empty directory with the same filename. Note that builds triggered from binary input will not preserve the source on the server, so rebuilds triggered by base image changes will use the source specified on the build config. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-status.1 b/docs/man/man1/openshift-cli-status.1 index 5d6fb9c1e55b..4b1cf310e1bc 100644 --- a/docs/man/man1/openshift-cli-status.1 +++ b/docs/man/man1/openshift-cli-status.1 @@ -16,14 +16,10 @@ openshift cli status \- Show an overview of the current project Show a high level overview of the current project .PP -This command will show services, deployment configs, build configurations, and active deployments. -If you have any misconfigured components information about them will be shown. For more information -about individual items, use the describe command (e.g. openshift cli describe buildConfig, -openshift cli describe deploymentConfig, openshift cli describe service). +This command will show services, deployment configs, build configurations, and active deployments. If you have any misconfigured components information about them will be shown. For more information about individual items, use the describe command (e.g. openshift cli describe buildConfig, openshift cli describe deploymentConfig, openshift cli describe service). .PP -You can specify an output format of "\-o dot" to have this command output the generated status -graph in DOT format that is suitable for use by the "dot" command. +You can specify an output format of "\-o dot" to have this command output the generated status graph in DOT format that is suitable for use by the "dot" command. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-tag.1 b/docs/man/man1/openshift-cli-tag.1 index c9791a8e3ef6..7bd025290ec0 100644 --- a/docs/man/man1/openshift-cli-tag.1 +++ b/docs/man/man1/openshift-cli-tag.1 @@ -16,17 +16,10 @@ openshift cli tag \- Tag existing images into image streams Tag existing images into image streams .PP -The tag command allows you to take an existing tag or image from an image -stream, or a Docker image pull spec, and set it as the most recent image for a -tag in 1 or more other image streams. It is similar to the 'docker tag' -command, but it operates on image streams instead. +The tag command allows you to take an existing tag or image from an image stream, or a Docker image pull spec, and set it as the most recent image for a tag in 1 or more other image streams. It is similar to the 'docker tag' command, but it operates on image streams instead. .PP -Pass the \-\-insecure flag if your external registry does not have a valid HTTPS -certificate, or is only served over HTTP. Pass \-\-scheduled to have the server -regularly check the tag for updates and import the latest version (which can -then trigger builds and deployments). Note that \-\-scheduled is only allowed for -Docker images. +Pass the \-\-insecure flag if your external registry does not have a valid HTTPS certificate, or is only served over HTTP. Pass \-\-scheduled to have the server regularly check the tag for updates and import the latest version (which can then trigger builds and deployments). Note that \-\-scheduled is only allowed for Docker images. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-whoami.1 b/docs/man/man1/openshift-cli-whoami.1 index e7f70473f4df..4cb5b9c62530 100644 --- a/docs/man/man1/openshift-cli-whoami.1 +++ b/docs/man/man1/openshift-cli-whoami.1 @@ -16,9 +16,7 @@ openshift cli whoami \- Return information about the current session Show information about the current session .PP -The default options for this command will return the currently authenticated user name -or an empty string. Other flags support returning the currently used token or the -user context. +The default options for this command will return the currently authenticated user name or an empty string. Other flags support returning the currently used token or the user context. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli.1 b/docs/man/man1/openshift-cli.1 index 6cc608135d49..7f40d50fd9f4 100644 --- a/docs/man/man1/openshift-cli.1 +++ b/docs/man/man1/openshift-cli.1 @@ -16,9 +16,7 @@ openshift cli \- Command line tools for managing applications OpenShift Client .PP -This client helps you develop, build, deploy, and run your applications on any OpenShift or -Kubernetes compatible platform. It also includes the administrative commands for managing a -cluster under the 'adm' subcommand. +This client helps you develop, build, deploy, and run your applications on any OpenShift or Kubernetes compatible platform. It also includes the administrative commands for managing a cluster under the 'adm' subcommand. .SH OPTIONS diff --git a/docs/man/man1/openshift-completion.1 b/docs/man/man1/openshift-completion.1 index 041b4038a3d2..233f3474006e 100644 --- a/docs/man/man1/openshift-completion.1 +++ b/docs/man/man1/openshift-completion.1 @@ -13,8 +13,7 @@ openshift completion \- Output shell completion code for the given shell (bash o .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of openshift commands. +This command prints shell code which must be evaluated to provide interactive completion of openshift commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-ex-build-chain.1 b/docs/man/man1/openshift-ex-build-chain.1 index 7d08f34d1c00..489d4f1ad2ed 100644 --- a/docs/man/man1/openshift-ex-build-chain.1 +++ b/docs/man/man1/openshift-ex-build-chain.1 @@ -16,9 +16,7 @@ openshift ex 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 the default namespace will be used respectively. .SH OPTIONS diff --git a/docs/man/man1/openshift-ex-ipfailover.1 b/docs/man/man1/openshift-ex-ipfailover.1 index f2916c8f647b..2746b166a8ec 100644 --- a/docs/man/man1/openshift-ex-ipfailover.1 +++ b/docs/man/man1/openshift-ex-ipfailover.1 @@ -16,17 +16,10 @@ openshift ex ipfailover \- Install an IP failover group to a set of nodes Configure or view IP Failover configuration .PP -This command helps to setup an IP failover configuration for the -cluster. An administrator can configure IP failover on an entire -cluster or on a subset of nodes (as defined via a labeled selector). +This command helps to setup an IP failover configuration for the cluster. An administrator can configure IP failover on an entire cluster or on a subset of nodes (as defined via a labeled selector). .PP -If an IP failover configuration does not exist with the given name, -the \-\-create flag can be passed to create a deployment configuration that -will provide IP failover capability. If you are running in production, it is -recommended that the labeled selector for the nodes matches at least 2 nodes -to ensure you have failover protection, and that you provide a \-\-replicas= -value that matches the number of nodes for the given labeled selector. +If an IP failover configuration does not exist with the given name, the \-\-create flag can be passed to create a deployment configuration that will provide IP failover capability. If you are running in production, it is recommended that the labeled selector for the nodes matches at least 2 nodes to ensure you have failover protection, and that you provide a \-\-replicas= value that matches the number of nodes for the given labeled selector. .SH OPTIONS diff --git a/docs/man/man1/openshift-ex-prune-groups.1 b/docs/man/man1/openshift-ex-prune-groups.1 index 8160fbc68777..67acd9da587b 100644 --- a/docs/man/man1/openshift-ex-prune-groups.1 +++ b/docs/man/man1/openshift-ex-prune-groups.1 @@ -16,13 +16,7 @@ openshift ex prune\-groups \- Prune OpenShift groups referencing missing records Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-ex-sync-groups.1 b/docs/man/man1/openshift-ex-sync-groups.1 index 4b9d9319257d..8791b94667d2 100644 --- a/docs/man/man1/openshift-ex-sync-groups.1 +++ b/docs/man/man1/openshift-ex-sync-groups.1 @@ -16,13 +16,7 @@ openshift ex sync\-groups \- Sync OpenShift groups with records from an external Sync OpenShift Groups with records from an external provider. .PP -In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish -to sync and where their records live. For instance, all or some groups may be selected from the current Groups -stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those -stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is -requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run -without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the -LDAP query templates. +In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish to sync and where their records live. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the LDAP query templates. .SH OPTIONS diff --git a/docs/man/man1/openshift-infra-deploy.1 b/docs/man/man1/openshift-infra-deploy.1 index 737184e6b883..4180d6e837af 100644 --- a/docs/man/man1/openshift-infra-deploy.1 +++ b/docs/man/man1/openshift-infra-deploy.1 @@ -16,9 +16,7 @@ openshift infra deploy \- Run the deployer Perform a deployment .PP -This command launches a deployment as described by a deployment configuration. It accepts the name -of a replication controller created by a deployment and runs that deployment to completion. You can -use the \-\-until flag to run the deployment until you reach the specified condition. +This command launches a deployment as described by a deployment configuration. It accepts the name of a replication controller created by a deployment and runs that deployment to completion. You can use the \-\-until flag to run the deployment until you reach the specified condition. .PP Available conditions: @@ -26,27 +24,35 @@ Available conditions: .IP \(bu "start": after old deployments are scaled to zero +.br .IP \(bu "pre": after the pre hook completes (even if no hook specified) +.br .IP \(bu "mid": after the mid hook completes (even if no hook specified) +.br .IP \(bu A percentage of the deployment, based on which strategy is in use +.br .IP .IP \(bu "0%" Recreate after the previous deployment is scaled to zero +.br .IP \(bu "N%" Recreate after the acceptance check if this is not the first deployment +.br .IP \(bu "0%" Rolling before the rolling deployment is started, equivalent to "pre" +.br .IP \(bu "N%" Rolling the percentage of pods in the target deployment that are ready +.br .IP \(bu "100%" All after the deployment is at full scale, but before the post hook runs +.br .PP -Unrecognized conditions will be ignored and the deployment will run to completion. You can run this -command multiple times when \-\-until is specified \- hooks will only be executed once. +Unrecognized conditions will be ignored and the deployment will run to completion. You can run this command multiple times when \-\-until is specified \- hooks will only be executed once. .SH OPTIONS diff --git a/docs/man/man1/openshift-infra-docker-build.1 b/docs/man/man1/openshift-infra-docker-build.1 index c630e0c18aaa..b98012f493fd 100644 --- a/docs/man/man1/openshift-infra-docker-build.1 +++ b/docs/man/man1/openshift-infra-docker-build.1 @@ -16,8 +16,7 @@ openshift infra docker\-build \- Run a Docker build Perform a Docker build .PP -This command executes a Docker build using arguments passed via the environment. -It expects to be run inside of a container. +This command executes a Docker build using arguments passed via the environment. It expects to be run inside of a container. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-infra-f5-router.1 b/docs/man/man1/openshift-infra-f5-router.1 index d7151dc734ca..b57f81960990 100644 --- a/docs/man/man1/openshift-infra-f5-router.1 +++ b/docs/man/man1/openshift-infra-f5-router.1 @@ -19,10 +19,7 @@ Start an F5 route synchronizer This command launches a process that will synchronize an F5 to the route configuration of your master. .PP -You may restrict the set of routes exposed to a single project (with \-\-namespace), projects your client has -access to with a set of labels (\-\-project\-labels), namespaces matching a label (\-\-namespace\-labels), or all -namespaces (no argument). You can limit the routes to those matching a \-\-labels or \-\-fields selector. Note -that you must have a cluster\-wide administrative role to view all namespaces. +You may restrict the set of routes exposed to a single project (with \-\-namespace), projects your client has access to with a set of labels (\-\-project\-labels), namespaces matching a label (\-\-namespace\-labels), or all namespaces (no argument). You can limit the routes to those matching a \-\-labels or \-\-fields selector. Note that you must have a cluster\-wide administrative role to view all namespaces. .SH OPTIONS diff --git a/docs/man/man1/openshift-infra-router.1 b/docs/man/man1/openshift-infra-router.1 index 703f72c29526..d8aa6915f68e 100644 --- a/docs/man/man1/openshift-infra-router.1 +++ b/docs/man/man1/openshift-infra-router.1 @@ -16,21 +16,16 @@ openshift infra router \- Start a router Start a router .PP -This command launches a router connected to your cluster master. The router listens for routes and endpoints -created by users and keeps a local router configuration up to date with those changes. +This command launches a router connected to your cluster master. The router listens for routes and endpoints created by users and keeps a local router configuration up to date with those changes. .PP You may customize the router by providing your own \-\-template and \-\-reload scripts. .PP -The router must have a default certificate in pem format. You may provide it via \-\-default\-cert otherwise -one is automatically created. +The router must have a default certificate in pem format. You may provide it via \-\-default\-cert otherwise one is automatically created. .PP -You may restrict the set of routes exposed to a single project (with \-\-namespace), projects your client has -access to with a set of labels (\-\-project\-labels), namespaces matching a label (\-\-namespace\-labels), or all -namespaces (no argument). You can limit the routes to those matching a \-\-labels or \-\-fields selector. Note -that you must have a cluster\-wide administrative role to view all namespaces. +You may restrict the set of routes exposed to a single project (with \-\-namespace), projects your client has access to with a set of labels (\-\-project\-labels), namespaces matching a label (\-\-namespace\-labels), or all namespaces (no argument). You can limit the routes to those matching a \-\-labels or \-\-fields selector. Note that you must have a cluster\-wide administrative role to view all namespaces. .SH OPTIONS diff --git a/docs/man/man1/openshift-infra-sti-build.1 b/docs/man/man1/openshift-infra-sti-build.1 index 2be6b4f1f41e..98e7ccc12daa 100644 --- a/docs/man/man1/openshift-infra-sti-build.1 +++ b/docs/man/man1/openshift-infra-sti-build.1 @@ -16,8 +16,7 @@ openshift infra sti\-build \- Run a Source\-to\-Image build Perform a Source\-to\-Image build .PP -This command executes a Source\-to\-Image build using arguments passed via the environment. -It expects to be run inside of a container. +This command executes a Source\-to\-Image build using arguments passed via the environment. It expects to be run inside of a container. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift.1 b/docs/man/man1/openshift.1 index 5d3d1919e901..4255041d1858 100644 --- a/docs/man/man1/openshift.1 +++ b/docs/man/man1/openshift.1 @@ -16,11 +16,10 @@ openshift \- Build, deploy, and manage your cloud applications OpenShift Application Platform .PP -The OpenShift distribution of Kubernetes helps you build, deploy, and manage your applications on top of -Docker containers. To start an all\-in\-one server with the default configuration, run: +The OpenShift distribution of Kubernetes helps you build, deploy, and manage your applications on top of Docker containers. To start an all\-in\-one server with the default configuration, run: .PP -openshift start \& +$ openshift start \& .SH OPTIONS diff --git a/pkg/cmd/cli/cli.go b/pkg/cmd/cli/cli.go index e06de68689c7..efe81b793bb6 100644 --- a/pkg/cmd/cli/cli.go +++ b/pkg/cmd/cli/cli.go @@ -205,20 +205,9 @@ func NewCommandCLI(name, fullName string, in io.Reader, out, errout io.Writer) * } cmds.AddCommand(cmd.NewCmdOptions(out)) - setOutput(cmds, out) - return cmds } -func setOutput(cmd *cobra.Command, out io.Writer) { - if cmd.HasSubCommands() { - for _, subCmd := range cmd.Commands() { - setOutput(subCmd, out) - } - } - cmd.SetOutput(out) -} - func moved(fullName, to string, parent, cmd *cobra.Command) string { cmd.Long = fmt.Sprintf("DEPRECATED: This command has been moved to \"%s %s\"", fullName, to) cmd.Short = fmt.Sprintf("DEPRECATED: %s", to) diff --git a/pkg/cmd/templates/markdown.go b/pkg/cmd/templates/markdown.go index b97a722a4698..6b666ab1b910 100644 --- a/pkg/cmd/templates/markdown.go +++ b/pkg/cmd/templates/markdown.go @@ -8,7 +8,7 @@ import ( "github.com/russross/blackfriday" ) -const indentation = " " +const indentation = ` ` type ASCIIRenderer struct { listItemCount uint