enroll(parent, body=None, x__xgafv=None)
Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.
+get(name, view=None, x__xgafv=None)
Gets details of a single bare metal node pool.
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.
- list(parent, pageSize=None, pageToken=None, x__xgafv=None)
list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists bare metal node pools in a given project, location and bare metal cluster.
Retrieves the next page of results.
- patch(name, body, updateMask=None, validateOnly=None, x__xgafv=None)
patch(name, body, allowMissing=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single bare metal node pool.
setIamPolicy(resource, body=None, x__xgafv=None)
get(name, x__xgafv=None)
+ get(name, view=None, x__xgafv=None)
Gets details of a single bare metal node pool.
Args:
name: string, Required. The name of the node pool to retrieve. projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool} (required)
+ view: string, View for bare metal node pool. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.
+ Allowed values
+ NODE_POOL_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
+ BASIC - Includes basic information of a node pool resource including node pool resource name.
+ FULL - Includes the complete configuration for bare metal node pool resource. This is the default value for GetBareMetalNodePoolRequest method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -320,7 +325,7 @@ Method Details
"etag": "A String", # 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.
"name": "A String", # Immutable. The bare metal node pool resource name.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # Required. Node pool configuration.
- "kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for baremetal 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 baremetal machines.
+ "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.
@@ -400,13 +405,18 @@ Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists bare metal node pools in a given project, location and bare metal cluster.
Args:
parent: string, Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/bareMetalClusters/{bareMetalCluster} (required)
pageSize: integer, The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous `ListBareMetalNodePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBareMetalNodePools` must match the call that provided the page token.
+ view: string, View for bare metal node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.
+ Allowed values
+ NODE_POOL_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
+ BASIC - Includes basic information of a node pool resource including node pool resource name.
+ FULL - Includes the complete configuration for bare metal node pool resource. This is the default value for ListBareMetalNodePoolsRequest method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -427,7 +437,7 @@ Method Details
"etag": "A String", # 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.
"name": "A String", # Immutable. The bare metal node pool resource name.
"nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # Required. Node pool configuration.
- "kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for baremetal 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 baremetal machines.
+ "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.
@@ -492,7 +502,7 @@ Method Details
patch(name, body, updateMask=None, validateOnly=None, x__xgafv=None)
+ patch(name, body, allowMissing=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single bare metal node pool. Args: @@ -510,7 +520,7 @@Method Details
"etag": "A String", # 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. "name": "A String", # Immutable. The bare metal node pool resource name. "nodePoolConfig": { # BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. # Required. Node pool configuration. - "kubeletConfig": { # KubeletConfig defines the modifiable kubelet configurations for baremetal 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 baremetal machines. + "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. @@ -553,6 +563,7 @@Method Details
"updateTime": "A String", # Output only. The time at which this bare metal node pool was last updated. } + allowMissing: boolean, If set to true, and the bare metal node pool is not found, the request will create a new bare metal node pool 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 BareMetalNodePool 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 BareMetalNodePool 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. diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.html index 8d19ef442b0..87b01c7af86 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.html @@ -157,7 +157,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -216,7 +216,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -259,7 +259,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -352,7 +352,7 @@Method Details
"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": [ # Required. For VMware user, bare metal user and standalone clusters, users that will be granted the cluster-admin role on the cluster, providing full access to the cluster. For bare metal Admin cluster, users will be granted the view role, which is a view only access. + "adminUsers": [ # Required. 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`. }, @@ -557,7 +557,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -616,7 +616,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -659,7 +659,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -752,7 +752,7 @@Method Details
"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": [ # Required. For VMware user, bare metal user and standalone clusters, users that will be granted the cluster-admin role on the cluster, providing full access to the cluster. For bare metal Admin cluster, users will be granted the view role, which is a view only access. + "adminUsers": [ # Required. 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`. }, @@ -883,7 +883,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -942,7 +942,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -985,7 +985,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -1078,7 +1078,7 @@Method Details
"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": [ # Required. For VMware user, bare metal user and standalone clusters, users that will be granted the cluster-admin role on the cluster, providing full access to the cluster. For bare metal Admin cluster, users will be granted the view role, which is a view only access. + "adminUsers": [ # Required. 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`. }, @@ -1179,7 +1179,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -1238,7 +1238,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -1281,7 +1281,7 @@Method Details
], "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 baremetal 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 baremetal machines. + "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. @@ -1374,7 +1374,7 @@Method Details
"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": [ # Required. For VMware user, bare metal user and standalone clusters, users that will be granted the cluster-admin role on the cluster, providing full access to the cluster. For bare metal Admin cluster, users will be granted the view role, which is a view only access. + "adminUsers": [ # Required. 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`. }, diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalStandaloneClusters.bareMetalStandaloneNodePools.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalStandaloneClusters.bareMetalStandaloneNodePools.html new file mode 100644 index 00000000000..84966e00481 --- /dev/null +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalStandaloneClusters.bareMetalStandaloneNodePools.html @@ -0,0 +1,132 @@ + + + +Anthos On-Prem API . projects . locations . bareMetalStandaloneClusters . bareMetalStandaloneNodePools
+Instance Methods
++
+close()Close httplib2 connections.
++
+enroll(parent, body=None, x__xgafv=None)Enrolls an existing bare metal standalone node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing standalone node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalStandaloneClusters.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalStandaloneClusters.html new file mode 100644 index 00000000000..02576d64dc2 --- /dev/null +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalStandaloneClusters.html @@ -0,0 +1,91 @@ + + + +enroll(parent, body=None, x__xgafv=None)+Enrolls an existing bare metal standalone node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing standalone node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created. + +Args: + parent: string, Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalStandaloneClusters/{cluster} (required) + body: object, The request body. + The object takes the form of: + +{ # Message for enrolling an existing bare metal standalone node pool to the GKE on-prem API. + "bareMetalStandaloneNodePoolId": "A String", # User provided OnePlatform identifier that is used as part of the resource name. This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format. + "validateOnly": True or False, # If set, only validate the request, but do not actually enroll the node pool. +} + + 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 response of the operation in case of success. 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. + }, +}+Anthos On-Prem API . projects . locations . bareMetalStandaloneClusters
+Instance Methods
++
+bareMetalStandaloneNodePools()+Returns the bareMetalStandaloneNodePools Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/gkeonprem_v1.projects.locations.html b/docs/dyn/gkeonprem_v1.projects.locations.html index ed83f9e080e..d02731030cf 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.html @@ -84,6 +84,11 @@close()+Close httplib2 connections.+Instance Methods
Returns the bareMetalClusters Resource.
++
+bareMetalStandaloneClusters()+Returns the bareMetalStandaloneClusters Resource.
+ diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html index 73196561063..aa9db468e7a 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html @@ -86,7 +86,7 @@Instance Methods
enroll(parent, body=None, x__xgafv=None)Enrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.
+get(name, view=None, x__xgafv=None)Gets details of a single VMware admin cluster.
@@ -125,7 +125,6 @@
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)Method Details
The object takes the form of: { # Message for enrolling an existing VMware admin cluster to the GKE on-prem API. - "localName": "A String", # The object name of the VMware OnPremAdminCluster 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 vmware_admin_cluster_id. Otherwise, it must match the object name of the VMware OnPremAdminCluster custom resource. It is not modifiable outside / beyond the enrollment operation. "membership": "A String", # Required. This is the full resource name of this admin cluster's fleet membership. "vmwareAdminClusterId": "A String", # User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all GKE on-prem clusters within a project and location and will return a 409 if the cluster already exists. This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format. } @@ -160,11 +159,16 @@Method Details
get(name, x__xgafv=None)
+ get(name, view=None, x__xgafv=None)
Gets details of a single VMware admin cluster.
Args:
name: string, Required. Name of the VMware admin cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{vmware_admin_cluster}" (required)
+ view: string, View for VMware admin cluster. When `BASIC` is specified, only the cluster resource name and 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 membership.
+ FULL - Includes the complete configuration for VMware admin cluster resource. This is the default value for GetVmwareAdminClusterRequest method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.html
index 1cf8b1b53c1..74fde7b6d85 100644
--- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.html
+++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.html
@@ -89,7 +89,7 @@ Instance Methods
Close httplib2 connections.
create(parent, body, validateOnly=None, vmwareClusterId=None, x__xgafv=None)
-Creates a new VMware cluster in a given project and location.
+Creates a new VMware user cluster in a given project and location.
Deletes a single VMware Cluster.
@@ -131,7 +131,7 @@ Method Details
create(parent, body, validateOnly=None, vmwareClusterId=None, x__xgafv=None)
- Creates a new VMware cluster in a given project and location.
+ Creates a new VMware user cluster in a given project and location.
Args:
parent: string, Required. The parent of the project and location where this cluster is created in. Format: "projects/{project}/locations/{location}" (required)
@@ -148,7 +148,7 @@ Method Details
"aagConfigDisabled": True or False, # Spread nodes across at least three physical hosts (requires at least three hosts). Enabled by default.
},
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # RBAC policy that will be applied and managed by the Anthos On-Prem API.
- "adminUsers": [ # Required. For VMware user, bare metal user and standalone clusters, users that will be granted the cluster-admin role on the cluster, providing full access to the cluster. For bare metal Admin cluster, users will be granted the view role, which is a view only access.
+ "adminUsers": [ # Required. 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`.
},
@@ -262,7 +262,7 @@ Method Details
},
"vcenterNetwork": "A String", # Output only. vcenter_network specifies vCenter network name. Inherited from the admin cluster.
},
- "onPremVersion": "A String", # The Anthos clusters on the VMware version for your user cluster. Defaults to the admin cluster version.
+ "onPremVersion": "A String", # Required. The Anthos clusters on the VMware version for your user cluster.
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware user cluster.
"state": "A String", # Output only. The current state of VMware user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state.
@@ -454,7 +454,7 @@ Method Details
"aagConfigDisabled": True or False, # Spread nodes across at least three physical hosts (requires at least three hosts). Enabled by default.
},
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # RBAC policy that will be applied and managed by the Anthos On-Prem API.
- "adminUsers": [ # Required. For VMware user, bare metal user and standalone clusters, users that will be granted the cluster-admin role on the cluster, providing full access to the cluster. For bare metal Admin cluster, users will be granted the view role, which is a view only access.
+ "adminUsers": [ # Required. 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`.
},
@@ -568,7 +568,7 @@ Method Details
},
"vcenterNetwork": "A String", # Output only. vcenter_network specifies vCenter network name. Inherited from the admin cluster.
},
- "onPremVersion": "A String", # The Anthos clusters on the VMware version for your user cluster. Defaults to the admin cluster version.
+ "onPremVersion": "A String", # Required. The Anthos clusters on the VMware version for your user cluster.
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware user cluster.
"state": "A String", # Output only. The current state of VMware user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state.
@@ -689,7 +689,7 @@ Method Details
"aagConfigDisabled": True or False, # Spread nodes across at least three physical hosts (requires at least three hosts). Enabled by default.
},
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # RBAC policy that will be applied and managed by the Anthos On-Prem API.
- "adminUsers": [ # Required. For VMware user, bare metal user and standalone clusters, users that will be granted the cluster-admin role on the cluster, providing full access to the cluster. For bare metal Admin cluster, users will be granted the view role, which is a view only access.
+ "adminUsers": [ # Required. 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`.
},
@@ -803,7 +803,7 @@ Method Details
},
"vcenterNetwork": "A String", # Output only. vcenter_network specifies vCenter network name. Inherited from the admin cluster.
},
- "onPremVersion": "A String", # The Anthos clusters on the VMware version for your user cluster. Defaults to the admin cluster version.
+ "onPremVersion": "A String", # Required. The Anthos clusters on the VMware version for your user cluster.
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware user cluster.
"state": "A String", # Output only. The current state of VMware user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state.
@@ -886,7 +886,7 @@ Method Details
"aagConfigDisabled": True or False, # Spread nodes across at least three physical hosts (requires at least three hosts). Enabled by default.
},
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # RBAC policy that will be applied and managed by the Anthos On-Prem API.
- "adminUsers": [ # Required. For VMware user, bare metal user and standalone clusters, users that will be granted the cluster-admin role on the cluster, providing full access to the cluster. For bare metal Admin cluster, users will be granted the view role, which is a view only access.
+ "adminUsers": [ # Required. 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`.
},
@@ -1000,7 +1000,7 @@ Method Details
},
"vcenterNetwork": "A String", # Output only. vcenter_network specifies vCenter network name. Inherited from the admin cluster.
},
- "onPremVersion": "A String", # The Anthos clusters on the VMware version for your user cluster. Defaults to the admin cluster version.
+ "onPremVersion": "A String", # Required. The Anthos clusters on the VMware version for your user cluster.
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware user cluster.
"state": "A String", # Output only. The current state of VMware user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state.
diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.html
index 7eea7a20e31..1f66e403c68 100644
--- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.html
+++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.html
@@ -92,13 +92,13 @@ Instance Methods
enroll(parent, body=None, x__xgafv=None)
Enrolls a VMware node pool to Anthos On-Prem API
+ get(name, view=None, x__xgafv=None)
Gets details of a single VMware node pool.
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.
- list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists VMware node pools in a given project, location and VMWare cluster.
@@ -113,7 +113,7 @@ Instance Methods
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, etag=None, validateOnly=None, x__xgafv=None)
+ unenroll(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)
Unenrolls a VMware node pool to Anthos On-Prem API
Method Details
@@ -303,11 +303,16 @@ Method Details
- get(name, x__xgafv=None)
+ get(name, view=None, x__xgafv=None)
Gets details of a single VMware node pool.
Args:
name: string, Required. The name of the node pool to retrieve. projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool} (required)
+ view: string, View for VMware node pool. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.
+ Allowed values
+ NODE_POOL_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
+ BASIC - Includes basic information of a node pool resource including node pool resource name.
+ FULL - Includes the complete configuration for VMware node pool resource. This is the default value for GetVmwareNodePoolRequest method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -413,13 +418,18 @@ Method Details
- list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists VMware node pools in a given project, location and VMWare cluster.
Args:
parent: string, Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/vmwareClusters/{vmwareCluster} (required)
pageSize: integer, The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous `ListVmwareNodePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListVmwareNodePools` must match the call that provided the page token.
+ view: string, View for VMware node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.
+ Allowed values
+ NODE_POOL_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
+ BASIC - Includes basic information of a node pool resource including node pool resource name.
+ FULL - Includes the complete configuration for VMware node pool resource. This is the default value for ListVmwareNodePoolsRequest method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -700,11 +710,12 @@ Method Details
- unenroll(name, etag=None, validateOnly=None, x__xgafv=None)
+ unenroll(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)
Unenrolls a VMware node pool to Anthos On-Prem API
Args:
name: string, Required. The name of the node pool to unenroll. Format: projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool} (required)
+ allowMissing: boolean, If set to true, and the VMware node pool 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 VMware node pool. If an etag is provided and does not match the current etag of node pool, deletion will be blocked and an ABORTED error will be returned.
validateOnly: boolean, If set, only validate the request, but do not actually unenroll the node pool.
x__xgafv: string, V1 error format.
diff --git a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json
index af11fcf4872..c994766d52a 100644
--- a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json
+++ b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json
@@ -1166,6 +1166,21 @@
"pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$",
"required": true,
"type": "string"
+ },
+ "view": {
+ "description": "View for bare metal node pool. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.",
+ "enum": [
+ "NODE_POOL_VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "If the value is not set, the default `FULL` view is used.",
+ "Includes basic information of a node pool resource including node pool resource name.",
+ "Includes the complete configuration for bare metal node pool resource. This is the default value for GetBareMetalNodePoolRequest method."
+ ],
+ "location": "query",
+ "type": "string"
}
},
"path": "v1/{+name}",
@@ -1233,6 +1248,21 @@
"pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$",
"required": true,
"type": "string"
+ },
+ "view": {
+ "description": "View for bare metal node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.",
+ "enum": [
+ "NODE_POOL_VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "If the value is not set, the default `FULL` view is used.",
+ "Includes basic information of a node pool resource including node pool resource name.",
+ "Includes the complete configuration for bare metal node pool resource. This is the default value for ListBareMetalNodePoolsRequest method."
+ ],
+ "location": "query",
+ "type": "string"
}
},
"path": "v1/{+parent}/bareMetalNodePools",
@@ -1252,6 +1282,11 @@
"name"
],
"parameters": {
+ "allowMissing": {
+ "description": "If set to true, and the bare metal node pool is not found, the request will create a new bare metal node pool with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.",
+ "location": "query",
+ "type": "boolean"
+ },
"name": {
"description": "Immutable. The bare metal node pool resource name.",
"location": "path",
@@ -1524,6 +1559,42 @@
}
}
},
+ "bareMetalStandaloneClusters": {
+ "resources": {
+ "bareMetalStandaloneNodePools": {
+ "methods": {
+ "enroll": {
+ "description": "Enrolls an existing bare metal standalone node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing standalone node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalStandaloneClusters/{bareMetalStandaloneClustersId}/bareMetalStandaloneNodePools:enroll",
+ "httpMethod": "POST",
+ "id": "gkeonprem.projects.locations.bareMetalStandaloneClusters.bareMetalStandaloneNodePools.enroll",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalStandaloneClusters/{cluster}",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalStandaloneClusters/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/bareMetalStandaloneNodePools:enroll",
+ "request": {
+ "$ref": "EnrollBareMetalStandaloneNodePoolRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ },
"operations": {
"methods": {
"cancel": {
@@ -1692,6 +1763,21 @@
"pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$",
"required": true,
"type": "string"
+ },
+ "view": {
+ "description": "View for VMware admin cluster. When `BASIC` is specified, only the cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.",
+ "enum": [
+ "CLUSTER_VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "If the value is not set, the default `FULL` view is used.",
+ "Includes basic information of a cluster resource including cluster resource name and membership.",
+ "Includes the complete configuration for VMware admin cluster resource. This is the default value for GetVmwareAdminClusterRequest method."
+ ],
+ "location": "query",
+ "type": "string"
}
},
"path": "v1/{+name}",
@@ -1996,7 +2082,7 @@
"vmwareClusters": {
"methods": {
"create": {
- "description": "Creates a new VMware cluster in a given project and location.",
+ "description": "Creates a new VMware user cluster in a given project and location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters",
"httpMethod": "POST",
"id": "gkeonprem.projects.locations.vmwareClusters.create",
@@ -2618,6 +2704,21 @@
"pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$",
"required": true,
"type": "string"
+ },
+ "view": {
+ "description": "View for VMware node pool. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.",
+ "enum": [
+ "NODE_POOL_VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "If the value is not set, the default `FULL` view is used.",
+ "Includes basic information of a node pool resource including node pool resource name.",
+ "Includes the complete configuration for VMware node pool resource. This is the default value for GetVmwareNodePoolRequest method."
+ ],
+ "location": "query",
+ "type": "string"
}
},
"path": "v1/{+name}",
@@ -2685,6 +2786,21 @@
"pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$",
"required": true,
"type": "string"
+ },
+ "view": {
+ "description": "View for VMware node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.",
+ "enum": [
+ "NODE_POOL_VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "enumDescriptions": [
+ "If the value is not set, the default `FULL` view is used.",
+ "Includes basic information of a node pool resource including node pool resource name.",
+ "Includes the complete configuration for VMware node pool resource. This is the default value for ListVmwareNodePoolsRequest method."
+ ],
+ "location": "query",
+ "type": "string"
}
},
"path": "v1/{+parent}/vmwareNodePools",
@@ -2799,6 +2915,11 @@
"name"
],
"parameters": {
+ "allowMissing": {
+ "description": "If set to true, and the VMware node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.",
+ "location": "query",
+ "type": "boolean"
+ },
"etag": {
"description": "The current etag of the VMware node pool. If an etag is provided and does not match the current etag of node pool, deletion will be blocked and an ABORTED error will be returned.",
"location": "query",
@@ -2906,7 +3027,7 @@
}
}
},
- "revision": "20230507",
+ "revision": "20230517",
"rootUrl": "https://gkeonprem.googleapis.com/",
"schemas": {
"Authorization": {
@@ -2914,7 +3035,7 @@
"id": "Authorization",
"properties": {
"adminUsers": {
- "description": "Required. For VMware user, bare metal user and standalone clusters, users that will be granted the cluster-admin role on the cluster, providing full access to the cluster. For bare metal Admin cluster, users will be granted the view role, which is a view only access.",
+ "description": "Required. 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.",
"items": {
"$ref": "ClusterUser"
},
@@ -3691,7 +3812,7 @@
"type": "object"
},
"BareMetalKubeletConfig": {
- "description": "KubeletConfig defines the modifiable kubelet configurations for baremetal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options).",
+ "description": "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).",
"id": "BareMetalKubeletConfig",
"properties": {
"registryBurst": {
@@ -4036,7 +4157,7 @@
"properties": {
"kubeletConfig": {
"$ref": "BareMetalKubeletConfig",
- "description": "The modifiable kubelet configurations for the baremetal machines."
+ "description": "The modifiable kubelet configurations for the bare metal machines."
},
"labels": {
"additionalProperties": {
@@ -4300,14 +4421,25 @@
},
"type": "object"
},
+ "EnrollBareMetalStandaloneNodePoolRequest": {
+ "description": "Message for enrolling an existing bare metal standalone node pool to the GKE on-prem API.",
+ "id": "EnrollBareMetalStandaloneNodePoolRequest",
+ "properties": {
+ "bareMetalStandaloneNodePoolId": {
+ "description": "User provided OnePlatform identifier that is used as part of the resource name. This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format.",
+ "type": "string"
+ },
+ "validateOnly": {
+ "description": "If set, only validate the request, but do not actually enroll the node pool.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
"EnrollVmwareAdminClusterRequest": {
"description": "Message for enrolling an existing VMware admin cluster to the GKE on-prem API.",
"id": "EnrollVmwareAdminClusterRequest",
"properties": {
- "localName": {
- "description": "The object name of the VMware OnPremAdminCluster 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 vmware_admin_cluster_id. Otherwise, it must match the object name of the VMware OnPremAdminCluster custom resource. It is not modifiable outside / beyond the enrollment operation.",
- "type": "string"
- },
"membership": {
"description": "Required. This is the full resource name of this admin cluster's fleet membership.",
"type": "string"
@@ -4683,6 +4815,11 @@
"readOnly": true,
"type": "string"
},
+ "controlPlaneDisconnected": {
+ "description": "Output only. Denotes if the local managing cluster's control plane is currently disconnected. This is expected to occur temporarily during self-managed cluster upgrades.",
+ "readOnly": true,
+ "type": "boolean"
+ },
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
@@ -5523,7 +5660,7 @@
"description": "The VMware user cluster network configuration."
},
"onPremVersion": {
- "description": "The Anthos clusters on the VMware version for your user cluster. Defaults to the admin cluster version.",
+ "description": "Required. The Anthos clusters on the VMware version for your user cluster.",
"type": "string"
},
"reconciling": {