Package google.cloud.edgecontainer.v1alpha

Índice

EdgeContainer

La API de EdgeContainer proporciona administración de clústeres de Kubernetes en implementaciones de Google Edge Cloud.

CreateCluster

rpc CreateCluster(CreateClusterRequest) returns (Operation)

Crea un clúster nuevo en un proyecto y una ubicación determinados.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

CreateNodePool

rpc CreateNodePool(CreateNodePoolRequest) returns (Operation)

Crea un nuevo NodePool en un proyecto y una ubicación determinados.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

CreateVpnConnection

rpc CreateVpnConnection(CreateVpnConnectionRequest) returns (Operation)

Crea una conexión de VPN nueva en un proyecto y una ubicación determinados.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

DeleteCluster

rpc DeleteCluster(DeleteClusterRequest) returns (Operation)

Borra un solo clúster.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

DeleteNodePool

rpc DeleteNodePool(DeleteNodePoolRequest) returns (Operation)

Borra un solo NodePool.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

DeleteVpnConnection

rpc DeleteVpnConnection(DeleteVpnConnectionRequest) returns (Operation)

Borra una sola conexión de VPN.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

GenerateAccessToken

rpc GenerateAccessToken(GenerateAccessTokenRequest) returns (GenerateAccessTokenResponse)

Genera un token de acceso para un clúster.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

GenerateOfflineCredential

rpc GenerateOfflineCredential(GenerateOfflineCredentialRequest) returns (GenerateOfflineCredentialResponse)

Genera una credencial sin conexión para un clúster.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

GetCluster

rpc GetCluster(GetClusterRequest) returns (Cluster)

Obtiene detalles de un solo clúster.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

GetMachine

rpc GetMachine(GetMachineRequest) returns (Machine)

Obtiene detalles de una sola máquina.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

GetNodePool

rpc GetNodePool(GetNodePoolRequest) returns (NodePool)

Obtiene detalles de un solo NodePool.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

GetServerConfig

rpc GetServerConfig(GetServerConfigRequest) returns (ServerConfig)

Obtiene la configuración del servidor.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

GetVpnConnection

rpc GetVpnConnection(GetVpnConnectionRequest) returns (VpnConnection)

Obtiene detalles de una sola conexión de VPN.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

ListClusters

rpc ListClusters(ListClustersRequest) returns (ListClustersResponse)

Enumera clústeres en una ubicación y un proyecto determinados.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

ListMachines

rpc ListMachines(ListMachinesRequest) returns (ListMachinesResponse)

Enumera las máquinas en una ubicación y un proyecto determinados.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

ListNodePools

rpc ListNodePools(ListNodePoolsRequest) returns (ListNodePoolsResponse)

Enumera NodePools en una ubicación y un proyecto determinados.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

ListVpnConnections

rpc ListVpnConnections(ListVpnConnectionsRequest) returns (ListVpnConnectionsResponse)

Enumera las conexiones VPN en una ubicación y un proyecto determinados.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

UpdateCluster

rpc UpdateCluster(UpdateClusterRequest) returns (Operation)

Actualiza los parámetros de un solo clúster.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

UpdateNodePool

rpc UpdateNodePool(UpdateNodePoolRequest) returns (Operation)

Actualiza los parámetros de un solo NodePool.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

UpgradeCluster

rpc UpgradeCluster(UpgradeClusterRequest) returns (Operation)

Actualiza un solo clúster.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.

Autorización

Es la política de RBAC que aplicará y administrará GEC.

Campos
admin_users

ClusterUser

Obligatorio. Usuario al que se le otorgará el rol de administrador de clústeres, lo que le proporcionará acceso completo al clúster. Actualmente, este es un campo único, pero se expandirá para permitir varios administradores en el futuro.

ChannelConfig

Es la configuración de un canal de versiones.

Campos
default_version

string

Solo salida. Versión predeterminada para este canal de versiones, p.ej.: "1.4.0".

Clúster

Un clúster de Kubernetes de Google Distributed Cloud Edge.

Campos
name

string

Obligatorio. Es el nombre del recurso del clúster.

create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó el clúster.

update_time

Timestamp

Solo salida. Fecha y hora en la que se actualizó el clúster por última vez.

labels

map<string, string>

Son las etiquetas asociadas a este recurso.

fleet

Fleet

Obligatorio. Configuración de la flota.

networking

ClusterNetworking

Obligatorio. Configuración de herramientas de redes de todo el clúster.

authorization

Authorization

Obligatorio. Inmutable. Es la política de RBAC que aplicará y administrará GEC.

default_max_pods_per_node

int32

Es opcional. Cantidad máxima predeterminada de Pods por nodo que se usa si no se especifica de forma explícita un valor máximo para un grupo de nodos en este clúster. En tal caso, se usará el valor predeterminado de Kubernetes.

