.\" Automatically generated by Podwrapper::Man 1.24.1 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "nbdkit-S3-plugin 1"
.TH nbdkit-S3-plugin 1 "2021-01-20" "nbdkit-1.24.1" "NBDKIT"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
nbdkit\-S3\-plugin \- open disk images stored in Amazon S3 or Ceph
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& nbdkit S3 [access\-key=...] [secret\-key=...] [session\-token=...]
\&           [endpoint\-url=...]
\&           bucket=BUCKET key=FILENAME
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`nbdkit\-S3\-plugin\*(C'\fR is a plugin for \fBnbdkit\fR\|(1) which lets you open
single files stored in Amazon S3 or Ceph as disk images.
.PP
Currently it only allows read access, although write access may be
added in future.
.PP
This plugin uses the Python Amazon Web Services \s-1SDK\s0 called Boto3.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 2
\& nbdkit S3 endpoint\-url=https://ceph.example.com \e
\&           bucket=MY\-BUCKET key=disk.img
.Ve
.SH "PARAMETERS"
.IX Header "PARAMETERS"
.IP "\fBaccess\-key=\fR\s-1ACCESS_KEY\s0" 4
.IX Item "access-key=ACCESS_KEY"
.PD 0
.IP "\fBsecret\-key=\fR\s-1SECRET_KEY\s0" 4
.IX Item "secret-key=SECRET_KEY"
.IP "\fBsession\-token=\fR\s-1SESSION_TOKEN\s0" 4
.IX Item "session-token=SESSION_TOKEN"
.PD
The \s-1AWS\s0 credentials may be specified on the command line using these
parameters, but it is more secure to pass them using files (see
\&\*(L"\s-1CREDENTIALS\*(R"\s0 below).
.IP "\fBendpoint\-url=\fR\s-1ENDPOINT\s0" 4
.IX Item "endpoint-url=ENDPOINT"
If accessing Ceph or another compatible S3 service, provide the
endpoint \s-1URL\s0 through this parameter.
.IP "\fBbucket=\fR\s-1BUCKET\s0" 4
.IX Item "bucket=BUCKET"
The bucket containing the file.  This parameter is required.
.IP "\fBkey=\fR\s-1FILENAME\s0" 4
.IX Item "key=FILENAME"
The file name within the bucket.  This parameter is required.
.SH "CREDENTIALS"
.IX Header "CREDENTIALS"
Although \s-1AWS\s0 credentials can be passed to nbdkit on the command line,
this is not secure since a user on the same machine could read them
using \fBps\fR\|(1).
.PP
A better way is to pass the credentials through the
\&\fI~/.aws/credentials\fR file.  This takes the form:
.PP
.Vb 3
\& [default]
\& aws_access_key_id = XXX
\& aws_secret_access_key = YYY
\& 
\& [profile]
\& aws_access_key_id = XXX
\& aws_secret_access_key = YYY
.Ve
.PP
Different profiles from the file can be selected by setting
the \f(CW\*(C`AWS_PROFILE\*(C'\fR environment variable.
.PP
There is much more information about credentials in
the Boto3 documentation.
.SH "COMPARED TO S3FS\-FUSE"
.IX Header "COMPARED TO S3FS-FUSE"
s3fs\-fuse (https://github.com/s3fs\-fuse/s3fs\-fuse) presents a whole
S3 bucket as a \s-1FUSE\s0 filesystem, with each object in the bucket
corresponding to a single file.  It is therefore quite different from
this plugin which turns a single S3 object into a block device.
.SH "FILES"
.IX Header "FILES"
.IP "\fI\f(CI$plugindir\fI/nbdkit\-S3\-plugin\fR" 4
.IX Item "$plugindir/nbdkit-S3-plugin"
The plugin.
.Sp
Use \f(CW\*(C`nbdkit \-\-dump\-config\*(C'\fR to find the location of \f(CW$plugindir\fR.
.IP "\fI\f(CI$HOME\fI/.aws/credentials\fR" 4
.IX Item "$HOME/.aws/credentials"
\&\s-1AWS\s0 credentials can be passed to boto3 using this file.
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
.ie n .IP """AWS_*""" 4
.el .IP "\f(CWAWS_*\fR" 4
.IX Item "AWS_*"
Boto3 reads some credential information from \f(CW\*(C`AWS_*\*(C'\fR environment variables.
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW\*(C`nbdkit\-S3\-plugin\*(C'\fR first appeared in nbdkit 1.24.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1),
\&\fBnbdkit\-plugin\fR\|(3),
\&\fBnbdkit\-python\-plugin\fR\|(3),
https://pypi.org/project/boto3/,
https://boto3.amazonaws.com/v1/documentation/api/latest/index.html,
https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
.SH "AUTHORS"
.IX Header "AUTHORS"
Richard W.M. Jones
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2020 Red Hat Inc.
.SH "LICENSE"
.IX Header "LICENSE"
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
.IP "\(bu" 4
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
.IP "\(bu" 4
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
.IP "\(bu" 4
Neither the name of Red Hat nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
.PP
\&\s-1THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS\s0 ''\s-1AS IS\s0'' \s-1AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\s0 (\s-1INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES\s0; \s-1LOSS OF
USE, DATA, OR PROFITS\s0; \s-1OR BUSINESS INTERRUPTION\s0) \s-1HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT\s0 (\s-1INCLUDING NEGLIGENCE OR OTHERWISE\s0) \s-1ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.\s0