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

chore: keep public-url config option for compatibility #213

Merged
merged 1 commit into from
Jul 24, 2024

Conversation

DnPlas
Copy link
Contributor

@DnPlas DnPlas commented Jul 24, 2024

Since this is a breaking change, it is preferrable to keep some sort of compatibility that allow users with existing deployments to keep running Dex even after the upgrade. This configuration option can be removed after a deprecation notice is rolled out.

Testing instructions

  1. Deploy dex-auth from 2.36/stable
  2. Configure public-url with any value `juju config dex-auth public-url="my-known-value.io"
  3. Verify this value is populated in Dex's OIDC configuration:
curl -v <dex's svc>:5556/dex/.well-known/openid-configuration
{
  "issuer": "my-known-value.io/dex",
...
  1. Refresh dex-auth to the charm from this PR
  2. Without changing the charm configuration, make sure that Dex's OIDC configuration persists
curl -v <dex's svc>:5556/dex/.well-known/openid-configuration
{
  "issuer": "my-known-value.io/dex",
...
  1. As an extra check, make sure the deprecation notice is logged juju debug-log

Since this is a breaking change, it is preferrable to keep some sort of compatibility that
allow users with existing deployments to keep running Dex even after the upgrade.
This configuration option can be removed after a deprecation notice is rolled out.
@DnPlas DnPlas merged commit ee0db14 into KF-5536-issuer-url-dev-branch Jul 24, 2024
6 of 7 checks passed
@DnPlas DnPlas deleted the dnplas-add-deprecation-note branch July 24, 2024 18:54
DnPlas added a commit that referenced this pull request Jul 24, 2024
Since this is a breaking change, it is preferrable to keep some sort of compatibility that
allow users with existing deployments to keep running Dex even after the upgrade.
This configuration option can be removed after a deprecation notice is rolled out.
DnPlas added a commit that referenced this pull request Jul 25, 2024
This branch introduces changes to support the dex-oidc-config interface and the deprecation of public-url in favour of issuer-url. For more information, please refer to the following:

* refactor: add dex-issuer-url and remove public-url config options (#209)
* feat: add dex_oidc_config library (#208)
* chore: keep public-url config option for compatibility #213
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.

2 participants