From 734f3bd63a5c7838992b0146c47ea7cdaa31a1bf Mon Sep 17 00:00:00 2001 From: toast-gear Date: Sat, 9 Jul 2022 13:56:06 +0100 Subject: [PATCH] docs: put shell k8s commands back --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6059df9d..ee1e86d1 100644 --- a/README.md +++ b/README.md @@ -283,6 +283,7 @@ We go into details about the differences between the 2 later, initially lets loo To launch a single self-hosted runner, you need to create a manifest file that includes a `RunnerDeployment` resource as follows. This example launches a self-hosted runner with name *example-runnerdeploy* for the *actions-runner-controller/actions-runner-controller* repository. ```yaml +# runnerdeployment.yaml apiVersion: actions.summerwind.dev/v1alpha1 kind: RunnerDeployment metadata: @@ -294,6 +295,21 @@ spec: repository: mumoshu/actions-runner-controller-ci ``` +Apply the created manifest file to your Kubernetes. + +```shell +$ kubectl apply -f runnerdeployment.yaml +runnerdeployment.actions.summerwind.dev/example-runnerdeploy created +``` + +You can see that 1 runner have been created as specified by `replicas: 1` attribute: + +```shell +$ kubectl get runners +NAME REPOSITORY STATUS +example-runnerdeploy2475h595fr mumoshu/actions-runner-controller-ci Running +``` + The runner you created has been registered directly to the defined repository, you should be able to see it in the settings of the repository. Now you can use your self-hosted runner. See the [official documentation](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow) on how to run a job with it. @@ -336,7 +352,7 @@ Now you can see the runner on the enterprise level (if you have enterprise acces ### RunnerDeployments -In our previous examples we were deploying a single runner via the `RunnerDeployment` kind, the amount of runners deployed is controlled statically via the `replicas:` field, we can increase this value to deploy additioanl sets of runners instead: +In our previous examples we were deploying a single runner via the `RunnerDeployment` kind, the amount of runners deployed can be statically set via the `replicas:` field, we can increase this value to deploy additioanl sets of runners instead: ```yaml # runnerdeployment.yaml