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 istruzioni sul terminale per aiutare gli utenti a interagire con i contenuti.
I link Apri in Cloud Shell consentono agli sviluppatori di eseguire esperimenti con i sample di codice e le API senza dover 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, eventualmente incorporato in un'immagine di pulsante, può essere aggiunto al file README.md di qualsiasi directory del 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 base 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 cartella principale del progetto, i cui contenuti vengono visualizzati nel riquadro di navigazione a sinistra. |
URL valido per un repository Git. Questo URL è costituito 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 (/). |
Parametri URL facoltativi
Puoi anche specificare uno dei seguenti parametri facoltativi:
| Parametro URL | Descrizione | Valori supportati |
|---|---|---|
cloudshell_git_branch
|
Ramo 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 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 scratch 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, utilizza il tutorial sulla creazione di immagini personalizzate che può essere avviato eseguendo il seguente comando in Cloud Shell:
Tieni presente che il download di immagini di grandi dimensioni sulla VM Cloud Shell richiede del tempo quando viene aperto l'URL. |
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ù di uno, vengono aperti 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 costituito dai seguenti caratteri consentiti: lettere maiuscole e minuscole, cifre, tilde (~), trattini bassi (_), trattini (-), punti (.), barre oblique (/) e due punti (:). |
cloudshell_print
|
File nel repository Git, in genere costituito da istruzioni da stampare sul 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 costituito dai seguenti caratteri consentiti: lettere maiuscole e minuscole, cifre, tilde (~), trattini bassi (_), trattini (-), punti (.), barre oblique (/) e due punti (:). |
cloudshell_tutorial
|
File Markdown del tutorial nel repository Git costituito da istruzioni da avviare come tutorial per guidare gli utenti attraverso un progetto. Il percorso del file è relativo alla directory corrente. |
Qualsiasi file Markdown del tutorial ben formato con un nome file valido. |
cloudshell_working_dir (Ritiro previsto)
|
Questo parametro è deprecato. Utilizza
|
Qualsiasi percorso file valido costituito dai seguenti caratteri consentiti: lettere maiuscole e minuscole, cifre, tilde (~), trattini bassi (_), trattini (-), punti (.), barre oblique (/) 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
il valore parametro vuoto 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 scratch che viene eliminata al termine della sessione. Per ulteriori informazioni, consulta Scegliere la modalità effimera. |
|
show
|
Apri solo con il terminale, solo con l'editor di Cloud Shell o con entrambi. |
|
Esempi
Per incorporare un pulsante per aprire un repository Git di esempio in Cloud Shell, includere il seguente codice 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 più specificamente 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.