REST Resource: projects.locations.bareMetalAdminClusters

Recurso: BareMetalAdminCluster

Recurso que representa um cluster de administrador bare metal.

Representação JSON 
{
  "name": string,
  "description": string,
  "uid": string,
  "bareMetalVersion": string,
  "state": enum (State),
  "endpoint": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "localName": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "networkConfig": {
    object (BareMetalAdminNetworkConfig)
  },
  "controlPlane": {
    object (BareMetalAdminControlPlaneConfig)
  },
  "loadBalancer": {
    object (BareMetalAdminLoadBalancerConfig)
  },
  "storage": {
    object (BareMetalAdminStorageConfig)
  },
  "fleet": {
    object (Fleet)
  },
  "clusterOperations": {
    object (BareMetalAdminClusterOperationsConfig)
  },
  "status": {
    object (ResourceStatus)
  },
  "maintenanceConfig": {
    object (BareMetalAdminMaintenanceConfig)
  },
  "maintenanceStatus": {
    object (BareMetalAdminMaintenanceStatus)
  },
  "validationCheck": {
    object (ValidationCheck)
  },
  "nodeConfig": {
    object (BareMetalAdminWorkloadNodeConfig)
  },
  "proxy": {
    object (BareMetalAdminProxyConfig)
  },
  "securityConfig": {
    object (BareMetalAdminSecurityConfig)
  },
  "nodeAccessConfig": {
    object (BareMetalAdminNodeAccessConfig)
  },
  "osEnvironmentConfig": {
    object (BareMetalAdminOsEnvironmentConfig)
  },
  "binaryAuthorization": {
    object (BinaryAuthorization)
  }
}
Campos
name

string

Imutável. O nome do recurso do cluster de administrador bare metal.
description

string

Uma descrição legível deste cluster de administrador bare metal.
uid

string

Apenas saída. O identificador exclusivo do cluster de administrador bare metal.
bareMetalVersion

string

A versão dos clusters de Anthos em bare metal para o cluster de administrador de bare metal.
state

enum (State)

Apenas saída. O estado atual do cluster de administrador bare metal.
endpoint

string

Apenas saída. O nome do endereço IP do servidor da API do cluster de administrador bare metal.
reconciling

boolean

Apenas saída. Se estiver definido, existem atualmente alterações em curso no cluster de administrador bare metal.
createTime

string (Timestamp format)

Apenas saída. A hora em que este cluster de administrador bare metal foi criado.

Usa RFC 3339, onde o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 este cluster de administrador bare metal foi atualizado pela última vez.

Usa RFC 3339, onde o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
deleteTime

string (Timestamp format)

Apenas saída. A hora em que este cluster de administrador bare metal foi eliminado. Se o recurso não for eliminado, este campo tem de estar vazio

Usa RFC 3339, onde o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
localName

string

Apenas saída. O nome do objeto do recurso personalizado do cluster bare metal. Este campo é usado para suportar nomes em conflito quando inscreve clusters existentes na API. Quando usado como parte da inscrição no cluster, este campo difere do ID no nome do recurso. Para novos clusters, este campo vai corresponder ao nome do cluster fornecido pelo utilizador e vai estar visível no último componente do nome do recurso. Não é modificável.

Todos os utilizadores devem usar este nome para aceder ao respetivo cluster através de gkectl ou kubectl e devem esperar ver o nome local quando visualizam os registos do controlador do cluster de administrador.
etag

string

Esta soma de verificação é calculada pelo servidor com base no valor de outros campos e pode ser enviada em pedidos de atualização e eliminação para garantir que o cliente tem um valor atualizado antes de continuar. Permite que os clientes façam leituras-modificações-escritas consistentes através do controlo de concorrência otimista.
annotations

map (key: string, value: string)

