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

Remove dedicated Portal auth configuration from values.yaml #55

Merged
merged 2 commits into from
Feb 27, 2020

Conversation

rainest
Copy link
Contributor

@rainest rainest commented Feb 22, 2020

What this PR does / why we need it:

Remove the dedicated Portal auth/session configuration. These are not necessary for most versions, as Kong Enterprise will start fine without them and allows users to set them via a workspace's Portal configuration in Manager.

This change continues support for the existing configuration to maintain compatibility with existing user values.yamls. It places a warning in NOTES.txt to inform users that the configuration is deprecated and should be moved under env if they wish to keep it in place.

Which issue this PR fixes

Fix #52

Special notes for your reviewer:

Unlike other versions, 0.35 does not support configuring sessions via Manager: the kong.conf portal_session_conf is the only way to set Portal session configuration, and is used by all workspaces. Setting this in env or continuing to use the deprecated configuration works for 0.35.

Checklist

[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]

  • PR is based off the current tip of the next branch and targets next, not master
  • New or modified sections of values.yaml are documented in the README.md
  • Title of the PR and commit headers start with chart name (e.g. [kong])

@rainest rainest requested a review from hbagdi February 22, 2020 00:31
Copy link
Member

@hbagdi hbagdi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

Please merge once the comments are resolved, thanks!

Please also see: #38 (comment)

charts/kong/README.md Outdated Show resolved Hide resolved
charts/kong/templates/NOTES.txt Show resolved Hide resolved
@hbagdi hbagdi mentioned this pull request Feb 27, 2020
* Remove enterprise.portal.portal_auth and
  enterprise.portal.session_conf_secret from values.yaml. Both can be
  configured per-workspace in Kong Manager, and providing them via
  environment variables only provides defaults. The standard default
  values are fine; Manager will prompt users to create a session
  configuration if necessary.
* Add deprecation warning to NOTES.txt. The chart continues to apply the
  old settings if present, but warns users that they should remove them
  or migrate them to env values.
* Update README.md with new session instructions.
* Clean up some outdated comments from values.yaml and adjust NOTES.txt
  format a bit.
@rainest rainest merged commit 831efbb into next Feb 27, 2020
@hbagdi hbagdi deleted the fix/portal-auth-removal branch February 27, 2020 22:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants