Skip to content

Deprecation notice & aliases for coder server config options #5290

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

Closed
bpmct opened this issue Dec 5, 2022 · 1 comment
Closed

Deprecation notice & aliases for coder server config options #5290

bpmct opened this issue Dec 5, 2022 · 1 comment
Labels
stale This issue is like stale bread.

Comments

@bpmct
Copy link
Member

bpmct commented Dec 5, 2022

We've run into a few cases where we need to change a configuration option for coder server. This can be particularly dangerous when users upgrade as it could change the deployment/security of their deployment as soon as they upgrade.

In the case of #5210, we probably could always support the following as aliases: CODER_OIDC_EMAIL_DOMAIN, CODER_OIDC_EMAIL_DOMAINS. Perhaps with viper aliases?

However, there may be cases where we entirely rename a variable or change its configuration format. We could support the old format for a while, but notify the admin to use the new format via server logs and on the deployment page (as it may be removed in a future version).

@github-actions
Copy link

github-actions bot commented Mar 6, 2023

This issue is becoming stale. In order to keep the tracker readable and actionable, I'm going close to this issue in 7 days if there isn't more activity.

@github-actions github-actions bot added the stale This issue is like stale bread. label Mar 6, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale This issue is like stale bread.
Projects
None yet
Development

No branches or pull requests

1 participant