Esegui il deployment del connettore

Questa pagina del tutorial di Cloud Search mostra come configurare un'origine dati e un connettore di contenuti per l'indicizzazione dei dati. Per iniziare dall'inizio di questo tutorial, consulta la guida introduttiva a Cloud Search.

Crea il connettore

Cambia la directory di lavoro in cloud-search-samples/end-to-end/connector ed esegui questo comando:

mvn package -DskipTests

Il comando scarica le dipendenze necessarie per creare il connettore di contenuti e compila il codice.

Crea le credenziali del service account

Il connettore richiede le credenziali del service account per chiamare le API Cloud Search. Per creare le credenziali:

1. Torna alla console Google Cloud.
2. Nel menu di navigazione a sinistra, fai clic su Credenziali. Viene visualizzata la pagina "Credenziali".
3. Fai clic sull'elenco a discesa + CREA CREDENZIALI e seleziona Account di servizio. Viene visualizzata la pagina "Crea service account".
4. Nel campo Nome service account, inserisci "tutorial".
5. Prendi nota del valore dell'ID service account (subito dopo il nome del service account). Questo valore verrà utilizzato in un secondo momento.
6. Fai clic su CREA. Viene visualizzata la finestra di dialogo "Autorizzazioni service account (facoltativo)".
7. Fai clic su CONTINUA. Viene visualizzata la finestra di dialogo "Concedi agli utenti l'accesso a questo service account (facoltativo)".
8. Fai clic su FINE. Viene visualizzata la schermata "Credenziali".
9. In Account di servizio, fai clic sull'email dell'account di servizio. Viene visualizzata la pagina "Dettagli del service account".
10. In Chiavi, fai clic sul menu a discesa AGGIUNGI CHIAVE e seleziona Crea nuova chiave. Viene visualizzata la finestra di dialogo "Crea chiave privata".
11. Fai clic su CREA.
12. (Facoltativo) Se viene visualizzata la finestra di dialogo "Vuoi consentire i download su console.cloud.google.com?", fai clic su Consenti.
13. Un file di chiave privata viene salvato sul tuo computer. Prendi nota della posizione del file scaricato. Questo file viene utilizzato per configurare il connettore dei contenuti in modo che possa autenticarsi quando chiama le API Google Cloud Search.

Inizializzare l'assistenza di terze parti

Prima di poter chiamare altre API Cloud Search, devi inizializzare il supporto di terze parti per Google Cloud Search.

Per inizializzare il supporto di terze parti per Cloud Search:

1. Il progetto della piattaforma Cloud Search contiene le credenziali del service account. Tuttavia, per inizializzare il supporto di terze parti, devi creare le credenziali dell'applicazione web. Per istruzioni su come creare le credenziali dell'applicazione web, consulta Creare le credenziali. Al termine di questo passaggio, dovresti avere un file con l'ID client e il client secret.

2. Utilizza OAuth 2 Playground di Google per ottenere un token di accesso:

   1. Fai clic su Impostazioni e seleziona Utilizza le tue credenziali di autenticazione.
   2. Inserisci l'ID client e il client secret del passaggio 1.
   3. Fai clic su Chiudi.
   4. Nel campo degli ambiti, digita https://www.googleapis.com/auth/cloud_search.settings e fai clic su Autorizza. OAuth 2 Playground restituisce un codice di autorizzazione.
   5. Fai clic su Exchange authorization code for tokens (Scambio codice di autorizzazione per i token). Viene restituito un token.

3. Per inizializzare il supporto di terze parti per Cloud Search, utilizza il seguente comando curl. Assicurati di sostituire [YOUR_ACCESS_TOKEN] con il token ottenuto nel passaggio 2.

   curl --request POST \
   'https://cloudsearch.googleapis.com/v1:initializeCustomer' \
     --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '{}' \
     --compressed
   

   In caso di esito positivo, il corpo della risposta contiene un'istanza di operation. Ad esempio:

   {
   name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
   }
   

   Se non riesci, contatta l'assistenza Cloud Search.

