Skip to content

Conversation

@andresgarciaf
Copy link
Contributor

Changes

What does this PR do?

This PR significantly enhances the Lakebridge installation documentation by expanding the pre-requisites section with comprehensive information about workspace requirements, network access, and security considerations for enterprise deployments.

Relevant implementation details

  • Databricks Workspace Requirements: Added detailed information about workspace access options (Production/Enterprise/Development/Free trial) and
    authentication methods (PAT vs Service Principal)
  • Enhanced Software Prerequisites: Reorganized Python and Java sections with clearer version requirements, installation links, and verification commands
  • Network & Environment Access (NEW): Added comprehensive section covering:
    • GitHub access requirements
    • Maven Central Repository access
    • PyPI (Python Package Index) access
    • Security-restricted environment considerations with whitelisting requirements
    • Optional private repository hosting guidance
  • Pre-Installation Checklist (NEW): Added a comprehensive 11-item checklist to help users verify all prerequisites before installation

Caveats/things to watch out for when reviewing:

  • All original content has been preserved - this is purely additive/reorganizational
  • MDX/Docusaurus formatting, images, and interactive components remain intact

Linked issues

N/A - This enhancement is based on field experience from STS (Shared Technical Services) engagements. During customer implementations, we identified common prerequisites and environment setup challenges that were not adequately documented. These additions will help customers, especially those in enterprise/hardened environments, prepare their infrastructure before installation and avoid common blockers.

Functionality

  • added relevant user documentation
  • added new CLI command
  • modified existing command: databricks labs lakebridge ...

Tests

  • manually tested - documentation reviewed for accuracy and completeness
  • added unit tests
  • added integration tests

@codecov
Copy link

codecov bot commented Nov 11, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.23%. Comparing base (db65960) to head (e0fbb0d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2141   +/-   ##
=======================================
  Coverage   65.23%   65.23%           
=======================================
  Files         100      100           
  Lines        8504     8504           
  Branches      875      875           
=======================================
  Hits         5548     5548           
  Misses       2769     2769           
  Partials      187      187           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link

github-actions bot commented Nov 11, 2025

✅ 51/51 passed, 11 flaky, 3m25s total

Flaky tests:

  • 🤪 test_validate_invalid_source_tech (177ms)
  • 🤪 test_validate_table_not_found (1ms)
  • 🤪 test_validate_successful_schema_check (285ms)
  • 🤪 test_validate_invalid_schema_check (1ms)
  • 🤪 test_validate_non_empty_tables (7ms)
  • 🤪 test_transpiles_informatica_to_sparksql_non_interactive[False] (19.311s)
  • 🤪 test_transpiles_informatica_to_sparksql_non_interactive[True] (19.539s)
  • 🤪 test_transpiles_informatica_to_sparksql (19.5s)
  • 🤪 test_transpile_teradata_sql_non_interactive[True] (23.788s)
  • 🤪 test_transpile_teradata_sql (6.147s)
  • 🤪 test_transpile_teradata_sql_non_interactive[False] (4.547s)

Running from acceptance #3032

@andresgarciaf andresgarciaf requested review from asnare and removed request for sundarshankar89 November 14, 2025 17:44
@andresgarciaf
Copy link
Contributor Author

@asnare can we merge this PR with yours? Adding additional elelments to the installation we seem in our engagements with Lakebridge.

@gueniai
Copy link
Collaborator

gueniai commented Nov 24, 2025

@andresgarciaf sorry for the delay in getting to this! Can you please resolve the conflicts? These changes are super helpful and I'd like them to go live ASAP

Copy link
Collaborator

@gueniai gueniai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andresgarciaf one important change from main was lost in the merge

Clarified Python version requirement and supported range.
@andresgarciaf andresgarciaf requested review from a team and removed request for asnare November 25, 2025 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants