Instalar o gsutil

Nesta página, descrevemos a instalação e a configuração da gsutil, uma ferramenta que permite acessar o Cloud Storage a partir da linha de comando usando HTTPS.

Importante: na maioria dos casos, os usuários que querem usar uma CLI para trabalhar com o Cloud Storage não devem usar a ferramenta gsutil. Em vez disso, trabalhe com a Google Cloud CLI e use os comandos gcloud storage.

Basta instalar o gsutil para ter acesso imediato de gravação e/ou leitura a dados públicos. A autenticação no serviço Cloud Storage permite que você leia e/ou grave acesso a dados protegidos que foram compartilhados com você. Ao ativar o faturamento, você pode criar e gerenciar seus próprios buckets.

Requisitos do sistema

• A ferramenta gsutil é executada em Linux/Unix, Mac OS e Windows (XP ou posterior).

• As versões 5.0 e posteriores da gsutil exigem o Python 3.

• Se você pretende usar objetos compostos, precisará instalar o crcmod compilado. No Windows, ele está disponível apenas para o Python de 32 bits.

Aviso: em algumas distribuições do Linux, há outra ferramenta denominada gsutil, da GrandStream BudgeTone, pré-instalada. Se você executar esse comando, em vez do comando gsutil do Cloud Storage, provavelmente será gerada uma mensagem de erro semelhante a esta: "Choose one of -b, -d, -e, or -r to do something". Se isso ocorrer, você tem duas alternativas: passar a versão da gsutil do Cloud Storage para frente da variável de ambiente PATH ou especificar o caminho completo ao executar a gsutil do Cloud Storage. Por exemplo, /home/users/joan/gsutil/gsutil ls.

Como instalar o gsutil

Observação: se você já instalou a CLI do Google Cloud, a gsutil já estará incluída. Além disso, a CLI do Google Cloud, incluindo a gsutil, é instalada por padrão em várias imagens do Google Compute Engine. Consulte os detalhes do SO para conferir uma lista completa.

O método de instalação e atualização do gsutil com suporte oficial faz parte da CLI do Google Cloud.

Como instalar o gsutil como parte da CLI do Google Cloud

Siga as instruções do seu sistema operacional para instalar o gsutil como parte da CLI do Google Cloud:

Linux

1. Confirme se você tem uma versão compatível do Python. A CLI do Google Cloud requer o Python de 3.8 a 3.12. O pacote Linux x86_64 inclui um intérprete de Python em pacote que terá preferência por padrão. Para informações sobre como escolher e configurar o interpretador do Python, consulte gcloud topic startup.
2. Faça o download de um dos seguintes itens:
   Observação: para determinar a versão do Linux, execute getconf LONG_BIT na linha de comando.

   Plataforma	Nome do pacote	Tamanho	Soma de verificação SHA256
   Linux de 64 bits (x86_64)	google-cloud-cli-471.0.0-linux-x86_64.tar.gz	202.0 MB	d53ed9f881953cb35c8312125ae24a201aba8660b724143d3ba048e2a7cc794d
   Linux de 64 bits (Arm)	google-cloud-cli-471.0.0-linux-arm.tar.gz	118,9 MB	62af142a8e42aea090873d8316c9e0cd80ee5a418f325168a4bfd14bd862ecdb
   Linux de 32 bits (x86)	google-cloud-cli-471.0.0-linux-x86.tar.gz	117.0 MB	a59f0f4c314f2f57009cf0aac47fb5c5be7e718f05e2b9a94efab2b40303f687

   Para fazer o download do arquivo do Linux, execute o seguinte comando:

   curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-cli-471.0.0-linux-x86_64.tar.gz

   Consulte a tabela acima e substitua google-cloud-cli-471.0.0-linux-x86_64.tar.gz pelo nome do pacote *.tar.gz que se aplica à sua configuração.

3. Para extrair o conteúdo do arquivo para o sistema de arquivos (preferencialmente para o diretório principal), execute o seguinte comando:

   tar -xf google-cloud-cli-471.0.0-linux-x86_64.tar.gz

   Opcional: para substituir uma instalação, remova o google-cloud-sdk e extraia o arquivo para o mesmo local.