4. Utilizza operations.get per verificare che il supporto di terze parti sia inizializzato:

   curl \
   'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=
   [YOUR_API_KEY]' \
   --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
   --header 'Accept: application/json' \
   --compressed
   

   Al termine dell'inizializzazione di terze parti, contiene il campo done impostato su true. Ad esempio:

   {
   name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
   done: true
   }
   

Crea l'origine dati

Poi, crea un'origine dati nella Console di amministrazione. L'origine dati fornisce uno spazio dei nomi per l'indicizzazione dei contenuti utilizzando il connettore.

1. Apri la Console di amministrazione Google.
2. Fai clic sull'icona App. Viene visualizzata la pagina "Amministrazione app".
3. Fai clic su Google Workspace. Viene visualizzata la pagina "Amministrazione di Google Workspace Apps".
4. Scorri verso il basso e fai clic su Cloud Search. Viene visualizzata la pagina "Impostazioni per Google Workspace".
5. Fai clic su Origini dati di terze parti. Viene visualizzata la pagina "Origini dati".
6. Fai clic sul pulsante giallo rotondo +. Viene visualizzata la finestra di dialogo "Aggiungi nuova origine dati".
7. Nel campo Nome visualizzato, digita "tutorial".
8. Nel campo Indirizzi email degli account di servizio, inserisci l'indirizzo email dell'account di servizio che hai creato nella sezione precedente. Se non conosci l'indirizzo email del service account, cerca il valore nella pagina Service account.
9. Fai clic su AGGIUNGI. Viene visualizzata la finestra di dialogo "L'origine dati è stata creata".
10. Fai clic su *Ok. Prendi nota dell'ID origine della nuova origine dati creata. L'ID origine viene utilizzato per configurare il connettore di contenuti.

Generare un token di accesso personale per l'API GitHub

Il connettore richiede l'accesso autenticato all'API GitHub per disporre di una quota sufficiente. Per semplicità, il connettore utilizza token di accesso personale anziché OAuth. I token personali consentono l'autenticazione come utente con un insieme limitato di autorizzazioni simile a OAuth.

1. Accedi a GitHub.
2. Nell'angolo in alto a destra, fai clic sulla tua immagine del profilo. Viene visualizzato un menu a discesa.
3. Fai clic su Impostazioni.
4. Fai clic su Impostazioni sviluppatore.
5. Fai clic su Token di accesso personali.
6. Fai clic su Genera token di accesso personale.
7. Nel campo Nota, inserisci "Tutorial su Cloud Search".
8. Controlla l'ambito public_repo.
9. Fai clic su Genera token.
10. Prendi nota del token generato. Viene utilizzato dal connettore per chiamare le API GitHub e fornisce la quota API per eseguire l'indicizzazione.

Configura il connettore

Dopo aver creato le credenziali e l'origine dati, aggiorna la configurazione del connettore in modo da includere questi valori:

1. Dalla riga di comando, cambia directory in cloud-search-samples/end-to-end/connector/.
2. Apri il file sample-config.properties con un editor di testo.
3. Imposta il parametro api.serviceAccountPrivateKeyFile sul percorso del file delle credenziali del servizio che hai scaricato in precedenza.
4. Imposta il parametro api.sourceId sull'ID dell'origine dati che hai creato in precedenza.
5. Imposta il parametro github.user sul tuo nome utente GitHub.
6. Imposta il parametro github.token sul token di accesso che hai creato in precedenza.
7. Salva il file.

Aggiorna lo schema

Il connettore indicizza i contenuti strutturati e non strutturati. Prima di indicizzare i dati, devi aggiornare lo schema dell'origine dati. Esegui questo comando per aggiornare lo schema:

mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
    -Dexec.args="-Dconfig=sample-config.properties"

Esegui il connettore

Per eseguire il connettore e iniziare l'indicizzazione, esegui il comando:

mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
    -Dexec.args="-Dconfig=sample-config.properties"

