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

Deprecate oauth2 settings #12399

Draft
wants to merge 2 commits into
base: make-some-oauth2-settings-optional
Choose a base branch
from

Conversation

MarcialRosales
Copy link
Contributor

@MarcialRosales MarcialRosales commented Sep 27, 2024

Proposed Changes

Implements these 2 features which essentially deprecate two settings:

This PR adds the new settings while keeping the old ones until 4.2.x when they will be removed.
If the user configures the old and the new setting, RabbitMQ will take the value from the new setting
If the user configures the only the old setting, RabbitMQ uses it.

Types of Changes

What types of changes does your code introduce to this project?
Put an x in the boxes that apply

  • Bug fix (non-breaking change which fixes issue #NNNN)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause an observable behavior change in existing systems)
  • Documentation improvements (corrections, new content, etc)
  • Cosmetic change (whitespace, formatting, etc)
  • Build system and/or CI

Release note

It should be mentioned in the release notes these two changes and the fact that users currently using auth_oauth2.jwks_url and/or management.oauth_metadata_url they are affected and they should modify their configuration.
Any reference to auth_oauth2.jwks_url should be renamed to auth_oauth2.jwks_uri. Likewise any reference in the legacy schema should be renamed to. i..e key_config.jwks_url to key_config.jwks_uri.
Any reference to management.oauth_metadata_url should be removed and instead configure the auth_oauth2.discovery_endpoint_params accordingly. There is a section in the docs that cover this in detail.

cc @pstack2021

@mergify mergify bot added the bazel label Sep 27, 2024
@MarcialRosales MarcialRosales changed the title Deprecate oauth2 settings Deprecate(Remove+Rename) oauth2 settings Sep 27, 2024
@MarcialRosales MarcialRosales changed the base branch from main to make-some-oauth2-settings-optional September 27, 2024 14:13
@MarcialRosales MarcialRosales self-assigned this Sep 27, 2024
@MarcialRosales MarcialRosales changed the title Deprecate(Remove+Rename) oauth2 settings Deprecate oauth2 settings Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant