Skip to content
This repository has been archived by the owner on Feb 22, 2022. It is now read-only.

Commit

Permalink
update docs for installing custom plugins
Browse files Browse the repository at this point in the history 
Signed-off-by: Melissa Palmer <[email protected]>
  • Loading branch information
@melissapalmer
melissapalmer committed Jan 9, 2019
1 parent 76f08fe commit fa15c6f
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 42 deletions.
84 changes: 42 additions & 42 deletions stable/sonarqube/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,48 +37,48 @@ $ helm delete kindly-newt

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. | 6.5 |
| `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 |
| `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.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 |
| `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 | `{}` |
| Parameter | Description | Default |
| ----------------------------------- | ------------------------------------------------------------ | ---------------------------------------------- |
| `image.repository` | image repository | `sonarqube` |
| `image.tag` | `sonarqube` image tag. | 6.5 |
| `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 |
| `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.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 |
| `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. <br />**NOTE**: if you have set this, starting from chart version 0.12.0 you will need to uncomment the command in values file. | `[]` |
| `plugins.resources` | Plugin Pod resource requests & limits | `{}` |

You can also configure values for the PostgreSQL / MySQL database via the Postgresql [README.md](https://github.com/kubernetes/charts/blob/master/stable/postgresql/README.md) / MySQL [README.md](https://github.com/kubernetes/charts/blob/master/stable/mysql/README.md)

Expand Down
4 changes: 4 additions & 0 deletions stable/sonarqube/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ image:
# "
# ]

# Starting from chart 0.12.0 if you want to install custom plugins ie: plugins.install is set, you need to , uncomment the following lines.
# command:
# - /usr/local/copy_plugins.sh

# Set security context for sonarqube pod
securityContext:
fsGroup: 999
Expand Down

0 comments on commit fa15c6f

Please sign in to comment.