Skip to content

Commit f084cfb

Browse files
committed
update manpage list parsing
1 parent 889defd commit f084cfb

18 files changed

+504
-364
lines changed

docs/man/man1/oadm-diagnostics.1

+10-4
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,22 @@ 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+
4143
.fi
4244
.RE
43-
.IP \n+[step]
4445

45-
\item If master/node config files are not found and the \-\-host flag is not
46+
.PP
4647
present, host diagnostics are skipped.
47-
\item If the client has cluster\-admin access, this access enables cluster
48+
If the client has cluster\-admin access, this access enables cluster
49+
50+
.PP
4851
diagnostics to run which regular users cannot.
49-
\item If a client config file is not found, client and cluster diagnostics
52+
If a client config file is not found, client and cluster diagnostics
53+
54+
.PP
5055
are skipped.
56+
5157
.PP
5258
Diagnostics may be individually run by passing diagnostic name as arguments.
5359
The available diagnostic names are:

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

+10-4
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,22 @@ 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+
4143
.fi
4244
.RE
43-
.IP \n+[step]
4445

45-
\item If master/node config files are not found and the \-\-host flag is not
46+
.PP
4647
present, host diagnostics are skipped.
47-
\item If the client has cluster\-admin access, this access enables cluster
48+
If the client has cluster\-admin access, this access enables cluster
49+
50+
.PP
4851
diagnostics to run which regular users cannot.
49-
\item If a client config file is not found, client and cluster diagnostics
52+
If a client config file is not found, client and cluster diagnostics
53+
54+
.PP
5055
are skipped.
56+
5157
.PP
5258
Diagnostics may be individually run by passing diagnostic name as arguments.
5359
The available diagnostic names are:

docs/man/man1/oc-deploy.1

+17-6
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,26 @@ 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 \n+[step]
2625

27-
\item Rolling (default) \- scales up the new deployment in stages, gradually reducing the number
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
2836
of old deployments. If one of the new deployed pods never becomes "ready", the new deployment
29-
will be rolled back (scaled down to zero). Use when your application can tolerate two versions
30-
of code running at the same time (many web applications, scalable databases)
31-
\item Recreate \- scales the old deployment down to zero, then scales the new deployment up to full.
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
3242
Use when your application cannot tolerate two versions of code running at the same time
33-
\item Custom \- run your own deployment process inside a Docker container using your own scripts.
43+
Custom \- run your own deployment process inside a Docker container using your own scripts.
44+
3445
.PP
3546
If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may
3647
never successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment.

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

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

3030
.PP
3131
Volume types include:
32-
.IP \n+[step]
3332

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

docs/man/man1/oc-types.1

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

2424
.PP
2525
Concepts:
26-
.IP \n+[step]
2726

