REST Resource: projects.locations.bareMetalAdminClusters

Recurso: BareMetalAdminCluster

Es un recurso que representa un clúster de administrador de Bare Metal.

Representación 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

Inmutable. Es el nombre del recurso del clúster de administrador de Bare Metal.

description

string

Una descripción legible por humanos de este clúster de administrador de Bare Metal.

uid

string

Solo salida. Es el identificador único del clúster de administrador de Bare Metal.

bareMetalVersion

string

La versión de los clústeres de Anthos en Bare Metal para el clúster de administrador de Bare Metal

state

enum (State)

Solo salida. El estado actual del clúster de administrador de Bare Metal.

endpoint

string

Solo salida. El nombre de la dirección IP del servidor de la API del clúster de administrador de Bare Metal

reconciling

boolean

Solo salida. Si se configura, actualmente hay cambios en tránsito en el clúster de administrador de Bare Metal.

createTime

string (Timestamp format)

Solo salida. La hora en la que se creó este clúster de administrador de Bare Metal.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Por ejemplo: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Solo salida. La hora en la que se actualizó este clúster de administrador de Bare Metal por última vez.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Por ejemplo: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

deleteTime

string (Timestamp format)

Solo salida. La hora en la que se borró este clúster de administrador de Bare Metal. Si el recurso no se borra, debe estar vacío.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Por ejemplo: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

localName

string

Solo salida. Es el nombre del objeto del recurso personalizado del clúster de Bare Metal. Este campo se usa para admitir nombres en conflicto cuando se inscriben clústeres existentes en la API. Cuando se use como parte de la inscripción del clúster, este campo diferirá del ID en el nombre del recurso. En el caso de los clústeres nuevos, este campo coincidirá con el nombre del clúster que proporcionó el usuario y será visible en el último componente del nombre del recurso. No se puede modificar.

Todos los usuarios deben usar este nombre para acceder a su clúster con gkectl o kubectl y deben esperar ver el nombre local cuando vean los registros del controlador de clúster de administrador.

etag

string

El servidor calcula esta suma de comprobación según el valor de otros campos y es posible que se envíe en las solicitudes de actualización y eliminación para garantizar que el cliente tenga un valor actualizado antes de continuar. Permite a los clientes realizar operaciones de lectura, modificación y escritura coherentes a través del control de simultaneidad optimista.

annotations

map (key: string, value: string)

Anotaciones en el clúster de administrador de Bare Metal Este campo tiene las mismas restricciones que las anotaciones de Kubernetes. El tamaño total de todas las claves y valores combinados se limita a 256,000. La clave puede tener 2 segmentos: prefijo (opcional) y nombre (obligatorio), separados por una barra diagonal (/). El prefijo debe ser un subdominio DNS. El nombre debe tener 63 caracteres o menos, comenzar y terminar con caracteres alfanuméricos, con guiones (-), guiones bajos (_), puntos (.) y caracteres alfanuméricos en el medio.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

networkConfig

object (BareMetalAdminNetworkConfig)

Configuración de red

controlPlane

object (BareMetalAdminControlPlaneConfig)

Configuración del plano de control

loadBalancer

object (BareMetalAdminLoadBalancerConfig)

Configuración del balanceador de cargas

storage

object (BareMetalAdminStorageConfig)

Configuración de almacenamiento.

fleet

object (Fleet)

Solo salida. Configuración de la flota para el clúster.

clusterOperations

object (BareMetalAdminClusterOperationsConfig)

Configuración de las operaciones del clúster

status

object (ResourceStatus)

Solo salida. ResourceStatus que representa el estado detallado del clúster

maintenanceConfig

object (BareMetalAdminMaintenanceConfig)

Configuración de mantenimiento.

maintenanceStatus

object (BareMetalAdminMaintenanceStatus)

Solo salida. MaintenanceStatus que representa el estado de mantenimiento.

validationCheck

object (ValidationCheck)

Solo salida. ValidationCheck que representa el resultado de la verificación previa.

nodeConfig

object (BareMetalAdminWorkloadNodeConfig)

Configuración del nodo de la carga de trabajo

proxy

object (BareMetalAdminProxyConfig)

Configuración de proxy.

securityConfig

object (BareMetalAdminSecurityConfig)

Configuración relacionada con la seguridad

