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

Możesz skonfigurować Google Cloud Search tak, aby zwracał wyniki z udziałów Microsoft Windows w organizacji oprócz treści Google Workspace. Używasz konektora Google Cloud Search File Systems i konfigurujesz go tak, aby miał dostęp do określonych udziałów systemu Windows. Jedna instancja łącznika może obsługiwać wiele udziałów Microsoft Windows.

Istotne kwestie

Ciągłe aktualizacje automatyczne

Domyślnie po uruchomieniu oprogramowanie sprzęgające stale monitoruje ścieżki początkowe (wartości z fs.src w pliku konfiguracyjnym oprogramowania sprzęgającego). Gdy system plików zgłosi zmiany w treści lub kontroli dostępu, łącznik zostanie uruchomiony, aby ponownie przeszukać system plików. Ponowne indeksowanie może być zasobochłonne. Aby wyłączyć monitorowanie systemu plików, ustaw fs.monitorForUpdates na false. Znacznie zmniejszasz wykorzystanie zasobów przez wtyczkę, ale opóźniasz moment, w którym odzwierciedla ona zmiany. Więcej informacji

Kontrola dostępu DFS

System DFS stosuje kontrolę dostępu do swoich linków i zwykle każdy link DFS ma własną listę ACL. Jednym z mechanizmów używanych przez DFS jest wyliczanie oparte na dostępie (ABE), które może ograniczać zwracane użytkownikowi linki DFS. Użytkownicy mogą otrzymywać tylko podzbiór linków DFS, a nawet tylko jeden link, gdy funkcja ABE izoluje hostowane katalogi domowe. Gdy oprogramowanie sprzęgające przechodzi przez system DFS, uwzględnia listę kontroli dostępu do linku DFS i listę kontroli dostępu do udziału miejsca docelowego, a lista kontroli dostępu do udziału dziedziczy listę kontroli dostępu DFS.

Znane ograniczenia

  • System plików: złącze System plików nie obsługuje zamapowanych dysków ani dysków lokalnych.
  • Rozproszony system plików: zamapowany dysk do UNC DFS nie działa prawidłowo. Niektóre listy ACL nie są odczytywane prawidłowo.
  • Oprogramowanie sprzęgające systemów plików obsługuje przestrzenie nazw i linki Distributed File System (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.
  • Linki do plików zwracane w cloudsearch.google.com nie są klikalne. Linków do plików zwracanych przez interfejs Query API nie można też kliknąć w większości przeglądarek.

Wymagania systemowe

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

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

Wdrażanie oprogramowania sprzęgającego

Wymagania wstępne

Zanim wdrożysz łącznik Cloud Search File Systems, upewnij się, że Twoje środowisko zawiera wszystkie te komponenty:

Wymagane uprawnienia konta Microsoft Windows

Konto Microsoft Windows, na którym działa oprogramowanie sprzęgające, musi mieć uprawnienia wystarczające do wykonania 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 ACL) zarówno plików, jak i folderów;
  • Uprawnienia do zapisu atrybutów podstawowych

Członkostwo w jednej z tych grup przyznaje kontu systemu Windows uprawnienia wystarczające dla oprogramowania sprzęgającego:

  • Administratorzy
  • Zaawansowani użytkownicy
  • Operatorzy druku
  • Operatorzy serwerów

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

  1. Pobierz repozytorium łącznika z GitHuba i skompiluj je.

    Aby używać Gita 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ź wybraną wersję oprogramowania sprzęgającego:

      > git checkout tags/v1-0.0.3

    Aby pobrać plik bezpośrednio z GitHuba:

    1. Wejdź na https://github.com/google-cloudsearch/windows-filesystems-connector.
    2. Kliknij Sklonuj lub pobierz Pobierz jako 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 instalacyjnego:

    > 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 zainstalowano łącznik, utwórz plik i nadaj mu nazwę 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 złącza. Więcej informacji znajdziesz w artykule Parametry złącza dostarczonego przez Google.

