Configurer Cloud Shell

Cette page décrit les différentes façons de configurer Cloud Shell pour personnaliser votre expérience.

Fichiers de configuration dans votre répertoire d'accueil Cloud Shell

Cloud Shell fournit gratuitement 5 Go de stockage sur disque persistant monté en tant que répertoire $HOME. Tous les fichiers que vous stockez dans votre répertoire d'accueil, y compris les logiciels installés, les scripts et les fichiers de configuration utilisateur tels que .bashrc et .vimrc, persistent entre les sessions. Étant donné que votre .bashrc persiste à travers les sessions, c'est un excellent moyen de personnaliser votre comportement Cloud Shell. De même, pour que vos installations persistent, vous pouvez installer des packages dans votre répertoire d'accueil.

Variables d'environnement préconfigurées

Lorsque Cloud Shell est démarré, le projet actif dans la console est propagé à votre configuration gcloud dans Cloud Shell pour une utilisation immédiate. La variable d'environnement GOOGLE_CLOUD_PROJECT, utilisée par le service d'identifiants par défaut de l'application pour définir l'ID de projet, est également définie afin de pointer vers le projet actif dans Cloud Shell.

La variable d'environnement CLOUD_SHELL est définie sur true. Cette variable peut être vérifiée dans les applications pour déterminer si une application est en cours d'exécution dans Cloud Shell.

Préférences de gcloud CLI

Lorsque vous utilisez Cloud Shell, les préférences de gcloud CLI sont stockées dans un dossier temporaire tmp, qui est défini uniquement pour l'onglet actuel. Elles ne sont pas conservées d'une session à l'autre.

Pour conserver les configurations de la gcloud CLI, vous pouvez les définir à l'aide de l'une des méthodes suivantes:

  • Pour que la configuration de gcloud CLI reste personnalisable par onglet, mais pour personnaliser la configuration par défaut elle-même, vous pouvez ajouter des commandes de configuration gcloud (telles que gcloud config set compute/region us-central1 pour définir une région par défaut) à la fin de votre fichier $HOME/.bashrc.

    Cela garantit que chaque nouvel onglet hérite de votre projet de console Google Cloud et de votre configuration par défaut personnalisée, mais vous permet également de personnaliser davantage la configuration de chaque onglet.

  • Pour toujours utiliser la même configuration de gcloud CLI, ajoutez export CLOUDSDK_CONFIG=$HOME/.config/gcloud à la fin de votre fichier .bashrc, puis exécutez gcloud config configurations create CONFIG_NAME pour créer la configuration à utiliser.

Propriétés communes

Pour définir le projet sur lequel vous souhaitez travailler, exécutez :

gcloud config set project [PROJECT_NAME]

Votre invite de commande est mise à jour pour refléter le projet actuellement actif, selon le format suivant : [USERNAME]@cloudshell:~ ([PROJECT_NAME])$

Pour sélectionner la région de votre choix, exécutez :

gcloud config set compute/region us-east1

Les commandes ci-dessus sont des exemples de configurations de gcloud CLI que vous pouvez définir. Pour obtenir la liste complète et plus de détails sur la définition des propriétés, consultez le guide des propriétés de la gcloud CLI.

Personnaliser l'environnement

La personnalisation de l'environnement vous permet d'installer des packages supplémentaires dans votre environnement Cloud Shell au démarrage.

Script de personnalisation de l'environnement

Cloud Shell exécute automatiquement le script $HOME/.customize_environment lorsque votre instance démarre. Contrairement à .profile ou .bashrc, ce script s'exécute une fois au démarrage de Cloud Shell (plutôt qu'une fois pour chaque connexion à Cloud Shell).

Ce script s'exécute en tant que racine et vous pouvez installer tous les packages que vous souhaitez inclure dans chaque session Cloud Shell à l'aide des commandes de gestion des packages Debian.

Par exemple, si vous souhaitez installer erlang sur Cloud Shell, votre fichier .customize_environment ressemblera à ceci :

#!/bin/sh
apt-get update
apt-get -y install erlang

Les journaux d'exécution de votre script .customize_environment se trouvent dans /var/log/customize_environment. Le script .customize_environment s'exécute en arrière-plan et, en cas d'exécution réussie, touche /google/devshell/customize_environment_done. Étant donné que l'installation des packages s'exécute en parallèle avec votre connexion, les packages installés peuvent devenir disponibles quelques instants après votre accès à l'invite de connexion.

Ouvrir Cloud Shell avec un compte utilisateur spécifique

Le paramètre authuser vous permet de spécifier un compte utilisateur à utiliser avec Cloud Shell. Vous devez être connecté avec le compte utilisateur spécifié. Si vous n'êtes pas connecté au compte spécifié, Cloud Shell s'ouvre avec le compte connecté par défaut. Par exemple, vous pouvez ouvrir Cloud Shell connecté en tant que client1@example.com à l'aide de l'URL shell.cloud.google.com?authuser=client1@example.com.

Personnaliser l'image de conteneur

La personnalisation des images de conteneurs vous permet de créer une image Docker qui fonctionne comme un environnement Cloud Shell personnalisé avec des packages supplémentaires et des configurations personnalisées spécifiés par vos soins. Votre image Docker doit être basée sur l'image Cloud Shell de base et hébergée sur Container Registry.

Pour en savoir plus sur la création d'une image de conteneur personnalisée, consultez le guide Personnaliser les images de conteneur.

Contrairement à la personnalisation de l'environnement, la personnalisation des images de conteneur n'affecte pas votre expérience Cloud Shell par défaut. Vous pouvez utiliser et partager votre image personnalisée avec les liens Ouvrir dans Cloud Shell.

Compatibilité tmux

Cloud Shell utilise tmux par défaut, ce qui lui permet d'améliorer la persistance entre les sessions d'onglets de navigateur. Par exemple, si vous actualisez la console Google Cloud dans un onglet ou si vous vous connectez à Cloud Shell à partir d'une autre machine, l'état de la session ne sera pas perdu.

Cloud Shell prend en charge les liaisons de touches tmux par défaut. Par exemple, si vous appuyez sur Ctrl + b puis sur %, tmux divise la fenêtre de session actuelle en volets gauche et droit, ce qui peut être utile pour le débogage.

Pour désactiver tmux dans Cloud Shell, cliquez sur le bouton Paramètres du terminal (icône de clé), sélectionnez Paramètres Tmux et désélectionnez l'option Activer l'intégration Tmux.

Statistiques d'utilisation

Cloud Shell recueille des statistiques d'utilisation anonymes sur les commandes exécutées dans le terminal Cloud Shell. Les statistiques sont collectées uniquement sur les commandes préinstallées dans Cloud Shell. Ces statistiques ne peuvent pas être liées à votre compte.

Les statistiques ne sont collectées sur aucune information personnellement identifiable, comme les arguments transmis à ces commandes.

Pour modifier les préférences de collecte de statistiques à tout moment, sélectionnez Statistiques d'utilisation du terminal dans le menu Paramètres Bouton "Paramètres". Toute modification de vos préférences dans le menu Paramètres prend effet à la session suivante. Pour activer ou désactiver la collecte de métriques, fermez votre onglet et ouvrez-en un autre après avoir effectué votre modification.

Remarque : Ces statistiques sont distinctes des statistiques d'utilisation de gcloud, qui sont activées par défaut dans Cloud Shell.

Pour désactiver la collecte des métriques de gcloud CLI, exécutez la commande suivante dans votre session Cloud Shell:

gcloud config set disable_usage_reporting true