Anotações no cluster de administrador bare metal. Este campo tem as mesmas restrições que as anotações do Kubernetes. O tamanho total de todas as chaves e valores combinados está limitado a 256 KB. A chave pode ter 2 segmentos: prefixo (opcional) e nome (obrigatório), separados por uma barra (/). O prefixo tem de ser um subdomínio DNS. O nome tem de ter 63 carateres ou menos, começar e terminar com carateres alfanuméricos, com traços (-), sublinhados (_), pontos (.) e carateres alfanuméricos entre eles.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
networkConfig

object (BareMetalAdminNetworkConfig)

Configuração de rede.
controlPlane

object (BareMetalAdminControlPlaneConfig)

Configuração do plano de controlo.
loadBalancer

object (BareMetalAdminLoadBalancerConfig)

Configuração do balanceador de carga.
storage

object (BareMetalAdminStorageConfig)

Configuração de armazenamento.
fleet

object (Fleet)

Apenas saída. Configuração da frota para o cluster.
clusterOperations

object (BareMetalAdminClusterOperationsConfig)

Configuração das operações de cluster.
status

object (ResourceStatus)

Apenas saída. ResourceStatus que representa o estado detalhado do cluster.
maintenanceConfig

object (BareMetalAdminMaintenanceConfig)

Configuração de manutenção.
maintenanceStatus

object (BareMetalAdminMaintenanceStatus)

Apenas saída. MaintenanceStatus que representa o estado de manutenção.
validationCheck

object (ValidationCheck)

Apenas saída. ValidationCheck que representa o resultado da verificação prévia.
nodeConfig

object (BareMetalAdminWorkloadNodeConfig)

Configuração do nó de carga de trabalho.
proxy

object (BareMetalAdminProxyConfig)

Configuração do proxy.
securityConfig

object (BareMetalAdminSecurityConfig)

Configuração relacionada com a segurança.
nodeAccessConfig

object (BareMetalAdminNodeAccessConfig)

Configurações relacionadas com o acesso aos nós.
osEnvironmentConfig

object (BareMetalAdminOsEnvironmentConfig)

Configurações relacionadas com o ambiente do SO.
binaryAuthorization

object (BinaryAuthorization)

Configurações relacionadas com a Autorização binária.

Estado

O estado do ciclo de vida do cluster de administrador bare metal.

Enumerações
STATE_UNSPECIFIED Não definido.
PROVISIONING O estado PROVISIONING indica que o cluster está a ser criado.
RUNNING O estado RUNNING indica que o cluster foi criado e está totalmente utilizável.
RECONCILING O estado RECONCILING indica que o cluster está a ser atualizado. Continua disponível, mas potencialmente com um desempenho inferior.
STOPPING O estado STOPPING indica que o cluster está a ser eliminado.
ERROR O estado ERROR indica que o cluster está num estado danificado irrecuperável.
DEGRADED O estado DEGRADED indica que o cluster requer a ação do utilizador para restaurar a funcionalidade completa.

BareMetalAdminNetworkConfig

BareMetalAdminNetworkConfig especifica a configuração de rede do cluster.

Representação JSON 
{
  "advancedNetworking": boolean,
  "multipleNetworkInterfacesConfig": {
    object (BareMetalAdminMultipleNetworkInterfacesConfig)
  },

  // Union field cluster_cidr_configuration can be only one of the following:
  "islandModeCidr": {
    object (BareMetalAdminIslandModeCidrConfig)
  }
  // End of list of possible types for union field cluster_cidr_configuration.
}
Campos
advancedNetworking

boolean

Permite a utilização de funcionalidades de rede avançadas do Anthos, como o equilíbrio de carga agrupado com BGP ou o gateway NAT de saída. A configuração das definições para funcionalidades de rede avançadas define automaticamente esta flag.
multipleNetworkInterfacesConfig

object (BareMetalAdminMultipleNetworkInterfacesConfig)

