FrostFS S3 Protocol Gateway
Find a file
Ekaterina Lebedeva 1d965b23ab
All checks were successful
/ DCO (pull_request) Successful in 1m57s
/ Builds (1.20) (pull_request) Successful in 2m53s
/ Builds (1.21) (pull_request) Successful in 2m38s
/ Vulncheck (pull_request) Successful in 2m42s
/ Lint (pull_request) Successful in 4m40s
/ Tests (1.20) (pull_request) Successful in 3m1s
/ Tests (1.21) (pull_request) Successful in 2m52s
[#432] doc: Fix grammar mistakes in authentication
Signed-off-by: Ekaterina Lebedeva <ekaterina.lebedeva@yadro.com>
2024-07-17 17:08:48 +03:00
.docker [#203] Add go1.21 to CI 2023-08-31 15:26:07 +03:00
.forgejo/workflows [#297] .forgejo: Check only PR commits in dco-go 2024-01-26 15:11:52 +00:00
.github [#2] Keep issue templates in .github 2023-06-07 15:35:57 +00:00
api [#398] Fix parameter parsing in bucket retryer 2024-07-03 13:42:24 +03:00
authmate [#372] authmate: Don't create creds with eacl table 2024-07-01 16:26:21 +03:00
cmd [#414] authmate: Add register-user command 2024-07-08 14:13:00 +03:00
config [#372] Drop kludge.acl_enabled flag 2024-07-01 16:26:19 +03:00
creds [#372] Drop [e]ACL related code 2024-07-01 16:58:44 +03:00
debian [#68] Fix pre-commit issues 2023-03-24 16:22:06 +03:00
docs [#432] doc: Fix grammar mistakes in authentication 2024-07-17 17:08:48 +03:00
internal [#414] authmate: Add register-user command 2024-07-08 14:13:00 +03:00
metrics [#321] Use correct owner id in billing metrics 2024-02-28 14:52:44 +03:00
pkg [#401] Drop notifications 2024-06-25 15:49:37 +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 [#195] Add log constants linter 2023-08-28 12:58:44 +03:00
.pre-commit-config.yaml [#195] Add log constants linter 2023-08-28 12:58:44 +03:00
CHANGELOG.md [#414] authmate: Add register-user command 2024-07-08 14:13:00 +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 [#419] Update SDK version 2024-07-08 12:15:24 +00:00
go.sum [#419] Update SDK version 2024-07-08 12:15:24 +00: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 [#308] Update linter versions 2024-02-16 18:24:53 +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 [#395] Port changelog and prepare it for next release 2024-05-27 14:27:11 +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.