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

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

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 accepter plusieurs partages Microsoft Windows.

Remarques importantes

Mises à jour automatiques continues

Par défaut, le connecteur surveille en permanence les chemins de démarrage (valeurs de fs.src dans le fichier de configuration du connecteur) au démarrage. Lorsque le système de fichiers signale des modifications de contenu ou des contrôles d'accès, le connecteur est déclenché pour réexplorer le système de fichiers. Cette réexploration peut utiliser 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 attendez que le connecteur reflète les 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 a généralement sa propre 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 obtenir uniquement un sous-ensemble des liens DFS, voire un seul lien lorsque l'ABE isole des répertoires d'accueil hébergés. Lorsque le connecteur balaie un système DFS, il respecte la LCA de la liaison DFS et celle 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 DFS (Distributed File System). Toutefois, le connecteur accepte uniquement les liens DFS d'un espace de noms DFS, et non les dossiers standards de l'espace de noms DFS.
  • Les liens de fichiers renvoyés sur cloudsearch.google.com ne sont pas cliquables. Par ailleurs, les liens de fichiers renvoyés par l'API Query ne sont pas cliquables dans la plupart des navigateurs.

Configuration système requise

Configuration système requise
Système d'exploitation
  • Windows Server 2016
  • Windows Server 2012
  • Windows Server 2008 R2
Logiciel
  • 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
  • SMB Message Block (SMB) : SMB1
  • SMB Message Block (SMB) : SMB2
  • Système de fichiers distribué (DFS)

Non compatible : système de fichiers Windows local, système de fichiers Sun Network 2.0, système de fichiers Sun 3.0 ou système Linux local.

Déployer le connecteur

Conditions préalables

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
  • Autorisations de lecture (LCA) pour les fichiers et les dossiers
  • Modifier les autorisations de base des attributs

L'appartenance à l'un des groupes suivants accorde à un compte Windows les autorisations suffisantes 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 des contenus directement depuis GitHub:

    1. Accédez à https://github.com/google-cloudsearch/windows-filesystems-connector.
    2. Cliquez sur Clone or download Download zip (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 lorsque vous créez le 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 celui de l'installation du connecteur, créez un fichier nommé connector-config.properties.

  2. Ajoutez des paramètres sous forme de paires clé/valeur au contenu du fichier, 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, puis 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 support

Par défaut, le connecteur tente de détecter le type de contenu de chaque fichier à l'aide de la fonctionnalité de détection de type de média fournie par JDK. Sous Microsoft Windows, JDK s'appuie sur le registre Windows pour déterminer les types de médias des fichiers. Une entrée de registre manquante peut entraîner un type de média "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 média 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 médias 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

Une fois que vous avez installé et configuré le connecteur de systèmes de fichiers, exécutez une commande semblable à celle-ci 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 de celui 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ètre
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é 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ètre
Systèmes de fichiers sources fs.src=path1[,path2, ...]

Obligatoire. Spécifiez les systèmes de fichiers sources comme une ou plusieurs 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 Unicode Unicode.

Caractère de séparateur de chemin

Paramètre Paramètre
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 qui 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ètre
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 de l'annuaire Active Directory.

Inclure les 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 ou non de comptes intégrés.

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

Indiquez 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 des fichiers et des dossiers masqués (sous Windows, les fichiers ou dossiers sont considérés comme masqués si l'attribut DOS correspondant est défini). La valeur par défaut est false.

Autoriser l'indexation des listes de dossiers explorés et les énumérations d'espaces de noms DFS fs.indexFolders=boolean

Si la valeur est true (valeur par défaut), le connecteur crée un objet CONTAINER_ITEM lorsqu'il explore un dossier. 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

Lorsque ce paramètre est défini sur true (valeur par défaut), les modifications apportées au contenu ou aux contrôles d'accès déclenchent la réexploration par le connecteur. Lorsque vous désactivez la surveillance (false), vous réduisez considérablement l'utilisation des ressources par le connecteur, mais la prise en compte des modifications est retardée.

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 ainsi éviter d'indexer les fichiers et les dossiers contenus dans ces dossiers.

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

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

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

Lors de l'exploration des fichiers et des dossiers, le connecteur peut modifier l'horodatage du dernier accès aux fichiers au moment de l'exploration. Lorsque les heures du dernier accès ne sont pas conservées, les systèmes de sauvegarde et d'archivage risquent de 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 associé au balayage ne dispose pas des autorisations suffisantes pour écrire les attributs du fichier. Si la valeur est définie sur ALWAYS, le connecteur refuse les demandes d'exploration du système de fichiers afin de ne pas modifier les codes temporels des derniers accès.

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 refuse toutes les demandes d'exploration suivantes du système de fichiers afin d'éviter de modifier les codes temporels 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. L'exploration continue, même si certains horodatages ne sont pas conservés.
  • NEVER : le connecteur n'essaie pas de conserver la date et l'heure du dernier accès lors de l'exploration des fichiers et des dossiers.
Explorer seulement les fichiers ayant été 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 seulement les fichiers consultés au cours des derniers jours fs.lastAccessedDays=number-of-days

Le contenu est exploré uniquement si la date et l'heure du dernier accès se situent dans le nombre de jours indiqué. La valeur par défaut est disabled.

Utilisez cette propriété pour que les contenus précédemment indexés qui n'ont pas été consultés depuis un certain temps arrivent à expiration. Par exemple, définissez la valeur 365 pour explorer le contenu uniquement 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.

N'explorer que les fichiers 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 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.

N'explorer que les fichiers modifiés au cours des derniers 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 le nombre de jours indiqué. La valeur par défaut est disabled.

Utilisez cette propriété pour faire expirer un contenu précédemment indexé qui n'a pas été modifié depuis un certain temps. Par exemple, définissez la valeur 365 pour explorer le contenu uniquement s'il a été modifié au cours de l'année passé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 des 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. Cependant, dans certaines configurations, le connecteur ne dispose pas des autorisations suffisantes pour lire la LCA du partage. Dans ce cas, le connecteur ne renvoie pas les fichiers conservés sur ce partage dans les résultats de recherche.

Vous pouvez faire en sorte que le connecteur ignore la LCA du partage afin que le contenu soit toujours renvoyé dans les résultats de recherche. Dans ce cas, l'API d'indexation obtient une LCA de partage entièrement permissive, plutôt que la véritable LCA du partage.

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

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