SonarQube升級指南

這是跨版本 SonarQube 升級的通用指南。 仔細(xì)閱讀目標(biāo)版本和任何中間版本的版本升級說明。

在升級之前，我們建議在盡可能類似于您的生產(chǎn)環(huán)境的臨時環(huán)境中練習(xí)升級。

在升級之前，請備份您的 SonarQube 數(shù)據(jù)庫。 升級問題很少見，但如果發(fā)生任何事情，您將需要備份。

升級之前

此頁面包含升級前應(yīng)熟悉的一些概念和建議。

SonarQube 版本號格式

版本號最多由三位數(shù)字組成，每個數(shù)字代表發(fā)布周期的一部分：

 

主要版本號
主要版本號代表一系列發(fā)布，具有發(fā)布周期的高級目標(biāo)。 它隨著 LTS 版本之后的版本而增加（例如，7.9 LTS 之后的版本是 8.0）。

次要版本號
次要版本號對應(yīng)于主要發(fā)布周期內(nèi)的增量功能更改。 在 LTS 發(fā)布時，發(fā)布周期關(guān)閉，次要版本號被凍結(jié)。

補丁版本號
僅在 LTS 版本上，補丁版本號代表 LTS 的補丁，用于修復(fù)阻止程序或關(guān)鍵問題。 升級遷移路徑中不考慮補丁版本號，無論您使用哪個補丁號，您的遷移路徑都是相同的。

遷移路徑

跨多個非 LTS 版本的升級是自動處理的。 但是，如果您的遷移路徑中有一個或多個 LTS 版本，您必須先遷移到每個中間 LTS，然后再遷移到目標(biāo)版本，如下例 3 所示。

如果您從 LTS 的早期補丁版本遷移，您可以直接升級到下一個 LTS。 您不需要安裝任何中間補丁版本。

遷移路徑示例：

示例 1 – 從 8.1 > 9.0，遷移路徑為 8.1 > 8.9.1 LTS > 9.0

示例 2 – 從 8.2 > 8.9 LTS，遷移路徑是 8.2 > 最新的 8.9 LTS 補丁。

示例 3 – 從 6.7.7 LTS > 8.9 LTS，遷移路徑為 6.7.7 LTS > 7.9.6 LTS > 最新的 8.9 LTS 補丁。

版本升級說明

通常，SonarQube 版本會附帶一些從以前版本升級的具體建議。 您應(yīng)該閱讀當(dāng)前版本和目標(biāo)版本之間每個版本的版本升級說明。

練習(xí)升級

我們建議您先練習(xí)升級到：

• 確保您的基礎(chǔ)架構(gòu)可以運行升級。
• 了解升級需要多長時間。
• 更好地了解升級過程并預(yù)測在執(zhí)行實際升級時需要執(zhí)行的操作。
• 在 SonarSource 社區(qū)解決您在練習(xí)升級過程中遇到的任何問題。

要練習(xí)升級，請使用生產(chǎn)數(shù)據(jù)庫的最新備份創(chuàng)建一個臨時環(huán)境。 您希望登臺環(huán)境與生產(chǎn)實例盡可能相似，因為升級所需的資源和時間取決于數(shù)據(jù)庫中存儲的內(nèi)容。 使用此暫存環(huán)境來測試升級，觀察備份和恢復(fù)系統(tǒng)以及完成該過程所需的時間。

數(shù)據(jù)庫磁盤使用建議

在升級期間，可能會復(fù)制表以加快遷移過程。 這可能會導(dǎo)致您的數(shù)據(jù)庫磁盤使用量暫時增加到正常使用量的兩倍。 因此，在開始遷移之前，我們建議您的數(shù)據(jù)庫磁盤使用率低于 50%。

從 ZIP 文件升級

• 將您的版本的 SonarQube 發(fā)行版下載并解壓縮到一個新目錄中，比如 $NEW_SONAR_HOME
• 如果您使用第三方插件，請手動安裝與您的 SonarQube 版本兼容的插件。使用插件版本矩陣確保您安裝的版本與您的服務(wù)器版本兼容。不建議簡單地將插件從舊服務(wù)器復(fù)制到新服務(wù)器；不兼容或重復(fù)的插件可能會導(dǎo)致啟動錯誤。默認(rèn)情況下，無需插件即可分析您的版本提供的所有語言。
• 使用 $OLD_SONAR_HOME/conf 目錄中相關(guān)文件的設(shè)置（網(wǎng)絡(luò)服務(wù)器 URL、數(shù)據(jù)庫、ldap 設(shè)置等）更新 sonar.properties 和 wrapper.conf 文件（在 $NEW_SONAR_HOME/conf 中）的內(nèi)容。不要復(fù)制粘貼舊文件。如果您使用的是 Oracle DB，請將其 JDBC 驅(qū)動程序復(fù)制到 $NEW_SONAR_HOME/extensions/jdbc-driver/oracle
• 停止您的舊 SonarQube 服務(wù)器
• 啟動您的新 SonarQube 服務(wù)器
• 瀏覽到 http://yourSonarQubeServerURL/setup 并按照設(shè)置說明進行操作
• 重新分析您的項目以獲取新數(shù)據(jù)

從 Docker 鏡像升級

