Docs: AI Gateway Setup - Unclear instructions for AIGW environment variables
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Problem to solve
The instructions to set AIGW_GITLAB_URL and AIGW_GITLAB_API_URL here are unclear. Imho, it is unnecessary to suggest to placeholders (<your_gitlab_instance> and <your_gitlab_domain>) in the documentation as it creates a lot of head scratching.
Proposal
Add text that explains <your_gitlab_url> with an example like https://gitlab.my.domain, then change the code block to
docker run -d -p 5052:5052 -p 50052:50052 \
-e AIGW_GITLAB_URL=<your_gitlab_url> \
-e AIGW_GITLAB_API_URL=<your_gitlab_url>/api/v4/ \
-e DUO_WORKFLOW_SELF_SIGNED_JWT__SIGNING_KEY="$(cat duo_workflow_jwt.key)" \
registry.gitlab.com/gitlab-org/modelops/applied-ml/code-suggestions/ai-assist/model-gateway:<ai-gateway-tag>
The same concept should be applied to other installation options.
It changes the situation in which one variable is a substring of the other and caters to the fact that some might not be using https which is currently a hardcoded piece in the docs.
Edited by 🤖 GitLab Bot 🤖