Package google.cloud.edgecontainer.v1alpha

Índice

EdgeContainer

A API EdgeContainer oferece gerenciamento de clusters do Kubernetes em implantações do Google Edge Cloud.

CreateCluster

rpc CreateCluster(CreateClusterRequest) returns (Operation)

Cria um novo cluster em determinado projeto e local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
CreateNodePool

rpc CreateNodePool(CreateNodePoolRequest) returns (Operation)

Cria um novo NodePool em determinado projeto e local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
CreateVpnConnection

rpc CreateVpnConnection(CreateVpnConnectionRequest) returns (Operation)

Cria uma conexão VPN em determinado projeto e local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
DeleteCluster

rpc DeleteCluster(DeleteClusterRequest) returns (Operation)

Exclui um único cluster.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
DeleteNodePool

rpc DeleteNodePool(DeleteNodePoolRequest) returns (Operation)

Exclui um único NodePool.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
DeleteVpnConnection

rpc DeleteVpnConnection(DeleteVpnConnectionRequest) returns (Operation)

Exclui uma única conexão VPN.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
GenerateAccessToken

rpc GenerateAccessToken(GenerateAccessTokenRequest) returns (GenerateAccessTokenResponse)

Gera um token de acesso para um cluster.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
GenerateOfflineCredential

rpc GenerateOfflineCredential(GenerateOfflineCredentialRequest) returns (GenerateOfflineCredentialResponse)

Gera uma credencial off-line para um cluster.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
GetCluster

rpc GetCluster(GetClusterRequest) returns (Cluster)

Recebe detalhes de um único cluster.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
GetMachine

rpc GetMachine(GetMachineRequest) returns (Machine)

Recebe detalhes de uma única máquina.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
GetNodePool

rpc GetNodePool(GetNodePoolRequest) returns (NodePool)

Recebe detalhes de um único NodePool.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
GetServerConfig

rpc GetServerConfig(GetServerConfigRequest) returns (ServerConfig)

Recebe a configuração do servidor.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
GetVpnConnection

rpc GetVpnConnection(GetVpnConnectionRequest) returns (VpnConnection)

Recebe detalhes de uma única conexão VPN.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
ListClusters

rpc ListClusters(ListClustersRequest) returns (ListClustersResponse)

Lista os clusters em um determinado projeto e local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
ListMachines

rpc ListMachines(ListMachinesRequest) returns (ListMachinesResponse)

Lista as máquinas em um determinado projeto e local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
ListNodePools

rpc ListNodePools(ListNodePoolsRequest) returns (ListNodePoolsResponse)

Lista os NodePools em determinado projeto e local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
ListVpnConnections

rpc ListVpnConnections(ListVpnConnectionsRequest) returns (ListVpnConnectionsResponse)

Lista as conexões VPN em um determinado projeto e local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
UpdateCluster

rpc UpdateCluster(UpdateClusterRequest) returns (Operation)

Atualiza os parâmetros de um único cluster.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
UpdateNodePool

rpc UpdateNodePool(UpdateNodePoolRequest) returns (Operation)

Atualiza os parâmetros de um único NodePool.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
UpgradeCluster

rpc UpgradeCluster(UpgradeClusterRequest) returns (Operation)

Faz upgrade de um único cluster.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Autorização

Política de RBAC que será aplicada e gerenciada pelo GEC.

Campos
admin_users

ClusterUser

Obrigatório. Usuário que receberá o papel de administrador do cluster e terá acesso total a ele. No momento, esse é um campo único, mas será expandido para permitir vários administradores no futuro.

ChannelConfig

Configuração de um canal de lançamento.

Campos
default_version

string

Apenas saída. Versão padrão para este canal de lançamento, por exemplo: "1.4.0".

Cluster

Um cluster do Kubernetes do Google Distributed Cloud Edge.

Campos
name

string

Obrigatório. O nome do recurso do cluster.
create_time

Timestamp

Apenas saída. O horário de criação do cluster.
update_time

Timestamp

Apenas saída. A hora em que o cluster foi atualizado pela última vez.
labels

map<string, string>

Rótulos associados a este recurso.
fleet

Fleet

Obrigatório. Configuração da frota.
networking

ClusterNetworking

Obrigatório. Configuração de rede em todo o cluster.
authorization

Authorization

Obrigatório. Imutável. Política de RBAC que será aplicada e gerenciada pelo GEC.
default_max_pods_per_node

int32

Opcional. O número máximo padrão de pods por nó usado se um valor máximo não for especificado explicitamente para um pool de nós neste cluster. Se não for especificado, o valor padrão do Kubernetes será usado.
endpoint

string

Apenas saída. O endereço IP do servidor da API Kubernetes.
port

int32

Apenas saída. O número da porta do servidor da API Kubernetes.
cluster_ca_certificate

string

Apenas saída. O certificado público codificado em PEM da CA do cluster.
maintenance_policy

MaintenancePolicy

Opcional. Configuração da política de manutenção em todo o cluster.
control_plane_version

string

Apenas saída. A versão de lançamento do plano de controle
node_version

string

Apenas saída. A versão de lançamento mais baixa entre todos os nós de trabalho. Esse campo pode ficar vazio se o cluster não tiver nós de trabalho.
control_plane

ControlPlane

Opcional. A configuração do plano de controle do cluster.
system_addons_config

SystemAddonsConfig

Opcional. A configuração dos complementos do sistema.
external_load_balancer_ipv4_address_pools[]

string

Opcional. Pools de endereços IPv4 para balanceamento de carga externo do plano de dados do cluster.
control_plane_encryption

ControlPlaneEncryption

