Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cherry pick into 1.5 of "Stop generating manuals by default" #13078

Merged
merged 4 commits into from
Feb 24, 2017
Merged

Cherry pick into 1.5 of "Stop generating manuals by default" #13078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f5d535b
Stop checking in generated docs
0xmichalis Jan 31, 2017
4466ada
Check out generated docs
0xmichalis Feb 23, 2017
c835705
Remove redundant docs
0xmichalis Jan 31, 2017
26d47cf
tito: generate man pages
0xmichalis Feb 7, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
852 changes: 3 additions & 849 deletions docs/generated/oadm_by_example_content.adoc
View file
Open in desktop

Large diffs are not rendered by default.

3,106 changes: 3 additions & 3,103 deletions docs/generated/oc_by_example_content.adoc
View file
Open in desktop

Large diffs are not rendered by default.

142 changes: 3 additions & 139 deletions docs/man/man1/oadm-build-chain.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,139 +1,3 @@
.TH "OADM" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" ""


.SH NAME
.PP
oadm build\-chain \- Output the inputs and dependencies of your builds


.SH SYNOPSIS
.PP
\fBoadm build\-chain\fP [OPTIONS]


.SH DESCRIPTION
.PP
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.


.SH OPTIONS
.PP
\fB\-\-all\fP=false
If true, build dependency tree for the specified image stream tag across all namespaces

.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format of dependency tree

.PP
\fB\-\-reverse\fP=false
If true, show the istags dependencies instead of its dependants.

.PP
\fB\-\-trigger\-only\fP=true
If true, only include dependencies based on build triggers. If false, include all dependencies.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-api\-version\fP=""
DEPRECATED: The API version to use when talking to the server

.PP
\fB\-\-as\fP=""
Username to impersonate for the operation

.PP
\fB\-\-azure\-container\-registry\-config\fP=""
Path to the file container Azure container registry configuration information.

.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority

.PP
\fB\-\-client\-certificate\fP=""
Path to a client certificate file for TLS

.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS

.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use

.PP
\fB\-\-config\fP=""
Path to the config file to use for CLI requests.

.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use

.PP
\fB\-\-google\-json\-key\fP=""
The Google Cloud Platform Service Account JSON Key to use for authentication.

.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

.PP
\fB\-\-log\-flush\-frequency\fP=0
Maximum number of seconds between log flushes

.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version

.PP
\fB\-n\fP, \fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request

.PP
\fB\-\-request\-timeout\fP="0"
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.

.PP
\fB\-\-server\fP=""
The address and port of the Kubernetes API server

.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server

.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use


.SH EXAMPLE
.PP
.RS

.nf
# Build the dependency tree for the 'latest' tag in <image\-stream>
oadm build\-chain <image\-stream>

# Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility
oadm build\-chain <image\-stream>:v2 \-o dot | dot \-T svg \-o deps.svg

# Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace
oadm build\-chain <image\-stream> \-n test \-\-all

.fi
.RE


.SH SEE ALSO
.PP
\fBoadm(1)\fP,


.SH HISTORY
.PP
June 2016, Ported from the Kubernetes man\-doc generator
This file is autogenerated, but we've stopped checking such files into the
repository to reduce the need for rebases. Please run hack/generate-docs.sh to
populate this file.
124 changes: 3 additions & 121 deletions docs/man/man1/oadm-ca-create-key-pair.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,121 +1,3 @@
.TH "OADM CA" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" ""


.SH NAME
.PP
oadm ca create\-key\-pair \- Create a public/private key pair


.SH SYNOPSIS
.PP
\fBoadm ca create\-key\-pair\fP [OPTIONS]


.SH DESCRIPTION
.PP
Create an RSA key pair and generate PEM\-encoded public/private key files

.PP
Example: Creating service account signing and authenticating key files:

.PP
CONFIG=openshift.local.config/master
oadm ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key


.SH OPTIONS
.PP
\fB\-\-overwrite\fP=false
Overwrite existing key files if found. If false, either file existing will prevent creation.

.PP
\fB\-\-private\-key\fP=""
The private key file.

.PP
\fB\-\-public\-key\fP=""
The public key file.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-api\-version\fP=""
DEPRECATED: The API version to use when talking to the server

.PP
\fB\-\-as\fP=""
Username to impersonate for the operation

.PP
\fB\-\-azure\-container\-registry\-config\fP=""
Path to the file container Azure container registry configuration information.

.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority

.PP
\fB\-\-client\-certificate\fP=""
Path to a client certificate file for TLS

.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS

.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use

.PP
\fB\-\-config\fP=""
Path to the config file to use for CLI requests.

.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use

.PP
\fB\-\-google\-json\-key\fP=""
The Google Cloud Platform Service Account JSON Key to use for authentication.

.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

.PP
\fB\-\-log\-flush\-frequency\fP=0
Maximum number of seconds between log flushes

.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version

.PP
\fB\-n\fP, \fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request

.PP
\fB\-\-request\-timeout\fP="0"
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.

.PP
\fB\-\-server\fP=""
The address and port of the Kubernetes API server

.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server

.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use


.SH SEE ALSO
.PP
\fBoadm\-ca(1)\fP,


.SH HISTORY
.PP
June 2016, Ported from the Kubernetes man\-doc generator
This file is autogenerated, but we've stopped checking such files into the
repository to reduce the need for rebases. Please run hack/generate-docs.sh to
populate this file.
Loading