diff --git a/docs.json b/docs.json index cce4a0ac8..03dbd8b84 100644 --- a/docs.json +++ b/docs.json @@ -89,7 +89,6 @@ { "group": "Install on public cloud", "pages": [ - "platform/hosting/self-managed/install-on-public-cloud", "platform/hosting/self-managed/aws-tf", "platform/hosting/self-managed/gcp-tf", "platform/hosting/self-managed/azure-tf" @@ -115,6 +114,7 @@ "platform/hosting/privacy-settings", "platform/hosting/smtp", "platform/hosting/env-vars", + "platform/hosting/enterprise-licenses", { "group": "Identity and access management (IAM)", "pages": [ diff --git a/platform/hosting/enterprise-licenses.mdx b/platform/hosting/enterprise-licenses.mdx new file mode 100644 index 000000000..872e69a3c --- /dev/null +++ b/platform/hosting/enterprise-licenses.mdx @@ -0,0 +1,172 @@ +--- +title: Enterprise Licenses +description: Learn about W&B Enterprise licenses, what features they include, and how to obtain and configure them. +--- + +An Enterprise license unlocks advanced W&B features designed for organizations that need enhanced capabilities in areas of security, compliance, or administrative. See the list of [Enterprise features](#enterprise-features). + +- **Security**: Enhanced authentication, encryption, and access controls. +- **Compliance**: Audit logging, HIPAA compliance options, and data governance controls. +- **Administration**: Advanced user management features like SCIM provisioning, custom roles, and automation capabilities. + +This page provides a comprehensive overview of Enterprise licenses, including what features they enable, how to obtain them, and how to configure them for your deployment. + +## Deployment Options +Enterprise licenses are available for W&B Dedicated Cloud and Self-Managed deployments. + +- [W&B Dedicated Cloud](/platform/hosting/hosting-options/dedicated_cloud) provides single-tenant infrastructure managed by W&B, deployed in Google Cloud. Dedicated Cloud deployments automatically include an Enterprise license. No additional configuration is required, and all Enterprise features are available immediately upon provisioning. +- [W&B Self-Managed](/platform/hosting/hosting-options/self-managed) is deployed on your own infrastructure, providing full control over your deployment and data. Air-gapped deployments are supported. To access Enterprise features on W&B Self-Managed, you must obtain and configure an Enterprise license. Without an Enterprise license, Self-Managed deployments operate with limited features. + +## Obtain an Enterprise license +This section explains how to obtain an Enterprise license. Select a tab to continue. + + + +W&B Dedicated Cloud includes an Enterprise license and no action is required. To get started with Dedicated Cloud: + +1. Contact [Sales](https://wandb.ai/site/contact-sales) to discuss your requirements. +2. Work with W&B to provision your dedicated instance. +3. All Enterprise features will be enabled upon deployment. + + +To obtain an Enterprise license for Self-Managed deployments: + +- To request an Enterprise trial license for evaluation purposes, visit the [Self-Managed Enterprise Trial form](https://wandb.ai/site/for-enterprise/self-hosted-trial) or contact [Sales](mailto:sales@wandb.ai). +- To request an Enterprise license for a production deployment, contact [Sales](https://wandb.ai/site/contact-sales) to discuss your deployment requirements and sizing and receive your license details. + +Store license keys securely and treat them as sensitive credentials. + + + + +## Configure an Enterprise license +After you [obtain an Enterprise license](#obtain-an-enterprise-license) for W&B Self-Managed, you can configure it programmatically using your deployment tool, such as Helm or Terraform, or you can configure it in the W&B App after deployment. Select a tab to continue. + + + +1. Update your `values.yaml` file: + ```yaml + wandb: + license: "YOUR_LICENSE_KEY_HERE" + ``` + +2. Upgrade your Helm release: + ```bash + helm upgrade wandb wandb/wandb \ + --namespace wandb \ + --reuse-values \ + --set license=$LICENSE_KEY + ``` + + +1. Update your Terraform variables: + ```hcl + variable "license" { + default = "YOUR_LICENSE_KEY_HERE" + } + ``` + +2. Apply the Terraform configuration: + ```bash + terraform apply -var="license=$LICENSE_KEY" + ``` + + +For existing deployments without environment variable configuration: + +1. Log in as an admin user +2. Navigate to **System Settings** +3. Find the **License** section +4. Enter your new license key +5. Save the changes + + +Deploying W&B on Docker is deprecated. W&B strongly encourages migrating to a [Kubernetes Operator]() deployment managed by Helm or Terraform. Refer to [Reference architecture](/platform/hosting/self-managed/ref-arch.mdx) or contact [Support](mailto:support@wandb.ai) for guidance. +Set the license key as an environment variable: +```bash +docker run -d \ + -e LICENSE="YOUR_LICENSE_KEY_HERE" \ + -e OTHER_ENV_VARS \ + wandb/local +``` + + + +Next, [verify your Enterprise license](#verify-or-update-an-enterprise-license). + +## Verify or update an Enterprise license + +As an instance admin, follow these steps to verify that your Enterprise license is active: +1. In the W&B App, click your user profile icon in the top right, then click **System Console**. +1. Go to the **License** tab. +1. To verify the license key, click **View license online**. If the license is not configured correctly, see [Common issues](#common-issues). +1. To update the license key, click **Update License**. This is required if your previous license expires and you [renew it](#renew-an-enterprise-license). + +## Renew an Enterprise license +A trial or production Enterprise license has an expiration date. To ensure uninterrupted service W&B contacts you: +- 30 days before the license expires +- When the license has expired + +To renew your license: +1. Contact your account team or [Support](mailto:support@wandb.ai) to obtain a new license key. +1. Follow the steps to [update the license](#verify-or-update-an-enterprise-license). + +## Enterprise features +The following features require an Enterprise license: + +### Security & Authentication +- **Single Sign-On (SSO)**: Integration with identity providers like Okta, Auth0, and others +- **SCIM Provisioning**: Automated user provisioning and deprovisioning +- **Service Accounts**: Non-human accounts for CI/CD and automation +- **IP Allowlisting**: Restrict access based on IP addresses (Self-Managed only) + +### Access Management +- **Custom Roles**: Create fine-grained roles beyond the default Member/Admin/View-Only roles +- **View-Only Users**: Read-only access for stakeholders who need visibility without edit permissions +- **Team-level Access Controls**: Advanced permissions at the team level +- **Project-level Access Controls**: Granular permissions for individual projects + +### Data & Compliance +- **Audit Logs**: Detailed logs of user actions for compliance and security monitoring +- **HIPAA Compliance**: Available with specific configuration options +- **Customer-Managed Encryption Keys (CMEK)**: Use your own encryption keys for data at rest +- **Bring Your Own Bucket (BYOB)**: Store artifacts in your own cloud storage (via Secure Storage Connector) +- **Data Retention Controls**: Configure custom data retention policies + +### Operations & Administration +- **Automations**: Trigger workflows based on events (Pro and Enterprise for Cloud) +- **Advanced Organization Dashboard**: Enhanced visibility into organization usage +- **Priority Support**: Faster response times and dedicated support channels +- **MySQL Database Support**: Use MySQL instead of Postgres (Self-Managed only) +- **S3-compatible Storage**: Use S3 or compatible object storage (Self-Managed only) + +### Performance & Scale +- **Dedicated Resources**: Guaranteed compute and storage resources (Dedicated Cloud) +- **Custom Rate Limits**: Higher API rate limits for enterprise workloads +- **Multi-region Deployment**: Deploy across multiple regions (Dedicated Cloud) + +## Common Issues + +### License Not Recognized +- Verify the license key is correctly formatted (no extra spaces) +- Ensure the license hasn't expired +- Check that the license is set in the correct configuration location + +### Features Not Available After Setting License +- Restart your W&B services after setting the license +- Verify the license includes the specific features you're trying to access +- Check system logs for any license validation errors + +### License Expiration Warnings +- Monitor the System Settings page for expiration notifications +- Set up alerts for license expiration in your monitoring system +- Keep your account team contact information up to date + +### Get support +For assistance with Enterprise licenses, contact your account team, [Sales](mailto:sales@wandb.ai), or [Support](mailto:support@wandb.ai). + +## Additional resources +- [W&B Pricing](/pricing) +- [W&B Self-Managed](/platform/hosting/hosting-options/self-managed) +- [W&B Dedicated Cloud](/platform/hosting/hosting-options/dedicated_cloud) +- [Security & Compliance](/security)