4. Adicione a CLI gcloud ao caminho. Execute o script de instalação na raiz da pasta que você extraiu usando o comando a seguir:

   ./google-cloud-sdk/install.sh

   Isso também pode ser feito de maneira não interativa (por exemplo, com um script) e fornecendo preferências como sinalizações. Para ver as flags disponíveis, execute::

   ./google-cloud-sdk/install.sh --help

   Opcional:
   • (Opcional) Para enviar estatísticas de uso anônimas para ajudar a melhorar a CLI gcloud, responda Y quando solicitado.
   • Para adicionar a CLI gcloud ao PATH e ativar o preenchimento do comando, responda Y quando solicitado.
5. Abra um novo terminal para as alterações entrarem em vigor.
6. Para inicializar a CLI gcloud, execute o comando gcloud init:

./google-cloud-sdk/bin/gcloud init

7. Opcional: instale componentes extras usando o gerenciador de componentes.

Debian/Ubuntu

Observação: dependendo da sua configuração, é possível escolher outros métodos de instalação:

• Se você quiser que gcloud e gsutil sejam atualizados automaticamente para a versão mais recente enquanto você estiver executando uma versão moderna do Ubuntu que usa o Snap Package Manager, é possível instalar a Google Cloud CLI como pacote snap.
• Se você está usando uma instância no Compute Engine, a CLI gcloud é instalada por padrão em várias imagens do SO. Consulte Detalhes do SO para ver uma lista completa.

Conteúdo do pacote

A CLI gcloud está disponível no formato de pacote para instalação em sistemas Debian e Ubuntu. O pacote contém apenas os comandos gcloud, gcloud alpha, gcloud beta, gsutil e bq. Ele não inclui kubectl ou as extensões do App Engine necessárias para implantar um aplicativo usando os comandos gcloud. Se você quiser esses componentes, instale-os separadamente.

Antes de começar

Antes de instalar a CLI gcloud, verifique se o sistema operacional atende aos seguintes requisitos:

• É uma versão do Ubuntu que não atingiu o fim da vida útil ou uma versão estável do Debian que não atingiu o fim da vida útil
• Recentemente, os pacotes foram atualizados:

  sudo apt-get update

• Inclui o apt-transport-https e o curl instalados:

  sudo apt-get install apt-transport-https ca-certificates gnupg curl

Instalação

1. Importe a chave pública do Google Cloud.

   • Para distribuições mais recentes (Debian 9+ ou Ubuntu 18.04+), execute o seguinte comando:

     curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg

   • Para distribuições mais antigas, execute o seguinte comando:

     curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add -

   • Se o comando apt-key da sua distribuição não for compatível com o argumento --keyring, execute o seguinte comando:

     curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -

   • Se não for possível receber as atualizações mais recentes devido a uma chave expirada, consiga o arquivo de chave apt-get.gpg mais recente.

2. Adicione o URI de distribuição da CLI gcloud como uma origem de pacote.
   • Para distribuições mais recentes (Debian 9+ ou Ubuntu 18.04+), execute o seguinte comando:

     echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list

   • Para distribuições mais antigas que não são compatíveis com a opção "assinado por", execute o seguinte comando:

     echo "deb https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list

   Observação: verifique se não há entradas duplicadas para o repositório cloud-sdk em /etc/apt/sources.list.d/google-cloud-sdk.list.
3. Atualize e instale a gcloud CLI:

   sudo apt-get update && sudo apt-get install google-cloud-cli

   Para mais opções de apt-get, como desativação de prompts ou simulações, consulte as páginas de manual de apt-get.

   Dica do Docker: se você estiver instalando a CLI gcloud dentro de uma imagem do Docker, use uma única etapa RUN:

   RUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | tee -a /etc/apt/sources.list.d/google-cloud-sdk.list && curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg && apt-get update -y && apt-get install google-cloud-sdk -y
       

   Para imagens de base mais antigas que não são compatíveis com o comando gpg --dearmor:

   RUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | tee -a /etc/apt/sources.list.d/google-cloud-sdk.list && curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key --keyring /usr/share/keyrings/cloud.google.gpg  add - && apt-get update -y && apt-get install google-cloud-cli -y
         

