Creare tutorial privati in Cloud Shell

Cloud Shell supporta la creazione di tutorial privati, consentendoti di progettare tutorial specifici per il tuo pubblico.

Dopo aver creato i tutorial utilizzando la guida Scrivere tutorial in Cloud Shell e aver seguito le best practice descritte nella Guida di stile per i tutorial, puoi ospitare il tutorial in un repository Git privato per renderlo disponibile ai tuoi utenti.

Puoi utilizzare qualsiasi servizio di hosting di repository Git che preferisci. Questa guida utilizza Secure Source Manager, un repository di codice sorgente gestito, a tenant singolo e con deployment a livello regionale, ospitato su Google Cloud, per mostrare i passaggi.

Creare un repository Git privato

Le istanze Secure Source Manager vengono implementate in una regione Google Cloud disponibile e sono accessibili tramite i relativi URI di istanza. I repository vengono creati nell'istanza Secure Source Manager utilizzando un'interfaccia web o l'API Secure Source Manager.

Per creare un repository Secure Source Manager per ospitare il tutorial privato, completa i seguenti passaggi.

  1. Avvia il terminale Cloud Shell. Per una sessione di Cloud Shell autonoma, utilizza shell.cloud.google.com.

  2. Crea un'istanza Secure Source Manager se non ne hai già una:

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

    Sostituisci quanto segue:

    • INSTANCE_ID: l'ID dell'istanza di Secure Source Manager.
    • LOCATION: la regione in cui stai creando l'istanza, ad esempio us-central1.

    La creazione dell'istanza può richiedere fino a 60 minuti.

  3. Per accedere all'istanza Secure Source Manager tramite la sua interfaccia web, copia il seguente URL nella barra degli indirizzi del browser:

    INSTANCE_ID-PROJECT_NUMBER.LOCATION.sourcemanager.dev
    

    Sostituisci PROJECT_NUMBER con il numero del progetto Google Cloud dell'istanza.

  4. Crea un repository privato:

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

    Sostituisci REPO_ID con l'ID del repository Secure Source Manager.

    Per informazioni sulle autorizzazioni richieste per creare un repository, consulta Ruoli richiesti.

  5. Aggiungi l'helper di autenticazione di Secure Source Manager alla configurazione Git globale. Per maggiori informazioni, vedi Configurare le credenziali.

  6. Clona il repository in Cloud Shell:

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

    Sostituisci PROJECT_ID con l'ID progetto Google Cloud dell'istanza.

  7. Sposta il file del tutorial nel repository creato localmente:

    mv PATH_TO_TUTORIAL REPO_ID/PATH_TO_TUTORIAL
    

    Sostituisci PATH_TO_TUTORIAL con il percorso del tuo tutorial privato.

  8. Vai al repository locale:

    cd REPO_ID
    
  9. Aggiungi, esegui il commit e il push dei file del tutorial:

    git add .
    git commit -m "Add private tutorial to Secure Source Manager"
    git push origin main
    
  10. Puoi visualizzare il repository Secure Source Manager nell'interfaccia web. Per maggiori informazioni, consulta Elencare e visualizzare i repository.

Per aiutare gli utenti a raggiungere il tuo tutorial, puoi utilizzare la funzionalità Apri in Cloud Shell di Cloud Shell, che ti consente di definire in che modo gli utenti accedono al tutorial. Per informazioni dettagliate su come personalizzare il link, consulta la guida Apri in Cloud Shell.

Per un tutorial ospitato in un repository Secure Source Manager, devi definire il parametro cloudshell_git_repo con l'URL HTTPS del tuo repository. Ad esempio:

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

Puoi formattare questo link come pulsante e incorporarlo nella documentazione in modo che gli utenti possano trovarlo. Ad esempio:

[![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)

Personalizzare i tutorial con gli strumenti dei componenti aggiuntivi

Puoi personalizzare ulteriormente l'esperienza del tutorial privato fornendo agli utenti strumenti personalizzati per lavorare con il tutorial.

Per farlo, puoi creare un'immagine Docker che funga da ambiente Cloud Shell personalizzato con tutti i pacchetti aggiuntivi e le configurazioni personalizzate che vuoi rendere disponibili per l'utente.