Skip to content

Commit 01dbd9d

Browse files
committed
📚 Sync docs from alaudadevops/gitlab-ce-operator on 31bc01dcba1d99f06da68d23e9e3fd6ed9b8f18e
Source: docs(upgrade): add shared memory volume mount configuration to the all-in-one pod (#261) Author: nanjingfm Ref: refs/heads/release-18.2 Commit: 31bc01dcba1d99f06da68d23e9e3fd6ed9b8f18e This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: AlaudaDevops/gitlab-ce-operator@31bc01d 🤖 Synced on 2025-11-04 05:51:42 UTC
1 parent ee5744c commit 01dbd9d

File tree

3 files changed

+29
-10
lines changed

3 files changed

+29
-10
lines changed

‎.github/SYNC_INFO.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Documentation Sync Information
22

3-
- **Last synced**: 2025-10-29 10:12:05 UTC
3+
- **Last synced**: 2025-11-04 05:51:42 UTC
44
- **Source repository**: alaudadevops/gitlab-ce-operator
5-
- **Source commit**: [33fb3a429998f2405cd0acc0a8bc42281a2ff1a9](https://github.com/alaudadevops/gitlab-ce-operator/commit/33fb3a429998f2405cd0acc0a8bc42281a2ff1a9)
5+
- **Source commit**: [31bc01dcba1d99f06da68d23e9e3fd6ed9b8f18e](https://github.com/alaudadevops/gitlab-ce-operator/commit/31bc01dcba1d99f06da68d23e9e3fd6ed9b8f18e)
66
- **Triggered by**: nanjingfm
7-
- **Workflow run**: [#45](https://github.com/alaudadevops/gitlab-ce-operator/actions/runs/18904327858)
7+
- **Workflow run**: [#46](https://github.com/alaudadevops/gitlab-ce-operator/actions/runs/19059216700)
88

99
## Files synced:
1010
- docs/

‎docs/en/install/03_gitlab_deploy.mdx‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -610,18 +610,27 @@ Create the following Oauth2Client resource in the global cluster to register the
610610
apiVersion: dex.coreos.com/v1
611611
kind: OAuth2Client
612612
name: OIDC
613+
id: gitlab-dex # Client ID
614+
secret: Z2l0bGFiLW9mZmljaWFsLTAK # Client secret
615+
redirectURIs:
616+
- <gitlab-host>/users/auth/dex/callback # GitLab authentication callback address, where <gitlab-host> is replaced with the GitLab instance access address
613617
metadata:
614618
name: m5uxi3dbmiwwizlyzpzjzzeeeirsk # This value is calculated based on the hash of the id field, online calculator: https://go.dev/play/p/QsoqUohsKok
615619
namespace: cpaas-system
616620
alignPasswordDB: true
617-
id: gitlab-dex # Client ID
618621
public: false
619-
redirectURIs:
620-
- <gitlab-host>/users/auth/dex/callback # GitLab authentication callback address, where <gitlab-host> is replaced with the GitLab instance access address
621-
secret: Z2l0bGFiLW9mZmljaWFsLTAK # Client secret
622622
spec: {}
623623
```
624624

625+
| Field | Description | Example |
626+
|-------|-------------|---------|
627+
|name| The display name of the resource. | OIDC|
628+
|id| The client ID for SSO authentication. Any value is allowed, except alauda-dex, which is reserved and may cause conflicts.| gitlab-dex |
629+
|secret| The client secret used for SSO authentication. Can be set to any value. | Z2l0bGFiLW9mZmljaWFsLTAK|
630+
|redirectURIs | GitLab authentication callback URL, formatted as `<gitlab-host>/users/auth/dex/callback`. | https://example.gitlab.com/users/auth/dex/callback|
631+
|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 |
632+
|metadata.namespace| The platform system namespace, Must be `cpaas-system`. | cpaas-system|
633+
625634
Prepare the configuration content according to the comments in the JSON below.
626635

627636
```yaml
@@ -684,10 +693,14 @@ If the platform is accessed via HTTPS and uses a self-signed certificate, you ne
684693

685694
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.
686695

696+
:::warning Certificate Format
697+
The certificate must be in PEM format.
698+
:::
699+
687700
```yaml
688701
apiVersion: v1
689702
data:
690-
ca.crt: <base64 encode data>
703+
ca.crt: <base64-encode a PEM-formatted certificate>
691704
kind: Secret
692705
metadata:
693706
name: dex-tls

‎docs/en/upgrade/02_14_upgrade_to_17.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,8 @@ Test setup:
511511
terminationMessagePath: /dev/termination-log
512512
terminationMessagePolicy: File
513513
volumeMounts:
514+
- mountPath: /dev/shm
515+
name: dshm
514516
- mountPath: /var/opt/gitlab/backups
515517
name: backup
516518
subPath: backups
@@ -529,6 +531,10 @@ Test setup:
529531
securityContext: {}
530532
terminationGracePeriodSeconds: 30
531533
volumes:
534+
- name: dshm
535+
emptyDir:
536+
medium: Memory
537+
sizeLimit: 512Mi
532538
- name: backup
533539
persistentVolumeClaim:
534540
claimName: backup-pvc
@@ -778,7 +784,7 @@ The namespace of the new gitlab instance must be the same as the namespace of th
778784
779785
2. Enable the toolbox component for the new GitLab instance.
780786
781-
```yaml
787+
```bash
782788
kubectl patch gitlabofficial.operator.alaudadevops.io ${NEW_GITLAB_NAME} -n $GITLAB_NAMESPACE --type='merge' -p='
783789
{
784790
"spec": {
@@ -894,7 +900,7 @@ The namespace of the new gitlab instance must be the same as the namespace of th
894900
kubectl patch deploy ${NEW_GITLAB_NAME}-sidekiq-all-in-1-v2 -n $GITLAB_NAMESPACE --type='json' -p='[{"op":"remove","path":"/metadata/annotations/skip-sync"}]'
895901
kubectl patch deploy ${NEW_GITLAB_NAME}-toolbox -n $GITLAB_NAMESPACE --type='json' -p='[{"op":"remove","path":"/metadata/annotations/skip-sync"}]'
896902
897-
kubectl delete pod -lrelease=fm-test-gitlab -n $GITLAB_NAMESPACE
903+
kubectl delete pod -lrelease=${NEW_GITLAB_NAME} -n $GITLAB_NAMESPACE
898904
kubectl scale deploy ${NEW_GITLAB_NAME}-webservice-default -n $GITLAB_NAMESPACE --replicas 1
899905
kubectl scale deploy ${NEW_GITLAB_NAME}-sidekiq-all-in-1-v2 -n $GITLAB_NAMESPACE --replicas 1
900906
```

0 commit comments

Comments
 (0)