Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,7 @@ package-lock.json

# Link checker output
lychee/

# Python
__pycache__/
*.pyc
99 changes: 83 additions & 16 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,22 +79,9 @@
"pages": [
"platform/hosting/hosting-options/self-managed",
"platform/hosting/self-managed/ref-arch",
{
"group": "Run W&B Server on Kubernetes",
"pages": [
"platform/hosting/operator",
"platform/hosting/self-managed/operator-airgapped"
]
},
{
"group": "Install on public cloud",
"pages": [
"platform/hosting/self-managed/aws-tf",
"platform/hosting/self-managed/gcp-tf",
"platform/hosting/self-managed/azure-tf"
]
},
"platform/hosting/self-managed/bare-metal",
"platform/hosting/self-managed/requirements",
"platform/hosting/self-managed/operator",
"platform/hosting/self-managed/on-premises-deployments/kubernetes-airgapped",
"platform/hosting/server-upgrade-process",
"platform/hosting/self-managed/disable-automatic-app-version-updates"
]
Expand Down Expand Up @@ -3979,6 +3966,86 @@
{
"source": "weave/guides/tracking",
"destination": "weave/concepts/what-is-weave"
},
{
"source": "/platform/hosting/operator",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/platform/hosting/self-managed/bare-metal",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/platform/hosting/self-managed/operator-airgapped",
"destination": "/platform/hosting/self-managed/on-premises-deployments/kubernetes-airgapped"
},
{
"source": "/platform/hosting/self-managed/cloud-deployments/terraform",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/platform/hosting/self-managed/on-premises-deployments/kubernetes",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/platform/hosting/self-managed/aws-tf",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/platform/hosting/self-managed/gcp-tf",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/platform/hosting/self-managed/azure-tf",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ja/platform/hosting/operator",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ja/platform/hosting/self-managed/bare-metal",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ja/platform/hosting/self-managed/operator-airgapped",
"destination": "/platform/hosting/self-managed/on-premises-deployments/kubernetes-airgapped"
},
{
"source": "/ja/platform/hosting/self-managed/aws-tf",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ja/platform/hosting/self-managed/gcp-tf",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ja/platform/hosting/self-managed/azure-tf",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ko/platform/hosting/operator",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ko/platform/hosting/self-managed/bare-metal",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ko/platform/hosting/self-managed/operator-airgapped",
"destination": "/platform/hosting/self-managed/on-premises-deployments/kubernetes-airgapped"
},
{
"source": "/ko/platform/hosting/self-managed/aws-tf",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ko/platform/hosting/self-managed/gcp-tf",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ko/platform/hosting/self-managed/azure-tf",
"destination": "/platform/hosting/self-managed/operator"
}
],
"baseUrl": "https://docs.wandb.ai"
Expand Down
4 changes: 2 additions & 2 deletions inference/ui-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Go to [https://wandb.ai/inference](https://wandb.ai/inference).

After [selecting a model](#access-the-inference-service), you can test it in the Playground. Available actions include:

- [Customize model settings and parameters](/weave/guides/tools/playground#customize-settings)
- [Customize model settings and parameters](/weave/guides/tools/playground#customize-playground-settings)
- [Add, retry, edit, and delete messages](/weave/guides/tools/playground#message-controls)
- [Save and reuse a model with custom settings](/weave/guides/tools/playground#saved-models)
- [Compare multiple models](#compare-multiple-models)
Expand Down Expand Up @@ -92,4 +92,4 @@ Visit the [Inference pricing page](https://wandb.ai/site/pricing/inference) for

- Review [available models](/inference/models) to find the best one for your needs
- Try the [API](/inference/api-reference/) for programmatic access
- See [usage examples](/inference/examples/) for code samples
- See [usage examples](/inference/examples/) for code samples
14 changes: 9 additions & 5 deletions platform/hosting/data-security/secure-storage-connector.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
title: Bring your own bucket (BYOB)
---

import ByobContextNote from "/snippets/en/_includes/byob-context-note.mdx";

<ByobContextNote/>

## Overview
Bring your own bucket (BYOB) allows you to store W&B artifacts and other related sensitive data in your own cloud or on-prem infrastructure. In case of [Dedicated Cloud](/platform/hosting/hosting-options/dedicated_cloud) or [Multi-tenant Cloud](/platform/hosting/hosting-options/multi_tenant_cloud), data that you store in your bucket is not copied to the W&B managed infrastructure.

Expand Down Expand Up @@ -49,7 +53,7 @@ W&B can connect to the following storage providers:
- [Amazon S3](https://aws.amazon.com/s3/): Object storage service offering industry-leading scalability, data availability, security, and performance.
- [Google Cloud Storage](https://cloud.google.com/storage): Managed service for storing unstructured data at scale.
- [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs): Cloud-based object storage solution for storing massive amounts of unstructured data like text, binary data, images, videos, and logs.
- S3-compatible storage such as [MinIO Enterprise (AIStor)](https://www.min.io/product/aistor) or other enterprise-grade solutions hosted in your cloud or on-premises infrastructure.
- S3-compatible storage such as [MinIO Enterprise (AIStor)](https://min.io/product/aistor) or other enterprise-grade solutions hosted in your cloud or on-premises infrastructure.

The following table shows the availability of BYOB at each scope for each W&B deployment type.

Expand All @@ -76,9 +80,9 @@ After [verifying availability](#availability-matrix), you are ready to provision
- A CoreWeave account with AI Object Storage enabled and with permission to create buckets, API access keys, and secret keys.
- Your W&B instance must be able to connect to CoreWeave network endpoints.

For details, see [Create a CoreWeave AI Object Storage bucket](https://docs.coreweave.com/products/storage/object-storage/buckets/create-bucket) in the CoreWeave documentation.
For details, see [Create a CoreWeave AI Object Storage bucket](https://docs.coreweave.com/docs/products/storage/object-storage/buckets/create-bucket) in the CoreWeave documentation.

1. <a id="coreweave-org-id" aria-label="CoreWeave organization ID"></a>**Multi-tenant Cloud**: Obtain your organization ID, which is required for your bucket policy.
1. <a id="coreweave-org-id"></a>**Multi-tenant Cloud**: Obtain your organization ID, which is required for your bucket policy.
1. Log in to the [W&B App](https://wandb.ai/site).
1. In the left navigation, click **Create a new team**.
1. In the drawer that opens, copy the W&B organization ID, which is located above **Invite team members**.
Expand Down Expand Up @@ -113,7 +117,7 @@ For details, see [Create a CoreWeave AI Object Storage bucket](https://docs.core
```
CoreWeave storage is S3-compatible. For details about CORS, refer to [Configuring cross-origin resource sharing (CORS)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) in the AWS documentation.

1. Configure a bucket policy that grants the required permissions for your W&B deployment to access the bucket and generate [pre-signed URLs](./presigned-urls) that AI workloads in your cloud infrastructure or user browsers utilize to access the bucket. Refer to [Bucket Policy Reference](https://docs.coreweave.com/products/storage/object-storage/auth-access/bucket-access/bucket-policies) in the CoreWeave documentation.
1. Configure a bucket policy that grants the required permissions for your W&B deployment to access the bucket and generate [pre-signed URLs](./presigned-urls) that AI workloads in your cloud infrastructure or user browsers utilize to access the bucket. Refer to [Bucket Policy Reference](https://docs.coreweave.com/docs/products/storage/object-storage/auth-access/bucket-access/bucket-policies) in the CoreWeave documentation.

```json
{
Expand Down Expand Up @@ -567,7 +571,7 @@ This section helps troubleshoot problems connecting to CoreWeave AI Object Stora
- Connecting to LOTA endpoints from W&B is not yet supported. To express interest, [contact support](mailto:support@wandb.com).
- **Access key and permission errors**
- Verify that your CoreWeave API Access Key is not expired.
- 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/products/storage/object-storage/auth-access/manage-access-keys/about) in the CoreWeave documentation.
- 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/auth-access/manage-access-keys/about) in the CoreWeave documentation.

### Google Cloud
This section helps troubleshoot problems connecting to Google Cloud Storage.
Expand Down
58 changes: 21 additions & 37 deletions platform/hosting/hosting-options/self-managed.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
description: Deploy W&B Self-Managed in production
title: Self-Managed
description: Deploy W&B Self-Managed on cloud or on-premises infrastructure
title: W&B Self-Managed deployment overview
sidebarTitle: Deployment overview
---

## Use W&B Self-Managed on cloud or on-prem infrastructure

<Note>
<Tip>
W&B recommends fully managed deployment options such as [W&B Multi-tenant Cloud](/platform/hosting/hosting-options/multi_tenant_cloud) or [W&B Dedicated Cloud](/platform/hosting/hosting-options/dedicated_cloud) deployment types. W&B fully managed services are simple and secure to use, with minimum to no configuration required.
</Note>
</Tip>

Deploy W&B Server on your [AWS, Google Cloud, or Azure cloud account](#deploy-wb-server-within-Self-Managed-cloud-accounts) or within your [on-premises infrastructure](#deploy-wb-server-in-on-prem-infrastructure).

Expand All @@ -18,52 +18,36 @@ Your IT/DevOps/MLOps team is responsible for:
- Managing upgrades and applying patches.
- Continuously maintaining your W&B Self-Managed W&B deployment.

<Tip>
<Info>
If your organization is subject to regulatory requirements, consider deploying on [W&B Dedicated Cloud](/platform/hosting/hosting-options/dedicated_cloud.mdx), which is maintained by W&B.
- W&B Dedicated Cloud's hosting platform meets the requirements of SOC 2 Type 2.
- When configured appropriately, a W&B Dedicated Cloud deployment complies with HIPAA.

Refer to the [W&B Security Portal](https://security.wandb.ai/) to request more information.
</Tip>
</Info>

{/* Check [Obtain your W&B Server license](#obtain-your-wb-server-license) to complete the setup. */}
## About the W&B Kubernetes Operator

## Deploy W&B Server within Self-Managed cloud accounts
Use the **W&B Kubernetes Operator** to deploy W&B Self-Managed. The operator simplifies deploying, administering, troubleshooting, and scaling W&B.

W&B recommends that you use official W&B Terraform scripts to deploy W&B Server into your AWS, Google Cloud, or Azure cloud account.
The operator connects to a central [deploy.wandb.ai](https://deploy.wandb.ai) server to request the latest specification changes for a given release channel and apply them. Updates are received as long as the license is valid. [Helm](https://helm.sh/) is used both to install the operator and for the operator to manage the W&B Kubernetes stack. The deployment consists of multiple pods, one per service; each pod name is prefixed with `wandb-`.

See specific cloud provider documentation for more information on how to set up W&B Server in [AWS](/platform/hosting/self-managed/aws-tf), [Google Cloud](/platform/hosting/self-managed/gcp-tf), or [Azure](/platform/hosting/self-managed/azure-tf).
Configuration follows a hierarchy: **Release Channel Values** (defaults from W&B), **User Input Values** (overrides via the System Console), and **Custom Resource Values** (your spec overrides both). For details, see [Deploy W&B with Kubernetes Operator](/platform/hosting/self-managed/operator).

## Deploy W&B Server in on-prem infrastructure
- To deploy W&B Self-Managed in public cloud or on-premises infrastructure, see [Deploy W&B with Kubernetes Operator](/platform/hosting/self-managed/operator).
- To deploy W&B Self-Managed to a custom cloud platform that is not AWS, the requirements are similar to the requirements for deploying in [on-prem infrastructure](#deploy-wb-server-in-on-prem-infrastructure).
- To deploy W&B Self-Managed in air-gapped environments, see [Deploy on Air-Gapped Kubernetes](/platform/hosting/self-managed/on-premises-deployments/kubernetes-airgapped).

To set up W&B Server in your on-premises infrastructure, you need to configure several infrastructure components. Some of those components include, but are not limited to:
## Required infrastructure

- (Strongly recommended) Kubernetes cluster
- MySQL 8 database cluster
All deployment options depend on the following infrastructure:
- Kubernetes
- MySQL 8 database
- Amazon S3-compatible object storage
- Redis cache cluster

See [Install on on-prem infrastructure](/platform/hosting/self-managed/bare-metal) for detailed instructions to install W&B Server on your on-prem infrastructure. W&B can provide recommendations for the different components and provide guidance through the installation process.

## Deploy W&B Server on a custom cloud platform
- Redis cache

You can deploy W&B Server to a cloud platform that is not AWS, Google Cloud, or Azure. Requirements for that are similar to that for deploying in [on-prem infrastructure](#deploy-wb-server-in-on-prem-infrastructure).
See [Requirements](/platform/hosting/self-managed/requirements) for details. W&B can provide recommendations for the different components and provide guidance through the installation process.

## Obtain your W&B Server license

You need a W&B trial license to complete your configuration of the W&B server. Open the [Deploy Manager](https://deploy.wandb.ai/deploy) to generate a free trial license.

<Note>
If you do not already have a W&B account, create one to generate your free license.

If you need an enterprise license for W&B Server which includes support for important security & other enterprise-friendly capabilities, [submit this form](https://wandb.ai/site/for-enterprise/self-hosted-trial) or reach out to your W&B team.
</Note>

The URL redirects you to a **Get a License for W&B Local** form. Provide the following information:

1. Choose a deployment type from the **Choose Platform** step.
2. Select the owner of the license or add a new organization in the **Basic Information** step.
3. Provide a name for the instance in the **Name of Instance** field and optionally provide a description in the **Description** field in the **Get a License** step.
4. Select the **Generate License Key** button.

A page displays with an overview of your deployment along with the license associated with the instance.
You need a W&B Server license before deploying. For step-by-step instructions, see [License](/platform/hosting/self-managed/requirements#license) on the Requirements page.
Loading