REST Resource: projects.locations.bareMetalAdminClusters

Recurso: BareMetalAdminCluster

Recurso que representa um cluster de administrador do 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 do Anthos em bare metal para o cluster de administrador 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 do Bare Metal.
reconciling

boolean

Apenas saída. Se definido, há mudanças em andamento no cluster de administrador do bare metal.
createTime

string (Timestamp format)

Apenas saída. A hora em que esse cluster de administrador do bare metal 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 de administrador do bare metal 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".
deleteTime

string (Timestamp format)

Apenas saída. O horário em que este cluster de administrador bare metal foi excluído. Se o recurso não for excluído, este campo precisa estar vazio.

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".
localName

string

Apenas saída. O nome do objeto do recurso personalizado do cluster bare metal. Esse campo é usado para oferecer suporte a nomes conflitantes ao registrar clusters atuais na API. Quando usado como parte do registro do cluster, esse campo será diferente do ID no nome do recurso. Para novos clusters, esse campo vai corresponder ao nome fornecido pelo usuário e ficará visível no último componente do nome do recurso. Ela não pode ser modificada.

Todos os usuários precisam usar esse nome para acessar o cluster com gkectl ou kubectl e esperar ver o nome local ao visualizar os registros do controlador do cluster de administrador.
etag

string

Esse checksum é calculado pelo servidor com base no valor de outros campos e pode ser enviado em solicitações de atualização e exclusão para garantir que o cliente tenha um valor atualizado antes de prosseguir. Permite que os clientes realizem leituras e modificações da gravação consistentes por meio do controle otimista de simultaneidade.
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 é limitado a 256 mil. A chave pode ter dois segmentos: prefixo (opcional) e nome (exigido), separados por uma barra (/). O prefixo precisa ser um subdomínio DNS. O nome deve ter 63 caracteres ou menos, começar e terminar com caracteres alfanuméricos, com traços (-), sublinhados (_), pontos (.) e caracteres alfanuméricos entre eles.

Um objeto com 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 controle.
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 de operações de cluster.
status

object (ResourceStatus)

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

object (BareMetalAdminMaintenanceConfig)

Configuração de manutenção.
maintenanceStatus

object (BareMetalAdminMaintenanceStatus)

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

object (ValidationCheck)

Apenas saída. "ValidationCheck" que representa o resultado da verificação de simulação.
nodeConfig

object (BareMetalAdminWorkloadNodeConfig)

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

object (BareMetalAdminProxyConfig)

Configuração de proxy.
securityConfig

object (BareMetalAdminSecurityConfig)

Configuração relacionada à segurança.
nodeAccessConfig

object (BareMetalAdminNodeAccessConfig)

Configurações relacionadas ao acesso ao nó.
osEnvironmentConfig

object (BareMetalAdminOsEnvironmentConfig)

Configurações relacionadas ao ambiente do SO.
binaryAuthorization

object (BinaryAuthorization)

Configurações relacionadas à autorização binária.

Estado

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

Tipos enumerados
STATE_UNSPECIFIED Não definido
PROVISIONING O estado PROVISIONING indica que o cluster está sendo criado.
RUNNING O estado RUNNING indica que o cluster foi criado e é totalmente utilizável.
RECONCILING O estado RECONCILING indica que o cluster está sendo atualizado. Ele continua disponível, mas com desempenho potencialmente reduzido.
STOPPING O estado STOPPING indica que o cluster está sendo excluído.
ERROR O estado ERROR indica que o cluster está em um estado corrompido e irrecuperável.
DEGRADED O estado DEGRADED indica que o cluster exige uma ação do usuário para restaurar a funcionalidade completa.

BareMetalAdminNetworkConfig

O 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 o uso de recursos avançados de rede do Anthos, como o balanceamento de carga em pacote com o BGP ou o gateway NAT de saída. A configuração de recursos avançados de rede define automaticamente essa flag.
multipleNetworkInterfacesConfig

object (BareMetalAdminMultipleNetworkInterfacesConfig)

Configuração para várias interfaces de rede.
Campo de união cluster_cidr_configuration. A configuração de CIDR a ser usada no cluster de administrador. cluster_cidr_configuration pode ser apenas de um dos tipos a seguir:
islandModeCidr

object (BareMetalAdminIslandModeCidrConfig)

Configuração para o CIDR do modo isolado.

