La funzionalità Apri in Cloud Shell ti consente di pubblicare un link che apre la console Google Cloud con un repository Git clonato in Cloud Shell e/o avvia Cloud Shell con un'immagine personalizzata. Puoi anche stampare le istruzioni nel terminale per aiutare gli utenti a interagire con i contenuti.
I link aperti in Cloud Shell aiutano gli sviluppatori a sperimentare con le tue API e i tuoi esempi di codice senza dover scaricare Google Cloud CLI, installare le dipendenze necessarie o cercare file di origine pertinenti. Questa pagina spiega come aggiungere un link Apri in Cloud Shell al tuo repository Git.
Parametri URL
Un link Apri in Cloud Shell, facoltativamente incorporato in un'immagine pulsante, può essere aggiunto al file README.md di qualsiasi directory nel tuo repository Git. La località consigliata per questo link è il file README.md principale del repository Git.
Parametro URL obbligatorio
Per creare questo collegamento, utilizza un URL di base di shell.cloud.google.com (o qualsiasi pagina della console Google Cloud che inizi con console.cloud.google.com) con il seguente parametro URL obbligatorio:
| Parametro URL | Descrizione | Valori supportati |
|---|---|---|
cloudshell_git_repo |
URL del repository Git da clonare. Dopo la clonazione del repository, viene aperta la radice della cartella del progetto, con i relativi contenuti nel riquadro di navigazione a sinistra. |
URL valido per un repository Git. Questo URL consiste in un dominio consentito (GitHub o Bitbucket) e in un percorso. Sono consentiti i seguenti caratteri: lettere maiuscole e minuscole, cifre, trattini bassi (_), trattini (-), punti (.) e barre (/). |
Parametri URL facoltativi
Puoi anche specificare uno qualsiasi dei seguenti parametri facoltativi:
| Parametro URL | Descrizione | Valori supportati |
|---|---|---|
cloudshell_git_branch
|
Ramo dal repository Git da clonare. Applicabile solo quando è specificato cloudshell_git_repo. Il ramo predefinito è master. | Qualsiasi ramo valido nel repository. Sono consentiti i seguenti caratteri: lettere maiuscole e minuscole, cifre, tilde (~), trattini bassi (_), trattini (-), punti (.), barre (/) e due punti (:). |
cloudshell_image
|
Immagine Docker personalizzata che esegue un ambiente personalizzato durante la sessione. Questo consente di fornire in Cloud Shell strumenti personalizzati che gli utenti possono utilizzare per lavorare con il tuo repository. L'apertura di un repository in Cloud Shell con questo parametro specificato crea un ambiente temporaneo con una home directory temporaneo che viene eliminata al termine della sessione. |
URL di un'immagine Docker ospitata in Container Registry. L'immagine Docker deve essere basata sull'immagine di base di Cloud Shell ed essere accessibile pubblicamente. Per creare un'immagine valida, usa il tutorial personalizzato per la creazione di immagini, che puoi avviare eseguendo questo comando in Cloud Shell:
Tieni presente che il download delle immagini di grandi dimensioni nella VM Cloud Shell richiede un po' di tempo all'apertura dell'URL. |
cloudshell_open_in_editor
|
File da aprire nell'editor di Cloud Shell. Può essere ripetuto per specificare più file da aprire. Se sono specificati più elementi, vengono aperti nell'ordine fornito. I file specificati vengono aperti nelle schede dell'editor a destra, una per file, nel progetto aperto. I percorsi dei file sono relativi alla directory attuale. Se viene fornito il parametro working_dir, il percorso a questi file viene trattato come relativo a working_dir. |
Qualsiasi percorso di file valido composto dai seguenti caratteri consentiti: lettere maiuscole e minuscole, cifre, tilde (~), trattini bassi (_), trattini (-), punti (.), barre (/) e due punti (:). |
cloudshell_print
|
File nel repository Git, che di solito consiste in istruzioni da stampare nel terminale per guidare i passaggi successivi dell'utente. Il percorso del file è relativo alla directory attuale. Se viene fornito il parametro working_dir, il percorso a questo file viene trattato come relativo a working_dir. |
Qualsiasi percorso di file valido composto dai seguenti caratteri consentiti: lettere maiuscole e minuscole, cifre, tilde (~), trattini bassi (_), trattini (-), punti (.), barre (/) e due punti (:). |
cloudshell_tutorial
|
Il file Tutorial Markdown nel repository Git contenente le istruzioni da lanciare come tutorial per guidare gli utenti attraverso un progetto. Il percorso del file è relativo alla directory attuale. |
Qualsiasi file di Markdown per i tutorial ben formato con un nome file valido. |
cloudshell_working_dir (deprecato)
|
Questo parametro è obsoleto. Usa
invece |
Qualsiasi percorso di file valido composto dai seguenti caratteri consentiti: lettere maiuscole e minuscole, cifre, tilde (~), trattini bassi (_), trattini (-), punti (.), barre (/) e due punti (:). |
cloudshell_workspace
|
Directory di lavoro per Cloud Shell. Il terminale si apre nella directory specificata. L'editor di Cloud Shell apre la directory come area di lavoro. | Qualsiasi percorso di file valido relativo al repository clonato. Puoi lasciare vuoto il valore del parametro o utilizzare . per specificare la radice del repository clonato. Se non viene specificato alcun repository, il percorso è relativo alla home directory di Cloud Shell. Sono consentiti i seguenti caratteri: lettere maiuscole e minuscole, cifre, tilde (~), trattini bassi (_), trattini (-), punti (.), barre (/) e due punti (:).
|
ephemeral |
L'apertura di un repository in Cloud Shell con questo parametro specificato crea un ambiente temporaneo con una home directory temporaneo che viene eliminata al termine della sessione. Per maggiori informazioni, consulta la pagina Scegliere la modalità temporanea. |
|
show
|
Apri solo con il terminale, solo con l'editor di Cloud Shell o entrambi. |
|
Esempi
Per incorporare un pulsante per aprire un repository Git di esempio in Cloud Shell, includi la seguente Markdown nel file README.md del tuo repository:
[](https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git)
Per incorporare la stessa funzionalità in un sito web, utilizza questo snippet 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>
Apri nel generatore di link di Cloud Shell
Per definire il comportamento del link Apri in Cloud Shell in modo più specifico, puoi utilizzare il modulo seguente per sperimentare i parametri necessari per aprire il repository in Cloud Shell.