REST Resource: projects.locations.vmwareAdminClusters

Recurso: VmwareAdminCluster

Recurso que representa um cluster de administrador do VMware.

Representação JSON 
{
  "name": string,
  "description": string,
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "annotations": {
    string: string,
    ...
  },
  "state": enum (State),
  "endpoint": string,
  "reconciling": boolean,
  "localName": string,
  "bootstrapClusterMembership": string,
  "onPremVersion": string,
  "fleet": {
    object (Fleet)
  },
  "imageType": string,
  "vcenter": {
    object (VmwareAdminVCenterConfig)
  },
  "networkConfig": {
    object (VmwareAdminNetworkConfig)
  },
  "loadBalancer": {
    object (VmwareAdminLoadBalancerConfig)
  },
  "controlPlaneNode": {
    object (VmwareAdminControlPlaneNodeConfig)
  },
  "addonNode": {
    object (VmwareAdminAddonNodeConfig)
  },
  "antiAffinityGroups": {
    object (VmwareAAGConfig)
  },
  "autoRepairConfig": {
    object (VmwareAutoRepairConfig)
  },
  "status": {
    object (ResourceStatus)
  },
  "platformConfig": {
    object (VmwarePlatformConfig)
  },
  "preparedSecrets": {
    object (VmwareAdminPreparedSecretsConfig)
  },
  "authorization": {
    object (VmwareAdminAuthorizationConfig)
  },
  "validationCheck": {
    object (ValidationCheck)
  },
  "privateRegistryConfig": {
    object (VmwareAdminPrivateRegistryConfig)
  },
  "enableAdvancedCluster": boolean
}
Campos
name

string

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

string

Uma descrição legível deste cluster de administrador do VMware.
uid

string

Apenas saída. O identificador exclusivo do cluster de administrador do VMware.
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.
createTime

string (Timestamp format)

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

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "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 VMware foi atualizado pela última vez.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30";
annotations

map (key: string, value: string)

Anotações no cluster de administrador do VMware. 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" }.
state

enum (State)

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

string

Apenas saída. O nome DNS do servidor da API do cluster de administrador do VMware.
reconciling

boolean

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

string

Apenas saída. O nome do objeto do recurso personalizado OnPremAdminCluster do VMware. 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.
bootstrapClusterMembership

string

O cluster de inicialização a que este cluster de administrador do VMware pertence.
onPremVersion

string

A versão dos clusters do Anthos no VMware para o cluster de administrador.
fleet

object (Fleet)

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

string

O tipo de imagem do SO para o cluster de administrador do VMware.
vcenter

object (VmwareAdminVCenterConfig)

A configuração do VCenter do cluster de administrador do VMware.
networkConfig

object (VmwareAdminNetworkConfig)

A configuração de rede do cluster de administrador do VMware.
loadBalancer

object (VmwareAdminLoadBalancerConfig)

A configuração do balanceador de carga do cluster de administrador do VMware.
controlPlaneNode

object (VmwareAdminControlPlaneNodeConfig)

A configuração do nó do plano de controle do cluster de administrador do VMware.
addonNode

object (VmwareAdminAddonNodeConfig)

A configuração do nó de complemento do cluster de administrador do VMware.
antiAffinityGroups

object (VmwareAAGConfig)

A configuração do grupo antiafinidade do cluster de administrador do VMware.
autoRepairConfig

object (VmwareAutoRepairConfig)

A configuração de reparo automático do cluster de administrador do VMware.
status

object (ResourceStatus)

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

object (VmwarePlatformConfig)

A configuração da plataforma VMware.
preparedSecrets

object (VmwareAdminPreparedSecretsConfig)

Apenas saída. A configuração de secrets preparadas do cluster de administrador do VMware. Ela sempre precisa ser ativada pela API Central, em vez de permitir que os usuários a definam.
authorization

object (VmwareAdminAuthorizationConfig)

A configuração de autorização do cluster de administrador do VMware.
validationCheck

object (ValidationCheck)

Apenas saída. "ValidationCheck" representa o resultado do job de verificação de simulação.
privateRegistryConfig

object (VmwareAdminPrivateRegistryConfig)

Configuração para o registro.
enableAdvancedCluster

boolean

Ative o cluster avançado.

Estado

O estado do ciclo de vida do cluster de administrador do VMware.

Enums
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.

