This product is not supported for your selected Datadog site. ().

gcp_gkeonprem_vmware_cluster

admin_cluster_membership

Type: STRING
Provider name: adminClusterMembership
Description: Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster’s fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.

admin_cluster_name

Type: STRING
Provider name: adminClusterName
Description: Output only. The resource name of the VMware admin cluster hosting this user cluster.

ancestors

Type: UNORDERED_LIST_STRING

annotations

Type: MAP_STRING_STRING
Provider name: annotations
Description: Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

anti_affinity_groups

Type: STRUCT
Provider name: antiAffinityGroups
Description: AAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter.

  • aag_config_disabled
    Type: BOOLEAN
    Provider name: aagConfigDisabled
    Description: Spread nodes across at least three physical hosts (requires at least three hosts). Enabled by default.

authorization

Type: STRUCT
Provider name: authorization
Description: RBAC policy that will be applied and managed by the Anthos On-Prem API.

  • admin_users
    Type: UNORDERED_LIST_STRUCT
    Provider name: adminUsers
    Description: For VMware and bare metal user clusters, users will be granted the cluster-admin role on the cluster, which provides full administrative access to the cluster. For bare metal admin clusters, users will be granted the cluster-view role, which limits users to read-only access.
    • username
      Type: STRING
      Provider name: username
      Description: Required. The name of the user, e.g. my-gcp-id@gmail.com.

auto_repair_config

Type: STRUCT
Provider name: autoRepairConfig
Description: Configuration for auto repairing.

  • enabled
    Type: BOOLEAN
    Provider name: enabled
    Description: Whether auto repair is enabled.

binary_authorization

Type: STRUCT
Provider name: binaryAuthorization
Description: Binary Authorization related configurations.

  • evaluation_mode
    Type: STRING
    Provider name: evaluationMode
    Description: Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
    Possible values:
    • EVALUATION_MODE_UNSPECIFIED - Default value
    • DISABLED - Disable BinaryAuthorization
    • PROJECT_SINGLETON_POLICY_ENFORCE - Enforce Kubernetes admission requests with BinaryAuthorization using the project’s singleton policy.

control_plane_node

Type: STRUCT
Provider name: controlPlaneNode
Description: VMware user cluster control plane nodes must have either 1 or 3 replicas.

  • auto_resize_config
    Type: STRUCT
    Provider name: autoResizeConfig
    Description: AutoResizeConfig provides auto resizing configurations.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: Whether to enable controle plane node auto resizing.
  • cpus
    Type: INT64
    Provider name: cpus
    Description: The number of CPUs for each admin cluster node that serve as control planes for this VMware user cluster. (default: 4 CPUs)
  • memory
    Type: INT64
    Provider name: memory
    Description: The megabytes of memory for each admin cluster node that serves as a control plane for this VMware user cluster (default: 8192 MB memory).
  • replicas
    Type: INT64
    Provider name: replicas
    Description: The number of control plane nodes for this VMware user cluster. (default: 1 replica).
  • vsphere_config
    Type: STRUCT
    Provider name: vsphereConfig
    Description: Vsphere-specific config.
    • datastore
      Type: STRING
      Provider name: datastore
      Description: The Vsphere datastore used by the control plane Node.
    • storage_policy_name
      Type: STRING
      Provider name: storagePolicyName
      Description: The Vsphere storage policy used by the control plane Node.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time at which VMware user cluster was created.

dataplane_v2

Type: STRUCT
Provider name: dataplaneV2
Description: VmwareDataplaneV2Config specifies configuration for Dataplane V2.

  • advanced_networking
    Type: BOOLEAN
    Provider name: advancedNetworking
    Description: Enable advanced networking which requires dataplane_v2_enabled to be set true.
  • dataplane_v2_enabled
    Type: BOOLEAN
    Provider name: dataplaneV2Enabled
    Description: Enables Dataplane V2.
  • forward_mode
    Type: STRING
    Provider name: forwardMode
    Description: Configure ForwardMode for Dataplane v2.
  • windows_dataplane_v2_enabled
    Type: BOOLEAN
    Provider name: windowsDataplaneV2Enabled
    Description: Enable Dataplane V2 for clusters with Windows nodes.