Configuração para várias interfaces de rede.
Campo de união cluster_cidr_configuration. A configuração CIDR a usar no cluster de administrador. cluster_cidr_configuration só pode ser uma das seguintes opções:
islandModeCidr

object (BareMetalAdminIslandModeCidrConfig)

Configuração do CIDR do modo isolado.

BareMetalAdminIslandModeCidrConfig

BareMetalAdminIslandModeCidrConfig especifica a configuração CIDR do cluster durante a execução no modo isolado.

Representação JSON 
{
  "serviceAddressCidrBlocks": [
    string
  ],
  "podAddressCidrBlocks": [
    string
  ]
}
Campos
serviceAddressCidrBlocks[]

string

Obrigatório. Todos os serviços no cluster têm um endereço IPv4 RFC1918 atribuído a partir destes intervalos. Não é possível alterar este campo após a criação.
podAddressCidrBlocks[]

string

Obrigatório. Todos os pods no cluster têm um endereço IPv4 RFC1918 atribuído a partir destes intervalos. Não é possível alterar este campo após a criação.

BareMetalAdminMultipleNetworkInterfacesConfig

Especifica a configuração do cluster de várias interfaces de rede.

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

boolean

Se deve ativar várias interfaces de rede para os seus pods.

Quando é definido, networkConfig.advanced_networking é automaticamente definido como verdadeiro.

BareMetalAdminControlPlaneConfig

BareMetalAdminControlPlaneConfig especifica a configuração do plano de controlo.

Representação JSON 
{
  "controlPlaneNodePoolConfig": {
    object (BareMetalAdminControlPlaneNodePoolConfig)
  },
  "apiServerArgs": [
    {
      object (BareMetalAdminApiServerArgument)
    }
  ]
}
Campos
controlPlaneNodePoolConfig

object (BareMetalAdminControlPlaneNodePoolConfig)

Obrigatório. Configura o node pool que executa o plano de controlo. Se especificado, o NodePool correspondente é criado para o plano de controlo do cluster. O NodePool tem o mesmo nome e espaço de nomes que o cluster.
apiServerArgs[]

object (BareMetalAdminApiServerArgument)

Personaliza os argumentos do servidor da API predefinidos. Apenas é suportado um subconjunto de flags personalizadas. Consulte a documentação do servidor da API abaixo para saber o formato exato: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/

BareMetalAdminControlPlaneNodePoolConfig

BareMetalAdminControlPlaneNodePoolConfig especifica a configuração do node pool do plano de controlo. Temos uma configuração do conjunto de nós específica do plano de controlo para que possamos ser flexíveis quanto ao suporte de campos específicos do plano de controlo no futuro.

Representação JSON 
{
  "nodePoolConfig": {
    object (BareMetalNodePoolConfig)
  }
}
Campos
nodePoolConfig

object (BareMetalNodePoolConfig)

Obrigatório. A configuração genérica de um node pool que executa o plano de controlo.

BareMetalAdminApiServerArgument

BareMetalAdminApiServerArgument representa um par nome->valor de arg. Apenas é suportado um subconjunto de flags personalizadas. Consulte a documentação do servidor da API abaixo para saber o formato exato: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/

Representação JSON 
{
  "argument": string,
  "value": string
}
Campos
argument

string

Obrigatório. O nome do argumento tal como aparece na linha de comandos do servidor da API. Certifique-se de que remove os traços iniciais.
value

string

Obrigatório. O valor do argumento, tal como será transmitido à linha de comandos do servidor da API.

BareMetalAdminLoadBalancerConfig

BareMetalAdminLoadBalancerConfig especifica a configuração do equilibrador de carga.

Representação JSON 
{
  "vipConfig": {
    object (BareMetalAdminVipConfig)
  },
  "portConfig": {
    object (BareMetalAdminPortConfig)
  },

  // Union field load_balancer_configuration can be only one of the following:
  "manualLbConfig": {
    object (BareMetalAdminManualLbConfig)
  },
  "bgpLbConfig": {
    object (BareMetalAdminBgpLbConfig)
  }
  // End of list of possible types for union field load_balancer_configuration.
}
Campos
vipConfig