La configurazione predefinita del connettore prevede l'indicizzazione di un singolo repository nell'organizzazione googleworkspace. L'indicizzazione del repository richiede circa 1 minuto. Dopo l'indicizzazione iniziale, il connettore continua a eseguire il polling per rilevare le modifiche al repository che devono essere riportate nell'indice Cloud Search.

Revisione del codice

Le sezioni rimanenti esaminano la struttura del connettore.

Avvio dell'applicazione

Il punto di ingresso del connettore è la classe GithubConnector. Il metodo main crea un'istanza di IndexingApplication dell'SDK e lo avvia.

/**
 * Main entry point for the connector. Creates and starts an indexing
 * application using the {@code ListingConnector} template and the sample's
 * custom {@code Repository} implementation.
 *
 * @param args program command line arguments
 * @throws InterruptedException thrown if an abort is issued during initialization
 */
public static void main(String[] args) throws InterruptedException {
  Repository repository = new GithubRepository();
  IndexingConnector connector = new ListingConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args)
      .build();
  application.start();
}

ListingConnector fornito dall'SDK implementa una strategia di attraversamento che sfrutta le code di Cloud Search per monitorare lo stato degli elementi nell'indice. Delega a GithubRepository, implementato dal connettore di esempio, per accedere ai contenuti di GitHub.

Esplorazione dei repository GitHub

Durante le traversie complete, viene chiamato il metodo getIds() per inserire in coda gli elementi che potrebbero dover essere indicizzati.

Il connettore può indicizzare più repository o organizzazioni. Per ridurre al minimo l'impatto di un errore, viene attraversato un repository GitHub alla volta. Un checkpoint viene restituito con i risultati dell'attraversamento contenente l'elenco dei repository da indicizzare nelle chiamate successive a getIds(). Se si verifica un errore, l'indicizzazione viene ripresa dal repository corrente anziché ricominciare dall'inizio.

/**
 * Gets all of the existing item IDs from the data repository. While
 * multiple repositories are supported, only one repository is traversed
 * per call. The remaining repositories are saved in the checkpoint
 * are traversed on subsequent calls. This minimizes the amount of
 * data that needs to be reindex in the event of an error.
 *
 * <p>This method is called by {@link ListingConnector#traverse()} during
 * <em>full traversals</em>. Every document ID and metadata hash value in
 * the <em>repository</em> is pushed to the Cloud Search queue. Each pushed
 * document is later polled and processed in the {@link #getDoc(Item)} method.
 * <p>
 * The metadata hash values are pushed to aid document change detection. The
 * queue sets the document status depending on the hash comparison. If the
 * pushed ID doesn't yet exist in Cloud Search, the document's status is
 * set to <em>new</em>. If the ID exists but has a mismatched hash value,
 * its status is set to <em>modified</em>. If the ID exists and matches
 * the hash value, its status is unchanged.
 *
 * <p>In every case, the pushed content hash value is only used for
 * comparison. The hash value is only set in the queue during an
 * update (see {@link #getDoc(Item)}).
 *
 * @param checkpoint value defined and maintained by this connector
 * @return this is typically a {@link PushItems} instance
 */
