Choosing and getting started in the US region

The SonarQube Cloud US instance is now available at sonarqube.us.

When you sign up for the SonarQube Cloud US instance, your account will be created in the US region.

You can use the current SonarQube Cloud documentation to manage and use the US instance except for some specificities described below. Note that when you see sonarcloud.io in the documentation, you must replace it with sonarqube.us.

Signing in to SonarQube Cloud US instance

The sign-in procedure to the US instance is the same as to the EU instance (see the Signing in to SonarQube Cloud page), except that you must:

• Go to sonarqube.us instead of sonarcloud.io.

• Ensure that you use a corporate email when signing in via a DevOps platform service. A personal email address (e.g., gmail address) will not be allowed.

Analyzing your project in the US region

Prerequisites

Make sure you use at least the following scanner version:

• SonarScanner for Maven: 5.1

• SonarScanner for Gradle: 6.1

• SonarScanner for .NET: 10.2

• SonarScanner for NPM: 4.3

• SonarScanner CLI: 7.1

• SonarScanner CLI Docker image: 11.3

• SonarQube Scan GitHub Action: 5.1.0

• SonarCloud Scan Bitbucket Pipe: 4.1

• Azure DevOps extension for SonarQube Cloud: 3.2

If you use CircleCI with our Orb, use at least Orb version 3.0.

Configuring your scanner for the US region

The procedure is the same for all scanners except Azure DevOps extension.

AZURE DEVOPS EXTENSION

ALL OTHER SCANNERS

Once you have created your project in SonarQube Cloud, proceed as follows:

1. Add the SonarQube Cloud service connection to Azure Pipelines for your project. The procedure is the same as described on the in the Adding SonarQube service connection to Azure Pipelines (SonarQube endpoint) article, except that you must select the US region as illustrated below.

2. Add the SonarQube Cloud analysis to your Azure build pipeline as described on Introduction page for Adding SonarQube Cloud analysis to your Azure build pipeline.

A new analysis parameter has been added to configure the scanner on a given region as described in the table below. Information about analysis parameters can be found on the Analysis parameters page.

Property key

Description

sonar.region

SonarQube Cloud instance’s region in which your project is hosted.

Environment variable:SONAR_REGION (Not supported yet by the SonarScanner for .NET).

Possible values:

• empty (default value)

• US

To configure your scanner for the US region:

• Set the sonar.region property to US on the CI/CD host.

Note that:

• For SonarScanner for .NET, the command line argument is /d:sonar.region=us.

• For CircleCI users (whether you use our Orb or the SonarScanner CLI directly in your CircleCI), we recommend that you add the SONAR_REGION environment variable to your CircleCI context.

If you do not specify this property or the corresponding environment variable, the scanner will look for your project in the SonarQube Cloud EU instance.

For general information about how to set an analysis parameter on the CI/CD host, see these pages for more details:

• SonarScanner for Maven

• SonarScanner for Gradle

• For the SonarScanner for .NET: Using the scanner

• For the SonarScanner for NPM: Configuring the scanner

• SonarScanner CLI

• Github Actions

• Bitbucket Pipelines

Connecting your project to SonarQube for IDE (connected mode)

SonarQube for IDE is a free IDE extension that integrates with SonarQube Cloud using connected mode. Details about connected mode are on theSonarQube for IDE page.

Connected mode can be set up for your project if:

• Your SonarQube Cloud organization is connected to one of the supported IDEs.

• The SonarQube Cloud project is bound to the corresponding project in your supported IDE.

To set up connected mode for a project, you can use two different modes:

1. Automatic mode: If a SonarQube Cloud user tries to open an issue detected in their project’s code in their IDE and connected mode has not been set up yet for the respective organization, the user will be prompted to start the automatic setup of connected mode. This is the easiest and preferred method.

2. Manual mode: If the automatic mode fails, a user (for example, the team manager) can perform the setup manually for the project in the IDE and share the connection details so that their teammates can perform the setup automatically, using the shared configuration.

We explain below how to use both modes in the US region.

Using the automatic setup mode (Open in IDE button)

To set up connected mode for your project using the automatic mode:

1. Open your project in your IDE.

2. In the SonarQube Cloud US instance, retrieve an issue detected in your project’s code and select the Open in IDE button. See the Opening issues in your IDE article for instructions to do this from SonarQube Cloud.

3. You’ll be prompted to confirm the connection of your SonarQube Cloud organization as illustrated below. Confirm by selecting Connect to This SonarQube Cloud Organization.

If the project opened in the IDE matches the SonarQube Cloud project, project binding is also performed. You’ll be notified about the successful organization connection and/or project binding.

Note that:

• If your organization is already connected to your IDE, project binding will be performed in the background (no confirmation will be required).

• If your project is not opened in your IDE or no matching is found, only the organization connection will be performed.

Using the manual setup mode

