ceph/man/ceph-post-file.8
Sage Weil d08e05e463 ceph-post-file: single command to upload a file to cephdrop
Use sftp to upload to a directory that only this user and ceph devs can
access.

Distribute an ssh key to connect to the account.  This will let us revoke
the key in the future if we feel the need.  Also distribute a known_hosts
file so that users have some confidence that they are connecting to the
real ceph drop account and not some third party.

Signed-off-by: Sage Weil <sage@inktank.com>
Reviewed-by: Dan Mick <dan.mick@inktank.com>
2013-08-16 17:59:11 -07:00

131 lines
3.3 KiB
Groff

.\" Man page generated from reStructuredText.
.
.TH "CEPH-POST-FILE" "8" "August 14, 2013" "dev" "Ceph"
.SH NAME
ceph-post-file \- post files for ceph developers
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBceph\-post\-file\fP [\-d \fIdescription] [\-u *user\fP] \fIfile or dir\fP ...
.fi
.sp
.SH DESCRIPTION
.sp
\fBceph\-post\-file\fP will upload files or directories to ceph.com for
later analysis by Ceph developers.
.sp
Each invocation uploads files or directories to a separate directory
with a unique tag. That tag can be passed to a developer or
referenced in a bug report (\fI\%http://tracker.ceph.com/\fP). Once the
upload completes, the directory is marked non\-readable and
non\-writeable to prevent access or modification by other users.
.SH WARNING
.sp
Basic measures are taken to make posted data be visible only to
developers with access to ceph.com infrastructure. However, users
should think twice and/or take appropriate precautions before
posting potentially sensitive data (for example, logs or data
directories that contain Ceph secrets).
.SH OPTIONS
.INDENT 0.0
.TP
.B \-d *description*, \-\-description *description*
Add a short description for the upload. This is a good opportunity
to reference a bug number. There is no default value.
.UNINDENT
.INDENT 0.0
.TP
.B \-u *user*
Set the user metadata for the upload. This defaults to \fIwhoami\(ga@\(gahostname \-f\fP\&.
.UNINDENT
.SH EXAMPLES
.sp
To upload a single log:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ceph\-post\-file /var/log/ceph/ceph\-mon.\(gahostname\(ga.log
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To upload several directories:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ceph\-post\-file \-d \(aqmon data directories\(aq /var/log/ceph/mon/*
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-post\-file\fP is part of the Ceph distributed file system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
\fBceph\-debugpack\fP(8),
.SH COPYRIGHT
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.