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

Możesz skonfigurować usługę Google Cloud Search tak, aby oprócz treści z Google Workspace zwracała wyniki z udostępnionych plików Microsoft Windows organizacji. Musisz użyć oprogramowania sprzęgającego Google Cloud Search File Systems i skonfigurować je, aby miało dostęp do określonych udziałów systemu Windows. Pojedyncza instancja oprogramowania sprzęgającego może obsługiwać wiele udziałów 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 pliku fs.src w pliku konfiguracji oprogramowania sprzęgającego) podczas uruchamiania oprogramowania sprzęgającego. Gdy system plików zgłosi zmiany w treści lub kontroli dostępu, oprogramowanie sprzęgające uruchamia się, aby ponownie zindeksować system plików. To ponowne indeksowanie może pochłaniać dużo zasobów. Aby wyłączyć monitorowanie systemu plików, ustaw fs.monitorForUpdates na false. Znacznie zmniejszasz wykorzystanie zasobów oprogramowania sprzęgającego, ale opóźniasz wprowadzenie tych zmian w oprogramowaniu sprzęgającym. Więcej informacji

Kontrola dostępu do DFS

System DFS stosuje kontrolę dostępu do swoich połączeń, a zwykle każde z nich ma własną listę kontroli dostępu. Jednym z mechanizmów używanych w DFS jest wyliczenie oparte na dostępie (ABE), które może ograniczyć linki do DFS zwracane użytkownikowi. Jeśli ABE wyodrębnia hostowane katalogi główne, użytkownicy mogą otrzymywać tylko podzbiór linków DFS, a nawet 1 link. Gdy oprogramowanie sprzęgające przemierza system DFS, oprogramowanie sprzęgające respektuje listę kontroli dostępu DFS i docelowej listy kontroli dostępu (ACL), a lista ACL udziału dziedziczy z listy kontroli dostępu DFS.

Znane ograniczenia

  • System plików: oprogramowanie sprzęgające systemu plików nie obsługuje dysków zmapowanych ani dysków lokalnych.
  • Rozproszony system plików: zmapowany dysk na DFS w UNC nie działa prawidłowo. Niektóre listy ACL 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 linki DFS tylko w przestrzeni nazw DFS, a nie w zwykłych folderach w przestrzeni nazw DFS.
  • Linków do plików zwróconych na cloudsearch.google.com nie można kliknąć. W większości przeglądarek nie można też kliknąć linków do plików zwracanych przez interfejs Query API.

Wymagania systemowe

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

Nieobsługiwane: lokalne systemy plików Windows, 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 systemu plików Cloud Search, sprawdź, czy środowisko ma wszystkie te składniki wstępne:

Wymagane uprawnienia konta Microsoft Windows

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

  • 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) zarówno do plików, jak i folderów
  • Uprawnienia do zapisu podstawowych atrybutów

Przynależność do jednej z tych grup zapewnia kontu Windows wystarczające uprawnienia wymagane przez oprogramowanie sprzęgające:

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

Krok 1. Zainstaluj oprogramowanie sprzęgające systemów plików Google Cloud Search

  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ć bezpośrednio z GitHuba:

    1. Wejdź na https://github.com/google-cloudsearch/windows-filesystems-connector.
    2. Kliknij Sklonuj 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 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, w którym znajduje się 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) Skonfiguruj inne parametry oprogramowania sprzęgającego zgodnie z potrzebami. Szczegółowe informacje znajdziesz w artykule Parametry oprogramowania sprzęgającego dostarczone przez Google.

Krok 3. Włącz logowanie

  1. Utwórz w katalogu o nazwie logs folder zawierający 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 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ą funkcji udostępniania przez JDKfunkcji wykrywania typu multimediów. W systemie Microsoft Windows JDK wykorzystuje rejestr systemu Windows do określania typów multimediów dla plików. Brak wpisu w rejestrze może w przypadku niektórych plików powodować ustawienie typu multimediów o wartości null.

W razie potrzeby możesz określić typ mediów, który zastąpi istniejące powiązania lub uniemożliwia użycie typu mediów o wartości null.

  1. W katalogu oprogramowania sprzęgającego utwórz plik o nazwie mime-type.properties zaszyfrowany za pomocą algorytmu Latin-1.
  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 systemu plików, aby uruchomić je na hoście, uruchom polecenie podobne do tego przykładu:

> 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).

Dokumentacja parametrów konfiguracji

Dostęp do źródła danych

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

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

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

Wymagane. Identyfikator źródła tożsamości Cloud Search skonfigurowany przez administratora Google Workspace na potrzeby synchronizowania tożsamości Active Directory za pomocą GCDS.

Dostęp do systemu plików

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

Wymagane. Określ źródłowe systemy plików jako co najmniej 1 źródło UNC rozdzielone separatorem skonfigurowanym przez funkcję fs.src.separator. Jeśli używasz znaków spoza Latin1, zakoduj je, używając znaków zmiany znaczenia Unicode w języku Java.

Znak separatora ścieżki

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

