diff --git a/docs.json b/docs.json index af1ed113..d4b9fe14 100644 --- a/docs.json +++ b/docs.json @@ -245,7 +245,7 @@ "storage/high-performance-storage", "storage/s3-api", { - "group": "Global volumes", + "group": "Global volumes (Beta)", "pages": [ "storage/globalvolume/overview", "storage/globalvolume/globalvolume-pods" diff --git a/storage/globalvolume/globalvolume-serverless.mdx b/storage/globalvolume/globalvolume-serverless.mdx deleted file mode 100644 index 34231c86..00000000 --- a/storage/globalvolume/globalvolume-serverless.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: "Global volumes for Serverless" -sidebarTitle: "For Serverless" -description: "Attach a global volume to a GPU Serverless endpoint so workers share access to model weights and other read-heavy data across all data centers." -tag: "Beta" -hidden: true -noindex: true ---- - - - Global volumes for Serverless are in beta. Features and behavior may change before general availability. - - -Attaching a global volume to a Serverless endpoint gives its workers shared, region-independent access to model weights and other read-heavy data. Because a global volume has no data center, attaching one doesn't restrict where your workers run. Your endpoint keeps access to the full GPU pool, unlike a network volume, which limits an endpoint to a single region. - -Global volumes are available on GPU endpoints only. CPU endpoints don't support them. - -If you don't have a global volume yet, [create one first](/storage/globalvolume#create-a-global-volume). - -## Mount path - -Inside a worker, a global volume mounts at `/runpod-volume`, the same path used for network volumes on Serverless. Read your model files and other assets from this path in your handler function. - -## Attach a global volume to an endpoint - -You attach a global volume when you create a new endpoint or edit an existing one. - -**To attach a global volume to a new endpoint:** - -1. Go to **Serverless** and click **+ New Endpoint**. -2. Configure your endpoint, then expand **Advanced**. -3. Under **Global volume**, select the volume you want to attach. -4. Click **Deploy**. - -**To attach or change the global volume on an existing endpoint:** - -1. Go to **Serverless** and select your endpoint. -2. Click **Manage**, then **Edit Endpoint**. -3. Expand **Advanced** and select the global volume you want to attach. -4. Click **Save Endpoint**. - - - Attaching a volume doesn't copy any existing data, so upload your model files and other assets to the global volume before you attach it. Changing the attached volume triggers a new release and your workers redeploy to pick it up. - - -An endpoint can attach at most one global volume. It can't use a global volume and a network volume at the same time, but it can attach multiple network volumes on their own. To switch an endpoint from network volumes to a global volume, detach the network volumes first. To switch back, remove the global volume first. - -## Attach a global volume with the REST API - -You can also attach and detach an endpoint's global volume through the Runpod REST API v2. The endpoint create, update, and read operations accept a `globalVolumes` field: an array of volume IDs that holds at most one volume. It mirrors the existing `networkVolumes` field. - - - The API doesn't expose a route for listing global volumes yet, so copy the volume ID from the **Storage** page in the console before you make a request. - - -To attach a global volume when you create an endpoint, include `globalVolumes` in the request body: - -```bash -curl --request POST \ ---url https://api.runpod.io/v2/serverless \ ---header 'Authorization: Bearer RUNPOD_API_KEY' \ ---header 'Content-Type: application/json' \ ---data '{ - "name": "my-endpoint", - "image": "runpod/pytorch:1.0.2-cu1281-torch280-ubuntu2404", - "gpu": { "pools": ["ADA_24"], "count": 1 }, - "globalVolumes": [""] -}' -``` - -To change the attached volume on an existing endpoint, send a PATCH request to `/v2/serverless/{id}`. The `globalVolumes` field follows the same rules as `networkVolumes`: - -- Omit the field to keep the current volume attached. -- Set it to `[""]` to attach or replace the volume. -- Set it to `[]` to detach the volume. - -```bash -curl --request PATCH \ ---url https://api.runpod.io/v2/serverless/{id} \ ---header 'Authorization: Bearer RUNPOD_API_KEY' \ ---header 'Content-Type: application/json' \ ---data '{ "globalVolumes": [] }' -``` - -Because an endpoint can't use a global volume and a network volume at the same time, a request that would attach both is rejected. Detach the existing volume first. - -The REST API can attach global volumes to Serverless endpoints only. To attach a global volume to a Pod, use the console (see [Global volumes for Pods](/storage/globalvolume-pods)). - -For the full request schemas, see [Create a Serverless endpoint](/serverless/references/create-endpoint) and [Update a Serverless endpoint](/serverless/references/update-endpoint). - -## Limitations - -- **One global volume per endpoint:** An endpoint can attach at most one global volume at a time. -- **Mutually exclusive with network volumes:** An endpoint can't use a global volume and a network volume at the same time. - -For shared limitations that apply to both Pods and Serverless, see [Global volumes — Limitations](/storage/globalvolume#limitations). - -## Next steps - -- [Global volumes for Pods](/storage/globalvolume-pods) -- [Serverless storage options](/serverless/storage/overview) -- [Use the S3-compatible API](/storage/s3-api) diff --git a/storage/globalvolume/overview.mdx b/storage/globalvolume/overview.mdx index 3bbcc509..0d3df6a7 100644 --- a/storage/globalvolume/overview.mdx +++ b/storage/globalvolume/overview.mdx @@ -1,8 +1,7 @@ --- -title: "Global volumes" -sidebarTitle: "Global volumes" +title: "Overview" +sidebarTitle: "Overview" description: "Learn how to create a global volume in Runpod and access your data from Pods across all data centers, with storage that persists across sessions." -tag: "Beta" --- @@ -15,6 +14,10 @@ Global volumes are designed for workloads that write data infrequently and read For attachment steps, see [Global volumes for Pods](/storage/globalvolume-pods). + + Global volumes are currently available for GPU Pods only. Serverless endpoints don't support global volumes. + + ## Create a global volume 1. In the left nav, go to **Storage**.