Ephemeral mode and "Runner" resource type

[nlwstein]

Not sure if it's our particular Kubernetes environment, but using the "Runner" type, which is called out early in the documentation does NOT work properly with the default values set:

---
apiVersion: actions.summerwind.dev/v1alpha1
kind: Runner
metadata:
  name: stm-prd-k8s
  namespace: github-runners
spec:
  organization: MY_ORG_NAME
  labels:
    - prd

It seems like the "Runner" bare resource when combined with ephemeral and the dockerd container simply falls into a degraded state (runner container exits with 0, docker left online) and the controller does not clean it up.

I switched to a "RunnerDeployment", like this:

---
apiVersion: actions.summerwind.dev/v1alpha1
kind: RunnerDeployment
metadata:
  name: stm-prd-k8s
  namespace: github-runners
spec:
  template:
    spec:
      organization: MY_ORG_NAME
      labels:
        - prd

...and it works perfectly!

This can likely be solved by re-writing this section, and just instructing new users to use the "RunnerDeployment" type 😄

[toast-gear]

Cheers for raising this, yeh that got missed tbf. Since the trasition to the new logic this is expected behaviour, we probably should update the docs to make the Runner kind more of an internal CRD for the controller to use with end users deploying the abstractions instead (RunnerDeployments and RunnerSets), there's no compelling reason to deploy the Runner kind directly anyway, We shouldcould probably produce a new .md file for which is "how the plumbing works?" doc for those that want to understand the internals and move the runner kind into there.

FYI I've raised an issue to create implementation docs as we have a need for a broader set of docs to cover this kind of thing tbf #1494