4. (Opcional) Instale qualquer um dos seguintes componentes adicionais:
   • google-cloud-cli
   • google-cloud-cli-anthos-auth
   • google-cloud-cli-app-engine-go
   • google-cloud-cli-app-engine-grpc
   • google-cloud-cli-app-engine-java
   • google-cloud-cli-app-engine-python
   • google-cloud-cli-app-engine-python-extras
   • google-cloud-cli-bigtable-emulator
   • google-cloud-cli-cbt
   • google-cloud-cli-cloud-build-local
   • google-cloud-cli-cloud-run-proxy
   • google-cloud-cli-config-connector
   • google-cloud-cli-datastore-emulator
   • google-cloud-cli-firestore-emulator
   • google-cloud-cli-gke-gcloud-auth-plugin
   • google-cloud-cli-kpt
   • google-cloud-cli-kubectl-oidc
   • google-cloud-cli-local-extract
   • google-cloud-cli-minikube
   • google-cloud-cli-nomos
   • google-cloud-cli-pubsub-emulator
   • google-cloud-cli-skaffold
   • google-cloud-cli-spanner-emulator
   • google-cloud-cli-terraform-validator
   • google-cloud-cli-tests
   • kubectl

   Por exemplo, o componente google-cloud-cli-app-engine-java pode ser instalado da seguinte maneira:

   sudo apt-get install google-cloud-cli-app-engine-java

5. Execute gcloud init para começar:

   gcloud init

Como fazer downgrade das versões da CLI gcloud

Para reverter para uma versão específica da CLI gcloud, em que VERSION é do formulário 123.0.0, execute o seguinte comando:

sudo apt-get update && sudo apt-get install google-cloud-cli=123.0.0-0

As dez versões mais recentes estão sempre disponíveis no repositório.

OBSERVAÇÃO: para versões anteriores a 371.0.0, o nome do pacote é google-cloud-sdk

Red Hat/Fedora/CentOS

Observação: se você estiver usando uma instância no Compute Engine, a CLI do Google Cloud será instalada por padrão em várias imagens do SO. Consulte Detalhes do SO para conferir uma lista completa.

Conteúdo do pacote

A CLI gcloud está disponível no formato de pacote para instalação no Red Hat Enterprise Linux 7, 8 e 9. Fedora 33 e 34; e CentOS 7 e 8. O pacote contém apenas os comandos gcloud, gcloud alpha, gcloud beta, gsutil e bq. Ele não inclui kubectl ou as extensões do App Engine necessárias para implantar um aplicativo usando comandos gcloud, que podem ser instalados separadamente conforme descrito posteriormente nesta seção.

Instalação

1. Atualize o DNF com informações de repositório da gcloud CLI. O comando de exemplo a seguir é para uma instalação compatível com o Red Hat Enterprise Linux 9, mas certifique-se de atualizar as definições conforme necessário para sua configuração:

   sudo tee -a /etc/yum.repos.d/google-cloud-sdk.repo << EOM
   [google-cloud-cli]
   name=Google Cloud CLI
   baseurl=https://packages.cloud.google.com/yum/repos/cloud-sdk-el9-x86_64
   enabled=1
   gpgcheck=1
   repo_gpgcheck=0
   gpgkey=https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg
   EOM
   

2. Se você estiver instalando no Fedora 34 ou 35, instale o libxcrypt-compat.x86_64.

   sudo dnf install libxcrypt-compat.x86_64

3. Instale a gcloud CLI:

   sudo dnf install google-cloud-cli

Observação: caso você não tenha movido para dnf no sistema, execute esses comandos usando yum.

Também é possível usar opções dnf/yum, como desativação de prompts ou simulações, com os comandos fornecidos.

4. (Opcional) Instale qualquer um dos seguintes componentes adicionais:
   • google-cloud-cli
   • google-cloud-cli-anthos-auth
   • google-cloud-cli-app-engine-go
   • google-cloud-cli-app-engine-grpc
   • google-cloud-cli-app-engine-java
   • google-cloud-cli-app-engine-python
   • google-cloud-cli-app-engine-python-extras
   • google-cloud-cli-bigtable-emulator
   • google-cloud-cli-cbt
   • google-cloud-cli-cloud-build-local
   • google-cloud-cli-cloud-run-proxy
   • google-cloud-cli-config-connector
   • google-cloud-cli-datastore-emulator
   • google-cloud-cli-firestore-emulator
   • google-cloud-cli-gke-gcloud-auth-plugin
   • google-cloud-cli-kpt
   • google-cloud-cli-kubectl-oidc
   • google-cloud-cli-local-extract
   • google-cloud-cli-minikube
   • google-cloud-cli-nomos
   • google-cloud-cli-pubsub-emulator
   • google-cloud-cli-skaffold
   • google-cloud-cli-spanner-emulator
   • google-cloud-cli-terraform-validator
   • google-cloud-cli-tests
   • kubectl

   Por exemplo, o componente google-cloud-cli-app-engine-java pode ser instalado da seguinte maneira:

   sudo dnf install google-cloud-cli-app-engine-java

