Como desenvolver com o Cloud Shell e Cloud Code

1. Visão geral

O Cloud Shell é um ambiente de desenvolvimento e operações on-line acessível por um navegador em qualquer lugar. É possível gerenciar os recursos com este terminal on-line pré-carregado com utilitários como a ferramenta de linha de comando gcloud, kubectl e muito mais. Também é possível desenvolver, criar, depurar e implantar apps baseados na nuvem usando o Editor do Cloud Shell on-line.

Neste laboratório, você vai trabalhar com o Cloud Shell e o editor do Cloud Shell, criando, implantando e testando aplicativos baseados em contêineres usando o Cloud Code em emuladores locais e nos serviços reais.

O que você vai aprender

Navegar e conhecer os principais recursos do Cloud Shell
Praticar com diferentes padrões de uso do Cloud Shell
Personalizar o ambiente shell do Cloud Shell para uso avançado
Conhecer as opções e os recursos do Cloud Code
Conhecer os detalhes do Cloud Code para aplicativos do Kubernetes
Usar emuladores locais, como o Minikube

Pré-requisitos

Você vai precisar de um projeto do GCP com permissões de editor, uma conta do GCP e acesso ao Cloud Shell.
Para as partes opcionais, você vai precisar de um emulador de terminal e do SDK Google Cloud instalado.

2. Configuração e requisitos

Configuração de ambiente personalizada

Faça login no Console do Google Cloud e crie um novo projeto ou reutilize um existente. Crie uma conta do Gmail ou do Google Workspace, se ainda não tiver uma.

O Nome do projeto é o nome de exibição para os participantes do projeto. É uma string de caracteres não usada pelas APIs do Google É possível atualizar o local a qualquer momento.
O ID do projeto precisa ser exclusivo em todos os projetos do Google Cloud e não pode ser mudado após a definição. O console do Cloud gera automaticamente uma string exclusiva. Em geral, não importa o que seja. Na maioria dos codelabs, é necessário fazer referência ao ID do projeto, normalmente identificado como PROJECT_ID. Se você não gostar do ID gerado, crie outro aleatório. Se preferir, teste o seu e confira se ele está disponível. Ele não pode ser mudado após essa etapa e permanece durante o projeto.
Para sua informação, há um terceiro valor, um Número do projeto, que algumas APIs usam. Saiba mais sobre esses três valores na documentação.

Em seguida, ative o faturamento no console do Cloud para usar os recursos/APIs do Cloud. A execução deste codelab não será muito cara, se tiver algum custo. Para encerrar os recursos e evitar cobranças além deste tutorial, exclua os recursos criados ou o projeto inteiro. Novos usuários do Google Cloud estão qualificados para o programa de US$ 300 de avaliação sem custos.

3. Como trabalhar com o terminal do Cloud Shell

Nesta seção, você vai aprender sobre o terminal do Cloud Shell, como navegar na interface, usar os recursos e conhecer as opções de configuração e as diferentes maneiras de usar o terminal para aumentar sua produtividade.

O Cloud Shell tem duas ferramentas principais: o terminal do Cloud Shell e o editor do Cloud Shell. Neste laboratório, os termos "terminal do Cloud Shell" e "Cloud Shell" serão usados de forma intercambiável. No entanto, o editor sempre será chamado de "Editor do Cloud Shell" para fazer uma distinção clara entre o emulador de terminal e o ambiente de desenvolvimento integrado (IDE, na sigla em inglês).

O Cloud Shell é um shell totalmente funcional baseado na nuvem criado em uma máquina Linux efêmera baseada em Debian do Google Compute Engine, que está sempre disponível para uso. Ele vem com o SDK do Google Cloud instalado e várias ferramentas relevantes, como git, kubectl, kubectx, curl, python3, tmux...

O diretório $HOME é mantido no Cloud Storage pelo Google Cloud e montado automaticamente sempre que a máquina do Cloud Shell é iniciada. Assim, você não perde nenhuma informação deixada nele, mesmo que a máquina do Cloud Shell seja desligada. Isso significa que, se você ativar o Cloud Shell novamente, o diretório $HOME e qualquer personalização feita nele estarão disponíveis para uso.