delete_time

Type: TIMESTAMP
Provider name: deleteTime
Description: Output only. The time at which VMware user cluster was deleted.

description

Type: STRING
Provider name: description
Description: A human readable description of this VMware user cluster.

disable_bundled_ingress

Type: BOOLEAN
Provider name: disableBundledIngress
Description: Disable bundled ingress.

enable_advanced_cluster

Type: BOOLEAN
Provider name: enableAdvancedCluster
Description: Enable advanced cluster.

enable_control_plane_v2

Type: BOOLEAN
Provider name: enableControlPlaneV2
Description: Enable control plane V2. Default to false.

endpoint

Type: STRING
Provider name: endpoint
Description: Output only. The DNS name of VMware user cluster’s API server.

etag

Type: STRING
Provider name: etag
Description: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

fleet

Type: STRUCT
Provider name: fleet
Description: Output only. Fleet configuration for the cluster.

  • membership
    Type: STRING
    Provider name: membership
    Description: Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as projects//locations//memberships/.

gcp_status

Type: STRUCT
Provider name: status
Description: Output only. ResourceStatus representing detailed cluster state.

  • conditions
    Type: UNORDERED_LIST_STRUCT
    Provider name: conditions
    Description: ResourceCondition provide a standard mechanism for higher-level status reporting from controller.
    • last_transition_time
      Type: TIMESTAMP
      Provider name: lastTransitionTime
      Description: Last time the condition transit from one status to another.
    • message
      Type: STRING
      Provider name: message
      Description: Human-readable message indicating details about last transition.
    • reason
      Type: STRING
      Provider name: reason
      Description: Machine-readable message indicating details about last transition.
    • state
      Type: STRING
      Provider name: state
      Description: state of the condition.
      Possible values:
      • STATE_UNSPECIFIED - Not set.
      • STATE_TRUE - Resource is in the condition.
      • STATE_FALSE - Resource is not in the condition.
      • STATE_UNKNOWN - Kubernetes controller can’t decide if the resource is in the condition or not.
    • type
      Type: STRING
      Provider name: type
      Description: Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)
  • error_message
    Type: STRING
    Provider name: errorMessage
    Description: Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention.
  • version
    Type: STRING
    Provider name: version
    Description: Reflect current version of the resource.
  • versions
    Type: STRUCT
    Provider name: versions
    Description: Shows the mapping of a given version to the number of machines under this version.
    • versions
      Type: UNORDERED_LIST_STRUCT
      Provider name: versions
      Description: Shows the mapping of a given version to the number of machines under this version.
      • count
        Type: INT64
        Provider name: count
        Description: Number of machines under the above version.
      • version
        Type: STRING
        Provider name: version
        Description: Resource version.

labels

Type: UNORDERED_LIST_STRING

load_balancer

