Rethink what belongs in `runtime/controllers`

Open
#527 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
go
Domain
backend

Research direction

Start by inspecting runtime/controllers and its overlap with runtime/leaderelection and runtime/client. Map the existing helpers, label selector support, and rate limit flags, then define and implement a clearer separation of responsibilities across these packages.

Written by the indexing model from the issue text.

Description

area/runtime enhancement

Historically, runtime/controllers used to facilitate setting up helpers (to e.g. initialize metrics in a common way for reconcilers to consume).

However, since growing it to support label selectors and rate limit flags. It has become an odd bag of mixed things (and not just "helpers"), which also has overlap with other sub-packages which provide component specific flags like runtime/leaderelection and runtime/client.

Given this, it looks like we need to rethink the structure and move, separate and/or divide (parts of it) to other places.

Dominant language
Go
Stars
63
Forks
162
Avg merge
9h 54m
Merged PRs (30d)
29

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from fluxcd/pkg

All issues in fluxcd/pkg

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.