Skip to content

feat: Add documentation for S3-compatible API for network volumes #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 61 commits into from
Jun 11, 2025
Merged

feat: Add documentation for S3-compatible API for network volumes #267

merged 61 commits into from
Jun 11, 2025

Conversation

muhsinking
Copy link
Collaborator

@muhsinking muhsinking commented May 29, 2025 •
edited
Loading

This pull request introduces comprehensive documentation for the new S3-compatible API, allowing users to manage their RunPod network volumes more efficiently.

Key changes:

  • New serverless/storage/s3-api.mdx page:
    • Details how to set up and authenticate using shared keys.
    • Provides instructions for configuring the AWS CLI.
    • Includes examples for common operations using both AWS CLI (ls, cp, rm, sync) and the Boto3 Python library.
    • Lists supported S3 actions and known limitations of the API.
  • Updates to serverless/storage/network-volumes.mdx:
    • Added a new "Manage files" section that directs users to the S3-compatible API documentation for file management tasks like uploading large models.
    • Minor wording adjustments for clarity and consistency.

muhsinking added 30 commits May 21, 2025 17:41
@muhsinking
Rewrite pods overview
a23e23d
@muhsinking
Rewrite storage types
f078060
@muhsinking
Merge branch 'main' into storage-docs
f17efc5
@muhsinking
Update types
822b725
@muhsinking
Delete sync volumes page
78b54eb
@muhsinking
Add note about attaching volume
be948a2
@muhsinking
Minor change
b385710
@muhsinking
Rewrite choose-a-pod
7db6c62
@muhsinking
Update pods overview
14d4c7c
@muhsinking
Update rp-styleguide.mdc
b38e970
@muhsinking
Update cursor styleguide
cb3bb36
@muhsinking
Update rules
7ff9bca
@muhsinking
Update connect-to-pod (first half)
899722b
@muhsinking
Simplify connect-to-runpod, improve manage-pods, finish connect-to-a-pod
0a0dd1b
@muhsinking
Rewrite network volumes
3ad4a92
@muhsinking
Rewrite network volumes page
ae0da6d
@muhsinking
Update architecture section
b2e18fa
@muhsinking
Add docs for serverless storage
7041f09
@muhsinking
Rename section
9543574
@muhsinking
Trim serverless storage overview
99b7902
@muhsinking
Trim serverless storage overview (again)
d66d4ab
@muhsinking
Undo openapi change
8d0c282
@muhsinking
Minor update
ae6757e
@muhsinking
Merge branch 'main' into storage-docs
11cc168
@muhsinking
Add note about allowing long cold starts
0f114ea
@muhsinking
Update rp-styleguide.mdc
ee6cbd0
@muhsinking
Update vram guidance
23fa2d6
@muhsinking
Update network volume speeds
105429e
@muhsinking
Add S3 API how-to
e27cc1a
@muhsinking
Update title
5e54313
@muhsinking muhsinking changed the title Add S3 API docs feat: Add documentation for S3-compatible API for network volumes Jun 2, 2025
@muhsinking muhsinking merged commit df961a9 into main Jun 11, 2025
1 check passed
@muhsinking muhsinking deleted the s3-api-docs branch June 11, 2025 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brosenpod brosenpod brosenpod left review comments

@stuffbyt stuffbyt Awaiting requested review from stuffbyt

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@muhsinking @brosenpod