CLEAR Engine 和 Web UI 管理者指南

2024/1/20 |

一個 Lucent Sky AVM 伺服器分為兩個主要元件：CLEAR Engine 和 Web UI。它們被預設安裝在同一台伺服器上，但也可以被分開安裝在不同的伺服器。這份指南將說明如何安裝、設定、管理、移除 CLEAR Engine 和 Web UI。

在這個文章中，你將會學習如何：

  • 安裝 CLEAR Engine 和 Web UI 為一個獨立的實體
  • 安裝 CLEAR Engine 和 Web UI 為新叢集中的第一個節點
  • 安裝 CLEAR Engine 和 Web UI 為現有叢集中的一個節點
  • 為 Web UI 設定 Internet Information Services（IIS）
  • 安裝和移除授權
  • 設置 CLEAR Engine 和 Web UI
  • 移除 CLEAR Engine 和 Web UI

本文結束時，你將能夠安裝、設定、管理、移除 CLEAR Engine 和 Web UI。

必要條件

  • Windows Communication Foundation (WCF) - CLEAR Engine 透過 WCF 和其介面通訊，包括具名管道（named pipes）、TCP 及其他 WCF 通道。
  • Windows Server - CLEAR Engine 以 Windows Service 方式運行，而 Web UI 則是在 Internet Information Services（IIS）上運作。你可能需要變更 Windows 防火牆的設定以允許 CLEAR Engine 及其介面間的通訊。

系統需求

處理器、記憶體和硬碟空間的需求：

  • 處理器: 2 個 1.6 GHz x64 處理器
  • 記憶體: 4 GB
  • 硬碟空間: 40 GB

