feat: implement runtime configuration package with multi-org support #13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
* chore: refactor entry into deployment and runtime RuntimeEntry has no startup value, and omits functions required to be serpent compatible. Co-authored-by: Danny Kopping <[email protected]> --------- Co-authored-by: Danny Kopping <[email protected]>
lizard-boy
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RFC.
What this does
Adds a new runtimeconfig package for managing all runtime related configuration. The goal of this package is to create a consistent method for CRUD on runtime configuration (as opposed to startup values).
The motivation and driver is mutli-org. Multi org settings must be configured at runtime. Instead of creating ad-hoc CRUD operations to a key/val store, this package creates a single code path for all settings.
Design
The design uses a Manager singleton that produces Resolvers to enable a cache layer in the future. A pure singleton cannot be used as the Resolver requires a database.Store, which could be a tx. So the user of the package must create the Resolver on demand with their local instance of the db.
Usage
The design is intentionally created so that we can deprecate startup values in favor of runtime in the future. The DeploymentEntry type specifically uses startup values as a fallback.
This will allow us to move some startup values into runtime, which has been a sticky point for configuring aspects of coder for awhile now.
Future work
Caching layer :: coder#14586
A follow up to this PR will be a caching layer that uses pubsub to update it's cached values. Adding a cache layer will make all settings essentially free to read, allowing use in hot paths such as httpmw (as we currently do for startup values).
RBAC layer :: coder/internal#154
When caching is implemented, dbauthz will not be called for cache hits. So this layer, or some layer above, needs to be RBAC aware.
Maybe in the initialize? the New? The field could know it's own RBAC properties??
Remove old runtime settings in favor of this
Pretty much all these sql queries: https://github.com/coder/coder/blob/e461d2773b5a2f1bd04ff899a922032b373e187f/coderd/database/queries/siteconfig.sql
Upside is we will remove a lot of database.Store queries (always nice to trim)