Abre en Cloud Shell

La característica Abrir en Cloud Shell te permite publicar un vínculo que abre Google Cloud Console con un repositorio de Git clonado en Cloud Shell o que inicia Cloud Shell con una imagen personalizada. También puedes imprimir instrucciones en la terminal para ayudar a los usuarios a interactuar con el contenido.

Los vínculos abiertos en Cloud Shell ayudan a los desarrolladores a experimentar con tus muestras de código y API sin tener que descargar el SDK de Cloud, instalar las dependencias requeridas o buscar archivos fuente relevantes. En esta página, se explica cómo agregar un vínculo Open in Cloud Shell a tu repositorio de Git.

Parámetros de URL

Se puede agregar un vínculo Abrir en Cloud Shell, opcionalmente incorporado en una imagen de botón, al archivo README.md de cualquier directorio en tu repositorio de Git. La ubicación recomendada para este vínculo es el archivo README.md raíz de tu repositorio de Git.

Parámetros obligatorios

Para crear este vínculo, deberás usar una URL base de ssh.cloud.google.com (o cualquier página de Cloud Console que comience con console.cloud.google.com) con al menos uno de los siguientes parámetros de URL:

Parámetro de URL Descripción Valores admitidos
cloudshell_git_repo

URL del repositorio de Git a clonar.

Una vez que se clona el repositorio, se abre la raíz de la carpeta del proyecto y se muestra su contenido en el panel de navegación izquierdo.

URL válida para un repositorio de Git.

Esta URL consta de un dominio permitido (GitHub o Bitbucket) y una ruta de acceso. Se permiten los siguientes caracteres: letras mayúsculas y minúsculas, dígitos, guiones bajos (_), guiones (-), puntos (.) y barras diagonales (/).

cloudshell_image

Imagen personalizada de Docker que ejecuta un entorno personalizado durante la sesión. Esto te permite proporcionar herramientas personalizadas en Cloud Shell que los usuarios pueden usar para trabajar con tu repositorio.

Cuando se abre un repositorio en Cloud Shell con este parámetro especificado, se crea un entorno temporal con un directorio principal inicial que se borra cuando finaliza la sesión.

URL de una imagen de Docker alojada en Container Registry. La imagen de Docker debe basarse en la imagen base de Cloud Shell y ser de acceso público.

Si deseas crear una imagen válida, usa el instructivo de creación de imágenes personalizadas que puede iniciarse si ejecutas el siguiente comando en Cloud Shell:

cloudshell launch-tutorial /google/devshell/tutorials/custom-image-tutorial.md

Ten en cuenta que las imágenes grandes tardan un tiempo en descargarse en la VM de Cloud Shell cuando se abre la URL.

Parámetros opcionales

También puedes especificar cualquiera de los siguientes parámetros opcionales:

Parámetro de URL Descripción Valores admitidos

cloudshell_git_branch

Rama del repositorio de Git para clonar. Solo es aplicable cuando se especifica cloudshell_git_repo. La rama predeterminada es principal. Cualquier rama válida en el repositorio. Se permiten los siguientes caracteres: letras mayúsculas y minúsculas, dígitos, virgulillas (~), guiones bajos (_), guiones (-), puntos (.) y barras diagonales (/) y dos puntos (:).

cloudshell_workspace

Directorio de trabajo para Cloud Shell. Se abrirá la terminal en el directorio especificado. El editor de Cloud Shell abre el directorio como un lugar de trabajo. Cualquier ruta de archivo válida en relación con el repositorio clonado. Puedes dejar el valor del parámetro vacío o usar '.' para especificar la raíz del repositorio clonado. Si no se especifica ningún repositorio, la ruta de acceso se relaciona con el directorio principal de Cloud Shell. Se permiten los siguientes caracteres: letras mayúsculas y minúsculas, dígitos, virgulillas (~), guiones bajos (_), guiones (-), puntos (.) y barras diagonales (/) y dos puntos. (:).

cloudshell_open_in_editor

Archivos que se abrirán en el Editor de Cloud Shell. Se puede repetir a fin de especificar la apertura de varios archivos. Si se especifican varios, se abren en el orden proporcionado.

Los archivos especificados se abren en las pestañas del editor de la derecha, una pestaña por archivo, en el proyecto abierto.

Las rutas de archivos están relacionadas con el directorio actual. Si se proporciona el parámetro working_dir, la ruta a estos archivos se trata como relativa a working_dir.

Cualquier ruta de archivo válida compuesta por los siguientes caracteres permitidos: letras mayúsculas y minúsculas, dígitos, virgulillas (~), guiones bajos (_), guiones (-), puntos (.) y barras diagonales (/). y dos puntos (:).

cloudshell_print

Archivo en el repositorio de Git que, por lo general, consta de instrucciones que deben imprimirse en la terminal, a fin de guiar los siguientes pasos del usuario. La ruta del archivo está relacionada con el directorio actual.

Si se proporciona el parámetro working_dir, la ruta a este archivo se trata como relacionada con working_dir.

Cualquier ruta de archivo válida compuesta por los siguientes caracteres permitidos: letras mayúsculas y minúsculas, dígitos, virgulillas (~), guiones bajos (_), guiones (-), puntos (.) y barras diagonales (/). y dos puntos (:).

cloudshell_tutorial

Archivo del instructivo en Markdown en el repositorio de Git, que consta de instrucciones que se iniciarán como un instructivo para guiar a los usuarios a través de un proyecto. La ruta del archivo está relacionada con el directorio actual.

Cualquier archivo de un instructivo en Markdown, con un formato correcto y un nombre de archivo válido.

shellonly

Abra solo con la línea de comando (y no con el editor).

true, false

cloudshell_working_dir (obsoleto)

Directorio que se abre como lugar de trabajo en el editor de Cloud Shell Cualquier ruta de archivo válida compuesta por los siguientes caracteres permitidos: letras mayúsculas y minúsculas, dígitos, virgulillas (~), guiones bajos (_), guiones (-), puntos (.) y barras diagonales (/). y dos puntos (:).

Ejemplos

Si deseas incorporar un botón para abrir un repositorio de Git de muestra en Cloud Shell, incluye el siguiente Markdown en el archivo README.md de tu repositorio:

[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git)

Para incorporar la misma funcionalidad en un sitio web, usa este fragmento HTML equivalente:

<a href="https://ssh.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>

A fin de definir el comportamiento del vínculo Abrir en Cloud Shell de manera más específica, puedes usar el siguiente formulario para experimentar con los parámetros necesarios a fin de abrir tu repositorio en Cloud Shell.