A funcionalidade Abrir no Cloud Shell permite-lhe publicar um link que abre a Google Cloud consola com um repositório Git clonado no Cloud Shell e/ou inicia o Cloud Shell com uma imagem personalizada. Também pode imprimir instruções no terminal para ajudar os utilizadores a interagir com o conteúdo.
Os links Abrir no Cloud Shell ajudam os programadores a experimentar os seus exemplos de código e APIs sem terem de transferir a CLI Google Cloud, instalar as dependências necessárias ou pesquisar ficheiros de origem relevantes. Esta página explica como adicionar um link Abrir no Cloud Shell ao seu repositório Git.
Parâmetros de URL
Pode adicionar um link Abrir no Cloud Shell, opcionalmente incorporado numa imagem de botão, ao ficheiro README.md de qualquer diretório no seu repositório Git. A localização recomendada para este link é o ficheiro README.md raiz do seu repositório Git.
Parâmetro de URL obrigatório
Para criar este link, use um URL de base de shell.cloud.google.com (ou qualquer página na
consola Google Cloud que comece por console.cloud.google.com) com
o seguinte parâmetro de URL obrigatório:
| Parâmetro de URL | Descrição | Valores suportados |
|---|---|---|
cloudshell_git_repo |
URL do repositório Git a clonar. Depois de o repositório ser clonado, a raiz da pasta do projeto é aberta, apresentando o respetivo conteúdo no painel de navegação do lado esquerdo. |
URL válido para um repositório Git. Este URL consiste num domínio permitido (GitHub ou Bitbucket) e num caminho. São permitidos os seguintes carateres: letras maiúsculas e minúsculas, dígitos, sublinhados (_), hífenes (-), pontos finais (.) e barras (/). Apenas os repositórios listados pertencentes à Google são abertos no ambiente do Cloud Shell predefinido e têm acesso às credenciais do utilizador. Todos os outros repositórios usam um ambiente do Cloud Shell temporário sem acesso às credenciais do utilizador. |
Parâmetros de URL opcionais
Também pode especificar qualquer um dos seguintes parâmetros opcionais:
| Parâmetro de URL | Descrição | Valores suportados |
|---|---|---|
cloudshell_git_branch
|
Ramo do repositório Git a clonar. Aplicável apenas quando cloudshell_git_repo é especificado. O ramo predefinido é master. | Qualquer ramo válido no repositório. Os seguintes carateres são permitidos: letras maiúsculas e minúsculas, dígitos, tis (~), sublinhados (_), hífenes (-), pontos finais (.), barras (/) e dois pontos (:). |
cloudshell_image
|
Imagem Docker personalizada que executa um ambiente personalizado durante a sessão. Isto permite-lhe fornecer ferramentas personalizadas no Cloud Shell que os utilizadores podem usar para trabalhar com o seu repositório. A abertura de um repositório no Cloud Shell com este parâmetro especificado cria um ambiente temporário com um diretório inicial temporário que é eliminado quando a sessão termina. |
URL de uma imagem de Docker alojada no Artifact Registry. A imagem Docker tem de se basear na imagem base do Cloud Shell e ser acessível publicamente. Para criar uma imagem válida, use o tutorial de criação de imagens personalizadas que pode ser iniciado executando o seguinte comando na Cloud Shell:
Tenha em atenção que as imagens grandes demoram algum tempo a ser transferidas para a VM do Cloud Shell quando o URL é aberto. |
cloudshell_open_in_editor
|
Ficheiros a abrir no editor do Cloud Shell. Pode ser repetido para especificar vários ficheiros a abrir. Se forem especificados vários, estes são abertos pela ordem indicada. Os ficheiros especificados são abertos nos separadores do editor do lado direito, um separador por ficheiro, no projeto aberto. Os caminhos dos ficheiros são relativos ao diretório atual. Se o parâmetro working_dir for fornecido, o caminho para estes ficheiros é tratado como relativo a working_dir. |
Qualquer caminho de ficheiro válido que consista nos seguintes carateres permitidos: letras maiúsculas e minúsculas, dígitos, tis (~), sublinhados (_), hífenes (-), pontos finais (.), barras (/) e dois pontos (:). |
cloudshell_print
|
Ficheiro no repositório Git, que consiste normalmente em instruções a serem impressas no terminal para orientar os passos seguintes de um utilizador. O caminho do ficheiro é relativo ao diretório atual. Se o parâmetro working_dir for fornecido, o caminho para este ficheiro é tratado como relativo a working_dir. |
Qualquer caminho de ficheiro válido que consista nos seguintes carateres permitidos: letras maiúsculas e minúsculas, dígitos, tis (~), sublinhados (_), hífenes (-), pontos finais (.), barras (/) e dois pontos (:). |
cloudshell_tutorial
|
Ficheiro Tutorial Markdown no repositório Git com instruções a serem iniciadas como um tutorial para orientar os utilizadores num projeto. O caminho do ficheiro é relativo ao diretório atual. |
Qualquer ficheiro Markdown de tutorial bem formado com um nome de ficheiro válido. |
cloudshell_working_dir (Descontinuado)
|
Este parâmetro foi descontinuado. Em alternativa, use
|
Qualquer caminho de ficheiro válido que consista nos seguintes carateres permitidos: letras maiúsculas e minúsculas, dígitos, tis (~), sublinhados (_), hífenes (-), pontos finais (.), barras (/) e dois pontos (:). |
cloudshell_workspace
|
Diretório de trabalho do Cloud Shell. O terminal é aberto no diretório especificado. O Editor do Cloud Shell abre o diretório como um espaço de trabalho. | Qualquer caminho do ficheiro válido relativo ao repositório clonado. Pode deixar o valor do parâmetro vazio ou usar . para especificar a raiz do repositório clonado. Se não for especificado nenhum repositório, o caminho é relativo ao diretório base do Cloud Shell. São permitidos os seguintes carateres: letras maiúsculas e minúsculas, dígitos, tis (~), sublinhados (_), hífenes (-), pontos finais (.), barras (/) e dois pontos (:).
|
ephemeral |
A abertura de um repositório no Cloud Shell com este parâmetro especificado cria um ambiente temporário com um diretório inicial temporário que é eliminado quando a sessão termina. Para mais informações, consulte a secção Escolher o modo efémero. |
|
show
|
Abra apenas com o terminal, apenas com o editor do Cloud Shell ou com ambos. |
|
Exemplos
Para incorporar um botão para abrir um repositório Git de exemplo no Cloud Shell, inclua o seguinte Markdown no ficheiro 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 num Website, use este fragmento de 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 forma mais específica, pode usar o formulário abaixo para experimentar os parâmetros necessários para abrir o seu repositório no Cloud Shell.