Skip to content

Commit db9d39a

Browse files
committed
track updated manpages
1 parent 908abc6 commit db9d39a

15 files changed

+316
-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:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
.TH "OC CREATE" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" ""
2+
3+
4+
.SH NAME
5+
.PP
6+
oc create clusterresourcequota \- Create cluster resource quota resource.
7+
8+
9+
.SH SYNOPSIS
10+
.PP
11+
\fBoc create clusterresourcequota\fP [OPTIONS]
12+
13+
14+
.SH DESCRIPTION
15+
.PP
16+
Create a cluster resource quota that controls certain resources.
17+
18+
.PP
19+
Cluster resource quota objects defined quota restrictions that span multiple projects based on label selectors.
20+
21+
22+
.SH OPTIONS
23+
.PP
24+
\fB\-\-hard\fP=[]
25+
The resource to constrain: RESOURCE=QUANTITY (pods=10)
26+
27+
.PP
28+
\fB\-o\fP, \fB\-\-output\fP=""
29+
Output mode. Use "\-o name" for shorter output (resource/name).
30+
31+
.PP
32+
\fB\-\-project\-selector\fP=""
33+
The project selector for the cluster resource quota
34+
35+
36+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
37+
.PP
38+
\fB\-\-api\-version\fP=""
39+
DEPRECATED: The API version to use when talking to the server
40+
41+
.PP
42+
\fB\-\-as\fP=""
43+
Username to impersonate for the operation.
44+
45+
.PP
46+
\fB\-\-certificate\-authority\fP=""
47+
Path to a cert. file for the certificate authority.
48+
49+
.PP
50+
\fB\-\-client\-certificate\fP=""
51+
Path to a client certificate file for TLS.
52+
53+
.PP
54+
\fB\-\-client\-key\fP=""
55+
Path to a client key file for TLS.
56+
57+
.PP
58+
\fB\-\-cluster\fP=""
59+
The name of the kubeconfig cluster to use
60+
61+
.PP
62+
\fB\-\-config\fP=""
63+
Path to the config file to use for CLI requests.
64+
65+
.PP
66+
\fB\-\-context\fP=""
67+
The name of the kubeconfig context to use
68+
69+
.PP
70+
\fB\-\-google\-json\-key\fP=""
71+
The Google Cloud Platform Service Account JSON Key to use for authentication.
72+
73+
.PP
74+
\fB\-\-insecure\-skip\-tls\-verify\fP=false
75+
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
76+
77+
.PP
78+
\fB\-\-log\-flush\-frequency\fP=0
79+
Maximum number of seconds between log flushes
80+
81+
.PP
82+
\fB\-\-match\-server\-version\fP=false
83+
Require server version to match client version
84+
85+
.PP
86+
\fB\-n\fP, \fB\-\-namespace\fP=""
87+
If present, the namespace scope for this CLI request.
88+
89+
.PP
90+
\fB\-\-server\fP=""
91+
The address and port of the Kubernetes API server
92+
93+
.PP
94+
\fB\-\-token\fP=""
95+
Bearer token for authentication to the API server.
96+
97+
.PP
98+
\fB\-\-user\fP=""
99+
The name of the kubeconfig user to use
100+
101+
102+
.SH EXAMPLE
103+
.PP
104+
.RS
105+
106+
.nf
107+
# Create an cluster resource quota limited to 10 pods
108+
oc create clusterresourcequota limit\-bob \-\-project\-selector=openshift.io/requester=user\-bob \-\-hard=pods=10
109+
110+
.fi
111+
.RE
112+
113+
114+
.SH SEE ALSO
115+
.PP
116+
\fBoc\-create(1)\fP,
117+
118+
119+
.SH HISTORY
120+
.PP
121+
June 2016, Ported from the Kubernetes man\-doc generator

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]

0 commit comments

Comments
 (0)