Wdrażanie oprogramowania sprzęgającego systemu plików Microsoft Windows

Możesz skonfigurować Google Cloud Search tak, aby oprócz treści Google Workspace zwracało wyniki z udostępnionych przez Microsoft Windows plików udostępnionych w systemie Microsoft Windows. Użyj oprogramowania sprzęgającego systemu plików Google Cloud Search i skonfiguruj je, aby uzyskać dostęp do określonych udziałów w systemie Windows. Pojedyncza instancja oprogramowania sprzęgającego może obsługiwać wiele udziałów systemu Microsoft Windows.

Ważne informacje

Ciągłe automatyczne aktualizacje

Domyślnie oprogramowanie sprzęgające stale monitoruje ścieżki początkowe (wartości z fs.src w pliku konfiguracji oprogramowania sprzęgającego) podczas uruchamiania oprogramowania sprzęgającego. Gdy system plików zgłosi zmianę treści lub kontroli dostępu, uruchomi się oprogramowanie sprzęgające w celu ponownego zindeksowania systemu plików. Ponowne indeksowanie może wymagać znacznych zasobów. Aby wyłączyć monitorowanie systemu plików, ustaw fs.monitorForUpdates na false. Ogranicza to wykorzystanie zasobów oprogramowania sprzęgającego, ale opóźnia odzwierciedlenie zmian przez oprogramowanie sprzęgające. Więcej informacji

Kontrola dostępu do DFS

System DFS stosuje kontrolę dostępu do swoich połączeń i zwykle każde połączenie ma własną listę kontroli dostępu. Jednym z mechanizmów stosowanych w DFS jest Enumeracja oparta na dostępie (ABE), która może ograniczać linki DFS zwracane użytkownikowi. Gdy ABE izoluje hostowane katalogi główne, użytkownicy mogą zobaczyć tylko podzbiór linków DFS, a nawet 1 link. Gdy oprogramowanie sprzęgające przemierza system DFS, oprogramowanie sprzęgające przestrzega listy kontroli dostępu (ACL) linku DFS i listy kontroli dostępu do udostępniania – natomiast lista ACL udostępniania dziedziczy listę kontroli dostępu (DFS ACL).

Znane ograniczenia

  • System plików: oprogramowanie sprzęgające systemów plików nie obsługuje dysków mapowanych ani dysków lokalnych.
  • Rozproszony system plików: dysk zmapowany na system plików DFS UNC nie działa prawidłowo. Niektóre listy kontroli dostępu nie są poprawnie odczytywane.
  • Oprogramowanie sprzęgające systemów plików obsługuje przestrzenie nazw i linki rozproszonego systemu plików (DFS). Oprogramowanie sprzęgające obsługuje jednak połączenia DFS tylko w przestrzeni nazw DFS, a nie w zwykłych folderach w tej przestrzeni.
  • Linków do plików zwróconych na stronie cloudsearch.google.com nie można kliknąć. W większości przeglądarek nie da się też kliknąć linków do plików zwróconych przez interfejs Query API.

Wymagania systemowe

Wymagania systemowe
System operacyjny
  • Windows Server 2016.
  • Windows Server 2012
  • Windows Server 2008 R2
Oprogramowanie
  • Na komputerze, na którym będzie działać oprogramowanie sprzęgające systemów plików Google Cloud Search, zainstalowana jest Java JRE 1.8
Protokoły systemu plików
  • Blokada wiadomości serwera (SMB) – SMB1
  • Blokada wiadomości serwera (SMB) – SMB2
  • Rozproszony system plików (DFS)

Nieobsługiwane: lokalne systemy plików Windows, system plików Sun Network File System (NFS) 2.0, Sun Network File System (NFS) 3.0 lub lokalny system plików Linux.

Wdrażanie oprogramowania sprzęgającego

Wymagania wstępne

