Recurso: Runtime
Es la definición de un entorno de ejecución para una instancia de notebook administrado.
| Representación JSON |
|---|
{ "name": string, "state": enum ( |
| Campos | |
|---|---|
name |
Solo salida. Es el nombre del recurso del entorno de ejecución. Formato: |
state |
Solo salida. Es el estado del tiempo de ejecución. |
healthState |
Solo salida. Es el healthState del entorno de ejecución. |
accessConfig |
Es la configuración para acceder al entorno de ejecución. |
softwareConfig |
Es la configuración del software dentro del entorno de ejecución. |
metrics |
Solo salida. Contiene métricas del daemon de Runtime, como el estado del servicio y las estadísticas de JupyterLab. |
createTime |
Solo salida. Es la hora de creación del entorno de ejecución. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
updateTime |
Solo salida. Es la fecha y hora de actualización del tiempo de ejecución. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
labels |
Es opcional. Son las etiquetas que se asociarán con este notebook administrado o entorno de ejecución. Las claves de las etiquetas deben contener entre 1 y 63 caracteres, y deben cumplir con el RFC 1035. Los valores de las etiquetas pueden estar vacíos, pero, si están presentes, deben contener entre 1 y 63 caracteres, y deben cumplir con el RFC 1035. No se pueden asociar más de 32 etiquetas con un clúster. Un objeto que contiene una lista de pares |
runtimeMigrationEligibility |
Solo salida. Verifica qué tan factible es una migración de GmN a WbI. |
| Tipo de entorno de ejecución. Actualmente, solo admite la VM de Compute Engine. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
virtualMachine |
Usa una imagen de VM de Compute Engine para iniciar la instancia de notebook administrado. |
| Fin de los campos mutuamente excluyentes. | |
migrated |
Solo salida. Es un valor booleano que indica si este notebook se migró a una instancia de Workbench. |
VirtualMachine
Tiempo de ejecución que usa una máquina virtual para el procesamiento.
| Representación JSON |
|---|
{
"instanceName": string,
"instanceId": string,
"virtualMachineConfig": {
object ( |
| Campos | |
|---|---|
instanceName |
Solo salida. Es el nombre fácil de usar de la instancia administrada de Compute Engine. |
instanceId |
Solo salida. Es el identificador único de la instancia administrada de Compute Engine. |
virtualMachineConfig |
Es la configuración de la máquina virtual. |
VirtualMachineConfig
Es la configuración de la máquina virtual.
| Representación JSON |
|---|
{ "zone": string, "machineType": string, "containerImages": [ { object ( |
| Campos | |
|---|---|
zone |
Solo salida. Es la zona en la que se encuentra la máquina virtual. Si se usa una solicitud regional, el servicio de notebooks elegirá una ubicación en la región de ejecución correspondiente. En una solicitud de obtención, la zona siempre estará presente. Ejemplo: * |
machineType |
Obligatorio. Es el tipo de máquina de Compute Engine que se usa para los tiempos de ejecución. El nombre corto es válido. Ejemplos: * |
containerImages[] |
Es opcional. Es una lista de imágenes de contenedor que se usarán como kernels en la instancia del notebook. |
dataDisk |
Obligatorio. Son los parámetros de configuración de la opción de disco de datos. |
encryptionConfig |
Es opcional. Es la configuración de encriptación del disco de datos de la máquina virtual. |
shieldedInstanceConfig |
Es opcional. Es la configuración de la instancia de VM protegida. |
acceleratorConfig |
Es opcional. Es la configuración del acelerador de Compute Engine para este entorno de ejecución. |
network |
Es opcional. Es la red de Compute Engine que se usará para las comunicaciones de la máquina. No se puede especificar con la subred. Si no se especifican Es una URL completa o un URI parcial. Ejemplos:
Los tiempos de ejecución son recursos administrados dentro de la infraestructura de Google. Los tiempos de ejecución admiten los siguientes parámetros de configuración de red:
|
subnet |
Es opcional. Es la subred de Compute Engine que se usará para las comunicaciones de la máquina. No se puede especificar con la red. Se aceptan URLs completas o URIs parciales. Ejemplos:
|
internalIpOnly |
Es opcional. Si es verdadero, el entorno de ejecución solo tendrá direcciones IP internas. De forma predeterminada, los tiempos de ejecución no están restringidos a las direcciones IP internas y tendrán direcciones IP externas efímeras asignadas a cada VM. Esta restricción |
tags[] |
Es opcional. Son las etiquetas de red de Compute Engine que se agregarán en el tiempo de ejecución (consulta Agrega etiquetas de red). |
guestAttributes |
Solo salida. Son los atributos de invitado de Compute Engine. (consulta Atributos de invitado del proyecto y de la instancia). Un objeto que contiene una lista de pares |
metadata |
Es opcional. Son las entradas de metadatos de Compute Engine que se agregarán a la máquina virtual. (consulta Metadatos de proyecto y de instancia). Un objeto que contiene una lista de pares |
labels |
Es opcional. Son las etiquetas que se asociarán con este entorno de ejecución. Las claves de las etiquetas deben contener entre 1 y 63 caracteres, y deben cumplir con el RFC 1035. Los valores de las etiquetas pueden estar vacíos, pero, si están presentes, deben contener entre 1 y 63 caracteres, y deben cumplir con el RFC 1035. No se pueden asociar más de 32 etiquetas a un clúster. Un objeto que contiene una lista de pares |
nicType |
Es opcional. Es el tipo de vNIC que se usará en esta interfaz. Puede ser gVNIC o VirtioNet. |
reservedIpRange |
Es opcional. El nombre del rango de IP reservado se usa para el intercambio de tráfico de VPC. La asignación de la subred usará el nombre del rango si está asignado. Ejemplo: managed-notebooks-range-c El valor del campo será |
bootImage |
Es opcional. Son los metadatos de la imagen de arranque que se usan para la capacidad de actualización del tiempo de ejecución. |
LocalDisk
Es un recurso de disco local conectado.
| Representación JSON |
|---|
{ "autoDelete": boolean, "boot": boolean, "deviceName": string, "guestOsFeatures": [ { object ( |
| Campos | |
|---|---|
autoDelete |
Es opcional. Solo salida. Especifica si el disco se borrará automáticamente cuando se borre la instancia (pero no cuando se separe el disco de la instancia). |
boot |
Es opcional. Solo salida. Indica que este es un disco de arranque. La máquina virtual usará la primera partición del disco para su sistema de archivos raíz. |
deviceName |
Es opcional. Solo salida. Especifica un nombre de dispositivo único de tu elección que se refleje en el árbol Si no se especifica, el servidor elige un nombre de dispositivo predeterminado para aplicar a este disco, con el formato persistent-disk-x, en el que x es un número asignado por Google Compute Engine. Este campo solo se aplica a los discos persistentes. |
guestOsFeatures[] |
Solo salida. Indica una lista de funciones para habilitar en el sistema operativo invitado. Solo se aplica a imágenes de arranque. Consulta Habilita las funciones del sistema operativo invitado para ver una lista de las opciones disponibles. |
index |
Solo salida. Es un índice basado en cero para este disco, en el que el 0 está reservado para el disco de arranque. Si tienes muchos discos conectados a una instancia, cada uno tendrá un número de índice único. |
initializeParams |
Solo entrada. Especifica los parámetros de un disco nuevo que se creará junto con la instancia nueva. Usa parámetros de inicialización para crear discos de arranque o SSD locales conectados a la instancia nueva. Esta propiedad es mutuamente exclusiva con la propiedad fuente. Solo puedes definir una u otra, pero no ambas. |
interface |
Especifica la interfaz de disco que se usará para conectar este disco, que puede ser SCSI o NVMe. El valor predeterminado es SCSI. Los discos persistentes siempre deben usar SCSI, y la solicitud fallará si intentas adjuntar un disco persistente en cualquier otro formato que no sea SCSI. Las SSD locales pueden usar NVMe o SCSI. Para conocer las características de rendimiento de SCSI a través de NVMe, consulta Rendimiento de SSD locales. Valores válidos:
|
kind |
Solo salida. Tipo de recurso. Siempre calcula#attachedDisk para los discos conectados. |
licenses[] |
Solo salida. Cualquier licencia válida visible públicamente. |
mode |
Es el modo en el que se conectará este disco, ya sea
|
source |
Especifica una URL parcial o completa válida para un recurso de Persistent Disk existente. |
type |
Especifica el tipo de disco, ya sea
|
RuntimeGuestOsFeature
Es opcional. Es una lista de funciones que se habilitarán en el sistema operativo invitado. Solo se aplica a imágenes de arranque. Lee Cómo habilitar las funciones del sistema operativo invitado para ver una lista de las opciones disponibles. Son las funciones del SO invitado para el disco de arranque.
| Representación JSON |
|---|
{ "type": string } |
| Campos | |
|---|---|
type |
Es el ID de una función admitida. Lee Cómo habilitar las funciones del sistema operativo invitado para ver una lista de las opciones disponibles. Valores válidos:
|
LocalDiskInitializeParams
Solo entrada. Especifica los parámetros de un disco nuevo que se creará junto con la instancia nueva. Usa parámetros de inicialización para crear discos de arranque o SSD locales conectados al nuevo entorno de ejecución. Esta propiedad es mutuamente exclusiva con la propiedad fuente. Solo puedes definir una u otra, pero no ambas.
| Representación JSON |
|---|
{
"description": string,
"diskName": string,
"diskSizeGb": string,
"diskType": enum ( |
| Campos | |
|---|---|
description |
Es opcional. Proporciona esta propiedad cuando crees el disco. |
diskName |
Es opcional. Especifica el nombre del disco. Si no se especifica, el valor predeterminado es usar el nombre de la instancia. Si el disco con el nombre de la instancia ya existe en la zona o región determinada, se generará automáticamente un nombre nuevo. |
diskSizeGb |
Es opcional. Especifica el tamaño del disco en GB en base 2. Si no se especifica, el disco tendrá el mismo tamaño que la imagen (por lo general, 10 GB). Si se especifica, el tamaño debe ser igual o mayor que 10 GB. El valor predeterminado es 100 GB. |
diskType |
Solo entrada. Tipo de disco de arranque conectado a esta instancia. El valor predeterminado es disco persistente estándar ( |
labels |
Es opcional. Son las etiquetas que se aplicarán a este disco. Los discos pueden modificar estos parámetros más adelante con el método disks.setLabels. Este campo solo se aplica a los discos persistentes. Un objeto que contiene una lista de pares |
DiskType
Son los tipos de discos posibles.
| Enums | |
|---|---|
DISK_TYPE_UNSPECIFIED |
No se estableció el tipo de disco. |
PD_STANDARD |
Es el tipo de disco persistente estándar. |
PD_SSD |
Es el tipo de disco persistente SSD. |
PD_BALANCED |
Es el tipo de disco persistente balanceado. |
PD_EXTREME |
Es el tipo de disco persistente extremo. |
EncryptionConfig
Representa una configuración de clave de encriptación personalizada que se puede aplicar a un recurso. Esto encriptará todos los discos de la máquina virtual.
| Representación JSON |
|---|
{ "kmsKey": string } |
| Campos | |
|---|---|
kmsKey |
Es el identificador de recurso de Cloud KMS de la clave de encriptación administrada por el cliente que se usa para proteger un recurso, como un disco. Tiene el siguiente formato: |
RuntimeShieldedInstanceConfig
Es un conjunto de opciones de instancias protegidas. Consulta Imágenes que usan funciones compatibles de VM protegida. No todas las combinaciones son válidas.
| Representación JSON |
|---|
{ "enableSecureBoot": boolean, "enableVtpm": boolean, "enableIntegrityMonitoring": boolean } |
| Campos | |
|---|---|
enableSecureBoot |
Define si la instancia tiene habilitado el inicio seguro. El arranque seguro ayuda a garantizar que el sistema solo ejecute software auténtico a través de la verificación de la firma digital de todos los componentes del inicio y la detención del proceso de inicio si falla la verificación de la firma. Está inhabilitado de forma predeterminada. |
enableVtpm |
Define si la instancia tiene habilitado el vTPM. Habilitada de forma predeterminada. |
enableIntegrityMonitoring |
Define si la instancia tiene habilitada la supervisión de integridad. Habilita la supervisión y la certificación de la integridad del inicio de la instancia. La certificación se realiza en función del modelo de referencia de la política de integridad. Este valor de referencia se deriva inicialmente de la imagen de arranque de confianza implícita cuando se crea la instancia. Habilitada de forma predeterminada. |
RuntimeAcceleratorConfig
Es la definición de los tipos de aceleradores de hardware que se pueden usar. Consulta Compute Engine AcceleratorTypes. Ejemplos:
nvidia-tesla-k80nvidia-tesla-p100nvidia-tesla-v100nvidia-tesla-p4nvidia-tesla-t4nvidia-tesla-a100
| Representación JSON |
|---|
{
"type": enum ( |
| Campos | |
|---|---|
type |
Es el modelo de acelerador. |
coreCount |
Es la cantidad de núcleos de este acelerador. |
AcceleratorType
Es el tipo de acelerador.
| Enums | |
|---|---|
ACCELERATOR_TYPE_UNSPECIFIED |
No se especificó el tipo de acelerador. |
NVIDIA_TESLA_K80 |
El tipo de acelerador es Nvidia Tesla K80. |
NVIDIA_TESLA_P100 |
El tipo de acelerador es Nvidia Tesla P100. |
NVIDIA_TESLA_V100 |
El tipo de acelerador es Nvidia Tesla V100. |
NVIDIA_TESLA_P4 |
El tipo de acelerador es Nvidia Tesla P4. |
NVIDIA_TESLA_T4 |
El tipo de acelerador es Nvidia Tesla T4. |
NVIDIA_TESLA_A100 |
El tipo de acelerador es Nvidia Tesla A100, 40 GB. |
NVIDIA_L4 |
El tipo de acelerador es Nvidia L4. |
TPU_V2 |
(Próximamente) El tipo de acelerador es TPU V2. |
TPU_V3 |
(Próximamente) El tipo de acelerador es TPU V3. |
NVIDIA_TESLA_T4_VWS |
El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla T4. |
NVIDIA_TESLA_P100_VWS |
El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla P100. |
NVIDIA_TESLA_P4_VWS |
El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla P4. |
NicType
Es el tipo de controlador de la NIC virtual. El valor predeterminado debe ser UNSPECIFIED_NIC_TYPE.
| Enums | |
|---|---|
UNSPECIFIED_NIC_TYPE |
No se especificó ningún tipo. |
VIRTIO_NET |
VIRTIO |
GVNIC |
GVNIC |
BootImage
Este tipo no tiene campos.
Es la definición de la imagen de arranque que usa el tiempo de ejecución. Se usa para facilitar la capacidad de actualización del tiempo de ejecución.
Estado
Es la definición de los estados de este entorno de ejecución.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
No se especifica el estado. |
STARTING |
La capa de procesamiento está iniciando el tiempo de ejecución. No está listo para usarse. |
PROVISIONING |
La capa de procesamiento está instalando los frameworks necesarios y registrando el tiempo de ejecución con el proxy del notebook. No se puede usar. |
ACTIVE |
El tiempo de ejecución se está ejecutando. Está lista para usarse. |
STOPPING |
La lógica de control está deteniendo el tiempo de ejecución. No se puede usar. |
STOPPED |
Se detuvo el tiempo de ejecución. No se puede usar. |
DELETING |
Se está borrando el entorno de ejecución. No se puede usar. |
UPGRADING |
Se está actualizando el tiempo de ejecución. No se puede usar. |
INITIALIZING |
Se está creando y configurando el entorno de ejecución. No está listo para usarse. |
HealthState
Es el subestado del tiempo de ejecución.
| Enums | |
|---|---|
HEALTH_STATE_UNSPECIFIED |
Se desconoce el subestado del tiempo de ejecución. |
HEALTHY |
Se sabe que el tiempo de ejecución está en buen estado (por ejemplo, los daemons críticos se están ejecutando). Se aplica al estado ACTIVE. |
UNHEALTHY |
Se sabe que el tiempo de ejecución se encuentra en un estado no saludable (por ejemplo, no se están ejecutando los daemons críticos). Se aplica al estado ACTIVE. |
AGENT_NOT_INSTALLED |
El entorno de ejecución no instaló el agente de supervisión del estado. Se aplica al estado ACTIVE. |
AGENT_NOT_RUNNING |
El agente de supervisión del estado del tiempo de ejecución no se está ejecutando. Se aplica al estado ACTIVE. |
RuntimeAccessConfig
Especifica la configuración de acceso para el entorno de ejecución
| Representación JSON |
|---|
{
"accessType": enum ( |
| Campos | |
|---|---|
accessType |
Es el tipo de modo de acceso de esta instancia. |
runtimeOwner |
Es el propietario de este tiempo de ejecución después de la creación. Formato: |
proxyUri |
Solo salida. Es el extremo de proxy que se usa para acceder al entorno de ejecución. |
RuntimeAccessType
Son las formas posibles de acceder al tiempo de ejecución. Modo de autenticación. Actualmente, solo admite un solo usuario.
| Enums | |
|---|---|
RUNTIME_ACCESS_TYPE_UNSPECIFIED |
Acceso sin especificar. |
SINGLE_USER |
Acceso de usuario único |
SERVICE_ACCOUNT |
Modo de cuenta de servicio. En el modo de cuenta de servicio, el creador del entorno de ejecución especificará una SA que exista en el proyecto del consumidor. Usa el campo Cuenta de servicio del entorno de ejecución. Los usuarios que acceden al entorno de ejecución necesitan el permiso ActAs (usuario de cuenta de servicio). |
RuntimeSoftwareConfig
Especifica la selección y la configuración del software dentro del entorno de ejecución. Son las propiedades que se establecerán en el tiempo de ejecución. Las claves de propiedades se especifican en formato key:value, por ejemplo:
idleShutdown: trueidleShutdownTimeout: 180enableHealthMonitoring: true
| Representación JSON |
|---|
{ "notebookUpgradeSchedule": string, "idleShutdownTimeout": integer, "installGpuDriver": boolean, "customGpuDriverPath": string, "postStartupScript": string, "kernels": [ { object ( |
| Campos | |
|---|---|
notebookUpgradeSchedule |
Es una expresión cron en la zona horaria UTC que se usa para programar la actualización automática de la instancia. Sigue el formato cron. |
idleShutdownTimeout |
Tiempo en minutos que se debe esperar antes de cerrar el entorno de ejecución. Valor predeterminado: 180 minutos |
installGpuDriver |
Instala el controlador de Nvidia automáticamente. Valor predeterminado: Verdadero |
customGpuDriverPath |
Especifica una ruta de acceso personalizada de Cloud Storage en la que se almacena el controlador de GPU. Si no se especifica, elegiremos automáticamente entre los controladores oficiales de la GPU. |
postStartupScript |
Ruta de acceso a una secuencia de comandos de Bash que se ejecuta automáticamente después de que se inicia por completo una instancia de notebook. La ruta de acceso debe ser una URL o una ruta de Cloud Storage ( |
kernels[] |
Es opcional. Es una lista de imágenes de contenedor que se usarán como kernels en la instancia del notebook. |
postStartupScriptBehavior |
Comportamiento de la secuencia de comandos de inicio posterior. |
enableHealthMonitoring |
Verifica que los servicios internos principales estén en ejecución. Valor predeterminado: Verdadero |
idleShutdown |
El entorno de ejecución se apagará automáticamente después de idle_shutdown_time. Valor predeterminado: Verdadero |
upgradeable |
Solo salida. Es un valor booleano que indica si hay una imagen más reciente disponible en una familia de imágenes. |
disableTerminal |
Es un valor booleano que indica si la terminal de JupyterLab estará disponible o no. Valor predeterminado: falso |
version |
Solo salida. Es la versión de la imagen de arranque, como M100, de la etiqueta de versión de la imagen. |
mixerDisabled |
Es un valor booleano que indica si se debe inhabilitar el cliente del mezclador. Valor predeterminado: falso |
PostStartupScriptBehavior
Comportamiento de la secuencia de comandos de inicio posterior.
| Enums | |
|---|---|
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED |
Comportamiento de secuencia de comandos de inicio posterior sin especificar. Se ejecutará solo una vez en la creación. |
RUN_EVERY_START |
Ejecuta la secuencia de comandos de inicio posterior proporcionada durante la creación en cada inicio. |
DOWNLOAD_AND_RUN_EVERY_START |
Descarga y ejecuta la secuencia de comandos de inicio proporcionada en cada inicio. |
RuntimeMetrics
Contiene métricas del daemon de tiempo de ejecución, como estadísticas del SO, el kernel y las sesiones.
| Representación JSON |
|---|
{ "systemMetrics": { string: string, ... } } |
| Campos | |
|---|---|
systemMetrics |
Solo salida. Son las métricas del sistema. Un objeto que contiene una lista de pares |
RuntimeMigrationEligibility
RuntimeMigrationEligibility representa la información de factibilidad de una migración de GmN a WbI.
| Representación JSON |
|---|
{ "warnings": [ enum ( |
| Campos | |
|---|---|
warnings[] |
Solo salida. Durante la migración, se establecerán ciertos parámetros de configuración de forma predeterminada. |
errors[] |
Solo salida. Algunos parámetros de configuración hacen que el GmN no sea apto para una migración automática. Se requiere una migración manual. |
Advertencia
Un mensaje de advertencia de migración significa que ciertos parámetros de configuración se establecerán de forma predeterminada durante la migración.
| Enums | |
|---|---|
WARNING_UNSPECIFIED |
Es el tipo predeterminado. |
UNSUPPORTED_ACCELERATOR_TYPE |
El GmN usa un tipo de acelerador que no se admite en WbI. Se migrará sin un acelerador. Los usuarios pueden adjuntar un acelerador después de la migración. |
UNSUPPORTED_OS |
El GmN usa un sistema operativo que no es compatible con WbI (p.ej., Debian 10). Se reemplazará por Debian 11 en WbI. |
RESERVED_IP_RANGE |
Este GmN está configurado con un rango de IP reservado, que ya no se aplica en WbI. |
GOOGLE_MANAGED_NETWORK |
Este GmN está configurado con una red administrada por Google. Proporciona las opciones network y subnet para la migración. |
POST_STARTUP_SCRIPT |
Este GmN está configurado con una secuencia de comandos posterior al inicio. De manera opcional, proporciona el postStartupScriptOption para la migración. |
SINGLE_USER |
Este dispositivo GmN está configurado con el modo de un solo usuario. De manera opcional, proporciona la opción serviceAccount para la migración. |
Error
Un mensaje de error de migración significa que ciertos parámetros de configuración hacen que el GmN no sea apto para una migración automática. Se requiere una migración manual.
| Enums | |
|---|---|
ERROR_UNSPECIFIED |
Es el tipo predeterminado. |
CUSTOM_CONTAINER |
El GMN está configurado con contenedores personalizados y no se puede migrar. |
Métodos |
|
|---|---|
|
Crea un nuevo entorno de ejecución en un proyecto y una ubicación determinados. |
|
Borra un solo entorno de ejecución. |
|
Obtiene detalles de un solo entorno de ejecución. |
|
Permite obtener la política de control de acceso de un recurso. |
|
Enumera los tiempos de ejecución en una ubicación y un proyecto determinados. |
|
Migra un entorno de ejecución existente a una instancia nueva de Workbench. |
|
Actualiza la configuración del entorno de ejecución del notebook. |
|
Informa y procesa un evento del entorno de ejecución. |
|
Restablece un entorno de ejecución de notebook administrado. |
|
Permite configurar la política de control de acceso en el recurso especificado. |
|
Inicia un entorno de ejecución de notebook administrado. |
|
Detiene un entorno de ejecución de notebook administrado. |
|
Cambia un entorno de ejecución de notebook administrado. |
|
Permite mostrar los permisos que tiene un emisor para un recurso específico. |