@Override
public CheckpointCloseableIterable<ApiOperation> getIds(byte[] checkpoint)
    throws RepositoryException {
  List<String> repositories;
  // Decode the checkpoint if present to get the list of remaining
  // repositories to index.
  if (checkpoint != null) {
    try {
      FullTraversalCheckpoint decodedCheckpoint = FullTraversalCheckpoint
          .fromBytes(checkpoint);
      repositories = decodedCheckpoint.getRemainingRepositories();
    } catch (IOException e) {
      throw new RepositoryException.Builder()
          .setErrorMessage("Unable to deserialize checkpoint")
          .setCause(e)
          .build();
    }
  } else {
    // No previous checkpoint, scan for repositories to index
    // based on the connector configuration.
    try {
      repositories = scanRepositories();
    } catch (IOException e) {
      throw toRepositoryError(e, Optional.of("Unable to scan repositories"));
    }
  }

  if (repositories.isEmpty()) {
    // Nothing left to index. Reset the checkpoint to null so the
    // next full traversal starts from the beginning
    Collection<ApiOperation> empty = Collections.emptyList();
    return new CheckpointCloseableIterableImpl.Builder<>(empty)
        .setCheckpoint((byte[]) null)
        .setHasMore(false)
        .build();
  }

  // Still have more repositories to index. Pop the next repository to
  // index off the list. The remaining repositories make up the next
  // checkpoint.
  String repositoryToIndex = repositories.get(0);
  repositories = repositories.subList(1, repositories.size());

  try {
    log.info(() -> String.format("Traversing repository %s", repositoryToIndex));
    Collection<ApiOperation> items = collectRepositoryItems(repositoryToIndex);
    FullTraversalCheckpoint newCheckpoint = new FullTraversalCheckpoint(repositories);
    return new CheckpointCloseableIterableImpl.Builder<>(items)
        .setHasMore(true)
        .setCheckpoint(newCheckpoint.toBytes())
        .build();
  } catch (IOException e) {
    String errorMessage = String.format("Unable to traverse repo: %s",
        repositoryToIndex);
    throw toRepositoryError(e, Optional.of(errorMessage));
  }
}

Il metodo collectRepositoryItems() gestisce l'attraversamento di un singolo repository GitHub. Questo metodo restituisce una raccolta di ApiOperations che rappresentano gli elementi da inserire nella coda. Gli elementi vengono inviati come nome risorsa e valore hash che rappresenta lo stato attuale dell'elemento.

Il valore hash viene utilizzato nei passaggi successivi dei repository GitHub. Questo valore fornisce un controllo leggero per determinare se i contenuti sono stati modificati senza dover caricare contenuti aggiuntivi. Il connettore mette in coda tutti gli elementi. Se l'elemento è nuovo o il valore hash è cambiato, viene reso disponibile per il polling nella coda. In caso contrario, l'elemento viene considerato non modificato.

/**
 * Fetch IDs to  push in to the queue for all items in the repository.
 * Currently captures issues & content in the master branch.
 *
 * @param name Name of repository to index
 * @return Items to push into the queue for later indexing
 * @throws IOException if error reading issues
 */
private Collection<ApiOperation> collectRepositoryItems(String name)
    throws IOException {
  List<ApiOperation> operations = new ArrayList<>();
  GHRepository repo = github.getRepository(name);

  // Add the repository as an item to be indexed
  String metadataHash = repo.getUpdatedAt().toString();
  String resourceName = repo.getHtmlUrl().getPath();
  PushItem repositoryPushItem = new PushItem()
      .setMetadataHash(metadataHash);
  PushItems items = new PushItems.Builder()
      .addPushItem(resourceName, repositoryPushItem)
      .build();

  operations.add(items);
  // Add issues/pull requests & files
  operations.add(collectIssues(repo));
  operations.add(collectContent(repo));
  return operations;
}

Elaborazione della coda

Al termine dell'attraversamento completo, il connettore inizia a eseguire il polling della coda per gli elementi che devono essere indicizzati. Il metodo getDoc() viene chiamato per ogni elemento estratto dalla coda. Il metodo legge l'elemento da GitHub e lo converte nella rappresentazione corretta per l'indicizzazione.

Poiché il connettore viene eseguito su dati attivi che possono essere modificati in qualsiasi momento, getDoc() verifica anche che l'elemento nella coda sia ancora valido ed elimina dall'indice gli elementi che non esistono più.

/**
 * Gets a single data repository item and indexes it if required.
 *
 * <p>This method is called by the {@link ListingConnector} during a poll
 * of the Cloud Search queue. Each queued item is processed
 * individually depending on its state in the data repository.
 *
 * @param item the data repository item to retrieve
 * @return the item's state determines which type of
 * {@link ApiOperation} is returned:
 * {@link RepositoryDoc}, {@link DeleteItem}, or {@link PushItem}
 */