Opcional. Opções de criptografia de disco do plano de controle remoto. Esse campo só é usado ao ativar o suporte à CMEK.
status

Status

Apenas saída. O status atual do cluster.
maintenance_events[]

MaintenanceEvent

Apenas saída. Todos os eventos de manutenção programados para o cluster, incluindo os em andamento, planejados para o futuro e realizados no passado (até 90 dias).
target_version

string

Opcional. A versão do cluster de destino. Por exemplo: "1.5.0".
release_channel

ReleaseChannel

Opcional. O canal de lançamento em que um cluster está inscrito.
survivability_config

SurvivabilityConfig

Opcional. Configuração da capacidade de sobrevivência do cluster, por exemplo, para o caso em que a conectividade de rede é perdida. Observação: isso só se aplica a clusters de plano de controle local.
external_load_balancer_ipv6_address_pools[]

string

Opcional. Pools de endereços IPv6 para balanceamento de carga externo do plano de dados do cluster.
connection_state

ConnectionState

Apenas saída. O estado atual da conexão do cluster.
external_load_balancer_address_pools[]

ExternalLoadBalancerPool

Opcional. Pools de balanceadores de carga externos para o cluster.
zone_storage_encryption

ZoneStorageEncryption

Opcional. A configuração de criptografia de armazenamento da zona
container_runtime_config

ContainerRuntimeConfig

Opcional. A configuração do ambiente de execução do contêiner do cluster.
enable_cluster_isolation

bool

Opcional. Isso indica se o cluster precisa ser isolado. go/cluster-isolation-in-gdcc-cluster

ConnectionState

ConnectionState contém o estado atual da conexão do cluster com o Google.

Campos
state

State

Apenas saída. O estado atual da conexão.
update_time

Timestamp

Apenas saída. O horário em que o estado da conexão foi alterado pela última vez.

Estado

O estado da conexão.

Tipos enumerados
STATE_UNSPECIFIED Estado de conexão desconhecido.
DISCONNECTED No momento, este cluster está desconectado do Google.
CONNECTED Este cluster está conectado ao Google.
CONNECTED_AND_SYNCING Este cluster está conectado ao Google, mas pode ter sido reconectado recentemente após uma desconexão. Ainda está sincronizando de volta.

ContainerRuntimeConfig

Configuração do ambiente de execução do contêiner do cluster.

Campos
default_container_runtime

DefaultContainerRuntime

Opcional. O ambiente de execução de contêiner padrão a ser configurado no cluster.

DefaultContainerRuntime

Lista de tempos de execução de contêineres compatíveis.

Tipos enumerados
DEFAULT_CONTAINER_RUNTIME_UNSPECIFIED O ambiente de execução do contêiner não foi especificado.
RUNC Use o runc como o ambiente de execução de contêiner padrão no cluster.
GVISOR Use o gVisor como o ambiente de execução de contêiner padrão no cluster.

ControlPlane

Configuração do plano de controle do cluster.

Campos

Campo de união config.

config pode ser apenas de um dos tipos a seguir:
remote

Remote

Configuração do plano de controle remoto.
local

Local

Configuração do plano de controle local.

Aviso: os clusters de plano de controle local precisam ser criados no próprio projeto. Os clusters de plano de controle local não podem coexistir no mesmo projeto com nenhum outro tipo de cluster, incluindo clusters que não são do GDCE. Misturar clusters GDCE de plano de controle local com qualquer outro tipo de cluster no mesmo projeto pode resultar em perda de dados.

Local

Configuração específica para clusters com um plano de controle hospedado localmente.

Aviso: os clusters de plano de controle local precisam ser criados no próprio projeto. Os clusters de plano de controle local não podem coexistir no mesmo projeto com nenhum outro tipo de cluster, incluindo clusters que não são do GDCE. Misturar clusters GDCE de plano de controle local com qualquer outro tipo de cluster no mesmo projeto pode resultar em perda de dados.

Campos
node_location

string

Nome das zonas do Google Distributed Cloud Edge em que esse pool de nós será criado. Por exemplo, us-central1-edge-customer-a.
node_count

int32

O número de nós que vão servir como réplicas do plano de controle.
machine_filter

string

Somente as máquinas que correspondem a esse filtro podem hospedar nós do plano de controle. A linguagem de filtragem aceita strings como "name=" e está documentada aqui: AIP-160.
shared_deployment_policy

SharedDeploymentPolicy

Configuração de política sobre como os aplicativos do usuário são implantados.
control_plane_node_storage_schema

string

Opcional. Nome do esquema de armazenamento dos nós do plano de controle.

Remoto

Esse tipo não tem campos.

Configuração específica para clusters com um plano de controle hospedado remotamente.

SharedDeploymentPolicy

Representa a configuração da política sobre como os aplicativos do usuário são implantados.

Tipos enumerados
SHARED_DEPLOYMENT_POLICY_UNSPECIFIED Não especificado.
ALLOWED Os aplicativos do usuário podem ser implantados no plano de controle e nos nós de trabalho.
DISALLOWED Os aplicativos do usuário não podem ser implantados em nós do plano de controle, apenas em nós de trabalho.

ControlPlaneEncryption

Configuração para suporte a chaves do KMS gerenciadas pelo cliente para nós do plano de controle.

Campos
kms_key

string

Opcional. A CryptoKey do Cloud KMS, por exemplo, projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}, para usar na proteção de discos do plano de controle. Se não for especificada, uma chave gerenciada pelo Google será usada.
kms_key_active_version

string

Apenas saída. A CryptoKeyVersion do Cloud KMS atualmente em uso para proteger discos do plano de controle. Só é aplicável se kms_key estiver definido.
kms_key_state

