fix!(jans-cedarling): fix cedarling-properties docs to be more proper #10788
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
Because it hard to keep consistent, and contains mistakes Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com> (cherry picked from commit cdd7a41)
…Nativity-Plan Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>
Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>
Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>
Signed-off-by: Oleh Bozhok <olehbozhok@gmail.com>
To highlight key if missing Signed-off-by: Oleh Bozhok <olehbozhok@gmail.com>
Signed-off-by: Oleh Bozhok <olehbozhok@gmail.com>
Signed-off-by: Oleh Bozhok <olehbozhok@gmail.com>
Signed-off-by: Oleh Bozhok <olehbozhok@gmail.com>
mo-auto
added
area-documentation
rmarinn
reviewed
Feb 4, 2025
| @@ -152,7 +152,7 @@ pub struct BootstrapConfigRaw { | |||
|
|
|||
| /// Configuration for token-based entities, mapping token names to their | |||
| /// respective settings. | |||
| #[serde(rename = "CEDARLING_TOKEN_CONFIGS", default)] | |||
| #[serde(rename = "CEDARLING_TOKEN_CONFIGS")] | |||
There was a problem hiding this comment.
why remove the serde(default) here? won't the deserialization fail if the CEDARLING_TOKEN_CONFIGS is not provided? the TokenConfigs struct implements Default in raw_config/token_settings.rs.
Are we requiring the user to set this bootstrap config now?
There was a problem hiding this comment.
OK, I missed that TokenConfigs have custom implementation of Default trait.
|
it also looks like python tests are failing now. might be because the names of some bootstrap properties were changed. |
…ING_TOKEN_CONFIGS` when parsing wia serde Signed-off-by: Oleh Bozhok <olehbozhok@gmail.com>
…that show default implementation of `CEDARLING_TOKEN_CONFIGS` Signed-off-by: Oleh Bozhok <olehbozhok@gmail.com>
…LING_POLICY_STORE_LOCAL` Signed-off-by: Oleh Bozhok <olehbozhok@gmail.com>
nynymike
approved these changes
Feb 4, 2025
SafinWasi
changed the title
SafinWasi
approved these changes
Feb 4, 2025
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.
Prepare
Description
Improve documentation. Fix name of some keys. Added information about required bootstrap properties keys.
Target issue
link
closes #10748
Implementation Details
Required keys for startupCEDARLING_TOKEN_CONFIGSis absentserdeshow key in errorTest and Document the changes
Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with
docs:to indicate documentation changes or if the below checklist is not selected.