Skip to content

Commit 66190f8

Browse files
committed
[DOCS-1383] Centralize and standard docs about Enterprise licenses
1 parent 41e2948 commit 66190f8

File tree

5 files changed

+267
-0
lines changed

5 files changed

+267
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This feature is available only for [W&B Dedicated Cloud]({{< relref "/guides/hosting/hosting-options/dedicated_cloud/_index.md" >}}) deployments, which include an Enterprise license.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!--
2+
INTERNAL PROCESS DOCUMENTATION - DO NOT PUBLISH
3+
4+
# Enterprise Feature Documentation Process
5+
6+
When documenting Enterprise features in W&B docs, follow these guidelines to maintain consistency:
7+
8+
## 1. Identifying Enterprise Features
9+
10+
Check the following sources:
11+
- The pricing page at https://wandb.ai/site/pricing/
12+
- The Enterprise licenses page at /guides/hosting/enterprise-licenses.md
13+
- Internal feature flags in the codebase
14+
- Product team announcements
15+
16+
## 2. Using Include Files
17+
18+
Use the appropriate include file based on the feature's availability:
19+
20+
- **For all Enterprise deployments**: Use `{{< readfile file="/_includes/enterprise-only.md" >}}`
21+
- **For Pro and Enterprise Cloud plans**: Use `{{< readfile file="/_includes/enterprise-cloud-only.md" >}}`
22+
- **For Self-Managed Enterprise only**: Use `{{< readfile file="/_includes/enterprise-self-managed-only.md" >}}`
23+
- **For Dedicated Cloud only**: Use `{{< readfile file="/_includes/enterprise-dedicated-cloud-only.md" >}}`
24+
- **For generic Enterprise features**: Use `{{< readfile file="/_includes/enterprise-feature.md" >}}`
25+
26+
## 3. Placement Guidelines
27+
28+
- Place the include at the beginning of the section describing the Enterprise feature
29+
- For entire pages about Enterprise features, place it after the page title
30+
- For subsections, place it immediately after the subsection heading
31+
32+
## 4. Updating the Enterprise Licenses Page
33+
34+
When a new Enterprise feature is added:
35+
1. Add it to the appropriate category in /guides/hosting/enterprise-licenses.md
36+
2. Include a brief description of what the feature does
37+
3. Note any deployment-specific restrictions
38+
39+
## 5. Review Checklist
40+
41+
Before publishing:
42+
- [ ] Is the feature correctly identified as Enterprise-only?
43+
- [ ] Is the appropriate include file used?
44+
- [ ] Is the feature listed on the Enterprise licenses page?
45+
- [ ] Does the description match the pricing page?
46+
47+
## 6. Staying Informed
48+
49+
To stay updated on Enterprise feature changes:
50+
- Subscribe to product update channels
51+
- Review pricing page changes monthly
52+
- Coordinate with the Sales Engineering team
53+
- Monitor customer feedback about feature availability
54+
55+
-->
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This feature requires an [Enterprise license]({{< relref "/guides/hosting/enterprise-licenses.md" >}}). See [Enterprise features]({{< relref "/guides/hosting/enterprise-licenses.md#enterprise-features" >}}) for more information.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This feature is available only for [W&B Self-Managed deployments]({{< relref "/guides/hosting/hosting-options/self-managed/_index.md" >}}) with an [Enterprise license]({{< relref "/guides/hosting/enterprise-licenses.md" >}}).
Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
---
2+
title: Enterprise Licenses
3+
description: Learn about W&B Enterprise licenses, what features they include, and how to obtain and configure them.
4+
displayed_sidebar: default
5+
---
6+
7+
# Enterprise Licenses
8+
9+
An Enterprise license unlocks advanced features in Weights & Biases designed for organizations that need enhanced security, compliance, and administrative 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.
10+
11+
## What is an Enterprise License?
12+
13+
An Enterprise license provides access to W&B's most advanced features for:
14+
- **Security**: Enhanced authentication, encryption, and access controls
15+
- **Compliance**: Audit logging, HIPAA compliance options, and data governance
16+
- **Administration**: Advanced user management, custom roles, and automation capabilities
17+
- **Scalability**: Performance optimizations and dedicated support
18+
19+
Enterprise licenses are available for both cloud and self-managed deployments of W&B.
20+
21+
## Deployment Options
22+
23+
### W&B Dedicated Cloud
24+
25+
[W&B Dedicated Cloud]({{< relref "/guides/hosting/hosting-options/dedicated_cloud/_index.md" >}}) deployments **automatically include** an Enterprise license. No additional configuration is required - all Enterprise features are available immediately upon provisioning.
26+
27+
**Key characteristics:**
28+
- Single-tenant infrastructure
29+
- Managed by W&B
30+
- Enterprise features enabled by default
31+
- Choice of cloud provider and region
32+
33+
### W&B Self-Managed
34+
35+
[W&B Self-Managed]({{< relref "/guides/hosting/hosting-options/self-managed/_index.md" >}}) deployments require obtaining and configuring an Enterprise license separately. Without an Enterprise license, Self-Managed deployments operate with limited features.
36+
37+
**Key characteristics:**
38+
- Deployed on your own infrastructure
39+
- Full control over data and deployment
40+
- Enterprise license must be obtained and configured
41+
- Supports air-gapped environments
42+
43+
## Enterprise Features
44+
45+
The following features require an Enterprise license:
46+
47+
### Security & Authentication
48+
- **Single Sign-On (SSO)**: Integration with identity providers like Okta, Auth0, and others
49+
- **SCIM Provisioning**: Automated user provisioning and deprovisioning
50+
- **Service Accounts**: Non-human accounts for CI/CD and automation
51+
- **IP Allowlisting**: Restrict access based on IP addresses (Self-Managed only)
52+
53+
### Access Management
54+
- **Custom Roles**: Create fine-grained roles beyond the default Member/Admin/View-Only roles
55+
- **View-Only Users**: Read-only access for stakeholders who need visibility without edit permissions
56+
- **Team-level Access Controls**: Advanced permissions at the team level
57+
- **Project-level Access Controls**: Granular permissions for individual projects
58+
59+
### Data & Compliance
60+
- **Audit Logs**: Detailed logs of user actions for compliance and security monitoring
61+
- **HIPAA Compliance**: Available with specific configuration options
62+
- **Customer-Managed Encryption Keys (CMEK)**: Use your own encryption keys for data at rest
63+
- **Bring Your Own Bucket (BYOB)**: Store artifacts in your own cloud storage (via Secure Storage Connector)
64+
- **Data Retention Controls**: Configure custom data retention policies
65+
66+
### Operations & Administration
67+
- **Automations**: Trigger workflows based on events (Pro and Enterprise for Cloud)
68+
- **Advanced Organization Dashboard**: Enhanced visibility into organization usage
69+
- **Priority Support**: Faster response times and dedicated support channels
70+
- **MySQL Database Support**: Use MySQL instead of Postgres (Self-Managed only)
71+
- **S3-compatible Storage**: Use S3 or compatible object storage (Self-Managed only)
72+
73+
### Performance & Scale
74+
- **Dedicated Resources**: Guaranteed compute and storage resources (Dedicated Cloud)
75+
- **Custom Rate Limits**: Higher API rate limits for enterprise workloads
76+
- **Multi-region Deployment**: Deploy across multiple regions (Dedicated Cloud)
77+
78+
## Obtaining an Enterprise License
79+
80+
### For W&B Dedicated Cloud
81+
82+
Enterprise licenses are included automatically. To get started with Dedicated Cloud:
83+
84+
1. [Contact W&B Sales](https://wandb.ai/site/contact-sales) to discuss your requirements
85+
2. Work with the W&B team to provision your dedicated instance
86+
3. All Enterprise features will be enabled upon deployment
87+
88+
### For W&B Self-Managed
89+
90+
To obtain an Enterprise license for Self-Managed deployments:
91+
92+
1. **Request an Enterprise Trial**:
93+
- Visit the [Self-Managed Enterprise Trial form](https://wandb.ai/site/for-enterprise/self-hosted-trial)
94+
- Or contact your W&B account team
95+
96+
2. **For Production Licenses**:
97+
- Contact [W&B Sales](https://wandb.ai/site/contact-sales)
98+
- Discuss your deployment size and requirements
99+
- Receive your production license key
100+
101+
## Configuring Enterprise Licenses (Self-Managed Only)
102+
103+
Once you have obtained an Enterprise license key, configure it in your Self-Managed deployment:
104+
105+
### For Kubernetes Deployments (Helm)
106+
107+
1. Update your `values.yaml` file:
108+
```yaml
109+
wandb:
110+
license: "YOUR_LICENSE_KEY_HERE"
111+
```
112+
113+
2. Upgrade your Helm release:
114+
```bash
115+
helm upgrade wandb wandb/wandb \
116+
--namespace wandb \
117+
--reuse-values \
118+
--set license=$LICENSE_KEY
119+
```
120+
121+
### For Terraform Deployments
122+
123+
1. Update your Terraform variables:
124+
```hcl
125+
variable "license" {
126+
default = "YOUR_LICENSE_KEY_HERE"
127+
}
128+
```
129+
130+
2. Apply the Terraform configuration:
131+
```bash
132+
terraform apply -var="license=$LICENSE_KEY"
133+
```
134+
135+
### For Docker Deployments
136+
137+
Set the license key as an environment variable:
138+
```bash
139+
docker run -d \
140+
-e LICENSE="YOUR_LICENSE_KEY_HERE" \
141+
-e OTHER_ENV_VARS \
142+
wandb/local
143+
```
144+
145+
### Via the UI (Post-Deployment)
146+
147+
For existing deployments without environment variable configuration:
148+
149+
1. Log in as an admin user
150+
2. Navigate to **System Settings**
151+
3. Find the **License** section
152+
4. Enter your new license key
153+
5. Save the changes
154+
155+
## Verifying Your License
156+
157+
To verify that your Enterprise license is active:
158+
159+
1. **For Admins**: Navigate to the System Settings page
160+
2. **Via API**: Check the `/system/settings` endpoint
161+
3. **Feature Availability**: Try accessing an Enterprise-only feature like Custom Roles
162+
163+
## License Renewal
164+
165+
Enterprise licenses have expiration dates. To ensure uninterrupted service:
166+
167+
- **30 days before expiration**: W&B will contact you about renewal
168+
- **Upon expiration**: Enterprise features will become unavailable
169+
- **To renew**: Contact [email protected] or your account team
170+
171+
## Common Issues
172+
173+
### License Not Recognized
174+
- Verify the license key is correctly formatted (no extra spaces)
175+
- Ensure the license hasn't expired
176+
- Check that the license is set in the correct configuration location
177+
178+
### Features Not Available After Setting License
179+
- Restart your W&B services after setting the license
180+
- Verify the license includes the specific features you're trying to access
181+
- Check system logs for any license validation errors
182+
183+
### License Expiration Warnings
184+
- Monitor the System Settings page for expiration notifications
185+
- Set up alerts for license expiration in your monitoring system
186+
- Keep your account team contact information up to date
187+
188+
## Best Practices
189+
190+
1. **Store License Keys Securely**: Treat license keys as sensitive credentials
191+
2. **Monitor Expiration**: Set up alerts 30-60 days before license expiration
192+
3. **Document Configuration**: Keep records of where and how licenses are configured
193+
4. **Test in Staging**: Validate license updates in a non-production environment first
194+
5. **Plan for Renewals**: Budget and plan for license renewals in advance
195+
196+
## Getting Help
197+
198+
For assistance with Enterprise licenses:
199+
200+
- **Technical Issues**: Contact [email protected]
201+
- **License Procurement**: Contact your W&B account team or [email protected]
202+
- **Feature Questions**: Consult this documentation or contact support
203+
204+
## Related Resources
205+
206+
- [W&B Pricing](https://wandb.ai/site/pricing/)
207+
- [Self-Managed Installation Guide]({{< relref "/guides/hosting/hosting-options/self-managed/_index.md" >}})
208+
- [Dedicated Cloud Overview]({{< relref "/guides/hosting/hosting-options/dedicated_cloud/_index.md" >}})
209+
- [Security & Compliance]({{< relref "/guides/hosting/data-security/_index.md" >}})

0 commit comments

Comments
 (0)