Déployer le connecteur de systèmes de fichiers Microsoft Windows

Vous pouvez configurer Google Cloud Search pour qu'il renvoie les résultats des partages Microsoft Windows de votre organisation, en plus de votre contenu Google Workspace. Vous utilisez le connecteur de systèmes de fichiers Google Cloud Search et le configurez pour accéder aux partages Windows spécifiés. Une même instance de connecteur peut prendre en charge plusieurs partages Microsoft Windows.

Remarques importantes

Mises à jour automatiques continues

Par défaut, le connecteur surveille en permanence les chemins de départ (valeurs de fs.src dans le fichier de configuration du connecteur) au démarrage du connecteur. Lorsque le système de fichiers signale des modifications apportées au contenu ou aux contrôles d'accès, le connecteur est déclenché pour réexplorer le système de fichiers. Cette réexploration peut consommer beaucoup de ressources. Pour désactiver la surveillance du système de fichiers, définissez fs.monitorForUpdates sur false. Vous réduisez considérablement l'utilisation des ressources par le connecteur, mais cela retarde la prise en compte des modifications. En savoir plus

Contrôle des accès DFS

Le système DFS applique un contrôle d'accès à ses liens et chaque lien DFS possède généralement sa propre liste de contrôle d'accès (LCA). L'un des mécanismes utilisés par DFS est l'énumération basée sur l'accès (ABE, Access-based Enumeration), qui peut limiter les liens DFS renvoyés à un utilisateur. Les utilisateurs peuvent n'obtenir qu'un sous-ensemble des liens DFS, voire un seul lien lorsque l'ABE isole les répertoires d'accueil hébergés. Lorsque le connecteur traverse un système DFS, il respecte la LCA du lien DFS et celle du partage de la cible, et la LCA du partage hérite de la LCA DFS.

Limites connues

  • Système de fichiers: le connecteur de systèmes de fichiers n'est pas compatible avec les lecteurs mappés et les lecteurs locaux.
  • Système de fichiers distribué: un lecteur mappé sur un DFS UNC ne fonctionne pas correctement. Certaines LCA ne sont pas lues correctement.
  • Le connecteur de systèmes de fichiers est compatible avec les espaces de noms et les liens du système de fichiers distribué (DFS). Toutefois, le connecteur n'accepte que les liens DFS d'un espace de noms DFS, pas les dossiers standards de l'espace de noms DFS.
  • Les liens de fichiers renvoyés sur cloudsearch.google.com ne sont pas cliquables. Dans la plupart des navigateurs, il n'est pas non plus possible de cliquer sur les liens de fichiers renvoyés par l'API Query.

Configuration requise

Configuration requise
Système d'exploitation
  • Windows Server 2016
  • Windows Server 2012
  • Windows Server 2008 R2
Logiciels
  • Java JRE 1.8 installé sur l'ordinateur qui exécute le connecteur de systèmes de fichiers Google Cloud Search
Protocoles de système de fichiers
  • SMB1 (Server Message Block) : SMB1
  • SMB (Server Message Block) : SMB2
  • Système de fichiers distribué (DFS)

Non compatibles:systèmes de fichiers Windows locaux, système de fichiers Sun Network (NFS) 2.0, système de fichiers réseau Sun (NFS) 3.0 ou système de fichiers Linux local.

Déployer le connecteur

Prérequis

Avant de déployer le connecteur de systèmes de fichiers Cloud Search, assurez-vous que votre environnement comporte tous les composants prérequis suivants:

Autorisations de compte Microsoft Windows requises

Le compte Microsoft Windows sous lequel le connecteur s'exécute doit disposer d'autorisations suffisantes pour effectuer les actions suivantes:

  • Lister le contenu des dossiers
  • Lire le contenu des documents
  • Lire les attributs des fichiers et des dossiers
  • Lire les autorisations (LCA) pour les fichiers et les dossiers
  • Écrire des autorisations de base concernant les attributs

Les comptes Windows appartenant à l'un des groupes suivants disposent des autorisations nécessaires au connecteur:

  • Administrateurs
  • Utilisateurs expérimentés
  • Opérateurs d'impression
  • Opérateurs de serveur

Étape 1. Installer le connecteur de systèmes de fichiers Google Cloud Search

  1. Récupérez le dépôt du connecteur sur GitHub et compilez-le.

    Pour utiliser git sur le serveur Windows:

    1. Clonez le dépôt :

      > git clone https://github.com/google-cloudsearch/windows-filesystems-connector.git
