dstepanov-yadro/xk6-frostfs
1
0
Fork 0
forked from TrueCloudLab/xk6-frostfs
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#8] Update README.md

Browse source 
Signed-off-by: Denis Kirillov <denis@nspcc.ru>
This commit is contained in:
Denis Kirillov 2022-06-01 09:45:28 +03:00 committed by Alex Vanin
parent f0285b244d
commit 265545a584
1 changed files with 8 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -2,7 +2,7 @@
<img src="./.github/logo.svg" width="500px" alt="NeoFS"> <img src="./.github/logo.svg" width="500px" alt="NeoFS">
</p> </p>
<p align="center"> <p align="center">
<a href="https://fs.neo.org">NeoFS</a> is a decentralized distributed object storage integrated with the <a href="https://neo.org">NEO Blockchain</a>. <a href="https://go.k6.io/k6">k6</a> extension to test and benchmark <a href="https://fs.neo.org">NeoFS</a> related protocols.
</p> </p>
--- ---
@ -10,11 +10,7 @@
# xk6-neofs # xk6-neofs
This is a [k6](https://go.k6.io/k6) extension using the # Build
[xk6](https://github.com/k6io/xk6) system, that allows to test
[NeoFS](https://github.com/nspcc-dev/neofs-node) related protocols.
## Build
To build a `k6` binary with this extension, first ensure you have the prerequisites: To build a `k6` binary with this extension, first ensure you have the prerequisites:
@ -42,9 +38,9 @@ xk6 build --with github.com/nspcc-dev/xk6-neofs=.
./k6 run test-script.js ./k6 run test-script.js
``` ```
## API # API
### Native ## Native
Create native client with `connect` method. Arguments: Create native client with `connect` method. Arguments:
- neofs storage node endpoint - neofs storage node endpoint
@ -55,7 +51,7 @@ import native from 'k6/x/neofs/native';
const neofs_cli = native.connect("s01.neofs.devenv:8080", "") const neofs_cli = native.connect("s01.neofs.devenv:8080", "")
``` ```
#### Methods ### Methods
- `setBufferSize(size)`. Sets internal buffer size for data upload and - `setBufferSize(size)`. Sets internal buffer size for data upload and
download. Default is 64 KiB. download. Default is 64 KiB.
- `put(container_id, headers, payload)`. Returns dictionary with `success` - `put(container_id, headers, payload)`. Returns dictionary with `success`
@ -67,7 +63,7 @@ const neofs_cli = native.connect("s01.neofs.devenv:8080", "")
It returns dicrionary with `success` boolean flag, `object_id` string and It returns dicrionary with `success` boolean flag, `object_id` string and
`error` string. `error` string.
### S3 ## S3
Create s3 client with `connect` method. Arguments: Create s3 client with `connect` method. Arguments:
- s3 gateway endpoint - s3 gateway endpoint
@ -79,13 +75,13 @@ import s3 from 'k6/x/neofs/s3';
const s3_cli = s3.connect("http://s3.neofs.devenv:8080") const s3_cli = s3.connect("http://s3.neofs.devenv:8080")
``` ```
#### Methods ### Methods
- `put(bucket, key, payload)`. Returns dictionary with `success` boolean flag - `put(bucket, key, payload)`. Returns dictionary with `success` boolean flag
and `error` string. and `error` string.
- `get(bucket, key)`. Returns dictionary with `success` boolean flag and `error` - `get(bucket, key)`. Returns dictionary with `success` boolean flag and `error`
string. string.
## Examples # Examples
See native protocol and s3 test suit examples in [examples](./examples) dir. See native protocol and s3 test suit examples in [examples](./examples) dir.