[2222] Document S3_STORAGE_CLASS setting in README - #2308
Open
JustinKyleJames wants to merge 1 commit into
Open
Conversation
JustinKyleJames
marked this pull request as draft
July 28, 2026 18:59
Contributor
Author
|
Converting this to draft. Pull #2307 will need to be merged and this rebased on that. In addition, I am adding a couple of more README issues on this pull. |
Contributor
|
#2307 is now merged. |
JustinKyleJames
force-pushed
the
issue_2222
branch
from
July 28, 2026 19:24
78c0661 to
812d169
Compare
Issue 2166 - Added a note that the S3 resource plugin should be installed on all servers in the zone. Issue 2222 - Document S3_STORAGE_CLASS setting in README Issue 2234 - Added a note about maximum upload size with default values for CIRCULAR_BUFFER_SIZE and S3_MPU_CHUNK.
JustinKyleJames
force-pushed
the
issue_2222
branch
from
July 29, 2026 19:51
812d169 to
ff03d3f
Compare
Contributor
Author
|
This has been rebased. Removing draft status. |
JustinKyleJames
marked this pull request as ready for review
July 29, 2026 19:52
Contributor
|
Is this ready for review? |
Contributor
Author
Yes it is. |
korydraughn
reviewed
Jul 31, 2026
|
|
||
| ## Installation Instructions | ||
|
|
||
| Install the deb or rpm package generated above or the one provided by the irods package repository on every server within the zone. |
Contributor
There was a problem hiding this comment.
Suggested change
| Install the deb or rpm package generated above or the one provided by the irods package repository on every server within the zone. | |
| Install the deb or rpm package generated above or the one provided by the iRODS package repository on every server within the zone. |
Comment on lines
+50
to
+55
| Install the deb or rpm package generated above or the one provided by the irods package repository on every server within the zone. | ||
|
|
||
| Note that the package is required even on servers that do not have an S3 resource attached to it as the following resource operations will execute on the server the client is attached to: | ||
|
|
||
| - RESOURCE_OP_RESOLVE_RESC_HIER | ||
| - RESOURCE_OP_NOTIFY |
Contributor
There was a problem hiding this comment.
This requirement feels new.
What changed to make installing the plugin on all nodes a requirement?
How do those operations influence this situation?
| Cacheless mode has a few extra configuration parameters in addition to HOST_MODE. | ||
|
|
||
| - `CIRCULAR_BUFFER_SIZE` - The plugin uses a circular buffer to store data while it is being streamed to S3. The size of the circular buffer is CIRCULAR_BUFFER_SIZE * S3_MPU_CHUNK. The default value is 4 so if the S3_MPU_CHUNK is the default of 5MB the circular buffer size will be 20MB. CIRCULAR_BUFFER_SIZE must be at least 2. If a size is set lower than 2 then it will default to 2. | ||
| - `CIRCULAR_BUFFER_SIZE` - The plugin uses a circular buffer to store data while it is being streamed to S3. The size of the circular buffer is CIRCULAR_BUFFER_SIZE * S3_MPU_CHUNK. The default value is 4 so if the S3_MPU_CHUNK is the default of 5MiB the circular buffer size will be 20MB. CIRCULAR_BUFFER_SIZE must be at least 2. If a size is set lower than 2 then it will default to 2. |
Contributor
There was a problem hiding this comment.
Should 20MB be 20MiB?
Are there other places in the README that need to be updated?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.