REST Resource: projects.locations.clusters

Recurso: cluster

Um cluster do Kubernetes do Google Distributed Cloud Edge.

Representação JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "fleet": {
    object (Fleet)
  },
  "networking": {
    object (ClusterNetworking)
  },
  "authorization": {
    object (Authorization)
  },
  "defaultMaxPodsPerNode": integer,
  "endpoint": string,
  "port": integer,
  "clusterCaCertificate": string,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "controlPlaneVersion": string,
  "nodeVersion": string,
  "controlPlane": {
    object (ControlPlane)
  },
  "systemAddonsConfig": {
    object (SystemAddonsConfig)
  },
  "externalLoadBalancerIpv4AddressPools": [
    string
  ],
  "controlPlaneEncryption": {
    object (ControlPlaneEncryption)
  },
  "status": enum (Status),
  "maintenanceEvents": [
    {
      object (MaintenanceEvent)
    }
  ],
  "targetVersion": string,
  "releaseChannel": enum (ReleaseChannel),
  "survivabilityConfig": {
    object (SurvivabilityConfig)
  },
  "externalLoadBalancerIpv6AddressPools": [
    string
  ],
  "connectionState": {
    object (ConnectionState)
  },
  "externalLoadBalancerAddressPools": [
    {
      object (ExternalLoadBalancerPool)
    }
  ],
  "zoneStorageEncryption": {
    object (ZoneStorageEncryption)
  }
}
Campos
name

string

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

string (Timestamp format)

Apenas saída. A hora em que o cluster foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Rótulos associados a este recurso.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
fleet

object (Fleet)

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

object (ClusterNetworking)

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

object (Authorization)

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

integer

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 de API Kubernetes.
port

integer

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

string

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

object (MaintenancePolicy)

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

string

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

string

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

object (ControlPlane)

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

object (SystemAddonsConfig)

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

string

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

object (ControlPlaneEncryption)

Opcional. Opções de criptografia de disco do plano de controle remoto. Este campo é usado apenas ao ativar o suporte a CMEK.
status

enum (Status)

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

object (MaintenanceEvent)

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

string

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

enum (ReleaseChannel)

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

object (SurvivabilityConfig)

Opcional. Configuração da capacidade de sobrevivência do cluster, por exemplo, para o caso de perda de conectividade de rede. Observação: isso se aplica apenas a clusters de plano de controle local.
externalLoadBalancerIpv6AddressPools[]

string

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

object (ConnectionState)

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

object (ExternalLoadBalancerPool)

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

object (ZoneStorageEncryption)

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

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.

Representação JSON 
{
  "project": string,
  "membership": string
}
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>.

ClusterNetworking

Configuração de rede em todo o cluster.

Representação JSON 
{
  "clusterIpv4CidrBlocks": [
    string
  ],
  "servicesIpv4CidrBlocks": [
    string
  ]
}
Campos
clusterIpv4CidrBlocks[]

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.
servicesIpv4CidrBlocks[]

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.

Autorização

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

Representação JSON 
{
  "adminUsers": {
    object (ClusterUser)
  }
}
Campos
adminUsers