KmsKeyState

Apenas saída. Disponibilidade da CryptoKey do Cloud KMS. Se não for KEY_AVAILABLE, os nós poderão ficar off-line porque não conseguem acessar os dados locais. Isso pode ser causado pela falta de permissões para usar a chave ou se ela estiver desativada ou excluída.
kms_status

Status

Apenas saída. Status de erro retornado pelo Cloud KMS ao usar essa chave. Esse campo só pode ser preenchido se kms_key_state não for KMS_KEY_STATE_KEY_AVAILABLE. Se preenchido, esse campo vai conter o status do erro informado pelo Cloud KMS.
resource_state

ResourceState

Apenas saída. O estado atual do recurso associado à CMEK.

ExternalLoadBalancerPool

Pool de balanceador de carga externo com configuração personalizada, como nome, atribuição manual/automática, ipv4 não sobreposto e intervalo de endereços ipv6 opcional.

Campos
address_pool

string

Opcional. Nome do pool de balanceamento de carga externo.
ipv4_range[]

string

Obrigatório. Intervalo de endereços IPv4 não sobrepostos do pool de balanceadores de carga externos.
ipv6_range[]

string

Opcional. Intervalo de endereços IPv6 não sobrepostos do pool de balanceadores de carga externos.
avoid_buggy_ips

bool

Opcional. Se for "true", o pool vai omitir endereços IP que terminam em .0 e .255. Alguns hardwares de rede descartam tráfego para esses endereços especiais. O valor padrão é "false".
manual_assign

bool

Opcional. Se verdadeiro, os endereços neste pool não serão atribuídos automaticamente aos serviços do Kubernetes. Se for "true", um endereço IP nesse pool só será usado quando for especificado explicitamente por um serviço. O valor padrão é "false".

MaintenanceEvent

Um evento de manutenção é uma operação que pode causar interrupções temporárias nas cargas de trabalho do cluster, incluindo upgrades de cluster iniciados pelo Google ou pelo usuário, mudanças na configuração do cluster iniciadas pelo usuário que exigem a reinicialização de nós etc.

Campos
uuid

string

Apenas saída. UUID do evento de manutenção.
target_version

string

Apenas saída. A versão de destino do cluster.
operation

string