object (BareMetalAdminVipConfig)

Os IPs virtuais usados pelo balanceador de carga.
portConfig

object (BareMetalAdminPortConfig)

Configura as portas nas quais o balanceador de carga vai escutar.
Campo de união load_balancer_configuration. A configuração do balanceador de carga a usar no cluster de administrador. load_balancer_configuration só pode ser uma das seguintes opções:
manualLbConfig

object (BareMetalAdminManualLbConfig)

Balanceadores de carga configurados manualmente.
bgpLbConfig

object (BareMetalAdminBgpLbConfig)

Configuração para equilibradores de carga com tipo BGP.

BareMetalAdminVipConfig

BareMetalAdminVipConfig para configurações do equilibrador de carga bare metal.

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

string

O VIP que reservou anteriormente para a API Kubernetes deste cluster de administrador bare metal.

BareMetalAdminPortConfig

BareMetalAdminPortConfig é a especificação das portas do balanceador de carga.

Representação JSON 
{
  "controlPlaneLoadBalancerPort": integer
}
Campos
controlPlaneLoadBalancerPort

integer

A porta que os balanceadores de carga alojados no plano de controlo vão escutar.

BareMetalAdminManualLbConfig

BareMetalAdminManualLbConfig representa os parâmetros de configuração de um equilibrador de carga manual.

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

boolean

Se o balanceamento de carga manual está ativado.

BareMetalAdminBgpLbConfig

BareMetalAdminBgpLbConfig representa os parâmetros de configuração de um equilibrador de carga do Border Gateway Protocol (BGP).

Representação JSON 
{
  "asn": string,
  "bgpPeerConfigs": [
    {
      object (BareMetalAdminBgpPeerConfig)
    }
  ],
  "addressPools": [
    {
      object (BareMetalAdminLoadBalancerAddressPool)
    }
  ],
  "loadBalancerNodePoolConfig": {
    object (BareMetalAdminLoadBalancerNodePoolConfig)
  }
}
Campos
asn

string (int64 format)

Obrigatório. Número do sistema autónomo (ASN) do BGP do cluster. Este campo pode ser atualizado após a criação do cluster.
bgpPeerConfigs[]

object (BareMetalAdminBgpPeerConfig)

Obrigatório. A lista de pares BGP aos quais o cluster se vai ligar. Tem de configurar, pelo menos, um par para cada nó do plano de controlo.

Os nós do plano de controlo ligam-se a estes pares para anunciar o VIP do plano de controlo. O balanceador de carga dos serviços também usa estes pares por predefinição.

Este campo pode ser atualizado após a criação do cluster.
addressPools[]

object (BareMetalAdminLoadBalancerAddressPool)

Obrigatório. AddressPools é uma lista de intervalos de IPs não sobrepostos usados por serviços com tipos de balanceadores de carga. Todos os endereços têm de ser encaminháveis para os nós do equilibrador de carga. O IngressVIP tem de ser incluído nos pools.
loadBalancerNodePoolConfig

object (BareMetalAdminLoadBalancerNodePoolConfig)

Especifica o conjunto de nós que executa o equilíbrio de carga do plano de dados. É necessária conetividade L2 entre os nós neste conjunto. Se estiver em falta, o conjunto de nós do plano de controlo é usado para o equilíbrio de carga do plano de dados.

BareMetalAdminBgpPeerConfig

BareMetalAdminBgpPeerConfig representa os parâmetros de configuração de um ponto de troca do protocolo de gateway de fronteira (BGP).

Representação JSON 
{
  "asn": string,
  "ipAddress": string,
  "controlPlaneNodes": [
    string
  ]
}
Campos
asn

string (int64 format)

Obrigatório. Número do sistema autónomo (ASN) do BGP para a rede que contém o dispositivo de pares externo.
ipAddress

