Köra ett CI/CD-arbetsflöde med ett Databricks-tillgångspaket och GitHub Actions

  • Artikel

Den här artikeln beskriver hur du kör ett CI/CD-arbetsflöde (kontinuerlig integrering/kontinuerlig distribution) i GitHub med GitHub Actions och ett Databricks-tillgångspaket. Se Vad är Databricks-tillgångspaket?

Du kan använda GitHub Actions tillsammans med Databricks CLI-kommandon bundle för att automatisera, anpassa och köra dina CI/CD-arbetsflöden från dina GitHub-lagringsplatser.

Du kan lägga till YAML-filer för GitHub Actions, till exempel följande i lagringsplatsens .github/workflows katalog. I följande exempel validerar, distribuerar och kör YAML-filen GitHub Actions det angivna jobbet i paketet i ett förproduktionsmål med namnet "qa" enligt definitionen i en paketkonfigurationsfil. I det här exemplet förlitar sig YAML-filen för GitHub Actions på följande:

  • En paketkonfigurationsfil i roten på lagringsplatsen, som uttryckligen deklareras via YAML-filens inställning working-directory: . för GitHub Actions (den här inställningen kan utelämnas om paketkonfigurationsfilen redan finns i roten på lagringsplatsen.) Den här paketkonfigurationsfilen definierar ett Azure Databricks-arbetsflöde med namnet my-job och ett mål med namnet qa. Se Konfiguration av Databricks-tillgångspaket.
  • En GitHub-hemlighet med namnet SP_TOKEN, som representerar Azure Databricks-åtkomsttoken för ett Huvudnamn för Azure Databricks-tjänsten som är associerad med Azure Databricks-arbetsytan som paketet distribueras och körs till. Se Krypterade hemligheter.
# This workflow validates, deploys, and runs the specified bundle
# within a pre-production target named "qa".
name: "QA deployment"

# Ensure that only a single job or workflow using the same concurrency group
# runs at a time.
concurrency: 1

# Trigger this workflow whenever a pull request is opened against the repo's
# main branch or an existing pull request's head branch is updated.
on:
  pull_request:
    types:
      - opened
      - synchronize
    branches:
      - main

jobs:
  # Used by the "pipeline_update" job to deploy the bundle.
  # Bundle validation is automatically performed as part of this deployment.
  # If validation fails, this workflow fails.
  deploy:
    name: "Deploy bundle"
    runs-on: ubuntu-latest

    steps:
      # Check out this repo, so that this workflow can access it.
      - uses: actions/checkout@v3

      # Download the Databricks CLI.
      # See https://github.com/databricks/setup-cli
      - uses: databricks/setup-cli@main

      # Deploy the bundle to the "qa" target as defined
      # in the bundle's settings file.
      - run: databricks bundle deploy
        working-directory: .
        env:
          DATABRICKS_TOKEN: ${{ secrets.SP_TOKEN }}
          DATABRICKS_BUNDLE_ENV: qa

  # Validate, deploy, and then run the bundle.
  pipeline_update:
    name: "Run pipeline update"
    runs-on: ubuntu-latest

    # Run the "deploy" job first.
    needs:
      - deploy

    steps:
      # Check out this repo, so that this workflow can access it.
      - uses: actions/checkout@v3

      # Use the downloaded Databricks CLI.
      - uses: databricks/setup-cli@main

      # Run the Databricks workflow named "my-job" as defined in the
      # bundle that was just deployed.
      - run: databricks bundle run my-job --refresh-all
        working-directory: .
        env:
          DATABRICKS_TOKEN: ${{ secrets.SP_TOKEN }}
          DATABRICKS_BUNDLE_ENV: qa

Följande GitHub Actions YAML-fil kan finnas på samma lagringsplats som föregående fil. Den här filen validerar, distribuerar och kör det angivna paketet inom ett produktionsmål med namnet "prod" enligt definitionen i en paketkonfigurationsfil. I det här exemplet förlitar sig YAML-filen för GitHub Actions på följande:

  • En paketkonfigurationsfil i roten på lagringsplatsen, som uttryckligen deklareras via YAML-filens inställning working-directory: . för GitHub Actions (den här inställningen kan utelämnas om paketkonfigurationsfilen redan finns i roten på lagringsplatsen.). Den här paketkonfigurationsfilen definierar ett Azure Databricks-arbetsflöde med namnet my-job och ett mål med namnet prod. Se Konfiguration av Databricks-tillgångspaket.
  • En GitHub-hemlighet med namnet SP_TOKEN, som representerar Azure Databricks-åtkomsttoken för ett Huvudnamn för Azure Databricks-tjänsten som är associerad med Azure Databricks-arbetsytan som paketet distribueras och körs till. Se Krypterade hemligheter.
# This workflow validates, deploys, and runs the specified bundle
# within a production target named "prod".
name: "Production deployment"

# Ensure that only a single job or workflow using the same concurrency group
# runs at a time.
concurrency: 1

# Trigger this workflow whenever a pull request is pushed to the repo's
# main branch.
on:
  push:
    branches:
      - main

jobs:
  deploy:
    name: "Deploy bundle"
    runs-on: ubuntu-latest

    steps:
      # Check out this repo, so that this workflow can access it.
      - uses: actions/checkout@v3

      # Download the Databricks CLI.
      # See https://github.com/databricks/setup-cli
      - uses: databricks/setup-cli@main

      # Deploy the bundle to the "prod" target as defined
      # in the bundle's settings file.
      - run: databricks bundle deploy
        working-directory: .
        env:
          DATABRICKS_TOKEN: ${{ secrets.SP_TOKEN }}
          DATABRICKS_BUNDLE_ENV: prod

  # Validate, deploy, and then run the bundle.
  pipeline_update:
    name: "Run pipeline update"
    runs-on: ubuntu-latest

    # Run the "deploy" job first.
    needs:
      - deploy

    steps:
      # Check out this repo, so that this workflow can access it.
      - uses: actions/checkout@v3

      # Use the downloaded Databricks CLI.
      - uses: databricks/setup-cli@main

      # Run the Databricks workflow named "my-job" as defined in the
      # bundle that was just deployed.
      - run: databricks bundle run my-job --refresh-all
        working-directory: .
        env:
          DATABRICKS_TOKEN: ${{ secrets.SP_TOKEN }}
          DATABRICKS_BUNDLE_ENV: prod

Se även