O recurso "Abrir no Cloud Shell" permite publicar um link que abre o console do Google Cloud com um repositório Git clonado para o Cloud Shell e/ou inicia o Cloud Shell com uma imagem personalizada. Você também pode imprimir instruções no terminal para ajudar os usuários a interagir com o conteúdo.
Os links de abertura no Cloud Shell ajudam os desenvolvedores a testar seus exemplos de código e APIs sem precisar fazer o download da Google Cloud CLI, instalar as dependências necessárias ou pesquisar arquivos de origem relevantes. Esta página explica como adicionar um link "Abrir no Cloud Shell" ao seu repositório Git.
Parâmetros de URL
Um link "Abrir no Cloud Shell", incorporado opcionalmente em uma imagem de botão, pode ser adicionado ao arquivo README.md de qualquer diretório no seu repositório Git. O local recomendado para este link é o arquivo README.md raiz do seu repositório Git.
Parâmetro de URL obrigatório
Para criar esse link, use um URL de base de shell.cloud.google.com (ou qualquer página no
console do Google Cloud que comece com console.cloud.google.com) com
o seguinte parâmetro de URL obrigatório:
| Parâmetro do URL | Descrição | Valores compatíveis |
|---|---|---|
cloudshell_git_repo |
URL do repositório Git para clonagem. Depois que o repositório for clonado, a raiz da pasta do projeto será aberta, exibindo o conteúdo no painel de navegação à esquerda. |
URL válido para um repositório Git. Esse URL consiste em um domínio permitido (GitHub ou Bitbucket) e um caminho. Os seguintes caracteres são permitidos: letras maiúsculas e minúsculas, dígitos, sublinhados (_), hífens (-), pontos (.) e barras (/). |
Parâmetros de URL opcionais
Também é possível especificar qualquer um dos seguintes parâmetros opcionais:
| Parâmetro do URL | Descrição | Valores compatíveis |
|---|---|---|
cloudshell_git_branch
|
Ramificação do repositório Git para clonar. Aplicável apenas quando cloudshell_git_repo é especificado. O branch padrão é mestre. | Qualquer branch válido no repositório. Os seguintes caracteres são permitidos: letras maiúsculas e minúsculas, dígitos, tils (~), sublinhados (_), hifens (-), pontos (.), barras (/) e dois-pontos (:). |
cloudshell_image
|
Imagem personalizada do Docker que executa um ambiente personalizado durante a sessão. Isso permite que você forneça ferramentas personalizadas no Cloud Shell para os usuários trabalharem com seu repositório. Abrir um repositório no Cloud Shell com esse parâmetro especificado cria um ambiente temporário com um diretório inicial de rascunho que é excluído quando a sessão termina. |
URL de uma imagem do Docker hospedada no Container Registry. A imagem do Docker precisa ser baseada na imagem básica do Cloud Shell e ser acessível publicamente. Para criar uma imagem válida, use o tutorial de criação de imagem personalizado que pode ser iniciado executando o seguinte comando no Cloud Shell:
As imagens grandes levam algum tempo para serem transferidas para a VM do Cloud Shell quando o URL é aberto. |
cloudshell_open_in_editor
|
Arquivos a serem abertos no editor do Cloud Shell. Pode ser repetido para especificar vários arquivos a serem abertos. Se forem especificados diversos arquivos, eles são abertos na ordem solicitada. Os arquivos especificados são abertos nas guias do editor no canto direito (uma guia por arquivo), dentro do projeto aberto. Os caminhos dos arquivos são relativos ao diretório atual. Se o parâmetro working_dir for fornecido, o caminho para esses arquivos são tratado como relativo ao working_dir. |
Qualquer caminho de arquivo válido que consista nos seguintes caracteres permitidos: letras maiúsculas e minúsculas, dígitos, tils (~), sublinhados (_), hifens (-), pontos (.), barras (/) e dois pontos (:). |
cloudshell_print
|
Arquivo no repositório Git que geralmente contém instruções para serem impressas no terminal a fim de orientar os próximos passos do usuário. O caminho do arquivo é relativo ao diretório atual. Se o parâmetro working_dir for fornecido, o caminho para este arquivo é tratado como relativo ao working_dir. |
Qualquer caminho de arquivo válido que consista nos seguintes caracteres permitidos: letras maiúsculas e minúsculas, dígitos, tils (~), sublinhados (_), hifens (-), pontos (.), barras (/) e dois pontos (:). |
cloudshell_tutorial
|
Arquivo Tutorial Markdown no repositório Git que consiste de instruções a serem lançadas como um tutorial para orientar usuários em um projeto. O caminho do arquivo é relativo ao diretório atual. |
Qualquer arquivo Tutorial Markdown formatado corretamente e com um nome de arquivo válido. |
cloudshell_working_dir (Uso suspenso)
|
Este parâmetro está obsoleto. Use
|
Qualquer caminho de arquivo válido que consista nos seguintes caracteres permitidos: letras maiúsculas e minúsculas, dígitos, tils (~), sublinhados (_), hifens (-), pontos (.), barras (/) e dois pontos (:). |
cloudshell_workspace
|
Diretório de trabalho para o Cloud Shell. O terminal abre no diretório especificado. O editor do Cloud Shell abre o diretório como um espaço de trabalho. | Qualquer caminho de arquivo válido relativo ao repositório clonado. Você pode deixar
o valor do parâmetro vazio ou usar . para especificar a raiz do
repositório clonado. Se nenhum repositório for especificado, o caminho será relativo ao diretório inicial do Cloud Shell. Os seguintes caracteres são permitidos: letras maiúsculas e minúsculas, dígitos, tils (~), sublinhados (_), hífens (-), pontos (.), barras (/) e dois-pontos. (:)
|
ephemeral |
Abrir um repositório no Cloud Shell com esse parâmetro especificado cria um ambiente temporário com um diretório inicial de rascunho que é excluído quando a sessão termina. Para mais informações, consulte Como escolher o modo temporário. |
|
show
|
Abra apenas o terminal, apenas o editor do Cloud Shell ou ambos. |
|
Exemplos
Para incorporar um botão para abrir um repositório Git de amostra no Cloud Shell, inclua o seguinte Markdown no arquivo README.md do seu repositório:
[](https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git)
Para incorporar a mesma funcionalidade em um site, use este snippet HTML equivalente:
<a href="https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git">
<img alt="Open in Cloud Shell" src ="https://gstatic.com/cloudssh/images/open-btn.svg">
</a>
Abrir no gerador de links do Cloud Shell
Para definir o comportamento do link "Abrir no Cloud Shell" de maneira mais específica, use o formulário abaixo para testar os parâmetros necessários para abrir o repositório no Cloud Shell.