Halaman ini menjelaskan parameter konfigurasi workstation yang memungkinkan Anda menyesuaikan lingkungan Cloud Workstations, termasuk jenis VM, ukuran disk beranda, image container dasar, dan lainnya. Di API, parameter konfigurasi workstation ini secara kolektif disebut sebagai
WorkstationConfig
.
Sebelum menggunakan parameter konfigurasi workstation ini, pahami hal-hal berikut:
Buat konfigurasi workstation awal dari Konsol Google Cloud.
Tinjau daftar Image dasar yang telah dikonfigurasi sebelumnya.
Baca cara menyesuaikan image dasar dan mengotomatiskan pembuatan ulang image container.
- Resource: WorkstationConfig
- Host
- GceInstance
- GceShieldedInstanceConfig
- GceConfidentialInstanceConfig
- Akselerator
- PersistentDirectory
- GceRegionalPersistentDisk
- ReclaimPolicy
- EphemeralDirectory
- GcePersistentDisk
- Penampung
- CustomerEncryptionKey
- ReadinessCheck
- Metode
Resource: WorkstationConfig
Resource konfigurasi workstation di Cloud Workstation API.
Konfigurasi workstation berfungsi sebagai template untuk workstation. Konfigurasi workstation menentukan detail seperti jenis instance virtual machine (VM) workstation, penyimpanan persisten, lingkungan yang menentukan image container, IDE atau Editor Kode mana yang akan digunakan, dan lainnya. Administrator dan tim platform juga dapat menggunakan aturan Identity and Access Management (IAM) untuk memberikan akses kepada tim atau kepada masing-masing developer.
Representasi JSON |
---|
{ "name": string, "displayName": string, "uid": string, "reconciling": boolean, "annotations": { string: string, ... }, "labels": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "etag": string, "idleTimeout": string, "runningTimeout": string, "host": { object ( |
Kolom | |
---|---|
name |
Pengenal. Nama lengkap konfigurasi workstation ini. |
displayName |
Opsional. Nama yang dapat dibaca manusia untuk konfigurasi workstation ini. |
uid |
Hanya output. ID unik yang ditetapkan sistem untuk konfigurasi workstation ini. |
reconciling |
Hanya output. Menunjukkan apakah konfigurasi workstation ini sedang diupdate agar sesuai dengan status yang diinginkan. |
annotations |
Opsional. Anotasi yang ditentukan klien. Objek yang berisi daftar pasangan |
labels |
Opsional. Label yang diterapkan ke konfigurasi workstation dan juga yang diterapkan ke resource Compute Engine yang mendasarinya. Objek yang berisi daftar pasangan |
createTime |
Hanya output. Waktu saat konfigurasi workstation ini dibuat. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: |
updateTime |
Hanya output. Waktu saat konfigurasi workstation ini diperbarui terakhir. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: |
deleteTime |
Hanya output. Waktu saat konfigurasi workstation ini dihapus untuk sementara. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: |
etag |
Opsional. Checksum yang dihitung oleh server. Dapat dikirim pada saat permintaan pembaruan dan penghapusan untuk memastikan bahwa klien memiliki nilai terbaru sebelum melanjutkan. |
idleTimeout |
Opsional. Jumlah detik untuk menunggu sebelum menghentikan workstation secara otomatis setelah traffic pengguna terakhir diterima. Nilai Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan ' |
runningTimeout |
Opsional. Jumlah detik workstation dapat berjalan hingga workstation dimatikan secara otomatis. Sebaiknya matikan workstation setiap hari untuk mengurangi biaya dan agar update keamanan dapat diterapkan setelah mulai ulang. Kolom Berikan durasi yang dihentikan oleh Peringatan: Nilai Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan ' |
host |
Opsional. Host runtime untuk workstation. |
persistentDirectories[] |
Opsional. Direktori yang akan bertahan di seluruh sesi workstation. |
ephemeralDirectories[] |
Opsional. Direktori efemeral yang tidak akan dipertahankan di seluruh sesi workstation. |
container |
Opsional. Container yang berjalan saat startup untuk setiap workstation menggunakan konfigurasi workstation ini. |
encryptionKey |
Tidak dapat diubah. Mengenkripsi resource konfigurasi workstation ini menggunakan kunci enkripsi yang dikelola pelanggan (CMEK). Jika ditentukan, boot disk instance Compute Engine dan persistent disk akan dienkripsi menggunakan kunci enkripsi ini. Jika kolom ini tidak disetel, disk akan dienkripsi menggunakan kunci yang dibuat. Kunci enkripsi yang dikelola pelanggan tidak melindungi metadata disk. Jika kunci enkripsi yang dikelola pelanggan dirotasi, saat instance workstation dihentikan, sistem akan mencoba membuat ulang persistent disk dengan kunci versi baru. Pastikan untuk menyimpan versi kunci yang lebih lama hingga persistent disk dibuat ulang. Jika tidak, data di persistent disk mungkin hilang. Jika kunci enkripsi dicabut, sesi workstation akan otomatis berhenti dalam waktu 7 jam. Tidak dapat diubah setelah konfigurasi workstation dibuat. |
readinessChecks[] |
Opsional. Pemeriksaan kesiapan yang harus dilakukan saat memulai workstation menggunakan konfigurasi workstation ini. Menandai workstation sebagai berjalan hanya setelah semua pemeriksaan kesiapan yang ditentukan menampilkan 200 kode status. |
replicaZones[] |
Opsional. Tidak dapat diubah. Menentukan zona yang digunakan untuk mereplikasi resource VM dan disk dalam region. Jika ditetapkan, tepatnya dua zona dalam region cluster workstation harus ditentukan—misalnya, Tidak dapat diubah setelah konfigurasi workstation dibuat. |
degraded |
Hanya output. Apakah resource ini didegradasi, dalam hal ini mungkin memerlukan tindakan pengguna untuk memulihkan fungsi penuh. Lihat juga kolom |
conditions[] |
Hanya output. Kondisi status yang menjelaskan status resource saat ini. |
enableAuditAgent |
Opsional. Apakah akan mengaktifkan logging |
disableTcpConnections |
Opsional. Menonaktifkan dukungan untuk koneksi TCP biasa di workstation. Secara default, layanan mendukung koneksi TCP melalui relai websocket. Menyetel opsi ini ke true akan menonaktifkan relai tersebut, yang mencegah penggunaan layanan yang memerlukan koneksi TCP biasa, seperti SSH. Jika diaktifkan, semua komunikasi harus dilakukan melalui HTTPS atau WSS. |
Host
Host runtime untuk workstation.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union config . Jenis host yang akan digunakan untuk runtime workstation. config hanya ada berupa salah satu diantara berikut: |
|
gceInstance |
Menentukan instance Compute Engine sebagai host. |
GceInstance
Runtime yang menggunakan instance Compute Engine.
Representasi JSON |
---|
{ "machineType": string, "serviceAccount": string, "serviceAccountScopes": [ string ], "tags": [ string ], "poolSize": integer, "pooledInstances": integer, "disablePublicIpAddresses": boolean, "enableNestedVirtualization": boolean, "shieldedInstanceConfig": { object ( |
Kolom | |
---|---|
machineType |
Opsional. Jenis mesin yang akan digunakan untuk instance VM—misalnya, |
serviceAccount |
Opsional. Alamat email akun layanan untuk VM Cloud Workstations yang dibuat dengan konfigurasi ini. Jika ditentukan, pastikan akun layanan memiliki izin Jika Anda sebagai administrator ingin dapat melakukan Jika tidak disetel, VM akan dijalankan dengan akun layanan yang disediakan oleh layanan Cloud Workstations, dan image harus dapat diakses secara publik. |
serviceAccountScopes[] |
Opsional. Cakupan yang akan diberikan kepada |
tags[] |
Opsional. Tag jaringan yang akan ditambahkan ke VM Compute Engine yang mendukung workstation. Opsi ini menerapkan tag jaringan ke VM yang dibuat dengan konfigurasi ini. Tag jaringan ini memungkinkan pembuatan aturan firewall. |
poolSize |
Opsional. Jumlah VM yang harus tetap tidak aktif oleh sistem sehingga workstation baru dapat dimulai dengan cepat untuk pengguna baru. Nilai defaultnya adalah |
pooledInstances |
Hanya output. Jumlah instance yang saat ini tersedia di kumpulan untuk startup workstation yang lebih cepat. |
disablePublicIpAddresses |
Opsional. Jika disetel ke benar (true), alamat IP publik untuk VM akan dinonaktifkan. Jika menonaktifkan alamat IP publik, Anda harus menyiapkan Akses Google Pribadi atau Cloud NAT di jaringan Anda. Jika Anda menggunakan Akses Google Pribadi dan menggunakan |
enableNestedVirtualization |
Opsional. Apakah akan mengaktifkan virtualisasi bertingkat pada VM Cloud Workstations yang dibuat menggunakan konfigurasi workstation ini. Virtualisasi bertingkat memungkinkan Anda menjalankan instance virtual machine (VM) di dalam workstation. Sebelum mengaktifkan virtualisasi bertingkat, pertimbangkan pertimbangan penting berikut. Instance Cloud Workstations tunduk pada batasan yang sama seperti instance Compute Engine:
|
shieldedInstanceConfig |
Opsional. Kumpulan opsi instance Compute Engine Shielded. |
confidentialInstanceConfig |
Opsional. Kumpulan opsi instance Compute Engine Confidential VM. |
bootDiskSizeGb |
Opsional. Ukuran boot disk untuk VM dalam gigabyte (GB). Ukuran boot disk minimum adalah |
accelerators[] |
Opsional. Daftar jenis dan jumlah kartu akselerator yang dilampirkan ke instance. |
disableSsh |
Opsional. Apakah akan menonaktifkan akses SSH ke VM. |
GceShieldedInstanceConfig
Kumpulan opsi instance Compute Engine Shielded.
Representasi JSON |
---|
{ "enableSecureBoot": boolean, "enableVtpm": boolean, "enableIntegrityMonitoring": boolean } |
Kolom | |
---|---|
enableSecureBoot |
Opsional. Apakah instance telah mengaktifkan Booting Aman. |
enableVtpm |
Opsional. Apakah instance mengaktifkan vTPM. |
enableIntegrityMonitoring |
Opsional. Apakah instance mengaktifkan pemantauan integritas. |
GceConfidentialInstanceConfig
Kumpulan opsi instance Compute Engine Confidential VM.
Representasi JSON |
---|
{ "enableConfidentialCompute": boolean } |
Kolom | |
---|---|
enableConfidentialCompute |
Opsional. Apakah instance telah mengaktifkan komputasi rahasia. |
Akselerator
Kartu akselerator yang terpasang pada instance.
Representasi JSON |
---|
{ "type": string, "count": integer } |
Kolom | |
---|---|
type |
Opsional. Jenis resource akselerator yang akan ditambahkan ke instance, misalnya, |
count |
Opsional. Jumlah kartu akselerator yang diekspos ke instance. |
PersistentDirectory
Direktori yang akan dipertahankan di seluruh sesi workstation.
Representasi JSON |
---|
{ "mountPath": string, // Union field |
Kolom | |
---|---|
mountPath |
Opsional. Lokasi direktori ini di workstation yang berjalan. |
Kolom union directory_type . Cara menerapkan direktori persisten. directory_type hanya ada berupa salah satu diantara berikut: |
|
gcePd |
PersistentDirectory yang didukung oleh persistent disk Compute Engine. |
GceRegionalPersistentDisk
Direktori Persisten yang didukung oleh persistent disk regional Compute Engine. Kolom persistentDirectories
diulang, tetapi hanya dapat berisi satu entri. Ini akan membuat persistent disk yang terpasang ke VM workstation di /home
saat sesi dimulai dan dilepas saat sesi berakhir. Jika kolom ini kosong, workstation yang dibuat dengan konfigurasi ini tidak memiliki direktori utama yang persisten.
Representasi JSON |
---|
{
"sizeGb": integer,
"fsType": string,
"diskType": string,
"sourceSnapshot": string,
"reclaimPolicy": enum ( |
Kolom | |
---|---|
sizeGb |
Opsional. Kapasitas GB pada direktori utama persisten untuk setiap workstation yang dibuat dengan konfigurasi ini. Harus kosong jika Nilai yang valid adalah |
fsType |
Opsional. Jenis sistem file tempat disk harus diformat. Image workstation harus mendukung jenis sistem file ini. Harus kosong jika |
diskType |
Opsional. Jenis persistent disk untuk direktori utama. Nilai defaultnya adalah |
sourceSnapshot |
Opsional. Nama snapshot yang akan digunakan sebagai sumber disk. Jika ditetapkan, |
reclaimPolicy |
Opsional. Apakah persistent disk harus dihapus saat workstation dihapus. Nilai yang valid adalah |
ReclaimPolicy
Nilai yang mewakili apa yang akan terjadi pada disk setelah workstation dihapus.
Enum | |
---|---|
RECLAIM_POLICY_UNSPECIFIED |
Jangan gunakan. |
DELETE |
Hapus persistent disk saat menghapus workstation. |
RETAIN |
Pertahankan persistent disk saat menghapus workstation. Administrator harus menghapus disk secara manual. |
EphemeralDirectory
Direktori {i>ephemeral<i} yang tidak akan dipertahankan di seluruh sesi {i>workstation<i}. File ini baru dibuat pada setiap operasi awal workstation.
Representasi JSON |
---|
{ "mountPath": string, // Union field |
Kolom | |
---|---|
mountPath |
Wajib. Lokasi direktori ini di workstation yang berjalan. |
Kolom union directory_type . Cara mengimplementasikan direktori efemeral. directory_type hanya ada berupa salah satu diantara berikut: |
|
gcePd |
EphemeralDirectory yang didukung oleh persistent disk Compute Engine. |
GcePersistentDisk
EphemeralDirectory didukung oleh persistent disk Compute Engine.
Representasi JSON |
---|
{ "diskType": string, "sourceSnapshot": string, "sourceImage": string, "readOnly": boolean } |
Kolom | |
---|---|
diskType |
Opsional. Jenis disk yang akan digunakan. Nilai defaultnya adalah |
sourceSnapshot |
Opsional. Nama snapshot yang akan digunakan sebagai sumber disk. Harus kosong jika |
sourceImage |
Opsional. Nama disk image yang akan digunakan sebagai sumber disk. Harus kosong jika |
readOnly |
Opsional. Apakah disk bersifat hanya baca. Jika true (benar), disk dapat digunakan bersama oleh beberapa VM dan |
Container
Container Docker.
Representasi JSON |
---|
{ "image": string, "command": [ string ], "args": [ string ], "env": { string: string, ... }, "workingDir": string, "runAsUser": integer } |
Kolom | |
---|---|
image |
Opsional. Image container Docker yang menentukan lingkungan kustom. Cloud Workstations menyediakan sejumlah image yang telah dikonfigurasi sebelumnya, tetapi Anda dapat membuat image container kustom sendiri. Jika menggunakan gambar pribadi, kolom |
command[] |
Opsional. Jika ditetapkan, akan mengganti ENTRYPOINT default yang ditentukan oleh gambar. |
args[] |
Opsional. Argumen yang diteruskan ke titik entri. |
env |
Opsional. Variabel lingkungan yang diteruskan ke titik entri container. Objek yang berisi daftar pasangan |
workingDir |
Opsional. Jika disetel, akan menimpa DIR default yang ditentukan oleh gambar. |
runAsUser |
Opsional. Jika disetel, akan mengganti USER yang ditentukan dalam gambar dengan uid yang diberikan. |
CustomerEncryptionKey
Kunci enkripsi yang dikelola pelanggan (Customer-Managed Encryption Key/CMEK) untuk resource Compute Engine dari konfigurasi workstation yang terkait. Tentukan nama kunci enkripsi Cloud KMS dan akun layanan default Anda. Sebaiknya gunakan akun layanan yang terpisah dan ikuti praktik terbaik Cloud KMS.
Representasi JSON |
---|
{ "kmsKey": string, "kmsKeyServiceAccount": string } |
Kolom | |
---|---|
kmsKey |
Tidak dapat diubah. Nama kunci enkripsi Google Cloud KMS. Misalnya, |
kmsKeyServiceAccount |
Tidak dapat diubah. Akun layanan yang akan digunakan dengan kunci KMS yang ditentukan. Sebaiknya gunakan akun layanan yang terpisah dan ikuti praktik terbaik KMS. Untuk informasi selengkapnya, lihat Pemisahan tugas dan |
ReadinessCheck
Pemeriksaan kesiapan yang akan dilakukan di workstation.
Representasi JSON |
---|
{ "path": string, "port": integer } |
Kolom | |
---|---|
path |
Opsional. Jalur ke mana permintaan harus dikirim. |
port |
Opsional. Port tujuan pengiriman permintaan. |
Metode |
|
---|---|
|
Membuat konfigurasi workstation baru. |
|
Menghapus konfigurasi workstation yang ditentukan. |
|
Menampilkan konfigurasi workstation yang diminta. |
|
Mendapatkan kebijakan kontrol akses untuk resource. |
|
Menampilkan semua konfigurasi workstation di cluster yang ditentukan. |
|
Menampilkan semua konfigurasi workstation di cluster yang ditentukan tempat pemanggil memiliki izin "workstations.workstation.create". |
|
Memperbarui konfigurasi workstation yang ada. |
|
Menetapkan kebijakan kontrol akses pada resource yang ditentukan. |
|
Menampilkan izin yang dimiliki pemanggil atas resource yang ditentukan. |