Type: STRUCT
Provider name: loadBalancer
Description: Load balancer configuration.

  • f5_config
    Type: STRUCT
    Provider name: f5Config
    Description: Configuration for F5 Big IP typed load balancers.
    • address
      Type: STRING
      Provider name: address
      Description: The load balancer’s IP address.
    • partition
      Type: STRING
      Provider name: partition
      Description: The preexisting partition to be used by the load balancer. This partition is usually created for the admin cluster for example: ‘my-f5-admin-partition’.
    • snat_pool
      Type: STRING
      Provider name: snatPool
      Description: The pool name. Only necessary, if using SNAT.
  • manual_lb_config
    Type: STRUCT
    Provider name: manualLbConfig
    Description: Manually configured load balancers.
    • control_plane_node_port
      Type: INT32
      Provider name: controlPlaneNodePort
      Description: NodePort for control plane service. The Kubernetes API server in the admin cluster is implemented as a Service of type NodePort (ex. 30968).
    • ingress_http_node_port
      Type: INT32
      Provider name: ingressHttpNodePort
      Description: NodePort for ingress service’s http. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 32527).
    • ingress_https_node_port
      Type: INT32
      Provider name: ingressHttpsNodePort
      Description: NodePort for ingress service’s https. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 30139).
    • konnectivity_server_node_port
      Type: INT32
      Provider name: konnectivityServerNodePort
      Description: NodePort for konnectivity server service running as a sidecar in each kube-apiserver pod (ex. 30564).
  • metal_lb_config
    Type: STRUCT
    Provider name: metalLbConfig
    Description: Configuration for MetalLB typed load balancers.
    • address_pools
      Type: UNORDERED_LIST_STRUCT
      Provider name: addressPools
      Description: Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools.
      • addresses
        Type: UNORDERED_LIST_STRING
        Provider name: addresses
        Description: Required. The addresses that are part of this pool. Each address must be either in the CIDR form (1.2.3.0/24) or range form (1.2.3.1-1.2.3.5).
      • avoid_buggy_ips
        Type: BOOLEAN
        Provider name: avoidBuggyIps
        Description: If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
      • manual_assign
        Type: BOOLEAN
        Provider name: manualAssign
        Description: If true, prevent IP addresses from being automatically assigned.
      • pool
        Type: STRING
        Provider name: pool
        Description: Required. The name of the address pool.
  • seesaw_config
    Type: STRUCT
    Provider name: seesawConfig
    Description: Output only. Configuration for Seesaw typed load balancers.
    • enable_ha
      Type: BOOLEAN
      Provider name: enableHa
      Description: Enable two load balancer VMs to achieve a highly-available Seesaw load balancer.
    • group
      Type: STRING
      Provider name: group
      Description: Required. In general the following format should be used for the Seesaw group name: seesaw-for-[cluster_name].
    • ip_blocks
      Type: UNORDERED_LIST_STRUCT
      Provider name: ipBlocks
      Description: Required. The IP Blocks to be used by the Seesaw load balancer
      • gateway
        Type: STRING
        Provider name: gateway
        Description: The network gateway used by the VMware user cluster.
      • ips
        Type: UNORDERED_LIST_STRUCT
        Provider name: ips
        Description: The node’s network configurations used by the VMware user cluster.
        • hostname
          Type: STRING
          Provider name: hostname
          Description: Hostname of the machine. VM’s name will be used if this field is empty.
        • ip
          Type: STRING
          Provider name: ip
          Description: IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
      • netmask
        Type: STRING
        Provider name: netmask
        Description: The netmask used by the VMware user cluster.
    • master_ip
      Type: STRING
      Provider name: masterIp
      Description: Required. MasterIP is the IP announced by the master of Seesaw group.
    • stackdriver_name
      Type: STRING
      Provider name: stackdriverName
      Description: Name to be used by Stackdriver.
    • vms
      Type: UNORDERED_LIST_STRING
      Provider name: vms
      Description: Names of the VMs created for this Seesaw group.
  • vip_config
    Type: STRUCT
    Provider name: vipConfig
    Description: The VIPs used by the load balancer.
    • control_plane_vip
      Type: STRING
      Provider name: controlPlaneVip
      Description: The VIP which you previously set aside for the Kubernetes API of this cluster.
    • ingress_vip
      Type: STRING
      Provider name: ingressVip
      Description: The VIP which you previously set aside for ingress traffic into this cluster.

local_name

Type: STRING
Provider name: localName
Description: Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs.

name

Type: STRING
Provider name: name
Description: Immutable. The VMware user cluster resource name.

network_config

