aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-docs
diff options
context:
space:
mode:
authormichaelbirnstiehl <michael.birnstiehl@sonarsource.com>2020-06-16 16:00:50 -0500
committersonartech <sonartech@sonarsource.com>2020-06-26 20:04:58 +0000
commitd4024846b199ece9f00b5bcfba0bced5b031ce2c (patch)
treef2af753a8ae4aa216163cf7ed5d0cadd79792d0b /server/sonar-docs
parent9b598e4d1b7e89f5f162cdbfb6992510154cef37 (diff)
downloadsonarqube-d4024846b199ece9f00b5bcfba0bced5b031ce2c.tar.gz
sonarqube-d4024846b199ece9f00b5bcfba0bced5b031ce2c.zip
SONAR-13532 Update docs for indexing during disaster recovery
Diffstat (limited to 'server/sonar-docs')
-rw-r--r--server/sonar-docs/src/pages/project-administration/managing-application.md7
-rw-r--r--server/sonar-docs/src/pages/project-administration/managing-portfolios.md5
-rw-r--r--server/sonar-docs/src/pages/setup/troubleshooting.md18
-rw-r--r--server/sonar-docs/src/pages/setup/upgrading.md3
-rw-r--r--server/sonar-docs/src/pages/user-guide/applications.md4
-rw-r--r--server/sonar-docs/src/pages/user-guide/portfolios.md12
6 files changed, 35 insertions, 14 deletions
diff --git a/server/sonar-docs/src/pages/project-administration/managing-application.md b/server/sonar-docs/src/pages/project-administration/managing-application.md
index c3a2494c9ba..8c2b13b784f 100644
--- a/server/sonar-docs/src/pages/project-administration/managing-application.md
+++ b/server/sonar-docs/src/pages/project-administration/managing-application.md
@@ -3,7 +3,7 @@ title: Managing Applications
url: /project-administration/managing-applications/
---
-*Applications are available as part of the [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/).*
+*Applications are available starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html).*
## Permissions
There are two levels of users with permissions for adding and editing Applications: users with the Create Applications permission and Global Administrators.
@@ -27,4 +27,7 @@ Once your Application exists, you can populate it with manually-selected project
Once your Application is populated with projects, you can create application branches by choosing branches from the Application's component projects. This option is available in the Application's **Application Settings > Edit Definition** interface, or from the global administration interface.
## Calculation
-By default, Applications are queued to be recalculated after each analysis of an included project. For each relevant Application, a “Background Task” is created, and you can follow the progress on each in the **[Administration > Projects > Background Tasks](/#sonarqube-admin#/admin/background_tasks)** by looking at the logs available for each item. \ No newline at end of file
+By default, Applications are queued to be recalculated after each analysis of an included project. For each relevant Application, a “Background Task” is created, and you can follow the progress on each in the **[Administration > Projects > Background Tasks](/#sonarqube-admin#/admin/background_tasks)** by looking at the logs available for each item.
+
+## Reindexing
+During Elasticsearch reindexing due to disaster recovery or upgrading, Applications will become available after each Application is indexed. \ No newline at end of file
diff --git a/server/sonar-docs/src/pages/project-administration/managing-portfolios.md b/server/sonar-docs/src/pages/project-administration/managing-portfolios.md
index 604b7f082c9..1164757a450 100644
--- a/server/sonar-docs/src/pages/project-administration/managing-portfolios.md
+++ b/server/sonar-docs/src/pages/project-administration/managing-portfolios.md
@@ -3,7 +3,7 @@ title: Managing Portfolios
url: /project-administration/managing-portfolios/
---
-*Portfolios are available as part of the [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/).*
+*Portfolios are available starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html).*
## Permissions
There are two levels of users with permissions for adding and editing Portfolios: users with the Create Portfolios permission and Global Administrators.
@@ -56,3 +56,6 @@ To add an Application to a Portfolio, first make sure your Application is [alrea
By default, Portfolios are queued to be recalculated after each analysis of an included project. For each relevant Portfolio, a “Background Task” is created, and you can follow the progress on each in the **[Administration > Projects > Background Tasks](/#sonarqube-admin#/admin/background_tasks)** by looking at the logs available for each item.
If you're having performance issues related to automatic recalculation of large portfolios, you can specify the hour(s) at which you want them to be recalculated at **[Administration > Portfolios > Recalculation](/#sonarqube-admin#/admin/settings?category=portfolios)**. Portfolios are queued to be recalculated at the beginning of the hour(s) that you specify.
+
+## Reindexing
+During Elasticsearch reindexing due to disaster recovery or an upgrade, you won't have access to Portfolios until all projects are indexed.
diff --git a/server/sonar-docs/src/pages/setup/troubleshooting.md b/server/sonar-docs/src/pages/setup/troubleshooting.md
index 4b82fd19689..a58929c3b34 100644
--- a/server/sonar-docs/src/pages/setup/troubleshooting.md
+++ b/server/sonar-docs/src/pages/setup/troubleshooting.md
@@ -3,8 +3,6 @@ title: Troubleshooting
url: /setup/troubleshooting/
---
-<!-- sonarqube -->
-
## Checking the logs
If you're having trouble starting your server for the first time (or any subsequent time!) the first thing to do is check your server logs. You'll find them in `$SONARQUBE_HOME/logs`:
@@ -72,4 +70,18 @@ If you still have inconsistencies, you'll need to rebuild the indices (this oper
**Note:** See [Configure & Operate a Cluster](/setup/operate-cluster/) for information on stopping and starting a cluster.
-<!-- /sonarqube -->
+## Failed tasks during reindexing
+
+During Elasticsearch reindexing due to disaster recovery or an upgrade, you may have a failed tasks in your branches or Pull Requests. If you only have a few failed tasks, you can reanalyze your branch or Pull Request. You may want to use web services to remove branches and Pull Requests that can't be reanalyzed because they have been removed from version control. If you have many failed tasks, you may want to delete your Elasticsearch directory and reindex again. To delete your Elasticsearch directory:
+
+**non-DCE:**
+
+1. Stop SonarQube
+1. Delete the data/es6 directory
+1. Restart SonarQube
+
+**DCE:**
+
+1. Stop the whole cluster (ES and application nodes)
+1. Delete the data/es6 directory on each ES node
+1. Restart the whole cluster
diff --git a/server/sonar-docs/src/pages/setup/upgrading.md b/server/sonar-docs/src/pages/setup/upgrading.md
index 6027fe9cd82..02472f4f16d 100644
--- a/server/sonar-docs/src/pages/setup/upgrading.md
+++ b/server/sonar-docs/src/pages/setup/upgrading.md
@@ -129,6 +129,9 @@ If you use external configuration, such as a script or Windows Service to contro
In case you used the InstallNTService.bat to install SonarQube as a Windows Service, run the $OLD_SONARQUBE_HOME/bin/.../UninstallNTService.bat before running the InstallNTService.bat of the $NEW_SONARQUBE_HOME.
+### Rebuilding Indexes
+If your upgrade requires the rebuild of Elasticsearch indexes, your projects and Applications will become available as they are reindexed. Portfolios won't be available until all projects are indexed.
+
## Release Upgrade Notes
Usually SonarQube releases come with some specific recommendations for upgrading from the previous version. You should read the upgrade notes for each version between your current version and the target version.
diff --git a/server/sonar-docs/src/pages/user-guide/applications.md b/server/sonar-docs/src/pages/user-guide/applications.md
index 271e05d6402..beebebedb02 100644
--- a/server/sonar-docs/src/pages/user-guide/applications.md
+++ b/server/sonar-docs/src/pages/user-guide/applications.md
@@ -3,7 +3,7 @@ title: Applications
url: /user-guide/applications/
---
-*Applications are available as part of the [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/).*
+*Applications are available starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html).*
## Using Applications
@@ -27,4 +27,4 @@ Branches are available for Applications. They allow you to aggregate branches fr
**Note:** Avoid adding branches to your application that will be deleted to prevent issues with your Application status.
-Once an Application has been set up, anyone with administration rights on the Application can manually create a new branch in the **Application Settings > Edit Definition** interface. Branches can also be managed from the global **Administration > Configuration > Portfolios** interface. For each Application branch you can choose which project branch should be included, or whether the project should be represented in the branch at all.
+Once an Application has been set up, anyone with administration rights on the Application can manually create a new branch in the **Application Settings > Edit Definition** interface. Branches can also be managed from the global **Administration > Configuration > Portfolios** interface. For each Application branch you can choose which project branch should be included, or whether the project should be represented in the branch at all. \ No newline at end of file
diff --git a/server/sonar-docs/src/pages/user-guide/portfolios.md b/server/sonar-docs/src/pages/user-guide/portfolios.md
index 36a6e79244b..336b3483c12 100644
--- a/server/sonar-docs/src/pages/user-guide/portfolios.md
+++ b/server/sonar-docs/src/pages/user-guide/portfolios.md
@@ -3,9 +3,9 @@ title: Portfolios
url: /user-guide/portfolios/
---
-*Portfolios are available as part of the [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/).*
+*Portfolios are available starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html).*
-### Portfolios Home Page
+## Portfolios Home Page
The Portfolio Home Page is the central place for managers and tech leads to keep an eye on the Releasability of the projects under their supervision. Releasability is based on the project's quality gate: Passed is releasable and Failed is not. Each Portfolio home page offers an aggregate view of the releasability of all projects in the Portfolio.
@@ -17,7 +17,7 @@ For each domain, you'll see:
* an indicator of when the rating last changed
* an indicator of the worst-performing project(s) in the domain
-### Releasability Rating
+## Releasability Rating
The Releasability rating is the ratio of projects in the Portfolio that have a **Passed** Quality Gate:
@@ -27,7 +27,7 @@ The Releasability rating is the ratio of projects in the Portfolio that have a *
**D**: > 20%
**E**: <= 20%
-### Reliability, Security Vulnerabilities, Security Review, and Maintainability Ratings
+## Reliability, Security Vulnerabilities, Security Review, and Maintainability Ratings
The Reliability, Security Vulnerabilities, Security Review, and Maintainability ratings for a Portfolio are calculated as the average of the ratings for all projects included in the Portfolio.
@@ -45,7 +45,7 @@ Rating conversion:
*Note: the Portfolio Home Page is also available at Sub-Portfolio level*
-### Portfolio PDF Report
+## Portfolio PDF Report
On a Portfolio Home Page, you can download a PDF overview of the Portfolio by selecting **Download as PDF** from the "Portfolio PDF Report" dropdown menu in the upper-right corner. This is really convenient, for example, if you're going into a meeting where you may not have access to your SonarQube instance.
@@ -53,4 +53,4 @@ You can subscribe to receive a PDF by email by selecting **Subscribe** from the
**Note:** You will only receive the PDF if the Portfolio is computed.
-Portfolios are created and edited in the global Portfolio administration interface: **Administration > Configuration > Portfolios**. For more information, see [Managing Portfolios](/project-administration/managing-portfolios/).
+Portfolios are created and edited in the global Portfolio administration interface: **Administration > Configuration > Portfolios**. For more information, see [Managing Portfolios](/project-administration/managing-portfolios/). \ No newline at end of file