Skip to content

Commit 2fea9df

Browse files
committed
Add example KAS configuration to README.md
1 parent 2c38008 commit 2fea9df

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

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

924924
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.
925925

926+
Here is an example settings for kubernetes rc.yml:
927+
928+
```yaml
929+
spec:
930+
containers:
931+
- name: gitlab
932+
image: sameersbn/gitlab:latest
933+
env:
934+
- name: GITLAB_KAS_ENABLED
935+
value: "true"
936+
- name: GITLAB_AGENT_BUILTIN_KAS_ENABLED
937+
value: "true"
938+
- name: GITLAB_KAS_EXTERNAL
939+
value: wss://gitlab.example.com/gitlab/-/kubernetes-agent/
940+
- name: GITLAB_KAS_INTERNAL
941+
value: grpc://127.0.0.1:8153
942+
- name: GITLAB_KAS_PROXY
943+
value: https://gitlab.example.com/gitlab/-/kubernetes-agent/k8s-proxy/
944+
- name: OWN_PRIVATE_API_URL
945+
value: grpc://127.0.0.1:8155
946+
```
947+
948+
and for docker-compose.yml:
949+
950+
```yaml
951+
services:
952+
gitlab:
953+
image: sameersbn/gitlab:latest
954+
environment:
955+
- GITLAB_KAS_ENABLED=true
956+
- GITLAB_AGENT_BUILTIN_KAS_ENABLED=true
957+
- GITLAB_KAS_EXTERNAL=wss://gitlab.example.com/gitlab/-/kubernetes-agent/
958+
- GITLAB_KAS_INTERNAL=grpc://127.0.0.1:8153
959+
- GITLAB_KAS_PROXY=https://gitlab.example.com/gitlab/-/kubernetes-agent/k8s-proxy/
960+
- OWN_PRIVATE_API_URL=grpc://127.0.0.1:8155
961+
```
962+
963+
or in another style:
964+
965+
```yaml
966+
services:
967+
gitlab:
968+
image: sameersbn/gitlab:latest
969+
environment:
970+
GITLAB_KAS_ENABLED: "true"
971+
GITLAB_AGENT_BUILTIN_KAS_ENABLED: "true"
972+
GITLAB_KAS_EXTERNAL: wss://gitlab.example.com/gitlab/-/kubernetes-agent/
973+
GITLAB_KAS_INTERNAL: grpc://127.0.0.1:8153
974+
GITLAB_KAS_PROXY: https://gitlab.example.com/gitlab/-/kubernetes-agent/k8s-proxy/
975+
OWN_PRIVATE_API_URL: grpc://127.0.0.1:8155
976+
```
977+
926978
#### Built-in GitLab-Agent KAS
927979
928980
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)