Krok 3. Włącz logowanie

  1. Utwórz folder o nazwie logs w katalogu zawierającym plik binarny łącznika.
  2. Utwórz plik ASCII lub UTF-8 o nazwie logging.properties w katalogu zawierającym plik binarny łącznika 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) Skonfiguruj typy mediów.

Domyślnie łącznik próbuje wykryć typ multimediów dla każdego pliku za pomocą funkcji wykrywania typu multimediów udostępnianej przez JDK. W systemie Microsoft Windows pakiet JDK korzysta z rejestru systemu Windows, aby określić typy multimediów dla plików. Brakujący wpis w rejestrze może spowodować, że w przypadku niektórych plików typ nośnika będzie miał wartość null.

W razie potrzeby możesz określić typ multimediów, który zastąpi istniejące powiązania lub zapobiegnie wystąpieniu typu multimediów o wartości null.

  1. W katalogu łącznika utwórz zaszyfrowany w formacie Latin-1 plik 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 Systemy plików

Po zainstalowaniu i skonfigurowaniu łącznika systemów plików uruchom go na komputerze hosta, wykonując polecenie podobne do tego w przykładzie:

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

Określ ścieżkę pliku konfiguracyjnego, jeśli różni się od domyślnej (w tym samym katalogu co plik binarny o nazwie connector-config.properties).

Informacje o parametrach konfiguracji

Dostęp do źródła danych

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

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

Wymagany. Plik klucza konta usługi Google Cloud Search, który umożliwia dostęp do łącznika systemów plików Google Cloud Search.

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

Wymagany. Identyfikator źródła tożsamości Cloud Search skonfigurowany przez administratora Google Workspace do 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, ...]

Wymagany. Określ źródłowe systemy plików jako co najmniej 1 źródło UNC rozdzielone separatorem skonfigurowanym przez fs.src.separator. Jeśli używasz znaków spoza zestawu Latin1, zakoduj je za pomocą znaków ucieczki 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 powodował konfliktu 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

Ustawienie Parametr
Domena Windows fs.supportedDomain=domain

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

Uwzględnianie kont na listach ACL fs.supportedAccounts=account-1[, account-2,...]

Lista kont rozdzielonych przecinkami, które mają być uwzględnione na listach kontroli dostępu, 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.

Wykluczanie wbudowanych kont z list kontroli dostępu fs.builtinGroupPrefix=prefix

Określ przedrostek wbudowanych kont. Konto, które zaczyna się od tego prefiksu, jest uważane 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 zezwolić łącznikowi na indeksowanie ukrytych plików i folderów (w systemach plików Windows plik lub folder jest uznawany za ukryty, jeśli ustawiony jest atrybut ukryty DOS). (wartością domyślną jest false);

Zezwalanie na indeksowanie list indeksowanych folderów i wyliczeń przestrzeni nazw DFS fs.indexFolders=boolean

Gdy ta opcja jest ustawiona na true (domyślnie), oprogramowanie sprzęgające podczas indeksowania folderu tworzy obiekt CONTAINER_ITEM. Jeśli ta wartość jest ustawiona na false, oprogramowanie sprzęgające tworzy obiekt VIRTUAL_CONTAINER_ITEM.

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

Gdy ta opcja jest ustawiona na true (domyślnie), zmiany w treści lub kontroli dostępu powodują ponowne indeksowanie przez łącznik. Gdy wyłączysz monitorowanie (ustawisz false), znacznie zmniejszysz zużycie zasobów przez łącznik, ale opóźnisz moment, w którym odzwierciedli on zmiany.

Ustawianie maksymalnego rozmiaru pamięci podręcznej katalogów fs.directoryCacheSize=number-of-entries

Maksymalny rozmiar pamięci podręcznej katalogu. Oprogramowanie sprzęgające używa pamięci podręcznej do identyfikowania ukrytych folderów, aby uniknąć indeksowania plików i folderów w ukrytych folderach.

Domyślna liczba wpisów to 50 000, co zwykle zużywa 10–15 MB pamięci RAM.

