📚 Sync docs from alaudadevops/gitlab-ce-operator on 1cc1cd7e0652bbc2d747ec87cb216dff86d3675d

Source: docs(upgrade): add shared memory volume mount configuration to the all-in-one pod (#261) (#264)
Author: nanjingfm
Ref: refs/heads/release-17.8
Commit: 1cc1cd7e0652bbc2d747ec87cb216dff86d3675d

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

🔗 View source commit: AlaudaDevops/gitlab-ce-operator@1cc1cd7
🤖 Synced on 2025-11-04 06:29:18 UTC

Author: nanjingfm

.github/SYNC_INFO.md

@@ -1,10 +1,10 @@
 # Documentation Sync Information
 
-- **Last synced**: 2025-09-23 09:29:47 UTC
+- **Last synced**: 2025-11-04 06:29:18 UTC
 - **Source repository**: alaudadevops/gitlab-ce-operator
-- **Source commit**: [500f9eeed1e62c633244eecc847b7f088b2a72a0](https://github.com/alaudadevops/gitlab-ce-operator/commit/500f9eeed1e62c633244eecc847b7f088b2a72a0)
+- **Source commit**: [1cc1cd7e0652bbc2d747ec87cb216dff86d3675d](https://github.com/alaudadevops/gitlab-ce-operator/commit/1cc1cd7e0652bbc2d747ec87cb216dff86d3675d)
 - **Triggered by**: nanjingfm
-- **Workflow run**: [#33](https://github.com/alaudadevops/gitlab-ce-operator/actions/runs/17941644092)
+- **Workflow run**: [#49](https://github.com/alaudadevops/gitlab-ce-operator/actions/runs/19059914912)
 
 ## Files synced:
 - docs/

docs/en/install/03_gitlab_deploy.mdx

@@ -610,18 +610,27 @@ Create the following Oauth2Client resource in the global cluster to register the
 apiVersion: dex.coreos.com/v1
 kind: OAuth2Client
 name: OIDC
+id: gitlab-dex # Client ID
+secret: Z2l0bGFiLW9mZmljaWFsLTAK # Client secret
+redirectURIs:
+  - <gitlab-host>/users/auth/dex/callback # GitLab authentication callback address, where <gitlab-host> is replaced with the GitLab instance access address
 metadata:
   name: m5uxi3dbmiwwizlyzpzjzzeeeirsk # This value is calculated based on the hash of the id field, online calculator: https://go.dev/play/p/QsoqUohsKok
   namespace: cpaas-system
 alignPasswordDB: true
-id: gitlab-dex # Client ID
 public: false
-redirectURIs:
-  - <gitlab-host>/users/auth/dex/callback # GitLab authentication callback address, where <gitlab-host> is replaced with the GitLab instance access address
-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.| gitlab-dex |
+|secret| The client secret used for SSO authentication. Can be set to any value. | Z2l0bGFiLW9mZmljaWFsLTAK|
+|redirectURIs | GitLab authentication callback URL, formatted as `<gitlab-host>/users/auth/dex/callback`. | https://example.gitlab.com/users/auth/dex/callback|
+|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. | m5uxi3dbmiwwizlyzpzjzzeeeirsk |
+|metadata.namespace| The platform system namespace, Must be `cpaas-system`. | cpaas-system|
+
 Prepare the configuration content according to the comments in the JSON below.
 
 ```yaml
@@ -684,10 +693,14 @@ If the platform is accessed via HTTPS and uses a self-signed certificate, you ne
 
 In the `cpaas-system` namespace of the global cluster, find the secret named `dex.tls`, get the `ca.crt` content from the secret, save it as a new secret, and create it in the namespace of the GitLab instance.
 
+:::warning Certificate Format
+The certificate must be in PEM format.
+:::
+
 ```yaml
 apiVersion: v1
 data:
-  ca.crt: <base64 encode data>
+  ca.crt: <base64-encode a PEM-formatted certificate>
 kind: Secret
 metadata:
   name: dex-tls

docs/en/upgrade/02_14_upgrade_to_17.md

@@ -488,6 +488,8 @@ For the latest GitLab instance and operator versions, please refer to the [Relea
               terminationMessagePath: /dev/termination-log
               terminationMessagePolicy: File
               volumeMounts:
+                - mountPath: /dev/shm
+                  name: dshm
                 - mountPath: /var/opt/gitlab/backups
                   name: backup
                   subPath: backups
@@ -506,6 +508,10 @@ For the latest GitLab instance and operator versions, please refer to the [Relea
           securityContext: {}
           terminationGracePeriodSeconds: 30
           volumes:
+            - name: dshm
+              emptyDir:
+                medium: Memory
+                sizeLimit: 512Mi
             - name: backup
               persistentVolumeClaim:
                 claimName: backup-pvc
@@ -739,7 +745,7 @@ The namespace of the new gitlab instance must be the same as the namespace of th
 
 2. Enable the toolbox component for the new GitLab instance.
 
-    ```yaml
+    ```bash
     kubectl patch gitlabofficial.operator.alaudadevops.io ${NEW_GITLAB_NAME} -n $GITLAB_NAMESPACE --type='merge' -p='
     {
       "spec": {
@@ -855,7 +861,7 @@ The namespace of the new gitlab instance must be the same as the namespace of th
     kubectl patch deploy ${NEW_GITLAB_NAME}-sidekiq-all-in-1-v2 -n $GITLAB_NAMESPACE --type='json' -p='[{"op":"remove","path":"/metadata/annotations/skip-sync"}]'
     kubectl patch deploy ${NEW_GITLAB_NAME}-toolbox -n $GITLAB_NAMESPACE --type='json' -p='[{"op":"remove","path":"/metadata/annotations/skip-sync"}]'
 
-    kubectl delete pod -lrelease=fm-test-gitlab -n $GITLAB_NAMESPACE
+    kubectl delete pod -lrelease=${NEW_GITLAB_NAME} -n $GITLAB_NAMESPACE
     kubectl scale deploy ${NEW_GITLAB_NAME}-webservice-default -n $GITLAB_NAMESPACE --replicas 1
     kubectl scale deploy ${NEW_GITLAB_NAME}-sidekiq-all-in-1-v2 -n $GITLAB_NAMESPACE --replicas 1
     ```