Créer des tutoriels privés dans Cloud Shell

Cloud Shell prend en charge la création de tutoriels privés, ce qui vous permet de concevoir des tutoriels spécifiquement pour votre audience.

Après avoir créé des tutoriels à l'aide du guide Écrire des tutoriels dans Cloud Shell et suivi les bonnes pratiques détaillées dans le guide de style du tutoriel, vous pouvez héberger votre tutoriel dans un dépôt Git privé afin de le mettre à la disposition de vos utilisateurs.

Vous pouvez utiliser n'importe quel service d'hébergement de dépôt Git. Ce guide utilise Secure Source Manager, un dépôt de code source géré, à locataire unique et déployé au niveau régional, hébergé sur Google Cloud, pour illustrer les étapes.

Créer un dépôt Git privé

Les instances Secure Source Manager sont déployées dans une région disponible Google Cloud et sont accessibles via leurs URI d'instance. Les dépôts sont créés dans l'instance Secure Source Manager à l'aide d'une interface Web ou de l'API Secure Source Manager.

Pour créer un dépôt Secure Source Manager afin d'héberger votre tutoriel privé, procédez comme suit.

  1. Lancez le terminal Cloud Shell. Pour une session Cloud Shell autonome, utilisez shell.cloud.google.com.

  2. Créez une instance Secure Source Manager si vous n'en avez pas déjà une :

    gcloud source-manager instances create INSTANCE_ID \
    --region=LOCATION

    Remplacez les éléments suivants :

    • INSTANCE_ID: ID de l'instance Secure Source Manager.
    • LOCATION: région dans laquelle vous créez l'instance, par exemple us-central1.

    La création de l'instance peut prendre jusqu'à 60 minutes.

  3. Pour accéder à l'instance Secure Source Manager via son interface Web, copiez l'URL suivante dans la barre d'adresse de votre navigateur :

    INSTANCE_ID-PROJECT_NUMBER.LOCATION.sourcemanager.dev

    Remplacez PROJECT_NUMBER par le numéro de projet de l'instance Google Cloud .

  4. Créez un dépôt privé :

    gcloud source-manager repos create REPO_ID \
    --instance=INSTANCE_ID \
    --region=LOCATION

    Remplacez REPO_ID par l'ID du dépôt Secure Source Manager.

    Pour en savoir plus sur les autorisations requises pour créer un dépôt, consultez Rôles requis.

  5. Ajoutez l'assistant d'authentification Secure Source Manager à votre configuration Git globale. Pour en savoir plus, consultez Configurer vos identifiants.

  6. Clonez votre dépôt vers Cloud Shell :

    git clone https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git

    Remplacez PROJECT_ID par l'ID de projet de l'instance Google Cloud .

  7. Déplacez votre fichier de tutoriel vers le dépôt créé localement :

    mv PATH_TO_TUTORIAL REPO_ID/PATH_TO_TUTORIAL

    Remplacez PATH_TO_TUTORIAL par le chemin d'accès à votre tutoriel privé.

  8. Accédez à votre dépôt local :

    cd REPO_ID

  9. Ajoutez les fichiers du tutoriel, validez-les et transférez-les :

    git add .
git commit -m "Add private tutorial to Secure Source Manager"
git push origin main

  10. Vous pouvez afficher votre dépôt Secure Source Manager dans l'interface Web. Pour en savoir plus, consultez Lister et afficher les dépôts.

Pour aider vos utilisateurs à accéder à votre tutoriel, vous pouvez utiliser la fonctionnalité Cloud Shell Open in Cloud Shell qui vous permet de définir la manière dont les utilisateurs accèdent à votre tutoriel. Pour plus d'informations sur la personnalisation de votre lien, consultez le guide Open in Cloud Shell.

Pour un tutoriel hébergé dans un dépôt Secure Source Manager, vous devez définir le paramètre cloudshell_git_repo avec l'URL HTTPS de votre dépôt. Exemple :

https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git

Vous pouvez personnaliser ce lien en tant que bouton et l'intégrer dans votre documentation pour permettre aux utilisateurs de le trouver. Exemple :

[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git)

Personnaliser les tutoriels à l'aide de modules complémentaires

Vous pouvez personnaliser davantage votre expérience de tutoriel privé en fournissant à vos utilisateurs des outils personnalisés pour travailler avec votre tutoriel.

Pour ce faire, vous pouvez créer une image Docker qui fonctionne comme un environnement Cloud Shell personnalisé avec tous les packages et configurations personnalisés que vous souhaitez mettre à la disposition de votre utilisateur.