# Databricks Partner Well-Architected Framework

> Best practices and reference architectures for technology partners integrating with the Databricks Lakehouse platform.

## About This Site

This documentation helps Databricks technology partners:
- Integrate their products with Databricks (Connected ISV Partners)
- Share data through Delta Sharing and Databricks Marketplace (Data Collaboration)
- Build applications on the Databricks platform (Built On Databricks)

### Firefly Analytics (/firefly)
A production-ready reference implementation showcasing Partner Well-Architected Framework patterns. Firefly is an open-source SaaS application built entirely on Databricks demonstrating custom authentication, multi-tenancy, embedded apps, and best practices for Built-On partners.

Live demo: https://www.firefly-analytics.com/
Source code: Coming soon

### AI-Ready Documentation (/ai-ready)
Explains how the PWAF is optimized for AI assistants and modern development workflows, including llms.txt structure, hidden context markers, and best practices for using AI tools (Claude, Cursor, Copilot, ChatGPT) with this documentation.

## Quick Start Guides

### For Connected ISV Partners
1. Review integration requirements [VALIDATION]: /isv-partners/integration-requirements
2. Choose integration pattern [DESIGN]: /isv-partners/integration-patterns
3. Implement OAuth authentication [IMPLEMENTATION]: /isv-partners/lakehouse-patterns/access-auth/
4. Configure telemetry [IMPLEMENTATION]: /isv-partners/telemetry-attribution/

### For Data Collaboration Partners
1. Understand Delta Sharing [OVERVIEW]: /data-collaboration/delta-shares
2. Design data as a product [DESIGN]: /data-collaboration/data-products
3. Choose sharing pattern (D2D/D2O/O2D) [IMPLEMENTATION]: /data-collaboration/sharing-patterns/
4. Configure recipients & authentication [IMPLEMENTATION]: /data-collaboration/access-distribution/recipients
5. Set up marketplace listing [DISTRIBUTION]: /data-collaboration/access-distribution/listings

### For Built-On Partners
1. Choose deployment model [DESIGN]: /built-on/deployment-models/
2. Design governance & isolation [ARCHITECTURE]: /built-on/architecture/governance
3. Implement cost management & tagging [IMPLEMENTATION]: /built-on/architecture/cost-management
4. Plan for scale [ARCHITECTURE]: /built-on/architecture/scale-limits
5. Automate with Terraform/DABs [OPERATIONS]: /built-on/operations/automation
6. Build customer onboarding [OPERATIONS]: /built-on/operations/onboarding

## Common Questions & Where to Find Answers

### Authentication & Security
- "How do I implement OAuth?" → /isv-partners/lakehouse-patterns/access-auth/
- "What's the difference between OAuth M2M and U2M?" → /isv-partners/lakehouse-patterns/access-auth/oauth-reference
- "How do I secure multi-tenant data?" → /built-on/architecture/governance
- "What are Unity Catalog best practices?" → /built-on/architecture/governance

### Cost & Attribution
- "How do I track per-customer usage?" → /built-on/architecture/cost-management
- "What telemetry is required for Built-On partners?" → /built-on/architecture/cost-management
- "What telemetry is required for Connected ISV partners?" → /isv-partners/telemetry-attribution/
- "How do I implement tagging?" → /built-on/architecture/cost-management

### Deployment & Architecture
- "Should I use workspace-per-tenant or shared workspace?" → /built-on/deployment-models/workspace-models
- "What is the Side Car model?" → /built-on/deployment-models/side-car
- "What is the Hybrid model?" → /built-on/deployment-models/hybrid
- "When should I use Partner Hosted vs Customer Managed?" → /built-on/deployment-models/

### Data Sharing
- "How do I share data with Databricks customers?" → /data-collaboration/sharing-patterns/d2d
- "How do I share data with non-Databricks users?" → /data-collaboration/sharing-patterns/d2o
- "What are pre-signed URLs in Delta Sharing?" → /data-collaboration/sharing-patterns/d2o
- "How do I implement dynamic entitlements?" → /data-collaboration/access-distribution/entitlements

## Partner Program Requirements

### Built-On Program
- Tagging requirements: See Partner Portal and /built-on/architecture/cost-management
- Governance standards: /built-on/architecture/governance
- Automation with Terraform/DABs: /built-on/operations/automation
- Customer Managed deployments have limited program benefits: /built-on/deployment-models/customer-managed

### Connected ISV Validation
- Must meet all integration requirements: /isv-partners/integration-requirements
- OAuth implementation required (M2M or U2M): /isv-partners/lakehouse-patterns/access-auth/
- Telemetry standards: /isv-partners/telemetry-attribution/
- Unity Catalog support encouraged

### Data Collaboration Partners
- Delta Sharing setup: /data-collaboration/delta-shares
- Marketplace listing guidelines: /data-collaboration/access-distribution/listings
- Data product design: /data-collaboration/data-products

## Sections

### Connected ISV Partners (/isv-partners/)
Integration patterns, telemetry implementation, and best practices for partners connecting to Databricks.

Key topics:
- Becoming a Validated Partner [OVERVIEW]: /isv-partners/integration-overview/
- Integration Requirements [VALIDATION REQUIREMENTS]: /isv-partners/integration-requirements
- Integration Patterns [DESIGN PATTERNS]: /isv-partners/integration-patterns
- Telemetry & Attribution [IMPLEMENTATION GUIDE]: /isv-partners/telemetry-attribution/
  - SQL Drivers: /isv-partners/telemetry-attribution/sql-drivers
  - Lakebase: /isv-partners/telemetry-attribution/lakebase
- Product Categories [GUIDANCE BY TYPE]: /isv-partners/product-categories/
  - BI & Visualization: /isv-partners/product-categories/bi
  - AI & ML: /isv-partners/product-categories/ai-ml