28-
\item
2927
.PP
28+
.RS
29+
30+
.nf
3031
Containers:
32+
3133
A definition of how to run one or more processes inside of a portable Linux
3234
environment. Containers are started from an Image and are usually isolated
3335
from other containers on the same machine.
34-
\item
35-
.PP
36+
3637
Image:
38+
3739
A layered Linux filesystem that contains application code, dependencies,
3840
and any supporting operating system libraries. An image is identified by
3941
a name that can be local to the current cluster or point to a remote Docker
4042
registry (a storage server for images).
41-
\item
42-
.PP
43+
4344
Pods [pod]:
45+
4446
A set of one or more containers that are deployed onto a Node together and
4547
share a unique IP and Volumes (persistent storage). Pods also define the
4648
security and runtime policy for each container.
47-
\item
48-
.PP
49+
4950
Labels:
51+
5052
Labels are key value pairs that can be assigned to any resource in the
5153
system for grouping and selection. Many resources use labels to identify
5254
sets of other resources.
53-
\item
54-
.PP
55+
5556
Volumes:
57+
5658
Containers are not persistent by default \- on restart their contents are
5759
cleared. Volumes are mounted filesystems available to Pods and their
5860
containers which may be backed by a number of host\-local or network
5961
attached storage endpoints. The simplest volume type is EmptyDir, which
6062
is a temporary directory on a single machine. Administrators may also
6163
allow you to request a Persistent Volume that is automatically attached
6264
to your pods.
63-
\item
64-
.PP
65+
6566
Nodes [node]:
67+
6668
Machines set up in the cluster to run containers. Usually managed
6769
by administrators and not by end users.
68-
\item
69-
.PP
70+
7071
Services [svc]:
72+
7173
A name representing a set of pods (or external servers) that are
7274
accessed by other pods. The service gets an IP and a DNS name, and can be
7375
exposed externally to the cluster via a port or a Route. It's also easy
7476
to consume services from pods because an environment variable with the
7577
name <SERVICE>\_HOST is automatically injected into other pods.
76-
\item
77-
.PP
78+
7879
Routes [route]:
80+
7981
A route is an external DNS entry (either a top level domain or a
8082
dynamically allocated name) that is created to point to a service so that
8183
it can be accessed outside the cluster. The administrator may configure
8284
one or more Routers to handle those routes, typically through an Apache
8385
or HAProxy load balancer / proxy.
84-
\item
85-
.PP
86+
8687
Replication Controllers [rc]:
88+
8789
A replication controller maintains a specific number of pods based on a
8890
template that match a set of labels. If pods are deleted (because the
8991
node they run on is taken out of service) the controller creates a new
9092
copy of that pod. A replication controller is most commonly used to
9193
represent a single deployment of part of an application based on a
9294
built image.
93-
\item
94-
.PP
95+
9596
Deployment Configuration [dc]:
97+
9698
Defines the template for a pod and manages deploying new images or
9799
configuration changes whenever those change. A single deployment
98100
configuration is usually analogous to a single micro\-service. Can support
99101
many different deployment patterns, including full restart, customizable
100102
rolling updates, and fully custom behaviors, as well as pre\- and post\-
101103
hooks. Each deployment is represented as a replication controller.
102-
\item
103-
.PP
104+
104105
Build Configuration [bc]:
106+
105107
Contains a description of how to build source code and a base image into a
106108
new image \- the primary method for delivering changes to your application.
107109
Builds can be source based and use builder images for common languages like
108110
Java, PHP, Ruby, or Python, or be Docker based and create builds from a
109111
Dockerfile. Each build configuration has web\-hooks and can be triggered
110112
automatically by changes to their base images.
111-
\item
112-
.PP
113+
113114
Builds [build]:
115+
114116
Builds create a new image from source code, other images, Dockerfiles, or
115117
binary input. A build is run inside of a container and has the same
116118
restrictions normal pods have. A build usually results in an image pushed
117119
to a Docker registry, but you can also choose to run a post\-build test that
118120
does not push an image.
119-
\item
120-
.PP
121+
121122
Image Streams and Image Stream Tags [is,istag]:
123+
122124
An image stream groups sets of related images under tags \- analogous to a
123125
branch in a source code repository. Each image stream may have one or
124126
more tags (the default tag is called "latest") and those tags may point
125127
at external Docker registries, at other tags in the same stream, or be
126128
controlled to directly point at known images. In addition, images can be
127129
pushed to an image stream tag directly via the integrated Docker
128130
registry.
129-
\item
130-
.PP
131+
131132
Secrets [secret]:
133+
132134
The secret resource can hold text or binary secrets for delivery into
133135
your pods. By default, every container is given a single secret which
134136
contains a token for accessing the API (with limited privileges) at
135137
/var/run/secrets/kubernetes.io/serviceaccount. You can create new
136138
secrets and mount them in your own pods, as well as reference secrets
137139
from builds (for connecting to remote servers) or use them to import
138140
remote images into an image stream.
139-
\item
140-
.PP
141+
141142
Projects [project]:
143+
142144
All of the above resources (except Nodes) exist inside of a project.
143145
Projects have a list of members and their roles, like viewer, editor,
144146
or admin, as well as a set of security controls on the running pods, and
145147
limits on how many resources the project can use. The names of each
146148
resource are unique within a project. Developers may request projects
147149
be created, but administrators control the resources allocated to
148150
projects.
151+
152+
.fi
153+
.RE
154+
149155
.PP
150156
For more, see
151157
\[la]https://docs.openshift.com\[ra]

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

+10-4
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,22 @@ 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+
4143
.fi
4244
.RE
43-
.IP \n+[step]
4445

45-
\item If master/node config files are not found and the \-\-host flag is not
46+
.PP
4647
present, host diagnostics are skipped.
47-
\item If the client has cluster\-admin access, this access enables cluster
48+
If the client has cluster\-admin access, this access enables cluster
49+
50+
.PP
4851
diagnostics to run which regular users cannot.
49-
\item If a client config file is not found, client and cluster diagnostics
52+
If a client config file is not found, client and cluster diagnostics
53+
54+
.PP
5055
are skipped.
56+
5157
.PP
5258
Diagnostics may be individually run by passing diagnostic name as arguments.
5359
The available diagnostic names are:

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

+10-4
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,22 @@ 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+
4143
.fi
4244
.RE
43-
.IP \n+[step]
4445

45-
\item If master/node config files are not found and the \-\-host flag is not
46+
.PP
4647
present, host diagnostics are skipped.
47-
\item If the client has cluster\-admin access, this access enables cluster
48+
If the client has cluster\-admin access, this access enables cluster
49+
50+
.PP
4851
diagnostics to run which regular users cannot.
49-
\item If a client config file is not found, client and cluster diagnostics
52+
If a client config file is not found, client and cluster diagnostics
53+
54+
.PP
5055
are skipped.
56+
5157
.PP
5258
Diagnostics may be individually run by passing diagnostic name as arguments.
5359
The available diagnostic names are:

docs/man/man1/openshift-cli-deploy.1

+17-6
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,26 @@ and scaling up new ones. Use 'openshift cli rollback' to rollback to any previou
2222

2323
.PP
2424
There are several deployment strategies defined:
25-
.IP \n+[step]
2625

27-
\item Rolling (default) \- scales up the new deployment in stages, gradually reducing the number
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
2836
of old deployments. If one of the new deployed pods never becomes "ready", the new deployment
29-
will be rolled back (scaled down to zero). Use when your application can tolerate two versions
30-
of code running at the same time (many web applications, scalable databases)
31-
\item Recreate \- scales the old deployment down to zero, then scales the new deployment up to full.
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
3242
Use when your application cannot tolerate two versions of code running at the same time
33-
\item Custom \- run your own deployment process inside a Docker container using your own scripts.
43+
Custom \- run your own deployment process inside a Docker container using your own scripts.
44+
3445
.PP
3546
If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may
3647
never successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment.

0 commit comments

Comments
 (0)