> cd windows-filesystems-connector

    2. Vérifiez la version souhaitée du connecteur:

      > git checkout tags/v1-0.0.3

    Pour télécharger directement depuis GitHub:

    1. Accédez à la page https://github.com/google-cloudsearch/windows-filesystems-connector.
    2. Cliquez sur Cloner ou télécharger Télécharger le fichier ZIP.
    3. Décompressez le package.
    4. Accédez au nouveau répertoire : 
      > cd windows-filesystems-connector

  2. Créez le connecteur. Si nécessaire, installez Apache Maven.

    > mvn package

    Pour ignorer les tests lors de la création du connecteur, exécutez mvn package -DskipTests au lieu de mvn package.

  3. Copiez le fichier ZIP du connecteur dans votre répertoire d'installation local:

    > cp target/google-cloudsearch-windows-filesystems-connector-v1-0.0.3.zip installation-dir
> cd installation-dir
> unzip google-cloudsearch-windows-filesystems-connector-v1-0.0.3.zip
> cd google-cloudsearch-windows-filesystems-connector-v1-0.0.3

Étape 2. Créer le fichier de configuration du connecteur

  1. Dans le même répertoire que les fichiers d'installation du connecteur, créez un fichier nommé connector-config.properties.

  2. Ajoutez des paramètres sous forme de paires clé/valeur aux contenus des fichiers, comme dans l'exemple suivant:

    ### File system connector configuration ###

# Required parameters for Cloud Search data source and identity source access
api.serviceAccountPrivateKeyFile=/path/to/file.json
api.sourceId=0123456789abcde
api.identitySourceId=a1b1c1234567

# Required parameters for file system access
fs.src=\\\\host\\share;\\\\dfshost\\dfsnamespace;\\\\dfshost\\dfsnamespace\\link

# Optional parameters for file system monitoring
traverse.abortAfterExceptions=500
fs.monitorForUpdates = true
fs.preserveLastAccessTime = IF_ALLOWED

    Pour obtenir une description détaillée de chaque paramètre, consultez la documentation de référence sur les paramètres de configuration.

  3. (Facultatif) Configurez d'autres paramètres de connecteur, si nécessaire. Pour en savoir plus, consultez Paramètres de connecteur fournis par Google.

Étape 3. Activer la journalisation

  1. Créez un dossier nommé logs dans le répertoire contenant le binaire du connecteur.

  2. Créez un fichier ASCII ou UTF-8 nommé logging.properties dans le répertoire contenant le binaire du connecteur et ajoutez le contenu suivant:

    handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
# Default log level
.level = WARNING
com.google.enterprise.cloudsearch.level = INFO
com.google.enterprise.cloudsearch.fs.level = INFO

# uncomment line below to increase logging level to enable API trace
#com.google.api.client.http.level = FINE
java.util.logging.ConsoleHandler.level = INFO
java.util.logging.FileHandler.pattern=logs/connector-fs.%g.log
java.util.logging.FileHandler.limit=10485760
java.util.logging.FileHandler.count=10
java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

Étape 4. (Facultatif) Configurer les types de contenus

Par défaut, le connecteur tente de détecter le type de contenu de chaque fichier grâce à la détection du type de contenu fournie par JDK. Sous Microsoft Windows, JDK s'appuie sur le registre Windows pour déterminer le type de contenu des fichiers. Une entrée de registre manquante peut entraîner la valeur "null" pour certains fichiers.

Si nécessaire, vous pouvez spécifier un type de média qui écrase toutes les liaisons existantes ou empêche un type de contenu nul.

  1. Dans le répertoire du connecteur, créez un fichier chiffré en Latin-1 nommé mime-type.properties.

  2. Saisissez les extensions de fichier et les types de support correspondants comme dans les exemples suivants:

    xlsx=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
one=application/msonenote
txt=text/plain
pdf=application/pdf

Étape 5: Exécuter le connecteur de systèmes de fichiers

Après avoir installé et configuré le connecteur de systèmes de fichiers, exécutez une commande semblable à l'exemple suivant pour le lancer sur la machine hôte:

> java -jar google-cloudsearch-windows-filesystems-connector-v1-0.0.3.jar -Djava.util.logging.config.file=logging.properties[ -Dconfig=my.config]

Spécifiez le chemin d'accès au fichier de configuration s'il est différent du chemin par défaut (dans le même répertoire que le binaire portant le nom connector-config.properties).

Documentation de référence sur les paramètres de configuration

Accès à la source de données

Paramètre Paramètres
ID de la source de données api.sourceId=1234567890abcdef

Obligatoire. ID de la source Google Cloud Search configuré par l'administrateur Google Workspace.
Chemin d'accès au fichier contenant la clé privée du compte de service api.serviceAccountPrivateKeyFile=./PrivateKey.json