endpoint

string

Solo salida. Es la dirección IP del servidor de la API de Kubernetes.

port

int32

Solo salida. Es el número de puerto del servidor de la API de Kubernetes.

cluster_ca_certificate

string

Solo salida. Es el certificado público de la CA del clúster codificado con PEM.

maintenance_policy

MaintenancePolicy

Es opcional. Es la configuración de la política de mantenimiento de todo el clúster.

control_plane_version

string

Solo salida. Versión de lanzamiento del plano de control

node_version

string

Solo salida. Es la versión de lanzamiento más baja entre todos los nodos trabajadores. Este campo puede estar vacío si el clúster no tiene nodos de trabajador.

control_plane

ControlPlane

Es opcional. Es la configuración del plano de control del clúster.

system_addons_config

SystemAddonsConfig

Es opcional. Es la configuración de los complementos del sistema.

external_load_balancer_ipv4_address_pools[]

string

Es opcional. Son grupos de direcciones IPv4 para el balanceo de cargas externo del plano de datos del clúster.

control_plane_encryption

ControlPlaneEncryption

Es opcional. Son opciones de encriptación de disco del plano de control remoto. Este campo solo se usa cuando se habilita la compatibilidad con CMEK.

status

Status

Solo salida. Es el estado actual del clúster.

maintenance_events[]

MaintenanceEvent

Solo salida. Todos los eventos de mantenimiento programados para el clúster, incluidos los que están en curso, los que se planificaron para el futuro y los que se realizaron en el pasado (hasta 90 días).

target_version

string

Es opcional. Es la versión del clúster de destino. Por ejemplo, “1.5.0”.

release_channel

ReleaseChannel

Es opcional. Es el canal de versiones al que está suscrito un clúster.

survivability_config

SurvivabilityConfig

Es opcional. Configuración de la capacidad de supervivencia del clúster, p. ej., para el caso en que se pierde la conectividad de red Nota: Esto solo se aplica a los clústeres del plano de control local.

external_load_balancer_ipv6_address_pools[]

string

Es opcional. Son grupos de direcciones IPv6 para el balanceo de cargas externo del plano de datos del clúster.

ControlPlane

Es la configuración del plano de control del clúster.

Campos

Campo de unión config.

config puede ser una de las siguientes opciones:

remote

Remote

Es la configuración del plano de control remoto.

local

Local

Es la configuración del plano de control local.

Advertencia: Los clústeres de plano de control local se deben crear en su propio proyecto. Los clústeres de plano de control local no pueden coexistir en el mismo proyecto con ningún otro tipo de clústeres, incluidos los que no son de GDCE. Mezclar clústeres de GDCE de plano de control local con cualquier otro tipo de clústeres en el mismo proyecto puede provocar la pérdida de datos.

Local

Es la configuración específica para los clústeres con un plano de control alojado de forma local.

Advertencia: Los clústeres de plano de control local se deben crear en su propio proyecto. Los clústeres de plano de control local no pueden coexistir en el mismo proyecto con ningún otro tipo de clústeres, incluidos los que no son de GDCE. Mezclar clústeres de GDCE de plano de control local con cualquier otro tipo de clústeres en el mismo proyecto puede provocar la pérdida de datos.

Campos
node_location

string

Nombre de las zonas de Google Distributed Cloud Edge en las que se creará este grupo de nodos. Por ejemplo: us-central1-edge-customer-a.

node_count

int32

Es la cantidad de nodos que funcionarán como réplicas del plano de control.

machine_filter

string

Solo se permitirá que las máquinas que coincidan con este filtro alojen nodos del plano de control. El lenguaje de filtrado acepta cadenas como "name=" y se documenta aquí: AIP-160.

shared_deployment_policy

SharedDeploymentPolicy

Es la configuración de la política sobre cómo se implementan las aplicaciones del usuario.

Remoto

Este tipo no tiene campos.

Es la configuración específica de los clústeres con un plano de control alojado de forma remota.

SharedDeploymentPolicy

Representa la configuración de la política sobre cómo se implementan las aplicaciones del usuario.

Enums
SHARED_DEPLOYMENT_POLICY_UNSPECIFIED Sin especificar.
ALLOWED Las aplicaciones de usuario se pueden implementar tanto en el plano de control como en los nodos trabajadores.
DISALLOWED Las aplicaciones de usuario no se pueden implementar en los nodos del plano de control y solo se pueden implementar en los nodos trabajadores.

ControlPlaneEncryption

Es la configuración para la compatibilidad con la clave de KMS administrada por el cliente para la encriptación del disco del clúster del plano de control remoto.

Campos
kms_key

string

