From f25df5bbb1942ec809e51ab4d9ef49acd55763b9 Mon Sep 17 00:00:00 2001 From: Thomas Sanson Date: Sun, 10 Nov 2024 17:00:52 +0000 Subject: [PATCH 1/4] fix(gitlabrunner): add details for GitLab Runner registration --- tutorials/easydeploy-gitlab-runner/index.mdx | 24 +++++++++++++++----- 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/tutorials/easydeploy-gitlab-runner/index.mdx b/tutorials/easydeploy-gitlab-runner/index.mdx index d4caa1ec84..cde1d04d4f 100644 --- a/tutorials/easydeploy-gitlab-runner/index.mdx +++ b/tutorials/easydeploy-gitlab-runner/index.mdx @@ -36,11 +36,23 @@ This setup enables you to optimize resource utilization, reduce overhead, and en If you cannot find GitLab Runner on the first page, use the search bar or navigate through the library using the arrow buttons. 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. -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. -9. Click **Deploy Application** to deploy GitLab Runner on your Kubernetes cluster. -10. Verify that the GitLab Runner is successfully installed and running: +8. **Provide GitLab Details:** + - **GitLab URL (`gitlabUrl`)**: Go to your GitLab project, navigate to **Settings > CI/CD > Runners**, and copy the GitLab instance URL. + - **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. + ```yaml + gitlabUrl: https://your-gitlab.com + runnerToken: "your-token" + rbac: + create: true + ``` + + It is essential to provide these details to successfully register your GitLab Runner with your GitLab project. + +9. 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. +10. Click **Deploy Application** to deploy GitLab Runner on your Kubernetes cluster. +11. Verify that the GitLab Runner is successfully installed and running: ```bash - kubectl get pods -n default # replace "default" with the name of the Kubernetes namespace in which you have installed your GitLab Runner. + kubectl get pods -n # replace "" with the name of the Kubernetes namespace in which you have installed your GitLab Runner. ``` You should see a pod with a name similar to `gitlab-runner-xxxxxx-xxxxx` in the `Running` state. @@ -120,7 +132,7 @@ Navigate to **CI/CD** > **Pipelines** in your GitLab project to view the status If the pipeline fails, you can check the logs of the GitLab Runner pod for more information: ```bash - kubectl logs -n default + kubectl logs -n ``` @@ -128,4 +140,4 @@ Navigate to **CI/CD** > **Pipelines** in your GitLab project to view the status 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. -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). \ No newline at end of file +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). From feed84a854cf5424cf4ae88b41ead9d3b45b530a Mon Sep 17 00:00:00 2001 From: Benedikt Rollik Date: Wed, 13 Nov 2024 09:54:17 +0100 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: nerda-codes <87707325+nerda-codes@users.noreply.github.com> --- tutorials/easydeploy-gitlab-runner/index.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tutorials/easydeploy-gitlab-runner/index.mdx b/tutorials/easydeploy-gitlab-runner/index.mdx index cde1d04d4f..627a7c0702 100644 --- a/tutorials/easydeploy-gitlab-runner/index.mdx +++ b/tutorials/easydeploy-gitlab-runner/index.mdx @@ -36,8 +36,8 @@ This setup enables you to optimize resource utilization, reduce overhead, and en If you cannot find GitLab Runner on the first page, use the search bar or navigate through the library using the arrow buttons. 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. -8. **Provide GitLab Details:** - - **GitLab URL (`gitlabUrl`)**: Go to your GitLab project, navigate to **Settings > CI/CD > Runners**, and copy the GitLab instance URL. +8. **Provide the following GitLab details:** + - **GitLab URL (`gitlabUrl`)**: Go to your GitLab project, click **Settings > CI/CD > Runners**, and copy the GitLab instance URL. - **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. ```yaml gitlabUrl: https://your-gitlab.com @@ -45,12 +45,12 @@ This setup enables you to optimize resource utilization, reduce overhead, and en rbac: create: true ``` - - It is essential to provide these details to successfully register your GitLab Runner with your GitLab project. + + The information above is required to register your GitLab Runner with your GitLab project. -9. 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. +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. 10. Click **Deploy Application** to deploy GitLab Runner on your Kubernetes cluster. -11. Verify that the GitLab Runner is successfully installed and running: +11. Use the following command to verify that the GitLab Runner is installed and running: ```bash kubectl get pods -n # replace "" with the name of the Kubernetes namespace in which you have installed your GitLab Runner. ``` From 4914151a22237ded783affbc741ff5f6785a625c Mon Sep 17 00:00:00 2001 From: Sanson Thomas <93382375+ThomasSanson@users.noreply.github.com> Date: Thu, 14 Nov 2024 07:33:45 +0100 Subject: [PATCH 3/4] Update tutorials/easydeploy-gitlab-runner/index.mdx Co-authored-by: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> --- tutorials/easydeploy-gitlab-runner/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/easydeploy-gitlab-runner/index.mdx b/tutorials/easydeploy-gitlab-runner/index.mdx index 627a7c0702..749c5b3ae9 100644 --- a/tutorials/easydeploy-gitlab-runner/index.mdx +++ b/tutorials/easydeploy-gitlab-runner/index.mdx @@ -37,7 +37,7 @@ This setup enables you to optimize resource utilization, reduce overhead, and en 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. 8. **Provide the following GitLab details:** - - **GitLab URL (`gitlabUrl`)**: Go to your GitLab project, click **Settings > CI/CD > Runners**, and copy the GitLab instance URL. + - **GitLab URL (`gitlabUrl`)**: Go to your GitLab project, click **Settings > CI/CD > Runners**, and copy the GitLab Instance URL. - **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. ```yaml gitlabUrl: https://your-gitlab.com From 91d6b53bb44dbca2658d124ad0316149845697c9 Mon Sep 17 00:00:00 2001 From: Sanson Thomas <93382375+ThomasSanson@users.noreply.github.com> Date: Thu, 14 Nov 2024 07:35:30 +0100 Subject: [PATCH 4/4] Update tutorials/easydeploy-gitlab-runner/index.mdx Co-authored-by: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> --- tutorials/easydeploy-gitlab-runner/index.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/tutorials/easydeploy-gitlab-runner/index.mdx b/tutorials/easydeploy-gitlab-runner/index.mdx index 749c5b3ae9..01676cf317 100644 --- a/tutorials/easydeploy-gitlab-runner/index.mdx +++ b/tutorials/easydeploy-gitlab-runner/index.mdx @@ -45,6 +45,7 @@ This setup enables you to optimize resource utilization, reduce overhead, and en rbac: create: true ``` + The information above is required to register your GitLab Runner with your GitLab project.