Recurso: ambiente de execução
A definição de um ambiente de execução para uma instância de notebook gerenciado.
| Representação JSON |
|---|
{ "name": string, "state": enum ( |
| Campos | |
|---|---|
name |
Apenas saída. O nome do recurso do ambiente de execução. Formato: |
state |
Apenas saída. Estado do ambiente de execução. |
healthState |
Apenas saída. Runtime healthState. |
accessConfig |
As configurações de configuração para acessar o tempo de execução. |
softwareConfig |
As configurações de configuração para software no tempo de execução. |
metrics |
Apenas saída. Contém métricas do daemon do ambiente de execução, como status do serviço e estatísticas do JupyterLab. |
createTime |
Apenas saída. Tempo de criação do ambiente de execução. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: |
updateTime |
Apenas saída. Horário da atualização do ambiente de execução. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: |
labels |
Opcional. Os rótulos a serem associados a este notebook gerenciado ou ambiente de execução. As chaves de rótulo precisam ter de 1 a 63 caracteres e estar em conformidade com a RFC 1035. Os valores de rótulo podem estar vazios, mas, se estiverem presentes, precisam ter de 1 a 63 caracteres e estar em conformidade com o RFC 1035. Não é possível associar mais de 32 rótulos a um cluster. Um objeto com uma lista de pares |
runtimeMigrationEligibility |
Apenas saída. Verifica a viabilidade de uma migração do GmN para o WbI. |
| Tipo do ambiente de execução. No momento, só é compatível com a VM do Compute Engine. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
virtualMachine |
Use uma imagem de VM do Compute Engine para iniciar a instância de notebook gerenciado. |
| Fim dos campos mutuamente exclusivos. | |
migrated |
Apenas saída. Booleano que indica se este notebook foi migrado para uma instância do Workbench |
VirtualMachine
Tempo de execução usando máquina virtual para computação.
| Representação JSON |
|---|
{
"instanceName": string,
"instanceId": string,
"virtualMachineConfig": {
object ( |
| Campos | |
|---|---|
instanceName |
Apenas saída. O nome fácil de usar da instância gerenciada do Compute Engine. |
instanceId |
Apenas saída. O identificador exclusivo da instância gerenciada do Compute Engine. |
virtualMachineConfig |
Configurações de configuração da máquina virtual. |
VirtualMachineConfig
As configurações de configuração da máquina virtual.
| Representação JSON |
|---|
{ "zone": string, "machineType": string, "containerImages": [ { object ( |
| Campos | |
|---|---|
zone |
Apenas saída. A zona em que a máquina virtual está localizada. Se você usar uma solicitação regional, o serviço de notebooks vai escolher um local na região de execução correspondente. Em uma solicitação GET, a zona sempre estará presente. Exemplo: * |
machineType |
Obrigatório. O tipo de máquina do Compute Engine usado para ambientes de execução. O nome abreviado é válido. Exemplos: * |
containerImages[] |
Opcional. Use uma lista de imagens de contêiner para usar como kernels na instância de notebook. |
dataDisk |
Obrigatório. Configurações de configuração da opção de disco de dados. |
encryptionConfig |
Opcional. Configurações de criptografia para o disco de dados da máquina virtual. |
shieldedInstanceConfig |
Opcional. Configurações de configuração da instância de VM protegida. |
acceleratorConfig |
Opcional. A configuração do acelerador do Compute Engine para este ambiente de execução. |
network |
Opcional. A rede do Compute Engine a ser usada para comunicações da máquina. Não pode ser especificado com sub-rede. Se nem Um URL completo ou um URI parcial. Exemplos:
Os runtimes são recursos gerenciados na infraestrutura do Google. Os ambientes de execução são compatíveis com as seguintes configurações de rede:
|
subnet |
Opcional. A sub-rede do Compute Engine a ser usada para comunicações da máquina. Não pode ser especificado com a rede. Um URL completo ou um URI parcial são válidos. Exemplos:
|
internalIpOnly |
Opcional. Se for "true", o ambiente de execução terá apenas endereços IP internos. Por padrão, os runtimes não são restritos a endereços IP internos e têm endereços IP externo temporários atribuídos a cada VM. Essa restrição |
tags[] |
Opcional. As tags de rede do Compute Engine a serem adicionadas ao tempo de execução. Consulte Adicionar tags de rede. |
guestAttributes |
Apenas saída. Os atributos de convidado do Compute Engine. Consulte Atributos de convidado do projeto e da instância. Um objeto com uma lista de pares |
metadata |
Opcional. As entradas de metadados do Compute Engine a serem adicionadas à máquina virtual. Consulte Metadados de projeto e instância. Um objeto com uma lista de pares |
labels |
Opcional. Os rótulos a serem associados a esse tempo de execução. As chaves de rótulo precisam ter de 1 a 63 caracteres e estar em conformidade com a RFC 1035. Os valores de rótulo podem estar vazios, mas, se estiverem presentes, precisam ter de 1 a 63 caracteres e estar em conformidade com o RFC 1035. Não é possível associar mais de 32 rótulos a um cluster. Um objeto com uma lista de pares |
nicType |
Opcional. O tipo de vNIC a ser usado nessa interface. Pode ser gVNIC ou VirtioNet. |
reservedIpRange |
Opcional. O nome do intervalo de IP reservado é usado para o peering de VPC. A alocação de sub-rede usará o nome do intervalo se ele for atribuído. Exemplo: managed-notebooks-range-c O valor do campo será: |
bootImage |
Opcional. Metadados da imagem de inicialização usados para capacidade de upgrade do ambiente de execução. |
LocalDisk
Um recurso de disco anexado local.
| Representação JSON |
|---|
{ "autoDelete": boolean, "boot": boolean, "deviceName": string, "guestOsFeatures": [ { object ( |
| Campos | |
|---|---|
autoDelete |
Opcional. Apenas saída. Especifica se o disco será excluído automaticamente quando a instância for excluída (mas não quando o disco for desanexado da instância). |
boot |
Opcional. Apenas saída. Indica que este é um disco de inicialização. A máquina virtual vai usar a primeira partição do disco para o sistema de arquivos raiz. |
deviceName |
Opcional. Apenas saída. Especifica um nome de dispositivo exclusivo de sua escolha que é refletido na árvore Se não for especificado, o servidor vai escolher um nome de dispositivo padrão para aplicar a esse disco, no formato persistent-disk-x, em que x é um número atribuído pelo Google Compute Engine. Esse campo só é aplicável a discos permanentes. |
guestOsFeatures[] |
Apenas saída. Indica uma lista de recursos a serem ativados no sistema operacional convidado. Aplicável apenas a imagens inicializáveis. Leia "Ativar recursos do sistema operacional convidado" para conferir uma lista de opções disponíveis. |
index |
Apenas saída. Um índice baseado em zero para este disco, em que 0 é reservado para o disco de inicialização. Se você tiver muitos discos anexados a uma instância, cada um terá um número de índice exclusivo. |
initializeParams |
Somente entrada. Especifica os parâmetros de um novo disco que será criado junto com a nova instância. Use parâmetros de inicialização para criar discos de inicialização ou SSDs locais anexados à nova instância. Essa propriedade é mutuamente exclusiva com a propriedade de origem. Só é possível definir uma ou outra, mas não ambas. |
interface |
Especifica a interface de disco a ser usada para anexar este disco, que é SCSI ou NVME. O padrão é SCSI. Os discos permanentes sempre precisam usar SCSI, e a solicitação vai falhar se você tentar anexar um disco permanente em qualquer outro formato. Os SSDs locais podem usar NVME ou SCSI. Para conhecer as características de desempenho do SCSI no NVMe, consulte "Desempenho do SSD local". Valores válidos:
|
kind |
Apenas saída. Tipo do recurso. Sempre compute#attachedDisk para discos anexados. |
licenses[] |
Apenas saída. Quaisquer licenças válidas visíveis publicamente. |
mode |
O modo em que este disco será anexado,
|
source |
Especifica um URL parcial ou completo válido para um recurso de disco permanente. |
type |
Especifica o tipo de disco,
|
RuntimeGuestOsFeature
Opcional. Uma lista de recursos a serem ativados no sistema operacional convidado. Aplicável apenas a imagens inicializáveis. Leia Ativar recursos do sistema operacional convidado para conferir uma lista de opções disponíveis. Recursos do SO convidado para o disco de inicialização.
| Representação JSON |
|---|
{ "type": string } |
| Campos | |
|---|---|
type |
O ID de um recurso compatível. Leia Ativar recursos do sistema operacional convidado para conferir uma lista de opções disponíveis. Valores válidos:
|
LocalDiskInitializeParams
Somente entrada. Especifica os parâmetros de um novo disco que será criado junto com a nova instância. Use parâmetros de inicialização para criar discos de inicialização ou SSDs locais anexados ao novo ambiente de execução. Essa propriedade é mutuamente exclusiva com a propriedade de origem. Só é possível definir uma ou outra, mas não ambas.
| Representação JSON |
|---|
{
"description": string,
"diskName": string,
"diskSizeGb": string,
"diskType": enum ( |
| Campos | |
|---|---|
description |
Opcional. Informe essa propriedade ao criar o disco. |
diskName |
Opcional. Especifica o nome do disco. Se não for especificado, o padrão será usar o nome da instância. Se o disco com o nome da instância já existir na zona/região especificada, um novo nome será gerado automaticamente. |
diskSizeGb |
Opcional. Especifica o tamanho do disco em GB de base 2. Se não for especificado, o disco terá o mesmo tamanho da imagem (geralmente 10 GB). Se especificado, o tamanho precisa ser igual ou maior que 10 GB. Padrão de 100 GB. |
diskType |
Somente entrada. O tipo do disco de inicialização anexado a esta instância, que tem como padrão o disco permanente padrão ( |
labels |
Opcional. Rótulos a serem aplicados a este disco. Elas podem ser modificadas posteriormente pelo método "disks.setLabels". Esse campo só é aplicável a discos permanentes. Um objeto com uma lista de pares |
DiskType
Tipos de disco possíveis.
| Tipos enumerados | |
|---|---|
DISK_TYPE_UNSPECIFIED |
Tipo de disco não definido. |
PD_STANDARD |
Tipo de disco permanente padrão. |
PD_SSD |
Tipo de disco permanente SSD. |
PD_BALANCED |
Tipo de disco permanente equilibrado. |
PD_EXTREME |
Tipo de disco permanente extremo. |
EncryptionConfig
Representa uma configuração de chave de criptografia personalizada que pode ser aplicada a um recurso. Isso vai criptografar todos os discos na máquina virtual.
| Representação JSON |
|---|
{ "kmsKey": string } |
| Campos | |
|---|---|
kmsKey |
O identificador de recurso do Cloud KMS da chave de criptografia gerenciada pelo cliente usada para proteger um recurso, como um disco. Ele tem o seguinte formato: |
RuntimeShieldedInstanceConfig
Um conjunto de opções de instância protegida. Consulte Imagens que usam recursos compatíveis de VM protegida. Nem todas as combinações são válidas.
| Representação JSON |
|---|
{ "enableSecureBoot": boolean, "enableVtpm": boolean, "enableIntegrityMonitoring": boolean } |
| Campos | |
|---|---|
enableSecureBoot |
Define se a Inicialização segura está ativada na instância. A Inicialização segura ajuda a garantir que o sistema execute apenas um software autêntico por meio da verificação da assinatura digital de todos os componentes de inicialização e da interrupção do processo de inicialização se a verificação da assinatura falhar. Essa configuração está desativada por padrão. |
enableVtpm |
Define se a instância tem o vTPM ativado. Ativado por padrão. |
enableIntegrityMonitoring |
Define se o monitoramento de integridade está ativado na instância. Permite o monitoramento e o atestado da integridade da inicialização da instância. O atestado é realizado em relação ao valor de referência da política de integridade. Esse valor de referência é derivado inicialmente da imagem de inicialização implicitamente confiável quando a instância é criada. Ativado por padrão. |
RuntimeAcceleratorConfig
Definição dos tipos de aceleradores de hardware que podem ser usados. Consulte AcceleratorTypes do Compute Engine. Exemplos:
nvidia-tesla-k80nvidia-tesla-p100nvidia-tesla-v100nvidia-tesla-p4nvidia-tesla-t4nvidia-tesla-a100
| Representação JSON |
|---|
{
"type": enum ( |
| Campos | |
|---|---|
type |
Modelo de acelerador. |
coreCount |
Contagem de núcleos deste acelerador. |
AcceleratorType
Tipo do acelerador.
| Tipos enumerados | |
|---|---|
ACCELERATOR_TYPE_UNSPECIFIED |
O tipo de acelerador não foi especificado. |
NVIDIA_TESLA_K80 |
O tipo de acelerador é Nvidia Tesla K80. |
NVIDIA_TESLA_P100 |
O tipo de acelerador é Nvidia Tesla P100. |
NVIDIA_TESLA_V100 |
O tipo de acelerador é Nvidia Tesla V100. |
NVIDIA_TESLA_P4 |
O tipo de acelerador é Nvidia Tesla P4. |
NVIDIA_TESLA_T4 |
O tipo de acelerador é Nvidia Tesla T4. |
NVIDIA_TESLA_A100 |
O tipo de acelerador é Nvidia Tesla A100 de 40 GB. |
NVIDIA_L4 |
O tipo de acelerador é Nvidia L4. |
TPU_V2 |
(Em breve) O tipo de acelerador é TPU V2. |
TPU_V3 |
(Em breve) O tipo de acelerador é TPU V3. |
NVIDIA_TESLA_T4_VWS |
O tipo de acelerador é NVIDIA Tesla T4 Virtual Workstations. |
NVIDIA_TESLA_P100_VWS |
O tipo de acelerador é NVIDIA Tesla P100 Virtual Workstations. |
NVIDIA_TESLA_P4_VWS |
O tipo de acelerador é NVIDIA Tesla P4 Virtual Workstations. |
NicType
O tipo de driver de vNIC. O padrão precisa ser UNSPECIFIED_NIC_TYPE.
| Tipos enumerados | |
|---|---|
UNSPECIFIED_NIC_TYPE |
Nenhum tipo especificado. |
VIRTIO_NET |
VIRTIO |
GVNIC |
GVNIC |
BootImage
Esse tipo não tem campos.
Definição da imagem de inicialização usada pelo ambiente de execução. Usado para facilitar a capacidade de upgrade do ambiente de execução.
Estado
A definição dos estados desse ambiente de execução.
| Tipos enumerados | |
|---|---|
STATE_UNSPECIFIED |
O estado não foi especificado. |
STARTING |
A camada de computação está iniciando o ambiente de execução. Ele não está pronto para uso. |
PROVISIONING |
A camada de computação está instalando os frameworks necessários e registrando o tempo de execução com o proxy do notebook. Ela não pode ser usada. |
ACTIVE |
O tempo de execução está em execução. Ele está pronto para uso. |
STOPPING |
A lógica de controle está interrompendo o tempo de execução. Ela não pode ser usada. |
STOPPED |
O ambiente de execução é interrompido. Ela não pode ser usada. |
DELETING |
O ambiente de execução está sendo excluído. Ela não pode ser usada. |
UPGRADING |
O ambiente de execução está sendo atualizado. Ela não pode ser usada. |
INITIALIZING |
O ambiente de execução está sendo criado e configurado. Ele não está pronto para uso. |
HealthState
O subestado de execução.
| Tipos enumerados | |
|---|---|
HEALTH_STATE_UNSPECIFIED |
O subestado do ambiente de execução é desconhecido. |
HEALTHY |
O ambiente de execução está em um estado íntegro (por exemplo, daemons críticos estão em execução). Aplica-se ao estado ACTIVE. |
UNHEALTHY |
O ambiente de execução está em um estado não íntegro (por exemplo, daemons críticos não estão em execução). Aplica-se ao estado ATIVO. |
AGENT_NOT_INSTALLED |
O ambiente de execução não instalou o agente de monitoramento de integridade. Aplicável ao estado ATIVO. |
AGENT_NOT_RUNNING |
O agente de monitoramento de integridade do tempo de execução não está em execução. Aplicável ao estado ATIVO. |
RuntimeAccessConfig
Especifica a configuração de login para o ambiente de execução.
| Representação JSON |
|---|
{
"accessType": enum ( |
| Campos | |
|---|---|
accessType |
O tipo de modo de acesso desta instância. |
runtimeOwner |
O proprietário deste ambiente de execução após a criação. Formato: |
proxyUri |
Apenas saída. O endpoint de proxy usado para acessar o ambiente de execução. |
RuntimeAccessType
Possíveis maneiras de acessar o ambiente de execução. Modo de autenticação. No momento, só há suporte para um único usuário.
| Tipos enumerados | |
|---|---|
RUNTIME_ACCESS_TYPE_UNSPECIFIED |
Acesso não especificado. |
SINGLE_USER |
Login de usuário único. |
SERVICE_ACCOUNT |
Modo de conta de serviço. No modo "Conta de serviço", o criador do ambiente de execução especifica uma conta de serviço que existe no projeto do consumidor. Usando o campo "Conta de serviço do ambiente de execução". Os usuários que acessam o ambiente de execução precisam da permissão ActAs (usuário da conta de serviço). |
RuntimeSoftwareConfig
Especifica a seleção e a configuração do software no ambiente de execução. As propriedades a serem definidas no tempo de execução. As chaves de propriedades são especificadas no formato key:value. Por exemplo:
idleShutdown: trueidleShutdownTimeout: 180enableHealthMonitoring: true
| Representação JSON |
|---|
{ "notebookUpgradeSchedule": string, "idleShutdownTimeout": integer, "installGpuDriver": boolean, "customGpuDriverPath": string, "postStartupScript": string, "kernels": [ { object ( |
| Campos | |
|---|---|
notebookUpgradeSchedule |
Expressão cron no fuso horário UTC, usada para programar o upgrade automático da instância. Siga o formato cron. |
idleShutdownTimeout |
Tempo em minutos para aguardar antes de encerrar o ambiente de execução. Padrão: 180 minutos |
installGpuDriver |
Instale o driver da Nvidia automaticamente. Padrão: True |
customGpuDriverPath |
Especifique um caminho personalizado do Cloud Storage em que o driver de GPU está armazenado. Se não for especificado, vamos escolher automaticamente entre os drivers oficiais de GPU. |
postStartupScript |
Caminho para um script Bash executado automaticamente após a inicialização completa de uma instância de notebook. O caminho precisa ser um URL ou do Cloud Storage ( |
kernels[] |
Opcional. Use uma lista de imagens de contêiner para usar como kernels na instância de notebook. |
postStartupScriptBehavior |
Comportamento do script de inicialização pós-inicialização. |
enableHealthMonitoring |
Verifica se os serviços internos principais estão em execução. Padrão: True |
idleShutdown |
O ambiente de execução será desligado automaticamente após idle_shutdown_time. Padrão: True |
upgradeable |
Apenas saída. Booleano que indica se uma imagem mais recente está disponível em uma família de imagens. |
disableTerminal |
Booleano que indica se o terminal do JupyterLab vai estar disponível ou não. Padrão: False. |
version |
Somente saída. Versão da imagem de inicialização, como M100, do rótulo de lançamento da imagem. |
mixerDisabled |
Booleano que indica se o cliente do mixer precisa ser desativado. Padrão: False. |
PostStartupScriptBehavior
Comportamento do script de inicialização pós-inicialização.
| Tipos enumerados | |
|---|---|
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED |
Comportamento não especificado do script de inicialização pós-inicialização. Será executado apenas uma vez na criação. |
RUN_EVERY_START |
Executa o script de inicialização fornecido durante a criação em cada inicialização. |
DOWNLOAD_AND_RUN_EVERY_START |
Faz o download e executa o script de inicialização fornecido a cada inicialização. |
RuntimeMetrics
Contém métricas de daemon de ambiente de execução, como SO, kernels e estatísticas de sessões.
| Representação JSON |
|---|
{ "systemMetrics": { string: string, ... } } |
| Campos | |
|---|---|
systemMetrics |
Apenas saída. As métricas do sistema. Um objeto com uma lista de pares |
RuntimeMigrationEligibility
"RuntimeMigrationEligibility" representa as informações de viabilidade de uma migração do GmN para o WbI.
| Representação JSON |
|---|
{ "warnings": [ enum ( |
| Campos | |
|---|---|
warnings[] |
Apenas saída. Algumas configurações serão definidas como padrão durante a migração. |
errors[] |
Apenas saída. Algumas configurações tornam o GmN inelegível para uma migração automática. É necessária uma migração manual. |
Aviso
Uma mensagem de aviso de migração significa que algumas configurações serão definidas como padrão durante a migração.
| Tipos enumerados | |
|---|---|
WARNING_UNSPECIFIED |
Tipo padrão. |
UNSUPPORTED_ACCELERATOR_TYPE |
A GmN usa um tipo de acelerador que não é compatível com a WbI. Ele será migrado sem um acelerador. Os usuários podem anexar um acelerador após a migração. |
UNSUPPORTED_OS |
O GmN usa um sistema operacional que não é compatível com o WbI (por exemplo, Debian 10). Ele será substituído pelo Debian 11 no WbI. |
RESERVED_IP_RANGE |
Este GmN está configurado com um intervalo de IP reservado, que não é mais aplicável no WbI. |
GOOGLE_MANAGED_NETWORK |
Essa GmN é configurada com uma rede gerenciada pelo Google. Informe as opções network e subnet para a migração. |
POST_STARTUP_SCRIPT |
Essa GmN é configurada com um script de pós-inicialização. Se quiser, forneça o postStartupScriptOption para a migração. |
SINGLE_USER |
Este GmN está configurado com o modo de usuário único. Se quiser, informe a opção serviceAccount para a migração. |
Erro
Uma mensagem de erro de migração significa que determinadas configurações tornam o GmN inelegível para uma migração automática. É necessária uma migração manual.
| Tipos enumerados | |
|---|---|
ERROR_UNSPECIFIED |
Tipo padrão. |
CUSTOM_CONTAINER |
A GmN está configurada com contêineres personalizados e não pode ser migrada. |
Métodos |
|
|---|---|
|
Cria um novo ambiente de execução em determinado projeto e local. |
|
Exclui um único ambiente de execução. |
|
Recebe detalhes de um único ambiente de execução. |
|
Busca a política de controle de acesso de um recurso. |
|
Lista os runtimes em determinado projeto e local. |
|
Migrar um ambiente de execução atual para uma nova instância do Workbench. |
|
Atualize a configuração do ambiente de execução do notebook. |
|
Gera relatórios e processa um evento de tempo de execução. |
|
Redefine um ambiente de execução de notebook gerenciado. |
|
Define a política de controle de acesso no recurso especificado. |
|
Inicia um ambiente de execução de notebook gerenciado. |
|
Interrompe um ambiente de execução de notebook gerenciado. |
|
Trocar um ambiente de execução de notebook gerenciado. |
|
Retorna permissões do autor da chamada no recurso especificado. |