Skip to content

Commit

Permalink
Update generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fabianofranz committed Sep 19, 2016
1 parent febf353 commit f5f1c6e
Show file tree
Hide file tree
Showing 249 changed files with 626 additions and 1,558 deletions.
4 changes: 1 addition & 3 deletions docs/man/man1/oadm-build-chain.1
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ oadm build\-chain \- Output the inputs and dependencies of your builds
Output the inputs and dependencies of your builds

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


.SH OPTIONS
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/oadm-ca-decrypt.1
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/oadm-ca-encrypt.1
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

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


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

.PP
The client stores configuration in the current user's home directory (under the .kube directory as
config). When you login the first time, a new config file is created, and subsequent project changes with the
'project' command will set the current context. These subcommands allow you to manage the config directly.
The client stores configuration in the current user's home directory (under the .kube directory 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:
Expand Down
8 changes: 1 addition & 7 deletions docs/man/man1/oadm-groups-prune.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 1 addition & 7 deletions docs/man/man1/oadm-groups-sync.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 2 additions & 9 deletions docs/man/man1/oadm-ipfailover.1
Original file line number Diff line number Diff line change
Expand Up @@ -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=<n>
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= <n> value that matches the number of nodes for the given labeled selector.


.SH OPTIONS
Expand Down
31 changes: 15 additions & 16 deletions docs/man/man1/oadm-manage-node.1
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 <mynode> \-\-schedulable=false
# Block accepting any pods on given nodes
oadm manage\-node <mynode> \-\-schedulable=false

# Mark selected nodes as schedulable
oadm manage\-node \-\-selector="<env=dev>" \-\-schedulable=true
# Mark selected nodes as schedulable
oadm manage\-node \-\-selector="<env=dev>" \-\-schedulable=true

# Migrate selected pods
oadm manage\-node <mynode> \-\-evacuate \-\-pod\-selector="<service=myapp>"
# Migrate selected pods
oadm manage\-node <mynode> \-\-evacuate \-\-pod\-selector="<service=myapp>"

# Migrate selected pods, use a grace period of 60 seconds
oadm manage\-node <mynode> \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="<service=myapp>"
# Migrate selected pods, use a grace period of 60 seconds
oadm manage\-node <mynode> \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="<service=myapp>"

# Migrate selected pods not backed by replication controller
oadm manage\-node <mynode> \-\-evacuate \-\-force \-\-pod\-selector="<service=myapp>"
# Migrate selected pods not backed by replication controller
oadm manage\-node <mynode> \-\-evacuate \-\-force \-\-pod\-selector="<service=myapp>"

# Show pods that will be migrated
oadm manage\-node <mynode> \-\-evacuate \-\-dry\-run \-\-pod\-selector="<service=myapp>"
# Show pods that will be migrated
oadm manage\-node <mynode> \-\-evacuate \-\-dry\-run \-\-pod\-selector="<service=myapp>"

# List all pods on given nodes
oadm manage\-node <mynode1> <mynode2> \-\-list\-pods
# List all pods on given nodes
oadm manage\-node <mynode1> <mynode2> \-\-list\-pods

.fi
.RE
Expand Down
38 changes: 24 additions & 14 deletions docs/man/man1/oadm-migrate-image-references.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 4 additions & 13 deletions docs/man/man1/oadm-migrate-storage.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions docs/man/man1/oadm-new-project.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 1 addition & 3 deletions docs/man/man1/oadm-policy-reconcile-cluster-roles.1
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 1 addition & 6 deletions docs/man/man1/oadm-policy-reconcile-sccs.1
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 2 additions & 5 deletions docs/man/man1/oadm-policy.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 1 addition & 7 deletions docs/man/man1/oadm-prune-groups.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions docs/man/man1/oadm-prune.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit f5f1c6e

Please sign in to comment.