nodeAccessConfig

object (BareMetalAdminNodeAccessConfig)

Parámetros de configuración relacionados con el acceso a nodos

osEnvironmentConfig

object (BareMetalAdminOsEnvironmentConfig)

Parámetros de configuración relacionados con el entorno del SO.

binaryAuthorization

object (BinaryAuthorization)

Parámetros de configuración relacionados con la autorización binaria

Estado

El estado del ciclo de vida del clúster de administrador de Bare Metal

Enums
STATE_UNSPECIFIED Sin establecer.
PROVISIONING El estado PROVISIONING indica que se está creando el clúster.
RUNNING El estado RUNNING indica que el clúster se creó y se puede usar por completo.
RECONCILING El estado RECONCILING indica que el clúster se está actualizando. Permanece disponible, pero es posible que el rendimiento se vea afectado.
STOPPING El estado STOPPING indica que se está borrando el clúster.
ERROR El estado ERROR indica que el clúster se encuentra en un estado con daño irrecuperable.
DEGRADED El estado DEGRADED indica que el clúster requiere una acción del usuario para restablecer la funcionalidad completa.

BareMetalAdminNetworkConfig

BareMetalAdminNetworkConfig especifica la configuración de red del clúster.

Representación JSON
{

  // 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
Campo de unión cluster_cidr_configuration. Es la configuración de CIDR que se usará en el clúster de administrador. cluster_cidr_configuration puede ser solo uno de los siguientes:
islandModeCidr

object (BareMetalAdminIslandModeCidrConfig)

Configuración del CIDR del modo Island.

BareMetalAdminIslandModeCidrConfig

BareMetalAdminIslandModeCidrConfig especifica la configuración de CIDR del clúster mientras se ejecuta en modo isla.

Representación JSON
{
  "serviceAddressCidrBlocks": [
    string
  ],
  "podAddressCidrBlocks": [
    string
  ]
}
Campos
serviceAddressCidrBlocks[]

string

Obligatorio. A todos los servicios del clúster se les asigna una dirección IPv4 RFC1918 de estos rangos. No se puede cambiar este campo después de crearlo.

podAddressCidrBlocks[]

string

Obligatorio. A todos los pods del clúster se les asigna una dirección IPv4 RFC1918 de estos rangos. No se puede cambiar este campo después de crearlo.

BareMetalAdminControlPlaneConfig

BareMetalAdminControlPlaneConfig especifica la configuración del plano de control.

Representación JSON
{
  "controlPlaneNodePoolConfig": {
    object (BareMetalAdminControlPlaneNodePoolConfig)
  },
  "apiServerArgs": [
    {
      object (BareMetalAdminApiServerArgument)
    }
  ]
}
Campos
controlPlaneNodePoolConfig

object (BareMetalAdminControlPlaneNodePoolConfig)

Obligatorio. Configura el grupo de nodos que ejecuta el plano de control. Si se especifica, se creará el NodePool correspondiente para el plano de control del clúster. El NodePool tendrá el mismo nombre y espacio de nombres que el clúster.

apiServerArgs[]

object (BareMetalAdminApiServerArgument)

Personaliza los argumentos del servidor de la API predeterminados. Solo se admite un subconjunto de marcas personalizadas. Consulta la documentación del servidor de API a continuación para conocer el formato exacto: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/

BareMetalAdminControlPlaneNodePoolConfig

BareMetalAdminControlPlaneNodePoolConfig especifica la configuración del grupo de nodos del plano de control. Tenemos una configuración de grupo de nodos específica del plano de control para que podamos ser flexibles en cuanto a la compatibilidad con campos específicos del plano de control en el futuro.

Representación JSON
{
  "nodePoolConfig": {
    object (BareMetalNodePoolConfig)
  }
}
Campos
nodePoolConfig

object (BareMetalNodePoolConfig)

Obligatorio. La configuración genérica para un grupo de nodos que ejecuta el plano de control.

BareMetalAdminApiServerArgument

BareMetalAdminApiServerArgument representa un par nombre->valor de arg. Solo se admite un subconjunto de marcas personalizadas. Consulta la documentación del servidor de API a continuación para conocer el formato exacto: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/

Representación JSON
{
  "argument": string,
  "value": string
}
Campos
argument

string

Obligatorio. Asegúrate de quitar los guiones iniciales del nombre del argumento tal como aparece en la línea de comandos del servidor de la API.

value

string

Obligatorio. Es el valor del argumento tal como se pasará a la línea de comandos del servidor de la API.

BareMetalAdminLoadBalancerConfig

BareMetalAdminLoadBalancerConfig especifica la configuración del balanceador de cargas.

Representación JSON
{
  "vipConfig": {
    object (BareMetalAdminVipConfig)
  },
  "portConfig": {
    object (BareMetalAdminPortConfig)
  },

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

object (BareMetalAdminVipConfig)

Las VIP que usa el balanceador de cargas

portConfig

object (BareMetalAdminPortConfig)

Configura los puertos en los que el balanceador de cargas escuchará.

Campo de unión load_balancer_configuration. Es la configuración del balanceador de cargas que se usará en el clúster de administrador. load_balancer_configuration puede ser solo uno de los siguientes:
manualLbConfig

object (BareMetalAdminManualLbConfig)

Balanceadores de cargas configurados de forma manual

BareMetalAdminVipConfig

BareMetalAdminVipConfig para configuraciones de balanceador de cargas de Bare Metal.

Representación JSON
{
  "controlPlaneVip": string
}
Campos
controlPlaneVip

string

La VIP que reservaste anteriormente para la API de Kubernetes de este clúster de administrador de Bare Metal

BareMetalAdminPortConfig

BareMetalAdminPortConfig es la especificación de los puertos del balanceador de cargas.

Representación JSON
{
  "controlPlaneLoadBalancerPort": integer
}
Campos
controlPlaneLoadBalancerPort

integer

Es el puerto en el que escucharán los balanceadores de cargas alojados en el plano de control.

BareMetalAdminManualLbConfig

BareMetalAdminManualLbConfig representa los parámetros de configuración de un balanceador de cargas manual.

Representación JSON
{
  "enabled": boolean
}
Campos
enabled

boolean

Indica si el balanceo de cargas manual está habilitado.

BareMetalAdminStorageConfig

BareMetalAdminStorageConfig especifica la configuración de almacenamiento del clúster.

Representación JSON
{
  "lvpShareConfig": {
    object (BareMetalLvpShareConfig)
  },
  "lvpNodeMountsConfig": {
    object (BareMetalLvpConfig)
  }
}
Campos
lvpShareConfig

object (BareMetalLvpShareConfig)

Obligatorio. Especifica la configuración de PersistentVolumes locales respaldados por subdirectorios en un sistema de archivos compartidos. Estos subdirectorios se crean automáticamente durante la creación del clúster.

lvpNodeMountsConfig

object (BareMetalLvpConfig)

Obligatorio. Especifica la configuración de PersistentVolumes locales respaldados por discos de nodos activados. El usuario debe formatear y activar estos discos, lo que se puede hacer antes o después de la creación del clúster.

BareMetalAdminClusterOperationsConfig

BareMetalAdminClusterOperationsConfig especifica la infraestructura de observabilidad del clúster de administrador.

Representación JSON
{
  "enableApplicationLogs": boolean
}
Campos
enableApplicationLogs

boolean

Si se debe habilitar la recopilación de registros o métricas de la aplicación (además de los registros o métricas del sistema)

BareMetalAdminMaintenanceConfig

BareMetalAdminMaintenanceConfig especifica configuraciones para poner los nodos de CR del clúster de administrador de Bare Metal en mantenimiento y sacarlos de él.

Representación JSON
{
  "maintenanceAddressCidrBlocks": [
    string
  ]
}
Campos
maintenanceAddressCidrBlocks[]

string

Obligatorio. Todas las direcciones IPv4 de estos rangos se colocarán en modo de mantenimiento. Los nodos en modo de mantenimiento se acordonarán y se desviarán. Cuando se cumplan ambas condiciones, se establecerá la anotación "baremetal.cluster.gke.io/maintenance" en el recurso del nodo.

BareMetalAdminMaintenanceStatus

BareMetalAdminMaintenanceStatus representa el estado de mantenimiento de los nodos de la CR del clúster de administrador de Bare Metal.

Representación JSON
{
  "machineDrainStatus": {
    object (BareMetalAdminMachineDrainStatus)
  }
}
Campos
machineDrainStatus

object (BareMetalAdminMachineDrainStatus)

Representa el estado de los nodos de máquinas que se están agotando y agotados. Se usa para mostrar el progreso de la actualización del clúster.

BareMetalAdminMachineDrainStatus

BareMetalAdminMachineDrainStatus representa el estado de las máquinas de nodos bare metal que están en operaciones de drenaje.

Representación JSON
{
  "drainingMachines": [
    {
      object (BareMetalAdminDrainingMachine)
    }
  ],
  "drainedMachines": [
    {
      object (BareMetalAdminDrainedMachine)
    }
  ]
}
Campos
drainingMachines[]

object (BareMetalAdminDrainingMachine)

La lista de máquinas de drenaje

drainedMachines[]

object (BareMetalAdminDrainedMachine)

La lista de máquinas drenadas

BareMetalAdminDrainingMachine

BareMetalAdminDrainingMachine representa las máquinas que se están agotando.

Representación JSON
{
  "nodeIp": string,
  "podCount": integer
}
Campos
nodeIp

string

Dirección IP de la máquina de drenaje.

podCount

integer

Es el recuento de pods que aún no se agotan.

BareMetalAdminDrainedMachine

BareMetalAdminDrainedMachine representa las máquinas que se agotan.

Representación JSON
{
  "nodeIp": string
}
Campos
nodeIp

string

Dirección IP de la máquina agotada.

BareMetalAdminWorkloadNodeConfig

BareMetalAdminWorkloadNodeConfig especifica las configuraciones de los nodos de la carga de trabajo.

Representación JSON
{
  "maxPodsPerNode": string
}
Campos
maxPodsPerNode

string (int64 format)

Es la cantidad máxima de pods que puede ejecutar un nodo. El tamaño del rango de CIDR asignado al nodo se derivará de este parámetro. De forma predeterminada, se crean 110 Pods por nodo. El límite superior es de 250 para los clústeres de administrador con HA y sin HA. El límite inferior es de 64 para el clúster de administrador que no tiene HA y de 32 para el clúster de administrador de HA.

BareMetalAdminProxyConfig

BareMetalAdminProxyConfig especifica la configuración del proxy del clúster.

Representación JSON
{
  "uri": string,
  "noProxy": [
    string
  ]
}
Campos
uri

string

Obligatorio. Especifica la dirección de tu servidor proxy. Ejemplos: http://domain

ADVERTENCIA: No proporciones credenciales en el formato http://(username:password@)domain, ya que el servidor las rechazará.

noProxy[]

string

Es una lista de IP, nombres de host y dominios que deben omitir el proxy. Ejemplos: ["127.0.0.1", "example.com", ".corp", "localhost"].

BareMetalAdminSecurityConfig

Especifica la configuración relacionada con la seguridad del clúster de administrador de Bare Metal.

Representación JSON
{
  "authorization": {
    object (Authorization)
  }
}
Campos
authorization

object (Authorization)

Configura el acceso de los usuarios al clúster de administrador.

BareMetalAdminNodeAccessConfig

Especifica la configuración relacionada con el acceso de nodos para el clúster de administrador de Bare Metal.

Representación JSON
{
  "loginUser": string
}
Campos
loginUser

string

Obligatorio. LoginUser es el nombre de usuario que se usa para acceder a las máquinas de nodos. Si no se establece, el valor predeterminado es "root".

BareMetalAdminOsEnvironmentConfig

Especifica la configuración de operación del sistema operativo para el aprovisionamiento de clústeres.

Representación JSON
{
  "packageRepoExcluded": boolean
}
Campos
packageRepoExcluded

boolean

Indica si se debe agregar el repositorio de paquetes cuando se inicializan las máquinas físicas.

Métodos

create

Crea un nuevo clúster de administrador de Bare Metal en un proyecto y una ubicación determinados.

enroll

Inscribe un clúster de administrador de Bare Metal existente en la API de Anthos On-Prem en una ubicación y un proyecto determinados.

get

Obtiene los detalles de un solo clúster de administrador de Bare Metal.

list

Muestra una lista de clústeres de administrador de Bare Metal en una ubicación y un proyecto determinados.

patch

Actualiza los parámetros de un solo clúster de administrador de Bare Metal.

queryVersionConfig

Consulta la configuración de la versión del clúster de administrador de Bare Metal.