VmwareAdminVCenterConfig

VmwareAdminVCenterConfig contém a configuração do vCenter para o cluster de administrador do VMware.

Representação JSON 
{
  "resourcePool": string,
  "datastore": string,
  "datacenter": string,
  "cluster": string,
  "folder": string,
  "caCertData": string,
  "address": string,
  "dataDisk": string,
  "storagePolicyName": string
}
Campos
resourcePool

string

O nome do pool de recursos do vCenter do cluster de administrador.
datastore

string

O nome do armazenamento de dados do vCenter para o cluster de administrador.
datacenter

string

O nome do data center do vCenter para o cluster de administrador.
cluster

string

O nome do cluster do vCenter para o cluster de administrador.
folder

string

O nome da pasta do vCenter para o cluster de administrador.
caCertData

string

Contém a chave pública do certificado de CA do vCenter para verificação SSL.
address

string

O endereço IP do vCenter.
dataDisk

string

O nome do disco de máquina virtual (VMDK) para o cluster de administrador.
storagePolicyName

string

O nome da política de armazenamento do vCenter para o cluster de usuário.

VmwareAdminNetworkConfig

VmwareAdminNetworkConfig contém a configuração de rede para o cluster de administrador do VMware.

Representação JSON 
{
  "serviceAddressCidrBlocks": [
    string
  ],
  "podAddressCidrBlocks": [
    string
  ],
  "vcenterNetwork": string,
  "hostConfig": {
    object (VmwareHostConfig)
  },
  "haControlPlaneConfig": {
    object (VmwareAdminHAControlPlaneConfig)
  },

  // Union field ip_configuration can be only one of the following:
  "staticIpConfig": {
    object (VmwareStaticIpConfig)
  },
  "dhcpIpConfig": {
    object (VmwareDhcpIpConfig)
  }
  // End of list of possible types for union field ip_configuration.
}
Campos
serviceAddressCidrBlocks[]

string

Obrigatório. Todos os serviços do cluster recebem um endereço IPv4 RFC1918 desses intervalos. Só é possível usar um intervalo. 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. Só é possível usar um intervalo. Este campo não pode ser alterado após a criação.
vcenterNetwork

string

vcenterNetwork especifica o nome da rede do vCenter.
hostConfig

object (VmwareHostConfig)

Representa configurações de rede comuns, independente do endereço IP do host.
haControlPlaneConfig

object (VmwareAdminHAControlPlaneConfig)

Configuração para o plano de controle do cluster de administrador de alta disponibilidade.
Campo de união ip_configuration. O tipo de configuração de IP usado pelo cluster de administrador do VMware. ip_configuration pode ser apenas de um dos tipos a seguir:
staticIpConfig

object (VmwareStaticIpConfig)

Definições de configuração para uma configuração de IP estático.
dhcpIpConfig

object (VmwareDhcpIpConfig)

Configurações de uma configuração de IP do DHCP.

VmwareAdminHAControlPlaneConfig

Especifica a configuração do plano de controle de administrador de alta disponibilidade.

Representação JSON 
{
  "controlPlaneIpBlock": {
    object (VmwareIpBlock)
  }
}
Campos
controlPlaneIpBlock

object (VmwareIpBlock)

Endereços IP estáticos para os nós do plano de controle do administrador.

VmwareAdminLoadBalancerConfig

VmwareAdminLoadBalancerConfig contém a configuração do balanceador de carga para o cluster de administrador do VMware.

Representação JSON 
{
  "vipConfig": {
    object (VmwareAdminVipConfig)
  },

  // Union field load_balancer_configuration can be only one of the following:
  "f5Config": {
    object (VmwareAdminF5BigIpConfig)
  },
  "manualLbConfig": {
    object (VmwareAdminManualLbConfig)
  },
  "metalLbConfig": {
    object (VmwareAdminMetalLbConfig)
  },
  "seesawConfig": {
    object (VmwareAdminSeesawConfig)
  }
  // End of list of possible types for union field load_balancer_configuration.
}
Campos
vipConfig

object (VmwareAdminVipConfig)

Os VIPs usados pelo balanceador de carga.
Campo de união load_balancer_configuration. A configuração do balanceador de carga a ser usada no cluster de administrador do VMware. load_balancer_configuration pode ser apenas de um dos tipos a seguir:
f5Config

