Skip to content
Open
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
93 changes: 77 additions & 16 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,22 +79,11 @@
"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/cloud-deployments/terraform",
"platform/hosting/self-managed/on-premises-deployments/kubernetes",
"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 @@ -3961,6 +3950,78 @@
{
"source": "/weave/guides/tools/limits",
"destination": "/weave/details/limits"
},
{
"source": "/platform/hosting/operator",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/platform/hosting/self-managed/bare-metal",
"destination": "/platform/hosting/self-managed/on-premises-deployments/kubernetes"
},
{
"source": "/platform/hosting/self-managed/operator-airgapped",
"destination": "/platform/hosting/self-managed/on-premises-deployments/kubernetes-airgapped"
},
{
"source": "/platform/hosting/self-managed/aws-tf",
"destination": "/platform/hosting/self-managed/cloud-deployments/terraform"
},
{
"source": "/platform/hosting/self-managed/gcp-tf",
"destination": "/platform/hosting/self-managed/cloud-deployments/terraform"
},
{
"source": "/platform/hosting/self-managed/azure-tf",
"destination": "/platform/hosting/self-managed/cloud-deployments/terraform"
},
{
"source": "/ja/platform/hosting/operator",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ja/platform/hosting/self-managed/bare-metal",
"destination": "/platform/hosting/self-managed/on-premises-deployments/kubernetes"
},
{
"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/cloud-deployments/terraform"
},
{
"source": "/ja/platform/hosting/self-managed/gcp-tf",
"destination": "/platform/hosting/self-managed/cloud-deployments/terraform"
},
{
"source": "/ja/platform/hosting/self-managed/azure-tf",
"destination": "/platform/hosting/self-managed/cloud-deployments/terraform"
},
{
"source": "/ko/platform/hosting/operator",
"destination": "/platform/hosting/self-managed/operator"
},
{
"source": "/ko/platform/hosting/self-managed/bare-metal",
"destination": "/platform/hosting/self-managed/on-premises-deployments/kubernetes"
},
{
"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/cloud-deployments/terraform"
},
{
"source": "/ko/platform/hosting/self-managed/gcp-tf",
"destination": "/platform/hosting/self-managed/cloud-deployments/terraform"
},
{
"source": "/ko/platform/hosting/self-managed/azure-tf",
"destination": "/platform/hosting/self-managed/cloud-deployments/terraform"
}
],
"baseUrl": "https://docs.wandb.ai"
Expand Down
12 changes: 3 additions & 9 deletions lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,8 @@ exclude = [
'(http|https)://0\.0\.0\.0',
'(http|https)://localhost',
'(http|https)://127\.0\.0\.1',
# Image file extensions (with or without trailing slash)
'\.(png|jpg|jpeg|gif|svg|webp|ico)(/)?$',
# Image paths - Mintlify rewrites /images/ paths during build
# Exclude both absolute paths and full URLs to image directories
# Match any URL containing /images/ (works for both relative and absolute paths)
'/images/',
# Match full URLs to image directories on any domain (including preview sites)
'(http|https)://[^/]+/images/',
'(http|https)://kubeflow\.mysite\.com',
'(http|https)://my-fake-url\.com',
Expand All @@ -71,10 +66,9 @@ exclude = [
'(http|https)://.*\.?portal\.azure\.com',
'(http|https)://.*\.?hhs\.gov',
'(http|https)://([^/]+\.)?github\.com/wandb',
'(http|https)://(api|app|deploy|docs|www)\.wandb\.(ai|com)',
'(http|https)://wandb\.(ai|com)',
# DSPy documentation - redirects from vercel.app to dspy.ai
'(http|https)://dspy-docs\.vercel\.app',
'(http|https)://wandb\.github\.io',
'(http|https)://(api|app|charts|deploy|docs|security|www)\.wandb\.(ai|com)(/.*)?',
'(http|https)://wandb\.(ai|com)(/.*)?'
]

# File/directory paths to exclude from checking
Expand Down
4 changes: 4 additions & 0 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
38 changes: 30 additions & 8 deletions platform/hosting/hosting-options/self-managed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,21 @@ title: Self-Managed
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>

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).
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).

### W&B Kubernetes Operator

W&B uses the **W&B Kubernetes Operator** to deploy and manage all Self-Managed deployments. The operator simplifies deploying, administering, troubleshooting, and scaling your W&B Server deployments on Kubernetes.

**Why the operator?** The W&B Server architecture continuously evolves to expand capabilities and improve performance, scalability, and administration. Before 2024, any Kubernetes-related change required manually updating Terraform modules, which wasn't scalable. The operator connects to a central deployment server to automatically receive and apply the latest specification changes for your release channel, ensuring your deployment stays up to date.

The operator uses Helm charts to manage the W&B Kubernetes stack and provides a configuration hierarchy that enables maximum flexibility while allowing W&B to release new images, configurations, and features automatically.

<Note>
W&B no longer supports deploying W&B Server using Docker, Docker Compose, or unmanaged Kubernetes deployments. All deployments must use the W&B Kubernetes Operator.
</Note>

For complete operator deployment instructions, see [Deploy with Kubernetes Operator](/platform/hosting/self-managed/operator).

Your IT/DevOps/MLOps team is responsible for:
- Provisioning your deployment.
Expand All @@ -23,27 +37,35 @@ If your organization is subject to regulatory requirements, consider deploying o
- 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.
Refer to the [W&B Security Portal](https://security.wandb.ai) to request more information.
</Tip>

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

## Deploy W&B Server within Self-Managed cloud accounts

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.
W&B recommends using the **W&B Kubernetes Operator** for all deployments. The operator is the recommended and only supported deployment method.

For cloud deployments, you have two options:

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).
1. **Full infrastructure provisioning with Terraform**: Use W&B Terraform modules to provision complete infrastructure (VPC, databases, Kubernetes clusters, load balancers) and deploy W&B Server. See [Deploy with Terraform on public cloud](/platform/hosting/self-managed/cloud-deployments/terraform) for AWS, Google Cloud, or Azure.

2. **Deploy operator on existing Kubernetes**: If you already have a Kubernetes cluster, deploy the W&B Kubernetes Operator directly. See [Deploy with Kubernetes Operator](/platform/hosting/operator) for complete instructions.

## Deploy W&B Server in on-prem infrastructure

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:
The **W&B Kubernetes Operator** is the recommended and only supported method for deploying W&B on on-premises infrastructure.

To set up W&B Server in your on-premises infrastructure, you need to configure several infrastructure components:

- (Strongly recommended) Kubernetes cluster
- Kubernetes cluster (required)
- MySQL 8 database cluster
- Amazon S3-compatible object storage
- 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.
For complete deployment instructions, see [Deploy with Kubernetes Operator](/platform/hosting/self-managed/operator). The operator guide includes environment-specific considerations for on-premises deployments, including load balancer configuration, persistent storage, DNS, and certificate management.

For air-gapped or fully disconnected environments, see [Deploy on Air-Gapped Kubernetes](/platform/hosting/self-managed/on-premises-deployments/kubernetes-airgapped).

## Deploy W&B Server on a custom cloud platform

Expand Down
Loading