Obligatoire. Fichier contenant la clé du compte de service Google Cloud Search pour l'accessibilité du connecteur de systèmes de fichiers Google Cloud Search.
ID de la source d'identité api.identitySourceId=x0987654321

Obligatoire. ID de la source d'identité Cloud Search configurée par l'administrateur Google Workspace pour la synchronisation des identités Active Directory avec GCDS.

Accès au système de fichiers

Paramètre Paramètres
Systèmes de fichiers sources fs.src=path1[,path2, ...]

Obligatoire. Spécifiez les systèmes de fichiers sources en tant que sources UNC séparées par le délimiteur configuré par fs.src.separator. Si vous utilisez des caractères qui ne sont pas en Latin1, encodez-les avec des caractères d'échappement Java Unicode.

Caractère de séparateur de chemin

Paramètre Paramètres
Caractère de séparateur de chemin fs.src.separator=separator-character

Le séparateur par défaut est ";". Si vos chemins d'accès sources contiennent des points-virgules, vous pouvez définir un délimiteur différent, comme une virgule (","), qui n'entre pas en conflit avec les caractères de vos chemins et n'est pas réservé par la syntaxe du fichier de propriétés.

Si la valeur fs.src.separator est une chaîne vide, la valeur fs.src est traitée comme un chemin unique.

Comportement du connecteur

Paramètre Paramètres
Domaine Windows fs.supportedDomain=domain

Obligatoire pour permettre aux utilisateurs configurés avec GCDS d'accéder aux documents via Cloud Search. Spécifiez un seul nom de domaine NetBIOS pour l'annuaire Active Directory.
Inclure des comptes dans les LCA fs.supportedAccounts=account-1[, account-2,...]

Liste de comptes séparés par une virgule à inclure dans les LCA, qu'il s'agisse de comptes intégrés ou non.

La valeur par défaut est BUILTIN\\Administrators,Everyone,BUILTIN\\Users, BUILTIN\\Guest,NT AUTHORITY\\INTERACTIVE, NT AUTHORITY\\Authenticated Users.
Exclure des comptes intégrés des LCA fs.builtinGroupPrefix=prefix

Spécifiez le préfixe des comptes intégrés. Un compte commençant par ce préfixe est considéré comme un compte intégré et sera exclu des LCA.

La valeur par défaut est BUILTIN\\.
Autoriser l'indexation des fichiers et dossiers cachés fs.crawlHiddenFiles=boolean

Définissez la valeur sur true pour permettre au connecteur d'explorer les fichiers et dossiers cachés (sur les systèmes de fichiers Windows, un fichier ou un dossier est considéré comme masqué si l'attribut DOS masqué est défini). La valeur par défaut est false.
Autoriser l'indexation des listes de dossiers explorés et des énumérations d'espaces de noms DFS fs.indexFolders=boolean

Si la valeur est true (par défaut), lorsque le connecteur explore un dossier, il crée un objet CONTAINER_ITEM. Si la valeur est "false", le connecteur crée un objet VIRTUAL_CONTAINER_ITEM.
Activer la surveillance des modifications du système de fichiers fs.monitorForUpdates=boolean

Si la valeur est true (par défaut), les modifications apportées au contenu ou aux contrôles d'accès déclenchent la réexploration du connecteur. Lorsque vous désactivez la surveillance (définie sur false), vous réduisez considérablement l'utilisation des ressources par le connecteur, mais cela retarde la prise en compte des modifications par le connecteur.
Définir la taille maximale du cache des répertoires fs.directoryCacheSize=number-of-entries

Taille maximale du cache de répertoire. Le connecteur utilise le cache pour identifier les dossiers masqués et éviter ainsi d'indexer les fichiers et les dossiers contenus dans ces dossiers.

La valeur par défaut est de 50 000 entrées, ce qui consomme généralement entre 10 et 15 mégaoctets de RAM.

Conservation de l'horodatage et contrôle de l'exploration

Paramètre Paramètres
Conserver l'horodatage du dernier accès fs.preserveLastAccessTime=value

Lorsque le connecteur explore des fichiers et des dossiers, il peut remplacer l'horodatage du dernier accès par l'heure de l'exploration. Lorsque les heures de dernier accès ne sont pas conservées, les systèmes de sauvegarde et d'archivage peuvent ne pas déplacer les fichiers et dossiers appropriés vers l'espace de stockage secondaire en raison de la visite du connecteur.

