📚 Sync docs from alaudadevops/sonarqube-ce-operator on fe5ad3d61075cb92b1623821d4df632a62a8c50b

Source: docs: update SonarQube deployment and upgrade documentation (#122)
Author: kycheng
Ref: refs/heads/release-2025.1
Commit: fe5ad3d61075cb92b1623821d4df632a62a8c50b

This commit automatically syncs documentation changes from the source-docs repository.

🔗 View source commit: https://github.com/alaudadevops/sonarqube-ce-operator/commit/fe5ad3d61075cb92b1623821d4df632a62a8c50b
🤖 Synced on 2025-11-05 10:09:39 UTC

Author: edge-katanomi-app2[bot]

.github/SYNC_INFO.md

@@ -1,10 +1,10 @@
 # Documentation Sync Information
 
-- **Last synced**: 2025-10-16 03:06:21 UTC
+- **Last synced**: 2025-11-05 10:09:39 UTC
 - **Source repository**: alaudadevops/sonarqube-ce-operator
-- **Source commit**: [e688ba7c63ed9258de493969ce591706e522cad1](https://github.com/alaudadevops/sonarqube-ce-operator/commit/e688ba7c63ed9258de493969ce591706e522cad1)
+- **Source commit**: [fe5ad3d61075cb92b1623821d4df632a62a8c50b](https://github.com/alaudadevops/sonarqube-ce-operator/commit/fe5ad3d61075cb92b1623821d4df632a62a8c50b)
 - **Triggered by**: edge-katanomi-app2[bot]
-- **Workflow run**: [#23](https://github.com/alaudadevops/sonarqube-ce-operator/actions/runs/18548996265)
+- **Workflow run**: [#26](https://github.com/alaudadevops/sonarqube-ce-operator/actions/runs/19098442020)
 
 ## Files synced:
 - docs/

docs/en/install/03_sonarqube_deploy.md

@@ -231,7 +231,7 @@ apiVersion: dex.coreos.com/v1
 kind: OAuth2Client
 name: OIDC
 metadata:
-  name: m5uxi3dbmiwwizlyzpzjzzeeeirsk # This value is calculated based on the hash of the id field, online calculator: https://go.dev/play/p/QsoqUohsKok
+  name: onxw4ylsof2wezjnmrsxrs7sttsiiirdeu # This value is calculated based on the hash of the id field, online calculator: https://go.dev/play/p/QsoqUohsKok
   namespace: cpaas-system
 id: sonarqube-dex # Client id
 public: false
@@ -241,6 +241,15 @@ secret: Z2l0bGFiLW9mZmljaWFsLTAK # Client secret
 spec: {}
 ```
 
+| Field | Description | Example |
+|-------|-------------|---------|
+|name| The display name of the resource. | OIDC |
+|id| The client ID for SSO authentication. Any value is allowed, except alauda-dex, which is reserved and may cause conflicts.| sonarqube-dex |
+|secret| The client secret used for SSO authentication. Can be set to any value. | Z2l0bGFiLW9mZmljaWFsLTAK |
+|redirectURIs | Sonarqube authentication callback URL, formatted as `<sonarqube-host>/*`. | https://example.sonarqube.com/* |
+|metadata.name| The resource name, which must be calculated based on the hash of the `id` field. You can use online hash calculators such as https://go.dev/play/p/QsoqUohsKok to generate it. | onxw4ylsof2wezjnmrsxrs7sttsiiirdeu |
+|metadata.namespace| The platform system namespace, Must be `cpaas-system`. | cpaas-system|
+
 Add the SSO configuration to the SonarQube instance:
 
 ```yaml

docs/en/upgrade/05_upgrade_to_2025.1.0.md

@@ -4,13 +4,16 @@
 
 This document describes how to upgrade SonarQube from version 9.9.5.1(9.9.6) to 2025.1.0. Since this upgrade involves changes in operator 4.0 version, existing SonarQube instances need to be migrated to the new version operator.
 
-::::tip Migration Duration
+::: tip Migration Duration
+
 - Larger databases take longer to migrate.
 - Storage performance also affects migration speed — using TopoLVM is recommended for better performance.
 
 Example:
+
 - SonarQube instance: 574 projects; PostgreSQL PVC usage 87 Gi; migration time ~1 hour
-::::
+
+:::
 
 ## Prerequisites
 
@@ -65,12 +68,9 @@ type: Opaque
 ```
 
 1. Perform a complete data backup according to the [backup documentation](../howto/04_sonarqube_backup.md)
-
 2. Create a new PG database for the new SonarQube instance.
-> It is recommended to create a new database for deploying the new SonarQube version to avoid contaminating the old database and ensure the old SonarQube can still function normally
-
+    > It is recommended to create a new database for deploying the new SonarQube version to avoid contaminating the old database and ensure the old SonarQube can still function normally
 3. Migrate the data according to the [backup documentation](../howto/04_sonarqube_backup.md)
-
 4. Create a new database secret. The new version secret only needs to store the password:
 
     ```bash
@@ -99,7 +99,9 @@ type: Opaque
 
 Choose the corresponding configuration based on the storage type used by the old SonarQube instance:
 
-`kubectl get sonarqube.operator.devops.alauda.io <old-sonarqube-name> -n <old-instance-namespace> -o jsonpath='{.spec.persistence.type}'`
+```bash
+kubectl get sonarqube.operator.devops.alauda.io <old-sonarqube-name> -n <old-instance-namespace> -o jsonpath='{.spec.persistence.type}'
+```
 
 **Using StorageClass:**