Skip to content

Commit 92116ef

Browse files
authored
[DOCS-1939] Fix step references in BYOB docs (#2000)
## Description [DOCS-1939] Fix step references in BYOB docs - Add an anchor for the environment variable step - Update link text from specific steps to 'Provision your bucket', but link to more specific anchors - Update links for AWS and Google Terraform examples - Simplify troubleshooting heading since <detail> is not working ## Testing - [x] Local build succeeds without errors (`mint dev`) - [x] Local link check succeeds without errors (`mint broken-links`) - [x] PR tests succeed [DOCS-1939]: https://wandb.atlassian.net/browse/DOCS-1939?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
1 parent f8d65b9 commit 92116ef

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

platform/hosting/data-security/secure-storage-connector.mdx

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -172,10 +172,10 @@ For details, see [Create a CoreWeave AI Object Storage bucket](https://docs.core
172172
- **Multi-tenant Cloud**: `arn:aws:iam::wandb:static/wandb-integration-public`
173173
- **Dedicated Cloud** or **Self-Managed**: `arn:aws:iam::wandb:static/wandb-integration`
174174
- `<wb-org-id>`:
175-
- **Multi-tenant Cloud**: The organization ID from [Step 1](#coreweave-org-id).
176-
- **Dedicated Cloud** or **Self-Managed**: The customer namespace from [Step 2](#coreweave-customer-namespace).
175+
- **Multi-tenant Cloud**: The organization ID from [Provision your bucket](#coreweave-org-id).
176+
- **Dedicated Cloud** or **Self-Managed**: The customer namespace from [Provision your bucket](#coreweave-customer-namespace).
177177
1. **Dedicated Cloud**: Contact [support](mailto:support@wandb.ai) to complete additional steps.
178-
1. **Self-Managed**: Update your W&B deployment to set the environment variable `GORILLA_SUPPORTED_FILE_STORES` to the exact string `cw://` and restart W&B. Otherwise, CoreWeave will not appear as an option when you configure team storage.
178+
1. <a id="set-environment-variable"></a>**Self-Managed**: Update your W&B deployment to set the environment variable `GORILLA_SUPPORTED_FILE_STORES` to the exact string `cw://` and restart W&B. Otherwise, CoreWeave will not appear as an option when you configure team storage.
179179

180180
Next, [configure W&B](#configure-byob).
181181
</Tab>
@@ -475,8 +475,8 @@ For **Self-Managed**, you can configure instance level BYOB using the W&B App:
475475
<Note>
476476
For Self-Managed, W&B recommends using the Terraform module managed by W&B to provision a storage bucket along with the necessary access mechanism and related IAM permissions:
477477

478-
* [AWS](https://github.com/wandb/terraform-aws-wandb/tree/main/modules/secure_storage_connector)
479-
* [Google Cloud](https://github.com/wandb/terraform-google-wandb/tree/main/modules/secure_storage_connector)
478+
* [AWS](https://github.com/wandb/terraform-aws-wandb/tree/main/examples/byob)
479+
* [Google Cloud](https://github.com/wandb/terraform-google-wandb/tree/main/examples/byob)
480480
* Azure - [Instance level BYOB](https://github.com/wandb/terraform-azurerm-wandb/tree/main/examples/byob) or [Team level BYOB](https://github.com/wandb/terraform-azurerm-wandb/tree/main/examples/secure-storage-connector)
481481
</Note>
482482

@@ -511,7 +511,7 @@ Select your deployment type to continue.
511511

512512
Click **Cloud provider** and select **CoreWeave**, **AWS**, **Google Cloud**, or **Azure**.
513513

514-
If the cloud provider is not listed, ensure that you have followed step 1 to add the bucket path to the supported file stores for your instance. If the storage provider is still not listed, [contact support](mailto:support@wandb.ai) for assistance.
514+
If the cloud provider is not listed, ensure that you have followed the instructions in [Provision your bucket](#set-environment-variable) to add the bucket path to the supported file stores for your instance. If the storage provider is still not listed, [contact support](mailto:support@wandb.ai) for assistance.
515515
1. Specify the bucket details.
516516
- For **CoreWeave**, provide only the bucket name.
517517
- For Amazon S3, Google Cloud, or S3-compatible storage, provide the full bucket path you [determined earlier](#determine-the-storage-address).
@@ -554,8 +554,7 @@ If W&B encounters errors accessing the bucket or detects invalid settings, an er
554554
</Tabs>
555555

556556
## Troubleshooting
557-
<details open>
558-
<summary>Connecting to CoreWeave AI Object Storage</summary>
557+
This section helps troubleshoot problems connecting to CoreWeave AI Object Storage.
559558

560559
- **Connection errors**
561560
- Verify that your W&B instance can connect to CoreWeave network endpoints.
@@ -573,5 +572,3 @@ If W&B encounters errors accessing the bucket or detects invalid settings, an er
573572
- **Access key and permission errors**
574573
- Verify that your CoreWeave API Access Key is not expired.
575574
- Verify that your CoreWeave API Access Key and Secret Key have sufficient permissions `GetObject`, `PutObject`, `DeleteObject`, `ListBucket`. The examples in this page meet this requirement. Refer to [Create and Manage Access Keys](https://docs.coreweave.com/docs/products/storage/object-storage/how-to/manage-access-keys) in the CoreWeave documentation.
576-
577-
</details>

0 commit comments

Comments
 (0)