La fonctionnalité Ouvrir dans Cloud Shell vous permet de publier un lien qui ouvre la console Google Cloud avec un dépôt Git cloné dans Cloud Shell ou qui démarre Cloud Shell avec une image personnalisée. Vous pouvez également afficher des instructions dans le terminal pour aider les utilisateurs à interagir avec le contenu.
Les liens "Ouvrir dans Cloud Shell" aident les développeurs à tester vos exemples de code et vos API sans télécharger la Google Cloud CLI, installer les dépendances requises ni rechercher les fichiers sources pertinents. Cette page explique comment ajouter un lien "Ouvrir dans Cloud Shell" à votre dépôt Git.
Paramètres d'URL
Un lien "Ouvrir dans Cloud Shell", éventuellement intégré dans une image de bouton, peut être ajouté au fichier README.md de n'importe quel répertoire de votre dépôt Git. L'emplacement recommandé pour ce lien est le fichier README.md racine de votre dépôt Git.
Paramètre d'URL obligatoire
Pour créer ce lien, utilisez l'URL de base shell.cloud.google.com (ou n'importe quelle page de la console Google Cloud qui commence par console.cloud.google.com) avec le paramètre d'URL obligatoire suivant :
| Paramètre d'URL | Description | Valeurs autorisées |
|---|---|---|
cloudshell_git_repo |
URL du dépôt Git à cloner. Une fois le dépôt cloné, la racine du dossier du projet est ouverte et son contenu est affiché dans le volet de navigation de gauche. |
URL valide pour un dépôt Git. Cette URL comprend un domaine autorisé (GitHub ou Bitbucket) ainsi qu'un chemin d'accès. Les caractères suivants sont autorisés : lettres majuscules et minuscules, chiffres, traits de soulignement (_), traits d'union (-), points (.) et barres obliques (/). Seuls les dépôts de la liste d'autorisation appartenant à Google s'ouvriront dans l'environnement Cloud Shell par défaut et auront accès aux identifiants de l'utilisateur. Tous les autres dépôts utiliseront un environnement Cloud Shell temporaire sans accès aux identifiants de l'utilisateur. |
Paramètres d'URL facultatifs
Vous pouvez également spécifier l'un des paramètres facultatifs suivants :
| Paramètre d'URL | Description | Valeurs autorisées |
|---|---|---|
cloudshell_git_branch
|
Branche du dépôt Git à cloner. Uniquement applicable lorsque cloudshell_git_repo est spécifié. La branche par défaut est master. | Toute branche valide dans le dépôt. Les caractères suivants sont autorisés: lettres majuscules et minuscules, chiffres, tildes (~), traits de soulignement (_), tirets (-), points (.), barres obliques (/) et deux-points (:). |
cloudshell_image
|
Image Docker personnalisée qui exécute un environnement personnalisé pendant la session. Cela vous permet de fournir des outils personnalisés dans Cloud Shell, que les utilisateurs peuvent utiliser pour travailler avec votre dépôt. L'ouverture d'un dépôt dans Cloud Shell avec ce paramètre spécifié crée un environnement temporaire avec un répertoire d'accueil temporaire qui est supprimé à la fin de la session. |
URL d'une image Docker hébergée dans Artifact Registry. L'image Docker doit être basée sur l'image Cloud Shell de base et être publiquement accessible. Notez que le téléchargement d'images volumineuses sur la VM Cloud Shell prend un certain temps lorsque l'URL est ouverte. |
cloudshell_open_in_editor
|
Fichier(s) à ouvrir dans l'éditeur Cloud Shell. Peut être répété pour spécifier l'ouverture de plusieurs fichiers. Si plusieurs sont spécifiés, ils s'ouvrent dans l'ordre indiqué. Le ou les fichiers spécifiés seront ouverts dans le projet en cours dans les onglets de l'éditeur de droite (un onglet par fichier). Les chemins de fichiers sont relatifs au répertoire actuel. Si le paramètre working_dir est fourni, le chemin d'accès à ces fichiers sera traité comme faisant référence à working_dir. |
N'importe quel chemin de fichier valide comportant les caractères autorisés suivants : lettres majuscules et minuscules, chiffres, tildes (~), traits de soulignement (_), traits d'union (-), points (.), barres obliques (/) et deux-points (:). |
cloudshell_print
|
Fichier hébergé sur le dépôt Git, généralement constitué d'instructions devant être imprimées sur le terminal pour guider l'utilisateur. Le chemin du fichier fait référence au répertoire actuel. Si le paramètre working_dir est fourni, le chemin d'accès à ce fichier sera traité comme faisant référence à working_dir. |
N'importe quel chemin de fichier valide comportant les caractères autorisés suivants : lettres majuscules et minuscules, chiffres, tildes (~), traits de soulignement (_), traits d'union (-), points (.), barres obliques (/) et deux-points (:). |
cloudshell_tutorial
|
Tutoriel au format Markdown dans le dépôt Git, comprenant des instructions à lancer sous forme de tutoriel afin de guider les utilisateurs dans l'utilisation d'un projet. Le chemin du fichier fait référence au répertoire actuel. |
Tout fichier de tutoriel Markdown bien formé avec un nom de fichier valide. |
cloudshell_working_dir (Obsolète)
|
Ce paramètre est obsolète. Utilisez plutôt |
N'importe quel chemin de fichier valide comportant les caractères autorisés suivants : lettres majuscules et minuscules, chiffres, tildes (~), traits de soulignement (_), traits d'union (-), points (.), barres obliques (/) et deux-points (:). |
cloudshell_workspace
|
Répertoire de travail pour Cloud Shell. Le terminal s'ouvre dans le répertoire spécifié. L'éditeur Cloud Shell ouvre le répertoire en tant qu'espace de travail. | N'importe quel chemin de fichier valide relatif au dépôt cloné. Vous pouvez laisser la valeur du paramètre vide ou utiliser . pour spécifier la racine du dépôt cloné. Si aucun dépôt n'est spécifié, le chemin d'accès est relatif au répertoire d'accueil de Cloud Shell. Les caractères suivants sont autorisés : lettres majuscules et minuscules, chiffres, tildes (~), traits de soulignement (_), tirets (-), points (.), barres obliques (/) et deux-points (:).
|
ephemeral |
L'ouverture d'un dépôt dans Cloud Shell avec ce paramètre spécifié crée un environnement temporaire avec un répertoire d'accueil temporaire qui est supprimé à la fin de la session. Pour en savoir plus, consultez Choisir le mode éphémère. | true, false |
show
|
Ouvrez uniquement le terminal, uniquement l'éditeur Cloud Shell ou les deux. |
ide, terminal, ide%2Cterminal |
Exemples
Pour intégrer un bouton permettant d'ouvrir un exemple de dépôt Git dans Cloud Shell, incluez le code Markdown suivant dans le fichier README.md de votre dépôt :
[](https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git)
Pour intégrer la même fonctionnalité dans un site Web, utilisez cet extrait de code HTML équivalent :
<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>
Ouvrir dans le générateur de liens Cloud Shell
Pour définir plus précisément le comportement du lien "Ouvrir dans Cloud Shell", vous pouvez utiliser le formulaire ci-dessous pour tester les paramètres nécessaires à l'ouverture de votre dépôt dans Cloud Shell.