Skip to content

Commit 5be9196

Browse files
ThomasSansonbene2k1nerda-codesldecarvalho-doc
authored andcommitted
docs(gitlabrunner): add GitLab registration details ext-fix-gitlabrunner (scaleway#3960)
* fix(gitlabrunner): add details for GitLab Runner registration * Apply suggestions from code review Co-authored-by: nerda-codes <[email protected]> * Update tutorials/easydeploy-gitlab-runner/index.mdx Co-authored-by: ldecarvalho-doc <[email protected]> * Update tutorials/easydeploy-gitlab-runner/index.mdx Co-authored-by: ldecarvalho-doc <[email protected]> --------- Co-authored-by: Benedikt Rollik <[email protected]> Co-authored-by: nerda-codes <[email protected]> Co-authored-by: ldecarvalho-doc <[email protected]>
1 parent 5217dd6 commit 5be9196

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

tutorials/easydeploy-gitlab-runner/index.mdx

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,24 @@ This setup enables you to optimize resource utilization, reduce overhead, and en
3636
If you cannot find GitLab Runner on the first page, use the search bar or navigate through the library using the arrow buttons.
3737
</Message>
3838
7. Optionally, customize the default configuration for GitLab Runner using [Helm Charts](/tutorials/kubernetes-package-management-helm/). If you do not need any customized configuration you can skip this step.
39-
8. Enter a name (e.g. `gitlab-runner`) and a Kubernetes namespace for your application. If no name is entered, GitLab Runner will be installed in the default namespace of the cluster.
40-
9. Click **Deploy Application** to deploy GitLab Runner on your Kubernetes cluster.
41-
10. Verify that the GitLab Runner is successfully installed and running:
39+
8. **Provide the following GitLab details:**
40+
- **GitLab URL (`gitlabUrl`)**: Go to your GitLab project, click **Settings > CI/CD > Runners**, and copy the GitLab Instance URL.
41+
- **Registration Token (`runnerToken`)**: Under the **Specific Runners** section in **Settings > CI/CD > Runners**, copy the registration token for your project. These are necessary to allow GitLab Runner to register correctly with your GitLab project.
42+
```yaml
43+
gitlabUrl: https://your-gitlab.com
44+
runnerToken: "your-token"
45+
rbac:
46+
create: true
47+
```
48+
49+
<Message type="note">
50+
The information above is required to register your GitLab Runner with your GitLab project.
51+
</Message>
52+
9. Enter a name (e.g. `gitlab-runner`) and a Kubernetes namespace for your application. If you do not specify a name, GitLab Runner will be installed in the default namespace of the cluster.
53+
10. Click **Deploy Application** to deploy GitLab Runner on your Kubernetes cluster.
54+
11. Use the following command to verify that the GitLab Runner is installed and running:
4255
```bash
43-
kubectl get pods -n default # replace "default" with the name of the Kubernetes namespace in which you have installed your GitLab Runner.
56+
kubectl get pods -n <namespace> # replace "<namespace>" with the name of the Kubernetes namespace in which you have installed your GitLab Runner.
4457
```
4558
You should see a pod with a name similar to `gitlab-runner-xxxxxx-xxxxx` in the `Running` state.
4659

@@ -120,12 +133,12 @@ Navigate to **CI/CD** > **Pipelines** in your GitLab project to view the status
120133
<Message type="tip">
121134
If the pipeline fails, you can check the logs of the GitLab Runner pod for more information:
122135
```bash
123-
kubectl logs -n default <gitlab-runner-pod-name>
136+
kubectl logs -n <namespace> <gitlab-runner-pod-name>
124137
```
125138
</Message>
126139

127140
# Conclusion
128141

129142
You have successfully set up a GitLab Runner hosted on Kubernetes and configured your GitLab CI/CD pipeline to use it. This setup allows you to leverage the scalability and flexibility of Kubernetes for your CI/CD workflows.
130143

131-
For more detailed information on configuring your GitLab Runner, refer to the [official GitLab documentation](https://docs.gitlab.com/runner/install/kubernetes.html#configuring-gitlab-runner-using-the-helm-chart).
144+
For more detailed information on configuring your GitLab Runner, refer to the [official GitLab documentation](https://docs.gitlab.com/runner/install/kubernetes.html#configuring-gitlab-runner-using-the-helm-chart).

0 commit comments

Comments
 (0)