Domyślny separator to „;”. Jeśli ścieżki źródłowe zawierają średniki, możesz ustawić inny separator, np. przecinek („,”), który nie będzie kolidował ze znakami w ścieżkach i nie będzie zarezerwowany przez 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

Ustawienie Parametr
Domena Windows fs.supportedDomain=domain

Wymagane, aby umożliwić użytkownikom ze skonfigurowanym GCDS dostęp do dokumentów za pomocą 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ść domyślna to 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 rozpoczynające się od tego prefiksu jest uznawane za konto wbudowane i zostanie wykluczone z list kontroli dostępu.

Wartość domyślna to BUILTIN\\.

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

Ustaw na true, aby umożliwić oprogramowaniu sprzęgającemu indeksowanie ukryte pliki i foldery (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 zindeksowanych list folderów i wyliczeń przestrzeni nazw DFS fs.indexFolders=boolean

Jeśli ustawisz wartość true (domyślnie), gdy oprogramowanie sprzęgające indeksuje 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 w systemie plików fs.monitorForUpdates=boolean

Jeśli zasada ma wartość true (domyślnie), zmiany treści lub kontroli dostępu powodują ponowne zindeksowanie oprogramowania sprzęgającego. Gdy wyłączysz monitorowanie (ustawienie na false), znacznie ograniczysz wykorzystanie zasobów oprogramowania sprzęgającego, ale opóźnisz tę zmianę, gdy oprogramowanie sprzęgające będzie odzwierciedlić zmiany.

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 do identyfikowania ukrytych folderów w celu uniknięcia indeksowania plików i folderów w ukrytych folderach.

Wartość domyślna to 50 tys. wpisów, co zwykle zużywa 10–15 MB pamięci RAM.

Zachowanie sygnatury czasowej i kontrola indeksowania

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

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

Domyślnie oprogramowanie sprzęgające próbuje zachować czas ostatniego dostępu (wartość fs.preserveLastAccessTime jest ustawiona na ALWAYS). Oprogramowanie sprzęgające może nie być w stanie przywrócić ostatniego czasu dostępu do pliku, jeśli użytkownik przemierzający nie ma wystarczających uprawnień do zapisywania atrybutów pliku. Gdy ustawiona jest wartość ALWAYS, oprogramowanie sprzęgające odrzuca żądania indeksowania systemu plików, dzięki czemu nie zmienia 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 po raz pierwszy oprogramowanie sprzęgające nie może zachować czasu ostatniego dostępu, odrzuca wszystkie kolejne żądania indeksowania 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. Indeksowanie będzie kontynuowane nawet wtedy, gdy niektóre sygnatury czasowe mogą nie zostać zachowane.
  • NEVER: oprogramowanie sprzęgające nie próbuje zachować 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 jest późniejszy niż określona data. Wartością domyślną jest disabled.

Podaj datę w formacie ISO8601: RRRR-MM-DD. Jeśli na przykład wartością jest 2010-01-01, oprogramowanie sprzęgające będzie indeksować tylko treści, do których uzyskano dostęp później niż na początku 2010 roku.

Jeśli podasz wartość fs.lastAccessedDate, nie będzie można 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 przypada w ciągu ostatnich dni. Wartością domyślną jest disabled.

Używaj tej usługi, aby wygasać wcześniej zindeksowane treści, z których od jakiegoś czasu nie było korzystać. Na przykład ustaw wartość 365, aby indeksować tylko te treści, które były otwierane w ciągu ostatniego roku.

Jeśli podasz wartość fs.lastAccessedDays, nie będzie można 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 jest późniejszy niż określona data. Wartością domyślną jest disabled.

Podaj datę w formacie ISO8601: RRRR-MM-DD. Jeśli na przykład wartością jest 2010-01-01, oprogramowanie sprzęgające będzie indeksować tylko treści zmodyfikowane później.

Jeśli podasz wartość fs.lastModifiedDate, nie będzie można ustawić wartości dla parametru fs.lastModifiedDays.

Indeksuj tylko pliki zmodyfikowane w ciągu ostatniej liczby 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.

Używaj tej właściwości, aby wygasać wcześniej zindeksowane treści, które nie były od jakiegoś czasu modyfikowane. Na przykład ustaw wartość 365, aby indeksować tylko te treści, które zostały zmodyfikowane w ciągu ostatniego roku.

Jeśli podasz wartość fs.lastModifiedDays, nie będzie można ustawić wartości dla parametru fs.lastModifiedDate.

Pomiń kontrolę dostępu do udziału plików

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

Możesz skonfigurować oprogramowanie sprzęgające tak, aby ignorowało współdzieloną listę kontroli dostępu (ACL), dzięki czemu treści będą zawsze zwracane w wynikach wyszukiwania. W takim przypadku interfejs API indeksowania otrzymuje całkowicie mniej rygorystyczną listę kontroli dostępu (ACL), a nie faktyczną listę kontroli dostępu (ACL).

Ustawienie Parametr
Pomiń kontrolę dostępu do udziału plików fs.skipShareAccessControl=boolean

Ustaw wartość false (domyślnie), aby wymuszać udostępniane listy kontroli dostępu (ACL). Ustaw jako true, aby ignorować udostępniane listy kontroli dostępu.