如果您使用 Oracle 數(shù)據(jù)庫升級或使用插件，您可以重復(fù)使用以前版本的擴展卷以避免移動插件或驅(qū)動程序。 使用插件版本矩陣確保您的插件與您的版本兼容。 默認(rèn)情況下，無需插件即可分析您的版本提供的所有語言。

要使用 Docker 映像升級 SonarQube：

• 停止并刪除現(xiàn)有的 SonarQube 容器（從 UI 重新啟動是不夠的，因為環(huán)境變量僅在第一次運行期間評估，而不是在重新啟動期間評估）：

$ docker stop <container_id>

$ docker rm <container_id>

• 運行docker:

$> docker run -d --name sonarqube \

    -p 9000:9000 \

    -e SONAR_JDBC_URL=... \

    -e SONAR_JDBC_USERNAME=... \

    -e SONAR_JDBC_PASSWORD=... \

    -v sonarqube_data:/opt/sonarqube/data \

    -v sonarqube_extensions:/opt/sonarqube/extensions \

    -v sonarqube_logs:/opt/sonarqube/logs \

    <image_name>

• 轉(zhuǎn)到 http://yourSonarQubeServerURL/setup 并按照設(shè)置說明進行操作。
• 重新分析您的項目以獲得新數(shù)據(jù)。

從 8.9.x LTS 到另一個 8.9.x LTS

不需要特定的 Docker 操作，只需使用新標(biāo)簽即可。

從 Helm Chart 升級

如果您使用 Oracle 數(shù)據(jù)庫升級或使用插件，您可以重用以前版本的擴展 PVC 以避免移動插件或驅(qū)動程序。 使用插件版本矩陣確保您的插件與您的版本兼容。 默認(rèn)情況下，無需插件即可分析您的版本提供的所有語言。

要使用我們的官方 Helm Chart 升級 SonarQube：

• 更改您的 values.yaml 上的 SonarQube 版本。
• 使用相同的舵圖重新部署 SonarQube：

helm upgrade --install -f values.yaml -n <your namespace> <your release name> <path to sonarqube helm chart>

• 轉(zhuǎn)到 http://yourSonarQubeServerURL/setup 并按照設(shè)置說明進行操作。
• 重新分析您的項目以獲得新數(shù)據(jù)。

回滾

如果您需要恢復(fù)到之前版本的 SonarQube，所有部署的高級回滾過程如下：

• 關(guān)閉您的 SonarQube 實例/集群。
• 將您的數(shù)據(jù)庫回滾到開始升級前的備份。
• 切換回 SonarQube 安裝的先前版本。
• 啟動您的 SonarQube 實例/集群。

更改您的版本

如果您要遷移到同一 SonarQube 版本中的不同版本（例如，從社區(qū)版到商業(yè)版），則步驟與上述完全相同，無需導(dǎo)航到 http://yourSonarQubeServerURL/setup 或重新分析 你的項目。

從 ZIP 文件實例遷移到 Docker 實例

從 ZIP 文件遷移到 Docker：

• 配置您的 Docker 實例以指向您現(xiàn)有的數(shù)據(jù)庫。
• 關(guān)閉您的 ZIP 實例。
• 啟動您的 Docker 實例。

其他步驟和信息

Oracle清理

從 6.6 版開始，如果您使用 Oracle，您可能需要執(zhí)行一個額外的步驟。 在 Oracle 上，要刪除的數(shù)據(jù)庫列現(xiàn)在標(biāo)記為 UNUSED，不再物理刪除。 要回收磁盤空間，Oracle 管理員必須手動刪除這些未使用的列。 SQL 請求是 ALTER TABLE foo DROP UNUSED COLUMNS。 相關(guān)表列在系統(tǒng)表 all_unused_col_tabs 中。

額外的數(shù)據(jù)庫維護

我們建議您在完成技術(shù)升級后，但在重新分析項目之前，刷新數(shù)據(jù)庫的統(tǒng)計信息并重建數(shù)據(jù)庫的索引。

對于 PostgreSQL，這意味著執(zhí)行 VACUUM FULL。 根據(jù) PostgreSQL 文檔：

在正常的 PostgreSQL 操作中，被更新刪除或廢棄的元組不會從它們的表中物理刪除； 它們一直存在，直到完成 VACUUM。

掃描儀更新

升級 SonarQube 時，您還應(yīng)該確保使用最新版本的 SonarQube 掃描儀，以利用掃描儀端的功能和修復(fù)。 請檢查您使用的掃描儀的文檔頁面，了解與 SonarQube 和您的構(gòu)建工具兼容的最新版本。

SonarQube 作為 Linux 或 Windows 服務(wù)

如果您使用外部配置（例如腳本或 Windows 服務(wù)）來控制您的服務(wù)器，則需要將其更新為指向 $NEW_SONAR_HOME。

• 對于 Linux，這取決于您如何實現(xiàn)服務(wù)
• 對于 Windows，您可以通過運行來更新您的服務(wù)：

sc config SonarQube binPath= "\"$NEW_SONAR_HOME\bin\windows-x86-64\wrapper.exe\" -s \"$NEW_SONAR_HOME\conf\wrapper.conf\""

重建索引

如果您的升級需要重建 Elasticsearch 索引，您的項目和應(yīng)用程序?qū)⒃谥匦滤饕笞兊每捎谩?在對所有項目編制索引之前，資料將不可用。