string

Obrigatório. O endereço IP do dispositivo externo de pares.
controlPlaneNodes[]

string

O endereço IP do nó do plano de controlo que se liga ao par externo. Se não especificar nós do plano de controlo, todos os nós do plano de controlo podem estabelecer ligação ao par externo. Se especificar um ou mais endereços IP, apenas os nós especificados participam em sessões de peering.

BareMetalAdminLoadBalancerAddressPool

Representa um conjunto de IPs usado pelo balanceador de carga.

Representação JSON 
{
  "pool": string,
  "addresses": [
    string
  ],
  "avoidBuggyIps": boolean,
  "manualAssign": boolean
}
Campos
pool

string

Obrigatório. O nome do conjunto de endereços.
addresses[]

string

Obrigatório. As moradas que fazem parte deste conjunto. Cada endereço tem de estar no formato CIDR (1.2.3.0/24) ou no formato de intervalo (1.2.3.1-1.2.3.5).
avoidBuggyIps

boolean

Se for verdade, evite usar IPs que terminem em .0 ou .255. Isto evita que os dispositivos de consumo com erros rejeitem por engano o tráfego IPv4 para esses endereços IP especiais.
manualAssign

boolean

Se for verdadeiro, impede que os endereços IP sejam atribuídos automaticamente.

BareMetalAdminLoadBalancerNodePoolConfig

Especifica a configuração do node pool do equilibrador de carga.

Representação JSON 
{
  "nodePoolConfig": {
    object (BareMetalNodePoolConfig)
  }
}
Campos
nodePoolConfig

object (BareMetalNodePoolConfig)

A configuração genérica de um conjunto de nós que executa um balanceador de carga.

BareMetalAdminStorageConfig

BareMetalAdminStorageConfig especifica a configuração de armazenamento do cluster.

Representação JSON 
{
  "lvpShareConfig": {
    object (BareMetalLvpShareConfig)
  },
  "lvpNodeMountsConfig": {
    object (BareMetalLvpConfig)
  }
}
Campos
lvpShareConfig

object (BareMetalLvpShareConfig)

Obrigatório. Especifica a configuração para PersistentVolumes locais suportados por subdiretórios num sistema de ficheiros partilhado. Estas subdiretorias são criadas automaticamente durante a criação do cluster.
lvpNodeMountsConfig

object (BareMetalLvpConfig)

Obrigatório. Especifica a configuração para PersistentVolumes locais suportados por discos de nós montados. Estes discos têm de ser formatados e montados pelo utilizador, o que pode ser feito antes ou depois da criação do cluster.

BareMetalAdminClusterOperationsConfig

BareMetalAdminClusterOperationsConfig especifica a infraestrutura de observabilidade do cluster de administrador.

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

boolean

Se a recolha de registos/métricas da aplicação deve ser ativada (além dos registos/métricas do sistema).

BareMetalAdminMaintenanceConfig

BareMetalAdminMaintenanceConfig especifica configurações para colocar os nós CRs do cluster de administrador de metal em modo de manutenção e fora do mesmo.

Representação JSON 
{
  "maintenanceAddressCidrBlocks": [
    string
  ]
}
Campos
maintenanceAddressCidrBlocks[]

string

Obrigatório. Todos os endereços IPv4 destes intervalos vão ser colocados em modo de manutenção. Os nós no modo de manutenção são isolados e esvaziados. Quando ambas as condições são verdadeiras, a anotação "baremetal.cluster.gke.io/maintenance" é definida no recurso do nó.

BareMetalAdminMaintenanceStatus

BareMetalAdminMaintenanceStatus representa o estado de manutenção dos nós do CR do cluster de administrador bare metal.

Representação JSON 
{
  "machineDrainStatus": {
    object (BareMetalAdminMachineDrainStatus)
  }
}
Campos
machineDrainStatus

