deprecated-helm-charts/stable/sonarqube

SonarQube

SonarQube is an open sourced code quality scanning tool.

Introduction

This chart bootstraps a SonarQube instance with a PostgreSQL database.

Prerequisites

• Kubernetes 1.6+

Installing the chart

To install the chart:

$ helm install stable/sonarqube

The above command deploys Sonarqube on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

The default login is admin/admin.

Uninstalling the chart

To uninstall/delete the deployment:

$ helm list
NAME       	REVISION	UPDATED                 	STATUS  	CHART          	NAMESPACE
kindly-newt	1       	Mon Oct  2 15:05:44 2017	DEPLOYED	sonarqube-0.1.0	default
$ helm delete kindly-newt

Configuration

The following table lists the configurable parameters of the Sonarqube chart and their default values.

Parameter	Description	Default
image.repository	image repository	sonarqube
image.tag	sonarqube image tag.	7.7-community
image.pullPolicy	Image pull policy	IfNotPresent
image.pullSecret	imagePullSecret to use for private repository
command	command to run in the container	nil (need to be set prior to 6.7.6, and 7.4)
securityContext.fsGroup	Group applied to mounted directories/files	999
ingress.enabled	Flag for enabling ingress	false
ingress.labels	Ingress additional labels	{}
ingress.hosts[0].name	Hostname to your SonarQube installation	sonar.organization.com
ingress.hosts[0].path	Path within the URL structure	/
livenessProbe.sonarWebContext	SonarQube web context for livenessProbe	/
readinessProbe.sonarWebContext	SonarQube web context for readinessProbe	/
service.type	Kubernetes service type	LoadBalancer
service.labels	Kubernetes service labels	None
service.annotations	Kubernetes service annotations	None
service.loadBalancerSourceRanges	Kubernetes service LB Allowed inbound IP addresses	0.0.0.0/0
service.loadBalancerIP	Kubernetes service LB Optional fixed external IP	None
persistence.enabled	Flag for enabling persistent storage	false
persistence.existingClaim	Do not create a new PVC but use this one	None
persistence.storageClass	Storage class to be used	"-"
persistence.accessMode	Volumes access mode to be set	ReadWriteOnce
persistence.size	Size of the volume	None
sonarProperties	Custom sonar.properties file	None
customCerts.enabled	Use customCerts.secretName	false
customCerts.secretName	Name of the secret which conatins your cacerts	false
sonarSecretKey	Name of existing secret used for settings encryption	None
database.type	Set to "mysql" to use mysql database	postgresql
postgresql.enabled	Set to false to use external server / mysql database	true
postgresql.postgresServer	Hostname of the external Postgresql server	null
postgresql.postgresPasswordSecret	Secret containing the password of the external Postgresql server	null
postgresql.postgresUser	Postgresql database user	sonarUser
postgresql.postgresPassword	Postgresql database password	sonarPass
postgresql.postgresDatabase	Postgresql database name	sonarDB
postgresql.service.port	Postgresql port	5432
mysql.enabled	Set to false to use external server / postgresql database	false
mysql.mysqlServer	Hostname of the external Mysql server	null
mysql.mysqlPasswordSecret	Secret containing the password of the external Mysql server	null
mysql.mysqlUser	Mysql database user	sonarUser
mysql.mysqlPassword	Mysql database password	sonarPass
mysql.mysqlDatabase	Mysql database name	sonarDB
mysql.mysqlParams	Mysql parameters for JDBC connection string	{}
mysql.service.port	Mysql port	3306
resources	Sonarqube Pod resource requests & limits	{}
affinity	Node / Pod affinities	{}
nodeSelector	Node labels for pod assignment	{}
hostAliases	Aliases for IPs in /etc/hosts	[]
tolerations	List of node taints to tolerate	[]
plugins.install	List of plugins to install	[]
plugins.resources	Plugin Pod resource requests & limits	{}
plugins.initContainerImage	Change init container image	[]
plugins.deleteDefaultPlugins	Remove default plugins and use plugins.install list	[]
podLabels	Map of labels to add to the pods	{}

You can also configure values for the PostgreSQL / MySQL database via the Postgresql README.md / MySQL README.md

For overriding variables see: Customizing the chart

Use custom cacerts

In environments with air-gapped setup, especially with internal tooling (repos) and self-signed certificates it is required to provide an adequate cacerts which overrides the default one:

1. Create a yaml file cacerts.yaml with a secret that contanins the cacerts

   apiVersion: v1
   kind: Secret
   metadata:
     name: my-cacerts
   data:
     cacerts: |
       xxxxxxxxxxxxxxxxxxxxxxx
   

2. Upload your cacerts.yaml to a secret with the key you specify in secretName in the cluster you are installing Sonarqube to.

   $ kubectl apply -f cacerts.yaml
   

3. Set the following values of the chart:

   customCerts:
      ## Enable to override the default cacerts with your own one
      enabled: false
      secretName: my-cacerts