object (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.

ClusterUser

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

Representação JSON 
{
  "username": string
}
Campos
username

string

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

MaintenancePolicy

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

Representação JSON 
{
  "window": {
    object (MaintenanceWindow)
  },
  "maintenanceExclusions": [
    {
      object (MaintenanceExclusionWindow)
    }
  ]
}
Campos
window

object (MaintenanceWindow)

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

object (MaintenanceExclusionWindow)

Opcional. Exclusões da manutenção automática. A manutenção que não é de emergência 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

Representação JSON 
{
  "recurringWindow": {
    object (RecurringTimeWindow)
  }
}
Campos
recurringWindow

object (RecurringTimeWindow)

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

RecurringTimeWindow

Representa uma janela de tempo arbitrária que se repete.

Representação JSON 
{
  "window": {
    object (TimeWindow)
  },
  "recurrence": string
}
Campos
window

object (TimeWindow)

A janela 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 continuam pelo período entre o horário de início e de término.

TimeWindow

Representa uma janela de tempo arbitrária.

Representação JSON 
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

MaintenanceExclusionWindow

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

Representação JSON 
{
  "window": {
    object (TimeWindow)
  },
  "id": string
}
Campos
window

object (TimeWindow)

Opcional. A janela de tempo.
id

string

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

ControlPlane

Configuração do plano de controle do cluster.

Representação JSON 
{

  // Union field config can be only one of the following:
  "remote": {
    object (Remote)
  },
  "local": {
    object (Local)
  }
  // End of list of possible types for union field config.
}
Campos

Campo de união config.

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

object (Remote)

Configuração do plano de controle remoto.
local

object (Local)

Configuração do plano de controle local.

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

Remoto

Esse tipo não tem campos.

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

Local

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

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

Representação JSON 
{
  "nodeLocation": string,
  "nodeCount": integer,
  "machineFilter": string,
  "sharedDeploymentPolicy": enum (SharedDeploymentPolicy),
  "controlPlaneNodeStorageSchema": string
}
Campos
nodeLocation

string

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

integer

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

string

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

enum (SharedDeploymentPolicy)

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

string

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

Aviso: o recurso de esquema de armazenamento local de nó configurável é experimental e não é recomendado para uso geral em clusters/pools de nós de produção.

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.

SystemAddonsConfig

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

Representação JSON 
{
  "ingress": {
    object (Ingress)
  },
  "vmServiceConfig": {
    object (VMServiceConfig)
  }
}
Campos
ingress

object (Ingress)

Opcional. Configuração para Entrada.
vmServiceConfig

object (VMServiceConfig)

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

Entrada

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

Representação JSON 
{
  "disabled": boolean,
  "ipv4Vip": string
}
Campos
disabled

boolean

Opcional. Se a entrada está desativada.
ipv4Vip

string

Opcional. VIP de entrada.

VMServiceConfig

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

Representação JSON 
{
  "vmmEnabled": boolean
}
Campos
vmmEnabled

boolean

Opcional. Se o VMM está ativado.

ControlPlaneEncryption

Configuração para suporte à chave KMS gerenciada pelo cliente para nós do plano de controle.

Representação JSON 
{
  "kmsKey": string,
  "kmsKeyActiveVersion": string,
  "kmsKeyState": enum (KmsKeyState),
  "kmsStatus": {
    object (Status)
  },
  "resourceState": enum (ResourceState)
}
Campos
kmsKey

string

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

string

Apenas saída. A CryptoKeyVersion do Cloud KMS em uso para proteger os discos do plano de controle. Aplicável apenas se kmsKey estiver definido.
kmsKeyState

enum (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 por falta de permissões para usar a chave ou se ela estiver desativada ou excluída.
kmsStatus

object (Status)

Apenas saída. Status de erro retornado pelo Cloud KMS ao usar essa chave. Esse campo só poderá ser preenchido se kmsKeyState não for KMS_KEY_STATE_KEY_AVAILABLE. Se preenchido, esse campo contém o status de erro informado pelo Cloud KMS.
resourceState

enum (ResourceState)

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

Status

Indica o status do cluster.

Tipos enumerados
STATUS_UNSPECIFIED Status desconhecido.
PROVISIONING O cluster está sendo criado.
RUNNING O cluster foi criado e está 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.

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 orientados pelo Google ou iniciados pelo usuário, alterações de configuração de cluster iniciadas pelo usuário que exigem a reinicialização de nós etc.

Representação JSON 
{
  "uuid": string,
  "targetVersion": string,
  "operation": string,
  "type": enum (Type),
  "schedule": enum (Schedule),
  "state": enum (State),
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "updateTime": string
}
Campos
uuid

string

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

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

enum (Type)

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

enum (Schedule)

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

enum (State)

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

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Apenas saída. O horário em que o evento de manutenção terminou, seja com sucesso ou não. Se o evento de manutenção for dividido em várias janelas de manutenção, endTime só será atualizado quando todo o fluxo terminar.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

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.

Programação

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 ficar inutilizável.
SUCCEEDED O evento de manutenção foi concluído.
FAILED O evento de manutenção falhou.

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 normal.
NONE Nenhum canal de lançamento.
REGULAR Canal de lançamento normal.

SurvivabilityConfig

Configuração da capacidade de sobrevivência do cluster, por exemplo, para o caso de perda de conectividade de rede.

Representação JSON 
{
  "offlineRebootTtl": string
}
Campos
offlineRebootTtl

string (Duration format)

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

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

ConnectionState

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

Representação JSON 
{
  "state": enum (State),
  "updateTime": string
}
Campos
state

enum (State)

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

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

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 No momento, este cluster está conectado ao Google.
CONNECTED_AND_SYNCING No momento, este cluster está conectado ao Google, mas pode ter se reconectado recentemente após uma desconexão. A sincronização ainda está em andamento.

ExternalLoadBalancerPool

Pool de balanceadores de carga externos com configuração personalizada, como nome, atribuição manual/automática, IPv4 não sobreposto e intervalo de endereços IPv6 opcional.

Representação JSON 
{
  "addressPool": string,
  "ipv4Range": [
    string
  ],
  "ipv6Range": [
    string
  ],
  "avoidBuggyIps": boolean,
  "manualAssign": boolean
}
Campos
addressPool

string

Opcional. Nome do pool do balanceador de carga externo.
ipv4Range[]

string

Obrigatório. Intervalo de endereços IPv4 não sobrepostos do pool do balanceador de carga externo.
ipv6Range[]

string

Opcional. Intervalo de endereços IPv6 não sobrepostos do pool do balanceador de carga externo.
avoidBuggyIps

boolean

Opcional. Se for verdadeiro, o pool vai omitir os 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 é falso.
manualAssign

boolean

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

ZoneStorageEncryption

Configuração para suporte à CMEK do Zone Storage

Representação JSON 
{
  "kmsKey": string,
  "kmsKeyActiveVersion": string,
  "resourceState": enum (ResourceState)
}
Campos
kmsKey

string

Opcional. A chave do Cloud KMS
kmsKeyActiveVersion

string

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

enum (ResourceState)

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

Métodos

create

 Cria um novo cluster em um determinado projeto e local.

delete

 Exclui um único cluster.

generateAccessToken

 Gera um token de acesso para um cluster.

generateOfflineCredential

 Gera uma credencial off-line para um cluster.

get

 Recebe detalhes de um único cluster.

list

 Lista os clusters em determinado projeto e local.

patch

 Atualiza os parâmetros de um único cluster.

upgrade

 Faz upgrade de um único cluster.