Zanim wdrożysz oprogramowanie sprzęgające systemów plików Cloud Search, sprawdź, czy Twoje środowisko zawiera wszystkie te komponenty wstępne:

Wymagane uprawnienia do konta Microsoft Windows

Konto Microsoft Windows, na którym działa oprogramowanie sprzęgające, musi mieć odpowiednie uprawnienia do wykonywania tych czynności:

  • Wyświetlanie zawartości folderów
  • Odczytywanie treści dokumentów
  • Odczytywanie atrybutów plików i folderów
  • Uprawnienia do odczytu (listy kontroli dostępu) dotyczące plików i folderów
  • Uprawnienia do zapisywania podstawowych atrybutów

Członkostwo w jednej z poniższych grup powoduje przyznanie kontu Windows wystarczających uprawnień wymaganych przez oprogramowanie sprzęgające:

  • Administratorzy
  • Doświadczeni użytkownicy
  • Operatory drukowania
  • Operatory serwera

Krok 1. Instalowanie oprogramowania sprzęgającego Google Cloud Search File Systems

  1. Pobierz repozytorium oprogramowania sprzęgającego z GitHuba i skompiluj je.

    Aby użyć git na serwerze z systemem Windows:

    1. Sklonuj repozytorium:

      > git clone https://github.com/google-cloudsearch/windows-filesystems-connector.git
      > cd windows-filesystems-connector
    2. Sprawdź odpowiednią wersję oprogramowania sprzęgającego:

      > git checkout tags/v1-0.0.3

    Aby pobrać treści bezpośrednio z GitHuba:

    1. Otwórz stronę https://github.com/google-cloudsearch/windows-filesystems-connector.
    2. Kliknij Skopiuj lub pobierz Pobierz plik ZIP.
    3. Rozpakuj pakiet.
    4. Przejdź do nowego katalogu:
      > cd windows-filesystems-connector
  2. Utwórz oprogramowanie sprzęgające. W razie potrzeby zainstaluj Apache Maven.

    > mvn package

    Aby pominąć testy podczas tworzenia oprogramowania sprzęgającego, uruchom polecenie mvn package -DskipTests zamiast mvn package.

  3. Skopiuj plik ZIP oprogramowania sprzęgającego do lokalnego katalogu instalacji:

    > 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

Krok 2. Tworzenie pliku konfiguracji oprogramowania sprzęgającego

  1. W tym samym katalogu co instalacja oprogramowania sprzęgającego utwórz plik i nazwij go connector-config.properties.

  2. Dodaj parametry jako pary klucz/wartość do zawartości pliku, jak w tym przykładzie:

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

    Szczegółowe opisy poszczególnych parametrów znajdziesz w dokumentacji parametrów konfiguracji.

  3. (Opcjonalnie) W razie potrzeby skonfiguruj inne parametry oprogramowania sprzęgającego. Szczegółowe informacje znajdziesz w artykule Parametry oprogramowania sprzęgającego dostarczone przez Google.

Krok 3. Włącz logowanie

  1. Utwórz folder o nazwie logs w katalogu zawierającym plik binarny oprogramowania sprzęgającego.
  2. Utwórz w katalogu zawierającym plik binarny oprogramowania sprzęgającego plik ASCII lub UTF-8 o nazwie logging.properties i dodaj do niego tę treść:

    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
    

Krok 4. (Opcjonalnie) Konfigurowanie typów multimediów

Domyślnie oprogramowanie sprzęgające próbuje wykryć typ multimediów dla każdego pliku za pomocą wykrywania typu multimediów dostarczonego przez JDK. W systemie Microsoft Windows JDK określa typy nośników dla plików, korzystając z rejestru systemu Windows. Brak wpisu w rejestrze może spowodować, że w przypadku niektórych plików typ multimediów będzie pusty.

