Utiliser le connecteur Cloud Storage avec Apache Spark


Ce tutoriel vous montre comment exécuter un exemple de code utilisant le connecteur Cloud Storage avec Apache Spark.

Objectifs

Écrire une tâche de décompte de mots simple Spark en Java, Scala ou Python, puis exécuter la tâche sur un cluster Dataproc.

Coûts

Dans ce document, vous utilisez les composants facturables de Google Cloudsuivants :

  • Compute Engine
  • Dataproc
  • Cloud Storage

Vous pouvez obtenir une estimation des coûts en fonction de votre utilisation prévue à l'aide du simulateur de coût.

Les nouveaux utilisateurs de Google Cloud peuvent bénéficier d'un essai gratuit.

Avant de commencer

Exécutez les étapes ci-dessous pour préparer l'exécution du code dans ce tutoriel.

  1. Configurer votre projet Si nécessaire, configurez un projet avec les API Dataproc, Compute Engine et Cloud Storage activées, et la Google Cloud CLI installée sur votre ordinateur local.

    1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
    2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    3. Verify that billing is enabled for your Google Cloud project.

    4. Enable the Dataproc, Compute Engine, and Cloud Storage APIs.

      Enable the APIs

    5. Create a service account:

      1. In the Google Cloud console, go to the Create service account page.

        Go to Create service account
      2. Select your project.
      3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

        In the Service account description field, enter a description. For example, Service account for quickstart.

      4. Click Create and continue.
      5. Grant the Project > Owner role to the service account.

        To grant the role, find the Select a role list, then select Project > Owner.

      6. Click Continue.
      7. Click Done to finish creating the service account.

        Do not close your browser window. You will use it in the next step.

    6. Create a service account key:

      1. In the Google Cloud console, click the email address for the service account that you created.
      2. Click Keys.
      3. Click Add key, and then click Create new key.
      4. Click Create. A JSON key file is downloaded to your computer.
      5. Click Close.
    7. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your credentials. This variable applies only to your current shell session, so if you open a new session, set the variable again.

    8. Install the Google Cloud CLI.

    9. Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

    10. Pour initialiser la gcloud CLI, exécutez la commande suivante :

      gcloud init
    11. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    12. Verify that billing is enabled for your Google Cloud project.

    13. Enable the Dataproc, Compute Engine, and Cloud Storage APIs.

      Enable the APIs

    14. Create a service account:

      1. In the Google Cloud console, go to the Create service account page.

        Go to Create service account
      2. Select your project.
      3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

        In the Service account description field, enter a description. For example, Service account for quickstart.

      4. Click Create and continue.
      5. Grant the Project > Owner role to the service account.

        To grant the role, find the Select a role list, then select Project > Owner.

      6. Click Continue.
      7. Click Done to finish creating the service account.

        Do not close your browser window. You will use it in the next step.

    15. Create a service account key:

      1. In the Google Cloud console, click the email address for the service account that you created.
      2. Click Keys.
      3. Click Add key, and then click Create new key.
      4. Click Create. A JSON key file is downloaded to your computer.
      5. Click Close.
    16. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your credentials. This variable applies only to your current shell session, so if you open a new session, set the variable again.

    17. Install the Google Cloud CLI.

    18. Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

    19. Pour initialiser la gcloud CLI, exécutez la commande suivante :

      gcloud init
    20. Créer un bucket Cloud Storage Vous aurez besoin d'un stockage Cloud Storage pour stocker les données du tutoriel. Si vous n'en avez pas, créez un bucket dans votre projet.

      1. In the Google Cloud console, go to the Cloud Storage Buckets page.

        Go to Buckets

      2. Click Create.
      3. On the Create a bucket page, enter your bucket information. To go to the next step, click Continue.
        1. In the Get started section, do the following:
          • Enter a globally unique name that meets the bucket naming requirements.
          • To add a bucket label, expand the Labels section (), click Add label, and specify a key and a value for your label.
        2. In the Choose where to store your data section, do the following:
          1. Select a Location type.
          2. Choose a location where your bucket's data is permanently stored from the Location type drop-down menu.
          3. To set up cross-bucket replication, select Add cross-bucket replication via Storage Transfer Service and follow these steps:

            Set up cross-bucket replication

            1. In the Bucket menu, select a bucket.
            2. In the Replication settings section, click Configure to configure settings for the replication job.

              The Configure cross-bucket replication pane appears.

              • To filter objects to replicate by object name prefix, enter a prefix that you want to include or exclude objects from, then click Add a prefix.
              • To set a storage class for the replicated objects, select a storage class from the Storage class menu. If you skip this step, the replicated objects will use the destination bucket's storage class by default.
              • Click Done.
        3. In the Choose how to store your data section, do the following:
          1. Select a default storage class for the bucket or Autoclass for automatic storage class management of your bucket's data.
          2. To enable hierarchical namespace, in the Optimize storage for data-intensive workloads section, select Enable hierarchical namespace on this bucket.
        4. In the Choose how to control access to objects section, select whether or not your bucket enforces public access prevention, and select an access control method for your bucket's objects.
        5. In the Choose how to protect object data section, do the following:
          • Select any of the options under Data protection that you want to set for your bucket.
            • To enable soft delete, click the Soft delete policy (For data recovery) checkbox, and specify the number of days you want to retain objects after deletion.
            • To set Object Versioning, click the Object versioning (For version control) checkbox, and specify the maximum number of versions per object and the number of days after which the noncurrent versions expire.
            • To enable the retention policy on objects and buckets, click the Retention (For compliance) checkbox, and then do the following:
              • To enable Object Retention Lock, click the Enable object retention checkbox.
              • To enable Bucket Lock, click the Set bucket retention policy checkbox, and choose a unit of time and a length of time for your retention period.
          • To choose how your object data will be encrypted, expand the Data encryption section (), and select a Data encryption method.
      4. Click Create.

    21. Définissez des variables d'environnement locales. Définissez des variables d'environnement sur votre ordinateur local. Définissez l'ID de votre projet Google Cloud et le nom du bucket Cloud Storage que vous utiliserez pour ce tutoriel. Indiquez également le nom et la région d'un cluster Dataproc existant ou nouveau. Vous pouvez créer un cluster à utiliser dans ce tutoriel à l'étape suivante.

      PROJECT=project-id
      
      BUCKET_NAME=bucket-name
      
      CLUSTER=cluster-name
      
      REGION=cluster-region Example: "us-central1"
      

    22. Créer un cluster Dataproc Exécutez la commande ci-dessous pour créer un cluster Dataproc à nœud unique dans la zone Compute Engine spécifiée.

      gcloud dataproc clusters create ${CLUSTER} \
          --project=${PROJECT} \
          --region=${REGION} \
          --single-node
      

    23. Copier des données publiques dans votre bucket Cloud Storage. Copiez un extrait de texte Shakespeare public dans le dossier input de votre bucket Cloud Storage :

      gcloud storage cp gs://pub/shakespeare/rose.txt \
          gs://${BUCKET_NAME}/input/rose.txt
      

    24. Configurer un environnement de développement Java (Apache Maven), Scala (SBT) ou Python.

    25. Préparer la tâche de décompte Spark

      Sélectionnez un onglet ci-dessous pour suivre la procédure de préparation d'un package ou d'un fichier de tâche à envoyer au cluster. Vous pouvez préparer l'un des types de tâches suivants :

      Java

      1. Copiez le fichier pom.xml sur votre ordinateur local. Le fichier pom.xml suivant spécifie les dépendances des bibliothèques Scala et Spark, auxquelles un champ d'application provided est attribué pour indiquer que le cluster Dataproc fournira ces bibliothèques lors de l'exécution. Le fichier pom.xml ne spécifie pas de dépendance Cloud Storage, car le connecteur met en œuvre l'interface HDFS standard. Lorsqu'une tâche Spark accède à des fichiers de cluster Cloud Storage (fichiers dont les URI commencent par gs:// ), le système utilise automatiquement le connecteur Cloud Storage pour accéder aux fichiers dans Cloud Storage.
        <?xml version="1.0" encoding="UTF-8"?>
        <project xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
          <modelVersion>4.0.0</modelVersion>
        
          <groupId>dataproc.codelab</groupId>
          <artifactId>word-count</artifactId>
          <version>1.0</version>
        
          <properties>
            <maven.compiler.source>1.8</maven.compiler.source>
            <maven.compiler.target>1.8</maven.compiler.target>
          </properties>
        
          <dependencies>
            <dependency>
              <groupId>org.scala-lang</groupId>
              <artifactId>scala-library</artifactId>
              <version>Scala version, for example, 2.11.8</version>
              <scope>provided</scope>
            </dependency>
            <dependency>
              <groupId>org.apache.spark</groupId>
              <artifactId>spark-core_Scala major.minor.version, for example, 2.11</artifactId>
              <version>Spark version, for example, 2.3.1</version>
              <scope>provided</scope>
            </dependency>
          </dependencies>
        </project>
      2. Copiez le code WordCount.java indiqué ci-dessous sur votre ordinateur local.
        1. Créez un ensemble de répertoires avec le chemin d'accès src/main/java/dataproc/codelab :
          mkdir -p src/main/java/dataproc/codelab
          
        2. Copiez WordCount.java sur votre ordinateur local dans src/main/java/dataproc/codelab :
          cp WordCount.java src/main/java/dataproc/codelab
          

        WordCount.java est une tâche Spark en Java qui lit les fichiers texte de Cloud Storage, effectue un décompte des mots, puis écrit les résultats des fichiers texte dans Cloud Storage.

        package dataproc.codelab;
        
        import java.util.Arrays;
        import org.apache.spark.SparkConf;
        import org.apache.spark.api.java.JavaPairRDD;
        import org.apache.spark.api.java.JavaRDD;
        import org.apache.spark.api.java.JavaSparkContext;
        import scala.Tuple2;
        
        public class WordCount {
          public static void main(String[] args) {
            if (args.length != 2) {
              throw new IllegalArgumentException("Exactly 2 arguments are required: <inputUri> <outputUri>");
            }
            String inputPath = args[0];
            String outputPath = args[1];
            JavaSparkContext sparkContext = new JavaSparkContext(new SparkConf().setAppName("Word Count"));
            JavaRDD<String> lines = sparkContext.textFile(inputPath);
            JavaRDD<String> words = lines.flatMap(
                (String line) -> Arrays.asList(line.split(" ")).iterator()
            );
            JavaPairRDD<String, Integer> wordCounts = words.mapToPair(
                (String word) -> new Tuple2<>(word, 1)
            ).reduceByKey(
                (Integer count1, Integer count2) -> count1 + count2
            );
            wordCounts.saveAsTextFile(outputPath);
          }
        }
      3. Créez le package.
        mvn clean package
        
        Si la compilation réussit, un fichier target/word-count-1.0.jar est créé.
      4. Entreposez le package sur Cloud Storage.
        gcloud storage cp target/word-count-1.0.jar \
            gs://${BUCKET_NAME}/java/word-count-1.0.jar
        

      Scala

      1. Copiez le fichier build.sbt sur votre ordinateur local. Le fichier build.sbt suivant spécifie les dépendances des bibliothèques Scala et Spark, auxquelles un champ d'application provided est attribué pour indiquer que le cluster Dataproc fournira ces bibliothèques lors de l'exécution. Le fichier build.sbt ne spécifie pas de dépendance Cloud Storage, car le connecteur met en œuvre l'interface HDFS standard. Lorsqu'une tâche Spark accède à des fichiers de cluster Cloud Storage (fichiers dont les URI commencent par gs:// ), le système utilise automatiquement le connecteur Cloud Storage pour accéder aux fichiers dans Cloud Storage.
        scalaVersion := "Scala version, for example, 2.11.8"
        
        name := "word-count"
        organization := "dataproc.codelab"
        version := "1.0"
        
        libraryDependencies ++= Seq(
          "org.scala-lang" % "scala-library" % scalaVersion.value % "provided",
          "org.apache.spark" %% "spark-core" % "Spark version, for example, 2.3.1" % "provided"
        )
      2. Copiez word-count.scala sur votre ordinateur local. Il s'agit d'une tâche Spark en Java qui lit les fichiers texte de Cloud Storage, effectue un décompte des mots, puis écrit les résultats des fichiers texte dans Cloud Storage.
        package dataproc.codelab
        
        import org.apache.spark.SparkContext
        import org.apache.spark.SparkConf
        
        object WordCount {
          def main(args: Array[String]) {
            if (args.length != 2) {
              throw new IllegalArgumentException(
                  "Exactly 2 arguments are required: <inputPath> <outputPath>")
            }
        
            val inputPath = args(0)
            val outputPath = args(1)
        
            val sc = new SparkContext(new SparkConf().setAppName("Word Count"))
            val lines = sc.textFile(inputPath)
            val words = lines.flatMap(line => line.split(" "))
            val wordCounts = words.map(word => (word, 1)).reduceByKey(_ + _)
            wordCounts.saveAsTextFile(outputPath)
          }
        }
      3. Créez le package.
        sbt clean package
        
        Si la compilation réussit, un fichier target/scala-2.11/word-count_2.11-1.0.jar est créé.
      4. Entreposez le package sur Cloud Storage.
        gcloud storage cp target/scala-2.11/word-count_2.11-1.0.jar \
            gs://${BUCKET_NAME}/scala/word-count_2.11-1.0.jar
        

      Python

      1. Copiez word-count.py sur votre ordinateur local. Il s'agit d'une tâche Spark en Python qui lit les fichiers texte de Cloud Storage, effectue un décompte des mots, puis écrit les résultats des fichiers texte dans Cloud Storage.
        #!/usr/bin/env python
        
        import pyspark
        import sys
        
        if len(sys.argv) != 3:
          raise Exception("Exactly 2 arguments are required: <inputUri> <outputUri>")
        
        inputUri=sys.argv[1]
        outputUri=sys.argv[2]
        
        sc = pyspark.SparkContext()
        lines = sc.textFile(sys.argv[1])
        words = lines.flatMap(lambda line: line.split())
        wordCounts = words.map(lambda word: (word, 1)).reduceByKey(lambda count1, count2: count1 + count2)
        wordCounts.saveAsTextFile(sys.argv[2])

      Envoyer la tâche

      Exécutez la commande gcloud suivante pour envoyer la tâche de décompte à votre cluster Dataproc.

      Java

      gcloud dataproc jobs submit spark \
          --cluster=${CLUSTER} \
          --class=dataproc.codelab.WordCount \
          --jars=gs://${BUCKET_NAME}/java/word-count-1.0.jar \
          --region=${REGION} \
          -- gs://${BUCKET_NAME}/input/ gs://${BUCKET_NAME}/output/
      

      Scala

      gcloud dataproc jobs submit spark \
          --cluster=${CLUSTER} \
          --class=dataproc.codelab.WordCount \
          --jars=gs://${BUCKET_NAME}/scala/word-count_2.11-1.0.jar \
          --region=${REGION} \
          -- gs://${BUCKET_NAME}/input/ gs://${BUCKET_NAME}/output/
      

      Python

      gcloud dataproc jobs submit pyspark word-count.py \
          --cluster=${CLUSTER} \
          --region=${REGION} \
          -- gs://${BUCKET_NAME}/input/ gs://${BUCKET_NAME}/output/
      

      Consulter le résultat

      Une fois le job terminé, exécutez la commande suivante de gcloud CLI pour afficher le résultat du décompte.

      gcloud storage cat gs://${BUCKET_NAME}/output/*
      

      Le résultat du décompte doit ressembler à celui-ci :

      (a,2)
      (call,1)
      (What's,1)
      (sweet.,1)
      (we,1)
      (as,1)
      (name?,1)
      (any,1)
      (other,1)
      (rose,1)
      (smell,1)
      (name,1)
      (would,1)
      (in,1)
      (which,1)
      (That,1)
      (By,1)
      

      Effectuer un nettoyage

      Une fois le tutoriel terminé, vous pouvez procéder au nettoyage des ressources que vous avez créées afin qu'elles ne soient plus comptabilisées dans votre quota et qu'elles ne vous soient plus facturées. Dans les sections suivantes, nous allons voir comment supprimer ou désactiver ces ressources.

      Supprimer le projet

      Le moyen le plus simple d'empêcher la facturation est de supprimer le projet que vous avez créé pour ce tutoriel.

      Pour supprimer le projet :

      1. In the Google Cloud console, go to the Manage resources page.

        Go to Manage resources

      2. In the project list, select the project that you want to delete, and then click Delete.
      3. In the dialog, type the project ID, and then click Shut down to delete the project.

      Supprimer le cluster Dataproc

      Au lieu de supprimer votre projet, vous souhaiterez peut-être simplement supprimer votre cluster au sein du projet.

      Supprimer le bucket Cloud Storage

    26. In the Google Cloud console, go to the Cloud Storage Buckets page.

      Go to Buckets

    27. Click the checkbox for the bucket that you want to delete.
    28. To delete the bucket, click Delete, and then follow the instructions.
    29. Étapes suivantes