-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(config)!: re-design and clean-up configuration #979
Merged
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
Alex6323
changed the title
Refactor/config/config refactor
refactor(config)!: redesign how Chronicle can be configured
Dec 14, 2022
Alex6323
changed the title
refactor(config)!: redesign how Chronicle can be configured
refactor(config)!: re-design and clean-up configuration
Dec 16, 2022
grtlr
reviewed
Dec 19, 2022
grtlr
reviewed
Dec 20, 2022
Alex6323
force-pushed
the
refactor/config/config-refactor
branch
from
December 20, 2022 10:02
c0fb35b
to
e0a7e71
Compare
grtlr
reviewed
Dec 20, 2022
grtlr
suggested changes
Dec 21, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please make sure cargo ci-check-features
command passes.
grtlr
suggested changes
Dec 22, 2022
Could you please also do #1000 as part of this PR? 🙏 |
grtlr
reviewed
Dec 23, 2022
grtlr
approved these changes
Dec 23, 2022
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.
Description and Motivation
This PR changes the way how Chronicle can be configured. This was motivated by the fact that we defined defaults in multiple locations and naturally ... conflicts appeared and bit us ... some place. Although those defaults were in theory (if they had been consistent) documented in the
config.template.toml
file, we think those are better documented in the CLI itself (if you invoke--help
). Another problem with such a file is that users were supposed to make a copy of that file and change it to their liking. This resulted in theconfig.toml
being invalidated earlier than it needed to be since often times no parameter that the user actually adapted was conflicting with the newer version. This PR changes the preferred mode of configuration for Chronicle as it makes everything configurable through the CLI itself and also limits supported environment variables to credentials basically (which are more unlikely to be deprecated). Together with the focus of Chronicle as a Docker deployment, this also allows for making ourdocker-compose.yml
the main location of configuration as it's no longer needed to copy over the template file.Linked Issues
GenerateJWT
CLI command does not seem to be generating valid tokens #947.env
file indocker-compose.yml
#1000Notes to Reviewer
As a reviewer, please pay particular attention to the following areas when reviewing this PR and tick the above boxes after you have completed the steps.
Config Changes
cargo ci-check-features
.