Deploying SonarQube on Kubernetes
This part of the Documentation is only valid for Community, Developer, and Enterprise Editions. For information on deploying the Data Center Edition of SonarQube on Kubernetes, see this documentation.
You can find the SonarQube Helm chart on GitHub.
Your feedback is welcome at our community forum.
When you want to operate SonarQube on Kubernetes, consider the following recommendations.
The SonarQube helm chart should only be used with the latest version of SonarQube and a supported version of Kubernetes. There is a dedicated helm chart for the LTS version of SonarQube that follows the same patch policy as the application, while also being compatible with the supported versions of Kubernetes.
Here is the list of containers that are compatible with the Pod Security levels:
- SQ application containers
- SQ init containers.
- postgresql containers.
This is achieved by setting this
SecurityContext as default on most containers:
Based on that, one can run the SQ helm chart in a full restricted namespace, by deactivating the
initFs.enabled parameters, which require root access.
For more information, see the production-use-case or take a look at the
Currently, only Helm 3 is supported.
To install the Helm Chart from our Helm Repository, you can use the following commands:
SonarQube comes with a bundled Elasticsearch and, as Elasticsearch is stateful, so is SonarQube. There is an option to persist the Elasticsearch indexes in a Persistent Volume, but with regular killing operations by the Kubernetes Cluster, these indexes can be corrupted. By default, persistency is disabled in the Helm chart.
Enabling persistency decreases the startup time of the SonarQube Pod significantly, but you are risking corrupting your Elasticsearch index. You can enable persistency by adding the following to the
Leaving persistency disabled results in a longer startup time until SonarQube is fully available, but you won't lose any data as SonarQube will persist all data in the database.
When you're working with your own CA or in an environment that uses self-signed certificates for your code repository platform, you can create a secret containing this certificate and add this certificate to the Java truststore inside the SonarQube deployment directly during the deployment.
To enable this behavior, add the following to your
If you already have a running installation of your code repository platform, you can extract the certificate with the following snippet using
This certificate needs to be Base64 encoded in order to be added as secret data.
Note that you can also use
string-data here if you don't want to encode your certificate.
The Base64 encoded certificate can be added to the secret's data:
Then, create the secret in your Kubernetes cluster with the following command:
To make the SonarQube service accessible from outside of your cluster, you most likely need an ingress. Creating a new ingress is also covered by the Helm chart. See the following section for help with creating one.
The SonarSource Helm chart has an optional dependency on the NGINX-ingress helm chart. If you already have NGINX-ingress present in your cluster, you can use it.
If you want to install NGINX as well, add the following to your
We recommend using the ingress-class NGINX with a body size of at least 64MB. This can be achieved with the following changes to your values.yaml:
You can customize the Helm chart values with various methods. One example is directly at the command line:
While we only document the most pressing Helm chart customizations in this documentation, there are other possibilities for you to choose to customize the chart before installing. Please see the Helm chart README file for more information on these.
As SonarQube is intended to be run anywhere, there are some drawbacks that are currently known when operating in Kubernetes. This list is not comprehensive, but something to keep in mind and points for us to improve on.
When persistence is disabled, SonarQube startup takes significantly longer as the Elasticsearch indexes need to be rebuilt. As this delay depends on the amount of data in your SonarQube instance, the values for the startup/readiness and liveness probes need to be adjusted to your environment. We also recommend taking a look at the default limits for the SonarQube deployment as the amount of CPU available to SonarQube also impacts the startup time.
Currently, there is a known limitation when working on AKS that resonates around the use of Azure Fileshare. We recommend using another storage class for persistency on AKS.