BareMetalAdminIslandModeCidrConfig

O BareMetalAdminIslandModeCidrConfig especifica a configuração de CIDR do cluster ao executar no modo isolado.

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

string

Obrigatório. Todos os serviços do cluster recebem um endereço IPv4 RFC1918 desses intervalos. Este campo não pode ser alterado após a criação.
podAddressCidrBlocks[]

string

Obrigatório. Todos os pods no cluster recebem um endereço IPv4 RFC1918 desses intervalos. Este campo não pode ser alterado 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 você quer ativar várias interfaces de rede para seus pods.

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

BareMetalAdminControlPlaneConfig

O BareMetalAdminControlPlaneConfig especifica a configuração do plano de controle.

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

object (BareMetalAdminControlPlaneNodePoolConfig)

Obrigatório. Configura o pool de nós que executa o plano de controle. Se especificado, o NodePool correspondente será criado para o plano de controle do cluster. O NodePool terá o mesmo nome e namespace do cluster.
apiServerArgs[]

object (BareMetalAdminApiServerArgument)

Personaliza os argumentos padrão do servidor de API. Apenas um subconjunto de flags personalizadas é compatível. 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 pool de nós do plano de controle. Temos uma configuração de pool de nós específica do plano de controle para que possamos ser flexíveis quanto ao suporte a campos específicos do plano de controle no futuro.

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

object (BareMetalNodePoolConfig)

Obrigatório. A configuração genérica para um pool de nós que executa o plano de controle.

BareMetalAdminApiServerArgument

"BareMetalAdminApiServerArgument" representa um par nome->valor de argumento. Apenas um subconjunto de flags personalizadas é compatível. 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 como aparece na linha de comando do servidor de API. Remova os traços iniciais.
value

string

Obrigatório. O valor do argumento, conforme será transmitido para a linha de comando do servidor da API.

BareMetalAdminLoadBalancerConfig

O BareMetalAdminLoadBalancerConfig especifica a configuração do balanceador 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 VIPs usados pelo balanceador de carga.
portConfig

object (BareMetalAdminPortConfig)

Configura as portas que o balanceador de carga vai escutar.
Campo de união load_balancer_configuration. A configuração do balanceador de carga a ser usada no cluster de administrador. load_balancer_configuration pode ser apenas de um dos tipos a seguir:
manualLbConfig

object (BareMetalAdminManualLbConfig)

Balanceadores de carga configurados manualmente.
bgpLbConfig

object (BareMetalAdminBgpLbConfig)

Configuração para balanceadores de carga tipados do BGP.

BareMetalAdminVipConfig

BareMetalAdminVipConfig para configurações de balanceador de carga bare metal.

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

string

O VIP que você reservou 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 em que os balanceadores de carga hospedados no plano de controle vão ficar ouvindo.

BareMetalAdminManualLbConfig

"BareMetalAdminManualLbConfig" representa parâmetros de configuração para um balanceador de carga manual.

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

boolean

Indica se o balanceamento de carga manual está ativado.

BareMetalAdminBgpLbConfig

BareMetalAdminBgpLbConfig representa parâmetros de configuração para um balanceador de carga do protocolo de gateway de borda (BGP).

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

string (int64 format)

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

object (BareMetalAdminBgpPeerConfig)

Obrigatório. A lista de peers de BGP a que o cluster se conectará. Pelo menos um peering precisa ser configurado para cada nó do plano de controle.

Os nós do plano de controle se conectam a esses peers para anunciar o VIP do plano de controle. O balanceador de carga do Services também usa esses peers por padrão.

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

object (BareMetalAdminLoadBalancerAddressPool)

Obrigatório. "AddressPools" é uma lista de pools de IP não sobrepostos usados por serviços tipados de balanceador de carga. Todos os endereços precisam ser roteáveis para os nós do balanceador de carga. O IngressVIP precisa ser incluído nos pools.
loadBalancerNodePoolConfig

object (BareMetalAdminLoadBalancerNodePoolConfig)

Especifica o pool de nós que executa o balanceamento de carga do plano de dados. É necessária conectividade L2 entre os nós desse pool. Se estiver faltando, o pool de nós do plano de controle será usado para o balanceamento de carga do plano de dados.

BareMetalAdminBgpPeerConfig

