Microsoft Windows File Systems コネクタのデプロイ

Google Workspace のコンテンツに加えて、組織の Microsoft Windows 共有から結果が返されるように Google Cloud Search を設定できます。Google Cloud Search File Systems コネクタを使用して、指定した Windows 共有にアクセスするように構成します。1 つのコネクタ インスタンスで複数の Microsoft Windows 共有をサポートできます。

重要な考慮事項

継続的な自動更新

デフォルトでは、コネクタは起動時に開始パス（コネクタ構成ファイルの fs.src の値）を継続的にモニタリングします。ファイル システムがコンテンツまたはアクセス制御の変更を報告すると、コネクタがトリガーされ、ファイル システムが再クロールされます。この再クロールはリソースを大量に消費する可能性があります。ファイル システムのモニタリングを無効にするには、fs.monitorForUpdates を false に設定します。コネクタのリソース使用量は大幅に減少しますが、コネクタが変更を反映するタイミングが遅れます。詳細

DFS のアクセス制御

DFS システムでは、リンクにアクセス制御が適用され、通常は各 DFS リンクに独自の ACL があります。DFS で使用されるメカニズムの 1 つがアクセスベースの列挙（ABE）です。ABE を使用すると、ユーザーに返される DFS リンクを制限できます。ABE がホストされているホーム ディレクトリを分離すると、ユーザーには DFS リンクのサブセットのみが表示されることがあります。1 つのリンクしか表示されないこともあります。コネクタが DFS システムを走査するとき、コネクタは DFS リンクの ACL とターゲットの共有 ACL を尊重し、共有 ACL は DFS ACL から継承されます。

既知の制限事項

• ファイル システム: File Systems コネクタは、マッピングされたドライブとローカル ドライブをサポートしていません。
• 分散ファイル システム: UNC DFS にマッピングされたドライブは正しく機能しません。一部の ACL が正しく読み取られません。
• File Systems コネクタは、分散ファイル システム（DFS）の名前空間とリンクをサポートしています。ただし、コネクタでサポートされているのは DFS 名前空間内の DFS リンクのみで、DFS 名前空間内の通常のフォルダはサポートされていません。
• cloudsearch.google.com で返されたファイルリンクをクリックできません。Query API から返されるファイルリンクも、ほとんどのブラウザではクリックできません。

• Google Cloud Search とデータソースの関係を確立するために必要な Google Workspace 情報:

  • Google Workspace の秘密鍵（サービス アカウント ID を含む）。秘密鍵を取得する方法については、 Google Cloud Search REST API へのアクセスを構成するをご覧ください。
  • Google Workspace データソース ID。データソース ID を取得する方法については、検索対象のデータソースを追加するをご覧ください。
  • ID ソースの ID。ID ソースの ID を取得する方法については、ID ソースを作成するをご覧ください。Google Workspace ディレクトリを Active Directory と同期する場合は、GCDS を使用して ID ソースを設定します。

  通常、これらの認証情報は組織の Google Workspace 管理者から提供されます。

• 次のセクションで説明するように、Windows アカウントに十分な権限がある。

必要な Microsoft Windows アカウントの権限

コネクタを実行する Microsoft Windows アカウントには、次の操作を行うための十分な権限が必要です。

• フォルダの内容を一覧表示する
• ドキュメントの内容を読み取る
• ファイルやフォルダの属性を読み取る
• ファイルとフォルダ両方の権限（ACL）を読み取る
• 基本属性を書き込む

次のいずれかのグループのメンバーになると、コネクタで必要となる十分な権限が Windows アカウントに付与されます。

• 管理者
• Power Users
• Print Operators
• Server Operators

ステップ 1. Google Cloud Search File Systems コネクタをインストールする

1. GitHub からコネクタ リポジトリを取得してビルドします。

   Windows サーバーで git を使用するには:

   1. リポジトリのクローンを作成します。

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

   2. 希望するバージョンのコネクタをチェックアウトします。

      > git checkout tags/v1-0.0.3

   GitHub から直接ダウンロードするには:

   1. https://github.com/google-cloudsearch/windows-filesystems-connector にアクセスします。
   2. [Clone or download] chevron_right [Download zip] をクリックします。
   3. パッケージを解凍します。
   4. 新しいディレクトリに移動します。

      > cd windows-filesystems-connector

2. コネクタをビルドします。必要に応じて、Apache Maven をインストールします。

   > mvn package

   コネクタをビルドするときにテストをスキップするには、mvn package の代わりに mvn package -DskipTests を実行します。

3. コネクタ zip ファイルをローカルのインストール ディレクトリにコピーします。

   > 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

1. コネクタのインストールと同じディレクトリにファイルを作成し、connector-config.properties という名前を付けます。

2. 次の例のように、パラメータを Key-Value ペアとしてファイルの内容に追加します。

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

   各パラメータの詳細については、 構成パラメータのリファレンスをご覧ください。

3. （省略可）必要に応じて、他のコネクタ パラメータを構成します。詳細については、Google 提供のコネクタ パラメータをご覧ください。

ステップ 3. ロギングを有効にする

1. コネクタ バイナリを含むディレクトリに logs という名前のフォルダを作成します。

2. コネクタ バイナリを含むディレクトリに logging.properties という名前の ASCII または UTF-8 ファイルを作成し、次の内容を追加します。

   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
   

デフォルトでは、コネクタは JDK が提供するメディアタイプ検出機能を使用して、各ファイルのメディアタイプを検出しようとします。Microsoft Windows では、JDK は Windows レジストリに基づいてファイルのメディアタイプを特定します。レジストリ エントリがない場合、特定のファイルのメディアタイプが null になることがあります。

必要に応じて、既存のバインディングを上書きするか、null メディアタイプを防ぐメディアタイプを指定できます。

1. コネクタ ディレクトリに、mime-type.properties という名前の Latin-1 で暗号化されたファイルを作成します。

2. 次の例のように、ファイル拡張子と対応するメディアタイプを入力します。

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

ステップ 5: File Systems コネクタを実行する

File Systems コネクタをインストールして構成したら、ホストマシンで起動するために、次のようなコマンドを実行します。

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

構成ファイルのパスがデフォルト（バイナリと同じディレクトリに connector-config.properties という名前で保存されている）と異なる場合は、構成ファイルのパスを指定します。

構成パラメータのリファレンス

データソース アクセス

ファイル システムへのアクセス

パス区切り文字

コネクタの動作

タイムスタンプの保持とクロール制御

ファイル共有のアクセス制御をスキップする

デフォルトでは、コネクタは、ファイル共有の ACL を含むアクセス制御リスト（ACL）をインデックス API に送信するときに、アクセス制御の完全性を維持します。ただし、構成によっては、コネクタに共有 ACL を読み取るための十分な権限がない場合があります。このような場合、コネクタは、そのファイル共有で管理されているファイルを検索結果に返しません。

コネクタを共有 ACL を無視するように設定すると、コンテンツが常に検索結果に返されます。この場合、インデックス API には実際の共有 ACL ではなく、まったく制限のない共有 ACL が送信されます。