Type: STRUCT
Provider name: networkConfig
Description: The VMware user cluster network configuration.

  • control_plane_v2_config
    Type: STRUCT
    Provider name: controlPlaneV2Config
    Description: Configuration for control plane V2 mode.
    • control_plane_ip_block
      Type: STRUCT
      Provider name: controlPlaneIpBlock
      Description: Static IP addresses for the control plane nodes.
      • gateway
        Type: STRING
        Provider name: gateway
        Description: The network gateway used by the VMware user cluster.
      • ips
        Type: UNORDERED_LIST_STRUCT
        Provider name: ips
        Description: The node’s network configurations used by the VMware user cluster.
        • hostname
          Type: STRING
          Provider name: hostname
          Description: Hostname of the machine. VM’s name will be used if this field is empty.
        • ip
          Type: STRING
          Provider name: ip
          Description: IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
      • netmask
        Type: STRING
        Provider name: netmask
        Description: The netmask used by the VMware user cluster.
  • dhcp_ip_config
    Type: STRUCT
    Provider name: dhcpIpConfig
    Description: Configuration settings for a DHCP IP configuration.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: enabled is a flag to mark if DHCP IP allocation is used for VMware user clusters.
  • host_config
    Type: STRUCT
    Provider name: hostConfig
    Description: Represents common network settings irrespective of the host’s IP address.
    • dns_search_domains
      Type: UNORDERED_LIST_STRING
      Provider name: dnsSearchDomains
      Description: DNS search domains.
    • dns_servers
      Type: UNORDERED_LIST_STRING
      Provider name: dnsServers
      Description: DNS servers.
    • ntp_servers
      Type: UNORDERED_LIST_STRING
      Provider name: ntpServers
      Description: NTP servers.
  • pod_address_cidr_blocks
    Type: UNORDERED_LIST_STRING
    Provider name: podAddressCidrBlocks
    Description: Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.
  • service_address_cidr_blocks
    Type: UNORDERED_LIST_STRING
    Provider name: serviceAddressCidrBlocks
    Description: Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.
  • static_ip_config
    Type: STRUCT
    Provider name: staticIpConfig
    Description: Configuration settings for a static IP configuration.
    • ip_blocks
      Type: UNORDERED_LIST_STRUCT
      Provider name: ipBlocks
      Description: Represents the configuration values for static IP allocation to nodes.
      • gateway
        Type: STRING
        Provider name: gateway
        Description: The network gateway used by the VMware user cluster.
      • ips
        Type: UNORDERED_LIST_STRUCT
        Provider name: ips
        Description: The node’s network configurations used by the VMware user cluster.
        • hostname
          Type: STRING
          Provider name: hostname
          Description: Hostname of the machine. VM’s name will be used if this field is empty.
        • ip
          Type: STRING
          Provider name: ip
          Description: IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
      • netmask
        Type: STRING
        Provider name: netmask
        Description: The netmask used by the VMware user cluster.
  • vcenter_network
    Type: STRING
    Provider name: vcenterNetwork
    Description: vcenter_network specifies vCenter network name. Inherited from the admin cluster.

on_prem_version

Type: STRING
Provider name: onPremVersion
Description: Required. The Anthos clusters on the VMware version for your user cluster.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

reconciling

Type: BOOLEAN
Provider name: reconciling
Description: Output only. If set, there are currently changes in flight to the VMware user cluster.

resource_name

Type: STRING

state

Type: STRING
Provider name: state
Description: Output only. The current state of VMware user cluster.
Possible values:

  • STATE_UNSPECIFIED - Not set.
  • PROVISIONING - The PROVISIONING state indicates the cluster is being created.
  • RUNNING - The RUNNING state indicates the cluster has been created and is fully usable.
  • RECONCILING - The RECONCILING state indicates that the cluster is being updated. It remains available, but potentially with degraded performance.
  • STOPPING - The STOPPING state indicates the cluster is being deleted.
  • ERROR - The ERROR state indicates the cluster is in a broken unrecoverable state.
  • DEGRADED - The DEGRADED state indicates the cluster requires user action to restore full functionality.