Inmutable. Es la clave criptográfica de Cloud KMS, p.ej., projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}, que se usará para proteger los discos del plano de control. Si no se especifica, se usará una clave administrada por Google.

kms_key_active_version

string

Solo salida. Es la versión de CryptoKey de Cloud KMS que se usa actualmente para proteger los discos del plano de control. Solo se aplica si se configura kms_key.

kms_key_state

KmsKeyState

Solo salida. Disponibilidad de la CryptoKey de Cloud KMS. Si no es KEY_AVAILABLE, es posible que los nodos se desconecten, ya que no pueden acceder a sus datos locales. Esto puede deberse a la falta de permisos para usar la clave o a que la clave está inhabilitada o borrada.

kms_status

Status

Solo salida. Es el estado de error que devuelve Cloud KMS cuando se usa esta clave. Este campo solo se puede completar si kms_key_state no es KMS_KEY_STATE_KEY_AVAILABLE. Si se propaga, este campo contiene el estado de error que informa Cloud KMS.

MaintenanceEvent

Un evento de mantenimiento es una operación que podría causar interrupciones temporales en las cargas de trabajo del clúster, incluidas las actualizaciones del clúster iniciadas por Google o por el usuario, los cambios en la configuración del clúster iniciados por el usuario que requieren el reinicio de los nodos, etcétera.

Campos
uuid

string

Solo salida. Es el UUID del evento de mantenimiento.

target_version

string

Solo salida. Es la versión de destino del clúster.

operation

string

