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

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

重要な考慮事項

ファイル システム コネクタをデプロイする前に、次の注意事項を確認してください。

継続的な自動更新

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

DFS のアクセス制御

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

既知の制限事項

このセクションでは、ファイル システム コネクタの既知の制限事項について説明します。

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

システム要件

File Systems コネクタをデプロイする前に、ホストマシンが次の要件を満たしていることを確認してください。

コネクタをデプロイする

File Systems コネクタをデプロイする手順は次のとおりです。

前提条件

コネクタをデプロイする前に、環境に次のコンポーネントがあることを確認してください。

• 接続を確立するための Google Workspace 情報:

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

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

• Windows アカウントに十分な権限があることを確認します。

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

コネクタを実行する Windows アカウントには、次の権限が必要です。

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

通常、これらのグループ（管理者、パワーユーザー、印刷オペレーター、サーバー オペレーター）のいずれかのメンバーになると、十分な権限が付与されます。

ステップ 1. コネクタをインストールする

GitHub からコネクタ リポジトリをダウンロードするかクローンを作成して、コネクタ パッケージをビルドします。

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

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

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

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

   1. windows-filesystems-connector に移動します。
   2. [Clone or download] > [Download zip] をクリックします。
   3. パッケージを解凍して、ディレクトリに移動します。

2. Apache Maven を使用してコネクタをビルドします。

   > 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

ステップ 2. 構成ファイルを作成する

コネクタをインストールしたら、コネクタの設定を含む構成ファイルを作成します。

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

2. パラメータを Key-Value ペアとして追加します。次に例を示します。

   # Required parameters
   api.serviceAccountPrivateKeyFile=/path/to/file.json
   api.sourceId=0123456789abcde
   api.identitySourceId=a1b1c1234567
   
   # File system access
   fs.src=\\\\host\\share;\\\\dfshost\\dfsnamespace
   
   # Optional parameters
   traverse.abortAfterExceptions=500
   fs.monitorForUpdates = true
   fs.preserveLastAccessTime = IF_ALLOWED
   

   ファイル システム固有のパラメータについては、構成パラメータのリファレンスをご覧ください。すべての Cloud Search コネクタで使用される共通パラメータの一覧については、Google 提供のコネクタ パラメータをご覧ください。

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

ログ用のディレクトリを作成し、ロギング構成ファイルを作成します。

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

2. 次の内容で logging.properties という名前のファイルを作成します。

   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
   

ステップ 4. （省略可）メディアタイプを構成する

コネクタは、デフォルトのメカニズムを使用してファイル メディア タイプの検出を試みます。Windows では、レジストリ エントリに依存します。ファイル拡張子のレジストリ エントリがない場合、コネクタがメディアタイプを正しく検出できないことがあります。メディアタイプが正しく検出されない場合や、拡張機能のデフォルトのタイプをオーバーライドする場合は、次の手順を行います。

1. コネクタ ディレクトリに mime-type.properties という名前のファイルを作成します。
2. 拡張機能とタイプを extension=media/type:properties xlsx=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet one=application/msonenote txt=text/plain pdf=application/pdf の形式で入力します。

ステップ 5. 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 という名前の構成ファイルを探します。構成ファイルの名前が異なる場合や、別のディレクトリにある場合は、-Dconfig パラメータを使用してパスを指定します。

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

次の表に、ファイル システム コネクタの構成に使用されるパラメータを示します。

データソース アクセス

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

これらのパラメータを使用して、クロールするファイル システム ソースを指定します。

パス区切り文字

コネクタの動作

これらのパラメータを使用して、コネクタがファイル システムをクロールする方法を調整します。

タイムスタンプの保持

これらのパラメータを使用して、コネクタがタイムスタンプの保持を処理する方法を指定します。

ファイル共有の ACL をスキップする

共有 ACL を読み取る権限がない場合は、共有 ACL を無視するようにコネクタを設定できます。コンテンツは、許可型の共有 ACL とともに返されます。