5. Execute gcloud init para começar:

   gcloud init

Como fazer downgrade das versões da CLI gcloud

Se você quiser reverter para uma versão específica da gcloud CLI, em que VERSION seja do formulário 123.0.0, execute: sudo dnf downgrade google-cloud-cli-VERSION. Os dez lançamentos mais recentes sempre estarão disponíveis no repositório. OBSERVAÇÃO: para versões anteriores a 371.0.0, o nome do pacote é google-cloud-sdk

macOS

1. Confirme se você tem uma versão compatível do Python:
   • Para verificar a versão atual do Python, execute python3 -V ou python -V. As versões compatíveis são o Python de 3.8 a 3.12.
   • O script de instalação principal oferece a instalação do Python 3.11 do CPython.
   • Caso contrário, para instalar uma versão compatível do Python, acesse as versões do Python para macOS (link em inglês) do Python.org.
   • Se você tem vários intérpretes de Python instalados na sua máquina, defina a variável de ambiente CLOUDSDK_PYTHON no shell para apontar para o caminho do intérprete preferido.
   • Para informações sobre como escolher e configurar o interpretador do Python, consulte gcloud topic startup.
2. Faça o download de um dos seguintes itens:
   Observação: para determinar o nome do hardware da sua máquina, execute uname -m na linha de comando.

Plataforma	Pacote	Tamanho	Soma de verificação SHA256
macOS de 64 bits (x86_64)	google-cloud-cli-471.0.0-darwin-x86_64.tar.gz	124.7 MB	b03ab8e095efa9d4530f541120541c2a212515858ff478ac92a835d9f6307765
macOS de 64 bits (ARM64, Apple M1 silicon)	google-cloud-cli-471.0.0-darwin-arm.tar.gz	121,8 MB	b875070c7a572edc70657e822708890b82d4319142809e8499340d07cdfcdea2
macOS de 32 bits (x86)	google-cloud-cli-471.0.0-darwin-x86.tar.gz	123,4 MB	c1e376e7504ffabda7671a830630e74d3c589e7d58093748e47089ae31d65b0b

1. Extraia o arquivo para qualquer local no seu sistema de arquivos, de preferência no diretório principal. No macOS, isso pode ser feito abrindo o arquivo .tar.gz salvo no local de preferência.

   Para substituir uma instalação, remova o diretório google-cloud-sdk e extraia o arquivo para o mesmo local.

2. (Opcional) Use o script de instalação para adicionar ferramentas da CLI gcloud a PATH. Também é possível ativar a conclusão do comando no shell, coletar estatísticas de uso e instalar o Python 3.11.

   Execute o script (na raiz da pasta extraída na última etapa) usando este comando:

   ./google-cloud-sdk/install.sh
   

   This can also be done non-interactively (for example, using a script) by providing preferences as flags. To describe the available flags, run:

   ./google-cloud-sdk/install.sh --help
   

   To run the install script with screen reader mode on:

   ./google-cloud-sdk/install.sh --screen-reader=true
   

   Open a new terminal so that the changes take effect.
3. To initialize the gcloud CLI, run gcloud init:

./google-cloud-sdk/bin/gcloud init

4. Optional. Install additional components using the component manager.

Windows

The Google Cloud CLI works on Windows 8.1 and later and Windows Server 2012 and later.

1. Download the Google Cloud CLI installer.

   Alternatively, open a PowerShell terminal and run the following PowerShell commands:

   (New-Object Net.WebClient).DownloadFile("https://dl.google.com/dl/cloudsdk/channels/rapid/GoogleCloudSDKInstaller.exe", "$env:Temp\GoogleCloudSDKInstaller.exe")
   
   & $env:Temp\GoogleCloudSDKInstaller.exe
       

2. Inicie o instalador e siga os prompts. O instalador é assinado pela Google LLC.

   Se você estiver usando um leitor de tela, marque a caixa de seleção Ativar modo leitor de tela. Essa opção configura gcloud para usar rastreadores de status em vez de spinners unicode, exibir o progresso como uma porcentagem e nivelar tabelas. Para mais informações, consulte o Guia de recursos de acessibilidade.