W razie potrzeby możesz określić typ nośnika, który zastąpi istniejące powiązania lub zapobiega typowi mediów o wartości null.

  1. W katalogu oprogramowania sprzęgającego utwórz plik zaszyfrowany Latin-1 o nazwie mime-type.properties.
  2. Wpisz rozszerzenia plików i odpowiadające im typy multimediów, jak w tych przykładach:

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

Krok 5. Uruchom oprogramowanie sprzęgające systemów plików

Po zainstalowaniu i skonfigurowaniu oprogramowania sprzęgającego systemów plików uruchom je na hoście, wykonując polecenie podobne do tego:

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

Podaj ścieżkę pliku konfiguracji, jeśli jest inna niż domyślna (znajduje się w tym samym katalogu co plik binarny o nazwie connector-config.properties).

Odniesienie do parametrów konfiguracji

Dostęp do źródła danych

lokalizacji, Parametr
Identyfikator źródła danych api.sourceId=1234567890abcdef

To pole jest wymagane. Identyfikator źródła Google Cloud Search skonfigurowany przez administratora Google Workspace.

Ścieżka do pliku klucza prywatnego konta usługi api.serviceAccountPrivateKeyFile=./PrivateKey.json

To pole jest wymagane. Plik klucza konta usługi Google Cloud Search na potrzeby ułatwień dostępu w oprogramowaniu sprzęgającym Google Cloud Search File Systems.

Identyfikator źródła tożsamości api.identitySourceId=x0987654321

To pole jest wymagane. Identyfikator źródła tożsamości Cloud Search skonfigurowany przez administratora Google Workspace na potrzeby synchronizowania tożsamości Active Directory przy użyciu GCDS.

Dostęp do systemu plików

lokalizacji, Parametr
Źródłowe systemy plików fs.src=path1[,path2, ...]

To pole jest wymagane. Określ źródłowe systemy plików jako co najmniej jedno źródło UNC rozdzielone separatorem skonfigurowanym przez funkcję fs.src.separator. Jeśli używasz znaków spoza Latin1, zakoduj je za pomocą znaków zmiany znaczenia w Java Unicode.

Znak separatora ścieżki

lokalizacji, Parametr
Znak separatora ścieżki fs.src.separator=separator-character

Domyślnym separatorem jest „;”. Jeśli ścieżki źródłowe zawierają średniki, możesz ustawić inny separator, np. przecinek („,”), który nie koliduje ze znakami w ścieżkach i nie jest zarezerwowany przez samą składnię pliku właściwości.

Jeśli wartość fs.src.separator jest pustym ciągiem znaków, wartość fs.src jest traktowana jako pojedyncza ścieżka.

Działanie oprogramowania sprzęgającego

lokalizacji, Parametr
Domena Windows fs.supportedDomain=domain

Wymagane, aby umożliwić użytkownikom skonfigurowanym za pomocą GCDS dostęp do dokumentów przez Cloud Search. Określ jako pojedynczą nazwę domeny NetBIOS Active Directory.

Uwzględnij konta w ACLS fs.supportedAccounts=account-1[, account-2,...]

Rozdzielona przecinkami lista kont, które mają zostać uwzględnione na listach kontroli dostępu (ACL) niezależnie od tego, czy są to konta wbudowane.

Wartością domyślną jest BUILTIN\\Administrators,Everyone,BUILTIN\\Users, BUILTIN\\Guest,NT AUTHORITY\\INTERACTIVE, NT AUTHORITY\\Authenticated Users.

Wyklucz wbudowane konta z list kontroli dostępu fs.builtinGroupPrefix=prefix

Określ prefiks kont wbudowanych. Konto, którego nazwa zaczyna się od tego prefiksu, jest uznawane za konto wbudowane i zostanie wykluczone z list kontroli dostępu.

Wartością domyślną jest BUILTIN\\.

Zezwalaj na indeksowanie ukrytych plików i folderów fs.crawlHiddenFiles=boolean

