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
2 changes: 1 addition & 1 deletion platform/hosting/hosting-options/self-managed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You can optionally configure rate limits on your instance to maintain stability.

Before you deploy, make sure the following infrastructure is available. All W&B Self-Managed deployment options depend on these components:
- Kubernetes
- MySQL 8 database
- MySQL 8.4.x database
- Amazon S3-compatible object storage
- Redis cache

Expand Down
27 changes: 27 additions & 0 deletions platform/hosting/self-managed/operator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ keywords: ["W&B operator", "Helm chart", "Kubernetes CR", "operator install", "c
---

import SelfManagedMysqlRequirements from "/snippets/_includes/self-managed-mysql-requirements.mdx";
import SelfManagedMysqlEolUpgrade from "/snippets/_includes/self-managed-mysql-eol-upgrade.mdx";
import SelfManagedRedisRequirements from "/snippets/_includes/self-managed-redis-requirements.mdx";
import SelfManagedObjectStorageRequirements from "/snippets/_includes/self-managed-object-storage-requirements.mdx";
import ByobProvisioningLink from "/snippets/_includes/byob-provisioning-link.mdx";
Expand All @@ -31,10 +32,15 @@ Before deploying W&B with the Kubernetes Operator, ensure your infrastructure me
For additional context, see the [reference architecture](/platform/hosting/self-managed/ref-arch/) page.

### MySQL database

<SelfManagedMysqlEolUpgrade/>

<SelfManagedMysqlRequirements/>

For complete MySQL setup instructions including configuration parameters and database creation, see the [MySQL section in the requirements page](/platform/hosting/self-managed/requirements/#mysql-database).

If you are upgrading from MySQL 8.0.x, see [Upgrade MySQL to 8.4.x](#upgrade-mysql-to-84x).

### Redis
<SelfManagedRedisRequirements/>

Expand Down Expand Up @@ -1205,6 +1211,27 @@ You no longer need to update W&B Server application if you use the W&B Kubernete

The operator automatically updates your W&B Server application when a new version of the software of W&B is released.

## Upgrade MySQL to 8.4.x

MySQL 8.0.x is end of life. Self-Managed deployments must run a supported MySQL version that receives security patches and critical bug fixes. If you run community MySQL, install or upgrade to **MySQL 8.4.x**. If you use a managed service, run an engine version your provider documents as supported and patched (for example Amazon RDS for MySQL, Google Cloud SQL for MySQL, or Azure Database for MySQL). W&B has validated the platform against MySQL 8.4.0 and current 8.4.x releases.

These steps describe the sequence from W&B's perspective. For how to upgrade MySQL itself, including backups and version paths, follow your MySQL distribution's or cloud provider's documentation. The same sequence applies to [standard](/platform/hosting/self-managed/operator) and [air-gapped](/platform/hosting/self-managed/on-premises-deployments/kubernetes-airgapped) Operator deployments. In air-gapped environments, obtain MySQL 8.4.x software through your internal distribution process before you upgrade the database.

<Note>
Plan a maintenance window and notify users before you begin. Contact [Customer Support](mailto:support@wandb.com) or your W&B team if you have questions about compatibility or your deployment topology.
</Note>

1. Review MySQL release notes and documentation for your target version and any intervening versions for requirements and other details.
2. Prepare for maintenance.

Before you start the upgrade, you can run the [MySQL Shell upgrade checker](https://dev.mysql.com/doc/mysql-shell/8.4/en/mysql-shell-utilities-upgrade.html) against your database to surface and fix compatibility issues for your target version. Resolve any errors or warnings in the checker output before you proceed. Refer to the documentation for your MySQL distribution.
3. Shut down MySQL and take a full backup of your MySQL database according to your MySQL distribution's documentation.

MySQL will be unavailable during the upgrade. While the database is unavailable, W&B client applications can't connect and will experience temporary errors.
4. Upgrade MySQL to 8.4.x according to your MySQL distribution's documentation.
5. Restart MySQL and verify that it is operational.
6. When MySQL is up, run `wandb verify` to validate your W&B deployment. The command runs a series of checks and reports results to `STDOUT`. If it reports problems, make adjustments and run it again. For setup and login steps, see [Verify the installation](#verify-the-installation).
7. After validation completes, users can resume normal operations.

## Migrate self-managed instances to W&B Operator

Expand Down
3 changes: 3 additions & 0 deletions platform/hosting/self-managed/ref-arch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ keywords: ["infrastructure sizing", "MySQL requirements", "Redis setup", "produc
---

import SelfManagedVersionRequirements from "/snippets/_includes/self-managed-version-requirements.mdx";
import SelfManagedMysqlEolUpgrade from "/snippets/_includes/self-managed-mysql-eol-upgrade.mdx";
import SelfManagedNetworkingRequirements from "/snippets/_includes/self-managed-networking-requirements.mdx";
import SelfManagedSslTlsRequirements from "/snippets/_includes/self-managed-ssl-tls-requirements.mdx";

Expand Down Expand Up @@ -59,6 +60,8 @@ W&B supports deployment on [OpenShift Kubernetes clusters](https://www.redhat.co

### MySQL

<SelfManagedMysqlEolUpgrade/>

W&B stores metadata in a MySQL database. The database's performance and storage requirements depend on the shapes of the model parameters and related metadata. For example, the database grows in size as you track more training runs, and load on the database increases based on queries in run tables, user workspaces, and reports.

**W&B strongly recommends using managed database services** (such as AWS RDS Aurora MySQL, Google Cloud SQL for MySQL, or Azure Database for MySQL) for production deployments. Managed services provide automated backups, monitoring, high availability, and patching, and reduce operational complexity. See the [Cloud provider instance recommendations](#cloud-provider-instance-recommendations) section for specific service recommendations.
Expand Down
3 changes: 3 additions & 0 deletions platform/hosting/self-managed/requirements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ keywords: ["hardware requirements", "Kubernetes version", "MySQL version", "CPU
import SelfManagedVersionRequirements from "/snippets/_includes/self-managed-version-requirements.mdx";
import SelfManagedHardwareRequirements from "/snippets/_includes/self-managed-hardware-requirements.mdx";
import SelfManagedMysqlRequirements from "/snippets/_includes/self-managed-mysql-requirements.mdx";
import SelfManagedMysqlEolUpgrade from "/snippets/_includes/self-managed-mysql-eol-upgrade.mdx";
import SelfManagedMysqlDatabaseCreation from "/snippets/_includes/self-managed-mysql-database-creation.mdx";
import SelfManagedRedisRequirements from "/snippets/_includes/self-managed-redis-requirements.mdx";
import SelfManagedObjectStorageRequirements from "/snippets/_includes/self-managed-object-storage-requirements.mdx";
Expand Down Expand Up @@ -48,6 +49,8 @@ For complete Kubernetes requirements, including load balancer and ingress config

## MySQL database

<SelfManagedMysqlEolUpgrade/>

<SelfManagedMysqlRequirements/>

W&B recommends using managed database services such as AWS RDS Aurora MySQL, Google Cloud SQL for MySQL, or Azure Database for MySQL for production deployments. Managed services provide automated backups, monitoring, high availability, and patching, and they reduce operational complexity.
Expand Down
3 changes: 3 additions & 0 deletions snippets/_includes/self-managed-mysql-eol-upgrade.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<Important>
MySQL 8.0.x reached end of life in April 2026. W&B Self-Managed deployments must run a supported MySQL version that receives security patches and critical bug fixes. If you run community MySQL, install or upgrade to **MySQL 8.4.x**. If you use a managed service, run an engine version your provider documents as supported and patched (for example Amazon RDS for MySQL, Google Cloud SQL for MySQL, or Azure Database for MySQL). W&B has validated the platform against MySQL 8.4.0 and current 8.4.x releases. If you are still on MySQL 8.0.x, plan an upgrade using the steps in [Upgrade MySQL to 8.4.x](/platform/hosting/self-managed/operator#upgrade-mysql-to-84x).
</Important>
2 changes: 1 addition & 1 deletion snippets/_includes/self-managed-version-requirements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
| ------------ | -------------------------------------------- |
| Kubernetes | v1.34 or newer ([Supported Kubernetes versions](https://kubernetes.io/releases/patch-releases/)) |
| Helm | v3.x |
| MySQL | v8.0.x is required, v8.0.32 or newer; v8.0.44 or newer is recommended.<br/>Aurora MySQL 3.x releases, must be v3.05.2 or newer |
| MySQL | W&B Self-Managed deployments must run a supported MySQL version that receives security patches and critical bug fixes. Install or upgrade to **MySQL 8.4.x**, or use a managed service version that your provider documents as supported and patched.<br/>Aurora MySQL version strings differ from community MySQL versions. Use `SELECT version()` to see the full engine version string and `SELECT aurora_version()` to see the Aurora version. [Aurora MySQL version 3](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.MySQL80.html) is compatible with MySQL 8.0.x and is still supported. See [Amazon Aurora versioning](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.VersionPolicy.Versioning.html) and your cloud provider's documentation when you choose a target version. |
| Redis | v7.x |
Loading