Adjust CLI help menu for new environment variable behavior with secret

koyeb · Sep 24, 2024 · c8bff05 · c8bff05
1 parent 801dc60
commit c8bff05
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/docs/reference.md b/docs/reference.md
@@ -290,7 +290,8 @@ See examples of koyeb service create --help
       --docker-entrypoint strings                Docker entrypoint. To provide multiple arguments, use the --docker-entrypoint flag multiple times.
       --docker-private-registry-secret string    Docker private registry secret
       --env strings                              Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
-                                                 To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
+                                                 To use the value of a secret as an environment variable, use the following syntax: 
+                                                 --env FOO={{secret.bar}}
                                                  To delete an environment variable, prefix its name with '!', for example --env '!FOO'
                                                  
       --git string                               Git repository
@@ -577,7 +578,8 @@ koyeb deploy <path> <app>/<service> [flags]
                                                  
       --deployment-strategy STRATEGY             Deployment strategy, either "rolling" (default), "canary", "blue-green" or "immediate".
       --env strings                              Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
-                                                 To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
+                                                 To use the value of a secret as an environment variable, use the following syntax: 
+                                                 --env FOO={{secret.bar}}
                                                  To delete an environment variable, prefix its name with '!', for example --env '!FOO'
                                                  
   -h, --help                                     help for deploy
@@ -1382,7 +1384,8 @@ $> koyeb service create myservice --app myapp --docker nginx --port 80:tcp
       --docker-entrypoint strings                Docker entrypoint. To provide multiple arguments, use the --docker-entrypoint flag multiple times.
       --docker-private-registry-secret string    Docker private registry secret
       --env strings                              Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
-                                                 To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
+                                                 To use the value of a secret as an environment variable, use the following syntax: 
+                                                 --env FOO={{secret.bar}}
                                                  To delete an environment variable, prefix its name with '!', for example --env '!FOO'
                                                  
       --git string                               Git repository
@@ -1802,7 +1805,8 @@ $> koyeb service update myapp/myservice --port 80:tcp --route '!/'
       --docker-entrypoint strings                Docker entrypoint. To provide multiple arguments, use the --docker-entrypoint flag multiple times.
       --docker-private-registry-secret string    Docker private registry secret
       --env strings                              Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
-                                                 To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
+                                                 To use the value of a secret as an environment variable, use the following syntax: 
+                                                 --env FOO={{secret.bar}}
                                                  To delete an environment variable, prefix its name with '!', for example --env '!FOO'
                                                  
       --git string                               Git repository

diff --git a/pkg/koyeb/services.go b/pkg/koyeb/services.go
@@ -314,7 +314,7 @@ func (h *ServiceHandler) addServiceDefinitionFlagsForAllSources(flags *pflag.Fla
 		"env",
 		[]string{},
 		"Update service environment variables using the format KEY=VALUE, for example --env FOO=bar\n"+
-			"To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar\n"+
+			"To use the value of a secret as an environment variable, use the following syntax: --env FOO={{secret.bar}}\n"+
 			"To delete an environment variable, prefix its name with '!', for example --env '!FOO'\n",
 	)
 	flags.String("instance-type", "nano", "Instance type")