Abrir en Cloud Shell

La función Abrir en Cloud Shell le permite publicar un enlace que abre Cloud Console y clona automáticamente un repositorio de Git en Cloud Shell o inicia Cloud Shell con una imagen personalizada. Además, permite que las instrucciones se impriman en la terminal, a fin de ayudar a los usuarios a interactuar con el contenido.

La característica Abrir en Cloud Shell ayuda a que los desarrolladores puedan experimentar con muestras de códigos y API sin tener que preocuparse de descargar el SDK de Cloud, de instalar las dependencias obligatorias, o de buscar los archivos de origen relevantes. En esta página se explica cómo agregar esta característica 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 su repositorio de Git. La ubicación recomendada para este vínculo es el archivo README.md raíz de tu repositorio de Git.

Para agregar funcionalidad a esta interacción Abrir en Cloud Shell, deberá usar una URL base de ssh.cloud.google.com (o cualquier página en Cloud Console que comience con console.cloud.google.com) con al menos uno de estos dos parámetros de URL:

Parámetro de URL Descripción Valores admitidos
cloudshell_git_repo

URL del repositorio de Git a clonar.

El repositorio especificado se clonará y la raíz de la carpeta del proyecto se abrirá, mostrando su contenido en el panel de navegación de la izquierda.

URL válida para un repositorio de Git.

Consiste en un dominio incluido en la lista blanca (GitHub o Bitbucket) y una ruta compuesta con estos caracteres válidos [a-zA-Z0-9_-./].

cloudshell_image

Especifica 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, a fin de trabajar con tu repositorio. Ten en cuenta que esto crea un entorno temporal con un directorio inicial nuevo, que se borrará cuando se finalice la sesión.

Este tutorial se puede iniciar ejecutando “cloudshell launch-tutorial /google/devshell/tutorials/custom-image-tutorial.md” dentro de Cloud Shell.

URL de una imagen de Docker alojada en Google Container Registry. La imagen de Docker debe basarse en la imagen base de Cloud Shell y ser de acceso público. Tenga en cuenta que una imagen grande tardará un tiempo en descargarse en la VM de Cloud Shell cuando se abra la URL.

Además, puede especificar cualquiera de estos parámetros opcionales:

Parámetro de URL Descripción Valores admitidos

cloudshell_git_branch

La rama específica del repositorio de git que se va a clonar. Solo aplicable cuando se especifica “cloudshell_git_repo”. La rama predeterminada es principal. Cualquier rama válida en el repositorio. Los caracteres deben coincidir con esta lista blanca: [a-zA-Z0-9~_-./:]

cloudshell_workspace

Directorio de trabajo para Cloud Shell Almacena a los usuarios en el directorio especificado en la terminal y abre el directorio como un lugar de trabajo en el editor de Cloud Shell. Cualquier ruta de archivo válida relacionada 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 uno, la ruta de acceso se relaciona con el directorio de inicio de Cloud Shell. Los caracteres deben coincidir con esta lista blanca: [a-zA-Z0-9_-./:]

cloudshell_open_in_editor

Los archivos 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 archivo válida. Los caracteres deben coincidir con esta lista blanca: [a-zA-Z0-9~_-./:]

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 archivo válida. Los caracteres deben coincidir con esta lista blanca: [a-zA-Z0-9~_-./:]

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. Los caracteres deben coincidir con esta lista blanca: [a-zA-Z0-9~_-./:]

Ejemplos

Si deseas proporcionar un vínculo para abrir un repositorio de Git simple en Cloud Shell, deberás usar Markdown como el siguiente fragmento a fin de incorporar el vínculo 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)

Si prefieres incorporar esta funcionalidad en un sitio web, el equivalente en HTML al fragmento anterior, es el siguiente:

<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>

Si deseas definir el comportamiento deseado del vínculo “Abrir en Cloud Shell” de manera más específica, puedes usar el formulario que se encuentra a continuación, a fin de experimentar con parámetros y determinar la URL esperada necesaria para abrir tu repositorio en Cloud Shell.