Ingérer des données à partir d’Okta

info

Bêta

Cette fonctionnalité est en Bêta. Pour l'utiliser, un administrateur de workspace doit activer Lakeflow Connect pour Okta à partir de la page Aperçus . Consultez Gérer les aperçus Databricks.

Créez un pipeline Lakeflow Connect géré qui ingère les données Okta dans les tables du Unity Catalog. Utilisez l’interface utilisateur Databricks, Declarative Automation Bundles ou un notebook Databricks.

Conditions requises

• Pour créer un pipeline d’ingestion, vous devez d’abord remplir les conditions suivantes :

  • Votre Workspace doit être activé pour Unity Catalog.

  • Le compute serverless doit être activé pour votre workspace. Voir Configuration requise pour le compute serverless.

  • Pour créer une connexion, vous devez disposer des privilèges CREATE CONNECTION sur le metastore. Voir Gérer les privilèges dans Unity Catalog.

    Si le connecteur prend en charge la création de pipelines basée sur l'interface utilisateur, un administrateur peut créer la connexion et le pipeline en même temps en suivant les étapes de cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent la création de pipelines basée sur l'API ou sont des utilisateurs non administrateurs, un administrateur doit d'abord créer la connexion dans Catalog Explorer. Voir Se connecter à des sources d'ingestion gérées.

  • Pour utiliser une connexion existante, vous devez disposer des privilèges USE CONNECTION ou ALL PRIVILEGES sur l'objet de connexion.

  • Vous devez disposer des privilèges USE CATALOG sur le catalogue cible.

  • Vous devez disposer des privilèges USE SCHEMA et CREATE TABLE sur un schéma existant ou des privilèges CREATE SCHEMA sur le catalogue cible.

• Pour ingérer à partir d'Okta, configurez d'abord l'authentification à partir de Databricks et créez une connexion. Voir Configurer l'authentification pour Okta et Créer une connexion Okta.

Options de connecteur

Pour les options acceptées par le connecteur Okta, leur portée et les tables auxquelles elles s'appliquent, voir Options du connecteur. Définissez les options de portée du pipeline dans source_configurations. Voir Exemples pour l'utilisation.

Créer un pipeline d’ingestion

Pour obtenir la liste des tables sources prises en charge, consultez Tables sources prises en charge.

Databricks UI

1. Dans la barre latérale du workspace Databricks, cliquez sur Data Ingestion .
2. Sur la page Ajouter des données , sous Connecteurs Databricks , cliquez sur Okta .
3. Sur la page Connection de l'assistant d'ingestion, sélectionnez la connexion qui stocke vos identifiants Okta. Si vous disposez du privilège CREATE CONNECTION sur le metastore, cliquez sur Create connection pour créer une connexion avec les identifiants de Configurer l'authentification pour Okta.
4. Cliquez sur Suivant .
5. Sur la page Configuration de l’ingestion , saisissez un nom pour le pipeline.
6. Sélectionnez un catalogue et un schéma dans lesquels écrire les logs d'événements. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, cliquez sur Créer un schéma dans le menu déroulant pour créer un schéma.
7. Cliquez sur Créer un pipeline et continuer .
8. Sur la page Source , sélectionnez les tables à ingérer.
9. Cliquez sur Enregistrer et continuer .
10. Sur la page Destination , sélectionnez un catalogue et un schéma dans lequel charger des données. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, cliquez sur Créer un schéma dans le menu déroulant pour créer un schéma.
11. Cliquez sur Enregistrer et continuer .
12. (Facultatif) Sur la page Planifications et notifications , cliquez sur Créer une planification . Définissez la fréquence de refresh des tables de destination.
13. (Facultatif) Cliquez sur Ajouter une notification pour définir des notifications par e-mail pour la réussite ou l'échec de l'opération du pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .

Declarative Automation Bundles

