Cloud Shell で限定公開チュートリアルを作成する

Cloud Shell では限定公開チュートリアルを作成できるため、受講者専用のチュートリアルを設計できます。

Cloud Shell のチュートリアルの作成ガイドを使用してチュートリアルを作成し、チュートリアル スタイルガイドに記載されているベスト プラクティスを実践すると、ユーザーが利用できるよう、プライベート Git リポジトリにチュートリアルをホストできます。

任意の Git リポジトリ ホスティング サービスを使用できます。このガイドでは、 Google Cloudでホストされるリージョンにデプロイされた単一テナントのマネージド ソースコード リポジトリである Secure Source Manager を使用して、手順を説明します。

プライベート Git リポジトリを作成する

Secure Source Manager インスタンスは、使用可能な Google Cloudリージョンにデプロイされ、インスタンス URI を介してアクセスできます。リポジトリは、ウェブ インターフェースまたは Secure Source Manager API を使用して Secure Source Manager インスタンスに作成されます。

限定公開チュートリアルをホストする Secure Source Manager リポジトリを作成するには、次の操作を行います。

  1. Cloud Shell ターミナルを起動します。スタンドアロンの Cloud Shell セッションでは、shell.cloud.google.com を使用します。

  2. Secure Source Manager インスタンスをまだ作成していない場合は作成します。

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

    次のように置き換えます。

    • INSTANCE_ID: Secure Source Manager インスタンスの ID。
    • LOCATION: インスタンスを作成するリージョン（us-central1 など）。

    インスタンスの作成には最大 60 分かかります。

  3. ウェブ インターフェースから Secure Source Manager インスタンスにアクセスするには、次の URL をブラウザのアドレスバーにコピーします。

    INSTANCE_ID-PROJECT_NUMBER.LOCATION.sourcemanager.dev

    PROJECT_NUMBER は、インスタンスの Google Cloud プロジェクト番号に置き換えます。

  4. プライベート リポジトリを作成します。

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

    REPO_ID は、Secure Source Manager リポジトリの ID に置き換えます。

    リポジトリの作成に必要な権限については、必要なロールをご覧ください。

  5. Secure Source Manager 認証ヘルパーをグローバル Git 構成に追加します。詳細については、認証情報を設定するをご覧ください。

  6. Cloud Shell にリポジトリのクローンを作成します。

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

    PROJECT_ID は、インスタンスの Google Cloud プロジェクト ID に置き換えます。

  7. チュートリアル ファイルをローカルに作成したリポジトリに移動します。

    mv PATH_TO_TUTORIAL REPO_ID/PATH_TO_TUTORIAL

    PATH_TO_TUTORIAL は、非公開チュートリアルのパスに置き換えます。

  8. ローカル リポジトリに移動します。

    cd REPO_ID

  9. チュートリアル ファイルを追加、commit、push します。

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

  10. Secure Source Manager リポジトリはウェブ インターフェースで確認できます。詳細については、リポジトリを一覧表示して表示するをご覧ください。

ユーザーがチュートリアルにアクセスできるよう、Cloud Shell の [Cloud Shell で開く] 機能を使用して、ユーザーがチュートリアルにアクセスする方法を定義できます。リンクをカスタマイズする方法について詳しくは、[Cloud Shell で開く] ガイドをご覧ください。

Secure Source Manager リポジトリでホストされているチュートリアルの場合は、リポジトリの HTTPS URL を指定して cloudshell_git_repo パラメータを定義する必要があります。次に例を示します。

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

このリンクをボタンとしてドキュメントに埋め込んで、ユーザーが簡単に見つけられるようにできます。次に例を示します。

[![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)

アドオンツールを使用してチュートリアルをカスタマイズする

チュートリアルを使用して作業するためのカスタムツールをユーザーに提供することで、限定公開のチュートリアル エクスペリエンスをさらにカスタマイズできます。

これを行うには、ユーザーに使用を許可する追加パッケージとカスタム構成をすべて使用して、カスタム Cloud Shell 環境として機能する Docker イメージを作成します。