Apenas saída. A operação para executar o evento de manutenção. Especificado no formato projects/*/locations/*/operations/*. Se o evento de manutenção for dividido em várias operações (por exemplo, devido a janelas de manutenção), a mais recente será registrada.
type

Type

Apenas saída. O tipo do evento de manutenção.
schedule

Schedule

Apenas saída. A programação do evento de manutenção.
state

State

Apenas saída. O estado do evento de manutenção.
create_time

Timestamp

Apenas saída. O horário em que a solicitação de evento de manutenção foi criada.
start_time

Timestamp

Apenas saída. O horário em que o evento de manutenção começou.
end_time

Timestamp

Apenas saída. O horário em que o evento de manutenção terminou, com ou sem êxito. Se o evento de manutenção for dividido em várias janelas, o end_time só será atualizado quando todo o fluxo terminar.
update_time

Timestamp

Apenas saída. O horário em que a mensagem do evento de manutenção foi atualizada.

Programar

Indica quando o evento de manutenção deve ser realizado.

Tipos enumerados
SCHEDULE_UNSPECIFIED Não especificado.
IMMEDIATELY Imediatamente após receber a solicitação.

Estado

Indica o estado do evento de manutenção.

Tipos enumerados
STATE_UNSPECIFIED Não especificado.
RECONCILING O evento de manutenção está em andamento. O cluster pode estar inutilizável.
SUCCEEDED O evento de manutenção foi concluído.
FAILED O evento de manutenção falhou.

Tipo

Indica o tipo de evento de manutenção.

Tipos enumerados
TYPE_UNSPECIFIED Não especificado.
USER_INITIATED_UPGRADE Upgrade iniciado pelos usuários.
GOOGLE_DRIVEN_UPGRADE Upgrade feito pelo Google.

ReleaseChannel

O canal de lançamento em que um cluster está inscrito.

Tipos enumerados
RELEASE_CHANNEL_UNSPECIFIED Canal de lançamento não especificado. O padrão é o canal REGULAR.
NONE Nenhum canal de lançamento.
REGULAR Canal de lançamento normal.

Status

Indica o status do cluster.

Tipos enumerados
STATUS_UNSPECIFIED Status desconhecido.
PROVISIONING O cluster está sendo criado.
RUNNING O cluster é criado e totalmente utilizável.
DELETING O cluster está sendo excluído.
ERROR O status indica que ocorreram alguns erros ao reconciliar/excluir o cluster.
RECONCILING O cluster está passando por algum trabalho, como upgrades de versão etc.

SurvivabilityConfig

Configuração da capacidade de sobrevivência do cluster, por exemplo, para o caso em que a conectividade de rede é perdida.

Campos
offline_reboot_ttl

Duration

Opcional. Período que permite que os nós do cluster sejam reinicializados e fiquem funcionais sem conectividade de rede com o Google. O padrão 0 significa que não é permitido. O máximo é sete dias.

SystemAddonsConfig

Configuração que os clientes podem definir para complementos do sistema GDCE.

Campos
ingress

Ingress

Opcional. Configuração para Entrada.
vm_service_config

VMServiceConfig

Opcional. Configuração para o serviço de VM.

Entrada

Configuração do complemento Entrada, que permite aos clientes criar um objeto Entrada para gerenciar o acesso externo aos servidores em um cluster. O complemento consiste em istiod e istio-ingress.

Campos
disabled

bool

Opcional. Indica se a entrada está desativada.
ipv4_vip

string

Opcional. VIP de entrada.

VMServiceConfig

VMServiceConfig define a configuração do serviço de VM do GDCE.

Campos
vmm_enabled

bool

Opcional. Se o VMM está ativado.

ZoneStorageEncryption

Configuração para suporte à CMEK de armazenamento zonal

Campos
kms_key

string

Opcional. A chave do Cloud KMS
kms_key_active_version

string

Apenas saída. A CryptoKeyVersion do Cloud KMS usada atualmente para criptografia/descriptografia
resource_state

ResourceState

Apenas saída. O estado atual do recurso da CMEK.

ClusterNetworking

Configuração de rede em todo o cluster.

Campos
cluster_ipv4_cidr_blocks[]

string

Obrigatório. Todos os pods no cluster recebem um endereço IPv4 RFC1918 desses blocos. Só é possível usar um bloco. Este campo não pode ser alterado após a criação.
services_ipv4_cidr_blocks[]

string

Obrigatório. Todos os serviços do cluster recebem um endereço IPv4 RFC1918 desses blocos. Só é possível usar um bloco. Este campo não pode ser alterado após a criação.

ClusterUser

Um principal de usuário para uma política de RBAC.

Campos
username

string

Obrigatório. Um nome de usuário do Google ativo.

ConfigData

Os dados de configuração contêm todos os dados relacionados à configuração da zona.

Campos
available_external_lb_pools_ipv4[]

string

Lista de pools de IP v4 disponíveis para balanceador de carga externo.
available_external_lb_pools_ipv6[]

string

lista de pools de IP v6 disponíveis para balanceador de carga externo

CreateClusterRequest

Cria um cluster.

Campos
parent

string

Obrigatório. O local pai em que o cluster será criado.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • edgecontainer.clusters.create
cluster_id

string

Obrigatório. Um identificador exclusivo especificado pelo cliente para o cluster.
cluster

Cluster

Obrigatório. O cluster a ser criado.
request_id

string

Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se request_id for fornecido.

CreateNodePoolRequest

Cria um pool de nós.

Campos
parent

string

Obrigatório. O cluster pai em que este pool de nós será criado.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • edgecontainer.nodePools.create
node_pool_id

string

Obrigatório. Um identificador exclusivo especificado pelo cliente para o pool de nós.
node_pool

NodePool

Obrigatório. O pool de nós a ser criado.
request_id

string

Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se request_id for fornecido.

CreateVpnConnectionRequest

Cria uma conexão VPN.

Campos
parent

string

Obrigatório. O local pai em que essa conexão VPN será criada.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • edgecontainer.vpnConnections.create
vpn_connection_id

string

Obrigatório. O identificador da conexão VPN.
vpn_connection

VpnConnection

Obrigatório. A conexão VPN a ser criada.
request_id

string

Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se request_id for fornecido.

DeleteClusterRequest

Exclui um cluster.

Campos
name

string

Obrigatório. O nome do recurso do cluster.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • edgecontainer.clusters.delete
request_id

string

Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se request_id for fornecido.

DeleteNodePoolRequest

Exclui um pool de nós.

Campos
name

string

Obrigatório. O nome do recurso do pool de nós.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • edgecontainer.nodePools.delete
request_id

string

Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se request_id for fornecido.

DeleteVpnConnectionRequest

Exclui uma conexão VPN.

Campos
name

string

Obrigatório. O nome do recurso da conexão VPN.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • edgecontainer.vpnConnections.delete
request_id

string

Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se request_id for fornecido.

Frota

Configuração relacionada à frota.

As frotas são um conceito do Google Cloud voltado à organização lógica de clusters. Com elas, é possível usar e gerenciar recursos de vários clusters e aplicar políticas consistentes em todos os sistemas.

Campos
project

string

Obrigatório. O número do projeto host da frota em que este cluster será registrado.

Os nomes de projetos são formatados como projects/<project-number>.
membership

string

Apenas saída. O nome do recurso de assinatura de hub gerenciado associado a esse cluster.

Os nomes de assinaturas são formatados como projects/<project-number>/locations/global/membership/<cluster-id>.

GenerateAccessTokenRequest

Gera um token de acesso para um cluster.

Campos
cluster

string

Obrigatório. O nome do recurso do cluster.

A autorização requer a seguinte permissão do IAM no recurso especificado cluster:

  • edgecontainer.clusters.generateAccessToken

GenerateAccessTokenResponse

Um token de acesso para um cluster.

Campos
access_token

string

Apenas saída. Token de acesso para autenticação no api-server do K8s.
expire_time

Timestamp

Apenas saída. Carimbo de data/hora em que o token vai expirar.

GenerateOfflineCredentialRequest

Gera uma credencial off-line para um cluster.

Campos
cluster

string

Obrigatório. O nome do recurso do cluster.

A autorização requer a seguinte permissão do IAM no recurso especificado cluster:

  • edgecontainer.clusters.generateOfflineCredential

GenerateOfflineCredentialResponse

Uma credencial off-line para um cluster.

Campos
client_certificate

string

Apenas saída. Certificado do cliente para autenticação no api-server do K8s.
client_key

string

Apenas saída. Chave privada do cliente para autenticação no api-server do K8s.
user_id

string

Apenas saída. Identidade do cliente.
expire_time

Timestamp

Apenas saída. Carimbo de data/hora em que esta credencial vai expirar.

GetClusterRequest

Recebe um cluster.

Campos
name

string

Obrigatório. O nome do recurso do cluster.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • edgecontainer.clusters.get

GetMachineRequest

Recebe uma máquina.

Campos
name

string

Obrigatório. O nome do recurso da máquina.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • edgecontainer.machines.get

GetNodePoolRequest

Recebe um pool de nós.

Campos
name

string

Obrigatório. O nome do recurso do pool de nós.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • edgecontainer.nodePools.get

GetServerConfigRequest

Recebe a configuração do servidor.

Campos
name

string

Obrigatório. O nome (projeto e local) da configuração do servidor a ser recebida, especificado no formato projects/*/locations/*.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • edgecontainer.serverConfig.get

GetVpnConnectionRequest

Recebe uma conexão VPN.

Campos
name

string

Obrigatório. O nome do recurso da conexão VPN.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • edgecontainer.vpnConnections.get

IdentityProvider

Representa um recurso de provedor de identidade que representa a configuração do provedor de identidade para a organização.

Campos
name

string

Identificador. O nome canônico do recurso do provedor de identidade. Por exemplo, organizations/{organization}/locations/{location}/identityProviders/{identity_provider}
create_time

Timestamp

Apenas saída. O horário em que o provedor de identidade foi criado.
update_time

Timestamp

Apenas saída. A hora em que o provedor de identidade foi atualizado pela última vez.
delete_time

Timestamp

Apenas saída. O horário em que o provedor de identidade foi excluído.
labels

map<string, string>

Opcional. Rótulos associados a este recurso.
Campo de união config. A configuração do provedor de identidade. config pode ser apenas de um dos tipos a seguir:
oidc_config

OIDCProviderConfig

A configuração do provedor OIDC.
Campo de união target. O destino do provedor de identidade. target pode ser apenas de um dos tipos a seguir:
zone_id

string

O ID da zona de destino do cluster de infraestrutura em que o provedor de identidade será configurado.
cluster

string

O nome totalmente qualificado da BMUC de destino para a qual o provedor de identidade será configurado.

KmsKeyState

Representa o estado de acessibilidade de uma chave do KMS gerenciada pelo cliente usada para integração da CMEK.

Tipos enumerados
KMS_KEY_STATE_UNSPECIFIED Não especificado.
KMS_KEY_STATE_KEY_AVAILABLE A chave está disponível para uso, e os recursos dependentes precisam estar acessíveis.
KMS_KEY_STATE_KEY_UNAVAILABLE A chave está indisponível por um motivo não especificado. Os recursos dependentes podem estar inacessíveis.

ListClustersRequest

Lista os clusters em um local.

Campos
parent

string

Obrigatório. O local pai, que tem essa coleção de clusters.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • edgecontainer.clusters.list
page_size

int32

O número máximo de recursos a serem listados.
page_token

string

Um token de página recebido de uma solicitação de lista anterior. Um token de página recebido de uma solicitação de lista anterior.
filter

string

Somente os recursos que corresponderem a esse filtro serão listados.
order_by

string

Especifica a ordem em que os recursos serão listados.

ListClustersResponse

Lista de clusters em um local.

Campos
clusters[]

Cluster

Clusters no local.
next_page_token

string

Token para recuperar a próxima página de resultados.
unreachable[]

string

Locais que não puderam ser alcançados.

ListMachinesRequest

Lista máquinas em um site.

Campos
parent

string

Obrigatório. O site principal, que é proprietário dessa coleção de máquinas.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • edgecontainer.machines.list
page_size

int32

O número máximo de recursos a serem listados.
page_token

string

Um token de página recebido de uma solicitação de lista anterior.
filter

string

Somente os recursos que corresponderem a esse filtro serão listados.
order_by

string

Especifica a ordem em que os recursos serão listados.

ListMachinesResponse

Lista de máquinas em um site.

Campos
machines[]

Machine

Máquinas no site.
next_page_token

string

Token para recuperar a próxima página de resultados.
unreachable[]

string

Locais que não puderam ser alcançados.

ListNodePoolsRequest

Lista os pools de nós em um cluster.

Campos
parent

string

Obrigatório. O cluster pai, que tem essa coleção de pools de nós.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • edgecontainer.nodePools.list
page_size

int32

O número máximo de recursos a serem listados.
page_token

string

Um token de página recebido de uma solicitação de lista anterior.
filter

string

Somente os recursos que corresponderem a esse filtro serão listados.
order_by

string

Especifica a ordem em que os recursos serão listados.

ListNodePoolsResponse

Lista de pools de nós em um cluster.

Campos
node_pools[]

NodePool

Pools de nós no cluster.
next_page_token

string

Token para recuperar a próxima página de resultados.
unreachable[]

string

Locais que não puderam ser alcançados.

ListVpnConnectionsRequest

Lista as conexões VPN.

Campos
parent

string

Obrigatório. O local pai, que tem essa coleção de conexões VPN.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • edgecontainer.vpnConnections.list
page_size

int32

O número máximo de recursos a serem listados.
page_token

string

Um token de página recebido de uma solicitação de lista anterior.
filter

string

Somente os recursos que corresponderem a esse filtro serão listados.
order_by

string

Especifica a ordem em que os recursos serão listados.

ListVpnConnectionsResponse

Lista de conexões VPN em um local.

Campos
vpn_connections[]

VpnConnection

VpnConnections no local.
next_page_token

string

Token para recuperar a próxima página de resultados.
unreachable[]

string

Locais que não puderam ser alcançados.

LocationMetadata

Metadados para um determinado google.cloud.location.Location.

Campos
available_zones

map<string, ZoneMetadata>

O conjunto de zonas do Google Distributed Cloud Edge disponíveis no local. O mapa é indexado pelo ID em letras minúsculas de cada zona.

Máquina

Uma máquina do Google Distributed Cloud Edge capaz de atuar como um nó do Kubernetes.

Campos
name

string

Obrigatório. O nome do recurso da máquina.
create_time

Timestamp

Apenas saída. A hora em que o pool de nós foi criado.
update_time

Timestamp

Apenas saída. A hora em que o pool de nós foi atualizado pela última vez.
labels

map<string, string>

Rótulos associados a este recurso.
hosted_node

string

Nome canônico do recurso do nó que esta máquina é responsável por hospedar, por exemplo, projects/{project}/locations/{location}/clusters/{cluster_id}/nodePools/{pool_id}/{node}, ou vazio se a máquina não estiver atribuída para assumir a função de um nó.

Para nós do plano de controle hospedados em máquinas de borda, isso vai retornar o seguinte formato: "projects/{project}/locations/{location}/clusters/{cluster_id}/controlPlaneNodes/{node}".
zone

string

A zona do Google Distributed Cloud Edge desta máquina.
version

string

Apenas saída. A versão do software da máquina.
disabled

bool

Apenas saída. Se a máquina está desativada. Se estiver desativada, a máquina não poderá entrar em serviço.
status

Status

Apenas saída. O status atual da máquina.
purpose

Purpose

O tipo de cluster em que a máquina é usada.

Finalidade

A finalidade da máquina pode ser VIRTUALIZED_WORKLOAD ou BAREMETAL_CLUSTER.

Tipos enumerados
PURPOSE_UNSPECIFIED Finalidade não especificada.
VIRTUALIZED_WORKLOAD A máquina é usada para carga de trabalho virtual.
BAREMETAL_CLUSTER A máquina é usada para um cluster de usuário bare metal.

Status

Indica o status da máquina.

Tipos enumerados
STATUS_UNSPECIFIED Status desconhecido.
READY A máquina está pronta para hospedar um nó. Esse é o padrão.
DISABLED_FOR_REPAIR A máquina foi desativada para reparo com a adição de uma ou mais reivindicações de desativação.

MaintenanceExclusionWindow

Representa uma janela de exclusão de manutenção.

Campos
window

TimeWindow

Opcional. O período.
id

string

Opcional. Um ID exclusivo (por cluster) para a janela.

MaintenancePolicy

Configuração da política de manutenção.

Campos
window

MaintenanceWindow

Especifica a janela de manutenção em que a manutenção pode ser realizada.
maintenance_exclusions[]

MaintenanceExclusionWindow

Opcional. Exclusões da manutenção automática. A manutenção não emergencial não deve ocorrer nessas janelas. Cada exclusão tem um nome exclusivo e pode estar ativa ou expirada. O número máximo de exclusões de manutenção permitidas em um determinado momento é 3.

MaintenanceWindow

Configuração da janela de manutenção

Campos
recurring_window

RecurringTimeWindow

Configuração de uma janela de manutenção recorrente.

NodePool

Um conjunto de nós do Kubernetes em um cluster com configuração e especificação comuns.

Campos
name

string

Obrigatório. O nome do recurso do pool de nós.
create_time

Timestamp

Apenas saída. A hora em que o pool de nós foi criado.
update_time

Timestamp

Apenas saída. A hora em que o pool de nós foi atualizado pela última vez.
labels

map<string, string>

Rótulos associados a este recurso.
node_location

string

Nome da zona do Google Distributed Cloud Edge em que o pool de nós será criado. Por exemplo, us-central1-edge-customer-a.
node_count

int32

Obrigatório. O número de nós no pool.
machine_filter

string

Somente as máquinas que correspondem a esse filtro podem participar do pool de nós. A linguagem de filtragem aceita strings como "name=" e está documentada com mais detalhes em AIP-160.
local_disk_encryption

LocalDiskEncryption

Opcional. Opções de criptografia de disco local. Esse campo só é usado ao ativar o suporte à CMEK.
node_version

string

Apenas saída. A versão de lançamento mais baixa entre todos os nós de trabalho.
node_config

NodeConfig

Opcional. Configuração de cada nó no NodePool

LocalDiskEncryption

Configuração para compatibilidade com CMEK para criptografia de disco local da máquina de borda.

Campos
kms_key

string

Opcional. A CryptoKey do Cloud KMS, por exemplo, projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}, a ser usada para proteger discos locais do nó. Se não for especificada, uma chave gerenciada pelo Google será usada.
kms_key_active_version

string

Apenas saída. A CryptoKeyVersion do Cloud KMS atualmente em uso para proteger discos locais do nó. Só é aplicável se kms_key estiver definido.
kms_key_state

KmsKeyState

Apenas saída. Disponibilidade da CryptoKey do Cloud KMS. Se não for KEY_AVAILABLE, os nós poderão ficar off-line porque não conseguem acessar os dados locais. Isso pode ser causado pela falta de permissões para usar a chave ou se ela estiver desativada ou excluída.
kms_status

Status

Apenas saída. Status de erro retornado pelo Cloud KMS ao usar essa chave. Esse campo só pode ser preenchido se kms_key_state não for KMS_KEY_STATE_KEY_AVAILABLE. Se preenchido, esse campo vai conter o status do erro informado pelo Cloud KMS.
resource_state

ResourceState

Apenas saída. O estado atual do recurso associado à CMEK.

NodeConfig

Configuração de cada nó no NodePool

Campos
labels

map<string, string>

Opcional. Os rótulos de nó do Kubernetes
node_storage_schema

string

Opcional. Nome do esquema de armazenamento dos nós de trabalho.

OIDCProviderConfig

Representa a configuração do provedor OIDC.

Campos
client_id

string

Obrigatório. O ID do cliente do provedor de identidade.
client_secret

string

Opcional. O chave secreta do cliente do provedor de identidade.
issuer_uri

string

Obrigatório. O URI do emissor do provedor de identidade.
scopes

string

Obrigatório. Os escopos do provedor de identidade.
user_claim

string

Opcional. A declaração do usuário do provedor de identidade.

OperationMetadata

Metadados de operações de longa duração para métodos da API Edge Container.

Campos
create_time

Timestamp

A hora em que a operação foi criada.
end_time

Timestamp

O horário em que a operação terminou de ser executada.
target

string

Caminho do recurso definido pelo servidor para o destino da operação.
verb

string

O verbo executado pela operação.
status_message

string

Status legível da operação, caso haja um.
requested_cancellation

bool

Identifica se o usuário solicitou o cancelamento da operação. As operações que foram canceladas com êxito têm o valor [Operation.error][] com um google.rpc.Status.code de 1, correspondente a Code.CANCELLED.
api_version

string

Versão da API usada para iniciar a operação.
warnings[]

string

Avisos que não bloqueiam a operação, mas ainda contêm informações relevantes para o usuário final.
status_reason

StatusReason

Status legível por máquina da operação, se houver.

StatusReason

Indica o motivo do status da operação.

Tipos enumerados
STATUS_REASON_UNSPECIFIED Motivo desconhecido.
UPGRADE_PAUSED O upgrade do cluster está pausado.

Cota

Representa a cota para recursos de contêiner de borda.

Campos
metric

string

Nome da métrica de cota.
limit

double

Limite de cota para essa métrica.
usage

double

Uso atual dessa métrica.

RecurringTimeWindow

Representa um período arbitrário que se repete.

Campos
window

TimeWindow

O período da primeira recorrência.
recurrence

string

Uma RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) para a recorrência dessa janela. Eles duram o período entre o horário de início e término.

ResourceState

Representa se o recurso está em estado de bloqueio ou pendente.

Tipos enumerados
RESOURCE_STATE_UNSPECIFIED Valor padrão.
RESOURCE_STATE_LOCK_DOWN O recurso está no estado "LOCK DOWN".
RESOURCE_STATE_LOCK_DOWN_PENDING O recurso está aguardando o bloqueio.

ServerConfig

Configuração do servidor para versões e canais de lançamento compatíveis.

Campos
channels

map<string, ChannelConfig>

Apenas saída. Mapeamento do canal de lançamento para a configuração do canal.
versions[]

Version

Apenas saída. Versões compatíveis, por exemplo: ["1.4.0", "1.5.0"].
default_version

string

Apenas saída. Versão padrão, por exemplo: "1.4.0".

ServiceAccount

Representa o recurso da conta de serviço.

Campos
name

string

Identificador. O nome canônico do recurso da conta de serviço do projeto. Por exemplo, projects/{project}/locations/{location}/serviceAccounts/{service_account}
zone

string

Obrigatório. O ID da zona em que a conta de serviço do projeto precisa ser criada.
key[]

ServiceAccountKey

Opcional. Chaves de conta de serviço.
create_time

Timestamp

Apenas saída. A hora em que a conta de serviço do projeto foi criada.
update_time

Timestamp

Apenas saída. A hora em que a conta de serviço do projeto foi atualizada pela última vez.
labels

map<string, string>

Opcional. Rótulos associados a este recurso.

Chave da conta de serviço

"ServiceAccountKey" contém os componentes principais de uma chave de conta de serviço.

Campos
algorithm

string

Obrigatório. O algoritmo da chave. No momento, somente chaves ES256 são aceitas.
id

string

Obrigatório. O ID da chave. Isso é usado para determinar qual chave verificar.
key

string

Obrigatório. A chave pública codificada em base64 para verificação.
expiry_time

Timestamp

Obrigatório. A data de validade da chave.
valid_start_time

Timestamp

Obrigatório. A data de início em que a chave se torna válida.

TimeWindow

Representa um período arbitrário.

Campos
start_time

Timestamp

O horário em que a janela começa.
end_time

Timestamp

O horário em que a janela termina. O horário de término precisa ser posterior ao horário de início.

UpdateClusterRequest

Atualiza um cluster.

Campos
update_mask

FieldMask

A máscara de campo é usada para especificar os campos a serem substituídos no recurso Cluster pela atualização. Os campos especificados em update_mask são relativos ao recurso, não à solicitação completa. Um campo será substituído se estiver na máscara. Se o usuário não fornecer uma máscara, todos os campos serão substituídos.
cluster

Cluster

O cluster atualizado.

A autorização requer a seguinte permissão do IAM no recurso especificado cluster:

  • edgecontainer.clusters.update
request_id

string

Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se request_id for fornecido.

UpdateNodePoolRequest

Atualiza um pool de nós.

Campos
update_mask

FieldMask

A máscara de campo é usada para especificar os campos a serem substituídos no recurso NodePool pela atualização. Os campos especificados em update_mask são relativos ao recurso, não à solicitação completa. Um campo será substituído se estiver na máscara. Se o usuário não fornecer uma máscara, todos os campos serão substituídos.
node_pool

NodePool

O pool de nós atualizado.

A autorização requer a seguinte permissão do IAM no recurso especificado nodePool:

  • edgecontainer.nodePools.update
request_id

string

Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se request_id for fornecido.

UpgradeClusterRequest

Faz upgrade de um cluster.

Campos
name

string

Obrigatório. O nome do recurso do cluster.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • edgecontainer.clusters.upgrade
target_version

string

Obrigatório. A versão para a qual o cluster será atualizado.
schedule

Schedule

A programação do upgrade.
request_id

string

Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se request_id for fornecido.

Programar

Representa a programação de quando o cluster será atualizado.

Tipos enumerados
SCHEDULE_UNSPECIFIED Não especificado. O padrão é fazer upgrade do cluster imediatamente, que é a única opção hoje.
IMMEDIATELY O cluster será atualizado imediatamente após receber a solicitação.

Versão

Versão de um cluster.

Campos
name

string

Apenas saída. Nome da versão, por exemplo: "1.4.0".

VpnConnection

Uma conexão VPN .

Campos
name

string

Obrigatório. O nome do recurso da conexão VPN
create_time

Timestamp

Apenas saída. A hora em que a conexão VPN foi criada.
update_time

Timestamp

Apenas saída. A hora em que a conexão VPN foi atualizada pela última vez.
labels

map<string, string>

Rótulos associados a este recurso.
nat_gateway_ip

string

IP do gateway NAT ou endereço IP WAN. Se um cliente tiver vários IPs NAT, ele precisará configurar o NAT para que apenas um IP externo seja mapeado para o cluster do Anthos do GMEC. Fica vazio se o NAT não for usado.
bgp_routing_mode
(deprecated)

BgpRoutingMode

Modo de roteamento dinâmico da rede VPC, regional ou global.
cluster

string

O nome canônico do cluster a ser conectado. Ele está no formato projects/{project}/locations/{location}/clusters/{cluster}.
vpc

string

O ID da rede VPC a ser conectada.
vpc_project

VpcProject

Opcional. Detalhes do projeto da rede VPC. Obrigatório se a VPC estiver em um projeto diferente do projeto do cluster.
enable_high_availability

bool

Indica se essa conexão VPN tem alta disponibilidade ativada no lado do cluster. Se ativada, ao criar uma conexão VPN, tentaremos usar dois IPs flutuantes do ANG.
router

string

Opcional. O nome do Cloud Router da conexão VPN.
details

Details

Apenas saída. Os detalhes da conexão criada.

BgpRoutingMode

Modo de roteamento.

Tipos enumerados
BGP_ROUTING_MODE_UNSPECIFIED Desconhecido.
REGIONAL Modo regional.
GLOBAL Modo global.

Detalhes

Os detalhes da conexão criada.

Campos
state

State

O estado desta conexão.
error

string

A mensagem de erro. Isso só é preenchido quando state=ERROR.
cloud_router

CloudRouter

As informações do Cloud Router.
cloud_vpns[]

CloudVpn

Cada conexão tem vários gateways do Cloud VPN.

CloudRouter

As informações do Cloud Router.

Campos
name

string

O nome do Cloud Router associado.

CloudVpn

As informações do Cloud VPN.

Campos
gateway

string

O nome do gateway do Cloud VPN criado.

Estado

O estado atual da conexão.

Tipos enumerados
STATE_UNSPECIFIED Desconhecido.
STATE_CONNECTED Conectado.
STATE_CONNECTING Ainda conectando.
STATE_ERROR Ocorreu um erro.

VpcProject

Detalhes do projeto da rede VPC.

Campos
project_id

string

O projeto da VPC a ser conectada. Se não for especificado, será o mesmo que o projeto do cluster.
service_account
(deprecated)

string

Opcional. Descontinuado: não use.

ZonalService

O serviço está ativado no projeto.

Campos
name

string

Identificador. O nome do recurso do serviço.
service_selector

ServiceSelector

Obrigatório. O serviço a ser ativado/desativado.
state

State

Apenas saída. O estado do serviço.
create_time

Timestamp

Apenas saída. O horário em que o serviço foi ativado.
update_time

Timestamp

Apenas saída. A hora em que o serviço foi atualizado pela última vez.
labels

map<string, string>

Opcional. Rótulos associados a este recurso.
Campo de união zone_or_cluster. A zona ou o cluster em que o serviço precisa ser ativado/desativado. zone_or_cluster pode ser apenas de um dos tipos a seguir:
zone

string

O ID da zona em que o serviço precisa ser ativado/desativado.
cluster

string

O nome totalmente qualificado do cluster em que o serviço precisa ser ativado/desativado.

ServiceSelector

Serviços que podem ser ativados/desativados.

Tipos enumerados
SERVICE_SELECTOR_UNSPECIFIED Não especificado.
ALLOYDB Serviço do AlloyDB, alloydb.googleapis.com.
VMM Serviço VMM, gdcvmmanager.googleapis.com.
BOOKSTORE Serviço de livraria, bookstore.googleapis.com.

Estado

O estado do serviço.

Tipos enumerados
STATE_UNSPECIFIED Não especificado.
STATE_ENABLED O serviço está ativado no projeto.
STATE_DISABLED O serviço está desativado no projeto.
STATE_ENABLING O serviço está sendo ativado no projeto.
STATE_DISABLING O serviço está sendo desativado no projeto.

ZoneMetadata

Uma zona do Google Distributed Cloud Edge onde as máquinas de borda estão localizadas.

Campos
quota[]

Quota

Cota para recursos nessa zona.
rack_types

map<string, RackType>

O mapa é indexado pelo nome do rack e tem o valor "RackType".
config_data

ConfigData

Dados de configuração da zona.

RackType

Tipo de rack.

Tipos enumerados
RACK_TYPE_UNSPECIFIED Tipo de rack não especificado. Um único rack também pertence a esse tipo.
BASE Tipo de rack básico, um par de dois racks Config-1 modificados que contêm switches de agregação.
EXPANSION Tipo de rack de expansão, também conhecido como racks independentes, adicionado pelos clientes sob demanda.