"BareMetalAdminBgpPeerConfig" representa parâmetros de configuração para um peer do Border Gateway Protocol (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 peering externo.
ipAddress

string

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

string

O endereço IP do nó do plano de controle que se conecta ao peering externo. Se você não especificar nenhum nó do plano de controle, todos os nós do plano de controle poderão se conectar ao peering externo. Se você especificar um ou mais endereços IP, apenas os nós especificados participarão das sessões de peering.

BareMetalAdminLoadBalancerAddressPool

Representa um pool de IP usado pelo balanceador de carga.

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

string

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

string

Obrigatório. Os endereços que fazem parte desse pool. Cada endereço precisa estar no formato CIDR (1.2.3.0/24) ou de intervalo (1.2.3.1-1.2.3.5).
avoidBuggyIps

boolean

Se for verdadeiro, evite usar IPs que terminam em .0 ou .255. Isso evita que dispositivos de consumo com bugs descartem por engano o tráfego IPv4 para esses endereços IP especiais.
manualAssign

boolean

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

BareMetalAdminLoadBalancerNodePoolConfig

Especifica a configuração do pool de nós do balanceador de carga.

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

object (BareMetalNodePoolConfig)

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

BareMetalAdminStorageConfig

O 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 de PersistentVolumes locais com backup em subdiretórios em um sistema de arquivos compartilhado. Esses subdiretórios são criados automaticamente durante a criação do cluster.
lvpNodeMountsConfig

object (BareMetalLvpConfig)

Obrigatório. Especifica a configuração dos PersistentVolumes locais apoiados por discos de nós montados. Esses discos precisam ser formatados e montados pelo usuário, o que pode ser feito antes ou depois da criação do cluster.

BareMetalAdminClusterOperationsConfig

O BareMetalAdminClusterOperationsConfig especifica a infraestrutura de observabilidade do cluster de administrador.

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

boolean

Se a coleta de registros/métricas de aplicativos deve ser ativada (além de registros/métricas do sistema).

BareMetalAdminMaintenanceConfig

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

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

string

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

BareMetalAdminMaintenanceStatus

"BareMetalAdminMaintenanceStatus" representa o status 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 status de drenagem e dos nós de máquina drenados. Isso é usado para mostrar o progresso do upgrade do cluster.

BareMetalAdminMachineDrainStatus

"BareMetalAdminMachineDrainStatus" representa o status das máquinas de nó bare metal que estão passando por operações de drenagem.

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

object (BareMetalAdminDrainingMachine)

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

object (BareMetalAdminDrainedMachine)

A lista de máquinas esgotadas.

BareMetalAdminDrainingMachine

"BareMetalAdminDrainingMachine" representa as máquinas que estão sendo esvaziadas no momento.

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

string

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

integer

A contagem de pods ainda não drenados.

BareMetalAdminDrainedMachine

"BareMetalAdminDrainedMachine" representa as máquinas que foram esgotadas.

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

string

Endereço IP da máquina esgotada.

BareMetalAdminWorkloadNodeConfig

O 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ó será derivado desse parâmetro. Por padrão, 110 pods são criados por nó. O limite superior é 250 para clusters de administrador HA e não HA. O limite inferior é 64 para clusters de administrador que não são de alta disponibilidade e 32 para clusters de administrador de alta disponibilidade.

BareMetalAdminProxyConfig

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

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

string

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

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

string

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

BareMetalAdminSecurityConfig

Especifica as configurações relacionadas à segurança do cluster de administrador bare metal.

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

object (Authorization)

Configura o acesso do usuário ao cluster de administrador.

BareMetalAdminNodeAccessConfig

Especifica as configurações relacionadas ao acesso de nós para o cluster de administrador em bare metal.

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

string

Obrigatório. LoginUser é o nome de usuário usado para acessar máquinas de nós. Se não for definido, o padrão será "root".

BareMetalAdminOsEnvironmentConfig

Especifica as configurações de operação do sistema operacional para o provisionamento de clusters.

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

boolean

Se o repositório de pacotes deve ser adicionado ao inicializar máquinas bare metal.

Métodos

create

 Cria um novo cluster de administrador bare metal em determinado projeto e local.

enroll

 Registra um cluster de administrador bare metal na API Anthos On-Prem em um determinado projeto e local.

get

 Recebe detalhes de um único cluster de administrador do bare metal.

list

 Lista os clusters de administrador bare metal em um determinado projeto e local.

patch

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

queryVersionConfig

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