object (VmwareAdminF5BigIpConfig)

Configuração para balanceadores de carga tipados F5 Big IP.
manualLbConfig

object (VmwareAdminManualLbConfig)

Balanceadores de carga configurados manualmente.
metalLbConfig

object (VmwareAdminMetalLbConfig)

Balanceadores de carga MetalLB.
seesawConfig

object (VmwareAdminSeesawConfig)

Apenas saída. Configuração para balanceadores de carga tipados do Seesaw.

VmwareAdminVipConfig

VmwareAdminVipConfig para configurações de balanceador de carga do VMware.

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

string

O VIP que você reservou para a API Kubernetes do cluster de administrador.
addonsVip

string

O VIP para configurar o balanceador de carga para complementos.

VmwareAdminF5BigIpConfig

VmwareAdminF5BigIpConfig representa parâmetros de configuração para um balanceador de carga F5 BIG-IP.

Representação JSON 
{
  "address": string,
  "partition": string,
  "snatPool": string
}
Campos
address

string

O endereço IP do balanceador de carga.
partition

string

A partição preexistente a ser usada pelo balanceador de carga. Essa partição geralmente é criada para o cluster de administrador, por exemplo, "my-f5-admin-partition".
snatPool

string

O nome do pool. Necessário apenas se você estiver usando SNAT.

VmwareAdminManualLbConfig

Representação JSON 
{
  "ingressHttpNodePort": integer,
  "ingressHttpsNodePort": integer,
  "controlPlaneNodePort": integer,
  "konnectivityServerNodePort": integer,
  "addonsNodePort": integer
}
Campos
ingressHttpNodePort

integer

NodePort para o http do serviço de entrada. O serviço de entrada no cluster de administrador é implementado como um serviço do tipo NodePort (por exemplo, 32527).
ingressHttpsNodePort

integer

NodePort para HTTPS do serviço de entrada. O serviço de entrada no cluster de administrador é implementado como um serviço do tipo NodePort (por exemplo, 30139).
controlPlaneNodePort

integer

NodePort para o serviço do plano de controle. O servidor da API Kubernetes no cluster de administrador é implementado como um serviço do tipo NodePort (por exemplo, 30968).
konnectivityServerNodePort

integer

NodePort para o serviço de servidor konnectivity em execução como um sidecar em cada pod kube-apiserver (por exemplo, 30564).
addonsNodePort

integer

NodePort para o servidor de complementos no cluster de administrador.

VmwareAdminMetalLbConfig

VmwareAdminMetalLbConfig representa parâmetros de configuração para um balanceador de carga MetalLB. No momento, não é necessário fazer nenhuma configuração para clusters de administrador.

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

boolean

Se o MetalLB está ativado.

VmwareAdminSeesawConfig

VmwareSeesawConfig representa parâmetros de configuração para um balanceador de carga do Seesaw já existente.

IMPORTANTE: a API Anthos On-Prem não gera nem atualiza configurações do Seesaw. Ela apenas vincula uma configuração preexistente a um novo cluster de usuário.

IMPORTANTE: ao tentar criar um cluster de usuário com um balanceador de carga Seesaw preexistente, siga algumas etapas de preparação antes de chamar o método da API "vmwareClusters.create". Primeiro, crie o namespace do cluster de usuário usando kubectl. O namespace precisa usar a seguinte convenção de nomenclatura : -gke-onprem-mgmt ou -gke-onprem-mgmt, dependendo se você usou "VmwareCluster.local_name" para evitar colisões. Para mais contexto, consulte a documentação de "VmwareCluster.local_name". Depois de criar o namespace, crie um recurso secret usando kubectl. Esse secret vai conter cópias das suas credenciais do Seesaw. O Secret precisa ser chamado de "user-cluster-creds" e conter as credenciais SSH e de certificado do Seesaw. As credenciais precisam ser chaves com os seguintes nomes: "seesaw-ssh-private-key", "seesaw-ssh-public-key", "seesaw-ssh-ca-key", "seesaw-ssh-ca-cert".

Representação JSON 
{
  "group": string,
  "masterIp": string,
  "ipBlocks": [
    {
      object (VmwareIpBlock)
    }
  ],
  "enableHa": boolean,
  "vms": [
    string
  ],
  "stackdriverName": string
}
Campos
group

string

