Options for the connect command

Datalab is deprecated and new Datalab instances cannot be created by using the datalab create command. Vertex AI Workbench provides a notebook-based environment that offers capabilities beyond Datalab. We recommend that you use Vertex AI Workbench for new projects and migrate your Datalab notebooks to Vertex AI Workbench. For more information, see Deprecation information. To get help migrating Datalab projects to Vertex AI Workbench see Get help.

This page describes the datalab connect command.

Usage

datalab connect [-h] [--no-user-checking] [--port PORT]
                [--max-reconnects MAX_RECONNECTS]
                [--connection-health-timeout-seconds CONNECTION_HEALTH_TIMEOUT_SECONDS]
                [--ssh-log-level {quiet,fatal,error,info,verbose,debug,debug1,debug2,debug3}]
                [--no-launch-browser] [--beta-internal-ip]
                [--project PROJECT] [--quiet]
                [--verbosity {debug,info,default,warning,error,critical,none}]
                [--zone ZONE] [--diagnose-me]
                NAME

datalab connect creates a persistent connection to a Datalab instance running in a Google Compute Engine VM.

This is a thin wrapper around the ssh(1) command that takes care of authentication and the translation of the instance name into an IP address.

This command ensures that the user's public SSH key is present in the project's metadata. If the user does not have a public SSH key, one is generated using ssh-keygen(1) (if the --quiet flag is given, the generated key will have an empty passphrase).

Once the connection is established, this command opens a browser window pointing at Cloud Datalab. To disable the browser opening, add the --no-launch-browser flag.

This command will attempt to re-establish the connection if it gets dropped. However, that connection will only exist while this command is running.

Options

-h/--help

Show a help message and exit

--no-user-checking

Do not check if the current user matches the Datalab instance

--port PORT

Local port on which Cloud Datalab is accessible

--max-reconnects MAX_RECONNECTS

Maximum number of times to reconnect.

A negative value means no limit.

--connection-health-timeout-seconds CONNECTION_HEALTH_TIMEOUT_SECONDS

Maximum amount of time in seconds, to wait for a connection to become healthy before giving up and retrying.

--ssh-log-level {quiet,fatal,error,info,verbose,debug,debug1,debug2,debug3}

The log level for the SSH command.

This may be useful for debugging issues with an SSH connection.

The default log level is "error".

--no-launch-browser

Do not open a browser connected to Cloud Datalab

--beta-internal-ip

Beta

This feature is covered by the Pre-GA Offerings Terms of the Google Cloud Terms of Service. Pre-GA features might have limited support, and changes to pre-GA features might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Connect to the internal IP address of the instance. This flag must also be used with the datalab create) command.

--project PROJECT

The Google Cloud Platform project name to use for this invocation.

If omitted then the current project is assumed.

--quiet

Do not issue any interactive prompts

--verbosity {debug,info,default,warning,error,critical,none}

Override the default output verbosity for this command.

--zone ZONE

The zone containing the instance. If not specified, you may be prompted to select a zone.

To avoid prompting when this flag is omitted, you can set the compute/zone property:

$ gcloud config set compute/zone ZONE

A list of zones can be fetched by running:

$ gcloud compute zones list

To unset the property, run:

$ gcloud config unset compute/zone

Alternatively, the zone can be stored in the environment variable CLOUDSDK_COMPUTE_ZONE.

--diagnose-me

Print additional diagnostics information to help troubleshoot issues.