Skip to content

Commit c8bff05

Browse files
committed
Adjust CLI help menu for new environment variable behavior with secret
1 parent 801dc60 commit c8bff05

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

docs/reference.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,8 @@ See examples of koyeb service create --help
290290
--docker-entrypoint strings Docker entrypoint. To provide multiple arguments, use the --docker-entrypoint flag multiple times.
291291
--docker-private-registry-secret string Docker private registry secret
292292
--env strings Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
293-
To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
293+
To use the value of a secret as an environment variable, use the following syntax:
294+
--env FOO={{secret.bar}}
294295
To delete an environment variable, prefix its name with '!', for example --env '!FOO'
295296
296297
--git string Git repository
@@ -577,7 +578,8 @@ koyeb deploy <path> <app>/<service> [flags]
577578
578579
--deployment-strategy STRATEGY Deployment strategy, either "rolling" (default), "canary", "blue-green" or "immediate".
579580
--env strings Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
580-
To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
581+
To use the value of a secret as an environment variable, use the following syntax:
582+
--env FOO={{secret.bar}}
581583
To delete an environment variable, prefix its name with '!', for example --env '!FOO'
582584
583585
-h, --help help for deploy
@@ -1382,7 +1384,8 @@ $> koyeb service create myservice --app myapp --docker nginx --port 80:tcp
13821384
--docker-entrypoint strings Docker entrypoint. To provide multiple arguments, use the --docker-entrypoint flag multiple times.
13831385
--docker-private-registry-secret string Docker private registry secret
13841386
--env strings Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
1385-
To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
1387+
To use the value of a secret as an environment variable, use the following syntax:
1388+
--env FOO={{secret.bar}}
13861389
To delete an environment variable, prefix its name with '!', for example --env '!FOO'
13871390
13881391
--git string Git repository
@@ -1802,7 +1805,8 @@ $> koyeb service update myapp/myservice --port 80:tcp --route '!/'
18021805
--docker-entrypoint strings Docker entrypoint. To provide multiple arguments, use the --docker-entrypoint flag multiple times.
18031806
--docker-private-registry-secret string Docker private registry secret
18041807
--env strings Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
1805-
To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
1808+
To use the value of a secret as an environment variable, use the following syntax:
1809+
--env FOO={{secret.bar}}
18061810
To delete an environment variable, prefix its name with '!', for example --env '!FOO'
18071811
18081812
--git string Git repository

pkg/koyeb/services.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ func (h *ServiceHandler) addServiceDefinitionFlagsForAllSources(flags *pflag.Fla
314314
"env",
315315
[]string{},
316316
"Update service environment variables using the format KEY=VALUE, for example --env FOO=bar\n"+
317-
"To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar\n"+
317+
"To use the value of a secret as an environment variable, use the following syntax: --env FOO={{secret.bar}}\n"+
318318
"To delete an environment variable, prefix its name with '!', for example --env '!FOO'\n",
319319
)
320320
flags.String("instance-type", "nano", "Instance type")

0 commit comments

Comments
 (0)