Skip to content
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

nixos/kanidm: rename options to match upstream nomenclature #359870

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

oddlama
Copy link
Contributor

@oddlama oddlama commented Nov 28, 2024

This renames originUrl to redirectUri and originLanding to landingUrl,
as previously discussed here.

I tried every way I could come up with to get the module to issue a warning when users use the old option,
but unfortunately I had to give up. There seems to be no way to make it work within a submodule.
See this related issue.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Nov 28, 2024
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Nov 29, 2024
@oddlama oddlama force-pushed the rename-kanidm-provision-options branch from a5930bb to bed941a Compare December 22, 2024 00:50
@github-actions github-actions bot added 8.has: documentation This PR adds or changes documentation 8.has: changelog labels Dec 22, 2024
@oddlama oddlama force-pushed the rename-kanidm-provision-options branch from bed941a to c1a2646 Compare December 22, 2024 00:52
@Flakebi
Copy link
Member

Flakebi commented Dec 24, 2024

I agree that the current names are not the best, I also got slightly confused while upgrading.
However, it seems like kanidm uses different names in different places. So, there’s no canonical spelling that we can adopt.
E.g. if I run kanidm system oauth2 list, I get the names we currently use:

$ kanidm system oauth2 list
class: account
class: memberof
class: oauth2_resource_server
class: oauth2_resource_server_basic
class: object
displayname: App
name: oauth-app-name
oauth2_rs_origin: 
oauth2_rs_origin_landing: 

Changing the name used in NixOS has a cost as it’s a breaking change.
As long as the names used in NixOS are also used in kanidm, I think we don’t need to change them (as we’d basically just switch the place in kanidm that is consistent/inconsistent with our names).

@oddlama
Copy link
Contributor Author

oddlama commented Dec 25, 2024

True, we don't need to change them. I agree that the fact that this change would be breaking is far from optimal - still I wanted to give the option to do this if the current wording is too confusing.

I'll convert this to a draft and maybe we can revisit this at a later time if there is ever something else in kanidm that requires us to a breaking change. Then we can maybe piggyback this on top without causing an additional breakage.

@oddlama oddlama marked this pull request as draft December 25, 2024 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: changelog 8.has: documentation This PR adds or changes documentation 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants