feat: provider name enhancements

dubinsky · dubinsky · commit cd5cd2d569c9 · 2026-03-17T00:51:28.000-04:00
- chore: typos and minor cleanup
- feat: convey to the provider the name it is running under
- feat: use `DEVPOD_PROVIDER_&lt;provider name&gt;_SOURCE` environment variable

Signed-off-by: Leonid Dubinsky &lt;dub@podval.org&gt;
diff --git a/cmd/context/create.go b/cmd/context/create.go
@@ -53,7 +53,7 @@ func (cmd *CreateCmd) Run(ctx context.Context, context string) error {
 
 	// verify name
 	if provider2.ProviderNameRegEx.MatchString(context) {
-		return fmt.Errorf("context name can only include smaller case letters, numbers or dashes")
+		return fmt.Errorf("context name can only include lower case letters, numbers or dashes")
 	} else if len(context) > 48 {
 		return fmt.Errorf("context name cannot be longer than 48 characters")
 	}
diff --git a/cmd/provider/add.go b/cmd/provider/add.go
@@ -3,6 +3,7 @@ package provider
 import (
 	"context"
 	"fmt"
+	"os"
 	"strings"
 
 	"github.com/sirupsen/logrus"
@@ -33,7 +34,7 @@ func NewAddCmd(f *flags.GlobalFlags) *cobra.Command {
 		GlobalFlags: f,
 	}
 	addCmd := &cobra.Command{
-		Use:   "add [URL or path]",
+		Use:   "add [name, GitHub link, URL or path]",
 		Short: "Adds a new provider to DevPod",
 		PreRunE: func(cobraCommand *cobra.Command, args []string) error {
 			if cmd.FromExisting != "" {
@@ -56,7 +57,7 @@ func NewAddCmd(f *flags.GlobalFlags) *cobra.Command {
 		BoolVar(&cmd.SingleMachine, "single-machine", false, "If enabled will use a single machine for all workspaces")
 	addCmd.Flags().
 		StringVar(&cmd.Name, "name", "",
-			"The name for the new provider. If not specified, the name from the provider's configuration file will be used.")
+			"The name for the new provider. If not specified, the name from the provider's configuration file will be used")
 	addCmd.Flags().
 		StringVar(&cmd.FromExisting, "from-existing", "",
 			"The name of an existing provider to use as a template. Needs to be used in conjunction with the --name flag")
@@ -69,23 +70,43 @@ func NewAddCmd(f *flags.GlobalFlags) *cobra.Command {
 }
 
 func (cmd *AddCmd) Run(ctx context.Context, devPodConfig *config.Config, args []string) error {
-	if len(args) != 1 && cmd.FromExisting == "" {
-		return fmt.Errorf("please specify either a local file, URL or Git repository. " +
-			"E.g. devpod provider add https://path/to/my/provider.yaml")
-	} else if cmd.Name != "" && provider.ProviderNameRegEx.MatchString(cmd.Name) {
-		return fmt.Errorf("provider name can only include smaller case letters, numbers or dashes")
-	} else if cmd.Name != "" && len(cmd.Name) > 32 {
-		return fmt.Errorf("provider name cannot be longer than 32 characters")
-	} else if cmd.FromExisting != "" && devPodConfig.Current() != nil && devPodConfig.Current().Providers[cmd.FromExisting] == nil {
-		return fmt.Errorf("provider %s does not exist", cmd.FromExisting)
+	providerName := cmd.Name
+
+	if providerName != "" {
+		if provider.ProviderNameRegEx.MatchString(providerName) {
+			return fmt.Errorf(
+				"provider name can only include lower case letters, numbers or dashes",
+			)
+		}
+		if len(providerName) > 32 {
+			return fmt.Errorf("provider name cannot be longer than 32 characters")
+		}
+	}
+
+	providerSource := ""
+	if len(args) == 1 {
+		providerSource = args[0]
+	}
+	if providerSource == "" {
+		var sourceEnvVar string
+		if providerName == "" {
+			sourceEnvVar = "DEVPOD_PROVIDER_SOURCE"
+		} else {
+			sourceEnvVar = "DEVPOD_PROVIDER_" + strings.ToUpper(providerName) + "_SOURCE"
+		}
+		providerSource = os.Getenv(sourceEnvVar)
 	}
 
 	var providerConfig *provider.ProviderConfig
 	var options []string
 	if cmd.FromExisting != "" {
+		if devPodConfig.Current() != nil &&
+			devPodConfig.Current().Providers[cmd.FromExisting] == nil {
+			return fmt.Errorf("provider %s does not exist", cmd.FromExisting)
+		}
 		providerWithOptions, err := workspace.CloneProvider(
 			devPodConfig,
-			cmd.Name,
+			providerName,
 			cmd.FromExisting,
 			log.Default,
 		)
@@ -100,7 +121,11 @@ func (cmd *AddCmd) Run(ctx context.Context, devPodConfig *config.Config, args []
 			cmd.Options,
 		)
 	} else {
-		c, err := workspace.AddProvider(devPodConfig, cmd.Name, args[0], log.Default)
+		if providerSource == "" {
+			return fmt.Errorf("please specify either a name, GitHub link, URL or path, " +
+				"e.g. devpod provider add https://path/to/my/provider.yaml")
+		}
+		c, err := workspace.AddProvider(devPodConfig, providerName, providerSource, log.Default)
 		if err != nil {
 			return err
 		}
diff --git a/cmd/provider/delete.go b/cmd/provider/delete.go
@@ -57,10 +57,6 @@ func NewDeleteCmd(flags *flags.GlobalFlags) *cobra.Command {
 }
 
 func (cmd *DeleteCmd) Run(ctx context.Context, args []string) error {
-	if len(args) > 1 {
-		return fmt.Errorf("please specify a provider to delete")
-	}
-
 	devPodConfig, err := config.LoadConfig(cmd.Context, cmd.Provider)
 	if err != nil {
 		return err
diff --git a/cmd/provider/update.go b/cmd/provider/update.go
@@ -26,7 +26,7 @@ func NewUpdateCmd(flags *flags.GlobalFlags) *cobra.Command {
 		GlobalFlags: flags,
 	}
 	updateCmd := &cobra.Command{
-		Use:   "update [name] [URL or path]",
+		Use:   "update [name] [name, GitHub link, URL or path]",
 		Short: "Updates a provider in DevPod",
 		RunE: func(cobraCmd *cobra.Command, args []string) error {
 			ctx := cobraCmd.Context()
@@ -48,8 +48,8 @@ func NewUpdateCmd(flags *flags.GlobalFlags) *cobra.Command {
 
 func (cmd *UpdateCmd) Run(ctx context.Context, devPodConfig *config.Config, args []string) error {
 	if len(args) != 1 && len(args) != 2 {
-		return fmt.Errorf("please specify either a local file, URL or Git repository. " +
-			"E.g. devpod provider update my-provider skevetter/devpod-provider-gcloud")
+		return fmt.Errorf("please specify either a local file, URL or Git repository, " +
+			"e.g. devpod provider update my-provider skevetter/devpod-provider-gcloud")
 	}
 
 	providerSource := ""
diff --git a/cmd/up.go b/cmd/up.go
@@ -157,7 +157,7 @@ func (cmd *UpCmd) registerDotfilesFlags(upCmd *cobra.Command) {
 			"The path in dotfiles directory to use to install the dotfiles, if empty will try to guess")
 	upCmd.Flags().
 		StringSliceVar(&cmd.DotfilesScriptEnv, "dotfiles-script-env", []string{},
-			"Extra environment variables to put into the dotfiles install script. E.g. MY_ENV_VAR=MY_VALUE")
+			"Extra environment variables to put into the dotfiles install script, e.g. MY_ENV_VAR=MY_VALUE")
 	upCmd.Flags().
 		StringSliceVar(&cmd.DotfilesScriptEnvFile, "dotfiles-script-env-file", []string{},
 			"The path to files containing environment variables to set for the dotfiles install script")
@@ -226,7 +226,7 @@ func (cmd *UpCmd) registerWorkspaceFlags(upCmd *cobra.Command) {
 			"The machine to use for this workspace. The machine needs to exist beforehand or the "+
 				"command will fail. If the workspace already exists, this option has no effect")
 	upCmd.Flags().
-		StringVar(&cmd.Source, "source", "", "Optional source for the workspace. E.g. git:https://github.com/my-org/my-repo")
+		StringVar(&cmd.Source, "source", "", "Optional source for the workspace, e.g. git:https://github.com/my-org/my-repo")
 	upCmd.Flags().
 		StringArrayVar(&cmd.ProviderOptions, "provider-option", []string{}, "Provider option in the form KEY=VALUE")
 	upCmd.Flags().
@@ -242,14 +242,14 @@ func (cmd *UpCmd) registerWorkspaceFlags(upCmd *cobra.Command) {
 			"Docker repository that hosts devpod prebuilds for this workspace")
 	upCmd.Flags().
 		StringArrayVar(&cmd.WorkspaceEnv, "workspace-env", []string{},
-			"Extra env variables to put into the workspace. E.g. MY_ENV_VAR=MY_VALUE")
+			"Extra env variables to put into the workspace, e.g. MY_ENV_VAR=MY_VALUE")
 	upCmd.Flags().
 		StringSliceVar(&cmd.WorkspaceEnvFile, "workspace-env-file", []string{},
-			"The path to files containing a list of extra env variables to put into the workspace. "+
-				"E.g. MY_ENV_VAR=MY_VALUE")
+			"The path to files containing a list of extra env variables to put into the workspace, "+
+				"e.g. MY_ENV_VAR=MY_VALUE")
 	upCmd.Flags().
 		StringArrayVar(&cmd.InitEnv, "init-env", []string{},
-			"Extra env variables to inject during the initialization of the workspace. E.g. MY_ENV_VAR=MY_VALUE")
+			"Extra env variables to inject during the initialization of the workspace, e.g. MY_ENV_VAR=MY_VALUE")
 	upCmd.Flags().
 		BoolVar(&cmd.DisableDaemon, "disable-daemon", false,
 			"If enabled, will not install a daemon into the target machine to track activity")
diff --git a/docs/pages/developing-providers/options.mdx b/docs/pages/developing-providers/options.mdx
@@ -67,7 +67,7 @@ configuring or adding the provider:
 - `command`: A command to retrieve the option value automatically. Can also reference other variables in the command, e.g. `echo ${MY_OTHER_VAR}-suffix`. For compatibility reasons, this command will be executed in an emulated shell on Windows.
 - `local`: If true, the option will be filled individually for each machine / workspace
 - `global`: If true, the option will be reused for each machine / workspace
-- `cache`: If non-empty, DevPod will re-execute the command after the given timeout. E.g. if this is 5m, DevPod will re-execute the command after 5 minutes to re-fill this value. This is useful if you want to store a token or something that expires locally in a variable.
+- `cache`: If non-empty, DevPod will re-execute the command after the given timeout, e.g. if this is 5m, DevPod will re-execute the command after 5 minutes to re-fill this value. This is useful if you want to store a token or something that expires locally in a variable.
 - `hidden`: If true, DevPod will not show this option in the Desktop application or through `devpod provider options`. Can be used to calculate variables internally or save tokens or other things internally.
 
 ### Default values
diff --git a/docs/pages/managing-providers/add-provider.mdx b/docs/pages/managing-providers/add-provider.mdx
@@ -140,7 +140,7 @@ AWS_AMI                   | false    | The disk image to use.         |
 AWS_DISK_SIZE             | false    | The disk size to use.          | 40                      | 40
 AWS_INSTANCE_TYPE         | false    | The machine type to use.       | c5.xlarge               | c5.xlarge
 AWS_REGION                | true     | The AWS cloud region to create |                         | us-west-2
-                          |          | the VM in. E.g. us-west-1      |                         |
+                          |          | the VM in, e.g. us-west-1      |                         |
 AWS_SECRET_ACCESS_KEY     | false    | The AWS secret access key      |                         |
 AWS_VPC_ID                | false    | The vpc id to use.             |                         |
 INACTIVITY_TIMEOUT        | false    | If defined, will automatically | 10m                     | 10m
@@ -178,7 +178,7 @@ AWS_AMI                   | false    | The disk image to use.         |
 AWS_DISK_SIZE             | false    | The disk size to use.          | 40                      | 120
 AWS_INSTANCE_TYPE         | false    | The machine type to use.       | c5.xlarge               | c5.xlarge
 AWS_REGION                | true     | The aws cloud region to create |                         | us-west-2
-                          |          | the VM in. E.g. us-west-1      |                         |
+                          |          | the VM in, e.g. us-west-1      |                         |
 AWS_SECRET_ACCESS_KEY     | false    | The aws secret access key      |                         |
 AWS_VPC_ID                | false    | The vpc id to use.             |                         |
 INACTIVITY_TIMEOUT        | false    | If defined, will automatically | 10m                     | 10m
diff --git a/pkg/driver/custom/custom.go b/pkg/driver/custom/custom.go
@@ -360,6 +360,7 @@ func ToEnvironWithBinaries(
 		workspace.Machine,
 		workspace.Options,
 		nil,
+		"",
 	)
 	for k, v := range agentBinaries {
 		environ = append(environ, k+"="+v)
diff --git a/pkg/ide/jupyter/jupyter.go b/pkg/ide/jupyter/jupyter.go
@@ -20,7 +20,7 @@ const (
 var Options = ide.Options{
 	BindAddressOption: {
 		Name:        BindAddressOption,
-		Description: "The address to bind the server to locally. E.g. 0.0.0.0:12345",
+		Description: "The address to bind the server to locally, e.g. 0.0.0.0:12345",
 		Default:     "",
 	},
 	OpenOption: {
diff --git a/pkg/ide/openvscode/openvscode.go b/pkg/ide/openvscode/openvscode.go
@@ -47,7 +47,7 @@ var Options = ide.Options{
 	},
 	BindAddressOption: {
 		Name:        BindAddressOption,
-		Description: "The address to bind VSCode web to locally. E.g. 0.0.0.0:12345",
+		Description: "The address to bind VSCode web to locally, e.g. 0.0.0.0:12345",
 		Default:     "",
 	},
 	VersionOption: {
diff --git a/pkg/ide/rstudio/rstudio.go b/pkg/ide/rstudio/rstudio.go
@@ -31,7 +31,7 @@ const (
 var Options = ide.Options{
 	BindAddressOption: {
 		Name:        BindAddressOption,
-		Description: "The address to bind the server to locally. E.g. 0.0.0.0:12345",
+		Description: "The address to bind the server to locally, e.g. 0.0.0.0:12345",
 		Default:     "",
 	},
 	OpenOption: {
diff --git a/pkg/provider/download.go b/pkg/provider/download.go
@@ -51,7 +51,13 @@ type EnvironmentOptions struct {
 }
 
 func ToEnvironmentWithBinaries(opts EnvironmentOptions) ([]string, error) {
-	environ := ToEnvironment(opts.Workspace, opts.Machine, opts.Options, opts.ExtraEnv)
+	environ := ToEnvironment(
+		opts.Workspace,
+		opts.Machine,
+		opts.Options,
+		opts.ExtraEnv,
+		opts.Config.Name,
+	)
 	binariesMap, err := GetBinaries(opts.Context, opts.Config)
 	if err != nil {
 		return nil, err
diff --git a/pkg/provider/env.go b/pkg/provider/env.go
@@ -64,6 +64,7 @@ func ToEnvironment(
 	machine *Machine,
 	options map[string]config.OptionValue,
 	extraEnv map[string]string,
+	providerName string,
 ) []string {
 	env := ToOptions(workspace, machine, options)
 
@@ -75,6 +76,9 @@ func ToEnvironment(
 	for k, v := range extraEnv {
 		osEnviron = append(osEnviron, k+"="+v)
 	}
+	if providerName != "" {
+		osEnviron = append(osEnviron, "DEVPOD_PROVIDER="+providerName)
+	}
 
 	return osEnviron
 }
diff --git a/pkg/provider/parse.go b/pkg/provider/parse.go
@@ -69,8 +69,8 @@ func validate(config *ProviderConfig) error {
 	for optionName, optionValue := range config.Options {
 		if optionNameRegEx.MatchString(optionName) {
 			return fmt.Errorf(
-				"provider option '%s' can only consist of upper case letters, numbers or underscores. "+
-					"E.g. MY_OPTION, MY_OTHER_OPTION",
+				"provider option '%s' can only consist of upper case letters, numbers or underscores, "+
+					"e.g. MY_OPTION, MY_OTHER_OPTION",
 				optionName,
 			)
 		}
@@ -318,7 +318,7 @@ func validateBinaries(prefix string, binaries map[string][]*ProviderBinary) erro
 	for binaryName, binaryArr := range binaries {
 		if optionNameRegEx.MatchString(binaryName) {
 			return fmt.Errorf(
-				"binary name '%s' can only consist of upper case letters, numbers or underscores. E.g. MY_BINARY, KUBECTL",
+				"binary name '%s' can only consist of upper case letters, numbers or underscores, e.g. MY_BINARY, KUBECTL",
 				binaryName,
 			)
 		}
diff --git a/pkg/workspace/workspace.go b/pkg/workspace/workspace.go
@@ -28,7 +28,7 @@ import (
 )
 
 var errProvideWorkspaceArg = errors.New(
-	"please provide a workspace name. E.g. 'devpod up ./my-folder', " +
+	"please provide a workspace name, e.g. 'devpod up ./my-folder', " +
 		"'devpod up github.com/my-org/my-repo' or 'devpod up ubuntu'")
 
 // RemoteCreator defines the interface for clients that support remote workspace creation.
@@ -67,7 +67,7 @@ func Resolve(
 	if params.DesiredID != "" {
 		if providerpkg.ProviderNameRegEx.MatchString(params.DesiredID) {
 			return nil, fmt.Errorf(
-				"workspace name can only include smaller case letters, numbers or dashes",
+				"workspace name can only include lower case letters, numbers or dashes",
 			)
 		} else if len(params.DesiredID) > 48 {
 			return nil, fmt.Errorf("workspace name cannot be longer than 48 characters")
diff --git a/providers/kubernetes/provider.yaml b/providers/kubernetes/provider.yaml
@@ -35,9 +35,9 @@ options:
     default: 10Gi
     global: true
   KUBERNETES_CONTEXT:
-    description: The kubernetes context to use. E.g. my-kube-context
+    description: The kubernetes context to use, e.g. my-kube-context
   KUBERNETES_CONFIG:
-    description: The kubernetes config to use. E.g. /path/to/my/kube/config.yaml
+    description: The kubernetes config to use, e.g. /path/to/my/kube/config.yaml
   KUBERNETES_PULL_SECRETS_ENABLED:
     description: If true, DevPod will create Kubernetes pull secrets from your injected Docker credentials for private registries. This setting requires the global Docker credentials forwarding setting (SSH_INJECT_DOCKER_CREDENTIALS) to be enabled. If Docker credential injection is disabled, pull secrets cannot be created regardless of this setting.
     default: "true"
@@ -66,23 +66,23 @@ options:
     description: If defined, DevPod will use the given storage class to create the persistent volume claim. You will need to ensure the storage class exists in your cluster!
     global: true
   PVC_ACCESS_MODE:
-    description: If defined, DevPod will use the given access mode to create the persistent volume claim. You will need to ensure the storage class support the given access mode!. E.g. RWO or ROX or RWX or RWOP
+    description: If defined, DevPod will use the given access mode to create the persistent volume claim. You will need to ensure the storage class support the given access mode, e.g. RWO or ROX or RWX or RWOP
     global: true
   PVC_ANNOTATIONS:
     description: If defined, DevPod will use add the given annotations to the main workspace pvc
     global: true
   NODE_SELECTOR:
-    description: The node selector to use for the workspace pod. E.g. my-label=value,my-label-2=value-2
+    description: The node selector to use for the workspace pod, e.g. my-label=value,my-label-2=value-2
     global: true
   RESOURCES:
-    description: The resources to use for the workspace container. E.g. requests.cpu=500m,limits.memory=5Gi,limits.gpu-vendor.example/example-gpu=1
+    description: The resources to use for the workspace container, e.g. requests.cpu=500m,limits.memory=5Gi,limits.gpu-vendor.example/example-gpu=1
     global: true
   POD_MANIFEST_TEMPLATE:
-    description: Pod manifest template file path used as template to build the devpod pod. E.g. /path/pod_manifest.yaml. Alternatively can be an inline yaml string.
+    description: Pod manifest template file path used as template to build the devpod pod, e.g. /path/pod_manifest.yaml. Alternatively can be an inline yaml string.
     global: true
     type: multiline
   LABELS:
-    description: The labels to use for the workspace pod. E.g. devpod.sh/example=value,devpod.sh/example2=value2
+    description: The labels to use for the workspace pod, e.g. devpod.sh/example=value,devpod.sh/example2=value2
     global: true
   DOCKERLESS_IMAGE:
     description: The dockerless image to use.
@@ -99,7 +99,7 @@ options:
     description: Sets the path of the workspace volume mount. By default it is the root of your workspace source code, usually /workspaces/$WORKSPACE_ID. If you intend to create multi-repo workspaces or need additional files throughout the lifecycle of the workspace, set this option to a parent directory of the workspace mount.
     type: string
   ARCHITECTURE:
-    description: The cpu architecture to use for the workspace pod. E.g. amd64, arm64, etc.
+    description: The cpu architecture to use for the workspace pod, e.g. amd64, arm64, etc.
     type: string
 agent:
   containerInactivityTimeout: ${INACTIVITY_TIMEOUT}

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ func (cmd *CreateCmd) Run(ctx context.Context, context string) error {`
`53`	`53`
`54`	`54`	`// verify name`
`55`	`55`	`if provider2.ProviderNameRegEx.MatchString(context) {`
`56`		`- return fmt.Errorf("context name can only include smaller case letters, numbers or dashes")`
	`56`	`+ return fmt.Errorf("context name can only include lower case letters, numbers or dashes")`
`57`	`57`	`} else if len(context) > 48 {`
`58`	`58`	`return fmt.Errorf("context name cannot be longer than 48 characters")`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -360,6 +360,7 @@ func ToEnvironWithBinaries(`
`360`	`360`	`workspace.Machine,`
`361`	`361`	`workspace.Options,`
`362`	`362`	`nil,`
	`363`	`+ "",`
`363`	`364`	`)`
`364`	`365`	`for k, v := range agentBinaries {`
`365`	`366`	`environ = append(environ, k+"="+v)`