Buka di Cloud Shell

Fitur Buka di Cloud Shell memungkinkan Anda memublikasikan link yang membuka konsol dengan repositori Git yang di-clone ke Cloud Shell dan/atau memulai Cloud Shell dengan image kustom. Google Cloud Anda juga dapat mencetak petunjuk ke terminal untuk membantu pengguna berinteraksi dengan konten.

Link Buka di Cloud Shell membantu developer bereksperimen dengan contoh kode dan API Anda tanpa harus mendownload Google Cloud CLI, menginstal dependensi yang diperlukan, atau menelusuri file sumber yang relevan. Halaman ini menjelaskan cara menambahkan link Buka di Cloud Shell ke repositori Git Anda.

Parameter URL

Link Buka di Cloud Shell, yang secara opsional disematkan dalam gambar tombol, dapat ditambahkan ke file README.md di direktori mana pun di repositori Git Anda. Lokasi yang direkomendasikan untuk link ini adalah file README.md root repositori Git Anda.

Parameter URL wajib diisi

Untuk membuat link ini, gunakan URL dasar shell.cloud.google.com (atau halaman apa pun di konsol Google Cloud yang diawali dengan console.cloud.google.com) dengan parameter URL wajib berikut:

Parameter URL Deskripsi Nilai yang Didukung
cloudshell_git_repo

URL repositori Git yang akan di-clone.

Setelah repositori di-clone, root folder project akan dibuka, menampilkan isinya di panel navigasi kiri.

URL yang valid untuk repositori Git.

URL ini terdiri dari domain yang diizinkan (GitHub atau Bitbucket) dan jalur. Karakter berikut diizinkan: huruf besar dan kecil, digit, garis bawah (_), tanda hubung (-), titik (.), dan garis miring (/).

Hanya repo yang ada dalam daftar yang dimiliki oleh Google yang akan dibuka di lingkungan Cloud Shell default dan memiliki akses ke kredensial pengguna. Semua repositori lainnya akan menggunakan lingkungan Cloud Shell sementara tanpa akses ke kredensial pengguna.

Parameter URL opsional

Anda juga dapat menentukan salah satu parameter opsional berikut:

Parameter URL Deskripsi Nilai yang Didukung
cloudshell_git_branch Cabang dari repositori Git yang akan di-clone. Hanya berlaku jika cloudshell_git_repo ditentukan. Cabang default-nya adalah master. Cabang yang valid di repositori. Karakter berikut diizinkan: huruf besar dan huruf kecil, digit, tilde (~), garis bawah (_), tanda hubung (-), titik (.), garis miring (/), dan titik dua (:).
cloudshell_image

Image Docker kustom yang menjalankan lingkungan yang disesuaikan selama sesi. Dengan begitu, Anda dapat menyediakan alat kustom di Cloud Shell yang dapat digunakan pengguna untuk berinteraksi dengan repositori Anda.

Membuka repositori di Cloud Shell dengan parameter ini yang ditentukan akan membuat lingkungan sementara dengan direktori beranda sementara yang dihapus saat sesi berakhir.

URL image Docker yang dihosting di Artifact Registry. Image Docker harus didasarkan pada image dasar Cloud Shell dan dapat diakses secara publik.

Untuk membuat image yang valid, gunakan tutorial pembuatan image kustom yang dapat dimulai dengan menjalankan perintah berikut di Cloud Shell:

cloudshell launch-tutorial /google/devshell/tutorials/custom-image-tutorial.md

Perhatikan bahwa gambar berukuran besar memerlukan waktu beberapa saat untuk didownload ke VM Cloud Shell saat URL dibuka.

cloudshell_open_in_editor

File yang akan dibuka di Cloud Shell Editor. Dapat diulang untuk menentukan beberapa file yang akan dibuka. Jika ada beberapa yang ditentukan, halaman tersebut akan terbuka dalam urutan yang diberikan.

File yang ditentukan akan dibuka di tab editor sebelah kanan, satu tab per file, di project yang dibuka.

Jalur file bersifat relatif terhadap direktori saat ini. Jika parameter working_dir diberikan, jalur ke file ini diperlakukan sebagai relatif terhadap working_dir.

Jalur file valid yang terdiri dari karakter yang diizinkan berikut: huruf besar dan kecil, digit, tilde (~), garis bawah (_), tanda hubung (-), titik (.), garis miring ke depan (/), dan titik dua (:).
cloudshell_print

File di repositori Git, biasanya berisi petunjuk yang akan dicetak ke terminal untuk memandu langkah selanjutnya pengguna. Jalur file relatif terhadap direktori saat ini.

Jika parameter working_dir diberikan, jalur ke file ini akan diperlakukan sebagai relatif terhadap working_dir.

Jalur file valid yang terdiri dari karakter yang diizinkan berikut: huruf besar dan kecil, digit, tilde (~), garis bawah (_), tanda hubung (-), titik (.), garis miring ke depan (/), dan titik dua (:).
cloudshell_tutorial

File Tutorial Markdown di repositori Git yang berisi petunjuk untuk diluncurkan sebagai tutorial guna memandu pengguna menyelesaikan project. Jalur file bersifat relatif terhadap direktori saat ini.

File Markdown Tutorial yang dibuat dengan baik dan memiliki nama file yang valid.

cloudshell_working_dir (Tidak digunakan lagi)

Parameter ini tidak digunakan lagi. Sebagai gantinya, gunakan cloudshell_workspace.

Jalur file valid yang terdiri dari karakter yang diizinkan berikut: huruf besar dan kecil, digit, tilde (~), garis bawah (_), tanda hubung (-), titik (.), garis miring ke depan (/), dan titik dua (:).
cloudshell_workspace Direktori kerja untuk Cloud Shell. Terminal akan terbuka di direktori yang ditentukan. Cloud Shell Editor akan membuka direktori sebagai ruang kerja. Jalur file valid apa pun yang relatif terhadap repositori yang di-clone. Anda dapat membiarkan nilai parameter kosong atau menggunakan . untuk menentukan root repositori yang di-clone. Jika tidak ada repositori yang ditentukan, jalur relatif terhadap direktori utama Cloud Shell. Karakter berikut diizinkan: huruf besar dan huruf kecil, digit, tilde (~), garis bawah (_), tanda hubung (-), titik (.), garis miring (/), dan titik dua (:).
ephemeral Membuka repositori di Cloud Shell dengan parameter ini yang ditentukan akan membuat lingkungan sementara dengan direktori beranda sementara yang dihapus saat sesi berakhir. Untuk mengetahui informasi selengkapnya, lihat Memilih mode sementara.

true, false

show

Buka hanya dengan terminal, hanya dengan Cloud Shell Editor, atau keduanya.

ide, terminal, ide%2Cterminal

Contoh

Untuk menyematkan tombol guna membuka repositori Git contoh di Cloud Shell, sertakan Markdown berikut dalam file README.md repositori Anda:

  [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git)

Untuk menyematkan fungsi yang sama ke dalam situs, gunakan cuplikan HTML yang setara ini:

  <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>

Untuk menentukan perilaku link Buka di Cloud Shell secara lebih spesifik, Anda dapat menggunakan formulir di bawah untuk bereksperimen dengan parameter yang diperlukan untuk membuka repositori Anda di Cloud Shell.