Par défaut, le connecteur tente de conserver la date et l'heure du dernier accès (fs.preserveLastAccessTime défini sur ALWAYS). Il est possible que le connecteur ne puisse pas restaurer la date et l'heure du dernier accès au fichier si l'utilisateur utilisé pour le balayage ne dispose pas des droits suffisants pour écrire les attributs de fichier. Lorsque la valeur est ALWAYS, le connecteur refuse les demandes d'exploration du système de fichiers afin de ne pas modifier l'horodatage du dernier accès aux fichiers.

Les valeurs possibles sont :

  • ALWAYS: le connecteur tente de conserver la date et l'heure du dernier accès lors de l'exploration des fichiers et des dossiers. La première fois que le connecteur ne peut pas conserver la date et l'heure du dernier accès, il rejette toutes les demandes d'exploration ultérieures du système de fichiers pour éviter de modifier l'horodatage du dernier accès.
  • IF_ALLOWED: le connecteur tente de conserver la date et l'heure du dernier accès lors de l'exploration des fichiers et des dossiers. Il continue l'exploration même si certains horodatages ne sont pas conservés.
  • NEVER: le connecteur ne tente pas de conserver la date et l'heure du dernier accès lors de l'exploration des fichiers et des dossiers.
Explorer uniquement les fichiers consultés après une certaine date fs.lastAccessedDate=YYYY-MM-DD

Le contenu est exploré uniquement si la date et l'heure du dernier accès sont postérieures à la date spécifiée. La valeur par défaut est disabled.

Indiquez la date au format ISO8601: AAAA-MM-JJ. Par exemple, si la valeur est 2010-01-01, le connecteur n'explore que le contenu consulté après le début de l'année 2010.

Si vous spécifiez fs.lastAccessedDate, vous ne pouvez pas définir de valeur pour fs.lastAccessedDays.
Explorer uniquement les fichiers consultés au cours d'un certain nombre de jours fs.lastAccessedDays=number-of-days

Le contenu est exploré uniquement si la date et l'heure du dernier accès sont comprises dans la plage de jours indiquée. La valeur par défaut est disabled.

Utilisez cette propriété pour faire expirer le contenu précédemment indexé qui n'a pas été consulté depuis un certain temps. Par exemple, définissez la valeur 365 pour n'explorer le contenu que s'il a été consulté au cours de l'année écoulée.

Si vous spécifiez fs.lastAccessedDays, vous ne pouvez pas définir de valeur pour fs.lastAccessedDate.
Explorer uniquement les fichiers qui ont été modifiés après une certaine date fs.lastModifiedDate=YYYY-MM-DD

Le contenu est exploré uniquement si la date et l'heure de la dernière modification sont postérieures à la date spécifiée. La valeur par défaut est disabled.

Indiquez la date au format ISO8601: AAAA-MM-JJ. Par exemple, si la valeur est 2010-01-01, le connecteur n'explore que le contenu qui a été modifié après le début de l'année 2010.

Si vous spécifiez fs.lastModifiedDate, vous ne pouvez pas définir de valeur pour fs.lastModifiedDays.
Explorer uniquement les fichiers qui ont été modifiés au cours d'un certain nombre de jours fs.lastModifiedDays=number-of-days

Le contenu est exploré uniquement si la date et l'heure de la dernière modification sont comprises dans la plage de jours indiquée. La valeur par défaut est disabled.

Utilisez cette propriété pour faire expirer le contenu précédemment indexé qui n'a pas été modifié depuis un certain temps. Par exemple, définissez la valeur 365 pour que le contenu ne soit exploré que s'il a été modifié au cours de l'année écoulée.

Si vous spécifiez fs.lastModifiedDays, vous ne pouvez pas définir de valeur pour fs.lastModifiedDate.

Ignorer le contrôle d'accès du partage de fichiers

Par défaut, le connecteur préserve l'intégrité du contrôle d'accès lorsqu'il envoie des listes de contrôle d'accès (LCA) à l'API d'indexation, y compris les LCA du partage de fichiers. Toutefois, dans certaines configurations, le connecteur ne dispose pas des autorisations nécessaires pour lire la LCA du partage. Dans ce cas, le connecteur n'affiche pas les fichiers stockés sur ce partage dans les résultats de recherche.

Vous pouvez configurer le connecteur de sorte qu'il ignore la LCA du partage afin que le contenu s'affiche systématiquement dans les résultats de recherche. Dans ce cas, l'API d'indexation reçoit une LCA de partage entièrement permissive, et non la véritable LCA du partage.

Paramètre Paramètres
Ignorer le contrôle d'accès du partage de fichiers fs.skipShareAccessControl=boolean

Définissez la valeur sur false (par défaut) pour appliquer les LCA de partage. Définissez la valeur sur true pour ignorer les LCA du partage.