como iniciar o Cloud Shell;

Acesse console.cloud.google.com e, se ainda não tiver feito login no console do GCP, insira suas credenciais do Google. A interface principal do Console do Google Cloud Platform vai aparecer.
Selecione o ID do projeto do GCP com que você vai trabalhar no seletor da barra de menu do Console do Cloud:

Encontre o botão para ativar o Cloud Shell no lado direito da barra de menus, ao lado do avatar da sua conta:

Clique no ícone do Cloud Shell para abrir o terminal. Um novo painel vai aparecer logo abaixo da interface do console do GCP:

Nesse painel, você tem o que é chamado de terminal do Cloud Shell.

Acesse o terminal do Cloud Shell e observe que, como você selecionou o ID do projeto do GCP correto no console do GCP, o Cloud Shell sabe disso e não é necessário especificá-lo novamente:

echo $GOOGLE_CLOUD_PROJECT

Isso vai gerar o ID do projeto do GCP, que também aparece no prompt do Cloud Shell.

Alternar entre ferramentas

O Cloud Shell oferece várias ferramentas e opções de configuração. Revise-as nas opções disponíveis no menu do Cloud Shell:

Clique no botão na barra para maximizar o terminal do Cloud Shell e ocupar todo o espaço da guia do navegador:

O Cloud Shell maximiza e ocupa todo o espaço da guia do navegador:

Clique nele de novo. O espaço da guia do navegador volta a ser compartilhado entre o console do Cloud e o Cloud Shell.

Abrir novas guias

O terminal do Cloud Shell permite abrir quantas guias forem necessárias.

Clique no botão a seguir e abra uma nova guia.

Agora feche a nova guia clicando no "x" ao lado do nome dela ou digitando exit no shell correspondente:

Abrir uma nova janela

Abrir o Cloud Shell em uma nova janela do navegador permite ter o console do Cloud em uma janela e o Cloud Shell em outra.

Clique no botão a seguir e observe como o Cloud Shell é aberto em uma nova guia do navegador:

O Cloud Shell agora oferece as mesmas opções de barra de ferramentas, mas com uma aparência um pouco diferente:

Permaneça nessa nova guia do navegador durante as próximas seções.

Transferir sessões com o Tmux

O Cloud Shell vem com o tmux incluído. O Tmux é um multiplexador de terminal muito conhecido, semelhante ao GNU Screen. A integração com o tmux permite que o Cloud Shell preserve sua sessão, não importa onde você esteja.

Nas etapas a seguir, você vai praticar esse conceito para entender melhor o recurso.

Mover o terminal do Cloud Shell

Na guia do Cloud Shell que você acabou de abrir, digite o comando top:

O comando "top" fornece uma visualização em tempo real dos processos em execução no terminal do Cloud Shell. Você vai usá-lo para visualizar a permanência da sessão no Cloud Shell fornecida pelo tmux.

Volte para a primeira guia do navegador (aquela em que o console do Cloud está).
Como você decidiu abrir o Cloud Shell em uma nova janela, há uma mensagem dizendo "Your session was transferred to another browser tab. You can disable this from the "Tmux Settings" option in the Cloud Shell settings menu.".
Clique no botão de reconexão:

Você terá acesso ao shell que estava sendo executado na segunda guia, e o comando "top" continuará sendo executado aqui da mesma forma que você o deixou.

Navegue até a segunda guia do navegador, onde você abriu o Cloud Shell em uma nova janela.
Clique em Reconectar. Você vai recuperar o processo principal exatamente como ele estava sendo executado antes de fecharmos a janela.

Dividir janelas com o tmux

O Tmux é muito mais útil do que você acabou de usar. Um tutorial do tmux está fora do escopo deste laboratório. Encontre mais informações sobre ele no guia oficial de primeiros passos do tmux.

No entanto, o tmux oferece ao Cloud Shell alguns recursos extras que são possíveis em emuladores de terminal local. Para demonstrar um, faça uma divisão lado a lado do terminal.

No Cloud Shell, pressione Ctrl + b e %.
Observe como o tmux cria um novo painel à direita do original:

Clique no segundo painel e digite exit.

Usar a visualização da Web