Em geral, o seguinte formato deve ser usado para o nome do grupo do Seesaw: seesaw-for-[clusterName].
masterIp

string

MasterIP é o IP anunciado pelo mestre do grupo do Seesaw.
ipBlocks[]

object (VmwareIpBlock)

Os blocos de IP a serem usados pelo balanceador de carga Seesaw
enableHa

boolean

Ative duas VMs de balanceador de carga para ter um balanceador de carga do Seesaw de alta disponibilidade.
vms[]

string

Nomes das VMs criadas para esse grupo do Seesaw.
stackdriverName

string

Nome a ser usado pelo Stackdriver.

VmwareAdminControlPlaneNodeConfig

VmwareAdminControlPlaneNodeConfig contém a configuração do nó do plano de controle para o cluster de administrador do VMware.

Representação JSON 
{
  "cpus": string,
  "memory": string,
  "replicas": string
}
Campos
cpus

string (int64 format)

O número de vCPUs para o nó de plano de controle do cluster de administrador.
memory

string (int64 format)

O número de mebibytes de memória para o nó do plano de controle do cluster de administrador.
replicas

string (int64 format)

O número de nós do plano de controle para este cluster de administrador do VMware. (padrão: 1 réplica).

VmwareAdminAddonNodeConfig

VmwareAdminAddonNodeConfig contém configurações de nós de complemento para o cluster de administrador do VMware.

Representação JSON 
{
  "autoResizeConfig": {
    object (VmwareAutoResizeConfig)
  }
}
Campos
autoResizeConfig

object (VmwareAutoResizeConfig)

A configuração VmwareAutoResizeConfig especifica a configuração de redimensionamento automático.

VmwarePlatformConfig

VmwarePlatformConfig representa a configuração da plataforma VMware.

Representação JSON 
{
  "requiredPlatformVersion": string,
  "platformVersion": string,
  "bundles": [
    {
      object (VmwareBundleConfig)
    }
  ],
  "status": {
    object (ResourceStatus)
  }
}
Campos
requiredPlatformVersion

string

Somente entrada. A versão da plataforma necessária, por exemplo, 1.13.1. Se a versão atual da plataforma for inferior à de destino, ela será atualizada para a versão de destino. Se a versão de destino não estiver instalada na plataforma (versões de pacote), baixe o pacote da versão de destino.
platformVersion

string

Apenas saída. A versão da plataforma, por exemplo, 1.13.2.
bundles[]

object (VmwareBundleConfig)

Apenas saída. A lista de pacotes instalados no cluster de administrador.
status

object (ResourceStatus)

Apenas saída. Status do recurso para a plataforma.

VmwareBundleConfig

VmwareBundleConfig representa a configuração do pacote.

Representação JSON 
{
  "version": string,
  "status": {
    object (ResourceStatus)
  }
}
Campos
version

string

A versão do pacote.
status

object (ResourceStatus)

Apenas saída. Status do recurso para o pacote.

VmwareAdminPreparedSecretsConfig

VmwareAdminPreparedSecretsConfig representa a configuração de secrets preparadas do cluster de administrador.

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

boolean

Se os secrets preparados estão ativados.

VmwareAdminAuthorizationConfig

VmwareAdminAuthorizationConfig representa a configuração para autorização de cluster de administrador.

Representação JSON 
{
  "viewerUsers": [
    {
      object (ClusterUser)
    }
  ]
}
Campos
viewerUsers[]

object (ClusterUser)

Para clusters de administrador do VMware, os usuários recebem a função de leitor de cluster.

VmwareAdminPrivateRegistryConfig

VmwareAdminPrivateRegistryConfig representa a configuração do registro do cluster de administrador.

Representação JSON 
{
  "address": string,
  "caCert": string
}
Campos
address

string

O endereço do registro.
caCert

string

Quando o ambiente de execução do contêiner extrai uma imagem do registro privado, o registro precisa comprovar a própria identidade com a apresentação de um certificado. O certificado do registro é assinado por uma autoridade certificadora (CA). O ambiente de execução do contêiner usa o certificado da CA para validar o certificado do registro.

Métodos

create

 Cria um cluster de administrador do VMware em um determinado projeto e local.

enroll

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

get

 Recebe detalhes de um único cluster de administrador do VMware.

list

 Lista os clusters de administrador do VMware em um determinado projeto e local.

patch

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