La funzionalità Apri in Cloud Shell consente di pubblicare un link che apre la console Google Cloud con un repository Git clonato in Cloud Shell o avvia Cloud Shell con un'immagine personalizzata. Puoi anche stampare le istruzioni sul terminale per aiutare gli utenti a interagire con i contenuti.
I link Apri in Cloud Shell aiutano gli sviluppatori a sperimentare con i tuoi esempi di codice e le tue API senza scaricare Google Cloud CLI, installare le dipendenze richieste o cercare i 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 nell'immagine di un pulsante, può essere aggiunto al file README.md di qualsiasi directory nel tuo repository Git. La posizione consigliata per questo link è il file README.md principale del tuo repository Git.
Parametro URL obbligatorio
Per creare questo link, utilizza un URL di base di shell.cloud.google.com (o qualsiasi pagina della console Google Cloud che inizia 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 directory root della cartella del progetto, i cui contenuti vengono visualizzati nel riquadro di navigazione a sinistra. |
URL valido per un repository Git. Questo URL è composto da un dominio consentito (GitHub o Bitbucket) e da un percorso. Sono consentiti i seguenti caratteri: lettere maiuscole e minuscole, cifre, trattini bassi (_), trattini (-), punti (.) e barre (/). Solo i repository inclusi nella lista consentita di proprietà di Google verranno aperti nell'ambiente Cloud Shell predefinito e avranno accesso alle credenziali dell'utente. Tutti gli altri repository utilizzeranno un ambiente Cloud Shell temporaneo senza accesso alle credenziali dell'utente. |
Parametri URL facoltativi
Puoi anche specificare uno dei seguenti parametri facoltativi:
| Parametro URL | Descrizione | Valori supportati |
|---|---|---|
cloudshell_git_branch
|
Branch del repository Git da clonare. Applicabile solo quando è specificato cloudshell_git_repo. Il branch predefinito è master. | Qualsiasi branch 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. In questo modo, puoi fornire strumenti personalizzati in Cloud Shell 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 temporanea che viene eliminata al termine della sessione. |
URL di un'immagine Docker ospitata in Artifact Registry. L'immagine Docker deve essere basata sull'immagine Cloud Shell di base ed essere accessibile pubblicamente. Tieni presente che il download di immagini di grandi dimensioni nella VM Cloud Shell richiede un po' di tempo quando l'URL viene aperto. |
cloudshell_open_in_editor
|
File da aprire nell'editor di Cloud Shell. Può essere ripetuto per specificare più file da aprire. Se ne vengono specificati più, si aprono nell'ordine fornito. I file specificati vengono aperti nelle schede dell'editor a destra, una scheda per file, nel progetto aperto. I percorsi dei file sono relativi alla directory corrente. Se viene fornito il parametro working_dir, il percorso di questi file viene considerato relativo a working_dir. |
Qualsiasi percorso 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 contiene istruzioni da stampare nel terminale per guidare l'utente nei passaggi successivi. Il percorso del file è relativo alla directory corrente. Se viene fornito il parametro working_dir, il percorso di questo file viene trattato come relativo a working_dir. |
Qualsiasi percorso file valido composto dai seguenti caratteri consentiti: lettere maiuscole e minuscole, cifre, tilde (~), trattini bassi (_), trattini (-), punti (.), barre (/) e due punti (:). |
cloudshell_tutorial
|
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 corrente. |
Qualsiasi file Tutorial Markdown ben formato con un nome file valido. |
cloudshell_working_dir (ritirato)
|
Questo parametro è stato ritirato. Utilizza invece |
Qualsiasi percorso 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 file valido relativo al repository clonato. Puoi lasciare vuoto il valore 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 temporanea che viene eliminata al termine della sessione. Per saperne di più, consulta Scelta della modalità temporanea. | true, false |
show
|
Apri solo con il terminale, solo con l'editor di Cloud Shell o con entrambi. |
ide, terminal, ide%2Cterminal |
Esempi
Per incorporare un pulsante per aprire un repository Git di esempio in Cloud Shell, includi il seguente Markdown nel file README.md del 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>
Generatore di link Apri in Cloud Shell
Per definire in modo più specifico il comportamento del link Apri in Cloud Shell, puoi utilizzare il modulo di seguito per sperimentare i parametri necessari per aprire il repository in Cloud Shell.