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

[Feature Request] Support TEMPORAL_API_KEY environment variable for consistency with temporal CLI #410

Open
tomwheeler opened this issue Jan 17, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@tomwheeler
Copy link

Is your feature request related to a problem? Please describe.

As per this internal Slack thread, I observed last night that the tcld command's environment variable used for API Key authentication (TEMPORAL_CLOUD_API_KEY) differs from the one used in the temporal CLI (TEMPORAL_API_KEY). This is confusing, adds friction for someone who uses both tools, and is a potential source of trouble for someone who doesn't realize they differ (since they will set one variable but not the other and then wonder why things didn't work as expected).

Describe the solution you'd like

For backwards compatibility, the TEMPORAL_CLOUD_API_KEY environment variable must continue to be supported. However, I would recommend making the TEMPORAL_API_KEY environment variable an alternate and preferred one that achieves the same effect. This will ensure that a user who sets the TEMPORAL_API_KEY environment variable will see consistent behavior in tcld, the temporal CLI, the SDKs when they support self-configuration in the future, the OMS reference application, and potentially other tools that rely on the variable set for the temporal CLI.

Additional context

@tomwheeler tomwheeler added the enhancement New feature or request label Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant