From 050c4d4c943d413d0a4ab4d6bd7b8804970792f2 Mon Sep 17 00:00:00 2001
From: Robert Williams <robertwilliams1985@gmail.com>
Date: Fri, 13 Jan 2023 16:56:13 +0000
Subject: [PATCH] Add docs

---
 docs/add-ons/gitlab-runner.md | 55 +++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 docs/add-ons/gitlab-runner.md

diff --git a/docs/add-ons/gitlab-runner.md b/docs/add-ons/gitlab-runner.md
new file mode 100644
index 0000000000..556612227e
--- /dev/null
+++ b/docs/add-ons/gitlab-runner.md
@@ -0,0 +1,55 @@
+# gitlab-runner
+
+The GitLab runner Helm Chart is the official way of deploying a GitLab runner on a Kubernetes cluster. The chart configures a GitLab runner which runs using the Kubernetes executor. For each new job, it provisions a pod within the specified namespace.
+
+For complete project documentation, please see [GitLab's documentation](https://docs.gitlab.com/runner/install/kubernetes.html). 
+
+## Usage
+
+The GitLab Runner can be deployed by enabling the add-on via the following:
+
+```hcl
+enable_gitlab_runner = true
+```
+
+At minimum a runner token must be supplied. This can be done directly, as a deploy-time value:
+
+```hcl
+  gitlab_runner_helm_config = {
+    set_sensitive = [
+      { name = "runnerRegistrationToken", value = "someTokenValue" },
+    ]
+  }
+```
+
+or using an existing secret, such as:
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: gitlab-runner-secret
+type: Opaque
+data:
+  runner-registration-token: "NlZrN1pzb3NxUXlmcmVBeFhUWnIK" #base64 encoded registration token
+  runner-token: ""
+```
+and passing it to the chart:
+
+```hcl
+  gitlab_runner_helm_config = {
+    set = [
+      { name = "runners.secret", value = "gitlab-runner-secret" }
+    ]
+  }
+```
+
+By default the runner is registered on the cloud instance `gitlab.com`. An self-hosted instance can also be configured:
+
+```hcl
+  gitlab_runner_helm_config = {
+    set = [
+      { name = "gitlabUrl", value = "https://mygitlab.com" }
+    ]
+  }
+```