storage

Type: STRUCT
Provider name: storage
Description: Storage configuration.

  • vsphere_csi_disabled
    Type: BOOLEAN
    Provider name: vsphereCsiDisabled
    Description: Whether or not to deploy vSphere CSI components in the VMware user cluster. Enabled by default.

tags

Type: UNORDERED_LIST_STRING

uid

Type: STRING
Provider name: uid
Description: Output only. The unique identifier of the VMware user cluster.

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The time at which VMware user cluster was last updated.

upgrade_policy

Type: STRUCT
Provider name: upgradePolicy
Description: Specifies upgrade policy for the cluster.

  • control_plane_only
    Type: BOOLEAN
    Provider name: controlPlaneOnly
    Description: Controls whether the upgrade applies to the control plane only.

validation_check

Type: STRUCT
Provider name: validationCheck
Description: Output only. ValidationCheck represents the result of the preflight check job.

  • gcp_status
    Type: STRUCT
    Provider name: status
    Description: Output only. The detailed validation check status.
    • result
      Type: UNORDERED_LIST_STRUCT
      Provider name: result
      Description: Individual checks which failed as part of the Preflight check execution.
      • category
        Type: STRING
        Provider name: category
        Description: The category of the validation.
      • description
        Type: STRING
        Provider name: description
        Description: The description of the validation check.
      • details
        Type: STRING
        Provider name: details
        Description: Detailed failure information, which might be unformatted.
      • reason
        Type: STRING
        Provider name: reason
        Description: A human-readable message of the check failure.
      • state
        Type: STRING
        Provider name: state
        Description: The validation check state.
        Possible values:
        • STATE_UNKNOWN - The default value. The check result is unknown.
        • STATE_FAILURE - The check failed.
        • STATE_SKIPPED - The check was skipped.
        • STATE_FATAL - The check itself failed to complete.
        • STATE_WARNING - The check encountered a warning.
  • option
    Type: STRING
    Provider name: option
    Description: Options used for the validation check
    Possible values:
    • OPTIONS_UNSPECIFIED - Default value. Standard preflight validation check will be used.
    • SKIP_VALIDATION_CHECK_BLOCKING - Prevent failed preflight checks from failing.
    • SKIP_VALIDATION_ALL - Skip all preflight check validations.
  • scenario
    Type: STRING
    Provider name: scenario
    Description: Output only. The scenario when the preflight checks were run.
    Possible values:
    • SCENARIO_UNSPECIFIED - Default value. This value is unused.
    • CREATE - The validation check occurred during a create flow.
    • UPDATE - The validation check occurred during an update flow.

vcenter

Type: STRUCT
Provider name: vcenter
Description: VmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster.

  • address
    Type: STRING
    Provider name: address
    Description: Output only. The vCenter IP address.
  • ca_cert_data
    Type: STRING
    Provider name: caCertData
    Description: Contains the vCenter CA certificate public key for SSL verification.
  • cluster
    Type: STRING
    Provider name: cluster
    Description: The name of the vCenter cluster for the user cluster.
  • datacenter
    Type: STRING
    Provider name: datacenter
    Description: The name of the vCenter datacenter for the user cluster.
  • datastore
    Type: STRING
    Provider name: datastore
    Description: The name of the vCenter datastore for the user cluster.
  • folder
    Type: STRING
    Provider name: folder
    Description: The name of the vCenter folder for the user cluster.
  • resource_pool
    Type: STRING
    Provider name: resourcePool
    Description: The name of the vCenter resource pool for the user cluster.
  • storage_policy_name
    Type: STRING
    Provider name: storagePolicyName
    Description: The name of the vCenter storage policy for the user cluster.

vm_tracking_enabled

Type: BOOLEAN
Provider name: vmTrackingEnabled
Description: Enable VM tracking.