Configuring Cloud SDK for use behind a proxy/firewall

If you are behind a corporate proxy or firewall, the gcloud command-line tool may not be able to access the internet with its default settings.

Installing Cloud SDK

The interactive Cloud SDK installers download components from the internet as part of the installation process, which may not work correctly if you are behind a proxy or firewall.

For a simpler installation process when proxy configuration is necessary, use one of the self-contained versioned archives to install the Cloud SDK. All previous versions of the Cloud SDK are also available to download from the downloads archive.

Proxy configuration

Note: The gcloud command-line tool respects the http_proxy, https_proxy, and no_proxy variables set in your proxy configuration. Configure your gcloud proxy settings only if you would like to use a different proxy. If gcloud proxy settings are set, they override existing proxy configuration; this includes ignoring no_proxy.

Once you have the SDK installed, proxy settings can be configured via Cloud SDK properties by using the typical gcloud config mechanism. For more information on what Cloud SDK properties are and how to use them, refer to the properties page.

To start, set the type of proxy you are using and the address and port on which to reach it:

gcloud config set proxy/type [PROXY_TYPE]
gcloud config set proxy/address [PROXY_IP_ADDRESS]
gcloud config set proxy/port [PROXY_PORT]

• Cloud SDK supports the following values for PROXY_TYPE: http, http_no_tunnel, socks4, socks5
• PROXY_IP_ADDRESS is the hostname or IP address of where the proxy can be reached.
• PROXY_PORT is the port the proxy is running on (e.g. 8080).

For an authenticated proxy, you will need to set your proxy username and password using properties, like so:

gcloud config set proxy/username [USERNAME]
gcloud config set proxy/password [PASSWORD]

Alternatively, to avoid having the proxy credentials recorded in any logs (such as shell history or gcloud logs) or in the gcloud CLI configuration file, you can set the properties using environment variables, like so:

export CLOUDSDK_PROXY_USERNAME [USERNAME]
export CLOUDSDK_PROXY_PASSWORD [PASSWORD]

The gcloud CLI won't store these values anywhere. This way, the credentials can be stored in an encrypted file locally, or they can be stored in a secure network location and retrieved when necessary.

A full description of all proxy related properties can be found by running gcloud topic configurations or gcloud config set and looking for proxy under the Available properties section.