Ustaw wartość true, aby umożliwić oprogramowaniu sprzęgającemu indeksowanie ukrytych plików i folderów (w systemach plików Windows plik lub folder jest uważany za ukryty, jeśli ustawiony jest ukryty atrybut DOS). Wartością domyślną jest false.

Zezwalaj na indeksowanie listy zindeksowanych folderów i wyliczeń przestrzeni nazw DFS fs.indexFolders=boolean

Gdy ma wartość true (domyślnie), gdy oprogramowanie sprzęgające przeszukuje folder, oprogramowanie sprzęgające tworzy obiekt CONTAINER_ITEM. Jeśli zasada ma wartość Fałsz, oprogramowanie sprzęgające tworzy obiekt VIRTUAL_CONTAINER_ITEM.

Włącz monitorowanie zmian systemu plików fs.monitorForUpdates=boolean

Gdy zasada ma wartość true (domyślnie), zmiany treści lub kontroli dostępu spowodują ponowne indeksowanie oprogramowania sprzęgającego. Wyłączenie monitorowania (ustawienie false) znacznie zmniejsza wykorzystanie zasobów oprogramowania sprzęgającego, ale opóźnia odzwierciedlenie zmian przez oprogramowanie sprzęgające.

Ustaw maksymalny rozmiar pamięci podręcznej katalogów fs.directoryCacheSize=number-of-entries

Maksymalny rozmiar pamięci podręcznej katalogu. Oprogramowanie sprzęgające korzysta z pamięci podręcznej, aby identyfikować ukryte foldery, co pozwala uniknąć indeksowania plików i folderów w ukrytych folderach.

Wartość domyślna to 50 tys. wpisów, które zwykle zużywają 10–15 megabajtów pamięci RAM.

Kontrola sygnatury czasowej i kontrola indeksowania

lokalizacji, Parametr
Zachowaj sygnaturę czasową ostatniego dostępu fs.preserveLastAccessTime=value

Gdy oprogramowanie sprzęgające przeszukuje pliki i foldery, może zmienić sygnaturę czasową ostatniego dostępu do plików i folderów na czas indeksowania. Gdy czas ostatniego dostępu nie jest zachowywany, systemy kopii zapasowych i archiwizowania mogą nie przenieść odpowiednich plików i folderów do pamięci dodatkowej z powodu odwiedzin oprogramowania sprzęgającego.

Domyślnie oprogramowanie sprzęgające próbuje zachować czas ostatniego dostępu (ustawienie fs.preserveLastAccessTime ma wartość ALWAYS). Oprogramowanie sprzęgające może nie być w stanie przywrócić czasu ostatniego dostępu do pliku, jeśli użytkownik przemierzający nie ma wystarczających uprawnień do zapisywania atrybutów pliku. Gdy ma wartość ALWAYS, oprogramowanie sprzęgające odrzuca żądania indeksowania dotyczące systemu plików, aby nie zmieniały sygnatur czasowych ostatniego dostępu do plików.

Możliwe wartości:

  • ALWAYS: oprogramowanie sprzęgające próbuje zachować czas ostatniego dostępu podczas indeksowania plików i folderów. Gdy oprogramowanie sprzęgające po raz pierwszy nie może zachować czasu ostatniego dostępu, odrzuca wszystkie kolejne żądania indeksowania wysyłane do systemu plików, aby zapobiec zmianie sygnatur czasowych ostatniego dostępu.
  • IF_ALLOWED: oprogramowanie sprzęgające próbuje zachować czas ostatniego dostępu podczas indeksowania plików i folderów. Indeksuje dalej nawet wtedy, gdy niektóre sygnatury czasowe mogą nie zostać zachowane.
  • NEVER: oprogramowanie sprzęgające nie próbuje zachowywać czasu ostatniego dostępu podczas indeksowania plików i folderów.
Indeksuj tylko te pliki, do których uzyskano dostęp po określonej dacie fs.lastAccessedDate=YYYY-MM-DD