- Databricks Design Patterns [ARCHITECTURE PATTERNS]: /isv-partners/lakehouse-patterns/
- OAuth Authentication [IMPLEMENTATION GUIDE]: /isv-partners/lakehouse-patterns/access-auth/
  - OAuth U2M (User-to-Machine): /isv-partners/lakehouse-patterns/access-auth/oauth-u2m
  - OAuth M2M (Machine-to-Machine): /isv-partners/lakehouse-patterns/access-auth/oauth-m2m
  - OAuth Reference: /isv-partners/lakehouse-patterns/access-auth/oauth-reference

Cross-references:
- For Unity Catalog patterns, see: /built-on/architecture/governance
- For Firefly reference implementation, see: /firefly

### Data Collaboration (/data-collaboration/)
Best practices for data providers sharing data via Delta Sharing and Databricks Marketplace.

Key topics:
- Getting Started [OVERVIEW]: /data-collaboration/getting-started
- Delta Sharing [OVERVIEW]: /data-collaboration/delta-shares
- Data as a Product [DESIGN GUIDE]: /data-collaboration/data-products
- AI Readiness [DESIGN GUIDE]: /data-collaboration/ai-readiness
- Sharing Patterns [IMPLEMENTATION GUIDE]:
  - D2D (Databricks-to-Databricks) [RECOMMENDED]: /data-collaboration/sharing-patterns/d2d
  - D2O (Databricks-to-Open): /data-collaboration/sharing-patterns/d2o
  - O2D (Open-to-Databricks): /data-collaboration/sharing-patterns/o2d
  - Bi-directional Sharing: /data-collaboration/sharing-patterns/bidirectional
  - Egress Considerations: /data-collaboration/sharing-patterns/egress-considerations
- Access Distribution [IMPLEMENTATION GUIDE]:
  - Recipients & Authentication: /data-collaboration/access-distribution/recipients
  - Dynamic Entitlements: /data-collaboration/access-distribution/entitlements
  - Marketplace Listings: /data-collaboration/access-distribution/listings
- Operations [OPERATIONS GUIDE]:
  - Access Management: /data-collaboration/operations/access-management
  - Monitoring: /data-collaboration/operations/monitoring
  - Operations Runbook: /data-collaboration/operations/runbook

Cross-references:
- For OAuth authentication, see: /isv-partners/lakehouse-patterns/access-auth/
- For Unity Catalog, see: /built-on/architecture/governance

### Built On Databricks (/built-on/)
Architecture guidance for designing, deploying, and operating intelligent data and AI products on Databricks.

Key topics:
- Deployment Models [ARCHITECTURE DECISIONS]: /built-on/deployment-models/
  - Partner Hosted (SaaS) [RECOMMENDED FOR SAAS]: /built-on/deployment-models/partner-hosted
    - SaaS Workspace Models (Multi-tenant vs Per-tenant): /built-on/deployment-models/workspace-models
  - Hybrid (Partner control plane, customer data plane): /built-on/deployment-models/hybrid
  - Side Car (Federated model): /built-on/deployment-models/side-car
  - Customer Managed (Limited program benefits): /built-on/deployment-models/customer-managed
- Pillars & Core Principles [ARCHITECTURE GUIDE]: /built-on/pillars/
  - Governance (Unity Catalog, multi-tenancy) [ARCHITECTURE]: /built-on/architecture/governance
  - Cost Management (Tagging, attribution, budgets) [IMPLEMENTATION]: /built-on/architecture/cost-management
  - Scale & Limits (Quotas, capacity planning) [REFERENCE]: /built-on/architecture/scale-limits
  - Automation (Terraform, DABs, CI/CD) [OPERATIONS]: /built-on/operations/automation
  - Customer and User Onboarding (Provisioning workflows) [OPERATIONS]: /built-on/operations/onboarding

Cross-references:
- For reference implementation, see: /firefly
- For telemetry requirements, see: /isv-partners/telemetry-attribution/
- For OAuth patterns, see: /isv-partners/lakehouse-patterns/access-auth/
- For Delta Sharing in multi-tenant apps, see: /data-collaboration/sharing-patterns/

## Official Databricks Documentation

For complete API references and tutorials, see:
- Databricks Documentation: https://docs.databricks.com/
- REST API Reference: https://docs.databricks.com/api/
- Python SDK: https://databricks-sdk-py.readthedocs.io/
- Terraform Provider: https://registry.terraform.io/providers/databricks/databricks/

## Key APIs for Partners

### Delta Sharing & Marketplace
- Shares API: https://docs.databricks.com/api/workspace/shares
- Recipients API: https://docs.databricks.com/api/workspace/recipients
- Providers API: https://docs.databricks.com/api/workspace/providers
- Python SDK (Sharing): https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sharing/
- Python SDK (Marketplace): https://databricks-sdk-py.readthedocs.io/en/latest/workspace/marketplace/

### Authentication
- OAuth M2M: https://docs.databricks.com/aws/en/dev-tools/auth/oauth-m2m.html
- OAuth U2M: https://docs.databricks.com/aws/en/dev-tools/auth/oauth-u2m.html
- Service Principals: https://docs.databricks.com/aws/en/admin/users-groups/service-principals.html

### Platform
- Unity Catalog: https://docs.databricks.com/aws/en/data-governance/unity-catalog/
- Databricks SQL: https://docs.databricks.com/aws/en/sql/
- Lakeflow Connect: https://docs.databricks.com/aws/en/connect/
- Model Serving: https://docs.databricks.com/aws/en/machine-learning/model-serving/

## Contact

- Partner Portal: https://partners.databricks.com/
- Databricks: https://www.databricks.com/