Skip to content

Commit f3c7ada

Browse files
committed
add chart_values input section in SonarQube README
1 parent e66c69e commit f3c7ada

1 file changed

Lines changed: 69 additions & 0 deletions

File tree

platform/modules/sonarqube/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,73 @@
2828
| <a name="input_chart_version"></a> [chart\_version](#input\_chart\_version) | Version of chart to install | `string` | `null` | no |
2929
| <a name="input_k8s_namespace"></a> [k8s\_namespace](#input\_k8s\_namespace) | Kubernetes namespace in which resources will be written | `string` | `"default"` | no |
3030
| <a name="input_name"></a> [name](#input\_name) | Name for the release | `string` | `"sonarqube"` | no |
31+
32+
## chart_values Input
33+
34+
The list of Helm values that can be configured via `chart_values` input. For default values, refer to [Artifact Hub](https://artifacthub.io/packages/helm/sonarqube/sonarqube?modal=values).
35+
36+
| Parameter | Description | Default |
37+
|-----------|-------------|---------|
38+
| `deploymentType` | Deployment type (Deployment or StatefulSet) | `"Deployment"` |
39+
| `replicaCount` | Number of SonarQube replicas | `1` |
40+
| `revisionHistoryLimit` | How many revisions to retain | `10` |
41+
| `deploymentStrategy` | Deployment strategy type | `Recreate` |
42+
| `community.enabled` | Enable Community Edition | `true` |
43+
| `community.buildNumber` | Community Edition build number | `"25.12.0.117093"` |
44+
| `image.repository` | Image repository | `"sonarqube"` |
45+
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
46+
| `securityContext.fsGroup` | Pod security context fsGroup | `1000` |
47+
| `containerSecurityContext` | Container security context | (see values.yaml) |
48+
| `elasticsearch.configureNode` | Configure Elasticsearch node | `false` |
49+
| `elasticsearch.bootstrapChecks` | Enable Elasticsearch bootstrap checks | `true` |
50+
| `service.type` | Kubernetes Service type | `"ClusterIP"` |
51+
| `service.externalPort` | Service external port | `9000` |
52+
| `service.internalPort` | Service internal port | `9000` |
53+
| `httpProxySecret` | Secret containing http proxy config | `""` |
54+
| `httpProxy` | HTTP proxy URL | `""` |
55+
| `networkPolicy.enabled` | Enable NetworkPolicy creation | `false` |
56+
| `sonarWebContext` | Context path for SonarQube web | `""` |
57+
| `ingress-nginx.enabled` | Enable ingress-nginx chart | `false` |
58+
| `httproute.enabled` | Enable Gateway API HTTPRoute | `false` |
59+
| `ingress.enabled` | Enable Ingress creation | `false` |
60+
| `ingress.hosts` | Ingress hosts configuration | `[]` |
61+
| `ingress.tls` | Ingress TLS configuration | `[]` |
62+
| `affinity` | Pod affinity rules | `{}` |
63+
| `tolerations` | Pod tolerations | `[]` |
64+
| `nodeSelector` | Pod node selector | `{}` |
65+
| `readinessProbe` | Readiness probe configuration | (see values.yaml) |
66+
| `livenessProbe` | Liveness probe configuration | (see values.yaml) |
67+
| `startupProbe` | Startup probe configuration | (see values.yaml) |
68+
| `initContainers` | Init containers configuration | (see values.yaml) |
69+
| `extraInitContainers` | Extra init containers | `{}` |
70+
| `extraContainers` | Extra main containers | `[]` |
71+
| `extraVolumes` | Extra volumes for the Pod | `[]` |
72+
| `extraVolumeMounts` | Extra volume mounts for containers | `[]` |
73+
| `caCerts.enabled` | Enable custom CA certs | `false` |
74+
| `initSysctl.enabled` | Enable Sysctl init container | `false` |
75+
| `initFs.enabled` | Enable InitFs init container | `false` |
76+
| `prometheusExporter.enabled` | Enable Prometheus JMX Exporter | `false` |
77+
| `prometheusMonitoring.podMonitor.enabled` | Enable Prometheus Operator PodMonitor | `false` |
78+
| `plugins.install` | List of plugins to install | `[]` |
79+
| `jvmOpts` | Additional JVM options | `""` |
80+
| `monitoringPasscode` | Passcode for liveness/readiness probes | `""` |
81+
| `env` | Environment variables | `[]` |
82+
| `annotations` | Pod annotations | `{}` |
83+
| `resources` | Pod resource requests/limits | (see values.yaml) |
84+
| `persistence.enabled` | Enable persistence | `false` |
85+
| `persistence.storageClass` | Storage class for PVC | `null` |
86+
| `persistence.accessMode` | PVC access mode | `ReadWriteOnce` |
87+
| `persistence.size` | PVC size | `5Gi` |
88+
| `emptyDir` | Config for emptyDir if persistence disabled | `{}` |
89+
| `jdbcOverwrite.enabled` | Enable external JDBC configuration | `true` |
90+
| `jdbcOverwrite.jdbcUrl` | JDBC URL for external database | `""` |
91+
| `jdbcOverwrite.jdbcUsername` | JDBC username | `""` |
92+
| `jdbcOverwrite.jdbcSecretName` | Secret name containing DB password | `""` |
93+
| `postgresql.enabled` | Enable embedded PostgreSQL | `false` |
94+
| `podLabels` | Additional labels for pods | `{}` |
95+
| `tests.enabled` | Enable test hook | `true` |
96+
| `serviceAccount.create` | Create Service Account | `false` |
97+
| `serviceAccount.name` | Service Account name | `""` |
98+
| `extraConfig` | Extra secrets/configmaps to mount | `{}` |
99+
| `terminationGracePeriodSeconds` | Pod termination grace period | `60` |
31100
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)