Skip to content

Commit e4a663a

Browse files
committed
track updated manpages
1 parent f084cfb commit e4a663a

14 files changed

+195
-220
lines changed

docs/man/man1/oadm-diagnostics.1

+7-10
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,19 @@ you will receive an error if they are not found. For example:
3838
.nf
3939
oadm diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml
4040

41-
If master/node config files are not found and the \-\-host flag is not
42-
4341
.fi
4442
.RE
43+
.IP
4544

46-
.PP
45+
.IP
46+
\(bu If master/node config files are not found and the \-\-host flag is not
4747
present, host diagnostics are skipped.
48-
If the client has cluster\-admin access, this access enables cluster
49-
50-
.PP
48+
.IP
49+
\(bu If the client has cluster\-admin access, this access enables cluster
5150
diagnostics to run which regular users cannot.
52-
If a client config file is not found, client and cluster diagnostics
53-
54-
.PP
51+
.IP
52+
\(bu If a client config file is not found, client and cluster diagnostics
5553
are skipped.
56-
5754
.PP
5855
Diagnostics may be individually run by passing diagnostic name as arguments.
5956
The available diagnostic names are:

docs/man/man1/oc-adm-diagnostics.1

+7-10
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,19 @@ you will receive an error if they are not found. For example:
3838
.nf
3939
oc adm diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml
4040

41-
If master/node config files are not found and the \-\-host flag is not
42-
4341
.fi
4442
.RE
43+
.IP
4544

46-
.PP
45+
.IP
46+
\(bu If master/node config files are not found and the \-\-host flag is not
4747
present, host diagnostics are skipped.
48-
If the client has cluster\-admin access, this access enables cluster
49-
50-
.PP
48+
.IP
49+
\(bu If the client has cluster\-admin access, this access enables cluster
5150
diagnostics to run which regular users cannot.
52-
If a client config file is not found, client and cluster diagnostics
53-
54-
.PP
51+
.IP
52+
\(bu If a client config file is not found, client and cluster diagnostics
5553
are skipped.
56-
5754
.PP
5855
Diagnostics may be individually run by passing diagnostic name as arguments.
5956
The available diagnostic names are:

docs/man/man1/oc-deploy.1

+9-17
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,18 @@ and scaling up new ones. Use 'oc rollback' to rollback to any previous deploymen
2222

2323
.PP
2424
There are several deployment strategies defined:
25+
.IP
2526

26-
.PP
27-
.RS
28-
29-
.nf
30-
Rolling (default) \- scales up the new deployment in stages, gradually reducing the number
31-
32-
.fi
33-
.RE
34-
35-
.PP
27+
.IP
28+
\(bu Rolling (default) \- scales up the new deployment in stages, gradually reducing the number
3629
of old deployments. If one of the new deployed pods never becomes "ready", the new deployment
37-
will be rolled back (scaled down to zero). Use when your application can tolerate two versions
38-
of code running at the same time (many web applications, scalable databases)
39-
Recreate \- scales the old deployment down to zero, then scales the new deployment up to full.
40-
41-
.PP
30+
will be rolled back (scaled down to zero). Use when your application can tolerate two versions
31+
of code running at the same time (many web applications, scalable databases)
32+
.IP
33+
\(bu Recreate \- scales the old deployment down to zero, then scales the new deployment up to full.
4234
Use when your application cannot tolerate two versions of code running at the same time
43-
Custom \- run your own deployment process inside a Docker container using your own scripts.
44-
35+
.IP
36+
\(bu Custom \- run your own deployment process inside a Docker container using your own scripts.
4537
.PP
4638
If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may
4739
never successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment.

docs/man/man1/oc-set-probe.1

+6-3
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,12 @@ Setting both liveness and readiness probes for each container is highly recommen
2828
The three probe types are:
2929
.IP \(bu 2
3030

31-
\item Open a TCP socket on the pod IP
32-
\item Perform an HTTP GET against a URL on a container that must return 200 OK
33-
\item Run a command in the container that must return exit code 0
31+
.IP
32+
\(bu Open a TCP socket on the pod IP
33+
.IP
34+
\(bu Perform an HTTP GET against a URL on a container that must return 200 OK
35+
.IP
36+
\(bu Run a command in the container that must return exit code 0
3437
.PP
3538
Containers that take a variable amount of time to start should set generous
3639
initial\-delay\-seconds values, otherwise as your application evolves you may suddenly begin

docs/man/man1/oc-set-volumes.1

+9-16
Original file line numberDiff line numberDiff line change
@@ -29,30 +29,23 @@ you cannot change a pod's volumes once it has been created.
2929

3030
.PP
3131
Volume types include:
32+
.IP
3233

33-
.PP
34-
.RS
35-
36-
.nf
37-
emptydir (empty directory) *default*
38-
34+
.IP
35+
\(bu emptydir (empty directory) \fIdefault\fP
3936
A directory allocated when the pod is created on a local host, is removed when
4037
the pod is deleted and is not copied across servers
41-
hostdir (host directory)
42-
38+
.IP
39+
\(bu hostdir (host directory)
4340
A directory with specific path on any host (requires elevated privileges)
44-
persistentvolumeclaim or pvc (persistent volume claim)
45-
41+
.IP
42+
\(bu persistentvolumeclaim or pvc (persistent volume claim)
4643
Link the volume directory in the container to a persistent volume claim you have
4744
allocated by name \- a persistent volume claim is a request to allocate storage.
4845
Note that if your claim hasn't been bound, your pods will not start.
49-
secret (mounted secret)
50-
46+
.IP
47+
\(bu secret (mounted secret)
5148
Secret volumes mount a named secret to the provided directory.
52-
53-
.fi
54-
.RE
55-
5649
.PP
5750
For descriptions on other volume types, see
5851
\[la]https://docs.openshift.com\[ra]

docs/man/man1/oc-types.1

+45-36
Original file line numberDiff line numberDiff line change
@@ -23,135 +23,144 @@ Services, Deployments, and Builds for delivering changes.
2323

2424
.PP
2525
Concepts:
26+
.IP
2627

28+
.IP
29+
\(bu
2730
.PP
28-
.RS
29-
30-
.nf
3131
Containers:
32-
3332
A definition of how to run one or more processes inside of a portable Linux
3433
environment. Containers are started from an Image and are usually isolated
3534
from other containers on the same machine.
36-
35+
.IP
36+
\(bu
37+
.PP
3738
Image:
38-
3939
A layered Linux filesystem that contains application code, dependencies,
4040
and any supporting operating system libraries. An image is identified by
4141
a name that can be local to the current cluster or point to a remote Docker
4242
registry (a storage server for images).
43-
43+
.IP
44+
\(bu
45+
.PP
4446
Pods [pod]:
45-
4647
A set of one or more containers that are deployed onto a Node together and
4748
share a unique IP and Volumes (persistent storage). Pods also define the
4849
security and runtime policy for each container.
49-
50+
.IP
51+
\(bu
52+
.PP
5053
Labels:
51-
5254
Labels are key value pairs that can be assigned to any resource in the
5355
system for grouping and selection. Many resources use labels to identify
5456
sets of other resources.
55-
57+
.IP
58+
\(bu
59+
.PP
5660
Volumes:
57-
5861
Containers are not persistent by default \- on restart their contents are
5962
cleared. Volumes are mounted filesystems available to Pods and their
6063
containers which may be backed by a number of host\-local or network
6164
attached storage endpoints. The simplest volume type is EmptyDir, which
6265
is a temporary directory on a single machine. Administrators may also
6366
allow you to request a Persistent Volume that is automatically attached
6467
to your pods.
65-
68+
.IP
69+
\(bu
70+
.PP
6671
Nodes [node]:
67-
6872
Machines set up in the cluster to run containers. Usually managed
6973
by administrators and not by end users.
70-
74+
.IP
75+
\(bu
76+
.PP
7177
Services [svc]:
72-
7378
A name representing a set of pods (or external servers) that are
7479
accessed by other pods. The service gets an IP and a DNS name, and can be
7580
exposed externally to the cluster via a port or a Route. It's also easy
7681
to consume services from pods because an environment variable with the
7782
name <SERVICE>\_HOST is automatically injected into other pods.
78-
83+
.IP
84+
\(bu
85+
.PP
7986
Routes [route]:
80-
8187
A route is an external DNS entry (either a top level domain or a
8288
dynamically allocated name) that is created to point to a service so that
8389
it can be accessed outside the cluster. The administrator may configure
8490
one or more Routers to handle those routes, typically through an Apache
8591
or HAProxy load balancer / proxy.
86-
92+
.IP
93+
\(bu
94+
.PP
8795
Replication Controllers [rc]:
88-
8996
A replication controller maintains a specific number of pods based on a
9097
template that match a set of labels. If pods are deleted (because the
9198
node they run on is taken out of service) the controller creates a new
9299
copy of that pod. A replication controller is most commonly used to
93100
represent a single deployment of part of an application based on a
94101
built image.
95-
102+
.IP
103+
\(bu
104+
.PP
96105
Deployment Configuration [dc]:
97-
98106
Defines the template for a pod and manages deploying new images or
99107
configuration changes whenever those change. A single deployment
100108
configuration is usually analogous to a single micro\-service. Can support
101109
many different deployment patterns, including full restart, customizable
102110
rolling updates, and fully custom behaviors, as well as pre\- and post\-
103111
hooks. Each deployment is represented as a replication controller.
104-
112+
.IP
113+
\(bu
114+
.PP
105115
Build Configuration [bc]:
106-
107116
Contains a description of how to build source code and a base image into a
108117
new image \- the primary method for delivering changes to your application.
109118
Builds can be source based and use builder images for common languages like
110119
Java, PHP, Ruby, or Python, or be Docker based and create builds from a
111120
Dockerfile. Each build configuration has web\-hooks and can be triggered
112121
automatically by changes to their base images.
113-
122+
.IP
123+
\(bu
124+
.PP
114125
Builds [build]:
115-
116126
Builds create a new image from source code, other images, Dockerfiles, or
117127
binary input. A build is run inside of a container and has the same
118128
restrictions normal pods have. A build usually results in an image pushed
119129
to a Docker registry, but you can also choose to run a post\-build test that
120130
does not push an image.
121-
131+
.IP
132+
\(bu
133+
.PP
122134
Image Streams and Image Stream Tags [is,istag]:
123-
124135
An image stream groups sets of related images under tags \- analogous to a
125136
branch in a source code repository. Each image stream may have one or
126137
more tags (the default tag is called "latest") and those tags may point
127138
at external Docker registries, at other tags in the same stream, or be
128139
controlled to directly point at known images. In addition, images can be
129140
pushed to an image stream tag directly via the integrated Docker
130141
registry.
131-
142+
.IP
143+
\(bu
144+
.PP
132145
Secrets [secret]:
133-
134146
The secret resource can hold text or binary secrets for delivery into
135147
your pods. By default, every container is given a single secret which
136148
contains a token for accessing the API (with limited privileges) at
137149
/var/run/secrets/kubernetes.io/serviceaccount. You can create new
138150
secrets and mount them in your own pods, as well as reference secrets
139151
from builds (for connecting to remote servers) or use them to import
140152
remote images into an image stream.
141-
153+
.IP
154+
\(bu
155+
.PP
142156
Projects [project]:
143-
144157
All of the above resources (except Nodes) exist inside of a project.
145158
Projects have a list of members and their roles, like viewer, editor,
146159
or admin, as well as a set of security controls on the running pods, and
147160
limits on how many resources the project can use. The names of each
148161
resource are unique within a project. Developers may request projects
149162
be created, but administrators control the resources allocated to
150163
projects.
151-
152-
.fi
153-
.RE
154-
155164
.PP
156165
For more, see
157166
\[la]https://docs.openshift.com\[ra]

docs/man/man1/openshift-admin-diagnostics.1

+7-10
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,19 @@ you will receive an error if they are not found. For example:
3838
.nf
3939
openshift admin diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml
4040

41-
If master/node config files are not found and the \-\-host flag is not
42-
4341
.fi
4442
.RE
43+
.IP
4544

46-
.PP
45+
.IP
46+
\(bu If master/node config files are not found and the \-\-host flag is not
4747
present, host diagnostics are skipped.
48-
If the client has cluster\-admin access, this access enables cluster
49-
50-
.PP
48+
.IP
49+
\(bu If the client has cluster\-admin access, this access enables cluster
5150
diagnostics to run which regular users cannot.
52-
If a client config file is not found, client and cluster diagnostics
53-
54-
.PP
51+
.IP
52+
\(bu If a client config file is not found, client and cluster diagnostics
5553
are skipped.
56-
5754
.PP
5855
Diagnostics may be individually run by passing diagnostic name as arguments.
5956
The available diagnostic names are:

docs/man/man1/openshift-cli-adm-diagnostics.1

+7-10
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,19 @@ you will receive an error if they are not found. For example:
3838
.nf
3939
openshift cli adm diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml
4040

41-
If master/node config files are not found and the \-\-host flag is not
42-
4341
.fi
4442
.RE
43+
.IP
4544

46-
.PP
45+
.IP
46+
\(bu If master/node config files are not found and the \-\-host flag is not
4747
present, host diagnostics are skipped.
48-
If the client has cluster\-admin access, this access enables cluster
49-
50-
.PP
48+
.IP
49+
\(bu If the client has cluster\-admin access, this access enables cluster
5150
diagnostics to run which regular users cannot.
52-
If a client config file is not found, client and cluster diagnostics
53-
54-
.PP
51+
.IP
52+
\(bu If a client config file is not found, client and cluster diagnostics
5553
are skipped.
56-
5754
.PP
5855
Diagnostics may be individually run by passing diagnostic name as arguments.
5956
The available diagnostic names are:

0 commit comments

Comments
 (0)