Skip to content

Commit 4a53bc8

Browse files
committed
Add example KAS configuration to README.md
1 parent 23a43fa commit 4a53bc8

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -942,6 +942,58 @@ You can specify user-facing URL by setting [`GITLAB_KAS_EXTERNAL`](#gitlab_kas_e
942942

943943
You can specify custom secret file by setting [`GITLAB_KAS_SECRET`](#gitlab_kas_secret). This secret file will be generated if they don't exist.
944944

945+
Here is an example settings for kubernetes rc.yml:
946+
947+
```yaml
948+
spec:
949+
containers:
950+
- name: gitlab
951+
image: sameersbn/gitlab:latest
952+
env:
953+
- name: GITLAB_KAS_ENABLED
954+
value: "true"
955+
- name: GITLAB_AGENT_BUILTIN_KAS_ENABLED
956+
value: "true"
957+
- name: GITLAB_KAS_EXTERNAL
958+
value: wss://gitlab.example.com/gitlab/-/kubernetes-agent/
959+
- name: GITLAB_KAS_INTERNAL
960+
value: grpc://127.0.0.1:8153
961+
- name: GITLAB_KAS_PROXY
962+
value: https://gitlab.example.com/gitlab/-/kubernetes-agent/k8s-proxy/
963+
- name: OWN_PRIVATE_API_URL
964+
value: grpc://127.0.0.1:8155
965+
```
966+
967+
and for docker-compose.yml:
968+
969+
```yaml
970+
services:
971+
gitlab:
972+
image: sameersbn/gitlab:latest
973+
environment:
974+
- GITLAB_KAS_ENABLED=true
975+
- GITLAB_AGENT_BUILTIN_KAS_ENABLED=true
976+
- GITLAB_KAS_EXTERNAL=wss://gitlab.example.com/gitlab/-/kubernetes-agent/
977+
- GITLAB_KAS_INTERNAL=grpc://127.0.0.1:8153
978+
- GITLAB_KAS_PROXY=https://gitlab.example.com/gitlab/-/kubernetes-agent/k8s-proxy/
979+
- OWN_PRIVATE_API_URL=grpc://127.0.0.1:8155
980+
```
981+
982+
or in another style:
983+
984+
```yaml
985+
services:
986+
gitlab:
987+
image: sameersbn/gitlab:latest
988+
environment:
989+
GITLAB_KAS_ENABLED: "true"
990+
GITLAB_AGENT_BUILTIN_KAS_ENABLED: "true"
991+
GITLAB_KAS_EXTERNAL: wss://gitlab.example.com/gitlab/-/kubernetes-agent/
992+
GITLAB_KAS_INTERNAL: grpc://127.0.0.1:8153
993+
GITLAB_KAS_PROXY: https://gitlab.example.com/gitlab/-/kubernetes-agent/k8s-proxy/
994+
OWN_PRIVATE_API_URL: grpc://127.0.0.1:8155
995+
```
996+
945997
#### Built-in GitLab-Agent KAS
946998
947999
To control whether launch built-in `gitlab-kas` on container startup or not, you can use configuration parameter [`GITLAB_AGENT_BUILTIN_KAS_ENABLED`](#gitlab_agent_builtin_kas_enabled).

0 commit comments

Comments
 (0)