CLEAR Engine 可被安裝在以下的作業系統中：

  • Windows Server 2022
  • Windows Server 2019
  • Windows Server 2016
  • Windows Server 2012 R2 (Standard, Datacenter)[^](## "Windows Server 2012 R2 已於 2023 年 10 月 10 日支援中止。")

以下的元件是必要的：

  • .NET Framework：.NET Framework 3.5 SP1 和 .NET Framework 4.8。
  • 桌面體驗：CLEAR Engine 和 Web UI 可能可在未安裝桌面體驗的 Windows Server 執行，但是這樣的使用情境是不被支援的。
  • 網路軟體：CLEAR Engine 所支援的作業系統都有內建的網路軟體。CLEAR Engine 支援下列網路協議（network protocols）：命名管道（named pipe）及 TCP/IP。
  • 虛擬化：CLEAR Engine 支援使用 Hyper-V 虛擬機器的環境。在其他基於 hypervisor 的虛擬機器環境中僅提供「根據現狀」的支援。
  • 資料庫：SQL Server 2014 或更新的版本。Lucent Sky AVM 安裝程式包含了 SQL Server 2019 Express，可和 CLEAR Engine 一併安裝。

其他建議：

  • CLEAR Engine 有內建 JDK。因此建議將 CLEAR Engine 安裝在沒有安裝任何 JDK 或 JRE 的伺服器上。

安裝 CLEAR Engine 和 Web UI 為一個獨立的實體

  1. 使用一個本機或網域管理者帳戶登入。建議使用內建的本機管理者帳戶來進行安裝。
  2. 解壓縮並執行 CLEAR Engine 安裝套件中的自我解壓縮檔（CLEAR_x64.exe）。它會建立一個 CLEAR_x64 目錄。

  3. 開啟上一步建立的目錄，在 Setup.bat 上點擊滑鼠右鍵，並選擇以系統管理員身分執行來啟動安裝程序：

    1. Welcome – 請選擇 [Next] 按鈕。
    2. License – 請先閱讀此畫面的終端使用者線上授權合約（EULA）。若你接受此合約，請選擇 [Agree] 按鈕；若否，請選擇 [Decline] 按鈕。

    3. Prerequisites – .NET Framework 3.5、.NET Framework 4.8、Internet Information Services（IIS）7.0 或更新的版本是必要的元件。若你希望安裝它們，選擇 [Install Windows Components] 按鈕；若已安裝這些元件，則選擇 [Skip] 按鈕略過。

      • Install Windows Components – 選擇 [Install Required Windows Features] 按鈕。安裝完成後，選擇 [Next] 按鈕。

    4. Cluster - 選擇 [A Standalone Instance]，再選擇 [Next] 按鈕。

      • Setup Instance - 於 [Serial Number] 欄位中輸入此實體的序號，接著選擇 [Next] 按鈕。

    5. Database - 若你希望安裝及設定新的 SQL Server Express 提供 CLEAR Engine 使用，請選擇 [Install SQL Server] 按鈕。若你希望設定一個既有的 SQL Server 實體供 CLEAR Engine 使用，請選擇 [Use Existing Database] 按鈕。

      • Install SQL Server – 選擇 [Launch SQL Server Setup] 按鈕以執行 SQL Server Express 的安裝程式。請依循安裝程式的步驟並直接接受預設的相關屬性設定，並在安裝完成後選擇 [Next] 按鈕。
      • Setup SQL Server – 請輸入你想使用的 SQL Server 的相關 FQDN、IP address 或電腦名稱及資料庫的實體名稱於 [SQL Server] 欄位中。（舉例來說，sqlserver.contoso.com\MSSQLSERVER 的 FQDN 就是 sqlserver.contoso.com、MSSQLSERVER 則是實體名稱）。接著選擇認證模式、若需要的話輸入使用者名稱及密碼，然後選擇 [Next] 按鈕。
    6. CLEAR Engine – 預設的儲存體位置會顯示在路徑按鈕上。若要選擇不同的儲存體位置，選擇按鈕並選擇想要的位置。然後選擇 [Next] 按鈕。需特別注意的是，安裝程式可能會在接下來的數分鐘間沒有回應。
    7. Web UI – 若要將 Web UI 安裝在同一台伺服器上，請輸入 Web UI 要使用的 FQDN 或 IP（電腦名稱，例如 ClearServer，是不支援的）於 [Web UI FQDN or IP address] 欄位中，接著選擇 [Next] 按鈕。若要使用其他伺服器作為 Web UI 主機，請直接選擇 [Skip] 按鈕。
    8. Complete – CLEAR Engine 和 Web UI 安裝完成。

安裝 CLEAR Engine 和 Web UI 為新叢集中的第一個節點

  1. 使用一個本機或網域管理者帳戶登入。建議使用內建的本機管理者帳戶來進行安裝。
  2. 解壓縮並執行 CLEAR Engine 安裝套件中的自我解壓縮檔（CLEAR_x64.exe）。它會建立一個 CLEAR_x64 目錄。

  3. 開啟上一步建立的目錄，在 Setup.bat 上點擊滑鼠右鍵，並選擇以系統管理員身分執行來啟動安裝程序：

    1. Welcome – 請選擇 [Next] 按鈕。
    2. License – 請先閱讀此畫面的終端使用者線上授權合約（EULA）。若你接受此合約，請選擇 [Agree] 按鈕；若否，請選擇 [Decline] 按鈕。

    3. Prerequisites – .NET Framework 3.5、.NET Framework 4.8、Internet Information Services（IIS）7.0 或更新的版本是必要的元件。若你希望安裝它們，選擇 [Install Windows Components] 按鈕；若已安裝這些元件，則選擇 [Skip] 按鈕略過。

      • Install Windows Components – 選擇 [Install Required Windows Features] 按鈕。安裝完成後，選擇 [Next] 按鈕。

    4. Cluster - 選擇 [Create a New Cluster]，再選擇 [Next] 按鈕。

      • Setup Instance - 於 [Serial Number] 欄位中輸入此實體的序號。新叢集的金鑰會顯示於 [Cluster Key] 欄位中。請記下此金鑰，因為在將其他實體加入此叢集時會需要它。接著選擇 [Next] 按鈕。

    5. Database - 若你希望安裝及設定新的 SQL Server Express 提供 CLEAR Engine 使用，請選擇 [Install SQL Server] 按鈕。若你希望設定一個既有的 SQL Server 實體供 CLEAR Engine 使用，請選擇 [Use Existing Database] 按鈕。

      • Install SQL Server – 選擇 [Launch SQL Server Setup] 按鈕以執行 SQL Server Express 的安裝程式。請依循安裝程式的步驟並直接接受預設的相關屬性設定，並在安裝完成後選擇 [Next] 按鈕。
      • Setup SQL Server – 請輸入你想使用的 SQL Server 的相關 FQDN、IP address 或電腦名稱及資料庫的實體名稱於 [SQL Server] 欄位中。（舉例來說，sqlserver.contoso.com\MSSQLSERVER 的 FQDN 就是 sqlserver.contoso.com、MSSQLSERVER 則是實體名稱）。接著選擇認證模式、若需要的話輸入使用者名稱及密碼，然後選擇 [Next] 按鈕。
    6. CLEAR Engine – 預設的儲存體位置會顯示在路徑按鈕上。若要選擇不同的儲存體位置，選擇按鈕並選擇想要的位置。請不要變更叢集金鑰。接著選擇 [Next] 按鈕。需特別注意的是，安裝程式可能會在接下來的數分鐘間沒有回應。
    7. Web UI – 若要將 Web UI 安裝在同一台伺服器上，請輸入 Web UI 要使用的 FQDN 或 IP（電腦名稱，例如 ClearServer，是不支援的）於 [Web UI FQDN or IP address] 欄位中，接著選擇 [Next] 按鈕。若要使用其他伺服器作為 Web UI 主機，請直接選擇 [Skip] 按鈕。
    8. Complete – CLEAR Engine 和 Web UI 安裝完成。

安裝 CLEAR Engine 和 Web UI 為現有叢集中的一個節點

  1. 使用一個本機或網域管理者帳戶登入。建議使用內建的本機管理者帳戶來進行安裝。
  2. 解壓縮並執行 CLEAR Engine 安裝套件中的自我解壓縮檔（CLEAR_x64.exe）。它會建立一個 CLEAR_x64 目錄。

  3. 開啟上一步建立的目錄，在 Setup.bat 上點擊滑鼠右鍵，並選擇以系統管理員身分執行來啟動安裝程序：

    1. Welcome – 請選擇 [Next] 按鈕。
    2. License – 請先閱讀此畫面的終端使用者線上授權合約（EULA）。若你接受此合約，請選擇 [Agree] 按鈕；若否，請選擇 [Decline] 按鈕。

    3. Prerequisites – .NET Framework 3.5、.NET Framework 4.8、Internet Information Services（IIS）7.0 或更新的版本是必要的元件。若你希望安裝它們，選擇 [Install Windows Components] 按鈕；若已安裝這些元件，則選擇 [Skip] 按鈕略過。

      • Install Windows Components – 選擇 [Install Required Windows Features] 按鈕。安裝完成後，選擇 [Next] 按鈕。

    4. Cluster - 選擇 [Join an Existing Cluster]，再選擇 [Next] 按鈕。

      • Setup Instance - 於 [Serial Number] 欄位中輸入此實體的序號。於 [Cluster Key] 欄位中輸入欲加入的叢集的金鑰。接著選擇 [Next] 按鈕。

    5. Database - 若你希望安裝及設定新的 SQL Server Express 提供 CLEAR Engine 使用，請選擇 [Install SQL Server] 按鈕。若你希望設定一個既有的 SQL Server 實體供 CLEAR Engine 使用，請選擇 [Use Existing Database] 按鈕。

      • Install SQL Server – 選擇 [Launch SQL Server Setup] 按鈕以執行 SQL Server Express 的安裝程式。請依循安裝程式的步驟並直接接受預設的相關屬性設定，並在安裝完成後選擇 [Next] 按鈕。
      • Setup SQL Server – 請輸入你想使用的 SQL Server 的相關 FQDN、IP address 或電腦名稱及資料庫的實體名稱於 [SQL Server] 欄位中。（舉例來說，sqlserver.contoso.com\MSSQLSERVER 的 FQDN 就是 sqlserver.contoso.com、MSSQLSERVER 則是實體名稱）。接著選擇認證模式、若需要的話輸入使用者名稱及密碼，然後選擇 [Next] 按鈕。
    6. CLEAR Engine – 預設的儲存體位置會顯示在路徑按鈕上。若要選擇不同的儲存體位置，選擇按鈕並選擇想要的位置。請確認叢集金鑰是正確的。若要變更，請選擇叢集金鑰按鈕。然後選擇 [Next] 按鈕。需特別注意的是，安裝程式可能會在接下來的數分鐘間沒有回應。
    7. Web UI – 若要將 Web UI 安裝在同一台伺服器上，請輸入 Web UI 要使用的 FQDN 或 IP（電腦名稱，例如 ClearServer，是不支援的）於 [Web UI FQDN or IP address] 欄位中，接著選擇 [Next] 按鈕。若要使用其他伺服器作為 Web UI 主機，請直接選擇 [Skip] 按鈕。
    8. Complete – CLEAR Engine 和 Web UI 安裝完成。

為 Web UI 設定 Internet Information Services（IIS）

  1. 開啟 [Internet Information Services 管理員] ，並在 [連線] 窗格內選擇已安裝 Web UI 的伺服器。

  2. 此時在右側的功能顯示窗格中，以滑鼠左鍵選擇兩次 [伺服器憑證] 項目。你可以選擇使用一個自我簽屬憑證、匯入現有憑證或建立憑證要求以供 Web UI 的 SSL 使用。

    • 建立自我簽屬憑證 – 在 [動作] 窗格中選擇 [建立自我簽屬憑證…]。在 [建立自我簽屬憑證] 視窗中，為憑證輸入一個好記名稱，例如：Lucent Sky AVM Web UI。
    • 匯入現有憑證 – 在 [動作] 窗格中選擇 [匯入…] ，接著輸入視窗中所需的相關資訊。
    • 建立憑證要求 – 在 [動作] 窗格中選擇 [建立憑證要求…]，接著輸入視窗中所需的相關資訊。
  3. 請於左側 [連線] 窗格之下，展開安裝了 Web UI 的伺服器，接著再展開 [站台] 目錄，並以滑鼠右鍵選擇 [CLEAR Web] 站台、選擇 [編輯繫結…] 項目。
  4. 於 [站台繫結] 視窗下，選擇 [新增(A)…] 按鈕。接著於新增站台繫結視窗中，[類型] 項目請在下拉式選單選擇 [https] 。若有需要，變更 [IP 位址(I)]、[連接埠]、[主機名稱]的設定值。[SSL憑證] 選擇你於上個步驟建立或匯入的憑證，完成後請選擇 [確定] 按鈕。
  5. 回到 [站台繫結] 視窗後，請選擇 [http] 項目，並選擇位於右側的 [移除(R)…] 按鈕。接著請選擇右下方的 [關閉] 按鈕。
  6. 以滑鼠右鍵選擇 [CLEAR Web] 站台、選擇 [管理網站] 下的 [啟動] 項目，讓站台開始運行。

安裝 Lucent Sky AVM 授權

在掃描應用程式之前，需要先安裝一個有效的授權。要了解如何在 CLEAR Engine 實體上安裝 Lucent Sky AVM 授權，請參考 Lucent Sky 知識庫：
安裝 Lucent Sky AVM 授權

非必要的步驟

當你安裝 CLEAR Engine 和 Web UI 之後，依照你的環境，你可能會想要完成這些選用的步驟：

  • 開啟長路徑支援

    若你需要掃描在非 Windows 作業系統上開發的應用程式，考慮開啟長路徑支援。要了解如何在 CLEAR Engine 實體上安裝 Lucent Sky AVM 授權，請參考 Lucent Sky 知識庫：
    開啟長路徑支援

  • 將 CLEAR Engine 檔案排除防毒軟體掃描

    將 CLEAR Engine 的相關檔案自防毒軟體掃描中排除可以提升效能。要了解如何設定套件目錄，請參考 Lucent Sky 知識庫：
    在防毒軟體掃描中排除 CLEAR Engine 檔案

  • 設定套件目錄

    設定自訂套件目錄可讓儲存體的管理更輕鬆。要了解如何設定套件目錄，請參考 Lucent Sky 知識庫：
    設定套件目錄

停用 CLEAR Engine 授權

停用 CLEAR Engine 授權可讓此授權移轉至另一個伺服器。要了解如何從 CLEAR Engine 實體上移除 Lucent Sky AVM 授權，請參考 Lucent Sky 知識庫：
安裝 Lucent Sky AVM 授權

設置 CLEAR Engine 和 Web UI

CLEAR Engine 和 Web UI 皆能使用設定檔案來自訂設置。要了解如何使用 CLEAR Engine 和 Web UI 的設定，請參考 Lucent Sky 知識庫：
設置 CLEAR Engine 和 Web UI

備份和還原 CLEAR Engine 設定和資料

CLEAR Engine 的設定和資料可獨立或和作業系統一起被備份及還原。要了解如何備份及還原 CLEAR Engine 的設定和資料，請參考 Lucent Sky 知識庫：
備份和還原 Lucent Sky AVM 實體或叢集

移除 CLEAR Engine 和 Web UI

  1. 使用一個本機或網域管理者帳戶登入。
  2. 以系統管理員身分開啟 Windows PowerShell。

  3. 輸入以下的命令：

     cd "C:\ProgramData\Lucent Sky\CLEAR Engine\Maintenance\Current"
 .\Setup.bat -m
  4. 選取 [Remove CLEAR Engine]，這將會移除 Windows 服務。若要從系統完整移除 CLEAR Engine，請刪除 C:\Program Files\Lucent Sky\CLEAR Engine 目錄。
  5. 選取 [Remove Web UI] 這將會移除 IIS 應用程式集區及站台。若要從系統完整移除 Web UI，請刪除 C:\Program Files\Lucent Sky\CLEAR Web 目錄。

如果這是一個獨立的實體，依照以下的步驟將它的資料從系統中移除：

  1. 以系統管理員身分開啟 Windows PowerShell。

  2. 輸入以下的命令：

     # Replace .\SQLEXPRESS if using a custom SQL Server instance
 $sqlInstance = ".\SQLEXPRESS"
 sqlcmd -S $sqlInstance -Q "drop database [SkyAnalyzer]"

  3. 輸入以下的命令：

     Remove-Item "C:\ProgramData\Lucent Sky" -Recurse

如果這是 CLEAR Engine 叢集中最後一個節點，依照以下的步驟將它的資料從系統中移除：

  1. 在具有叢集資料庫的伺服器中，使用一個本機或網域管理者帳戶登入。
  2. 以系統管理員身分開啟 Windows PowerShell。

  3. 輸入以下的命令：

     # Replace .\SQLEXPRESS if using a custom SQL Server instance
 $sqlInstance = ".\SQLEXPRESS"
 sqlcmd $sqlInstance -Q "drop database [SkyAnalyzer]"
  4. 在具有叢集儲存體的伺服器中，使用一個本機或網域管理者帳戶登入。
  5. 以系統管理員身分開啟 Windows PowerShell。

  6. 輸入以下的命令：

     # Replace C:\ProgramData\Lucent Sky if using a custom file system storage location
 $fileSystemStorage = "C:\ProgramData\Lucent Sky\CLEAR Engine"
 Remove-Item $fileSystemStorage -Recurse