From d2a3ba0c0680a0e42f2be17c5eddc64e6203fb1f Mon Sep 17 00:00:00 2001 From: Angira Kekteeva Date: Tue, 28 Jun 2022 22:12:39 +0400 Subject: [PATCH] [#562] Rename authmate directory To generate neofs-s3-authmate instead of neofs-authmate Signed-off-by: Angira Kekteeva --- Dockerfile | 2 +- README.md | 4 ++-- cmd/{authmate => s3-authmate}/main.go | 0 docs/authmate.md | 14 +++++++------- docs/aws_cli.md | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) rename cmd/{authmate => s3-authmate}/main.go (100%) diff --git a/Dockerfile b/Dockerfile index db8eb0dc..55d9516c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -19,7 +19,7 @@ FROM scratch WORKDIR / COPY --from=builder /src/bin/neofs-s3-gw /bin/neofs-s3-gw -COPY --from=builder /src/bin/neofs-authmate /bin/neofs-authmate +COPY --from=builder /src/bin/neofs-s3-authmate /bin/neofs-s3-authmate COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ ENTRYPOINT ["/bin/neofs-s3-gw"] diff --git a/README.md b/README.md index 36e9680c..2abca4df 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ NeoFS S3 gateway provides API compatible with Amazon S3 cloud storage service. ```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`). +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: @@ -87,7 +87,7 @@ AmazonS3 s3Client = AmazonS3ClientBuilder.standard() ## Documentation - [Configuration](./docs/configuration.md) -- [NeoFS AuthMate](./docs/authmate.md) +- [NeoFS S3 AuthMate](./docs/authmate.md) - [AWS CLI basic usage](./docs/aws_cli.md) - [AWS S3 API compatibility](./docs/aws_s3_compat.md) - [AWS S3 Compatibility test results](./docs/s3_test_results.md) diff --git a/cmd/authmate/main.go b/cmd/s3-authmate/main.go similarity index 100% rename from cmd/authmate/main.go rename to cmd/s3-authmate/main.go diff --git a/docs/authmate.md b/docs/authmate.md index c0912841..f0f61425 100644 --- a/docs/authmate.md +++ b/docs/authmate.md @@ -1,4 +1,4 @@ -# NeoFS AuthMate +# NeoFS S3 AuthMate Authmate is a tool to create gateway AWS credentials. AWS users are authenticated with access key IDs and secrets, while NeoFS users are @@ -105,7 +105,7 @@ You can issue a secret using the parameters above only. The tool will E.g.: ```shell -$ neofs-authmate issue-secret --wallet wallet.json \ +$ neofs-s3-authmate issue-secret --wallet wallet.json \ --peer 192.168.130.71:8080 \ --gate-public-key 0313b1ac3a8076e155a7e797b24f0b650cccad5941ea59d7cfd51a024a8b2a06bf\ --gate-public-key 0317585fa8274f7afdf1fc5f2a2e7bece549d5175c4e5182e37924f30229aef967 @@ -141,7 +141,7 @@ Creation of bearer tokens is mandatory. Rules for a bearer token can be set via parameter `--bearer-rules` (json-string and file path allowed): ```shell -$ neofs-authmate issue-secret --wallet wallet.json \ +$ neofs-s3-authmate issue-secret --wallet wallet.json \ --peer 192.168.130.71:8080 \ --gate-public-key 0313b1ac3a8076e155a7e797b24f0b650cccad5941ea59d7cfd51a024a8b2a06bf \ --bearer-rules bearer-rules.json @@ -195,7 +195,7 @@ If bearer rules are not set, a token will be auto-generated with a value: With a session token, there are 3 options: 1. append `--session-tokens` parameter with your custom rules in json format (as a string or file path). E.g.: ```shell -$ neofs-authmate issue-secret --wallet wallet.json \ +$ neofs-s3-authmate issue-secret --wallet wallet.json \ --peer 192.168.130.71:8080 \ --gate-public-key 0313b1ac3a8076e155a7e797b24f0b650cccad5941ea59d7cfd51a024a8b2a06bf \ --session-tokens session.json @@ -253,7 +253,7 @@ and the other (for `gate-wallet.json`) interactively: ```shell $ AUTHMATE_WALLET_PASSPHRASE=some-pwd \ -neofs-authmate obtain-secret --wallet wallet.json \ +neofs-s3-authmate obtain-secret --wallet wallet.json \ --peer 192.168.130.71:8080 \ --gate-wallet gate-wallet.json \ --access-key-id 5g933dyLEkXbbAspouhPPTiyLZRg4axBW1axSPD87eVT0AiXsH4AjYy1iTJ4C1WExzjBrSobJsQFWEyKLREe5sQYM @@ -272,7 +272,7 @@ using AWS credentials from `~/.aws/credentials` (you can specify profile using t with the following command: ```shell -$ neofs-authmate generate-presigned-url --endpoint http://localhost:8084 \ +$ neofs-s3-authmate generate-presigned-url --endpoint http://localhost:8084 \ --method get --bucket presigned --object obj --lifetime 30s { @@ -283,7 +283,7 @@ $ neofs-authmate generate-presigned-url --endpoint http://localhost:8084 \ You can also provide credential explicitly: ```shell -$ neofs-authmate generate-presigned-url --endpoint http://localhost:8084 \ +$ neofs-s3-authmate generate-presigned-url --endpoint http://localhost:8084 \ --method put --bucket presigned --object obj --lifetime 12h \ --region ru --aws-secret-access-key c2d65ef2980f03f4f495bdebedeeae760496697880d61d106bb9a4e5cd2e0607 \ --aws-access-key-id ETaA2CadPcA7bAkLsML2PbTudXY8uRt2PDjCCwkvRv9s0FDCxWDXYc1SA1vKv8KbyCNsLY2AmAjJ92Vz5rgvsFCy diff --git a/docs/aws_cli.md b/docs/aws_cli.md index 0356ddca..a8292083 100644 --- a/docs/aws_cli.md +++ b/docs/aws_cli.md @@ -6,7 +6,7 @@ To configure basic settings that the AWS CLI uses to interact with the Gateway, follow the steps below: -1. issue a secret with neofs-authmate tool (see [NeoFS Authmate] (#neofs-authmate)) +1. issue a secret with neofs-s3-authmate tool (see [NeoFS S3 Authmate](./authmate.md)) 2. execute the command ``` $ aws configure