@Override
public ApiOperation getDoc(Item item) throws RepositoryException {
  log.info(() -> String.format("Processing item: %s ", item.getName()));
  Object githubObject;
  try {
    // Retrieve the item from GitHub
    githubObject = getGithubObject(item.getName());
    if (githubObject instanceof GHRepository) {
      return indexItem((GHRepository) githubObject, item);
    } else if (githubObject instanceof GHPullRequest) {
      return indexItem((GHPullRequest) githubObject, item);
    } else if (githubObject instanceof GHIssue) {
      return indexItem((GHIssue) githubObject, item);
    } else if (githubObject instanceof GHContent) {
      return indexItem((GHContent) githubObject, item);
    } else {
      String errorMessage = String.format("Unexpected item received: %s",
          item.getName());
      throw new RepositoryException.Builder()
          .setErrorMessage(errorMessage)
          .setErrorType(RepositoryException.ErrorType.UNKNOWN)
          .build();
    }
  } catch (FileNotFoundException e) {
    log.info(() -> String.format("Deleting item: %s ", item.getName()));
    return ApiOperations.deleteItem(item.getName());
  } catch (IOException e) {
    String errorMessage = String.format("Unable to retrieve item: %s",
        item.getName());
    throw toRepositoryError(e, Optional.of(errorMessage));
  }
}

Per ciascuno degli oggetti GitHub indicizzati dal connettore, il metodo indexItem() gestisce la creazione della rappresentazione dell'elemento per Cloud Search. Ad esempio, per creare la rappresentazione degli elementi di contenuti:

/**
 * Build the ApiOperation to index a content item (file).
 *
 * @param content      Content item to index
 * @param previousItem Previous item state in the index
 * @return ApiOperation (RepositoryDoc if indexing,  PushItem if not modified)
 * @throws IOException if unable to create operation
 */
private ApiOperation indexItem(GHContent content, Item previousItem)
    throws IOException {
  String metadataHash = content.getSha();

  // If previously indexed and unchanged, just requeue as unmodified
  if (canSkipIndexing(previousItem, metadataHash)) {
    return notModified(previousItem.getName());
  }

  String resourceName = new URL(content.getHtmlUrl()).getPath();
  FieldOrValue<String> title = FieldOrValue.withValue(content.getName());
  FieldOrValue<String> url = FieldOrValue.withValue(content.getHtmlUrl());

  String containerName = content.getOwner().getHtmlUrl().getPath();
  String programmingLanguage = FileExtensions.getLanguageForFile(content.getName());

  // Structured data based on the schema
  Multimap<String, Object> structuredData = ArrayListMultimap.create();
  structuredData.put("organization", content.getOwner().getOwnerName());
  structuredData.put("repository", content.getOwner().getName());
  structuredData.put("path", content.getPath());
  structuredData.put("language", programmingLanguage);

  Item item = IndexingItemBuilder.fromConfiguration(resourceName)
      .setTitle(title)
      .setContainerName(containerName)
      .setSourceRepositoryUrl(url)
      .setItemType(IndexingItemBuilder.ItemType.CONTAINER_ITEM)
      .setObjectType("file")
      .setValues(structuredData)
      .setVersion(Longs.toByteArray(System.currentTimeMillis()))
      .setHash(content.getSha())
      .build();

  // Index the file content too
  String mimeType = FileTypeMap.getDefaultFileTypeMap()
      .getContentType(content.getName());
  AbstractInputStreamContent fileContent = new InputStreamContent(
      mimeType, content.read())
      .setLength(content.getSize())
      .setCloseInputStream(true);
  return new RepositoryDoc.Builder()
      .setItem(item)
      .setContent(fileContent, IndexingService.ContentFormat.RAW)
      .setRequestMode(IndexingService.RequestMode.SYNCHRONOUS)
      .build();
}

A questo punto, esegui il deployment dell'interfaccia di ricerca.

Precedente Successivo