Questa pagina descrive i parametri di configurazione della workstation che consentono di personalizzare l'ambiente Cloud Workstations, inclusi tipo di VM, dimensioni del disco home, immagine del container di base e altro ancora. Nell'API, questi parametri di configurazione della workstation sono denominati collettivamente WorkstationConfig
.
Prima di utilizzare questi parametri di configurazione della workstation, acquisisci familiarità con quanto segue:
Crea una configurazione iniziale della workstation dalla console Google Cloud.
Esamina l'elenco delle immagini di base preconfigurate.
Scopri come personalizzare l'immagine di base e automatizzare le rigenerazioni delle immagini container.
- Risorsa: WorkstationConfig
- Host
- GceInstance
- GceShieldedInstanceConfig
- GceConfidentialInstanceConfig
- Acceleratore
- PersistentDirectory
- GceRegionalPersistentDisk
- ReclaimPolicy
- EphemeralDirectory
- GcePersistentDisk
- Container
- CustomerEncryptionKey
- ReadinessCheck
- Metodi
Risorsa: WorkstationConfig
Una risorsa di configurazione workstation nell'API Cloud Workstations.
Le configurazioni delle workstation fungono da modelli per le workstation. La configurazione della workstation definisce dettagli come il tipo di istanza di macchina virtuale (VM) workstation, l'archiviazione permanente, l'ambiente che definisce l'immagine container, l'IDE o l'editor di codice da utilizzare e altro ancora. Gli amministratori e i team della piattaforma possono anche utilizzare le regole di Identity and Access Management (IAM) per concedere l'accesso ai team o a singoli sviluppatori.
Rappresentazione 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 ( |
Campi | |
---|---|
name |
Identificatore. Nome completo di questa configurazione di workstation. |
displayName |
Facoltativo. Nome leggibile per questa configurazione di workstation. |
uid |
Solo output. Un identificatore univoco assegnato dal sistema per questa configurazione della workstation. |
reconciling |
Solo output. Indica se la configurazione della workstation è attualmente in fase di aggiornamento in modo che corrisponda allo stato previsto. |
annotations |
Facoltativo. Annotazioni specificate dal client. Un oggetto contenente un elenco di |
labels |
Facoltativo. Etichette che vengono applicate alla configurazione della workstation e propagate anche alle risorse Compute Engine sottostanti. Un oggetto contenente un elenco di |
createTime |
Solo output. Data/ora di creazione di questa configurazione della workstation. Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: |
updateTime |
Solo output. L'ora dell'ultimo aggiornamento di questa workstation. Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: |
deleteTime |
Solo output. Ora in cui questa configurazione della workstation è stata eliminata temporaneamente. Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: |
etag |
Facoltativo. Checksum calcolato dal server. Possono essere inviate in caso di richieste di aggiornamento ed eliminazione per assicurarsi che il client abbia un valore aggiornato prima di procedere. |
idleTimeout |
Facoltativo. Numero di secondi di attesa prima di arrestare automaticamente una workstation dopo l'ultima ricezione del traffico degli utenti. Il valore Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
runningTimeout |
Facoltativo. Numero di secondi in cui una workstation può essere eseguita fino all'arresto automatico. Ti consigliamo di arrestare le workstation ogni giorno per ridurre i costi e in modo che gli aggiornamenti della sicurezza possano essere applicati al riavvio. I campi Indica una durata terminata da Avviso: il valore Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
host |
Facoltativo. Host di runtime per la workstation. |
persistentDirectories[] |
Facoltativo. Directory per rimanere persistenti tra le sessioni della workstation. |
ephemeralDirectories[] |
Facoltativo. Directory temporanee che non verranno mantenute tra le sessioni della workstation. |
container |
Facoltativo. Container che viene eseguito all'avvio per ogni workstation che utilizza questa configurazione di workstation. |
encryptionKey |
Immutabile. Cripta le risorse di questa configurazione di workstation utilizzando una chiave di crittografia gestita dal cliente (CMEK). Se specificato, il disco di avvio dell'istanza Compute Engine e il disco permanente vengono criptati utilizzando questa chiave di crittografia. Se questo campo non viene impostato, i dischi vengono criptati utilizzando una chiave generata. Le chiavi di crittografia gestite dal cliente non proteggono i metadati del disco. Se la chiave di crittografia gestita dal cliente viene ruotata, quando l'istanza della workstation viene arrestata, il sistema tenta di ricreare il disco permanente con la nuova versione della chiave. Assicurati di conservare le versioni precedenti della chiave fino alla nuova creazione del disco permanente. In caso contrario, i dati sul disco permanente potrebbero andare persi. Se la chiave di crittografia viene revocata, la sessione della workstation si interrompe automaticamente entro 7 ore. Immutabile dopo la creazione della configurazione della workstation. |
readinessChecks[] |
Facoltativo. Controlli di idoneità da eseguire all'avvio di una workstation utilizzando questa configurazione della workstation. Contrassegna una workstation come in esecuzione solo dopo che tutti i controlli di idoneità specificati hanno restituito codici di stato 200. |
replicaZones[] |
Facoltativo. Immutabile. Specifica le zone utilizzate per replicare le risorse VM e disco all'interno della regione. Se viene impostato, devono essere specificate esattamente due zone all'interno della regione del cluster di workstation, ad esempio Immutabile dopo la creazione della configurazione della workstation. |
degraded |
Solo output. Indica se le prestazioni di questa risorsa sono ridotte, nel qual caso potrebbe essere necessaria un'azione dell'utente per ripristinare la funzionalità completa. Vedi anche il campo |
conditions[] |
Solo output. Condizioni di stato che descrivono lo stato attuale della risorsa. |
enableAuditAgent |
Facoltativo. Se abilitare il logging di |
disableTcpConnections |
Facoltativo. Disabilita il supporto per le connessioni TCP semplici nella workstation. Per impostazione predefinita, il servizio supporta le connessioni TCP tramite un inoltro WebSocket. Se questa opzione viene impostata su true, l'inoltro viene disattivato, impedendo l'utilizzo di servizi che richiedono connessioni TCP semplici, come SSH. Quando questa opzione è abilitata, tutte le comunicazioni devono avvenire tramite HTTPS o WSS. |
Host
Host di runtime per una workstation.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione config . Tipo di host da utilizzare per il runtime della workstation. config può essere solo uno dei seguenti: |
|
gceInstance |
Specifica un'istanza Compute Engine come host. |
GceInstance
Un runtime che utilizza un'istanza Compute Engine.
Rappresentazione JSON |
---|
{ "machineType": string, "serviceAccount": string, "serviceAccountScopes": [ string ], "tags": [ string ], "poolSize": integer, "pooledInstances": integer, "disablePublicIpAddresses": boolean, "enableNestedVirtualization": boolean, "shieldedInstanceConfig": { object ( |
Campi | |
---|---|
machineType |
Facoltativo. Il tipo di macchina da utilizzare per le istanze VM, ad esempio |
serviceAccount |
Facoltativo. L'indirizzo email dell'account di servizio per le VM Cloud Workstations create con questa configurazione. Se specificato, assicurati che l'account di servizio disponga dell'autorizzazione Se in qualità di amministratore vuoi poter eseguire Se non viene configurato, le VM vengono eseguite con un account di servizio fornito dal servizio Cloud Workstations e l'immagine deve essere accessibile pubblicamente. |
serviceAccountScopes[] |
Facoltativo. Ambiti da concedere a |
tags[] |
Facoltativo. Tag di rete da aggiungere alle VM di Compute Engine che supportano le workstation. Questa opzione applica i tag di rete alle VM create con questa configurazione. Questi tag di rete consentono la creazione di regole firewall. |
poolSize |
Facoltativo. Il numero di VM che il sistema deve mantenere inattive per consentire l'avvio rapido di nuove workstation per i nuovi utenti. Il valore predefinito è |
pooledInstances |
Solo output. Numero di istanze attualmente disponibili nel pool per un avvio più rapido della workstation. |
disablePublicIpAddresses |
Facoltativo. Se questo criterio viene impostato su true, gli indirizzi IP pubblici delle VM vengono disattivati. Se disabiliti gli indirizzi IP pubblici, devi configurare l'accesso privato Google o Cloud NAT sulla tua rete. Se utilizzi l'accesso privato Google e usi |
enableNestedVirtualization |
Facoltativo. Indica se abilitare la virtualizzazione nidificata sulle VM Cloud Workstations create utilizzando questa configurazione di workstation. La virtualizzazione nidificata ti consente di eseguire istanze di macchine virtuali (VM) all'interno della tua workstation. Prima di attivare la virtualizzazione nidificata, considera le seguenti considerazioni importanti. Le istanze Cloud Workstations sono soggette alle stesse restrizioni delle istanze di Compute Engine:
|
shieldedInstanceConfig |
Facoltativo. Un insieme di opzioni per le istanze schermate di Compute Engine. |
confidentialInstanceConfig |
Facoltativo. Un insieme di opzioni per le istanze Confidential VM di Compute Engine. |
bootDiskSizeGb |
Facoltativo. Le dimensioni del disco di avvio per la VM in gigabyte (GB). La dimensione minima del disco di avvio è |
accelerators[] |
Facoltativo. Un elenco del tipo e del numero di schede dell'acceleratore associate all'istanza. |
disableSsh |
Facoltativo. Indica se disabilitare l'accesso SSH alla VM. |
GceShieldedInstanceConfig
Un insieme di opzioni per le istanze schermate di Compute Engine.
Rappresentazione JSON |
---|
{ "enableSecureBoot": boolean, "enableVtpm": boolean, "enableIntegrityMonitoring": boolean } |
Campi | |
---|---|
enableSecureBoot |
Facoltativo. Indica se l'istanza ha Avvio protetto abilitato. |
enableVtpm |
Facoltativo. Indica se nell'istanza è abilitato vTPM. |
enableIntegrityMonitoring |
Facoltativo. Indica se nell'istanza è abilitato il monitoraggio dell'integrità. |
GceConfidentialInstanceConfig
Un insieme di opzioni per le istanze Confidential VM di Compute Engine.
Rappresentazione JSON |
---|
{ "enableConfidentialCompute": boolean } |
Campi | |
---|---|
enableConfidentialCompute |
Facoltativo. Indica se nell'istanza è abilitato il Confidential Computing. |
Acceleratore
Una scheda dell'acceleratore collegata all'istanza.
Rappresentazione JSON |
---|
{ "type": string, "count": integer } |
Campi | |
---|---|
type |
Facoltativo. Tipo di risorsa dell'acceleratore da collegare all'istanza, ad esempio |
count |
Facoltativo. Numero di schede acceleratori esposte all'istanza. |
PersistentDirectory
Una directory da mantenere tra le sessioni della workstation.
Rappresentazione JSON |
---|
{ "mountPath": string, // Union field |
Campi | |
---|---|
mountPath |
Facoltativo. Percorso di questa directory nella workstation in esecuzione. |
Campo di unione directory_type . Come implementare una directory permanente. directory_type può essere solo uno dei seguenti: |
|
gcePd |
Una PersistentDirectory supportata da un disco permanente di Compute Engine. |
GceRegionalPersistentDisk
Una directory permanente supportata da un disco permanente a livello di regione di Compute Engine. Il campo persistentDirectories
è ripetuto, ma può contenere una sola voce. Crea un disco permanente che si monta sulla VM della workstation alle ore /home
all'avvio della sessione e si scollega alla fine. Se questo campo è vuoto, le workstation create con questa configurazione non hanno una home directory permanente.
Rappresentazione JSON |
---|
{
"sizeGb": integer,
"fsType": string,
"diskType": string,
"sourceSnapshot": string,
"reclaimPolicy": enum ( |
Campi | |
---|---|
sizeGb |
Facoltativo. La capacità in GB di una home directory permanente per ogni workstation creata con questa configurazione. Deve essere vuoto se è impostato I valori validi sono |
fsType |
Facoltativo. Tipo di file system con cui deve essere formattato il disco. L'immagine della workstation deve supportare questo tipo di file system. Deve essere vuoto se è impostato |
diskType |
Facoltativo. Il tipo di disco permanente per la home directory. Il valore predefinito è |
sourceSnapshot |
Facoltativo. Nome dello snapshot da utilizzare come origine per il disco. Se impostati, i campi |
reclaimPolicy |
Facoltativo. Indica se il disco permanente deve essere eliminato quando viene eliminata la workstation. I valori validi sono |
ReclaimPolicy
Valore che rappresenta cosa dovrebbe succedere al disco dopo l'eliminazione della workstation.
Enum | |
---|---|
RECLAIM_POLICY_UNSPECIFIED |
Non utilizzare. |
DELETE |
Elimina il disco permanente durante l'eliminazione della workstation. |
RETAIN |
Conserva il disco permanente quando elimini la workstation. Un amministratore deve eliminare manualmente il disco. |
EphemeralDirectory
Una directory temporanea che non verrà persistente tra le sessioni della workstation. Viene creato di recente a ogni operazione di avvio della workstation.
Rappresentazione JSON |
---|
{ "mountPath": string, // Union field |
Campi | |
---|---|
mountPath |
obbligatorio. Percorso di questa directory nella workstation in esecuzione. |
Campo di unione directory_type . Come implementare una directory temporanea. directory_type può essere solo uno dei seguenti: |
|
gcePd |
Una directory EphemeralDirectory supportata da un disco permanente di Compute Engine. |
GcePersistentDisk
Una directory EphemeralDirectory è supportata da un disco permanente di Compute Engine.
Rappresentazione JSON |
---|
{ "diskType": string, "sourceSnapshot": string, "sourceImage": string, "readOnly": boolean } |
Campi | |
---|---|
diskType |
Facoltativo. Tipo di disco da utilizzare. Il valore predefinito è |
sourceSnapshot |
Facoltativo. Nome dello snapshot da utilizzare come origine per il disco. Deve essere vuoto se è impostato |
sourceImage |
Facoltativo. Nome dell'immagine disco da utilizzare come origine per il disco. Deve essere vuoto se è impostato |
readOnly |
Facoltativo. Indica se il disco è di sola lettura. Se il valore è true, il disco potrebbe essere condiviso da più VM e è necessario impostare |
Container
Un container Docker.
Rappresentazione JSON |
---|
{ "image": string, "command": [ string ], "args": [ string ], "env": { string: string, ... }, "workingDir": string, "runAsUser": integer } |
Campi | |
---|---|
image |
Facoltativo. Un'immagine container Docker che definisce un ambiente personalizzato. Cloud Workstations fornisce una serie di immagini preconfigurate, ma puoi creare le tue immagini container personalizzate. Se utilizzi un'immagine privata, il campo |
command[] |
Facoltativo. Se impostato, sostituisce il valore predefinito di ENTRYPOINT specificato dall'immagine. |
args[] |
Facoltativo. Argomenti passati al punto di ingresso. |
env |
Facoltativo. Variabili di ambiente passate al punto di ingresso del container. Un oggetto contenente un elenco di |
workingDir |
Facoltativo. Se impostato, sostituisce il valore predefinito di DIR specificato dall'immagine. |
runAsUser |
Facoltativo. Se impostato, sostituisce l'utente specificato nell'immagine con l'uid indicato. |
CustomerEncryptionKey
Una chiave di crittografia gestita dal cliente (CMEK) per le risorse Compute Engine della configurazione della workstation associata. Specifica il nome della tua chiave di crittografia Cloud KMS e l'account di servizio predefinito. Ti consigliamo di utilizzare un account di servizio separato e di seguire le best practice di Cloud KMS.
Rappresentazione JSON |
---|
{ "kmsKey": string, "kmsKeyServiceAccount": string } |
Campi | |
---|---|
kmsKey |
Immutabile. Il nome della chiave di crittografia di Google Cloud KMS. Ad esempio, |
kmsKeyServiceAccount |
Immutabile. L'account di servizio da utilizzare con la chiave KMS specificata. Ti consigliamo di utilizzare un account di servizio separato e di seguire le best practice KMS. Per ulteriori informazioni, consulta gli articoli Separazione dei compiti e |
ReadinessCheck
Un controllo di idoneità da eseguire su una workstation.
Rappresentazione JSON |
---|
{ "path": string, "port": integer } |
Campi | |
---|---|
path |
Facoltativo. Percorso a cui deve essere inviata la richiesta. |
port |
Facoltativo. Porta a cui deve essere inviata la richiesta. |
Metodi |
|
---|---|
|
Crea una nuova configurazione di workstation. |
|
Elimina la configurazione della workstation specificata. |
|
Restituisce la configurazione della workstation richiesta. |
|
Ottieni il criterio di controllo dell'accesso per una risorsa. |
|
Restituisce tutte le configurazioni di workstation nel cluster specificato. |
|
Restituisce tutte le configurazioni di workstation nel cluster specificato in cui il chiamante dispone dell'autorizzazione "workstations.workstation.create". |
|
Aggiorna la configurazione di una workstation esistente. |
|
Imposta il criterio di controllo dell'accesso sulla risorsa specificata. |
|
Restituisce le autorizzazioni di cui un chiamante dispone per la risorsa specificata. |