Utilisez les Declarative Automation Bundles pour gérer les pipelines Okta en tant que code. Les bundles peuvent contenir des définitions YAML de Jobs et de tâches, sont gérés à l'aide de la CLI Databricks et peuvent être partagés et exécutés dans différents Workspace cibles (tels que le développement, la pré-production et la production). Voir Que sont les Declarative Automation Bundles ?.

1. Créez un bundle à l’aide de la CLI Databricks :

   Bash

   databricks bundle init

2. Ajoutez deux nouveaux fichiers de ressources au bundle :

   • Fichier de définition de pipeline (par exemple, resources/okta_pipeline.yml). Consultez pipeline.ingestion_definition et Exemples.
   • Un fichier de définition de job qui contrôle la fréquence d'ingestion des données (par exemple, resources/okta_job.yml).

3. Déployez le pipeline à l'aide de Databricks CLI :

   Bash

   databricks bundle deploy

Databricks notebook

1. Importez le notebook suivant dans votre workspace Databricks :

Ouvrir le notebook dans un nouvel ongletOuvrir dans Databricks

2. Laissez les cellules un et deux telles quelles.

3. Modifiez la troisième cellule avec les détails de configuration de votre pipeline. Voir pipeline.ingestion_definition et Exemples.

4. Configurez éventuellement les paramètres avancés du pipeline. Voir Modèles courants pour les pipelines d'ingestion gérés.

5. Cliquez sur Tout exécuter .

Exemples

Le connecteur Okta met à disposition 25 tables sources dans le schéma source default. Ingérez des tables individuelles ou les tables dont vous avez besoin.

Ingérer des tables spécifiques

Utilisez cette option pour ingérer un sous-ensemble spécifique de tables, ou pour personnaliser le nom de destination par table. L’option facultative start_datetime définit la profondeur de lecture de la première synchronisation de chaque table incrémentielle.

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère des tables Okta individuelles :

YAML

resources:
  pipelines:
    okta_pipeline:
      name: okta_pipeline
      catalog: 'main'
      target: 'okta_data'
      ingestion_definition:
        connection_name: okta_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                start_datetime: '<start-datetime>'
        objects:
          - table:
              source_schema: 'default'
              source_table: 'users'
              destination_catalog: 'main'
              destination_schema: 'okta_data'
              destination_table: 'users'
          - table:
              source_schema: 'default'
              source_table: 'groups'
              destination_catalog: 'main'
              destination_schema: 'okta_data'
              destination_table: 'groups'
          - table:
              source_schema: 'default'
              source_table: 'group_members'
              destination_catalog: 'main'
              destination_schema: 'okta_data'
              destination_table: 'group_members'

Databricks notebook

La spécification de pipeline suivante ingère des tables Okta individuelles :

Python

pipeline_name = "okta_pipeline"
connection_name = "<okta-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "source_configurations": [
      {
        "api_source_connector_config": {
          "configs": {
            "start_datetime": "<start-datetime>"
          }
        }
      }
    ],
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "users",
          "destination_catalog": "main",
          "destination_schema": "okta_data",
          "destination_table": "users"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "groups",
          "destination_catalog": "main",
          "destination_schema": "okta_data",
          "destination_table": "groups"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "group_members",
          "destination_catalog": "main",
          "destination_schema": "okta_data",
          "destination_table": "group_members"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Fichier de définition de job Declarative Automation Bundles

Voici un exemple de fichier de définition de job à utiliser avec Declarative Automation Bundles. Le job s'exécute quotidiennement.

Declarative Automation Bundles

YAML

resources:
  jobs:
    okta_job:
      name: okta_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: okta_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.okta_pipeline.id}

Modèles courants

Pour les configurations avancées de pipeline, voir Modèles courants pour les pipelines d'ingestion gérés.

Étapes suivantes

Start, planifiez et définissez des alertes sur votre pipeline. Voir Tâches courantes de maintenance du pipeline.

Ressources supplémentaires

• FAQ sur le connecteur Okta
• Limitations du connecteur Okta
• Référence du connecteur Okta
• Dépanner le connecteur Okta