Solo salida. Operación para ejecutar el evento de mantenimiento. Se especifica en el formato projects/*/locations/*/operations/*. Si el evento de mantenimiento se divide en varias operaciones (p.ej., debido a períodos de mantenimiento), se registra la más reciente.

type

Type

Solo salida. Es el tipo de evento de mantenimiento.

schedule

Schedule

Solo salida. Es el programa del evento de mantenimiento.

state

State

Solo salida. Es el estado del evento de mantenimiento.

create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó la solicitud del evento de mantenimiento.

start_time

Timestamp

Solo salida. Es la fecha y hora en que comenzó el evento de mantenimiento.

end_time

Timestamp

Solo salida. Es la fecha y hora en que finalizó el evento de mantenimiento, ya sea que se haya completado correctamente o no. Si el evento de mantenimiento se divide en varios períodos de mantenimiento, end_time solo se actualiza cuando finaliza todo el flujo.

update_time

Timestamp

Solo salida. Es la fecha y hora en que se actualizó el mensaje del evento de mantenimiento.

Programar

Indica cuándo se debe realizar el evento de mantenimiento.

Enums
SCHEDULE_UNSPECIFIED Sin especificar.
IMMEDIATELY Inmediatamente después de recibir la solicitud

Estado

Indica el estado del evento de mantenimiento.

Enums
STATE_UNSPECIFIED Sin especificar.
RECONCILING El evento de mantenimiento está en curso. Es posible que el clúster no se pueda usar.
SUCCEEDED El evento de mantenimiento se completó correctamente.
FAILED El evento de mantenimiento falló.

Tipo

Indica el tipo de evento de mantenimiento.

Enums
TYPE_UNSPECIFIED Sin especificar.
USER_INITIATED_UPGRADE Actualización iniciada por los usuarios.
GOOGLE_DRIVEN_UPGRADE Actualización impulsada por Google.

ReleaseChannel

Es el canal de versiones al que está suscrito un clúster.

Enums
RELEASE_CHANNEL_UNSPECIFIED Canal de versiones sin especificar. De forma predeterminada, se seleccionará el canal REGULAR.
NONE No hay canal de versiones.
REGULAR Canal de versiones regular.

Estado

Indica el estado del clúster.

Enums
STATUS_UNSPECIFIED Estado desconocido.
PROVISIONING El clúster se está creando.
RUNNING El clúster se creó y se puede usar por completo.
DELETING El clúster se está borrando.
ERROR El estado indica que se produjeron algunos errores durante la conciliación o el borrado del clúster.
RECONCILING El clúster está en proceso de actualización de versión, etc.

SurvivabilityConfig

Configuración de la capacidad de supervivencia del clúster, p. ej., para el caso en que se pierde la conectividad de red

Campos
offline_reboot_ttl

Duration

Es opcional. Período que permite que los nodos del clúster se reinicien y funcionen sin conectividad de red a Google. El valor predeterminado 0 significa que no se permite. La cantidad máxima es de 7 días.

SystemAddonsConfig

Es la configuración que los clientes pueden definir para los complementos del sistema de GDCE.

Campos
ingress

Ingress

Es opcional. Es la configuración de Ingress.

Entrada

Es la configuración del complemento de Ingress que permite a los clientes crear un objeto Ingress para administrar el acceso externo a los servidores de un clúster. El complemento consta de istiod y istio-ingress.

Campos
disabled

bool

Es opcional. Indica si Ingress está inhabilitado.

ipv4_vip

string

Es opcional. Es la VIP de entrada.

ClusterNetworking

Configuración de herramientas de redes de todo el clúster.

Campos
cluster_ipv4_cidr_blocks[]

string

Obligatorio. A todos los pods del clúster se les asigna una dirección IPv4 RFC1918 de estos bloques. Solo se admite un bloque. No se puede cambiar este campo después de crearlo.

services_ipv4_cidr_blocks[]

string

Obligatorio. A todos los servicios del clúster se les asigna una dirección IPv4 RFC1918 de estos bloques. Solo se admite un bloque. No se puede cambiar este campo después de crearlo.

ClusterUser

Es un principal de usuario para una política de RBAC.

Campos
username

string

Obligatorio. Un nombre de usuario de Google activo

CreateClusterRequest

Crea un clúster.

Campos
parent

string

Obligatorio. Es la ubicación principal en la que se creará este clúster.

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • edgecontainer.clusters.create
cluster_id

string

Obligatorio. Es un identificador único especificado por el cliente para el clúster.

cluster

Cluster

Obligatorio. Es el clúster que se creará.

request_id

string

Es un identificador único para esta solicitud. Se limita a 36 caracteres ASCII. Se recomienda usar un UUID aleatorio. Esta solicitud solo es idempotente si se proporciona request_id.

CreateNodePoolRequest

Crea un grupo de nodos.

Campos
parent

string

Obligatorio. Es el clúster principal en el que se creará este grupo de nodos.

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • edgecontainer.nodePools.create
node_pool_id

string

Obligatorio. Es un identificador único especificado por el cliente para el grupo de nodos.

node_pool

NodePool

Obligatorio. Es el grupo de nodos que se creará.

request_id

string

Es un identificador único para esta solicitud. Se limita a 36 caracteres ASCII. Se recomienda usar un UUID aleatorio. Esta solicitud solo es idempotente si se proporciona request_id.

CreateVpnConnectionRequest

Crea una conexión de VPN.

Campos
parent

string

Obligatorio. Es la ubicación principal en la que se creará esta conexión de VPN.

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • edgecontainer.vpnConnections.create
vpn_connection_id

string

Obligatorio. Es el identificador de la conexión de VPN.

vpn_connection

VpnConnection

Obligatorio. Es la conexión de VPN que se creará.

request_id

string

Es un identificador único para esta solicitud. Se limita a 36 caracteres ASCII. Se recomienda usar un UUID aleatorio. Esta solicitud solo es idempotente si se proporciona request_id.

DeleteClusterRequest

Borra un clúster.

Campos
name

string

Obligatorio. Es el nombre del recurso del clúster.

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • edgecontainer.clusters.delete
request_id

string

Es un identificador único para esta solicitud. Se limita a 36 caracteres ASCII. Se recomienda usar un UUID aleatorio. Esta solicitud solo es idempotente si se proporciona request_id.

DeleteNodePoolRequest

Borra un grupo de nodos.

Campos
name

string

Obligatorio. Es el nombre del recurso del grupo de nodos.

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • edgecontainer.nodePools.delete
request_id

string

Es un identificador único para esta solicitud. Se limita a 36 caracteres ASCII. Se recomienda usar un UUID aleatorio. Esta solicitud solo es idempotente si se proporciona request_id.

DeleteVpnConnectionRequest

Borra una conexión VPN.

Campos
name

string

Obligatorio. Es el nombre del recurso de la conexión de VPN.

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • edgecontainer.vpnConnections.delete
request_id

string

Es un identificador único para esta solicitud. Se limita a 36 caracteres ASCII. Se recomienda usar un UUID aleatorio. Esta solicitud solo es idempotente si se proporciona request_id.

Flota

Configuración relacionada con la flota.

Las flotas son un concepto de Google Cloud que organiza los clústeres de manera lógica, lo que te permite usar y administrar capacidades de varios clústeres y aplicar políticas coherentes en tus sistemas.

Campos
project

string

Obligatorio. El número del proyecto host de la flota en el que se registrará este clúster.

Los nombres de los proyectos tienen el formato projects/<project-number>.

membership

string

Solo salida. El nombre del recurso de membresía del concentrador administrado asociado a este clúster.

Los nombres de las membresías tienen el formato projects/<project-number>/locations/global/membership/<cluster-id>.

GenerateAccessTokenRequest

Genera un token de acceso para un clúster.

Campos
cluster

string

Obligatorio. Es el nombre del recurso del clúster.

La autorización requiere el siguiente permiso de IAM en el recurso especificado cluster:

  • edgecontainer.clusters.get

GenerateAccessTokenResponse

Es un token de acceso para un clúster.

Campos
access_token

string

Solo salida. Token de acceso para autenticarte en api-server de k8s.

expire_time

Timestamp

Solo salida. Marca de tiempo en la que vencerá el token.

GenerateOfflineCredentialRequest

Genera una credencial sin conexión(offline) para un clúster.

Campos
cluster

string

Obligatorio. Es el nombre del recurso del clúster.

La autorización requiere el siguiente permiso de IAM en el recurso especificado cluster:

  • edgecontainer.clusters.get

GenerateOfflineCredentialResponse

Es una credencial sin conexión para un clúster.

Campos
client_certificate

string

Solo salida. Certificado de cliente para autenticarse en el servidor de la API de k8s.

client_key

string

Solo salida. Clave privada del cliente para autenticarse en el servidor de la API de k8s.

user_id

string

Solo salida. Identidad del cliente.

expire_time

Timestamp

Solo salida. Es la marca de tiempo en la que vencerá esta credencial.

GetClusterRequest

Obtiene un clúster.

Campos
name

string

Obligatorio. Es el nombre del recurso del clúster.

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • edgecontainer.clusters.get

GetMachineRequest

Obtiene una máquina.

Campos
name

string

Obligatorio. Es el nombre del recurso de la máquina.

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • edgecontainer.machines.get

GetNodePoolRequest

Obtiene un grupo de nodos.

Campos
name

string

Obligatorio. Es el nombre del recurso del grupo de nodos.

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • edgecontainer.nodePools.get

GetServerConfigRequest

Obtiene la configuración del servidor.

Campos
name

string

Obligatorio. Nombre (proyecto y ubicación) de la configuración del servidor que se obtendrá, especificado en el formato projects/*/locations/*.

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • edgecontainer.serverConfig.get

GetVpnConnectionRequest

Obtiene una conexión de VPN.

Campos
name

string

Obligatorio. Es el nombre del recurso de la conexión de VPN.

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • edgecontainer.vpnConnections.get

KmsKeyState

Representa el estado de accesibilidad de una clave de KMS administrada por el cliente que se usa para la integración de CMEK.

Enums
KMS_KEY_STATE_UNSPECIFIED Sin especificar.
KMS_KEY_STATE_KEY_AVAILABLE La clave está disponible para su uso y se debería poder acceder a los recursos dependientes.
KMS_KEY_STATE_KEY_UNAVAILABLE La clave no está disponible por un motivo no especificado. Es posible que no se pueda acceder a los recursos dependientes.

ListClustersRequest

Enumera los clústeres en una ubicación.

Campos
parent

string

Obligatorio. Es la ubicación principal, que es propietaria de esta colección de clústeres.

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • edgecontainer.clusters.list
page_size

int32

Es la cantidad máxima de recursos que se pueden incluir en la lista.

page_token

string

Es un token de página que se recibió de una solicitud de lista anterior. Es un token de página que se recibió de una solicitud de lista anterior.

filter

string

Solo se mostrarán los recursos que coincidan con este filtro.

order_by

string

Especifica el orden en que se mostrarán los recursos.

ListClustersResponse

Es una lista de clústeres en una ubicación.

Campos
clusters[]

Cluster

Son los clústeres en la ubicación.

next_page_token

string

Un token para recuperar la siguiente página de resultados.

unreachable[]

string

Ubicaciones a las que no se pudo llegar.

ListMachinesRequest

Enumera las máquinas de un sitio.

Campos
parent

string

Obligatorio. Es el sitio principal, que es propietario de esta colección de máquinas.

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • edgecontainer.machines.list
page_size

int32

Es la cantidad máxima de recursos que se pueden incluir en la lista.

page_token

string

Es un token de página que se recibió de una solicitud de lista anterior.

filter

string

Solo se mostrarán los recursos que coincidan con este filtro.

order_by

string

Especifica el orden en que se mostrarán los recursos.

ListMachinesResponse

Es la lista de máquinas en un sitio.

Campos
machines[]

Machine

Son las máquinas que se encuentran en el sitio.

next_page_token

string

Un token para recuperar la siguiente página de resultados.

unreachable[]

string

Ubicaciones a las que no se pudo llegar.

ListNodePoolsRequest

Enumera los grupos de nodos en un clúster.

Campos
parent

string

Obligatorio. Es el clúster principal, que es propietario de esta colección de grupos de nodos.

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • edgecontainer.nodePools.list
page_size

int32

Es la cantidad máxima de recursos que se pueden incluir en la lista.

page_token

string

Es un token de página que se recibió de una solicitud de lista anterior.

filter

string

Solo se mostrarán los recursos que coincidan con este filtro.

order_by

string

Especifica el orden en que se mostrarán los recursos.

ListNodePoolsResponse

Es una lista de grupos de nodos en un clúster.

Campos
node_pools[]

NodePool

Son los grupos de nodos del clúster.

next_page_token

string

Un token para recuperar la siguiente página de resultados.

unreachable[]

string

Ubicaciones a las que no se pudo llegar.

ListVpnConnectionsRequest

Enumera las conexiones de VPN.

Campos
parent

string

Obligatorio. Es la ubicación principal, que es propietaria de esta colección de conexiones de VPN.

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • edgecontainer.vpnConnections.list
page_size

int32

Es la cantidad máxima de recursos que se pueden incluir en la lista.

page_token

string

Es un token de página que se recibió de una solicitud de lista anterior.

filter

string

Solo se mostrarán los recursos que coincidan con este filtro.

order_by

string

Especifica el orden en que se mostrarán los recursos.

ListVpnConnectionsResponse

Es una lista de las conexiones VPN en una ubicación.

Campos
vpn_connections[]

VpnConnection

Son las VpnConnections en la ubicación.

next_page_token

string

Un token para recuperar la siguiente página de resultados.

unreachable[]

string

Ubicaciones a las que no se pudo llegar.

LocationMetadata

Son los metadatos de un google.cloud.location.Location determinado.

Campos
available_zones

map<string, ZoneMetadata>

Es el conjunto de zonas de Google Distributed Cloud Edge disponibles en la ubicación. El mapa se indexa con el ID en minúsculas de cada zona.

Máquina

Una máquina de Google Distributed Cloud Edge capaz de actuar como un nodo de Kubernetes

Campos
name

string

Obligatorio. Es el nombre del recurso de la máquina.

create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó el grupo de nodos.

update_time

Timestamp

Solo salida. Fecha y hora en la que se actualizó el grupo de nodos por última vez.

labels

map<string, string>

Son las etiquetas asociadas a este recurso.

hosted_node

string

Es el nombre canónico del recurso del nodo que esta máquina es responsable de alojar, p.ej., projects/{project}/locations/{location}/clusters/{cluster_id}/nodePools/{pool_id}/{node}, o bien está vacío si la máquina no está asignada para asumir el rol de un nodo.

Para los nodos del plano de control alojados en máquinas perimetrales, se devolverá el siguiente formato: "projects/{project}/locations/{location}/clusters/{cluster_id}/controlPlaneNodes/{node}".

zone

string

Es la zona de Google Distributed Cloud Edge de esta máquina.

version

string

Solo salida. Es la versión de software de la máquina.

disabled

bool

Solo salida. Indica si la máquina está inhabilitada. Si está inhabilitada, la máquina no puede entrar en servicio.

MaintenancePolicy

Es la configuración de la política de mantenimiento.

Campos
window

MaintenanceWindow

Especifica el período de mantenimiento en el que se puede realizar el mantenimiento.

MaintenanceWindow

Configuración del período de mantenimiento

Campos
recurring_window

RecurringTimeWindow

Es la configuración de un período de mantenimiento recurrente.

Grupo de nodos

Es un conjunto de nodos de Kubernetes en un clúster con configuración y especificaciones comunes.

Campos
name

string

Obligatorio. Es el nombre del recurso del grupo de nodos.

create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó el grupo de nodos.

update_time

Timestamp

Solo salida. Fecha y hora en la que se actualizó el grupo de nodos por última vez.

labels

map<string, string>

Son las etiquetas asociadas a este recurso.

node_location

string

Es el nombre de la zona de Google Distributed Cloud Edge en la que se creará este grupo de nodos. Por ejemplo: us-central1-edge-customer-a.

node_count

int32

Obligatorio. Es la cantidad de nodos del grupo.

machine_filter

string

Solo se permitirá que las máquinas que coincidan con este filtro se unan al grupo de nodos. El lenguaje de filtrado acepta cadenas como "name=" y se documenta con más detalle en AIP-160.

local_disk_encryption

LocalDiskEncryption

Es opcional. Opciones de encriptación de disco local Este campo solo se usa cuando se habilita la compatibilidad con CMEK.

node_version

string

Solo salida. Es la versión de lanzamiento más baja entre todos los nodos trabajadores.

node_config

NodeConfig

Es opcional. Es la configuración de cada nodo del NodePool.

LocalDiskEncryption

Es la configuración de la compatibilidad con CMEK para la encriptación de discos locales de la máquina perimetral.

Campos
kms_key

string

Inmutable. Es la CryptoKey de Cloud KMS (p.ej., projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}) que se usará para proteger los discos locales del nodo. Si no se especifica, se usará una clave administrada por Google.

kms_key_active_version

string

Solo salida. Es la versión de CryptoKey de Cloud KMS que se usa actualmente para proteger los discos locales del nodo. Solo se aplica si se configura kms_key.

kms_key_state

KmsKeyState

Solo salida. Disponibilidad de la CryptoKey de Cloud KMS. Si no es KEY_AVAILABLE, es posible que los nodos se desconecten, ya que no pueden acceder a sus datos locales. Esto puede deberse a la falta de permisos para usar la clave o a que la clave está inhabilitada o borrada.

kms_status

Status

Solo salida. Es el estado de error que devuelve Cloud KMS cuando se usa esta clave. Este campo solo se puede completar si kms_key_state no es KMS_KEY_STATE_KEY_AVAILABLE. Si se propaga, este campo contiene el estado de error que informa Cloud KMS.

NodeConfig

Es la configuración de cada nodo del NodePool.

Campos
labels

map<string, string>

Es opcional. Las etiquetas de nodos de Kubernetes

OperationMetadata

Son los metadatos de la operación de larga duración para los métodos de la API de Edge Container.

Campos
create_time

Timestamp

Es la fecha y hora en que se creó la operación.

end_time

Timestamp

Es la hora a la que finalizó la operación.

target

string

Es la ruta de acceso al recurso definida por el servidor para el destino de la operación.

verb

string

Verbo que ejecuta la operación.

status_message

string

Estado legible de la operación, si lo hay.

requested_cancellation

bool

Identifica si el usuario solicitó la cancelación de la operación. Las operaciones que se cancelaron de forma correcta tienen el valor [Operation.error][] con un google.rpc.Status.code de 1, que corresponde a Code.CANCELLED.

api_version

string

Versión de la API que se usó para iniciar la operación.

warnings[]

string

Advertencias que no bloquean la operación, pero que contienen información relevante para el usuario final.

Cuota

Representa la cuota para los recursos de contenedores de Edge.

Campos
metric

string

Es el nombre de la métrica de cuota.

limit

double

Es el límite de cuota para esta métrica.

usage

double

Es el uso actual de esta métrica.

RecurringTimeWindow

Representa un período arbitrario que se repite.

Campos
window

TimeWindow

Es el período de la primera recurrencia.

recurrence

string

Es una RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) que indica cómo se repite este período. Se extienden durante el período comprendido entre la hora de inicio y la hora de finalización.

ServerConfig

Es la configuración del servidor para las versiones y los canales de versiones compatibles.

Campos
channels

map<string, ChannelConfig>

Solo salida. Es la asignación del canal de versiones a la configuración del canal.

versions[]

Version

Solo salida. Versiones compatibles, p.ej.: ["1.4.0", "1.5.0"].

default_version

string

Solo salida. Versión predeterminada, p.ej.: "1.4.0".

TimeWindow

Representa un período arbitrario.

Campos
start_time

Timestamp

Es la hora en la que comienza el período.

end_time

Timestamp

Es la fecha y hora en que finaliza el período. La hora de finalización debe ser posterior a la de inicio.

UpdateClusterRequest

Actualiza un clúster.

Campos
update_mask

FieldMask

La máscara de campo se usa para especificar los campos que la actualización reemplazará en el recurso Cluster. Los campos especificados en update_mask se relacionan con el recurso, no con la solicitud completa. Un campo se reemplazará si está en la máscara. Si el usuario no proporciona una máscara, se reemplazarán todos los campos.

cluster

Cluster

Es el clúster actualizado.

La autorización requiere el siguiente permiso de IAM en el recurso especificado cluster:

  • edgecontainer.clusters.update
request_id

string

Es un identificador único para esta solicitud. Se limita a 36 caracteres ASCII. Se recomienda usar un UUID aleatorio. Esta solicitud solo es idempotente si se proporciona request_id.

UpdateNodePoolRequest

Actualiza un grupo de nodos.

Campos
update_mask

FieldMask

La máscara de campo se usa para especificar los campos que la actualización reemplazará en el recurso NodePool. Los campos especificados en update_mask se relacionan con el recurso, no con la solicitud completa. Un campo se reemplazará si está en la máscara. Si el usuario no proporciona una máscara, se reemplazarán todos los campos.

node_pool

NodePool

Es el grupo de nodos actualizado.

La autorización requiere el siguiente permiso de IAM en el recurso especificado nodePool:

  • edgecontainer.nodePools.update
request_id

string

Es un identificador único para esta solicitud. Se limita a 36 caracteres ASCII. Se recomienda usar un UUID aleatorio. Esta solicitud solo es idempotente si se proporciona request_id.

UpgradeClusterRequest

Actualiza un clúster.

Campos
name

string

Obligatorio. Es el nombre del recurso del clúster.

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • edgecontainer.clusters.upgrade
target_version

string

Obligatorio. Es la versión a la que se actualizará el clúster.

schedule

Schedule

Es la programación de la actualización.

request_id

string

Es un identificador único para esta solicitud. Se limita a 36 caracteres ASCII. Se recomienda usar un UUID aleatorio. Esta solicitud solo es idempotente si se proporciona request_id.

Programar

Representa el programa de cuándo se actualizará el clúster.

Enums
SCHEDULE_UNSPECIFIED Sin especificar. La opción predeterminada es actualizar el clúster de inmediato, que es la única opción disponible actualmente.
IMMEDIATELY El clúster se actualizará inmediatamente después de recibir la solicitud.

Versión

Es la versión de un clúster.

Campos
name

string

Solo salida. Nombre de la versión, p.ej.: "1.4.0".

VpnConnection

Una conexión de VPN .

Campos
name

string

Obligatorio. Nombre del recurso de la conexión de VPN

create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó la conexión de VPN.

update_time

Timestamp

Solo salida. Fecha y hora en la que se actualizó la conexión de VPN por última vez.

labels

map<string, string>

Son las etiquetas asociadas a este recurso.

nat_gateway_ip

string

IP de la puerta de enlace NAT o dirección IP de WAN Si un cliente tiene varias IPs de NAT, debe configurar la NAT de modo que solo una IP externa se asigne al clúster de Anthos de GMEC. Este campo está vacío si no se usa NAT.

bgp_routing_mode
(deprecated)

BgpRoutingMode

Modo de enrutamiento dinámico de la red de VPC, regional o global.

cluster

string

Es el nombre canónico del clúster al que se conectará. Tiene el formato projects/{project}/locations/{location}/clusters/{cluster}.

vpc

string

Es el ID de la red de VPC a la que se conectará.

vpc_project

VpcProject

Es opcional. Detalles del proyecto de la red de VPC. Se requiere si la VPC se encuentra en un proyecto diferente del proyecto del clúster.

enable_high_availability

bool

Indica si esta conexión de VPN tiene habilitada la alta disponibilidad en el clúster. Si está habilitada, cuando se cree la conexión de VPN, intentaremos usar 2 IPs flotantes de ANG.

router

string

Es opcional. Es el nombre del Cloud Router de la conexión de VPN.

details

Details

Solo salida. Son los detalles de la conexión creada.

BgpRoutingMode

Modo de enrutamiento.

Enums
BGP_ROUTING_MODE_UNSPECIFIED Desconocido.
REGIONAL Modo regional.
GLOBAL Modo global

Detalles

Son los detalles de la conexión creada.

Campos
state

State

Es el estado de esta conexión.

error

string

Mensaje de error. Este campo solo se propaga cuando state=ERROR.

cloud_router

CloudRouter

Es la información del Cloud Router.

cloud_vpns[]

CloudVpn

Cada conexión tiene varias puertas de enlace de Cloud VPN.

CloudRouter

Es la información del Cloud Router.

Campos
name

string

Es el nombre del Cloud Router asociado.

CloudVpn

Es la información de Cloud VPN.

Campos
gateway

string

Es el nombre de la puerta de enlace de Cloud VPN creada.

Estado

Es el estado de conexión actual.

Enums
STATE_UNSPECIFIED Desconocido.
STATE_CONNECTED Conectado.
STATE_CONNECTING Aún conectándose.
STATE_ERROR Se produjo un error.

VpcProject

Detalles del proyecto de la red de VPC.

Campos
project_id

string

Es el proyecto de la VPC a la que se conectará. Si no se especifica, es el mismo que el proyecto del clúster.

service_account
(deprecated)

string

Es opcional. Es la cuenta de servicio en el proyecto de VPC configurada por el usuario. Se usa para crear o borrar Cloud Router y VPN con alta disponibilidad de Cloud para la conexión de VPN. Si se cambia esta SA durante o después de que se crea una conexión de VPN, debes quitar los recursos de Cloud Router y Cloud VPN en |project_id|. Tiene el formato service-{project_number}@gcp-sa-edgecontainer.iam.gserviceaccount.com.

ZoneMetadata

Es una zona de Google Distributed Cloud Edge en la que se encuentran las máquinas perimetrales.

Campos
quota[]

Quota

Es la cuota para los recursos en esta zona.

rack_types

map<string, RackType>

Es el mapa que se codifica según el nombre del rack y tiene el valor de RackType.

RackType

Es el tipo de estructura.

Enums
RACK_TYPE_UNSPECIFIED Tipo de estructura no especificado. Las estructuras individuales también pertenecen a este tipo.
BASE Tipo de rack base, un par de dos racks Config-1 modificados que contienen conmutadores de agregación.
EXPANSION Tipo de estructura de expansión, también conocidas como estructuras independientes, que los clientes agregan a pedido.