Indeksuj treść tylko wtedy, gdy czas ostatniego dostępu przypada po określonej dacie. Wartością domyślną jest disabled.

Datę należy podać w formacie ISO8601: RRRR-MM-DD. Jeśli na przykład wartość to 2010-01-01, oprogramowanie sprzęgające zindeksuje tylko te treści, które były otwierane w okresie od początku 2010 roku.

Jeśli podasz fs.lastAccessedDate, nie możesz też ustawić wartości dla parametru fs.lastAccessedDays.

Indeksuj tylko te pliki, do których uzyskano dostęp w ciągu ostatnich dni fs.lastAccessedDays=number-of-days

Indeksuj treść tylko wtedy, gdy czas ostatniego dostępu do niej przypada w ciągu ostatnich dni. Wartością domyślną jest disabled.

Użyj tej właściwości, aby wygasnąć wcześniej zindeksowane treści, z których od jakiegoś czasu nie korzystano. Na przykład ustaw wartość 365, aby indeksować tylko treści, które zostały otwierane w ciągu ostatniego roku.

Jeśli podasz fs.lastAccessedDays, nie możesz też ustawić wartości dla parametru fs.lastAccessedDate.

Indeksuj tylko pliki zmodyfikowane po określonej dacie fs.lastModifiedDate=YYYY-MM-DD

Indeksuj treść tylko wtedy, gdy czas ostatniej modyfikacji przypada po określonej dacie. Wartością domyślną jest disabled.

Datę należy podać w formacie ISO8601: RRRR-MM-DD. Jeśli na przykład wartość to 2010-01-01, oprogramowanie sprzęgające przeszukuje tylko treść zmodyfikowaną w okresie po rozpoczęciu 2010 roku.

Jeśli podasz fs.lastModifiedDate, nie możesz też ustawić wartości dla parametru fs.lastModifiedDays.

Indeksuj tylko te pliki, które zostały zmodyfikowane w ciągu ostatnich dni fs.lastModifiedDays=number-of-days

Indeksuj treść tylko wtedy, gdy czas ostatniej modyfikacji przypada w ciągu ostatnich dni. Wartością domyślną jest disabled.

Ta właściwość służy do usuwania wcześniej zindeksowanych treści, które od jakiegoś czasu nie były modyfikowane. Na przykład ustaw wartość 365, aby indeksować tylko treści, które zostały zmodyfikowane w ciągu ostatniego roku.

Jeśli podasz fs.lastModifiedDays, nie możesz też ustawić wartości dla parametru fs.lastModifiedDate.

Pomiń kontrolę dostępu do udostępniania plików

Domyślnie oprogramowanie sprzęgające zachowuje integralność kontroli dostępu, gdy wysyła do interfejsu API indeksowania listy kontroli dostępu (ACL), w tym listy kontroli dostępu do udziału plików. Jednak w niektórych konfiguracjach oprogramowanie sprzęgające może nie mieć wystarczających uprawnień do odczytu udostępnionej listy kontroli dostępu. W takich przypadkach oprogramowanie sprzęgające nie zwraca w wynikach wyszukiwania żadnych plików przechowywanych w tym udziale plików.

Oprogramowanie sprzęgające można skonfigurować tak, aby ignorowało listę kontroli dostępu (ACL), tak aby treść zawsze była zwracana w wynikach wyszukiwania. W takim przypadku interfejs API indeksowania otrzymuje listę kontroli dostępu (ACL) w sposób całkowicie mało rygorystyczny, a nie otrzymaną przez samą współdzieloną listę kontroli dostępu.

lokalizacji, Parametr
Pomiń kontrolę dostępu do udostępniania plików fs.skipShareAccessControl=boolean

Ustaw na false (domyślnie), aby wymuszać udostępnianie list kontroli dostępu. Ustaw na true, aby ignorować listy kontroli dostępu (ACL).