O Cloud Shell também pode estabelecer o encaminhamento automático de portas da máquina do Cloud Shell em execução na nuvem pelo navegador local em execução no computador.

Digite no Cloud Shell:

python3 -m http.server 8080

Acesse a opção Visualização da Web no canto superior direito e selecione Visualizar na porta 8080:

Uma nova guia será aberta com a página padrão veiculada nessa porta.

É possível mudar a porta e fazer uma prévia de qualquer porta que seu aplicativo esteja expondo no Cloud Shell, não apenas a porta 8080.

Como acessar outras opções do Cloud Shell

Há outras configurações e opções disponíveis no Cloud Shell.

Clique nos três pontos no menu do Cloud Shell para acessar as opções:

As opções mais relevantes aqui são a possibilidade de fazer upload ou download de arquivos para o Cloud Shell e reiniciar a máquina do Cloud Shell caso você tenha algum problema.

4. Como trabalhar com o editor do Cloud Shell

Um dos recursos mais importantes do Cloud Shell é o editor do Cloud Shell. É um ambiente de desenvolvimento integrado completo baseado no projeto de código aberto Eclipse Theia e com contribuições do Google, entre outros. A aparência é muito semelhante ao VSCode, já que ambos usam vários componentes de base de código aberto comuns, como o editor Monaco, o modelo de extensão, o protocolo de servidor de linguagem e o protocolo de adaptador de depuração.

Como o Theia/editor do Cloud Shell é uma ferramenta bastante complexa, descrever todos os recursos do editor do Cloud Shell está fora do escopo deste laboratório. Nesta seção, você vai conhecer alguns conceitos básicos e recursos exclusivos disponíveis nessa implementação do Google Cloud.

Como acessar o editor do Cloud Shell

É possível acessar o editor do Cloud Shell de três maneiras diferentes:

Acessar na linha de comando
Acessar pelo menu do Cloud Shell
Acessar um URL no navegador

Siga estas etapas para conhecer esses métodos

Abra o .bashrc na linha de comando com o seguinte comando:

cloudshell edit $HOME/.bashrc

Abra o Cloud Shell no menu clicando no botão Abrir editor : . Isso abre o editor do Cloud Shell e mantém o terminal aberto. Se você quiser ter todo o espaço da guia apenas para o editor do Cloud Shell, clique no botão à direita do botão "Editar" para fechar o terminal. Esses dois botões (Abrir/Fechar editor e Abrir/Fechar terminal) determinam qual das ferramentas está presente na guia do navegador. Pratique clicar nos dois para pegar o jeito.
Invoque o editor do Cloud Shell na barra de URL do navegador digitando ide.cloud.google.com.

Como usar a linha de comando do editor do Cloud Shell

Embora o terminal e o editor do Cloud Shell coexistam na mesma guia do navegador, você pode dispensar o terminal e usar exclusivamente o editor do Cloud Shell, além do terminal disponível nele, para todas as suas necessidades. Isso pode fazer sentido se você estiver acostumado a trabalhar no ambiente de desenvolvimento integrado e conhecer os diferentes atalhos e dinâmicas de painel do VSCode.

