Create SonarQube plugin configurations

2 minute readExtensibilityDeveloper productivity

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

  1. Navigate to DevOps Essentials  Plugin Management  Plugin configurations.

  2. Select Add plugin configuration to create a new configuration.

  3. In the New Configuration window, specify a Name for the configuration.

  4. Select the Project that the configuration belongs to.

  5. Optionally, add a Description for the configuration.

  6. Select the appropriate Plugin for the configuration.

  7. Configure the plugin configuration parameters.

  8. Select OK.

Depending on your plugin configuration and how you run procedures, the Input parameters  Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

SonarQube plugin configuration parameters

Table 1. EC-SonarQube plugin configuration parameters
Parameter Description

Server configuration

Required. The EC-SonarQube configuration name.

Description

The description for the plugin configuration.

Protocol

Required. Specifies whether to prepend the hostname with https:// or http://.

Host

Required. The host name of the SonarQube server.

URL path of SonarQube

The URL path of SonarQube. For example, /sonar for http://host:9000/sonar. Leave blank if none.

SonarQube server port

Required. The SonarQube server port. For example, 9000.

Ignore SSL errors

Turn SSL verification off for instances with self-signed certificates. Ignore SSL errors works only for REST API calls for the Get Last SonarQube Metrics and CollectReportingData procedures.

Organization key

The organization key that is required to identify the organization associated with your project. For instance, it is required to work with SonarCloud.

Auth type

The authentication type; a username with a password or an access token.

Password

The login or authentication token of a SonarQube user with the Execute Analysis permission. This is the password associated with the sonar.login username.

If you use an authentication token, use it in the login field and leave the password blank.

Token

The personal access token.

Debug level

The verbosity level of the output.

HTTP proxy

The proxy that should be used for connections.

Proxy authorization

The username and password for the proxy.

Check connection resource

A resource that is used to check the connection.