forked from TrueCloudLab/frostfs-s3-gw
FrostFS S3 Protocol Gateway
83fb697f80
It's redundant to write app name and version in each log message, a single entry at the start is enough. Make `App.Wait` to write app name as `neofs-s3-gw` in `application started` message. Do not add `app_name` and `app_version` fields to the logger returned by `newLogger`. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru> |
||
|---|---|---|
| .github/workflows | ||
| api | ||
| authmate | ||
| cmd | ||
| creds | ||
| docs | ||
| internal | ||
| .dockerignore | ||
| .gitignore | ||
| .golangci.yml | ||
| CHANGELOG.md | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| help.mk | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| 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-authmate).
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
-pparameter or viaS3_GW_PEERS_<N>_ADDRESSandS3_GW_PEERS_<N>_WEIGHTenvironment variables (gateway supports multiple NeoFS nodes with weighted load balancing). - a wallet used to fetch key and communicate with NeoFS nodes
Passed via
--walletparameter orS3_GW_WALLETenvironment 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