If the automatic setup mode fails, a user, such as your team leader, can manually set up connected mode.

To set up connected mode manually for a given IDE project:

1. If not already done, enable the US region option in your IDE.

2. If not already done, connect the respective SonarQube Cloud US organization to your IDE.

3. Bind the IDE project with the respective SonarQube Cloud US project and share the binding.

4. The teammates can now automatically bind the IDE project with the SonarQube Cloud US project by using the shared configuration.

We explain below how to perform these steps in detail for the different flavors of IDE.

VS CODE

INTELLIJ

VISUAL STUDIO

ECLIPSE

Step 1: Enable the US region option in your IDE

1. In VS Code, open the SonarLint extension settings.

2. In Sonarlint > Early Access: Show Region Selection, select the Show region selection while creating SonarQube Cloud Connection (Early Access) option.

Step 2: Connect the SonarQube Cloud US organization to your IDE

Follow the procedure described in Connected mode setup, by adding the following step:

• When you create the SonarQube Cloud connection in your IDE, select the US - sonarqube.us option as illustrated below (the EU option is selected by default).

Step 3: Bind your project and share the binding

Follow the procedure described on the Connected mode setup article.

Step 4: Teammates can now bind the project more easily using shared configuration

Follow the procedure described in the Connected mode setup article.

Step 1: Enable the US region option in your IDE

1. In IntelliJ, go to Settings > Tools > SonarQube for IDE.

2. Select the Show region selection for SonarQube Cloud (early access) option.

Step 2: Connect the SonarQube Cloud US organization to your IDE

Follow the procedure described in Connected mode setup, by adding the following step:

• When you create the SonarQube Cloud connection in your IDE, select the US - sonarqube.us option as illustrated below (the EU option is selected by default).

Step 3: Bind your project and share the binding

Follow the procedure described on the Connected mode setup article.

Step 4: Teammates can now bind the project more easily using shared configuration

Follow the procedure described in the Connected mode setup article.

Step 1: Enable the US region option in your IDE

1. In Visual Studio, go to Extensions > SonarQube for Visual Studio > Options… > SonarQube for Visual Studio > General > SonarQube Cloud settings.

2. Select the Show region selection for SonarQube Cloud (Early Access) option.

Step 2: Connect the SonarQube Cloud US organization to your IDE

Follow the procedure described in Connected mode setup, by adding the following step:

• When you create the SonarQube Cloud connection in your IDE, select the US - sonarqube.us option as illustrated below (the EU option is selected by default).

Step 3: Bind your project and share the binding

Follow the procedure described on the Connected mode setup article.

Step 4: Teammates can now bind the project more easily using shared configuration

Follow the procedure described in the Connected mode setup article.

Step 1: Enable the US region option in your IDE

1. In Eclipse, go to Window > Preferences > SonarQube (or Eclipse > Settings… > SonarQube for Mac OS).

2. Select the Show region selection for SonarQube Cloud (Early Access) option.

Step 2: Connect the SonarQube Cloud US organization to your IDE

Follow the procedure described in Connected mode setup, by adding the following step:

• When you create the SonarQube Cloud connection in your IDE, select the US - sonarqube.us option as illustrated below (the EU option is selected by default).

Step 3: Bind your project and share the binding

Follow the procedure described on the Connected mode setup article.

Step 4: Teammates can now bind the project more easily using shared configuration

Follow the procedure described in Connected mode setup.

Using the Web API

The Web API for the US region can be accessed through this base URL:

• V2: http://api.sonarqube.us/

• V1: http://sonarqube.us/api Note that the Web API V2 will gradually replace the Web API V1 as endpoints get deprecated and replaced.

To access the API documentation, go to https://sonarcloud.io/web_api or select the help button from the top bar in SonarQube Cloud.

Managing your IP whitelist

The SonarQube Cloud US instance currently allows the following static IP addresses for outgoing calls to supported DevOps platforms:

• 54.156.164.222

• 52.5.238.69

• 52.7.26.20

• 44.221.182.231

• 52.1.126.206

• 34.233.177.123

IP filtering is not supported for any other use case.

Managing your domain whitelist

If you can’t access SonarQube Cloud on your network and your pipeline is hosted within an organization that is secured with a firewall or proxy server, you must add certain IP addresses and domain URLs to the allowlist. To update this, you need to add an outbound rule to your firewall.

Ensure the following domain URLs are allowed for SonarQube Cloud US instance:

• sonarqube.us & *.sonarqube.us , which would cover notifications.sonarqube.us used for web sockets

• analysis-sensorcache-us-east-1-produs1.s3.us-east-1.amazonaws.com

• app.getbeamer.com for the latest news on SonarQube Cloud

• sonarsource.com (if logged out, users are redirected here)

• docs.sonarsource.com to view the product documentation. In addition, *.sonarsource.com would provide access to additional content sometimes referenced in the docs.