Crea instructivos privados en Cloud Shell

Cloud Shell admite la creación de instructivos privados, lo que te permite diseñar instructivos específicamente para tu público.

Después de crear instructivos con la guía Cómo escribir instructivos en Cloud Shell y seguir las prácticas recomendadas que se detallan en la Guía de estilo de los instructivos, puedes alojar tu instructivo en un repositorio privado de Git para que esté disponible para tus usuarios.

Puedes usar el servicio de alojamiento de repositorios de Git que prefieras. En esta guía, se usa Secure Source Manager, un repositorio de código fuente administrado de un solo usuario y con implementación regional alojado en Google Cloud, para demostrar los pasos.

Crea un repositorio privado de Git

Las instancias de Secure Source Manager se implementan en una región Google Clouddisponible y se puede acceder a ellas a través de sus URIs de instancia. Los repositorios se crean en la instancia de Secure Source Manager con una interfaz web o la API de Secure Source Manager.

Para crear un repositorio de Secure Source Manager que aloje tu instructivo privado, completa los siguientes pasos.

  1. Inicia la terminal de Cloud Shell. Para una sesión independiente de Cloud Shell, usa shell.cloud.google.com.

  2. Crea una instancia de Secure Source Manager si aún no tienes una:

    gcloud source-manager instances create INSTANCE_ID \
    --region=LOCATION

    Reemplaza lo siguiente:

    • INSTANCE_ID: Es el ID de la instancia de Secure Source Manager.
    • LOCATION: Es la región en la que crearás la instancia, por ejemplo, us-central1.

    La creación de la instancia puede tardar hasta 60 minutos.

  3. Para acceder a la instancia de Secure Source Manager a través de su interfaz web, copia la siguiente URL en la barra de direcciones de tu navegador:

    INSTANCE_ID-PROJECT_NUMBER.LOCATION.sourcemanager.dev

    Reemplaza PROJECT_NUMBER por el número de proyecto de la instancia de Google Cloud .

  4. Crea un repositorio privado:

    gcloud source-manager repos create REPO_ID \
    --instance=INSTANCE_ID \
    --region=LOCATION

    Reemplaza REPO_ID por el ID del repositorio de Secure Source Manager.

    Para obtener información sobre los permisos necesarios para crear un repositorio, consulta Roles necesarios.

  5. Agrega el auxiliar de autenticación de Secure Source Manager a tu configuración global de Git. Para obtener más información, consulta Cómo configurar tus credenciales.

  6. Clona tu repositorio en Cloud Shell:

    git clone https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git

    Reemplaza PROJECT_ID por el ID del proyecto de la instancia Google Cloud .

  7. Mueve el archivo del instructivo al repositorio que creaste de forma local:

    mv PATH_TO_TUTORIAL REPO_ID/PATH_TO_TUTORIAL

    Reemplaza PATH_TO_TUTORIAL por la ruta de acceso a tu instructivo privado.

  8. Ve a tu repositorio local:

    cd REPO_ID

  9. Agrega, confirma y envía los archivos del instructivo:

    git add .
git commit -m "Add private tutorial to Secure Source Manager"
git push origin main

  10. Puedes ver tu repositorio de Secure Source Manager en la interfaz web. Para obtener más información, consulta Cómo ver y enumerar repositorios.

Para ayudar a tus usuarios a acceder a tu instructivo, puedes usar la función Abrir en Cloud Shell de Cloud Shell, que te permite definir cómo los usuarios acceden a tu instructivo. Para obtener detalles sobre cómo personalizar tu vínculo, consulta la guía de Open in Cloud Shell.

En el caso de un instructivo alojado en un repositorio de Secure Source Manager, deberás definir el parámetro cloudshell_git_repo con la URL HTTPS de tu repositorio. Por ejemplo:

https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git

Puedes darle estilo a este vínculo como un botón y, luego, incorporarlo en la documentación para que los usuarios lo encuentren. Por ejemplo:

[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git)

Personaliza instructivos con herramientas de complementos

Puedes personalizar aún más tu experiencia de tutorial privado proporcionando a tus usuarios herramientas personalizadas para trabajar con tu tutorial.

Para ello, puedes crear una imagen de Docker que funcione como un entorno personalizado de Cloud Shell con todos los paquetes adicionales y las configuraciones personalizadas que desees que estén disponibles para tu usuario.