Zachowywanie sygnatur czasowych i kontrolowanie indeksowania

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

Gdy łącznik indeksuje pliki i foldery, może zmienić sygnaturę czasową ostatniego dostępu do plików i folderów na czas indeksowania. Jeśli czasy ostatniego dostępu nie są zachowywane, systemy tworzenia kopii zapasowych i archiwizacji mogą nie przenosić odpowiednich plików i folderów do pamięci dodatkowej z powodu wizyty łącznika.

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

Możliwe wartości:

  • ALWAYS: podczas indeksowania plików i folderów łącznik próbuje zachować czas ostatniego dostępu. Gdy oprogramowanie sprzęgające po raz pierwszy nie może zachować ostatniego czasu dostępu, odrzuca wszystkie kolejne żądania indeksowania systemu plików, aby zapobiec zmianie sygnatur czasowych ostatniego dostępu.
  • IF_ALLOWED: podczas indeksowania plików i folderów łącznik próbuje zachować czas ostatniego dostępu. Nadal indeksuje, nawet jeśli niektóre sygnatury czasowe nie zostaną zachowane.
  • NEVER: łącznik nie próbuje zachować czasu ostatniego dostępu podczas indeksowania plików i folderów.
Indeksowanie tylko plików, do których uzyskano dostęp po określonej dacie fs.lastAccessedDate=YYYY-MM-DD

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

Podaj datę w formacie ISO8601: RRRR-MM-DD. Jeśli np. wartość to 2010-01-01, oprogramowanie sprzęgające indeksuje tylko treści, do których uzyskano dostęp po początku 2010 roku.

Jeśli określisz wartość fs.lastAccessedDate, nie możesz też ustawić wartości fs.lastAccessedDays.

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

Indeksowanie treści tylko wtedy, gdy ostatni dostęp miał miejsce w ciągu określonej liczby dni przed dniem bieżącym. Wartością domyślną jest disabled.

Użyj tej właściwości, aby wygasić wcześniej zindeksowane treści, do których od jakiegoś czasu nie uzyskano dostępu. Na przykład ustaw wartość 365, aby indeksować treści tylko wtedy, gdy były one dostępne w ciągu ostatniego roku.

Jeśli określisz wartość fs.lastAccessedDays, nie możesz też ustawić wartości fs.lastAccessedDate.

Indeksowanie tylko plików zmodyfikowanych po określonej dacie fs.lastModifiedDate=YYYY-MM-DD

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

Podaj datę w formacie ISO8601: RRRR-MM-DD. Jeśli np. wartość to 2010-01-01, oprogramowanie sprzęgające indeksuje tylko treści, które zostały zmodyfikowane po początku 2010 roku.

Jeśli określisz wartość fs.lastModifiedDate, nie możesz też ustawić wartości fs.lastModifiedDays.

Indeksowanie tylko plików zmodyfikowanych w ciągu ostatnich kilku dni fs.lastModifiedDays=number-of-days

Indeksowanie treści tylko wtedy, gdy czas ostatniej modyfikacji mieści się w zakresie liczby dni przed dniem bieżącym. Wartością domyślną jest disabled.

Użyj tej właściwości, aby wygasić wcześniej zindeksowane treści, które od dłuższego czasu nie były 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 określisz wartość fs.lastModifiedDays, nie możesz też ustawić wartości fs.lastModifiedDate.

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

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

Możesz skonfigurować oprogramowanie sprzęgające tak, aby ignorowało listę kontroli dostępu do udostępniania, dzięki czemu zawartość będzie zawsze zwracana w wynikach wyszukiwania. W takim przypadku interfejs Indexing API otrzymuje listę kontroli dostępu z pełnymi uprawnieniami do udostępniania, a nie rzeczywistą listę kontroli dostępu.

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

Ustaw wartość false (domyślnie), aby wymuszać listy ACL udostępniania. Ustaw wartość true, aby zignorować listy kontroli dostępu do udostępniania.