Configurazione tipica del progetto Lakebase con bundle di automazione dichiarativa

Importante

Il supporto per i Declarative Automation Bundles di Lakebase è in fase Beta.

Questa pagina mostra un bundle completo di bundle di automazione dichiarativa per un progetto di scalabilità automatica di Lakebase pronto per la produzione con le funzionalità più usate:

  • Ramo di produzione protetto
  • Endpoint di lettura/scrittura a disponibilità elevata con repliche secondarie leggibili
  • Autorizzazione a livello CAN_MANAGE di area di lavoro inline per un'entità servizio
  • Streaming continuo di tabelle sincronizzate da Unity Catalog
  • Collegamento di Unity Catalog per il database Lakebase
  • App Databricks connessa al progetto Lakebase

Per un'introduzione dettagliata ai bundle di automazione dichiarativa con Lakebase, vedere Gestire Lakebase con bundle di automazione dichiarativa.

Prerequisiti

Prima di iniziare, è necessario disporre di quanto segue:

Completare la configurazione del bundle

Il bundle usa le variabili per tutti i valori specifici dell'area di lavoro. Impostarli in un .databricks/bundle/<target>/variables.json file o passarli in fase di distribuzione con --var.

Quando si crea un progetto, Azure Databricks crea automaticamente un production ramo, un primary endpoint di lettura/scrittura, un ruolo Postgres proprietario associato all'identità e un databricks_postgres database. Per configurare queste risorse create in modo implicito, dichiararle con replace_existing: true.

bundle:
  name: lakebase-typical-project

variables:
  project_id:
    description: 'Lakebase project ID (lowercase, hyphen-delimited)'
    default: 'my-lakebase-project'
  display_name:
    description: 'Human-readable project name shown in the UI'
    default: 'My Lakebase project'
  pg_version:
    description: 'Postgres major version'
    default: 17
  min_cu:
    description: 'Minimum compute units on the default endpoint'
    default: 0.5
  max_cu:
    description: 'Maximum compute units on the default endpoint'
    default: 4.0
  suspend_timeout:
    description: 'Idle time before the default endpoint suspends. Ignored when no_suspension is true.'
    default: '300s'
  admin_sp_app_id:
    description: 'Application ID of the service principal to grant CAN_MANAGE on the project'
    default: '<your-sp-application-id>'
  source_table:
    description: 'Unity Catalog three-part name of the Delta table to sync (catalog.schema.table)'
    default: '<catalog>.<schema>.<table>'
  primary_key_column:
    description: 'Primary key column of the source Delta table'
    default: '<pk>'
  storage_catalog:
    description: 'Unity Catalog catalog where the sync pipeline stores its metadata'
    default: '<catalog>'
  storage_schema:
    description: 'Unity Catalog schema where the sync pipeline stores its metadata'
    default: '<schema>'
  app_name:
    description: 'Databricks App name (must be unique in the workspace)'
    default: 'my-lakebase-app'
  uc_catalog_id:
    description: 'Name to register the Lakebase database in Unity Catalog'
    default: 'my_lakebase_uc_catalog'
  database_name:
    description: 'Postgres-internal name for the app database'
    default: 'app_database'

targets:
  prod:
    default: true
    workspace:
      host: https://<your-workspace>.cloud.databricks.com

    resources:
      # Project — top-level container for branches, endpoints, and databases.
      # The permissions block grants workspace-level CAN_MANAGE to the service principal.
      postgres_projects:
        lakebase_project:
          project_id: ${var.project_id}
          # purge_on_delete: true  # Uncomment to permanently delete on destroy (default: soft delete, 7-day retention).
          pg_version: ${var.pg_version}
          display_name: ${var.display_name}
          default_endpoint_settings:
            autoscaling_limit_min_cu: ${var.min_cu}
            autoscaling_limit_max_cu: ${var.max_cu}
            suspend_timeout_duration: ${var.suspend_timeout}
          permissions:
            - service_principal_name: ${var.admin_sp_app_id}
              level: CAN_MANAGE

      # Configure the implicitly created production branch as protected.
      postgres_branches:
        production:
          branch_id: production
          parent: ${resources.postgres_projects.lakebase_project.name}
          no_expiry: true
          is_protected: true
          replace_existing: true

      # Configure the implicitly created primary endpoint with HA.
      # HA requires no_suspension: true. group.min: 2 adds a standby for automatic failover.
      postgres_endpoints:
        primary:
          endpoint_id: primary
          parent: ${resources.postgres_branches.production.name}
          endpoint_type: ENDPOINT_TYPE_READ_WRITE
          autoscaling_limit_min_cu: ${var.min_cu}
          autoscaling_limit_max_cu: ${var.max_cu}
          no_suspension: true
          group:
            min: 2
            max: 2
            enable_readable_secondaries: true
          replace_existing: true

      # Postgres role that owns the app database.
      postgres_roles:
        app_role:
          role_id: app-role # Resource ID: lowercase letters, digits, and hyphens.
          parent: ${resources.postgres_branches.production.name}
          postgres_role: app_role # Postgres identifier: lowercase letters, digits, and underscores.

      # Named Postgres database for the app.
      postgres_databases:
        app_db:
          database_id: app-database
          parent: ${resources.postgres_branches.production.name}
          postgres_database: ${var.database_name}
          role: ${resources.postgres_roles.app_role.id}

      # Sync a Unity Catalog Delta table into the project continuously.
      postgres_synced_tables:
        orders_sync:
          synced_table_id: '${var.storage_catalog}.${var.storage_schema}.orders_synced'
          branch: ${resources.postgres_branches.production.name}
          postgres_database: ${var.database_name}
          source_table_full_name: ${var.source_table}
          primary_key_columns:
            - ${var.primary_key_column}
          scheduling_policy: CONTINUOUS
          create_database_objects_if_missing: true
          new_pipeline_spec:
            storage_catalog: ${var.storage_catalog}
            storage_schema: ${var.storage_schema}

      # Bind the Lakebase database into Unity Catalog so it is queryable as UC data.
      postgres_catalogs:
        lakebase_uc_catalog:
          catalog_id: ${var.uc_catalog_id}
          postgres_database: ${var.database_name}
          branch: ${resources.postgres_branches.production.name}
          create_database_if_missing: true

      # Databricks App connected to the project.
      # Update source_code_path to point to your app source directory.
      apps:
        lakebase_app:
          name: ${var.app_name}
          description: 'App backed by Lakebase autoscaling'
          source_code_path: ./app_src
          config:
            command:
              - flask
              - run
              - --host=0.0.0.0
              - --port=8000
          resources:
            - name: lakebase-db
              postgres:
                branch: ${resources.postgres_branches.production.name}
                database: ${resources.postgres_databases.app_db.name}
                permission: CAN_CONNECT_AND_CREATE