object (BareMetalAdminMachineDrainStatus)

Representa o estado dos nós da máquina de esgotamento e esgotados. Isto é usado para mostrar o progresso da atualização do cluster.

BareMetalAdminMachineDrainStatus

BareMetalAdminMachineDrainStatus representa o estado das máquinas de nós de metal descoberto que estão a ser submetidas a operações de drenagem.

Representação JSON 
{
  "drainingMachines": [
    {
      object (BareMetalAdminDrainingMachine)
    }
  ],
  "drainedMachines": [
    {
      object (BareMetalAdminDrainedMachine)
    }
  ]
}
Campos
drainingMachines[]

object (BareMetalAdminDrainingMachine)

A lista de máquinas com drenagem.
drainedMachines[]

object (BareMetalAdminDrainedMachine)

A lista de máquinas com bateria descarregada.

BareMetalAdminDrainingMachine

BareMetalAdminDrainingMachine representa as máquinas que estão atualmente a ser esvaziadas.

Representação JSON 
{
  "nodeIp": string,
  "podCount": integer
}
Campos
nodeIp

string

Endereço IP da máquina de drenagem.
podCount

integer

A contagem de pods que ainda não foram esvaziados.

BareMetalAdminDrainedMachine

BareMetalAdminDrainedMachine representa as máquinas que foram esgotadas.

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

string

Endereço IP da máquina esgotado.

BareMetalAdminWorkloadNodeConfig

BareMetalAdminWorkloadNodeConfig especifica as configurações do nó de carga de trabalho.

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

string (int64 format)

O número máximo de pods que um nó pode executar. O tamanho do intervalo CIDR atribuído ao nó é derivado deste parâmetro. Por predefinição, são criados 110 agrupamentos por nó. O limite superior é de 250 para o cluster de administrador de HA e não HA. O limite inferior é 64 para o cluster de administrador não HA e 32 para o cluster de administrador HA.

BareMetalAdminProxyConfig

BareMetalAdminProxyConfig especifica a configuração do proxy do cluster.

Representação JSON 
{
  "uri": string,
  "noProxy": [
    string
  ]
}
Campos
uri

string

Obrigatório. Especifica o endereço do seu servidor proxy. Exemplos: http://domain

AVISO: não faculte credenciais no formato http://(username:password@)domain. Estas serão rejeitadas pelo servidor.
noProxy[]

string

Uma lista de IPs, nomes de anfitriões e domínios que devem ignorar o proxy. Exemplos: ["127.0.0.1", "example.com", ".corp", "localhost"].

BareMetalAdminSecurityConfig

Especifica as definições relacionadas com a segurança para o cluster de administrador bare metal.

Representação JSON 
{
  "authorization": {
    object (Authorization)
  }
}
Campos
authorization

object (Authorization)

Configura o acesso do utilizador ao cluster de administração.

BareMetalAdminNodeAccessConfig

Especifica as definições relacionadas com o acesso ao nó para o cluster de administrador bare metal.

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

string

Obrigatório. LoginUser é o nome de utilizador usado para aceder a máquinas de nós. A predefinição é "root" em caso de não definição.

BareMetalAdminOsEnvironmentConfig

Especifica as definições de funcionamento do sistema operativo para o aprovisionamento de clusters.

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

boolean

Se o repositório de pacotes deve ser adicionado ao inicializar máquinas sem sistema operativo.

Métodos

create

 Cria um novo cluster de administrador bare metal num determinado projeto e localização.

enroll

 Regista um cluster de administrador bare metal existente na API Anthos On-Prem num determinado projeto e localização.

get

 Obtém detalhes de um único cluster de administrador bare metal.

list

 Lista os clusters de administrador bare metal num determinado projeto e localização.

patch

 Atualiza os parâmetros de um único cluster de administrador bare metal.

queryVersionConfig

 Consulta a configuração da versão do cluster de administrador de bare metal.