💥 Support environment config [BREAKING CHANGES] #764

cretz · 2025-02-25T14:48:57Z

What was changed

💥 BREAKING CHANGE - --api-key now assumes TLS (i.e. --tls) by default, so users using API keys on non-TLS servers will have to explicitly disable TLS (i.e. --tls=false)
Added experimental temporal config commands
Changed internals to have env vars use envconfig approach
No longer log when env var overrides config-file-set values as was in [Feature Request] Log notice when --env is getting overrode by env var #293

Checklist

Closes [Feature Request] Environment configuration #751

Sushisource · 2025-03-24T19:42:58Z

temporalcli/client.go

+	// To support legacy TLS environment variables, if they are present, we will
+	// have them force-override anything loaded from existing file or env
+	if !cctx.RootCommand.DisableConfigEnv {
+		oldEnvTLSCert, _ := cctx.Options.EnvLookup.LookupEnv("TEMPORAL_TLS_CERT")


Mentioned in the other PR, but this sure seems like a good reason to export the constants from the SDK

I don't think every SDK should export every environment variable name as part of its public API to users, it will be part of the spec.

Sushisource · 2025-03-24T19:49:00Z

temporalcli/commandsgen/commands.yml

+        implied-env: TEMPORAL_CONFIG_FILE
+      - name: profile
+        type: string
+        description: Profile to use for config file.


Should this use default as the default?

No because the default is actually determined by the Go SDK not by the CLI. A CLI flag (whether set via "default" or explicitly) would override where it may be otherwise set, e.g. env var or the actual default.

temporalcli/commandsgen/commands.yml

Sushisource · 2025-03-24T19:52:45Z

temporalcli/commandsgen/commands.yml

+      Remove a full profile entirely _or_ remove a property within a profile.
+      When deleting an entire profile, the `--profile` must be set explicitly.
+
+      ```
+      temporal env delete \
+          --profile my-profile
+      ```


IMO adding an explicit --delete-whole-profile or something might be good in that instance, but, not hugely concerned.

👍 Yeah this just matches what we do for env today, but I do agree. Actually this should be a top-level command called delete-profile so delete can always require the --prop.

Moved to its own command. Leaving conversation open for others that may want to see that this changed.

cretz · 2025-04-01T14:26:42Z

temporalcli/client.go

+	// In the past, the presence of API key CLI arg did not imply TLS like it
+	// does with envconfig. Therefore if there is a user-provided API key and
+	// TLS is not present, explicitly disable it so API key presence doesn't
+	// enable it in ToClientOptions below.
+	// TODO(cretz): Or do we want to break compatibility to have TLS defaulted
+	// for all API keys?
+	if c.ApiKey != "" && clientProfile.TLS == nil {
+		clientProfile.TLS = &envconfig.ClientConfigTLS{Disabled: true}
+	}


Thoughts here on just making TLS the default for API key and adding TLS disabled option? Technically a backwards incompatible break, but a good one IMO.

I think it makes sense

Ok, I have made this breaking change and added tests

# Conflicts: # go.mod # go.sum # temporalcli/client.go # temporalcli/commands.gen.go # temporalcli/commands.go # temporalcli/commandsgen/commands.yml

cretz · 2025-04-17T20:02:12Z

temporalcli/commandsgen/commands.yml

+        type: string
+        description: |
+          File path to read TOML config from, defaults to
+          `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined


Suggested change

`$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined

`$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined

cretz · 2025-04-17T21:35:43Z

temporalcli/client.go

+	if namespaceExplicitlySet {
+		clientProfile.Namespace = c.Namespace
+	}


Suggested change

if namespaceExplicitlySet {

clientProfile.Namespace = c.Namespace

}

if namespaceExplicitlySet {

clientProfile.Namespace = c.Namespace

} else {

c.Namespace = clientProfile.Namespace

}

Some code is using c.Namespace flag in its output which is obviously not valid if it's overwritten by env config stuff. Need to either update c.Namespace with the valid value or have some other way to relay what is the now-current namespace value.

yuandrew

Primarily looked at the commandsgen stuff, just one clarity comment

yuandrew · 2025-04-18T18:36:23Z

temporalcli/commandsgen/commands.yml

 #       short: The single letter short version of name (i.e. a for address). (string)
 #       env: Binds the environment variable to this flag. (string)
+#       implied-env: Documents the environment variable as bound to the flag,
+#         but does actually bind it.


Should this be doesn't? Also missing the type (string)

Also, I'm not seeing ImpliedEnv used anywhere, do we want it printed into the generated docs?

Yes, I meant doesn't, will fix. Yes, I do think it'd make sense to be in the docs just like env. I just had to make a separate field because it's effectively doc only, it has no runtime use.

Support environment config

0e58809

Fixes temporalio#751

cretz requested a review from a team February 25, 2025 14:48

cretz mentioned this pull request Feb 25, 2025

Support environment config on a single sample temporalio/samples-go#392

Closed

cretz mentioned this pull request Mar 11, 2025

[Bug] Unable to set multiple grpc-meta in the env config #774

Open

Sushisource reviewed Mar 24, 2025

View reviewed changes

Separated delete-profile into its own command

67b32d4

cretz changed the base branch from next-server to main April 1, 2025 14:22

cretz commented Apr 1, 2025

View reviewed changes

cretz added 2 commits April 1, 2025 10:57

Merge remote-tracking branch 'remotes/origin/main' into envconfig

3766051

# Conflicts: # go.mod # go.sum # temporalcli/client.go # temporalcli/commands.gen.go # temporalcli/commands.go # temporalcli/commandsgen/commands.yml

Fix for only overriding some envconfig options if explicitly set

15f42ae

Sushisource approved these changes Apr 2, 2025

View reviewed changes

BREAKING: Made --api-key enable TLS by default

fb9b2e1

cretz changed the title ~~Support environment config~~ 💥 Support environment config [BREAKING CHANGES] Apr 3, 2025

cretz mentioned this pull request Apr 3, 2025

[DRAFT - IGNORE] Testing Envconfig CLI #787

Closed

CI fix

2f11d52

cretz commented Apr 17, 2025

View reviewed changes

cretz added 3 commits April 18, 2025 13:05

Fix issue with derived namespace not being accurate

bb92500

Merge branch 'main' into envconfig

374c667

Add tags

8d6fffe

yuandrew reviewed Apr 18, 2025

View reviewed changes

Minor typo

85435bc

cretz merged commit 4a0118a into temporalio:main Apr 21, 2025
14 checks passed

cretz mentioned this pull request Jun 9, 2025

[Bug] temporal workflow list fails without --tls vs. temporal cloud #810

Closed

cretz mentioned this pull request Dec 18, 2025

Add OAuth support for CLI extensions #892

Open

	`$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined
	`$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined

💥 Support environment config [BREAKING CHANGES] #764

💥 Support environment config [BREAKING CHANGES] #764

Uh oh!

Conversation

cretz commented Feb 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What was changed

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cretz Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cretz Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yuandrew left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cretz commented Feb 25, 2025 •

edited

Loading

cretz Apr 1, 2025 •

edited

Loading

cretz Apr 3, 2025 •

edited

Loading