FrostFS S3 Protocol Gateway
Find a file
Alex Vanin 751d66bde0 [#140] Use gRPC interceptor from observability package
Previous SDK implementation had implicit gRPC interceptor
for tracing. Now pool constructors allow any dial options,
so gateway should manually pass tracing interceptors from
observability package.

Signed-off-by: Alex Vanin <a.vanin@yadro.com>
2023-06-14 15:46:43 +00:00
.docker Rename package name 2023-03-07 17:38:08 +03:00
.forgejo/workflows [#133] Drop sync-tree 2023-06-09 09:34:36 +03:00
.github [#2] Keep issue templates in .github 2023-06-07 15:35:57 +00:00
api [#103] Return 504 http code on timeout errors 2023-06-14 09:16:21 +03:00
authmate [#132] authmate: Add bearer token to obtain-secret result 2023-06-13 15:14:19 +00:00
cmd [#140] Use gRPC interceptor from observability package 2023-06-14 15:46:43 +00:00
config [#133] Update docs 2023-06-09 09:34:49 +03:00
creds [#68] Fix pre-commit issues 2023-03-24 16:22:06 +03:00
debian [#68] Fix pre-commit issues 2023-03-24 16:22:06 +03:00
docs [#132] authmate: Add bearer token to obtain-secret result 2023-06-13 15:14:19 +00:00
internal [#103] Return 504 http code on timeout errors 2023-06-14 09:16:21 +03:00
metrics [#80] metrics: Use map for constant labels 2023-04-20 11:14:52 +03:00
pkg/service/tree [#103] Return 504 http code on timeout errors 2023-06-14 09:16:21 +03:00
.dockerignore [#471] Add docker/* target in Makefile 2022-06-16 11:12:42 +03:00
.gitignore [#133] Drop sync-tree 2023-06-09 09:34:36 +03:00
.gitlint [#65] Enable pre-commit 2023-03-24 07:28:04 +00:00
.golangci.yml [#127] Increase golangci-lint timeout 2023-06-06 08:11:36 +00:00
.pre-commit-config.yaml [#65] Enable pre-commit 2023-03-24 07:28:04 +00:00
CHANGELOG.md [#103] Return 504 http code on timeout errors 2023-06-14 09:16:21 +03:00
CONTRIBUTING.md [#2] Update CONTRIBUTING 2023-06-07 15:35:57 +00:00
CREDITS.md [#68] Fix pre-commit issues 2023-03-24 16:22:06 +03:00
go.mod [#133] Use tree pool from SDK 2023-06-09 09:34:04 +03:00
go.sum [#133] Use tree pool from SDK 2023-06-09 09:34:04 +03:00
help.mk [#725] Fix help 2022-10-17 19:16:05 +03:00
LICENSE [#264] Change NeoFS S3 Gateway license to AGPLv3 2021-09-20 10:38:28 +03:00
Makefile [#133] Drop sync-tree 2023-06-09 09:34:36 +03:00
README.md [#2] Keep issue templates in .github 2023-06-07 15:35:57 +00:00
updateTestsResult.sh [#68] Fix pre-commit issues 2023-03-24 16:22:06 +03:00
VERSION Release v0.26.0 2022-12-28 17:06:32 +03:00

FrostFS logo

FrostFS is a decentralized distributed object storage integrated with the NEO Blockchain.


Report Release License

FrostFS S3 Gateway

FrostFS S3 gateway provides API compatible with Amazon S3 cloud storage service.

Installation

go get -u git.frostfs.info/TrueCloudLab/frostfs-s3-gw

Or you can call make to build it from the cloned repository (the binary will end up in bin/frostfs-s3-gw with authmate helper in bin/frostfs-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:

  • FrostFS node(s) address (S3 gateway itself is not a FrostFS node) Passed via -p parameter or via S3_GW_PEERS_<N>_ADDRESS and S3_GW_PEERS_<N>_WEIGHT environment variables (gateway supports multiple FrostFS nodes with weighted load balancing).
  • a wallet used to fetch key and communicate with FrostFS nodes Passed via --wallet parameter or S3_GW_WALLET_PATH environment variable.

These two commands are functionally equivalent, they run the gate with one backend node, some keys and otherwise default settings:

$ frostfs-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 \
  frostfs-s3-gw

It's also possible to specify uri scheme (grpc or grpcs) when using -p or environment variables:

$ frostfs-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 \
  frostfs-s3-gw

Domains

By default, s3-gw enable only path-style access. To be able to use both: virtual-hosted-style and path-style access you must configure listen_domains:

$ frostfs-s3-gw -p 192.168.130.72:8080 --wallet wallet.json --listen_domains your.first.domain --listen_domains your.second.domain

So now you can use (e.g. HeadBucket. Make sure DNS is properly configured):

$ curl --head http://bucket-name.your.first.domain:8080
HTTP/1.1 200 OK
...

or

$ curl --head http://your.second.domain:8080/bucket-name
HTTP/1.1 200 OK
...

Also, you can configure domains using .env variables or yaml file.

Documentation

Credits

Please see CREDITS for details.