Actions d'initialisation

Lors de la création d'un cluster Dataproc, vous pouvez spécifier des actions d'initialisation dans des exécutables ou des scripts que Dataproc exécutera sur tous les nœuds du cluster Dataproc immédiatement après la configuration du cluster. Les actions d'initialisation vous permettent souvent de configurer les dépendances de tâches, telles que l'installation de packages Python. Vous pouvez ainsi soumettre les tâches au cluster sans avoir à installer de dépendances lors de leur exécution.

Vous trouverez des exemples de scripts d'actions d'initialisation fréquemment utilisés et d'autres exemples aux emplacements suivants :

Consignes et remarques importantes

  • Ne créez pas de clusters de production référençant des actions d'initialisation situées dans les buckets publics gs://goog-dataproc-initialization-actions-REGION. Ces scripts sont fournis en tant que mises en œuvre de référence et sont synchronisés avec les modifications apportées en continu au dépôt GitHub. Une nouvelle version d'une action d'initialisation dans des buckets publics risque de compromettre la création du cluster. À la place, copiez l'action d'initialisation des buckets publics dans votre bucket, comme illustré dans l'exemple suivant:

    REGION=region
    
    gsutil cp gs://goog-dataproc-initialization-actions-${REGION}/tez/tez.sh gs://my-bucket
    
    Créez ensuite le cluster en référençant la copie:
    gcloud dataproc clusters create cluster-name \
        --region=${REGION} \
        --initialization-actions=gs://my-bucket/tez.sh \
        ... other flags ...
    
    Vous pouvez décider quand synchroniser la copie de l'action d'initialisation avec les modifications de cette action qui sont apportées dans le bucket public ou dans le dépôt GitHub.

  • Les actions d'initialisation sont exécutées sur chaque nœud lors de la création du cluster. Elles sont également exécutées sur chaque nœud nouvellement ajouté lors du scaling ou de l'autoscaling des clusters pour augmenter leur capacité.

  • Les actions d'initialisation sont exécutées en tant qu'utilisateur root. Cela signifie que vous n'avez pas besoin d'utiliser sudo.

  • Vous devez utiliser des chemins absolus dans les actions d'initialisation.

  • Les actions d'initialisation doivent utiliser une ligne shebang pour indiquer comment le script doit être interprété (par exemple, #!/bin/bash ou #!/usr/bin/python).

  • Si une action d'initialisation se termine par un code de sortie différent de zéro, l'opération de création de cluster indique un état "ERREUR". Pour déboguer l'action d'initialisation, connectez-vous via SSH aux instances de VM du cluster, puis examinez les journaux. Après avoir résolu le problème d'action d'initialisation, vous pouvez supprimer le cluster, puis le recréer.

  • Si vous créez un cluster Dataproc avec des adresses IP internes uniquement, les tentatives d'accès à github.com sur Internet lors d'une action d'initialisation échoueront à moins que vous n'ayez configuré des routes vers les accès directs. trafic via Cloud NAT ou Cloud VPN. Sans accès à Internet, vous pouvez activer l'accès privé à Google et placer des dépendances de tâches dans Cloud Storage. Les nœuds de cluster peuvent télécharger des fichiers. Dépendances provenant de Cloud Storage à partir d'adresses IP internes.

  • Vous pouvez configurer des dépendances de tâches à l'aide d'images personnalisées Dataproc plutôt qu'avec des actions d'initialisation.

  • Traitement de l'initialisation:

    • Clusters d'images antérieurs à la version 2.0 :
      • Maître: les actions d'initialisation de nœud maître ne démarrent pas tant que l'écriture HDFS est accessible en écriture (jusqu'à ce que HDFS ait quitté le mode sans échec et au moins deux DataNodes HDFS). Cela permet aux actions d'initialisation exécutées sur les maîtres d'écrire des fichiers dans HDFS.
      • Nœud de calcul: si l'utilisateur définit la propriété de cluster dataproc:dataproc.worker.custom.init.actions.mode sur RUN_BEFORE_SERVICES, chaque nœud de calcul exécute ses actions d'initialisation avant l'activation. démarre ses daemons de données HDFS et leurs daemons de gestionnaire de nœuds YARN. Comme Dataproc n'exécute pas d'actions d'initialisation de maître tant que HDFS n'est pas en écriture, ce qui nécessite l'exécution de deux daemons de données HDFS, ce paramètre peut augmenter le temps de création du cluster.
    • Clusters d'images 2.0 et versions ultérieures:

      • Maître: les actions d'initialisation du nœud maître peuvent s'exécuter avant que HDFS soit accessible en écriture. Si vous exécutez des actions d'initialisation qui préproduisent des fichiers dans HDFS ou dépendent de la disponibilité de services dépendants HDFS, tels que Ranger, définissez la propriété de clusterdataproc.master.custom.init.actions.mode. 101}à RUN_AFTER_SERVICES. Remarque: Étant donné que ce paramètre de propriété peut augmenter le temps de création des clusters, consultez la description du délai de création de cluster pour les nœuds de calcul d'image pré-2.0, ne l'utilisez que lorsque (si vous avez besoin de cette option, nous vous recommandons d'utiliser le paramètre RUN_AVANT_SERVICES par défaut pour cette propriété).
      • Nœud de calcul: la propriété de cluster dataproc:dataproc.worker.custom.init.actions.mode est définie sur RUN_BEFORE_SERVICES et ne peut pas être transmise au cluster. lors de la création du cluster (ne peut pas être modifié par l'utilisateur) ; Chaque nœud de calcul exécute ses actions d'initialisation avant de démarrer son daemon de données HDFS et ses daemons de gestionnaires de nœuds YARN. Comme Dataproc n'attend pas que HDFS soit accessible avant d'exécuter des actions d'initialisation de maître, les actions d'initialisation des maîtres et des nœuds de calcul s'exécutent en parallèle.
    • Recommandations :

      • Utilisez les métadonnées pour déterminer le rôle d'un nœud afin d'exécuter de manière conditionnelle une action d'initialisation sur des nœuds (consultez la page Utiliser des métadonnées de cluster).
      • Dupliquer la copie d'une action d'initialisation dans un bucket Cloud Storage pour plus de stabilité (consultez la section Utilisation des actions d'initialisation).
      • Ajoutez des tentatives lors du téléchargement sur Internet pour contribuer à stabiliser l'action d'initialisation.

Utiliser les actions d'initialisation

Les actions d'initialisation de cluster peuvent être spécifiées quelle que soit la manière dont vous créez un cluster :

  • Via Google Cloud Console
  • Sur la ligne de commande à l'aide de l'outil de ligne de commande gcloud
  • De façon automatisée à l'aide de l'API clusters.create de Dataproc (consultez la section sur le paramètre NodeInitializationAction)

Commande gcloud

Lorsque vous créez un cluster à l'aide de la commande gcloud dataproc clusters create, spécifiez un ou plusieurs emplacements Cloud Storage (URI) des scripts ou exécutables d'initialisation avec l'option --initialization-actions, en les séparant par une virgule. Remarque : L'utilisation de plusieurs caractères "/" consécutifs dans un URI d'emplacement Cloud Storage après le préfixe "gs://" initial, par exemple "gs://bucket/my//object//name", n'est pas acceptée.

La syntaxe associée à cette option est illustrée ci-dessous. Vous pouvez l'afficher à partir de la ligne de commande en exécutant gcloud dataproc clusters create --help.

gcloud dataproc clusters create cluster-name \
    --region=${REGION} \
    --initialization-actions=Cloud Storage URI(s) (gs://bucket/...) \
    --initialization-action-timeout=timeout-value (default=10m) \
    ... other flags ...
Remarques :
  • Utilisez l'option --initialization-action-timeout pour spécifier un délai avant expiration pour l'action d'initialisation. La valeur par défaut du délai avant expiration est de 10 minutes. Si le script ou le fichier exécutable d'initialisation n'est pas terminé à la fin du délai d'expiration, Dataproc annule l'action d'initialisation.
  • Utilisez la propriété de cluster dataproc:dataproc.worker.custom.init.actions.mode pour exécuter l'action d'initialisation sur les nœuds de calcul principaux avant le démarrage des gestionnaires de nœuds et des daemons Datanode.

API REST

Spécifiez un ou plusieurs script(s) ou exécutable(s) dans un tableau ClusterConfig.initializationActions dans le cadre d'une requête API clusters.create.

Exemple

POST /v1/projects/my-project-id/regions/us-central1/clusters/
{
  "projectId": "my-project-id",
  "clusterName": "example-cluster",
  "config": {
    "configBucket": "",
    "gceClusterConfig": {
      "subnetworkUri": "default",
      "zoneUri": "us-central1-b"
    },
    "masterConfig": {
      "numInstances": 1,
      "machineTypeUri": "n1-standard-4",
      "diskConfig": {
        "bootDiskSizeGb": 500,
        "numLocalSsds": 0
      }
    },
    "workerConfig": {
      "numInstances": 2,
      "machineTypeUri": "n1-standard-4",
      "diskConfig": {
        "bootDiskSizeGb": 500,
        "numLocalSsds": 0
      }
    },
    "initializationActions": [
      {
        "executableFile": "gs://cloud-example-bucket/my-init-action.sh"
      }
    ]
  }
}
.

Console

  • Ouvrez la page Dataproc Créer un cluster, puis sélectionnez le panneau "Personnaliser le cluster".
  • Dans la section "Actions d'initialisation", saisissez l'emplacement des buckets Cloud Storage correspondant à chaque action d'initialisation dans le ou les champ(s) du fichier exécutable. Cliquez sur "PARCOURIR" pour ouvrir la page du navigateur Cloud Storage dans Cloud Console et sélectionner un script ou un fichier exécutable. Cliquez sur "AJOUTER UNE ACTION D'INITIALISATION" pour ajouter chaque nouveau fichier.
  • Transmettre des arguments aux actions d'initialisation

    Dataproc définit des valeurs de métadonnées spéciales pour les instances exécutées dans vos clusters. Vous pouvez définir vos propres métadonnées personnalisées pour transmettre des arguments aux actions d'initialisation.

    gcloud dataproc clusters create cluster-name \
        --region=${REGION} \
        --initialization-actions=Cloud Storage URI(s) (gs://bucket/...) \
        --metadata=name1=value1,name2=value2... \
        ... other flags ...
    

    Les valeurs de métadonnées peuvent être lues dans les actions d'initialisation comme suit :

    var1=$(/usr/share/google/get_metadata_value attributes/name1)
    

    Sélection de nœud

    Si vous souhaitez limiter les actions d'initialisation au nœud maître ou aux nœuds de calcul, vous pouvez ajouter une logique de sélection de nœud simple à l'exécutable ou au script.

    ROLE=$(/usr/share/google/get_metadata_value attributes/dataproc-role)
    if [[ "${ROLE}" == 'Master' ]]; then
      ... master specific actions ...
    else
      ... worker specific actions ...
    fi
    

    Binaires de préproduction

    Un scénario d'initialisation de cluster courant consiste en la préproduction de binaires de tâches sur un cluster afin d'éliminer le besoin de préparer ces binaires chaque fois qu'une tâche est soumise. Par exemple, supposons que le script d'initialisation suivant soit stocké dans gs://my-bucket/download-job-jar.sh, un emplacement de bucket Cloud Storage :

    #!/bin/bash
    ROLE=$(/usr/share/google/get_metadata_value attributes/dataproc-role)
    if [[ "${ROLE}" == 'Master' ]]; then
      gsutil cp gs://my-bucket/jobs/sessionalize-logs-1.0.jar home/username
    fi
    

    L'emplacement de ce script peut être transmis à la commande gcloud dataproc clusters create :

    gcloud dataproc clusters create my-dataproc-cluster \
        --region=${REGION} \
        --initialization-actions=gs://my-bucket/download-job-jar.sh
    

    Dataproc exécute ce script sur tous les nœuds et, à cause de la logique de sélection de nœud dans le script, il télécharge le fichier jar sur le nœud maître. Les tâches soumises peuvent ensuite utiliser le fichier jar de préproduction :

    gcloud dataproc jobs submit hadoop \
        --cluster=my-dataproc-cluster \
        --region=${REGION} \
        --jar=file:///home/username/sessionalize-logs-1.0.jar
    

    Exemples d'actions d'initialisation

    Vous trouverez des exemples de scripts d'actions d'initialisation fréquemment utilisés et d'autres scripts dans gs://goog-dataproc-initialization-actions-<REGION>, un bucket public Cloud Storage régional, et dans un dépôt GitHub. Pour contribuer à un script, consultez le document CONTRIBUTING.md, puis déposez une demande d'extraction.

    Logging

    Le résultat de l'exécution de chaque action d'initialisation est enregistré pour chaque instance dans /var/log/dataproc-initialization-script-X.log, où X correspond à l'index basé sur zéro de chaque script d'action d'initialisation successif. Par exemple, si votre cluster comporte deux actions d'initialisation, les résultats sont enregistrés dans /var/log/dataproc-initialization-script-0.log et /var/log/dataproc-initialization-script-1.log.

    Étape suivante

    Découvrez les actions d'initialisation GitHub.