La función Abrir en Cloud Shell te permite publicar un vínculo que abre la consola de Google Cloud con un repositorio de Git clonado en Cloud Shell o 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 para abrir en Cloud Shell ayudan a los desarrolladores a experimentar con tus muestras de código y APIs sin tener que descargar Google Cloud CLI, instalar las dependencias obligatorias ni buscar archivos de origen relevantes. En esta página, se explica cómo agregar un vínculo Abrir en Cloud Shell a tu repositorio de Git.
Parámetros de URL
El vínculo Abrir en Cloud Shell, incorporado opcionalmente en una imagen de botón, se puede agregar 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ámetro de URL obligatorio
Para crear este vínculo, usa una URL base de shell.cloud.google.com (o cualquier página en la consola de Google Cloud que comience con console.cloud.google.com) con el siguiente parámetro de URL obligatorio:
| Parámetro de URL | Descripción | Valores admitidos |
|---|---|---|
cloudshell_git_repo |
URL del repositorio de Git a clonar. Después de clonar el repositorio, se abre la raíz de la carpeta del proyecto y se muestra su contenido en el panel de navegación de la izquierda. |
URL válida para un repositorio de Git. Esta URL consta de un dominio permitido (GitHub o Bitbucket) y una ruta. Se permiten los siguientes caracteres: letras mayúsculas y minúsculas, dígitos, guiones bajos (_), guiones (-), puntos (.) y barras (/). |
Parámetros de URL opcionales
También puedes especificar cualquiera de los siguientes parámetros opcionales:
| Parámetro de URL | Descripción | Valores admitidos |
|---|---|---|
cloudshell_git_branch
|
Es la rama del repositorio de Git que se va a 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 (.), barras (/) y dos puntos (:). |
cloudshell_image
|
Es la imagen de Docker personalizada que se ejecuta en 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. Si abres un repositorio en Cloud Shell con este parámetro especificado, se crea un entorno temporal con un directorio principal nuevo 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. Para crear una imagen válida, usa el instructivo de creación de imágenes personalizadas que se puede iniciar ejecutando el siguiente comando en Cloud Shell:
Ten en cuenta que las imágenes grandes tardan un tiempo en descargarse en la VM de Cloud Shell cuando se abre la URL. |
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 abrirán en el orden establecido. Los archivos especificados se abrirán 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 tratará como relacionada con working_dir. |
Cualquier ruta de acceso de archivo válida que conste de los siguientes caracteres permitidos: letras mayúsculas y minúsculas, dígitos, virgulillas (~), guiones bajos (_), guiones (-), puntos (.), 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 tratará como relacionada con working_dir. |
Cualquier ruta de acceso de archivo válida que conste de los siguientes caracteres permitidos: letras mayúsculas y minúsculas, dígitos, virgulillas (~), guiones bajos (_), guiones (-), puntos (.), 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. |
cloudshell_working_dir (Obsoleto)
|
Este parámetro está obsoleto. En su lugar, usa |
Cualquier ruta de acceso de archivo válida que conste de los siguientes caracteres permitidos: letras mayúsculas y minúsculas, dígitos, virgulillas (~), guiones bajos (_), guiones (-), puntos (.), barras diagonales (/) y dos puntos (:). |
cloudshell_workspace
|
Es el directorio de trabajo de Cloud Shell. La terminal se abrirá en el directorio especificado. El editor de Cloud Shell abre el directorio como un lugar de trabajo. | Cualquier ruta de acceso 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 un repositorio, la ruta de acceso se refiere al directorio principal de Cloud Shell. Se permiten los siguientes caracteres: letras mayúsculas y minúsculas, dígitos, virgulillas (~), guiones bajos (_), guiones (-), puntos (.), barras (/) y dos puntos (:).
|
ephemeral |
Si abres un repositorio en Cloud Shell con este parámetro especificado, se crea un entorno temporal con un directorio principal nuevo que se borra cuando finaliza la sesión. Para obtener más información, consulta Elige el modo efímero. |
|
show
|
Abre solo la terminal, solo el editor de Cloud Shell o ambos. |
|
Ejemplos
Para incorporar un botón que abra un repositorio de Git de ejemplo en Cloud Shell, incluye el siguiente código Markdown en el archivo README.md de tu repositorio:
[](https://shell.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 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 en el generador de vínculos de Cloud Shell
Para definir el comportamiento del vínculo Abrir en Cloud Shell de manera más específica, puedes usar el formulario que se encuentra a continuación para experimentar con los parámetros necesarios para abrir tu repositorio en Cloud Shell.