Skip to content

Commit 4466ada

Browse files
committed
Check out generated docs
1 parent f5d535b commit 4466ada

File tree

783 files changed

+2349
-127987
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

783 files changed

+2349
-127987
lines changed

docs/generated/oadm_by_example_content.adoc

+3-849
Large diffs are not rendered by default.

docs/generated/oc_by_example_content.adoc

+3-3,103
Large diffs are not rendered by default.

docs/man/man1/oadm-build-chain.1

+3-139
Original file line numberDiff line numberDiff line change
@@ -1,139 +1,3 @@
1-
.TH "OADM" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" ""
2-
3-
4-
.SH NAME
5-
.PP
6-
oadm build\-chain \- Output the inputs and dependencies of your builds
7-
8-
9-
.SH SYNOPSIS
10-
.PP
11-
\fBoadm build\-chain\fP [OPTIONS]
12-
13-
14-
.SH DESCRIPTION
15-
.PP
16-
Output the inputs and dependencies of your builds
17-
18-
.PP
19-
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.
20-
21-
22-
.SH OPTIONS
23-
.PP
24-
\fB\-\-all\fP=false
25-
If true, build dependency tree for the specified image stream tag across all namespaces
26-
27-
.PP
28-
\fB\-o\fP, \fB\-\-output\fP=""
29-
Output format of dependency tree
30-
31-
.PP
32-
\fB\-\-reverse\fP=false
33-
If true, show the istags dependencies instead of its dependants.
34-
35-
.PP
36-
\fB\-\-trigger\-only\fP=true
37-
If true, only include dependencies based on build triggers. If false, include all dependencies.
38-
39-
40-
.SH OPTIONS INHERITED FROM PARENT COMMANDS
41-
.PP
42-
\fB\-\-api\-version\fP=""
43-
DEPRECATED: The API version to use when talking to the server
44-
45-
.PP
46-
\fB\-\-as\fP=""
47-
Username to impersonate for the operation
48-
49-
.PP
50-
\fB\-\-azure\-container\-registry\-config\fP=""
51-
Path to the file container Azure container registry configuration information.
52-
53-
.PP
54-
\fB\-\-certificate\-authority\fP=""
55-
Path to a cert. file for the certificate authority
56-
57-
.PP
58-
\fB\-\-client\-certificate\fP=""
59-
Path to a client certificate file for TLS
60-
61-
.PP
62-
\fB\-\-client\-key\fP=""
63-
Path to a client key file for TLS
64-
65-
.PP
66-
\fB\-\-cluster\fP=""
67-
The name of the kubeconfig cluster to use
68-
69-
.PP
70-
\fB\-\-config\fP=""
71-
Path to the config file to use for CLI requests.
72-
73-
.PP
74-
\fB\-\-context\fP=""
75-
The name of the kubeconfig context to use
76-
77-
.PP
78-
\fB\-\-google\-json\-key\fP=""
79-
The Google Cloud Platform Service Account JSON Key to use for authentication.
80-
81-
.PP
82-
\fB\-\-insecure\-skip\-tls\-verify\fP=false
83-
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
84-
85-
.PP
86-
\fB\-\-log\-flush\-frequency\fP=0
87-
Maximum number of seconds between log flushes
88-
89-
.PP
90-
\fB\-\-match\-server\-version\fP=false
91-
Require server version to match client version
92-
93-
.PP
94-
\fB\-n\fP, \fB\-\-namespace\fP=""
95-
If present, the namespace scope for this CLI request
96-
97-
.PP
98-
\fB\-\-request\-timeout\fP="0"
99-
The length of time to wait before giving up on a single server request. Non\-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.
100-
101-
.PP
102-
\fB\-\-server\fP=""
103-
The address and port of the Kubernetes API server
104-
105-
.PP
106-
\fB\-\-token\fP=""
107-
Bearer token for authentication to the API server
108-
109-
.PP
110-
\fB\-\-user\fP=""
111-
The name of the kubeconfig user to use
112-
113-
114-
.SH EXAMPLE
115-
.PP
116-
.RS
117-
118-
.nf
119-
# Build the dependency tree for the 'latest' tag in <image\-stream>
120-
oadm build\-chain <image\-stream>
121-
122-
# Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility
123-
oadm build\-chain <image\-stream>:v2 \-o dot | dot \-T svg \-o deps.svg
124-
125-
# Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace
126-
oadm build\-chain <image\-stream> \-n test \-\-all
127-
128-
.fi
129-
.RE
130-
131-
132-
.SH SEE ALSO
133-
.PP
134-
\fBoadm(1)\fP,
135-
136-
137-
.SH HISTORY
138-
.PP
139-
June 2016, Ported from the Kubernetes man\-doc generator
1+
This file is autogenerated, but we've stopped checking such files into the
2+
repository to reduce the need for rebases. Please run hack/generate-docs.sh to
3+
populate this file.
+3-121
Original file line numberDiff line numberDiff line change
@@ -1,121 +1,3 @@
1-
.TH "OADM CA" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" ""
2-
3-
4-
.SH NAME
5-
.PP
6-
oadm ca create\-key\-pair \- Create a public/private key pair
7-
8-
9-
.SH SYNOPSIS
10-
.PP
11-
\fBoadm ca create\-key\-pair\fP [OPTIONS]
12-
13-
14-
.SH DESCRIPTION
15-
.PP
16-
Create an RSA key pair and generate PEM\-encoded public/private key files
17-
18-
.PP
19-
Example: Creating service account signing and authenticating key files:
20-
21-
.PP
22-
CONFIG=openshift.local.config/master
23-
oadm ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key
24-
25-
26-
.SH OPTIONS
27-
.PP
28-
\fB\-\-overwrite\fP=false
29-
Overwrite existing key files if found. If false, either file existing will prevent creation.
30-
31-
.PP
32-
\fB\-\-private\-key\fP=""
33-
The private key file.
34-
35-
.PP
36-
\fB\-\-public\-key\fP=""
37-
The public key file.
38-
39-
40-
.SH OPTIONS INHERITED FROM PARENT COMMANDS
41-
.PP
42-
\fB\-\-api\-version\fP=""
43-
DEPRECATED: The API version to use when talking to the server
44-
45-
.PP
46-
\fB\-\-as\fP=""
47-
Username to impersonate for the operation
48-
49-
.PP
50-
\fB\-\-azure\-container\-registry\-config\fP=""
51-
Path to the file container Azure container registry configuration information.
52-
53-
.PP
54-
\fB\-\-certificate\-authority\fP=""
55-
Path to a cert. file for the certificate authority
56-
57-
.PP
58-
\fB\-\-client\-certificate\fP=""
59-
Path to a client certificate file for TLS
60-
61-
.PP
62-
\fB\-\-client\-key\fP=""
63-
Path to a client key file for TLS
64-
65-
.PP
66-
\fB\-\-cluster\fP=""
67-
The name of the kubeconfig cluster to use
68-
69-
.PP
70-
\fB\-\-config\fP=""
71-
Path to the config file to use for CLI requests.
72-
73-
.PP
74-
\fB\-\-context\fP=""
75-
The name of the kubeconfig context to use
76-
77-
.PP
78-
\fB\-\-google\-json\-key\fP=""
79-
The Google Cloud Platform Service Account JSON Key to use for authentication.
80-
81-
.PP
82-
\fB\-\-insecure\-skip\-tls\-verify\fP=false
83-
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
84-
85-
.PP
86-
\fB\-\-log\-flush\-frequency\fP=0
87-
Maximum number of seconds between log flushes
88-
89-
.PP
90-
\fB\-\-match\-server\-version\fP=false
91-
Require server version to match client version
92-
93-
.PP
94-
\fB\-n\fP, \fB\-\-namespace\fP=""
95-
If present, the namespace scope for this CLI request
96-
97-
.PP
98-
\fB\-\-request\-timeout\fP="0"
99-
The length of time to wait before giving up on a single server request. Non\-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.
100-
101-
.PP
102-
\fB\-\-server\fP=""
103-
The address and port of the Kubernetes API server
104-
105-
.PP
106-
\fB\-\-token\fP=""
107-
Bearer token for authentication to the API server
108-
109-
.PP
110-
\fB\-\-user\fP=""
111-
The name of the kubeconfig user to use
112-
113-
114-
.SH SEE ALSO
115-
.PP
116-
\fBoadm\-ca(1)\fP,
117-
118-
119-
.SH HISTORY
120-
.PP
121-
June 2016, Ported from the Kubernetes man\-doc generator
1+
This file is autogenerated, but we've stopped checking such files into the
2+
repository to reduce the need for rebases. Please run hack/generate-docs.sh to
3+
populate this file.

0 commit comments

Comments
 (0)