feat: add an unregister command

viceice commented

2024-04-18 08:32:26 +00:00

Owner

I'm running the runner inside kubernetes and everytime the pod get's recreated i get a new runner.
Now the old runner pod get's removed but it's still registered in forgejo.

So i like to add a shutdown hook which will unregister the runner.

https://codeberg.org/forgejo/forgejo/issues/1030

I'm running the runner inside kubernetes and everytime the pod get's recreated i get a new runner. Now the old runner pod get's removed but it's still registered in forgejo. So i like to add a shutdown hook which will unregister the runner. - https://codeberg.org/forgejo/forgejo/issues/1030

❤️ 2

viceice added the

Kind/Feature

label

2024-04-18 08:32:26 +00:00

earl-warren changed title from ~~Add an unregister command~~ to feat: add an unregister command

2025-07-01 15:50:39 +00:00

earl-warren added the

Priority

Low

label

2025-07-11 12:31:28 +00:00

Routhinator commented

2025-07-19 15:51:09 +00:00

This is a very needed thing when running dynamically provisioned runners. I just had to spend way to much time manually de-registering over 100 runner pods from the UI which was painful because the UI doesn't provide a way to remove multiple runners at once.

earl-warren added

and removed

labels

2025-07-19 20:55:06 +00:00

earl-warren commented

2025-07-19 20:55:18 +00:00

Contributor

Bumped the priority.

👍 1

earl-warren referenced this issue from a commit

2025-07-28 17:10:26 +00:00

fix: #182 - support symlinks in workspace

earl-warren closed this issue

2025-07-28 17:10:26 +00:00

earl-warren referenced this issue from a commit

2025-07-28 17:10:29 +00:00

chore(cleanup): ACT cli is redundant with Forgejo runner cli (#182)

viceice commented

2025-07-28 17:28:08 +00:00

Author

Owner

wrongly closed from merge

viceice reopened this issue

2025-07-28 17:28:08 +00:00

earl-warren commented

2025-07-28 18:19:37 +00:00

Contributor

good catch

aahlenst commented

2025-12-12 20:55:56 +00:00

Member

@viceice The issue you linked talks about HTTP APIs. Is that sufficient for your use case or do you want to execute forgejo-runner unregister in a Kubernetes PreStop hook?

@viceice The issue you linked talks about HTTP APIs. Is that sufficient for your use case or do you want to execute `forgejo-runner unregister` in a Kubernetes PreStop hook?

Routhinator commented

2025-12-13 00:12:38 +00:00

HTTP API is a prerequisite to having an unregister command. If the API is added, we can at least script a preStop with curl and an addtional configmap to provide the script, but the end goal should be an unregister command.

I can imagine there are needs for dynamically priovisioned runners outside of Kube as well.

HTTP API is a prerequisite to having an unregister command. If the API is added, we can at least script a preStop with curl and an addtional configmap to provide the script, but the end goal should be an unregister command. I can imagine there are needs for dynamically priovisioned runners outside of Kube as well.

aahlenst commented

2025-12-13 12:54:57 +00:00

Member

@Routhinator wrote in #182 (comment):

HTTP API is a prerequisite to having an unregister command.

The runner talks to Forgejo using GRPC. I don't think it calls the HTTP API at any time.

If the API is added, we can at least script a preStop with curl and an addtional configmap to provide the script, but the end goal should be an unregister command.

An endpoint to delete runners exists in the development version of Forgejo. It would be awesome if you could try it and provide feedback.

I don't think it will be easy to do with curl because you'd need to know whether it's a global, organization, user, or repository runner to call the right endpoint. I don't think we can infer this information from the .runner file or the local configuration. So we'd need another endpoint that could provide that information.

I can imagine there are needs for dynamically priovisioned runners outside of Kube as well.

From what I could gather so far, forgejo-runner register only makes sense for people with Kubernetes or a similar system that can keep the runner registration token secret. For everyone else, corresponding HTTP APIs are being developed.

What are the requirements for a forgejo-runner unregister command?

What I have so far:

forgejo-runner unregister should be a no-op with exit code 0 (and a terminal message?) if there's no .runner file.
forgejo-runner unregister should work with the credentials stored in the .runner file.
If forgejo-runner unregister fails for some reason, it should exit with a code > 0.
Upon success, forgejo-runner unregister should remove the .runner file.

@Routhinator wrote in https://code.forgejo.org/forgejo/runner/issues/182#issuecomment-69876: > HTTP API is a prerequisite to having an unregister command. The runner talks to Forgejo using GRPC. I don't think it calls the HTTP API at any time. > If the API is added, we can at least script a preStop with curl and an addtional configmap to provide the script, but the end goal should be an unregister command. An endpoint to delete runners exists in the development version of Forgejo. It would be awesome if you could try it and provide feedback. I don't think it will be easy to do with `curl` because you'd need to know whether it's a global, organization, user, or repository runner to call the right endpoint. I don't think we can infer this information from the `.runner` file or the local configuration. So we'd need another endpoint that could provide that information. > I can imagine there are needs for dynamically priovisioned runners outside of Kube as well. From what I could gather so far, `forgejo-runner register` only makes sense for people with Kubernetes or a similar system that can keep the runner registration token secret. For everyone else, corresponding HTTP APIs are being developed. --- What are the requirements for a `forgejo-runner unregister` command? What I have so far: * `forgejo-runner unregister` should be a no-op with exit code 0 (and a terminal message?) if there's no `.runner` file. * `forgejo-runner unregister` should work with the credentials stored in the `.runner` file. * If `forgejo-runner unregister` fails for some reason, it should exit with a code > 0. * Upon success, `forgejo-runner unregister` should remove the `.runner` file.

aahlenst referenced this issue

2025-12-13 12:56:10 +00:00

introducing ephemeral-runners #1122

aahlenst referenced this issue

2025-12-17 12:23:56 +00:00

introducing ephemeral-runners #1122

Rows
Columns

feat: add an unregister command #182