Returns the bareMetalNodePools Resource.
Returns the operations Resource.
Close httplib2 connections.
Creates a new bare metal cluster in a given project and location.
Deletes a single bare metal Cluster.
enroll(parent, body=None, x__xgafv=None)
Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.
get(name, allowMissing=None, view=None, x__xgafv=None)
Gets details of a single bare metal Cluster.
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists bare metal clusters in a given project and location.
Retrieves the next page of results.
patch(name, body, allowMissing=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single bare metal Cluster.
Queries the bare metal user cluster version config.
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
unenroll(name, allowMissing=None, etag=None, force=None, validateOnly=None, x__xgafv=None)
Unenrolls an existing bare metal user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.
close()
Close httplib2 connections.
create(parent, body, allowPreflightFailure=None, bareMetalClusterId=None, validateOnly=None, x__xgafv=None)
Creates a new bare metal cluster in a given project and location.
Args:
parent: string, Required. The parent of the project and location where the cluster is created in. Format: "projects/{project}/locations/{location}" (required)
body: object, The request body.
The object takes the form of:
{ # Resource that represents a bare metal user cluster.
"adminClusterMembership": "A String", # Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership.
"adminClusterName": "A String", # Output only. The resource name of the bare metal admin cluster managing this user cluster.
"annotations": { # Annotations on the bare metal 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.
"a_key": "A String",
},
"bareMetalVersion": "A String", # Required. The Anthos clusters on bare metal version for your user cluster.
"binaryAuthorization": { # Configuration for Binary Authorization. # Binary Authorization related configurations.
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"clusterOperations": { # Specifies the bare metal user cluster's observability infrastructure. # Cluster operations configuration.
"enableApplicationLogs": True or False, # Whether collection of application logs/metrics should be enabled (in addition to system logs/metrics).
},
"controlPlane": { # Specifies the control plane configuration. # Required. Control plane configuration.
"apiServerArgs": [ # Customizes the default API server args. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).
{ # Represents an arg name->value pair. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).
"argument": "A String", # Required. The argument name as it appears on the API Server command line, make sure to remove the leading dashes.
"value": "A String", # Required. The value of the arg as it will be passed to the API Server command line.
},
],
"controlPlaneNodePoolConfig": { # Specifies the control plane node pool configuration. # Required. Configures the node pool running the control plane.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # Required. The generic configuration for a node pool running the control plane.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"createTime": "A String", # Output only. The time when the bare metal user cluster was created.
"deleteTime": "A String", # Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty
"description": "A String", # A human readable description of this bare metal user cluster.
"endpoint": "A String", # Output only. The IP address of the bare metal user cluster's API server.
"etag": "A String", # Output only. 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": { # Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## # Output only. Fleet configuration for the cluster.
"membership": "A String", # Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as `projects//locations//memberships/`.
},
"loadBalancer": { # Specifies the load balancer configuration. # Required. Load balancer configuration.
"bgpLbConfig": { # BareMetalBgpLbConfig represents configuration parameters for a Border Gateway Protocol (BGP) load balancer. # Configuration for BGP typed load balancers. When set network_config.advanced_networking is automatically set to true.
"addressPools": [ # 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.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # 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).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
"asn": "A String", # Required. BGP autonomous system number (ASN) of the cluster. This field can be updated after cluster creation.
"bgpPeerConfigs": [ # Required. The list of BGP peers that the cluster will connect to. At least one peer must be configured for each control plane node. Control plane nodes will connect to these peers to advertise the control plane VIP. The Services load balancer also uses these peers by default. This field can be updated after cluster creation.
{ # BareMetalBgpPeerConfig represents configuration parameters for a Border Gateway Protocol (BGP) peer.
"asn": "A String", # Required. BGP autonomous system number (ASN) for the network that contains the external peer device.
"controlPlaneNodes": [ # The IP address of the control plane node that connects to the external peer. If you don't specify any control plane nodes, all control plane nodes can connect to the external peer. If you specify one or more IP addresses, only the nodes specified participate in peering sessions.
"A String",
],
"ipAddress": "A String", # Required. The IP address of the external peer device.
},
],
"loadBalancerNodePoolConfig": { # Specifies the load balancer's node pool configuration. # Specifies the node pool running data plane load balancing. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used for data plane load balancing.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # The generic configuration for a node pool running a load balancer.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"manualLbConfig": { # Represents configuration parameters for a manual load balancer. # Manually configured load balancers.
"enabled": True or False, # Whether manual load balancing is enabled.
},
"metalLbConfig": { # Represents configuration parameters for a MetalLB load balancer. # Configuration for MetalLB load balancers.
"addressPools": [ # 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.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # 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).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
"loadBalancerNodePoolConfig": { # Specifies the load balancer's node pool configuration. # Specifies the node pool running the load balancer. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used as the load balancer pool.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # The generic configuration for a node pool running a load balancer.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"portConfig": { # Specifies load balancer ports for the bare metal user cluster. # Configures the ports that the load balancer will listen on.
"controlPlaneLoadBalancerPort": 42, # The port that control plane hosted load balancers will listen on.
},
"vipConfig": { # Specifies the VIP config for the bare metal load balancer. # The VIPs used by the load balancer.
"controlPlaneVip": "A String", # The VIP which you previously set aside for the Kubernetes API of this bare metal user cluster.
"ingressVip": "A String", # The VIP which you previously set aside for ingress traffic into this bare metal user cluster.
},
},
"localName": "A String", # Output only. The object name of the bare metal user cluster 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 name 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. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl.
"maintenanceConfig": { # Specifies configurations to put bare metal nodes in and out of maintenance. # Maintenance configuration.
"maintenanceAddressCidrBlocks": [ # Required. All IPv4 address from these ranges will be placed into maintenance mode. Nodes in maintenance mode will be cordoned and drained. When both of these are true, the "baremetal.cluster.gke.io/maintenance" annotation will be set on the node resource.
"A String",
],
},
"maintenanceStatus": { # Represents the maintenance status of the bare metal user cluster. # Output only. Status of on-going maintenance tasks.
"machineDrainStatus": { # Represents the status of node machines that are undergoing drain operations. # The maintenance status of node machines.
"drainedMachines": [ # The list of drained machines.
{ # Represents a machine that is currently drained.
"nodeIp": "A String", # Drained machine IP address.
},
],
"drainingMachines": [ # The list of draning machines.
{ # Represents a machine that is currently draining.
"nodeIp": "A String", # Draining machine IP address.
"podCount": 42, # The count of pods yet to drain.
},
],
},
},
"name": "A String", # Immutable. The bare metal user cluster resource name.
"networkConfig": { # Specifies the cluster network configuration. # Required. Network configuration.
"advancedNetworking": True or False, # Enables the use of advanced Anthos networking features, such as Bundled Load Balancing with BGP or the egress NAT gateway. Setting configuration for advanced networking features will automatically set this flag.
"islandModeCidr": { # Specifies the cluster CIDR configuration while running in island mode. # Configuration for island mode CIDR. In an island-mode network, nodes have unique IP addresses, but pods don't have unique addresses across clusters. This doesn't cause problems because pods in one cluster never directly communicate with pods in another cluster. Instead, there are gateways that mediate between a pod in one cluster and a pod in another cluster.
"podAddressCidrBlocks": [ # Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field cannot be changed after creation.
"A String",
],
"serviceAddressCidrBlocks": [ # Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field is mutable after creation starting with version 1.15.
"A String",
],
},
"multipleNetworkInterfacesConfig": { # Specifies the multiple networking interfaces cluster configuration. # Configuration for multiple network interfaces.
"enabled": True or False, # Whether to enable multiple network interfaces for your pods. When set network_config.advanced_networking is automatically set to true.
},
"srIovConfig": { # Specifies the SR-IOV networking operator config. # Configuration for SR-IOV.
"enabled": True or False, # Whether to install the SR-IOV operator.
},
},
"nodeAccessConfig": { # Specifies the node access related settings for the bare metal user cluster. # Node access related configurations.
"loginUser": "A String", # LoginUser is the user name used to access node machines. It defaults to "root" if not set.
},
"nodeConfig": { # Specifies the workload node configurations. # Workload node configuration.
"containerRuntime": "A String", # Specifies which container runtime will be used.
"maxPodsPerNode": "A String", # The maximum number of pods a node can run. The size of the CIDR range assigned to the node will be derived from this parameter.
},
"osEnvironmentConfig": { # Specifies operating system settings for cluster provisioning. # OS environment related configurations.
"packageRepoExcluded": True or False, # Whether the package repo should not be included when initializing bare metal machines.
},
"proxy": { # Specifies the cluster proxy configuration. # Proxy configuration.
"noProxy": [ # A list of IPs, hostnames, and domains that should skip the proxy. Examples: ["127.0.0.1", "example.com", ".corp", "localhost"].
"A String",
],
"uri": "A String", # Required. Specifies the address of your proxy server. Examples: `http://domain` Do not provide credentials in the format `http://(username:password@)domain` these will be rejected by the server.
},
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the bare metal user cluster.
"securityConfig": { # Specifies the security related settings for the bare metal user cluster. # Security related setting configuration.
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # Configures user access to the user cluster.
"adminUsers": [ # 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.
{ # ClusterUser configures user principals for an RBAC policy.
"username": "A String", # Required. The name of the user, e.g. `my-gcp-id@gmail.com`.
},
],
},
},
"state": "A String", # Output only. The current state of the bare metal user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. Detailed cluster status.
"conditions": [ # ResourceCondition provide a standard mechanism for higher-level status reporting from controller.
{ # ResourceCondition provides a standard mechanism for higher-level status reporting from controller.
"lastTransitionTime": "A String", # Last time the condition transit from one status to another.
"message": "A String", # Human-readable message indicating details about last transition.
"reason": "A String", # Machine-readable message indicating details about last transition.
"state": "A String", # state of the condition.
"type": "A String", # Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)
},
],
"errorMessage": "A String", # 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": "A String", # Reflect current version of the resource.
"versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version.
"versions": [ # Shows the mapping of a given version to the number of machines under this version.
{ # Version describes the number of nodes at a given version under a resource.
"count": "A String", # Number of machines under the above version.
"version": "A String", # Resource version.
},
],
},
},
"storage": { # BareMetalStorageConfig specifies the cluster storage configuration. # Required. Storage configuration.
"lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation.
"path": "A String", # Required. The host machine path.
"storageClass": "A String", # Required. The StorageClass name that PVs will be created with.
},
"lvpShareConfig": { # Specifies the configs for local persistent volumes under a shared file system. # Required. Specifies the config for local PersistentVolumes backed by subdirectories in a shared filesystem. These subdirectores are automatically created during cluster creation.
"lvpConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Defines the machine path and storage class for the LVP Share.
"path": "A String", # Required. The host machine path.
"storageClass": "A String", # Required. The StorageClass name that PVs will be created with.
},
"sharedPathPvCount": 42, # The number of subdirectories to create under path.
},
},
"uid": "A String", # Output only. The unique identifier of the bare metal user cluster.
"updateTime": "A String", # Output only. The time when the bare metal user cluster was last updated.
"upgradePolicy": { # BareMetalClusterUpgradePolicy defines the cluster upgrade policy. # The cluster upgrade policy.
"pause": True or False, # Output only. Pause is used to show the upgrade pause status. It's view only for now.
"policy": "A String", # Specifies which upgrade policy to use.
},
"validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. The result of the preflight check.
"option": "A String", # Options used for the validation check
"scenario": "A String", # Output only. The scenario when the preflight checks were run.
"status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status.
"result": [ # Individual checks which failed as part of the Preflight check execution.
{ # ValidationCheckResult defines the details about the validation check.
"category": "A String", # The category of the validation.
"description": "A String", # The description of the validation check.
"details": "A String", # Detailed failure information, which might be unformatted.
"reason": "A String", # A human-readable message of the check failure.
"state": "A String", # The validation check state.
},
],
},
},
}
allowPreflightFailure: boolean, Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster.
bareMetalClusterId: string, Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/
validateOnly: boolean, Validate the request without actually doing any updates.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, allowMissing=None, etag=None, force=None, ignoreErrors=None, validateOnly=None, x__xgafv=None)
Deletes a single bare metal Cluster.
Args:
name: string, Required. Name of the bare metal user cluster to be deleted. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}" (required)
allowMissing: boolean, If set to true, and the bare metal cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
etag: string, The current etag of the bare metal Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
force: boolean, If set to true, any node pools from the cluster will also be deleted.
ignoreErrors: boolean, If set to true, the deletion of a bare metal user cluster resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's cluster resource and the on-prem admin cluster that hosts your user cluster is disconnected / unreachable or deleted. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP user cluster but an existing on-prem user cluster.
validateOnly: boolean, Validate the request without actually doing any updates.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
enroll(parent, body=None, x__xgafv=None)
Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.
Args:
parent: string, Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}" (required)
body: object, The request body.
The object takes the form of:
{ # Message for enrolling an existing bare metal cluster to the Anthos On-Prem API.
"adminClusterMembership": "A String", # Required. The admin cluster this bare metal 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.
"bareMetalClusterId": "A String", # User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all bare metal clusters within a project and location and will return a 409 if the cluster already exists. (https://tools.ietf.org/html/rfc1123) format.
"localName": "A String", # Optional. The object name of the bare metal cluster custom resource on the associated admin cluster. This field is used to support conflicting resource names when enrolling existing clusters to the API. When not provided, this field will resolve to the bare_metal_cluster_id. Otherwise, it must match the object name of the bare metal cluster custom resource. It is not modifiable outside / beyond the enrollment operation.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, allowMissing=None, view=None, x__xgafv=None)
Gets details of a single bare metal Cluster.
Args:
name: string, Required. Name of the bare metal user cluster to get. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}" (required)
allowMissing: boolean, Optional. If true, return BareMetal Cluster including the one that only exists in RMS.
view: string, View for bare metal user cluster. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.
Allowed values
CLUSTER_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
BASIC - Includes basic information of a cluster resource including cluster resource name and admin cluster membership.
FULL - Includes the complete configuration for bare metal cluster resource. This is the default value for GetBareMetalClusterRequest method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Resource that represents a bare metal user cluster.
"adminClusterMembership": "A String", # Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership.
"adminClusterName": "A String", # Output only. The resource name of the bare metal admin cluster managing this user cluster.
"annotations": { # Annotations on the bare metal 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.
"a_key": "A String",
},
"bareMetalVersion": "A String", # Required. The Anthos clusters on bare metal version for your user cluster.
"binaryAuthorization": { # Configuration for Binary Authorization. # Binary Authorization related configurations.
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"clusterOperations": { # Specifies the bare metal user cluster's observability infrastructure. # Cluster operations configuration.
"enableApplicationLogs": True or False, # Whether collection of application logs/metrics should be enabled (in addition to system logs/metrics).
},
"controlPlane": { # Specifies the control plane configuration. # Required. Control plane configuration.
"apiServerArgs": [ # Customizes the default API server args. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).
{ # Represents an arg name->value pair. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).
"argument": "A String", # Required. The argument name as it appears on the API Server command line, make sure to remove the leading dashes.
"value": "A String", # Required. The value of the arg as it will be passed to the API Server command line.
},
],
"controlPlaneNodePoolConfig": { # Specifies the control plane node pool configuration. # Required. Configures the node pool running the control plane.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # Required. The generic configuration for a node pool running the control plane.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"createTime": "A String", # Output only. The time when the bare metal user cluster was created.
"deleteTime": "A String", # Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty
"description": "A String", # A human readable description of this bare metal user cluster.
"endpoint": "A String", # Output only. The IP address of the bare metal user cluster's API server.
"etag": "A String", # Output only. 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": { # Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## # Output only. Fleet configuration for the cluster.
"membership": "A String", # Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as `projects//locations//memberships/`.
},
"loadBalancer": { # Specifies the load balancer configuration. # Required. Load balancer configuration.
"bgpLbConfig": { # BareMetalBgpLbConfig represents configuration parameters for a Border Gateway Protocol (BGP) load balancer. # Configuration for BGP typed load balancers. When set network_config.advanced_networking is automatically set to true.
"addressPools": [ # 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.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # 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).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
"asn": "A String", # Required. BGP autonomous system number (ASN) of the cluster. This field can be updated after cluster creation.
"bgpPeerConfigs": [ # Required. The list of BGP peers that the cluster will connect to. At least one peer must be configured for each control plane node. Control plane nodes will connect to these peers to advertise the control plane VIP. The Services load balancer also uses these peers by default. This field can be updated after cluster creation.
{ # BareMetalBgpPeerConfig represents configuration parameters for a Border Gateway Protocol (BGP) peer.
"asn": "A String", # Required. BGP autonomous system number (ASN) for the network that contains the external peer device.
"controlPlaneNodes": [ # The IP address of the control plane node that connects to the external peer. If you don't specify any control plane nodes, all control plane nodes can connect to the external peer. If you specify one or more IP addresses, only the nodes specified participate in peering sessions.
"A String",
],
"ipAddress": "A String", # Required. The IP address of the external peer device.
},
],
"loadBalancerNodePoolConfig": { # Specifies the load balancer's node pool configuration. # Specifies the node pool running data plane load balancing. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used for data plane load balancing.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # The generic configuration for a node pool running a load balancer.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"manualLbConfig": { # Represents configuration parameters for a manual load balancer. # Manually configured load balancers.
"enabled": True or False, # Whether manual load balancing is enabled.
},
"metalLbConfig": { # Represents configuration parameters for a MetalLB load balancer. # Configuration for MetalLB load balancers.
"addressPools": [ # 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.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # 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).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
"loadBalancerNodePoolConfig": { # Specifies the load balancer's node pool configuration. # Specifies the node pool running the load balancer. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used as the load balancer pool.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # The generic configuration for a node pool running a load balancer.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"portConfig": { # Specifies load balancer ports for the bare metal user cluster. # Configures the ports that the load balancer will listen on.
"controlPlaneLoadBalancerPort": 42, # The port that control plane hosted load balancers will listen on.
},
"vipConfig": { # Specifies the VIP config for the bare metal load balancer. # The VIPs used by the load balancer.
"controlPlaneVip": "A String", # The VIP which you previously set aside for the Kubernetes API of this bare metal user cluster.
"ingressVip": "A String", # The VIP which you previously set aside for ingress traffic into this bare metal user cluster.
},
},
"localName": "A String", # Output only. The object name of the bare metal user cluster 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 name 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. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl.
"maintenanceConfig": { # Specifies configurations to put bare metal nodes in and out of maintenance. # Maintenance configuration.
"maintenanceAddressCidrBlocks": [ # Required. All IPv4 address from these ranges will be placed into maintenance mode. Nodes in maintenance mode will be cordoned and drained. When both of these are true, the "baremetal.cluster.gke.io/maintenance" annotation will be set on the node resource.
"A String",
],
},
"maintenanceStatus": { # Represents the maintenance status of the bare metal user cluster. # Output only. Status of on-going maintenance tasks.
"machineDrainStatus": { # Represents the status of node machines that are undergoing drain operations. # The maintenance status of node machines.
"drainedMachines": [ # The list of drained machines.
{ # Represents a machine that is currently drained.
"nodeIp": "A String", # Drained machine IP address.
},
],
"drainingMachines": [ # The list of draning machines.
{ # Represents a machine that is currently draining.
"nodeIp": "A String", # Draining machine IP address.
"podCount": 42, # The count of pods yet to drain.
},
],
},
},
"name": "A String", # Immutable. The bare metal user cluster resource name.
"networkConfig": { # Specifies the cluster network configuration. # Required. Network configuration.
"advancedNetworking": True or False, # Enables the use of advanced Anthos networking features, such as Bundled Load Balancing with BGP or the egress NAT gateway. Setting configuration for advanced networking features will automatically set this flag.
"islandModeCidr": { # Specifies the cluster CIDR configuration while running in island mode. # Configuration for island mode CIDR. In an island-mode network, nodes have unique IP addresses, but pods don't have unique addresses across clusters. This doesn't cause problems because pods in one cluster never directly communicate with pods in another cluster. Instead, there are gateways that mediate between a pod in one cluster and a pod in another cluster.
"podAddressCidrBlocks": [ # Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field cannot be changed after creation.
"A String",
],
"serviceAddressCidrBlocks": [ # Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field is mutable after creation starting with version 1.15.
"A String",
],
},
"multipleNetworkInterfacesConfig": { # Specifies the multiple networking interfaces cluster configuration. # Configuration for multiple network interfaces.
"enabled": True or False, # Whether to enable multiple network interfaces for your pods. When set network_config.advanced_networking is automatically set to true.
},
"srIovConfig": { # Specifies the SR-IOV networking operator config. # Configuration for SR-IOV.
"enabled": True or False, # Whether to install the SR-IOV operator.
},
},
"nodeAccessConfig": { # Specifies the node access related settings for the bare metal user cluster. # Node access related configurations.
"loginUser": "A String", # LoginUser is the user name used to access node machines. It defaults to "root" if not set.
},
"nodeConfig": { # Specifies the workload node configurations. # Workload node configuration.
"containerRuntime": "A String", # Specifies which container runtime will be used.
"maxPodsPerNode": "A String", # The maximum number of pods a node can run. The size of the CIDR range assigned to the node will be derived from this parameter.
},
"osEnvironmentConfig": { # Specifies operating system settings for cluster provisioning. # OS environment related configurations.
"packageRepoExcluded": True or False, # Whether the package repo should not be included when initializing bare metal machines.
},
"proxy": { # Specifies the cluster proxy configuration. # Proxy configuration.
"noProxy": [ # A list of IPs, hostnames, and domains that should skip the proxy. Examples: ["127.0.0.1", "example.com", ".corp", "localhost"].
"A String",
],
"uri": "A String", # Required. Specifies the address of your proxy server. Examples: `http://domain` Do not provide credentials in the format `http://(username:password@)domain` these will be rejected by the server.
},
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the bare metal user cluster.
"securityConfig": { # Specifies the security related settings for the bare metal user cluster. # Security related setting configuration.
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # Configures user access to the user cluster.
"adminUsers": [ # 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.
{ # ClusterUser configures user principals for an RBAC policy.
"username": "A String", # Required. The name of the user, e.g. `my-gcp-id@gmail.com`.
},
],
},
},
"state": "A String", # Output only. The current state of the bare metal user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. Detailed cluster status.
"conditions": [ # ResourceCondition provide a standard mechanism for higher-level status reporting from controller.
{ # ResourceCondition provides a standard mechanism for higher-level status reporting from controller.
"lastTransitionTime": "A String", # Last time the condition transit from one status to another.
"message": "A String", # Human-readable message indicating details about last transition.
"reason": "A String", # Machine-readable message indicating details about last transition.
"state": "A String", # state of the condition.
"type": "A String", # Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)
},
],
"errorMessage": "A String", # 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": "A String", # Reflect current version of the resource.
"versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version.
"versions": [ # Shows the mapping of a given version to the number of machines under this version.
{ # Version describes the number of nodes at a given version under a resource.
"count": "A String", # Number of machines under the above version.
"version": "A String", # Resource version.
},
],
},
},
"storage": { # BareMetalStorageConfig specifies the cluster storage configuration. # Required. Storage configuration.
"lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation.
"path": "A String", # Required. The host machine path.
"storageClass": "A String", # Required. The StorageClass name that PVs will be created with.
},
"lvpShareConfig": { # Specifies the configs for local persistent volumes under a shared file system. # Required. Specifies the config for local PersistentVolumes backed by subdirectories in a shared filesystem. These subdirectores are automatically created during cluster creation.
"lvpConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Defines the machine path and storage class for the LVP Share.
"path": "A String", # Required. The host machine path.
"storageClass": "A String", # Required. The StorageClass name that PVs will be created with.
},
"sharedPathPvCount": 42, # The number of subdirectories to create under path.
},
},
"uid": "A String", # Output only. The unique identifier of the bare metal user cluster.
"updateTime": "A String", # Output only. The time when the bare metal user cluster was last updated.
"upgradePolicy": { # BareMetalClusterUpgradePolicy defines the cluster upgrade policy. # The cluster upgrade policy.
"pause": True or False, # Output only. Pause is used to show the upgrade pause status. It's view only for now.
"policy": "A String", # Specifies which upgrade policy to use.
},
"validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. The result of the preflight check.
"option": "A String", # Options used for the validation check
"scenario": "A String", # Output only. The scenario when the preflight checks were run.
"status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status.
"result": [ # Individual checks which failed as part of the Preflight check execution.
{ # ValidationCheckResult defines the details about the validation check.
"category": "A String", # The category of the validation.
"description": "A String", # The description of the validation check.
"details": "A String", # Detailed failure information, which might be unformatted.
"reason": "A String", # A human-readable message of the check failure.
"state": "A String", # The validation check state.
},
],
},
},
}
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
list(parent, allowMissing=None, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists bare metal clusters in a given project and location.
Args:
parent: string, Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" (required)
allowMissing: boolean, Optional. If true, return list of BareMetal Clusters including the ones that only exists in RMS.
filter: string, A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.
pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A token identifying a page of results the server should return.
view: string, View for bare metal Clusters. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.
Allowed values
CLUSTER_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
BASIC - Includes basic information of a cluster resource including cluster resource name and admin cluster membership.
FULL - Includes the complete configuration for bare metal cluster resource. This is the default value for ListBareMetalClustersRequest method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing bare metal Clusters.
"bareMetalClusters": [ # The list of bare metal Clusters.
{ # Resource that represents a bare metal user cluster.
"adminClusterMembership": "A String", # Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership.
"adminClusterName": "A String", # Output only. The resource name of the bare metal admin cluster managing this user cluster.
"annotations": { # Annotations on the bare metal 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.
"a_key": "A String",
},
"bareMetalVersion": "A String", # Required. The Anthos clusters on bare metal version for your user cluster.
"binaryAuthorization": { # Configuration for Binary Authorization. # Binary Authorization related configurations.
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"clusterOperations": { # Specifies the bare metal user cluster's observability infrastructure. # Cluster operations configuration.
"enableApplicationLogs": True or False, # Whether collection of application logs/metrics should be enabled (in addition to system logs/metrics).
},
"controlPlane": { # Specifies the control plane configuration. # Required. Control plane configuration.
"apiServerArgs": [ # Customizes the default API server args. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).
{ # Represents an arg name->value pair. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).
"argument": "A String", # Required. The argument name as it appears on the API Server command line, make sure to remove the leading dashes.
"value": "A String", # Required. The value of the arg as it will be passed to the API Server command line.
},
],
"controlPlaneNodePoolConfig": { # Specifies the control plane node pool configuration. # Required. Configures the node pool running the control plane.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # Required. The generic configuration for a node pool running the control plane.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"createTime": "A String", # Output only. The time when the bare metal user cluster was created.
"deleteTime": "A String", # Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty
"description": "A String", # A human readable description of this bare metal user cluster.
"endpoint": "A String", # Output only. The IP address of the bare metal user cluster's API server.
"etag": "A String", # Output only. 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": { # Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## # Output only. Fleet configuration for the cluster.
"membership": "A String", # Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as `projects//locations//memberships/`.
},
"loadBalancer": { # Specifies the load balancer configuration. # Required. Load balancer configuration.
"bgpLbConfig": { # BareMetalBgpLbConfig represents configuration parameters for a Border Gateway Protocol (BGP) load balancer. # Configuration for BGP typed load balancers. When set network_config.advanced_networking is automatically set to true.
"addressPools": [ # 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.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # 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).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
"asn": "A String", # Required. BGP autonomous system number (ASN) of the cluster. This field can be updated after cluster creation.
"bgpPeerConfigs": [ # Required. The list of BGP peers that the cluster will connect to. At least one peer must be configured for each control plane node. Control plane nodes will connect to these peers to advertise the control plane VIP. The Services load balancer also uses these peers by default. This field can be updated after cluster creation.
{ # BareMetalBgpPeerConfig represents configuration parameters for a Border Gateway Protocol (BGP) peer.
"asn": "A String", # Required. BGP autonomous system number (ASN) for the network that contains the external peer device.
"controlPlaneNodes": [ # The IP address of the control plane node that connects to the external peer. If you don't specify any control plane nodes, all control plane nodes can connect to the external peer. If you specify one or more IP addresses, only the nodes specified participate in peering sessions.
"A String",
],
"ipAddress": "A String", # Required. The IP address of the external peer device.
},
],
"loadBalancerNodePoolConfig": { # Specifies the load balancer's node pool configuration. # Specifies the node pool running data plane load balancing. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used for data plane load balancing.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # The generic configuration for a node pool running a load balancer.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"manualLbConfig": { # Represents configuration parameters for a manual load balancer. # Manually configured load balancers.
"enabled": True or False, # Whether manual load balancing is enabled.
},
"metalLbConfig": { # Represents configuration parameters for a MetalLB load balancer. # Configuration for MetalLB load balancers.
"addressPools": [ # 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.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # 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).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
"loadBalancerNodePoolConfig": { # Specifies the load balancer's node pool configuration. # Specifies the node pool running the load balancer. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used as the load balancer pool.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # The generic configuration for a node pool running a load balancer.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"portConfig": { # Specifies load balancer ports for the bare metal user cluster. # Configures the ports that the load balancer will listen on.
"controlPlaneLoadBalancerPort": 42, # The port that control plane hosted load balancers will listen on.
},
"vipConfig": { # Specifies the VIP config for the bare metal load balancer. # The VIPs used by the load balancer.
"controlPlaneVip": "A String", # The VIP which you previously set aside for the Kubernetes API of this bare metal user cluster.
"ingressVip": "A String", # The VIP which you previously set aside for ingress traffic into this bare metal user cluster.
},
},
"localName": "A String", # Output only. The object name of the bare metal user cluster 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 name 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. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl.
"maintenanceConfig": { # Specifies configurations to put bare metal nodes in and out of maintenance. # Maintenance configuration.
"maintenanceAddressCidrBlocks": [ # Required. All IPv4 address from these ranges will be placed into maintenance mode. Nodes in maintenance mode will be cordoned and drained. When both of these are true, the "baremetal.cluster.gke.io/maintenance" annotation will be set on the node resource.
"A String",
],
},
"maintenanceStatus": { # Represents the maintenance status of the bare metal user cluster. # Output only. Status of on-going maintenance tasks.
"machineDrainStatus": { # Represents the status of node machines that are undergoing drain operations. # The maintenance status of node machines.
"drainedMachines": [ # The list of drained machines.
{ # Represents a machine that is currently drained.
"nodeIp": "A String", # Drained machine IP address.
},
],
"drainingMachines": [ # The list of draning machines.
{ # Represents a machine that is currently draining.
"nodeIp": "A String", # Draining machine IP address.
"podCount": 42, # The count of pods yet to drain.
},
],
},
},
"name": "A String", # Immutable. The bare metal user cluster resource name.
"networkConfig": { # Specifies the cluster network configuration. # Required. Network configuration.
"advancedNetworking": True or False, # Enables the use of advanced Anthos networking features, such as Bundled Load Balancing with BGP or the egress NAT gateway. Setting configuration for advanced networking features will automatically set this flag.
"islandModeCidr": { # Specifies the cluster CIDR configuration while running in island mode. # Configuration for island mode CIDR. In an island-mode network, nodes have unique IP addresses, but pods don't have unique addresses across clusters. This doesn't cause problems because pods in one cluster never directly communicate with pods in another cluster. Instead, there are gateways that mediate between a pod in one cluster and a pod in another cluster.
"podAddressCidrBlocks": [ # Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field cannot be changed after creation.
"A String",
],
"serviceAddressCidrBlocks": [ # Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field is mutable after creation starting with version 1.15.
"A String",
],
},
"multipleNetworkInterfacesConfig": { # Specifies the multiple networking interfaces cluster configuration. # Configuration for multiple network interfaces.
"enabled": True or False, # Whether to enable multiple network interfaces for your pods. When set network_config.advanced_networking is automatically set to true.
},
"srIovConfig": { # Specifies the SR-IOV networking operator config. # Configuration for SR-IOV.
"enabled": True or False, # Whether to install the SR-IOV operator.
},
},
"nodeAccessConfig": { # Specifies the node access related settings for the bare metal user cluster. # Node access related configurations.
"loginUser": "A String", # LoginUser is the user name used to access node machines. It defaults to "root" if not set.
},
"nodeConfig": { # Specifies the workload node configurations. # Workload node configuration.
"containerRuntime": "A String", # Specifies which container runtime will be used.
"maxPodsPerNode": "A String", # The maximum number of pods a node can run. The size of the CIDR range assigned to the node will be derived from this parameter.
},
"osEnvironmentConfig": { # Specifies operating system settings for cluster provisioning. # OS environment related configurations.
"packageRepoExcluded": True or False, # Whether the package repo should not be included when initializing bare metal machines.
},
"proxy": { # Specifies the cluster proxy configuration. # Proxy configuration.
"noProxy": [ # A list of IPs, hostnames, and domains that should skip the proxy. Examples: ["127.0.0.1", "example.com", ".corp", "localhost"].
"A String",
],
"uri": "A String", # Required. Specifies the address of your proxy server. Examples: `http://domain` Do not provide credentials in the format `http://(username:password@)domain` these will be rejected by the server.
},
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the bare metal user cluster.
"securityConfig": { # Specifies the security related settings for the bare metal user cluster. # Security related setting configuration.
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # Configures user access to the user cluster.
"adminUsers": [ # 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.
{ # ClusterUser configures user principals for an RBAC policy.
"username": "A String", # Required. The name of the user, e.g. `my-gcp-id@gmail.com`.
},
],
},
},
"state": "A String", # Output only. The current state of the bare metal user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. Detailed cluster status.
"conditions": [ # ResourceCondition provide a standard mechanism for higher-level status reporting from controller.
{ # ResourceCondition provides a standard mechanism for higher-level status reporting from controller.
"lastTransitionTime": "A String", # Last time the condition transit from one status to another.
"message": "A String", # Human-readable message indicating details about last transition.
"reason": "A String", # Machine-readable message indicating details about last transition.
"state": "A String", # state of the condition.
"type": "A String", # Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)
},
],
"errorMessage": "A String", # 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": "A String", # Reflect current version of the resource.
"versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version.
"versions": [ # Shows the mapping of a given version to the number of machines under this version.
{ # Version describes the number of nodes at a given version under a resource.
"count": "A String", # Number of machines under the above version.
"version": "A String", # Resource version.
},
],
},
},
"storage": { # BareMetalStorageConfig specifies the cluster storage configuration. # Required. Storage configuration.
"lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation.
"path": "A String", # Required. The host machine path.
"storageClass": "A String", # Required. The StorageClass name that PVs will be created with.
},
"lvpShareConfig": { # Specifies the configs for local persistent volumes under a shared file system. # Required. Specifies the config for local PersistentVolumes backed by subdirectories in a shared filesystem. These subdirectores are automatically created during cluster creation.
"lvpConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Defines the machine path and storage class for the LVP Share.
"path": "A String", # Required. The host machine path.
"storageClass": "A String", # Required. The StorageClass name that PVs will be created with.
},
"sharedPathPvCount": 42, # The number of subdirectories to create under path.
},
},
"uid": "A String", # Output only. The unique identifier of the bare metal user cluster.
"updateTime": "A String", # Output only. The time when the bare metal user cluster was last updated.
"upgradePolicy": { # BareMetalClusterUpgradePolicy defines the cluster upgrade policy. # The cluster upgrade policy.
"pause": True or False, # Output only. Pause is used to show the upgrade pause status. It's view only for now.
"policy": "A String", # Specifies which upgrade policy to use.
},
"validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. The result of the preflight check.
"option": "A String", # Options used for the validation check
"scenario": "A String", # Output only. The scenario when the preflight checks were run.
"status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status.
"result": [ # Individual checks which failed as part of the Preflight check execution.
{ # ValidationCheckResult defines the details about the validation check.
"category": "A String", # The category of the validation.
"description": "A String", # The description of the validation check.
"details": "A String", # Detailed failure information, which might be unformatted.
"reason": "A String", # A human-readable message of the check failure.
"state": "A String", # The validation check state.
},
],
},
},
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body, allowMissing=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single bare metal Cluster.
Args:
name: string, Immutable. The bare metal user cluster resource name. (required)
body: object, The request body.
The object takes the form of:
{ # Resource that represents a bare metal user cluster.
"adminClusterMembership": "A String", # Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership.
"adminClusterName": "A String", # Output only. The resource name of the bare metal admin cluster managing this user cluster.
"annotations": { # Annotations on the bare metal 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.
"a_key": "A String",
},
"bareMetalVersion": "A String", # Required. The Anthos clusters on bare metal version for your user cluster.
"binaryAuthorization": { # Configuration for Binary Authorization. # Binary Authorization related configurations.
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"clusterOperations": { # Specifies the bare metal user cluster's observability infrastructure. # Cluster operations configuration.
"enableApplicationLogs": True or False, # Whether collection of application logs/metrics should be enabled (in addition to system logs/metrics).
},
"controlPlane": { # Specifies the control plane configuration. # Required. Control plane configuration.
"apiServerArgs": [ # Customizes the default API server args. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).
{ # Represents an arg name->value pair. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).
"argument": "A String", # Required. The argument name as it appears on the API Server command line, make sure to remove the leading dashes.
"value": "A String", # Required. The value of the arg as it will be passed to the API Server command line.
},
],
"controlPlaneNodePoolConfig": { # Specifies the control plane node pool configuration. # Required. Configures the node pool running the control plane.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # Required. The generic configuration for a node pool running the control plane.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"createTime": "A String", # Output only. The time when the bare metal user cluster was created.
"deleteTime": "A String", # Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty
"description": "A String", # A human readable description of this bare metal user cluster.
"endpoint": "A String", # Output only. The IP address of the bare metal user cluster's API server.
"etag": "A String", # Output only. 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": { # Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## # Output only. Fleet configuration for the cluster.
"membership": "A String", # Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as `projects//locations//memberships/`.
},
"loadBalancer": { # Specifies the load balancer configuration. # Required. Load balancer configuration.
"bgpLbConfig": { # BareMetalBgpLbConfig represents configuration parameters for a Border Gateway Protocol (BGP) load balancer. # Configuration for BGP typed load balancers. When set network_config.advanced_networking is automatically set to true.
"addressPools": [ # 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.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # 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).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
"asn": "A String", # Required. BGP autonomous system number (ASN) of the cluster. This field can be updated after cluster creation.
"bgpPeerConfigs": [ # Required. The list of BGP peers that the cluster will connect to. At least one peer must be configured for each control plane node. Control plane nodes will connect to these peers to advertise the control plane VIP. The Services load balancer also uses these peers by default. This field can be updated after cluster creation.
{ # BareMetalBgpPeerConfig represents configuration parameters for a Border Gateway Protocol (BGP) peer.
"asn": "A String", # Required. BGP autonomous system number (ASN) for the network that contains the external peer device.
"controlPlaneNodes": [ # The IP address of the control plane node that connects to the external peer. If you don't specify any control plane nodes, all control plane nodes can connect to the external peer. If you specify one or more IP addresses, only the nodes specified participate in peering sessions.
"A String",
],
"ipAddress": "A String", # Required. The IP address of the external peer device.
},
],
"loadBalancerNodePoolConfig": { # Specifies the load balancer's node pool configuration. # Specifies the node pool running data plane load balancing. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used for data plane load balancing.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # The generic configuration for a node pool running a load balancer.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"manualLbConfig": { # Represents configuration parameters for a manual load balancer. # Manually configured load balancers.
"enabled": True or False, # Whether manual load balancing is enabled.
},
"metalLbConfig": { # Represents configuration parameters for a MetalLB load balancer. # Configuration for MetalLB load balancers.
"addressPools": [ # 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.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # 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).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
"loadBalancerNodePoolConfig": { # Specifies the load balancer's node pool configuration. # Specifies the node pool running the load balancer. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used as the load balancer pool.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # The generic configuration for a node pool running a load balancer.
"kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). # The modifiable kubelet configurations for the bare metal machines.
"registryBurst": 42, # The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.
"registryPullQps": 42, # The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.
"serializeImagePullsDisabled": True or False, # Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.
},
"labels": { # The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeConfigs": [ # Required. The list of machine addresses in the bare metal node pool.
{ # BareMetalNodeConfig lists machine addresses to access Nodes.
"labels": { # The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"nodeIp": "A String", # The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1
},
],
"operatingSystem": "A String", # Specifies the nodes operating system (default: LINUX).
"taints": [ # The initial taints assigned to nodes of this node pool.
{ # NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.
"effect": "A String", # The taint effect.
"key": "A String", # Key associated with the effect.
"value": "A String", # Value associated with the effect.
},
],
},
},
},
"portConfig": { # Specifies load balancer ports for the bare metal user cluster. # Configures the ports that the load balancer will listen on.
"controlPlaneLoadBalancerPort": 42, # The port that control plane hosted load balancers will listen on.
},
"vipConfig": { # Specifies the VIP config for the bare metal load balancer. # The VIPs used by the load balancer.
"controlPlaneVip": "A String", # The VIP which you previously set aside for the Kubernetes API of this bare metal user cluster.
"ingressVip": "A String", # The VIP which you previously set aside for ingress traffic into this bare metal user cluster.
},
},
"localName": "A String", # Output only. The object name of the bare metal user cluster 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 name 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. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl.
"maintenanceConfig": { # Specifies configurations to put bare metal nodes in and out of maintenance. # Maintenance configuration.
"maintenanceAddressCidrBlocks": [ # Required. All IPv4 address from these ranges will be placed into maintenance mode. Nodes in maintenance mode will be cordoned and drained. When both of these are true, the "baremetal.cluster.gke.io/maintenance" annotation will be set on the node resource.
"A String",
],
},
"maintenanceStatus": { # Represents the maintenance status of the bare metal user cluster. # Output only. Status of on-going maintenance tasks.
"machineDrainStatus": { # Represents the status of node machines that are undergoing drain operations. # The maintenance status of node machines.
"drainedMachines": [ # The list of drained machines.
{ # Represents a machine that is currently drained.
"nodeIp": "A String", # Drained machine IP address.
},
],
"drainingMachines": [ # The list of draning machines.
{ # Represents a machine that is currently draining.
"nodeIp": "A String", # Draining machine IP address.
"podCount": 42, # The count of pods yet to drain.
},
],
},
},
"name": "A String", # Immutable. The bare metal user cluster resource name.
"networkConfig": { # Specifies the cluster network configuration. # Required. Network configuration.
"advancedNetworking": True or False, # Enables the use of advanced Anthos networking features, such as Bundled Load Balancing with BGP or the egress NAT gateway. Setting configuration for advanced networking features will automatically set this flag.
"islandModeCidr": { # Specifies the cluster CIDR configuration while running in island mode. # Configuration for island mode CIDR. In an island-mode network, nodes have unique IP addresses, but pods don't have unique addresses across clusters. This doesn't cause problems because pods in one cluster never directly communicate with pods in another cluster. Instead, there are gateways that mediate between a pod in one cluster and a pod in another cluster.
"podAddressCidrBlocks": [ # Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field cannot be changed after creation.
"A String",
],
"serviceAddressCidrBlocks": [ # Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field is mutable after creation starting with version 1.15.
"A String",
],
},
"multipleNetworkInterfacesConfig": { # Specifies the multiple networking interfaces cluster configuration. # Configuration for multiple network interfaces.
"enabled": True or False, # Whether to enable multiple network interfaces for your pods. When set network_config.advanced_networking is automatically set to true.
},
"srIovConfig": { # Specifies the SR-IOV networking operator config. # Configuration for SR-IOV.
"enabled": True or False, # Whether to install the SR-IOV operator.
},
},
"nodeAccessConfig": { # Specifies the node access related settings for the bare metal user cluster. # Node access related configurations.
"loginUser": "A String", # LoginUser is the user name used to access node machines. It defaults to "root" if not set.
},
"nodeConfig": { # Specifies the workload node configurations. # Workload node configuration.
"containerRuntime": "A String", # Specifies which container runtime will be used.
"maxPodsPerNode": "A String", # The maximum number of pods a node can run. The size of the CIDR range assigned to the node will be derived from this parameter.
},
"osEnvironmentConfig": { # Specifies operating system settings for cluster provisioning. # OS environment related configurations.
"packageRepoExcluded": True or False, # Whether the package repo should not be included when initializing bare metal machines.
},
"proxy": { # Specifies the cluster proxy configuration. # Proxy configuration.
"noProxy": [ # A list of IPs, hostnames, and domains that should skip the proxy. Examples: ["127.0.0.1", "example.com", ".corp", "localhost"].
"A String",
],
"uri": "A String", # Required. Specifies the address of your proxy server. Examples: `http://domain` Do not provide credentials in the format `http://(username:password@)domain` these will be rejected by the server.
},
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the bare metal user cluster.
"securityConfig": { # Specifies the security related settings for the bare metal user cluster. # Security related setting configuration.
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # Configures user access to the user cluster.
"adminUsers": [ # 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.
{ # ClusterUser configures user principals for an RBAC policy.
"username": "A String", # Required. The name of the user, e.g. `my-gcp-id@gmail.com`.
},
],
},
},
"state": "A String", # Output only. The current state of the bare metal user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. Detailed cluster status.
"conditions": [ # ResourceCondition provide a standard mechanism for higher-level status reporting from controller.
{ # ResourceCondition provides a standard mechanism for higher-level status reporting from controller.
"lastTransitionTime": "A String", # Last time the condition transit from one status to another.
"message": "A String", # Human-readable message indicating details about last transition.
"reason": "A String", # Machine-readable message indicating details about last transition.
"state": "A String", # state of the condition.
"type": "A String", # Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)
},
],
"errorMessage": "A String", # 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": "A String", # Reflect current version of the resource.
"versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version.
"versions": [ # Shows the mapping of a given version to the number of machines under this version.
{ # Version describes the number of nodes at a given version under a resource.
"count": "A String", # Number of machines under the above version.
"version": "A String", # Resource version.
},
],
},
},
"storage": { # BareMetalStorageConfig specifies the cluster storage configuration. # Required. Storage configuration.
"lvpNodeMountsConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation.
"path": "A String", # Required. The host machine path.
"storageClass": "A String", # Required. The StorageClass name that PVs will be created with.
},
"lvpShareConfig": { # Specifies the configs for local persistent volumes under a shared file system. # Required. Specifies the config for local PersistentVolumes backed by subdirectories in a shared filesystem. These subdirectores are automatically created during cluster creation.
"lvpConfig": { # Specifies the configs for local persistent volumes (PVs). # Required. Defines the machine path and storage class for the LVP Share.
"path": "A String", # Required. The host machine path.
"storageClass": "A String", # Required. The StorageClass name that PVs will be created with.
},
"sharedPathPvCount": 42, # The number of subdirectories to create under path.
},
},
"uid": "A String", # Output only. The unique identifier of the bare metal user cluster.
"updateTime": "A String", # Output only. The time when the bare metal user cluster was last updated.
"upgradePolicy": { # BareMetalClusterUpgradePolicy defines the cluster upgrade policy. # The cluster upgrade policy.
"pause": True or False, # Output only. Pause is used to show the upgrade pause status. It's view only for now.
"policy": "A String", # Specifies which upgrade policy to use.
},
"validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. The result of the preflight check.
"option": "A String", # Options used for the validation check
"scenario": "A String", # Output only. The scenario when the preflight checks were run.
"status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status.
"result": [ # Individual checks which failed as part of the Preflight check execution.
{ # ValidationCheckResult defines the details about the validation check.
"category": "A String", # The category of the validation.
"description": "A String", # The description of the validation check.
"details": "A String", # Detailed failure information, which might be unformatted.
"reason": "A String", # A human-readable message of the check failure.
"state": "A String", # The validation check state.
},
],
},
},
}
allowMissing: boolean, If set to true, and the bare metal cluster is not found, the request will create a new bare metal cluster with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the BareMetalCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the BareMetalCluster message will be updated. Empty fields will be ignored unless a field mask is used.
validateOnly: boolean, Validate the request without actually doing any updates.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
queryVersionConfig(parent, createConfig_adminClusterMembership=None, createConfig_adminClusterName=None, upgradeConfig_clusterName=None, x__xgafv=None)
Queries the bare metal user cluster version config.
Args:
parent: string, Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}" (required)
createConfig_adminClusterMembership: string, The admin cluster membership. This is the full resource name of the admin cluster's fleet membership. Format: "projects/{project}/locations/{location}/memberships/{membership}"
createConfig_adminClusterName: string, The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}"
upgradeConfig_clusterName: string, The user cluster resource name. This is the full resource name of the user cluster resource. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}"
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for querying bare metal admin cluster version config.
"versions": [ # List of available versions to install or to upgrade to.
{ # Contains information about a specific Anthos on bare metal version.
"dependencies": [ # The list of upgrade dependencies for this version.
{ # UpgradeDependency represents a dependency when upgrading a resource.
"currentVersion": "A String", # Current version of the dependency e.g. 1.15.0.
"membership": "A String", # Membership names are formatted as `projects//locations//memberships/`.
"resourceName": "A String", # Resource name of the dependency.
"targetVersion": "A String", # Target version of the dependency e.g. 1.16.1. This is the version the dependency needs to be upgraded to before a resource can be upgraded.
},
],
"hasDependencies": True or False, # If set, the cluster dependencies (e.g. the admin cluster, other user clusters managed by the same admin cluster, version skew policy, etc) must be upgraded before this version can be installed or upgraded to.
"version": "A String", # Version number e.g. 1.13.1.
},
],
}
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}
unenroll(name, allowMissing=None, etag=None, force=None, validateOnly=None, x__xgafv=None)
Unenrolls an existing bare metal user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.
Args:
name: string, Required. Name of the bare metal user cluster to be unenrolled. Format: "projects/{project}/locations/{location}/bareMetalClusters/{cluster}" (required)
allowMissing: boolean, If set to true, and the bare metal cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
etag: string, The current etag of the bare metal Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
force: boolean, This is required if the cluster has any associated node pools. When set, any child node pools will also be unenrolled.
validateOnly: boolean, Validate the request without actually doing any updates.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}