Note

Ogni progetto Lakebase crea automaticamente un database databricks_postgres di proprietà di un ruolo Postgres collegato alla tua identità. Questo bundle crea invece un database separato con nome proprio (${var.database_name}), di proprietà di un ruolo applicativo dedicato, per isolare i dati dell'applicazione. Per usare direttamente il database implicito e il ruolo, rimuovere i postgres_roles blocchi di risorse e postgres_databases , impostare postgres_database: databricks_postgres direttamente su postgres_synced_tables e postgres_catalogse aggiornare la risorsa dell'app su database: ${resources.postgres_branches.production.name}/databases/databricks-postgres.

Per portare invece il ruolo di proprietario implicito e il database databricks_postgres sotto la gestione del bundle, dichiarali con replace_existing: true usando i relativi ID esistenti. L'ID del database è sempre databricks-postgres. L'ID del ruolo deriva dalla tua identità Databricks anziché essere un nome predefinito, quindi individualo prima:

databricks postgres list-roles projects/<project-id>/branches/production

Dichiara quindi entrambe le risorse, facendo corrispondere ogni campo a quanto già impostato per il ruolo. L'omissione membership_roles rimuove l'appartenenza DATABRICKS_SUPERUSER dal ruolo quando viene adottata, quindi dichiararla in modo esplicito:

postgres_roles:
  owner:
    role_id: <role-id-from-list-roles>
    parent: ${resources.postgres_branches.production.name}
    postgres_role: user@databricks.com # Or the service principal application ID.
    identity_type: USER # Or SERVICE_PRINCIPAL.
    membership_roles:
      - DATABRICKS_SUPERUSER
    replace_existing: true

postgres_databases:
  databricks_postgres:
    database_id: databricks-postgres
    parent: ${resources.postgres_branches.production.name}
    postgres_database: databricks_postgres
    role: ${resources.postgres_roles.owner.id}
    replace_existing: true

Note

Per eliminare le risorse create da questo bundle, eseguire databricks bundle destroy -t prod. Per impostazione predefinita, il progetto viene eliminato in modo temporaneo e conservato per 7 giorni prima dell'eliminazione permanente, in modo da poterlo recuperare durante il periodo di conservazione. Per eliminare immediatamente solo il progetto, usare l'interfaccia della riga di comando di Databricks con --purgeo rimuovere il commento purge_on_delete: true nella risorsa di progetto precedente per eliminarlo definitivamente in ogni eliminazione definitiva:

databricks postgres delete-project projects/<project-id> --purge

Applica il pacchetto

Convalidare e distribuire:

databricks bundle validate -t prod
databricks bundle deploy -t prod

Se databricks bundle deploy non viene completato alla prima esecuzione, eseguirlo nuovamente.

Cosa viene distribuito

Il bundle crea le risorse seguenti:

  • Un progetto di scalabilità automatica di Lakebase con le impostazioni predefinite di calcolo specificate.
  • Ramo protetto production .
  • Endpoint primario di lettura/scrittura con disponibilità elevata e repliche secondarie leggibili.
  • Pipeline di sincronizzazione continua che trasmette una tabella Delta del catalogo Unity nel database di progetto.
  • Catalogo Unity basato sul database Lakebase, interrogabile come dati di Unity Catalog.
  • Un'app Databricks connessa al database del progetto.
  • Autorizzazione dell'area di lavoro CAN_MANAGE per l'entità servizio specificata.

Risorse aggiuntive

  • Last updated on