Abra o editor do Cloud Shell usando qualquer um dos métodos mencionados acima. Em seguida, acesse o menu "Editor" e selecione Terminal > Novo terminal (ou pressione Ctrl + ` no teclado). Um novo painel de terminal será aberto na parte de baixo do editor do Cloud Shell, que pode ser usado para todas as suas necessidades de shell:

Isso também oferece a opção de gerenciar diferentes painéis de terminal sem precisar usar o gerenciamento de painéis do tmux, como era o caso do terminal do Cloud Shell.

Como personalizar as configurações do Cloud Shell

O Cloud Shell oferece várias opções de personalização, desde aparência e comportamento básico até configuração de inicialização e operação detalhada do terminal do Cloud Shell. Você vai analisar as diferentes opções com alguns detalhes nas seções a seguir.

Acesse o menu do terminal do Cloud Shell e clique no ícone de engrenagem. Várias opções de configuração vão aparecer:

Confira alguns deles:

Temas de cores: você pode usar claro, escuro ou um conjunto de cores personalizadas (básico, como cor da fonte e cor do plano de fundo).
Tamanho do texto: cinco tamanhos de fonte diferentes para escolher
Fonte: Courier New ou Monospace
Copiar configurações: aqui você pode mudar o atalho de teclado para copiar e usar os mesmos atalhos dos emuladores de terminal Linux mais usados.
Teclado: mapeamento da tecla Meta para Alt (por padrão, Meta é ESC) e mapeamento da tecla Alt Gr em alguns SOs.

Como configurar o ambiente do shell

Como um emulador de Terminal que executa um shell em uma máquina Linux baseada em Debian, é possível personalizar o ambiente shell da mesma forma que no Linux. Assim, todos os arquivos de configuração presentes em $HOME (como .bashrc)) serão originados sempre que um novo processo de shell de login for criado.

O Cloud Shell também permite especificar quais ações você quer realizar sempre que a instância do Cloud Shell for iniciada em um arquivo de configuração especial chamado .customize_environment. Leia mais sobre isso na documentação de Personalização do ambiente.

Pratique adicionar algumas configurações ao terminal do Cloud Shell. Acesse o terminal do Cloud Shell e clone o seguinte repositório de exemplo de código:

git clone https://gitlab.com/javiercanadillas/cloud-code-getting-started.git

Este repositório contém exemplos para os dois principais eventos em que você pode querer configurar o Cloud Shell:

Sempre que a instância do Cloud Shell for iniciada, o arquivo $HOME/.customize_environment será lido. O registro de execução desse processo pode ser encontrado em /var/log/customize_environment, e um /google/devshell/customize_environment_done será criado após a execução bem-sucedida.
Sempre que um novo processo de shell é iniciado (nova janela, nova guia etc.), os arquivos de configuração do shell bash regular são lidos.

Para praticar com os dois, siga estas etapas:

Execute o comando a seguir para iniciar as personalizações fornecidas pelo repositório:

cd cloud-code-getting-started
source set_env_cust.sh

Isso configura e ativa as duas opções de personalização mencionadas anteriormente.

Observe o novo prompt de shell. Um script bash originado no arquivo .bash_profile configurou esse novo comando, que é mais curto do que o padrão e inclui informações básicas do Git, como a ramificação extraída ou o status do Git.
Agora há um novo alias code para o comando cloudshell edit, que é mais curto. Use-o para conferir o conteúdo do arquivo .bash_profile:

code $HOME/.bash_profile

Use o comando bat recém-instalado para conferir o conteúdo do arquivo .customize_environment:

bat $HOME/.customize_environment

bat é uma versão aprimorada da ferramenta Unix cat. A saída bat mostra aqui o comando apt install usado para reinstalar hey, uma ferramenta de teste de carga, sempre que uma nova máquina do Cloud Shell é iniciada.

Para testar se tudo está funcionando, clique no menu do Cloud Shell (os três pontos no canto superior direito) e selecione Reiniciar.

Isso permite simular o tempo limite do Cloud Shell e a recriação da instância, garantindo que tudo esteja configurado corretamente.

Como personalizar a imagem de contêiner do Cloud Shell

Com essa opção de personalização, é possível criar uma imagem Docker que funciona como um ambiente Cloud Shell personalizado com pacotes adicionais e configurações personalizadas. A imagem gerada vai criar uma instância do Cloud Shell totalmente efêmera. Portanto, nem a VM do Cloud Shell nem o diretório $HOME anexado a ela vão persistir. No entanto, essa criação de imagem será útil para casos de uso em que você precisa entregar instâncias do Cloud Shell específicas da função a terceiros para que eles possam realizar uma tarefa específica da maneira mais eficiente.

Em vez de personalizar o ambiente como na seção anterior, você vai incorporar as mudanças em uma nova imagem usada para iniciar o Cloud Shell. Isso tem vantagens óbvias, já que o Cloud Shell personalizado será iniciado mais rápido.

Como criar uma nova imagem do Cloud Shell

Para iniciar a criação da imagem de contêiner do Cloud Shell, digite no terminal do Cloud Shell:

cloudshell env create-custom-image custom-cloud-shell
cd custom-cloud-shell

Isso cria um novo diretório no Cloud Shell e um novo repositório do Cloud Source Repositories com o mesmo nome para hospedar seu código. Ele também clona um Dockerfile de exemplo no $HOME/custom-cloud-shell/ directory.

Adicione a linha RUN apt install -y hey à última linha do Dockerfile:

echo "RUN apt install -y hey" >> $HOME/custom-cloud-shell/Dockerfile

Isso configura a mesma personalização que você tinha no .customize_environment, mas em um contêiner.

Crie a imagem localmente:

cloudshell env build-local

Teste a nova imagem executando o seguinte comando:

cloudshell env run

Agora você está em um shell dentro da imagem.

Teste se o comando hey está instalado executando-o:

hey

Quando terminar, digite exit para sair do contêiner:

exit

Envie as mudanças para o Cloud Source Repositories e a imagem para o Container Registry:

git commit -a -m "Initial commit"
git push origin master
cloudshell env push

Testar a nova imagem

Disponibilize a imagem publicamente para que você possa consumi-la:

gsutil iam ch allUsers:objectViewer $(gsutil ls)

Gere um URL que possa ser usado para testar sua instância personalizada publicada do Cloud Shell:

echo "https://ssh.cloud.google.com/cloudshell/editor?cloudshell_image=gcr.io/$GOOGLE_CLOUD_PROJECT/custom-cloud-shell"

Copie o URL de saída e cole em uma nova guia do navegador. A instância personalizada do Cloud Shell será aberta. Observe que, ao acessar a instância, há banners indicando que você está executando no modo temporário completo:

Teste a imagem novamente executando o comando hey

hey

Depois disso, exit a instância efêmera do Cloud Shell, volte à guia em que o Cloud Shell normal foi aberto e clique em Reconectar.

Acessar o Cloud Shell remotamente com SSH

Também é possível usar os recursos do Cloud Shell remotamente no computador local. Isso geralmente envolve dois casos de uso diferentes:

Fazer SSH na máquina do Cloud Shell pelo terminal local
Montar o diretório remoto $HOME do Cloud Shell localmente.

Para isso, é necessário ter o SDK Google Cloud instalado localmente. Também é necessário configurar o ID do projeto e as credenciais específicas que você está usando.

Siga estas etapas em um emulador de terminal na sua máquina local:

Configure o ID do projeto do GCP e faça login com as credenciais correspondentes à organização do Cloud em que você tem o Cloud Shell.

gcloud config set project <your project id>
gcloud auth login

SSH para sua máquina remota do Cloud Shell:

gcloud cloud-shell ssh --authorize-session

Agora você está no Cloud Shell, mas usando os recursos e a configuração do emulador de terminal local. Se o que você usa for compatível com tmux, aproveite outras integrações para ter uma experiência remota melhor.

Monte o diretório inicial do Cloud Shell na sua máquina local.

Embora seja bom poder usar SSH na instância remota do Cloud Shell, é ainda melhor ter o ambiente de desenvolvimento integrado local com acesso ao diretório $HOME remoto do Cloud Shell. Assim, é possível combinar o acesso SSH demonstrado anteriormente com a capacidade de editar o código remoto localmente.

Para fazer isso, na máquina local, primeiro crie um ponto de montagem:

mkdir $HOME/cloudshell

Este é o diretório em que o Cloud Shell será ativado. Agora, para fazer a montagem, verifique se a instância do Cloud Shell está iniciada e digite no terminal local:

$(gcloud cloud-shell get-mount-command $HOME/cloudshell)
cd $HOME/cloudshell

Isso vai buscar o comando de montagem necessário para montar o Cloud Shell localmente e fazer a montagem. O conteúdo do diretório principal do Cloud Shell será montado na sua máquina local.

Agora, você pode abrir um IDE como o VSCode localmente e abrir um espaço de trabalho remoto na nuvem. Ao mesmo tempo, usando o acesso SSH ao Cloud Shell, você pode abrir um painel de Terminal no ambiente de desenvolvimento integrado para ter um terminal remoto integrado ao ambiente de desenvolvimento integrado local.

5. Usando o Cloud Code

O Cloud Code é um plug-in desenvolvido pelo Google que permite aos desenvolvedores trabalhar de maneira mais eficaz com ferramentas baseadas na nuvem. Ele está disponível em vários ambientes de desenvolvimento integrado e editores de código, como VSCode e produtos Jetbrains, e é integrado por padrão ao editor do Cloud Shell para sua conveniência. O Cloud Code inclui muitos recursos úteis para desenvolvedores que você vai praticar nas próximas etapas.

Como encontrar o Cloud Code no editor do Cloud Shell

Usar os botões de acesso rápido

Encontre os quatro botões a seguir no painel esquerdo do editor:

Esses itens de menu permitem fácil acesso e configuração dos serviços do GCP diretamente no editor do Cloud Shell.

Neste laboratório, você vai se concentrar nos clusters do Kubernetes.

Como usar a barra de status

Há duas outras partes do Cloud expostas pela interface do editor do Cloud Shell que são relevantes. Os dois aparecem na barra inferior do editor:

<> Cloud Code: clique aqui para abrir um menu de ações rápidas que você vai usar neste tutorial:
Controlar o minikube: permite controlar o emulador local do Kubernetes, o minikube, com ações básicas, como iniciar ou interromper o cluster.

Como criar uma instância do Minikube

Clique no botão para criar uma instância do Minikube agora.

Como criar um cluster do GKE com o Cloud Code

Clique no ícone Cloud Code - Kubernetes Clusters ( ) à esquerda. Um novo painel chamado CLOUD CODE - KUBERNETES: CLUSTERS vai aparecer à esquerda.
Clique no botão + ao lado de CLOUD CODE - KUBERNETES: CLUSTERS e selecione Google Kubernetes Engine. Também é possível escolher outras opções, como o Minikube que você iniciou antes:

Clique em Criar um novo cluster do GKE. Essa opção vai carregar um novo painel à direita, onde você pode inserir mais informações para criar rapidamente um cluster de desenvolvimento. Siga as instruções no painel e insira as seguintes informações:

Escolher o Autopilot
Selecione sua região (europe-west-1)
Dê ao cluster o nome "dev".

Clique no botão Criar cluster. Isso vai criar um cluster do Autopilot.

O processo de criação do cluster pode levar até cinco minutos. Enquanto o cluster é criado, explore um pouco mais o painel do Kubernetes do Cloud Code.

Conheça o painel do Kubernetes do Cloud Code

Antes, você criou um cluster do Minikube. Quando estiver pronto, o cluster vai aparecer no painel do Kubernetes do Cloud Code com o nome que você deu a ele, minikube:

O cluster vai aparecer como "ATIVO" na interface. Essa configuração está sincronizada com o contexto atual do Kubernetes na linha de comando. .

No painel do Kubernetes do Cloud Code, você pode ver o seguinte:

O arquivo KubeConfig padrão: o Cloud Code lê o arquivo ~/.kube/config do usuário e o usa para se conectar aos clusters do Kubernetes configurados nele, facilitando a navegação. Para editar o arquivo Kubeconfig, passe o cursor sobre a linha Default Kubeconfig e clique no quadrado com a seta saindo ao lado, se quiser.
Uma renderização navegável dos diferentes objetos dos clusters registrados: nesse caso, é possível ver o cluster do Minikube minikube criado antes, com os contextos, namespaces e nós. Expanda alguns dos nós da árvore. Ainda não haverá pods porque você não implantou nenhum aplicativo.

Depois que o novo cluster do GKE estiver funcionando, ele vai aparecer no painel esquerdo junto com o cluster do Minikube minikube. É possível clicar com o botão direito do mouse em qualquer um dos clusters e torná-lo "ativo" ao selecionar o cluster para qualquer uma das ações do Cloud Code que você pode iniciar:

6. Parabéns!

Parabéns, você concluiu o codelab.

Conteúdo abordado

Navegou e se familiarizou com os principais recursos do Cloud Shell
Praticou com diferentes padrões de uso do Cloud Shell
Personalizou o ambiente shell do Cloud Shell para uso avançado
Conheceu as opções e os recursos do Cloud Code
Revisou os detalhes do Cloud Code para aplicativos do Kubernetes
Usar emuladores locais, como o Minikube