3. A CLI do Google Cloud requer Python. As versões compatíveis são o Python de 3.8 a 3.12. Por padrão, a versão para Windows da CLI do Google Cloud vem com o Python 3. Para usar a CLI do Google Cloud, seu sistema operacional precisa executar uma versão compatível do Python.

   O instalador instala todas as dependências necessárias, incluindo a versão necessária do Python. Embora o SDK da CLI do Google Cloud instale e gerencie o Python 3 por padrão, é possível usar uma instalação atual do Python ao desmarcar a opção de instalar o Bundled Python, se necessário. Consulte gcloud topic startup para saber como usar uma instalação existente do Python.

4. Depois que a instalação for concluída, o instalador oferecerá a opção de criar os atalhos do menu e da área de trabalho, iniciar o shell da CLI do Google Cloud e configurar a CLI gcloud. Deixe as opções para iniciar o shell e configurar a instalação selecionadas. O instalador inicia uma janela de terminal e executa o comando gcloud init.

5. A instalação padrão não inclui as extensões do App Engine necessárias para implantar um aplicativo usando comandos gcloud. Para instalar esses componentes, use o gerenciador de componentes da CLI gcloud.

Dicas de solução de problemas:

• Se a instalação não for bem-sucedida devido ao comando find não ter sido reconhecido, verifique se sua variável de ambiente PATH está definida para incluir a pasta que contém find. Geralmente, isso é C:\WINDOWS\system32;.
• Se você desinstalou a CLI gcloud, é necessário reinicializar o sistema antes de instalá-la novamente.
• Se a descompactação falhar, execute o instalador como um administrador.

Execute as atualizações com o comando components update: gcloud components update.

Como configurar credenciais para acessar dados protegidos

Para acessar dados protegidos ou gravar em um bucket protegido, é necessário configurar as credenciais (autenticar). Por exemplo, se outra pessoa criou uma conta do Cloud Storage e fez upload de dados que só podem ser acessados por você ou por outras pessoas específicas, configure suas credenciais para que o serviço do Cloud Storage consiga acessar esses dados.

Ao usar o gsutil como parte da CLI do Google Cloud, o OAuth2 é usado para autenticar e autorizar o acesso aos recursos do Cloud Storage. Para estabelecer o acesso, execute o comando gcloud init e siga as instruções fornecidas na linha de comando, que incluem o login na sua conta de usuário. Se você seguiu as etapas de instalação acima, provavelmente já fez essa configuração. Se você executou gcloud init anteriormente, ao executar o comando novamente, será perguntado se quer reinicializar a configuração ou criar uma nova. Para mais informações, consulte Inicializar a Google Cloud CLI.

Isso é tudo! Já é possível acessar os dados protegidos. Para ver uma lista de comandos gsutil, digite gsutil no prompt de comando.

Solução de problemas

Se você tentar autenticar o gsutil usando o comando gcloud init, mas ainda não conseguir acessar os buckets ou objetos esperados, seu sistema poderá ter a versão legada e autônoma do gsutil e o Google Versão do pacote da CLI do Cloud gsutil instalada. Execute o comando gsutil version -l e verifique o valor de using cloud sdk. Se for False, seu sistema estará usando a versão autônoma da gsutil ao executar comandos. É recomendável remover a versão autônoma da gsutil do sistema. No entanto, você também pode autenticar usando o comando gsutil config -a ou gsutil config -e.

Autenticar com HMAC

O OAuth 2.0 é o meio de autenticação recomendado para o gsutil. No entanto, também é possível usar chaves HMAC como credenciais. Para autenticar com HMAC, use o seguinte comando:

gsutil config -a

Esse comando direciona você para um processo de autenticação em que é solicitado o ID de acesso e o secret associados à sua chave HMAC.

Ao autenticar com chaves HMAC, desative a transmissão de credenciais da CLI do Google Cloud usando o comando: gcloud config set pass_credentials_to_gsutil false.

Ativar o mTLS

Também é possível ativar o TLS mútuo (mTLS, na sigla em inglês). Quando o mTLS está ativado no dispositivo, ele tenta se conectar a storage.mtls.googleapis.com. Antes que a conexão seja permitida, o Cloud Storage verifica o certificado no dispositivo.

Observação: esse recurso só funciona quando a gsutil faz solicitações pela API JSON do Cloud Storage.

A maneira mais simples de conseguir um certificado é pela CLI do Google Cloud. É possível definir um manualmente no arquivo .boto definindo os seguintes valores em "Credentials":

1. use_client_certificate: uma sinalização que controla se o mTLS será usado ou não
2. cert_provider_command: um comando de shell que imprime um certificado no stdout para que a gsutil leia.

Faça um teste

Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho do Cloud Storage em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

Faça uma avaliação gratuita do Cloud Storage