TrueCloudLab/frostfs-api
34
1
Fork 18
Code Issues 14 Pull requests 3 Releases Activity Actions

[#82] Update documentation info #83

Merged
fyrchik merged 1 commit from orikik/frostfs-api:docs into master 2025-03-20 15:48:57 +00:00
Conversation 11 Commits 1 Files changed 4 +78 -2
orikik commented 2025-03-11 15:43:36 +00:00
Member
Copy link
  • Added more information about HeadResponse.Body.split_info field.
  • Updated information in documentation from .proto files.
- Added more information about HeadResponse.Body.split_info field. - Updated information in documentation from .proto files.
orikik added the
documentation
 label 2025-03-11 15:43:36 +00:00
orikik added 1 commit 2025-03-11 15:43:36 +00:00
[#82] Update documentation info
All checks were successful
Formatters / Run fmt (pull_request) Successful in 22s
Details
DCO action / DCO (pull_request) Successful in 26s
Details
Pre-commit hooks / Pre-commit (pull_request) Successful in 28s
Details
7bcf22459b 
Signed-off-by: Ori Bruk <o.bruk@yadro.com>
requested reviews from alexvanin, realloc, fyrchik, a.bogatyrev, storage-sdk-developers 2025-03-11 15:43:36 +00:00
PavelGrossSpb approved these changes 2025-03-12 08:14:11 +00:00
Dismissed
pogpp reviewed 2025-03-20 08:00:16 +00:00
object/service.proto Outdated
@ -571,2 +574,4 @@
// Meta information of split hierarchy.
// The return of this information indicates that an error has occurred.
// This information allows you to assemble the object yourself.
pogpp commented 2025-03-20 08:00:16 +00:00
Member
Copy link

This information allows you to assemble the object on your own.

This information allows you to assemble the object on your own.
orikik commented 2025-03-20 08:54:27 +00:00
Author
Member
Copy link

fixed it

fixed it
orikik force-pushed docs from 7bcf22459b to f73bc43299 2025-03-20 08:53:08 +00:00 Compare
orikik dismissed PavelGrossSpb's review 2025-03-20 08:53:08 +00:00
Reason:

New commits pushed, approval review dismissed automatically according to repository settings

alexvanin approved these changes 2025-03-20 09:26:37 +00:00
Dismissed
pogpp approved these changes 2025-03-20 09:28:16 +00:00
Dismissed
realloc approved these changes 2025-03-20 09:32:54 +00:00
Dismissed
fyrchik requested changes 2025-03-20 09:40:37 +00:00
Dismissed
object/service.proto Outdated
@ -125,2 +125,4 @@
// the very minimal information will be returned instead.
//
// Max header size depends on gRPC transmission settings.
// By default gRPC uses 4 MiB messages.
fyrchik commented 2025-03-20 09:35:48 +00:00
Owner
Copy link

Could you rephrase this a bit:

Max header size is currently not limited by this API, but may be restricted on the service level. gRPC uses 4 MiB messages by default.

In TO we use 256 MiB, so the header can be bigger.
Frankly, I would discuss the possiblity of limiting header right here and right now.
The order should be should be kibibytes, not mebibytes.
How about 16 KiB?
@realloc @alexvanin @dstepanov-yadro

Could you rephrase this a bit: ``` Max header size is currently not limited by this API, but may be restricted on the service level. gRPC uses 4 MiB messages by default. ``` In TO we use 256 MiB, so the header can be bigger. Frankly, I would discuss the possiblity of limiting header right here and right now. The order should be should be kibibytes, not mebibytes. How about 16 KiB? @realloc @alexvanin @dstepanov-yadro
fyrchik commented 2025-03-20 09:42:21 +00:00
Owner
Copy link

Maybe even have it in the network config.

Maybe even have it in the network config.
orikik commented 2025-03-20 09:47:25 +00:00
Author
Member
Copy link

As our experience with customers shows, even 4 MiB is not sufficient for them.

As our experience with customers shows, even 4 MiB is not sufficient for them.
orikik commented 2025-03-20 10:10:39 +00:00
Author
Member
Copy link

Could you rephrase this a bit:

@fyrchik Made with minor changes.

> Could you rephrase this a bit: @fyrchik Made with minor changes.
realloc commented 2025-03-20 12:32:24 +00:00
Owner
Copy link

Let's limit the Header size. I think few kilobytes might not be enough, hence 1 MiB looks better to me.

Let's limit the Header size. I think few kilobytes might not be enough, hence 1 MiB looks better to me.
object/service.proto Outdated
@ -570,6 +573,8 @@ message HeadResponse {
ShortHeader short_header = 2;
// Meta information of split hierarchy.
// The return of this information indicates that an error has occurred.
fyrchik commented 2025-03-20 09:40:07 +00:00
Owner
Copy link

I don't see how this comment helps to clarify anything.
We have no error on the gRPC level and return SplitInfo in the response.
So it should be sth about The object is virtual, manual assembly is required.

I don't see how this comment helps to clarify anything. We have no `error` on the gRPC level and return `SplitInfo` in the response. So it should be sth about `The object is virtual, manual assembly is required`.
orikik commented 2025-03-20 10:10:13 +00:00
Author
Member
Copy link

@fyrchik Made with minor changes.

@fyrchik Made with minor changes.
orikik force-pushed docs from f73bc43299 to a9eaff2fd6 2025-03-20 10:08:08 +00:00 Compare
orikik dismissed alexvanin's review 2025-03-20 10:08:08 +00:00
Reason:

New commits pushed, approval review dismissed automatically according to repository settings

orikik dismissed pogpp's review 2025-03-20 10:08:08 +00:00
Reason:

New commits pushed, approval review dismissed automatically according to repository settings

orikik dismissed realloc's review 2025-03-20 10:08:08 +00:00
Reason:

New commits pushed, approval review dismissed automatically according to repository settings

requested review from fyrchik 2025-03-20 10:34:32 +00:00
alexvanin approved these changes 2025-03-20 10:59:16 +00:00
requested reviews from realloc, pogpp 2025-03-20 11:00:50 +00:00
PavelGrossSpb approved these changes 2025-03-20 11:04:41 +00:00
realloc approved these changes 2025-03-20 12:37:28 +00:00
realloc left a comment
Owner
Copy link

LGTM. Header limitation may be described here or in following PRs.

LGTM. Header limitation may be described here or in following PRs.
orikik commented 2025-03-20 12:52:43 +00:00
Author
Member
Copy link

@realloc wrote in #83 (comment):

LGTM. Header limitation may be described here or in following PRs.

We can set this limit when saving the header, but with the PATCH method we can add attributes to the header, which may cause the limit to be exceeded.

@realloc wrote in https://git.frostfs.info/TrueCloudLab/frostfs-api/pulls/83#issuecomment-70957: > LGTM. Header limitation may be described here or in following PRs. We can set this limit when saving the header, but with the PATCH method we can add attributes to the header, which may cause the limit to be exceeded.
fyrchik approved these changes 2025-03-20 15:47:20 +00:00
fyrchik merged commit a9eaff2fd6 into master 2025-03-20 15:48:57 +00:00
orikik deleted branch docs 2025-03-20 15:49:45 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
a.bogatyrev
alexvanin
pogpp
PavelGrossSpb
realloc
fyrchik
Labels
Clear labels   
P0

Highest

  
P1

High

  
P2

Medium

  
P3

Low

  
good first issue

Good for newcomers

  
triage

Needs to be triaged

  
Infrastructure

Infrastructure, Automation, CI/CD or DevOps related stuff

  
blocked

The issue or PR is blocked by something

  
bug

Something is not working

  
config

Configuration format update or breaking change

  
discussion

Talking about something in order to reach a decision or to exchange ideas

  
documentation

Documentation related

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
go

Language features adoption

  
help wanted

Extra attention is needed

  
internal

   
invalid

Something is wrong

  
kludge

This is a kludge and we know it

  
observability

Related to metrics, tracing and logs

  
perfomance

Perfomance related

  
question

More information is needed

  
refactoring

Refactoring

  
wontfix

This won't be fixed

No labels
P0
P1
P2
P3
good first issue
triage
Infrastructure
blocked
bug
config
discussion
documentation
duplicate
enhancement
go
help wanted
internal
invalid
kludge
observability
perfomance
question
refactoring
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
6 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: TrueCloudLab/frostfs-api#83
No description provided.
Delete branch "orikik/frostfs-api:docs"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?