From 942b5492f47be0c7e87e9cb2d219a8cfb7077a78 Mon Sep 17 00:00:00 2001 From: michaelbirnstiehl Date: Thu, 23 Apr 2020 08:25:03 -0500 Subject: [PATCH] DOCS Remove SonarCloud references from requirements --- .../github-application.md | 58 ------------------- .../src/pages/requirements/requirements.md | 2 +- 2 files changed, 1 insertion(+), 59 deletions(-) delete mode 100644 server/sonar-docs/src/pages/instance-administration/github-application.md diff --git a/server/sonar-docs/src/pages/instance-administration/github-application.md b/server/sonar-docs/src/pages/instance-administration/github-application.md deleted file mode 100644 index 8841dc9861a..00000000000 --- a/server/sonar-docs/src/pages/instance-administration/github-application.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: GitHub Enterprise Integration -url: /instance-administration/github-application/ ---- -_GitHub Enterprise Integration is available as part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) and [above](https://www.sonarsource.com/plans-and-pricing/)._ - -You can add Pull Request decoration to Checks in GitHub Enterprise by creating a GitHub Application, configuring your SonarQube instance, and installing the app in your organizations. - -## Creating a GitHub Application - -Click [here](https://developer.github.com/apps/building-github-apps/creating-a-github-app/) for general instructions on creating a GitHub App. - -From the "Register new GitHub App" page, follow these steps to create your GitHub App for PR decoration: - -1. Under **GitHub App name**, give your app a name (such as SonarQubePRChecks). -2. GitHub requires a **Homepage URL** and a **Webhook URL**. These values aren't important for Pull Request decoration, so you can use any URL (such as https://www.sonarqube.org/). -3. Grant access for the following **Permissions** - - | Permission | Access | - |---------------------|--------------| - | Checks | Read & write | - | Repository metadata | Read-only | - | Pull Requests | Read-only | - | Commit statuses | Read-only | - -4. Under "Where can this GitHub App be installed?," select **Any account**. -5. Click **Create GitHub App**. - -## Generating and Setting Your Private Key - -After creating your app, you'll be prompted with a link to "generate a private key" at the top of the page. Click the link to download your `.pem` private key file. You can also download your `.pem` file by scrolling down to "Private Key" and clicking **Generate Private Key**. - -After downloading your `.pem` file, you'll need to set your private key in SonarQube global settings by copying and pasting the content of your private key file into the text box at [**Administration > Pull Requests > GitHub > GitHub App private key**](/#sonarqube-admin#/admin/settings?category=pull_request/). - -## Configuring Your SonarQube Instance - -You'll need to configure the following global settings in SonarQube. - -### Setting Your GitHub Enterprise Instance API URL - -Enter your GitHub Enterprise Instance API URL in the text box at [**Administration > Pull Requests > GitHub > GitHub API URL**](/#sonarqube-admin#/admin/settings?category=pull_request/). -Your GitHub Enterprise instance API URL is formatted as follows: `https:///api/v3` - -### Setting Your App Name and ID - -1. Enter your app name in the text box at [**Administration > Pull Requests > GitHub > GitHub App name**](/#sonarqube-admin#/admin/settings?category=pull_request/). -2. Enter your app ID in the text box at [**Administration > Pull Requests > GitHub > GitHub App ID**](/#sonarqube-admin#/admin/settings?category=pull_request/). You can find your GitHub App ID on the app's settings page at `https:///settings/apps/`. - -## Installing Your App - -To install your app in your organizations: - -1. Go to your GitHub App URL. - * GitHub App URLs are specific to your GitHub Enterprise Address and your app name and are formatted as follows: `https:///github-apps/`. - * For example, if your GitHub Enterprise address is `github-enterprise-1.yoursite.com` and your app name is `SonarQubePRChecks`, your GitHub App URL will be `https://github-enterprise-1.yoursite.com/github-apps/SonarQubePRChecks`. -2. From your GitHub App page, click the **Install** or **Configure** button. -3. Choose the organization where you want to install your app from the list. -4. Click the **Install** button. diff --git a/server/sonar-docs/src/pages/requirements/requirements.md b/server/sonar-docs/src/pages/requirements/requirements.md index d041dfba1db..02a4ab553a0 100644 --- a/server/sonar-docs/src/pages/requirements/requirements.md +++ b/server/sonar-docs/src/pages/requirements/requirements.md @@ -7,7 +7,7 @@ The only prerequisite for running SonarQube is to have Java (Oracle JRE 11 or Op ## Hardware Requirements 1. A small-scale (individual or small team) instance of the SonarQube server requires at least 2GB of RAM to run efficiently and 1GB of free RAM for the OS. If you are installing an instance for a large teams or Enterprise, please consider the additional recommendations below. -2. The amount of disk space you need will depend on how much code you analyze with SonarQube. As an example, [SonarCloud](https://sonarcloud.io) the public instance of SonarQube, has more than 350 million lines of code under analysis with 5 years of history. SonarCloud is currently running on clustered [Amazon EC2 m5.large](http://aws.amazon.com/ec2/instance-types/) instances with allocations of 50 Gb of drive space per node. It handles 19,000+ projects with roughly 14M open issues. SonarCloud runs on PostgreSQL 9.5 and it is using about 250Gb of disk space for the database. +2. The amount of disk space you need will depend on how much code you analyze with SonarQube. 3. SonarQube must be installed on hard drives that have excellent read & write performance. Most importantly, the "data" folder houses the Elasticsearch indices on which a huge amount of I/O will be done when the server is up and running. Great read & write hard drive performance will therefore have a great impact on the overall SonarQube server performance. 4. SonarQube does not support 32-bit systems on the server side. SonarQube does, however, support 32-bit systems on the scanner side. -- 2.39.5