c88a9842db
Signed-off-by: Denis Kirillov <denis@nspcc.ru> |
||
---|---|---|
.docker | ||
.github/workflows | ||
api | ||
authmate | ||
cmd | ||
config | ||
creds | ||
docs | ||
internal | ||
.dockerignore | ||
.gitignore | ||
.golangci.yml | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
CREDITS.md | ||
go.mod | ||
go.sum | ||
help.mk | ||
LICENSE | ||
Makefile | ||
README.md | ||
syncTree.sh | ||
updateTestsResult.sh | ||
VERSION |
NeoFS S3 Gateway
NeoFS S3 gateway provides API compatible with Amazon S3 cloud storage service.
Installation
go get -u github.com/nspcc-dev/neofs-s3-gw
Or you can call make
to build it from the cloned repository (the binary will
end up in bin/neofs-s3-gw
with authmate helper in bin/neofs-s3-authmate
).
To build binaries in clean docker environment, call make docker/all
.
Other notable make targets:
dep Check and ensure dependencies
image Build clean docker image
dirty-image Build dirty docker image with host-built binaries
format Run all code formatters
lint Run linters
version Show current version
Or you can also use a Docker
image provided for released
(and occasionally unreleased) versions of gateway (:latest
points to the
latest stable release).
Execution
Minimalistic S3 gateway setup needs:
- NeoFS node(s) address (S3 gateway itself is not a NeoFS node)
Passed via
-p
parameter or viaS3_GW_PEERS_<N>_ADDRESS
andS3_GW_PEERS_<N>_WEIGHT
environment variables (gateway supports multiple NeoFS nodes with weighted load balancing). - a wallet used to fetch key and communicate with NeoFS nodes
Passed via
--wallet
parameter orS3_GW_WALLET
environment variable.
These two commands are functionally equivalent, they run the gate with one backend node, some keys and otherwise default settings:
$ neofs-s3-gw -p 192.168.130.72:8080 --wallet wallet.json
$ S3_GW_PEERS_0_ADDRESS=192.168.130.72:8080 \
S3_GW_WALLET=wallet.json \
neofs-s3-gw
It's also possible to specify uri scheme (grpc or grpcs) when using -p
or environment variables:
$ neofs-s3-gw -p grpc://192.168.130.72:8080 --wallet wallet.json
$ S3_GW_PEERS_0_ADDRESS=grpcs://192.168.130.72:8080 \
S3_GW_WALLET=wallet.json \
neofs-s3-gw
AWS SDK Compatibility
To match signature of the request you must not include the following headers to SignedHeaders
:
User-Agent
X-Amzn-Trace-Id
AWS SDK JAVA v1
Using aws-sdk-java you can get the following error:
Exception in thread "main" com.amazonaws.services.s3.model.AmazonS3Exception:
The request signature we calculated does not match the signature you provided. Check your key and signing method.
To solve this problem you should configure client properly:
RequestHandler2 handler = new RequestHandler2() {
@Override
public void beforeAttempt(HandlerBeforeAttemptContext context) {
context.getRequest().getHeaders().remove("User-Agent");
super.beforeAttempt(context);
}
};
AmazonS3 s3Client = AmazonS3ClientBuilder.standard()
.withRequestHandlers(handler)
.enablePathStyleAccess()
// ...
.build()
Documentation
- Configuration
- NeoFS S3 AuthMate
- NeoFS Tree service
- AWS CLI basic usage
- AWS S3 API compatibility
- AWS S3 Compatibility test results
Credits
Please see CREDITS for details.