La función Abrir en Cloud Shell te permite publicar un enlace que abre la consola con un repositorio de Git clonado en Cloud Shell o que inicia Cloud Shell con una imagen personalizada. Google Cloud También puedes imprimir instrucciones en la terminal para ayudar a los usuarios a interactuar con el contenido.
Los enlaces para abrir en Cloud Shell ayudan a los desarrolladores a experimentar con tus ejemplos de código y APIs sin tener que descargar la CLI de Google Cloud, instalar las dependencias necesarias ni buscar los archivos de origen pertinentes. En esta página se explica cómo añadir un enlace para abrir en Cloud Shell a tu repositorio de Git.
Parámetros de URL
Se puede añadir un enlace "Abrir en Cloud Shell", opcionalmente insertado en una imagen de botón, al archivo README.md de cualquier directorio de tu repositorio de Git. La ubicación recomendada para este enlace es el archivo README.md raíz de tu repositorio de Git.
Parámetro de URL obligatorio
Para crear este enlace, utilice la URL base shell.cloud.google.com (o cualquier página de la consola Google Cloud que empiece por 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 que se va a clonar. Una vez clonado 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 de un repositorio de Git. Esta URL consta de un dominio permitido (GitHub o Bitbucket) y una ruta. Se pueden usar los siguientes caracteres: letras mayúsculas y minúsculas, dígitos, guiones bajos (_), guiones (-), puntos (.) y barras inclinadas (/). Solo se abrirán en el entorno de Cloud Shell predeterminado los repositorios de la lista permitida que sean propiedad de Google, y solo estos tendrán acceso a las credenciales del usuario. Todos los demás repositorios usarán un entorno de Cloud Shell temporal sin acceso a las credenciales del usuario. |
Parámetros de URL opcionales
También puede especificar cualquiera de los siguientes parámetros opcionales:
| Parámetro de URL | Descripción | Valores admitidos |
|---|---|---|
cloudshell_git_branch
|
Rama del repositorio de Git que se va a clonar. Solo se aplica cuando se especifica cloudshell_git_repo. La rama predeterminada es master. | Cualquier rama válida del repositorio. Se pueden usar los siguientes caracteres: letras en mayúsculas y minúsculas, dígitos, virgulillas (~), guiones bajos (_), guiones (-), puntos (.), barras (/) y dos puntos (:). |
cloudshell_image
|
Imagen Docker personalizada que ejecuta un entorno personalizado durante la sesión. De esta forma, puedes proporcionar herramientas personalizadas en Cloud Shell que los usuarios pueden usar para trabajar con tu repositorio. Si se abre un repositorio en Cloud Shell con este parámetro, se crea un entorno temporal con un directorio principal provisional que se elimina cuando finaliza la sesión. |
URL de una imagen de Docker alojada en Artifact 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, sigue el tutorial de creación de imágenes personalizadas, al que puedes acceder ejecutando el siguiente comando en Cloud Shell:
Ten en cuenta que las imágenes grandes tardan un poco en descargarse en la VM de Cloud Shell cuando se abre la URL. |
cloudshell_open_in_editor
|
Archivos que se van a abrir en el editor de Cloud Shell. Se puede repetir para especificar varios archivos que se van a abrir. Si se especifican varios, se abrirán en el orden indicado. 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 archivo son relativas al directorio actual. Si se proporciona el parámetro working_dir, la ruta de estos archivos se trata como relativa a working_dir. |
Cualquier ruta de archivo válida que conste de los siguientes caracteres permitidos: letras mayúsculas y minúsculas, números, tildes (~), guiones bajos (_), guiones (-), puntos (.), barras oblicuas (/) y dos puntos (:). |
cloudshell_print
|
Archivo del repositorio de Git que suele contener instrucciones para imprimirse en la terminal y guiar a los usuarios en los siguientes pasos. La ruta del archivo es relativa al directorio actual. Si se proporciona el parámetro working_dir, la ruta a este archivo se trata como relativa a working_dir. |
Cualquier ruta de archivo válida que conste de los siguientes caracteres permitidos: letras mayúsculas y minúsculas, números, tildes (~), guiones bajos (_), guiones (-), puntos (.), barras oblicuas (/) y dos puntos (:). |
cloudshell_tutorial
|
Archivo Markdown del tutorial en el repositorio de Git que contiene las instrucciones que se deben iniciar como tutorial para guiar a los usuarios en un proyecto. La ruta del archivo es relativa al directorio actual. |
Cualquier archivo de Markdown de tutorial bien formado con un nombre de archivo válido. |
cloudshell_working_dir (Obsoleto)
|
Este parámetro ya no está disponible. Usa
|
Cualquier ruta de archivo válida que conste de los siguientes caracteres permitidos: letras mayúsculas y minúsculas, números, tildes (~), guiones bajos (_), guiones (-), puntos (.), barras oblicuas (/) y dos puntos (:). |
cloudshell_workspace
|
Directorio de trabajo de Cloud Shell. El terminal se abre en el directorio especificado. El editor de Cloud Shell abre el directorio como un espacio de trabajo. | Cualquier ruta de archivo válida relativa al repositorio clonado. Puede 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 es relativa 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 se abre un repositorio en Cloud Shell con este parámetro, se crea un entorno temporal con un directorio principal provisional que se elimina cuando finaliza la sesión. Para obtener más información, consulta Elegir el modo efímero. |
|
show
|
Abrir solo el terminal, solo el editor de Cloud Shell o ambos. |
|
Ejemplos
Para insertar 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 insertar la misma función en un sitio web, utilice este fragmento de código 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>
Generador de enlaces para abrir en Cloud Shell
Para definir el comportamiento del enlace Abrir en Cloud Shell de forma más específica, puedes usar el formulario que aparece a continuación para experimentar con los parámetros necesarios para abrir tu repositorio en Cloud Shell.