realloc/frostfs-rest-gw
1
0
Fork 0
forked from TrueCloudLab/frostfs-rest-gw
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#2] Update docs

Browse source 
Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
This commit is contained in:
Denis Kirillov 2022-12-16 12:45:15 +03:00 committed by Alex Vanin
parent 803cafbbd5
commit 087a1c79db
6 changed files with 39 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/CODEOWNERS vendored
View file

@ -1 +1 @@
* @alexvanin @masterSplinter01 @KirillovDenis * @alexvanin @KirillovDenis

16
CONTRIBUTING.md
View file

@ -3,8 +3,8 @@
First, thank you for contributing! We love and encourage pull requests from First, thank you for contributing! We love and encourage pull requests from
everyone. Please follow the guidelines: everyone. Please follow the guidelines:
- Check the open [issues](https://github.com/nspcc-dev/neofs-rest-gw/issues) and - Check the open [issues](https://github.com/TrueCloudLab/frostfs-rest-gw/issues) and
[pull requests](https://github.com/nspcc-dev/neofs-rest-gw/pulls) for existing [pull requests](https://github.com/TrueCloudLab/frostfs-rest-gw/pulls) for existing
discussions. discussions.
- Open an issue first, to discuss a new feature or enhancement. - Open an issue first, to discuss a new feature or enhancement.
@ -23,23 +23,23 @@ everyone. Please follow the guidelines:
## Development Workflow ## Development Workflow
Start by forking the `neofs-rest-gw` repository, make changes in a branch and then Start by forking the `frostfs-rest-gw` repository, make changes in a branch and then
send a pull request. We encourage pull requests to discuss code changes. Here send a pull request. We encourage pull requests to discuss code changes. Here
are the steps in details: are the steps in details:
### Set up your GitHub Repository ### Set up your GitHub Repository
Fork [NeoFS REST Gateway upstream](https://github.com/nspcc-dev/neofs-rest-gw/fork) source Fork [FrostFS REST Gateway upstream](https://github.com/TrueCloudLab/frostfs-rest-gw/fork) source
repository to your own personal repository. Copy the URL of your fork (you will repository to your own personal repository. Copy the URL of your fork (you will
need it for the `git clone` command below). need it for the `git clone` command below).
```sh ```sh
$ git clone https://github.com/nspcc-dev/neofs-rest-gw $ git clone https://github.com/TrueCloudLab/frostfs-rest-gw
``` ```
### Set up git remote as ``upstream`` ### Set up git remote as ``upstream``
```sh ```sh
$ cd neofs-rest-gw $ cd frostfs-rest-gw
$ git remote add upstream https://github.com/nspcc-dev/neofs-rest-gw $ git remote add upstream https://github.com/TrueCloudLab/frostfs-rest-gw
$ git fetch upstream $ git fetch upstream
$ git merge upstream/master $ git merge upstream/master
... ...
@ -106,7 +106,7 @@ contributors".
To sign your work, just add a line like this at the end of your commit message: To sign your work, just add a line like this at the end of your commit message:
``` ```
Signed-off-by: Samii Sakisaka <samii@nspcc.ru> Signed-off-by: Samii Sakisaka <samii@frostfs.info>
``` ```
This can easily be done with the `--signoff` option to `git commit`. This can easily be done with the `--signoff` option to `git commit`.

34
README.md
View file

@ -1,18 +1,18 @@
<p align="center"> <p align="center">
<img src="./.github/logo.svg" width="500px" alt="NeoFS"> <img src="./.github/logo.svg" width="500px" alt="FrostFS">
</p> </p>
<p align="center"> <p align="center">
REST server to interact with <a href="https://fs.neo.org">NeoFS</a>. REST server to interact with <a href="https://frostfs.info">FrostFS</a>.
</p> </p>
--- ---
[![Report](https://goreportcard.com/badge/github.com/nspcc-dev/neofs-rest-gw)](https://goreportcard.com/report/github.com/nspcc-dev/neofs-rest-gw) [![Report](https://goreportcard.com/badge/github.com/TrueCloudLab/frostfs-rest-gw)](https://goreportcard.com/report/github.com/TrueCloudLab/frostfs-rest-gw)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nspcc-dev/neofs-rest-gw?sort=semver) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/TrueCloudLab/frostfs-rest-gw?sort=semver)
![License](https://img.shields.io/github/license/nspcc-dev/neofs-rest-gw.svg?style=popout) ![License](https://img.shields.io/github/license/TrueCloudLab/frostfs-rest-gw.svg?style=popout)
# neofs-rest-gw # frostfs-rest-gw
NeoFS REST Gateway bridges NeoFS internal protocol and REST API server. FrostFS REST Gateway bridges FrostFS internal protocol and REST API server.
## Installation ## Installation
@ -29,10 +29,10 @@ Before building make sure you have the following tools:
First clone this repository: First clone this repository:
```shell ```shell
$ git clone https://github.com/nspcc-dev/neofs-rest-gw $ git clone https://github.com/TrueCloudLab/frostfs-rest-gw
``` ```
Then run make to build `bin/neofs-rest-gw` binary: Then run make to build `bin/frostfs-rest-gw` binary:
```shell ```shell
$ make $ make
@ -89,11 +89,11 @@ Or you can also use a [Docker image](https://hub.docker.com/r/nspccdev/neofs-res
## Execution ## Execution
REST gateway itself is not a NeoFS node, so to access NeoFS it uses node's gRPC interface and you need to provide some REST gateway itself is not a FrostFS node, so to access FrostFS it uses node's gRPC interface and you need to provide some
node that it will connect to. This can be done either via `-p` parameter or via `REST_GW_POOL_PEERS_<N>_ADDRESS` and node that it will connect to. This can be done either via `-p` parameter or via `REST_GW_POOL_PEERS_<N>_ADDRESS` and
`REST_GW_POOL_PEERS_<N>_WEIGHT` environment variables (the gate supports multiple NeoFS nodes with weighted load balancing). `REST_GW_POOL_PEERS_<N>_WEIGHT` environment variables (the gate supports multiple FrostFS nodes with weighted load balancing).
If you're launching REST gateway in bundle with [neofs-dev-env](https://github.com/nspcc-dev/neofs-dev-env), you can get If you're launching REST gateway in bundle with [frostfs-dev-env](https://github.com/TrueCloudLab/frostfs-dev-env), you can get
an IP address of the node in output of `make hosts` command an IP address of the node in output of `make hosts` command
(with s0*.neofs.devenv name). (with s0*.neofs.devenv name).
@ -101,15 +101,15 @@ These two commands are functionally equivalent, they run the gate with one backe
settings): settings):
```shell ```shell
$ neofs-rest-gw -p 192.168.130.72:8080 $ frostfs-rest-gw -p 192.168.130.72:8080
$ REST_GW_POOL_PEERS_0_ADDRESS=192.168.130.72:8080 neofs-rest-gw $ REST_GW_POOL_PEERS_0_ADDRESS=192.168.130.72:8080 frostfs-rest-gw
``` ```
It's also possible to specify uri scheme (grpc or grpcs) when using `-p`: It's also possible to specify uri scheme (grpc or grpcs) when using `-p`:
```shell ```shell
$ neofs-rest-gw -p grpc://192.168.130.72:8080 $ frostfs-rest-gw -p grpc://192.168.130.72:8080
$ REST_GW_POOL_PEERS_0_ADDRESS=grpcs://192.168.130.72:8080 neofs-rest-gw $ REST_GW_POOL_PEERS_0_ADDRESS=grpcs://192.168.130.72:8080 frostfs-rest-gw
``` ```
## Configuration ## Configuration
@ -119,7 +119,7 @@ specifically mentioned in most cases (see `--help` also). If you prefer a config
See [config](./config/config.yaml) and [defaults](./docs/gate-configuration.md) for example. See [config](./config/config.yaml) and [defaults](./docs/gate-configuration.md) for example.
```shell ```shell
$ neofs-rest-gw --config config.yaml $ frostfs-rest-gw --config config.yaml
``` ```
## Docs ## Docs

16
docs/gate-configuration.md
View file

@ -1,6 +1,6 @@
# NeoFS REST Gateway configuration file # FrostFS REST Gateway configuration file
This section contains detailed NeoFS REST Gateway configuration file description This section contains detailed FrostFS REST Gateway configuration file description
including default config values and some tips to set up configurable values. including default config values and some tips to set up configurable values.
There are some custom types used for brevity: There are some custom types used for brevity:
@ -88,23 +88,23 @@ pool:
error-threshold: 100 error-threshold: 100
# Nodes configuration # Nodes configuration
# This configuration makes the gateway use the first node (node1.neofs:8080) # This configuration makes the gateway use the first node (node1.frostfs:8080)
# while it's healthy. Otherwise, gateway uses the second node (node2.neofs:8080) # while it's healthy. Otherwise, gateway uses the second node (node2.frostfs:8080)
# for 10% of requests and the third node (node3.neofs:8080) for 90% of requests. # for 10% of requests and the third node (node3.frostfs:8080) for 90% of requests.
# Until nodes with the same priority level are healthy # Until nodes with the same priority level are healthy
# nodes with other priority are not used. # nodes with other priority are not used.
# The lower the value, the higher the priority. # The lower the value, the higher the priority.
peers: peers:
0: 0:
address: node1.neofs:8080 address: node1.frostfs:8080
priority: 1 priority: 1
weight: 1 weight: 1
1: 1:
address: node2.neofs:8080 address: node2.frostfs:8080
priority: 2 priority: 2
weight: 0.1 weight: 0.1
2: 2:
address: node3.neofs:8080 address: node3.frostfs:8080
priority: 2 priority: 2
weight: 0.9 weight: 0.9
``` ```

8
static/docs/docs.md
View file

@ -1,7 +1,7 @@
# neofs-rest-gw # frostfs-rest-gw
NeoFS REST Gateway bridges NeoFS internal protocol and REST API server. FrostFS REST Gateway bridges FrostFS internal protocol and REST API server.
### Open API specification ### Open API specification
@ -9,7 +9,7 @@ See full [API spec](/v1/docs).
### Basic concept ### Basic concept
Using this API you can interact with NeoFS nodes and manage containers and objects. Using this API you can interact with FrostFS nodes and manage containers and objects.
#### Container #### Container
@ -72,7 +72,7 @@ Also, you can use this attribute to further object searching.
### Status codes ### Status codes
More about NeoFS status code you can More about FrostFS status code you can
find [here](https://github.com/nspcc-dev/neofs-spec/blob/master/20-api-v2/status.md). find [here](https://github.com/nspcc-dev/neofs-spec/blob/master/20-api-v2/status.md).

2
static/docs/index.html
View file

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<title>NeoFS REST GW</title> <title>FrostFS REST GW</title>
</head> </head>
<body> <body>