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 aux emplacements suivants : Remarque: Google n'est pas compatible avec ces exemples.

• Dépôt GitHub
• Cloud Storage : dans les buckets publics régionaux gs://goog-dataproc-initialization-actions-REGION

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 à titre d'implémentations de référence. Ils sont synchronisés avec les modifications apportées en continu au dépôt GitHub. Les mises à jour de ces scripts peuvent compromettre la création de votre cluster. À la place, copiez l'action d'initialisation du bucket public dans un dossier de bucket Cloud Storage avec version, comme illustré dans l'exemple suivant:

  REGION=COMPUTE_REGION
  gcloud storage cp gs://goog-dataproc-initialization-actions-${REGION}/cloud-sql-proxy/cloud-sql-proxy.sh \
      gs://my-bucket/cloud-sql-proxy/v1.0/cloud-sql-proxy.sh
  

  Créez ensuite le cluster en référençant la copie dans Cloud Storage:

  gcloud dataproc clusters create CLUSTER_NAME \
      --region=${REGION} \
      --initialization-actions=gs://my-bucket/cloud-sql-proxy/v1.0/cloud-sql-proxy.sh \
      ...other flags...
  

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

• Lorsque vous mettez à jour des actions d'initialisation (par exemple, lorsque vous synchronisez vos actions d'initialisation Cloud Storage avec les modifications apportées aux actions d'initialisation de bucket public ou de dépôt GitHub), créez un dossier (de préférence avec un nom de version) pour recevoir les actions d'initialisation mises à jour. Si vous mettez à jour l'action d'initialisation en place, les nouveaux nœuds, tels que ceux ajoutés par l'autoscaler, exécuteront l'action d'initialisation mise à jour en place, et non l'action d'initialisation de la version précédente exécutée sur les nœuds existants. De telles différences d'actions d'initialisation peuvent entraîner des nœuds de cluster incohérents ou défectueux.

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

• Utilisez des chemins absolus dans les actions d'initialisation.

• Utilisez une ligne shebang dans les actions d'initialisation 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, utilisez SSH pour vous connecter 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 via Internet lors d'une action d'initialisation échoueront à moins que vous n'ayez configuré des routes pour diriger le 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 les dépendances depuis 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: pour permettre aux actions d'initialisation de s'exécuter sur des maîtres afin d'écrire des fichiers dans HDFS, les actions d'initialisation du nœud maître ne démarrent pas tant que HDFS n'est pas accessible en écriture (jusqu'à ce que HDFS ait quitté le mode sécurisé et qu'au moins deux DataNodes HDFS soient associés).
    • Nœud de calcul: si vous définissez 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 de démarrer ses daemons de nœud de données HDFS et de gestionnaire de données YARN. Étant donné que Dataproc n'exécute aucune action d'initialisation du maître tant que HDFS n'est pas accessible en écriture, ce qui nécessite l'exécution de deux daemons de nœud de données HDFS, définir cette propriété 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 ne soit accessible en écriture. Si vous exécutez des actions d'initialisation qui organisent les fichiers dans HDFS ou dépendent de la disponibilité des services dépendants de HDFS, tels que Ranger, définissez la propriété de cluster dataproc.master.custom.init.actions.mode sur RUN_AFTER_SERVICES. Remarque: Étant donné que ce paramètre de propriété peut augmenter le temps de création du cluster (consultez les explications sur le délai de création du cluster pour les nœuds de calcul des clusters antérieurs à la version 2.0), ne l'utilisez que lorsque nécessaire (en pratique, utilisez le paramètre RUN_BEFORE_SERVICES par défaut pour cette propriété).
    • Worker: 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 sa création (vous ne pouvez pas modifier le paramètre de la propriété). Chaque nœud de calcul exécute ses actions d'initialisation avant de démarrer ses daemons de nœud de données HDFS et de gestionnaire de données YARN. Étant donné que Dataproc n'attend pas que HDFS soit accessible en écriture avant d'exécuter les actions d'initialisation du maître, les actions d'initialisation du maître et des nœuds de travail s'exécutent en parallèle.

  • Recommandations :

    • Utilisez les métadonnées pour déterminer le rôle d'un nœud pour exécuter une action d'initialisation de manière conditionnelle sur les nœuds (voir Utiliser des métadonnées de cluster).
    • Dupliquer une copie d'une action d'initialisation dans un bucket Cloud Storage pour plus de stabilité (voir Utilisation des actions d'initialisation).
    • Ajoutez des tentatives lorsque vous téléchargez depuis Internet afin de 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 la console Google Cloud
• Utiliser la CLI gcloud
• De façon automatisée à l'aide de l'API clusters.create de Dataproc (consultez la section sur le paramètre NodeInitializationAction)

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 ...

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"
      }
    ]
  }
}

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 aux nœuds maître, pilotes ou 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 if [[ "${ROLE}" == 'Driver' ]]; then
  ... driver 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
  gcloud storage 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.