Blame - docs/dyn/container_v1.projects.locations.clusters.nodePools.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Creates a node pool for a cluster.</p>

80

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

81

<code><a href="#delete">delete(name, projectId=None, nodePoolId=None, clusterId=None, zone=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">Deletes a node pool from a cluster.</p>

83

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

84

<code><a href="#get">get(name, zone=None, nodePoolId=None, projectId=None, clusterId=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

85

<p class="firstline">Retrieves the requested node pool.</p>

86

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

87

<code><a href="#list">list(parent, clusterId=None, projectId=None, zone=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Lists the node pools for a cluster.</p>

89

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

90

<code><a href="#rollback">rollback(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

<p class="firstline">Rolls back a previously Aborted or Failed NodePool upgrade.</p>

92

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

<code><a href="#setAutoscaling">setAutoscaling(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Sets the autoscaling settings for the specified node pool.</p>

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#setManagement">setManagement(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<p class="firstline">Sets the NodeManagement options for a node pool.</p>

98

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#setSize">setSize(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

100

<p class="firstline">Sets the size for a specific node pool.</p>

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

<p class="firstline">Updates the version and/or image type for the specified node pool.</p>

104

<h3>Method Details</h3>

105

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

106

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

107

<pre>Creates a node pool for a cluster.

108

109

Args:

110

parent: string, The parent (project, location, cluster id) where the node pool will be

111

created. Specified in the format

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

112

`projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

113

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

114

The object takes the form of:

115

116

{ # CreateNodePoolRequest creates a node pool for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

117

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

118

# number](https://developers.google.com/console/help/new/#projectnumber).

119

# This field has been deprecated and replaced by the parent field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

120

"zone": "A String", # Deprecated. The name of the Google Compute Engine

121

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

122

# cluster resides. This field has been deprecated and replaced by the parent

123

# field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

124

"parent": "A String", # The parent (project, location, cluster id) where the node pool will be

125

# created. Specified in the format

126

# `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

127

"nodePool": { # NodePool contains the name and configuration for a cluster's node pool. # Required. The node pool to create.

128

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

129

# specification, under the control of the cluster master. They may have a set

130

# of Kubernetes labels applied to them, which may be used to reference them

131

# during pod scheduling. They may also be resized up or down, to accommodate

132

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

133

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

134

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

135

# node pool.

136

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

137

# the Auto Upgrades will proceed.

138

"description": "A String", # [Output only] This field is set when upgrades are about to commence

139

# with the description of the upgrade.

140

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

141

# with the approximate start time for the upgrades, in

142

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

143

},

144

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

145

# pool. If enabled, the nodes in this node pool will be monitored and, if

146

# they fail health checks too many times, an automatic repair action will be

147

# triggered.

148

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

149

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

150

# up to date with the latest release version of Kubernetes.

151

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

152

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

153

# disruption caused by an upgrade.

154

#

155

# maxUnavailable controls the number of nodes that can be simultaneously

156

# unavailable.

157

#

158

# maxSurge controls the number of additional nodes that can be added to the

159

# node pool temporarily for the time of the upgrade to increase the number of

160

# available nodes.

161

#

162

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

163

# nodes are being upgraded at the same time).

164

#

165

# Note: upgrades inevitably introduce some disruption since workloads need to

166

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

167

# this holds true. (Disruption stays within the limits of

168

# PodDisruptionBudget, if it is configured.)

169

#

170

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

171

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

172

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

173

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

174

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

175

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

176

# the upgrade process. A node is considered available if its status is

177

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

178

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

179

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

180

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

181

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

182

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

183

# is sufficient for this number of instances. You must also have available

184

# firewall and routes quota.

185

"statusMessage": "A String", # [Output only] Additional information about the current status of this

186

# node pool instance, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

187

"version": "A String", # The version of the Kubernetes of this node.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

188

"conditions": [ # Which conditions caused the current node pool state.

189

{ # StatusCondition describes why a cluster or a node pool has a certain status

190

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

191

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

192

"code": "A String", # Machine-friendly representation of the condition

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

193

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

194

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

195

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

196

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

197

#

198

# If unspecified, the default disk type is 'pd-standard'

199

"bootDiskKmsKey": "A String", #

200

# The Customer Managed Encryption Key used to encrypt the boot disk attached

201

# to each node in the node pool. This should be of the form

202

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

203

# For more information about protecting resources with Cloud KMS Keys please

204

# see:

205

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

206

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

207

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

208

#

209

# Enables monitoring and attestation of the boot integrity of the instance.

210

# The attestation is performed against the integrity policy baseline. This

211

# baseline is initially derived from the implicitly trusted boot image when

212

# the instance is created.

213

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

214

#

215

# Secure Boot helps ensure that the system only runs authentic software by

216

# verifying the digital signature of all boot components, and halting the

217

# boot process if signature verification fails.

218

},

219

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

220

# These will added in addition to any default label(s) that

221

# Kubernetes may apply to the node.

222

# In case of conflict in label keys, the applied set may differ depending on

223

# the Kubernetes version -- it's best to assume the behavior is undefined

224

# and conflicts should be avoided.

225

# For more information, including usage and the valid values, see:

226

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

227

"a_key": "A String",

228

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

229

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

230

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

231

#

232

# The following scopes are recommended, but not required, and by default are

233

# not included:

234

#

235

# * `https://www.googleapis.com/auth/compute` is required for mounting

236

# persistent storage on your nodes.

237

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

238

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

239

# (the [Google Container

240

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

241

#

242

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

243

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

244

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

245

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

246

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

247

# scheduled on the specified or newer CPU platform. Applicable values are the

248

# friendly names of CPU platforms, such as

249

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

250

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

251

# information, read [how to specify min CPU

252

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

253

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

254

#

255

# The limit for this value is dependent upon the maximum number of

256

# disks available on a machine per zone. See:

257

# https://cloud.google.com/compute/docs/disks/local-ssd

258

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

259

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

260

#

261

# For more information, including usage and the valid values, see:

262

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

263

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

264

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

265

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

266

# See

267

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

268

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

269

"value": "A String", # Value for taint.

270

"key": "A String", # Key for taint.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

271

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

272

},

273

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

274

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

275

# the latest version of it will be used.

276

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

277

# the specified [Zonal Compute

278

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

279

# to this node pool.

280

# is the configuration of desired reservation which instances could take

281

# capacity from.

282

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

283

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

284

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

285

# the key and specify the name of your reservation as its value.

286

"values": [ # Corresponds to the label value(s) of reservation resource(s).

287

"A String",

288

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

289

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

290

"machineType": "A String", # The name of a Google Compute Engine [machine

291

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

292

# `n1-standard-1`).

293

#

294

# If unspecified, the default machine type is

295

# `n1-standard-1`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

296

"nodeGroup": "A String", # Setting this field will assign instances of this

297

# pool to run on the specified node group. This is useful for running

298

# workloads on [sole tenant

299

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

300

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

301

#

302

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

303

# in length. These are reflected as part of a URL in the metadata server.

304

# Additionally, to avoid ambiguity, keys must not conflict with any other

305

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

311

# "enable-os-login"

312

# "gci-ensure-gke-docker"

313

# "gci-metrics-enabled"

314

# "gci-update-strategy"

315

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

320

# "windows-startup-script-ps1"

321

# "common-psm1"

322

# "k8s-node-setup-psm1"

323

# "install-ssh-psm1"

324

# "user-profile-psm1"

325

# "serial-port-logging-enable"

326

#

327

# Values are free-form strings, and only have meaning as interpreted by

328

# the image running in the instance. The only restriction placed on them is

329

# that each value's size must be less than or equal to 32 KB.

330

#

331

# The total size of all keys and values must be less than 512 KB.

332

"a_key": "A String",

333

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

334

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

335

# valid sources or targets for network firewalls and are specified by

336

# the client during cluster or node pool creation. Each tag within the list

337

# must comply with RFC1035.

338

"A String",

339

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

340

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

341

"type": "A String", # Type of the sandbox to use for the node.

342

},

343

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

344

# https://cloud.google.com/compute/docs/instances/preemptible for more

345

# information about preemptible VM instances.

346

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

347

# workloads on the node pool.

348

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

349

# on the node pool.

350

},

351

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

352

# The smallest allowed disk size is 10GB.

353

#

354

# If unspecified, the default disk size is 100GB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

355

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

356

# Specify the email address of the Service Account; otherwise, if no Service

357

# Account is specified, the "default" service account is used.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

358

"accelerators": [ # A list of hardware accelerators to be attached to each node.

359

# See https://cloud.google.com/compute/docs/gpus for more information about

360

# support for GPUs.

361

{ # AcceleratorConfig represents a Hardware Accelerator request.

362

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

363

# [here](https://cloud.google.com/compute/docs/gpus)

364

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

365

},

366

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

367

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

368

"name": "A String", # The name of the node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

369

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

370

# simultaneously on a node in the node pool.

371

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

372

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

373

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

374

# only if a valid configuration is present.

375

# adjust the size of the node pool to the current cluster usage.

376

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

377

# max_node_count.

378

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

379

# has to enough quota to scale up the cluster.

380

"enabled": True or False, # Is autoscaling enabled for this node pool.

381

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

382

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

383

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

384

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

385

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

386

# associated with this node pool.

387

"A String",

388

],

389

"status": "A String", # [Output only] The status of the nodes in this pool instance.

390

"locations": [ # The list of Google Compute Engine

391

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

392

# NodePool's nodes should be located.

393

"A String",

394

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

395

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

396

"clusterId": "A String", # Deprecated. The name of the cluster.

397

# This field has been deprecated and replaced by the parent field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

398

}

399

400

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

407

408

{ # This operation resource represents operations that may have happened or are

409

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

410

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

411

"name": "A String", # A non-parameterized string describing an operation stage.

412

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

413

"metrics": [ # Progress metric bundle, for example:

414

# metrics: [{name: "nodes done", int_value: 15},

415

# {name: "nodes total", int_value: 32}]

416

# or

417

# metrics: [{name: "progress", double_value: 0.56},

418

# {name: "progress scale", double_value: 1.0}]

419

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

420

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

421

"doubleValue": 3.14, # For metrics with floating point value.

422

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

423

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

424

},

425

],

426

"status": "A String", # Status of an operation stage.

427

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

428

"stages": [ # Substages of an operation or a stage.

429

# Object with schema name: OperationProgress

430

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

431

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

432

"targetLink": "A String", # Server-defined URL for the target of the operation.

433

"status": "A String", # The current status of the operation.

434

"operationType": "A String", # The operation type.

435

"startTime": "A String", # [Output only] The time the operation started, in

436

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

437

"clusterConditions": [ # Which conditions caused the current cluster state.

438

{ # StatusCondition describes why a cluster or a node pool has a certain status

439

# (e.g., ERROR or DEGRADED).

440

"message": "A String", # Human-friendly representation of the condition

441

"code": "A String", # Machine-friendly representation of the condition

442

},

443

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

444

"zone": "A String", # The name of the Google Compute Engine

445

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

446

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

447

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

448

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

449

"detail": "A String", # Detailed operation progress, if available.

450

"endTime": "A String", # [Output only] The time the operation completed, in

451

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

452

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

453

{ # StatusCondition describes why a cluster or a node pool has a certain status

454

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

455

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

456

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

457

},

458

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

459

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

460

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

461

# or

462

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

463

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

464

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

469

<code class="details" id="delete">delete(name, projectId=None, nodePoolId=None, clusterId=None, zone=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

470

<pre>Deletes a node pool from a cluster.

471

472

Args:

473

name: string, The name (project, location, cluster, node pool id) of the node pool to

474

delete. Specified in the format

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

475

`projects/*/locations/*/clusters/*/nodePools/*`. (required)

476

projectId: string, Deprecated. The Google Developers Console [project ID or project

477

number](https://developers.google.com/console/help/new/#projectnumber).

478

This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

479

nodePoolId: string, Deprecated. The name of the node pool to delete.

480

This field has been deprecated and replaced by the name field.

481

clusterId: string, Deprecated. The name of the cluster.

482

This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

483

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

484

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

485

cluster resides. This field has been deprecated and replaced by the name

486

field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

487

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

494

495

{ # This operation resource represents operations that may have happened or are

496

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

497

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

498

"name": "A String", # A non-parameterized string describing an operation stage.

499

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

500

"metrics": [ # Progress metric bundle, for example:

501

# metrics: [{name: "nodes done", int_value: 15},

502

# {name: "nodes total", int_value: 32}]

503

# or

504

# metrics: [{name: "progress", double_value: 0.56},

505

# {name: "progress scale", double_value: 1.0}]

506

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

507

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

508

"doubleValue": 3.14, # For metrics with floating point value.

509

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

510

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

511

},

512

],

513

"status": "A String", # Status of an operation stage.

514

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

515

"stages": [ # Substages of an operation or a stage.

516

# Object with schema name: OperationProgress

517

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

518

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

519

"targetLink": "A String", # Server-defined URL for the target of the operation.

520

"status": "A String", # The current status of the operation.

521

"operationType": "A String", # The operation type.

522

"startTime": "A String", # [Output only] The time the operation started, in

523

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

524

"clusterConditions": [ # Which conditions caused the current cluster state.

525

{ # StatusCondition describes why a cluster or a node pool has a certain status

526

# (e.g., ERROR or DEGRADED).

527

"message": "A String", # Human-friendly representation of the condition

528

"code": "A String", # Machine-friendly representation of the condition

529

},

530

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

531

"zone": "A String", # The name of the Google Compute Engine

532

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

533

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

534

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

535

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

536

"detail": "A String", # Detailed operation progress, if available.

537

"endTime": "A String", # [Output only] The time the operation completed, in

538

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

539

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

540

{ # StatusCondition describes why a cluster or a node pool has a certain status

541

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

542

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

543

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

544

},

545

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

546

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

547

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

548

# or

549

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

550

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

551

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

556

<code class="details" id="get">get(name, zone=None, nodePoolId=None, projectId=None, clusterId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

557

<pre>Retrieves the requested node pool.

558

559

Args:

560

name: string, The name (project, location, cluster, node pool id) of the node pool to

561

get. Specified in the format

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

562

`projects/*/locations/*/clusters/*/nodePools/*`. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

563

zone: string, Deprecated. The name of the Google Compute Engine

564

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

565

cluster resides. This field has been deprecated and replaced by the name

566

field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

567

nodePoolId: string, Deprecated. The name of the node pool.

568

This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

569

projectId: string, Deprecated. The Google Developers Console [project ID or project

570

number](https://developers.google.com/console/help/new/#projectnumber).

571

This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

572

clusterId: string, Deprecated. The name of the cluster.

573

This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

574

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

581

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

582

{ # NodePool contains the name and configuration for a cluster's node pool.

583

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

584

# specification, under the control of the cluster master. They may have a set

585

# of Kubernetes labels applied to them, which may be used to reference them

586

# during pod scheduling. They may also be resized up or down, to accommodate

587

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

588

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

589

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

590

# node pool.

591

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

592

# the Auto Upgrades will proceed.

593

"description": "A String", # [Output only] This field is set when upgrades are about to commence

594

# with the description of the upgrade.

595

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

596

# with the approximate start time for the upgrades, in

597

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

598

},

599

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

600

# pool. If enabled, the nodes in this node pool will be monitored and, if

601

# they fail health checks too many times, an automatic repair action will be

602

# triggered.

603

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

604

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

605

# up to date with the latest release version of Kubernetes.

606

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

607

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

608

# disruption caused by an upgrade.

609

#

610

# maxUnavailable controls the number of nodes that can be simultaneously

611

# unavailable.

612

#

613

# maxSurge controls the number of additional nodes that can be added to the

614

# node pool temporarily for the time of the upgrade to increase the number of

615

# available nodes.

616

#

617

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

618

# nodes are being upgraded at the same time).

619

#

620

# Note: upgrades inevitably introduce some disruption since workloads need to

621

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

622

# this holds true. (Disruption stays within the limits of

623

# PodDisruptionBudget, if it is configured.)

624

#

625

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

626

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

627

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

628

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

629

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

630

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

631

# the upgrade process. A node is considered available if its status is

632

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

633

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

634

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

635

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

636

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

637

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

638

# is sufficient for this number of instances. You must also have available

639

# firewall and routes quota.

640

"statusMessage": "A String", # [Output only] Additional information about the current status of this

641

# node pool instance, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

642

"version": "A String", # The version of the Kubernetes of this node.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

643

"conditions": [ # Which conditions caused the current node pool state.

644

{ # StatusCondition describes why a cluster or a node pool has a certain status

645

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

646

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

647

"code": "A String", # Machine-friendly representation of the condition

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

648

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

649

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

650

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

651

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

652

#

653

# If unspecified, the default disk type is 'pd-standard'

654

"bootDiskKmsKey": "A String", #

655

# The Customer Managed Encryption Key used to encrypt the boot disk attached

656

# to each node in the node pool. This should be of the form

657

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

658

# For more information about protecting resources with Cloud KMS Keys please

659

# see:

660

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

661

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

662

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

663

#

664

# Enables monitoring and attestation of the boot integrity of the instance.

665

# The attestation is performed against the integrity policy baseline. This

666

# baseline is initially derived from the implicitly trusted boot image when

667

# the instance is created.

668

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

669

#

670

# Secure Boot helps ensure that the system only runs authentic software by

671

# verifying the digital signature of all boot components, and halting the

672

# boot process if signature verification fails.

673

},

674

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

675

# These will added in addition to any default label(s) that

676

# Kubernetes may apply to the node.

677

# In case of conflict in label keys, the applied set may differ depending on

678

# the Kubernetes version -- it's best to assume the behavior is undefined

679

# and conflicts should be avoided.

680

# For more information, including usage and the valid values, see:

681

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

682

"a_key": "A String",

683

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

684

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

685

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

686

#

687

# The following scopes are recommended, but not required, and by default are

688

# not included:

689

#

690

# * `https://www.googleapis.com/auth/compute` is required for mounting

691

# persistent storage on your nodes.

692

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

693

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

694

# (the [Google Container

695

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

696

#

697

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

698

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

699

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

700

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

701

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

702

# scheduled on the specified or newer CPU platform. Applicable values are the

703

# friendly names of CPU platforms, such as

704

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

705

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

706

# information, read [how to specify min CPU

707

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

708

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

709

#

710

# The limit for this value is dependent upon the maximum number of

711

# disks available on a machine per zone. See:

712

# https://cloud.google.com/compute/docs/disks/local-ssd

713

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

714

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

715

#

716

# For more information, including usage and the valid values, see:

717

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

718

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

719

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

720

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

721

# See

722

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

723

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

724

"value": "A String", # Value for taint.

725

"key": "A String", # Key for taint.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

726

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

727

},

728

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

729

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

730

# the latest version of it will be used.

731

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

732

# the specified [Zonal Compute

733

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

734

# to this node pool.

735

# is the configuration of desired reservation which instances could take

736

# capacity from.

737

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

738

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

739

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

740

# the key and specify the name of your reservation as its value.

741

"values": [ # Corresponds to the label value(s) of reservation resource(s).

742

"A String",

743

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

744

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

745

"machineType": "A String", # The name of a Google Compute Engine [machine

746

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

747

# `n1-standard-1`).

748

#

749

# If unspecified, the default machine type is

750

# `n1-standard-1`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

751

"nodeGroup": "A String", # Setting this field will assign instances of this

752

# pool to run on the specified node group. This is useful for running

753

# workloads on [sole tenant

754

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

755

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

756

#

757

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

758

# in length. These are reflected as part of a URL in the metadata server.

759

# Additionally, to avoid ambiguity, keys must not conflict with any other

760

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

766

# "enable-os-login"

767

# "gci-ensure-gke-docker"

768

# "gci-metrics-enabled"

769

# "gci-update-strategy"

770

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

775

# "windows-startup-script-ps1"

776

# "common-psm1"

777

# "k8s-node-setup-psm1"

778

# "install-ssh-psm1"

779

# "user-profile-psm1"

780

# "serial-port-logging-enable"

781

#

782

# Values are free-form strings, and only have meaning as interpreted by

783

# the image running in the instance. The only restriction placed on them is

784

# that each value's size must be less than or equal to 32 KB.

785

#

786

# The total size of all keys and values must be less than 512 KB.

787

"a_key": "A String",

788

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

789

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

790

# valid sources or targets for network firewalls and are specified by

791

# the client during cluster or node pool creation. Each tag within the list

792

# must comply with RFC1035.

793

"A String",

794

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

795

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

796

"type": "A String", # Type of the sandbox to use for the node.

797

},

798

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

799

# https://cloud.google.com/compute/docs/instances/preemptible for more

800

# information about preemptible VM instances.

801

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

802

# workloads on the node pool.

803

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

804

# on the node pool.

805

},

806

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

807

# The smallest allowed disk size is 10GB.

808

#

809

# If unspecified, the default disk size is 100GB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

810

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

811

# Specify the email address of the Service Account; otherwise, if no Service

812

# Account is specified, the "default" service account is used.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

813

"accelerators": [ # A list of hardware accelerators to be attached to each node.

814

# See https://cloud.google.com/compute/docs/gpus for more information about

815

# support for GPUs.

816

{ # AcceleratorConfig represents a Hardware Accelerator request.

817

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

818

# [here](https://cloud.google.com/compute/docs/gpus)

819

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

820

},

821

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

822

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

823

"name": "A String", # The name of the node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

824

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

825

# simultaneously on a node in the node pool.

826

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

827

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

828

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

829

# only if a valid configuration is present.

830

# adjust the size of the node pool to the current cluster usage.

831

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

832

# max_node_count.

833

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

834

# has to enough quota to scale up the cluster.

835

"enabled": True or False, # Is autoscaling enabled for this node pool.

836

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

837

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

838

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

839

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

840

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

841

# associated with this node pool.

842

"A String",

843

],

844

"status": "A String", # [Output only] The status of the nodes in this pool instance.

845

"locations": [ # The list of Google Compute Engine

846

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

847

# NodePool's nodes should be located.

848

"A String",

849

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

854

<code class="details" id="list">list(parent, clusterId=None, projectId=None, zone=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

855

<pre>Lists the node pools for a cluster.

856

857

Args:

858

parent: string, The parent (project, location, cluster id) where the node pools will be

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

859

listed. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

860

clusterId: string, Deprecated. The name of the cluster.

861

This field has been deprecated and replaced by the parent field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

862

projectId: string, Deprecated. The Google Developers Console [project ID or project

863

number](https://developers.google.com/console/help/new/#projectnumber).

864

This field has been deprecated and replaced by the parent field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

865

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

866

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

867

cluster resides. This field has been deprecated and replaced by the parent

868

field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

869

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

876

877

{ # ListNodePoolsResponse is the result of ListNodePoolsRequest.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

878

"nodePools": [ # A list of node pools for a cluster.

879

{ # NodePool contains the name and configuration for a cluster's node pool.

880

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

881

# specification, under the control of the cluster master. They may have a set

882

# of Kubernetes labels applied to them, which may be used to reference them

883

# during pod scheduling. They may also be resized up or down, to accommodate

884

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

885

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

886

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

887

# node pool.

888

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

889

# the Auto Upgrades will proceed.

890

"description": "A String", # [Output only] This field is set when upgrades are about to commence

891

# with the description of the upgrade.

892

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

893

# with the approximate start time for the upgrades, in

894

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

895

},

896

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

897

# pool. If enabled, the nodes in this node pool will be monitored and, if

898

# they fail health checks too many times, an automatic repair action will be

899

# triggered.

900

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

901

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

902

# up to date with the latest release version of Kubernetes.

903

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

904

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

905

# disruption caused by an upgrade.

906

#

907

# maxUnavailable controls the number of nodes that can be simultaneously

908

# unavailable.

909

#

910

# maxSurge controls the number of additional nodes that can be added to the

911

# node pool temporarily for the time of the upgrade to increase the number of

912

# available nodes.

913

#

914

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

915

# nodes are being upgraded at the same time).

916

#

917

# Note: upgrades inevitably introduce some disruption since workloads need to

918

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

919

# this holds true. (Disruption stays within the limits of

920

# PodDisruptionBudget, if it is configured.)

921

#

922

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

923

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

924

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

925

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

926

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

927

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

928

# the upgrade process. A node is considered available if its status is

929

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

930

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

931

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

932

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

933

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

934

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

935

# is sufficient for this number of instances. You must also have available

936

# firewall and routes quota.

937

"statusMessage": "A String", # [Output only] Additional information about the current status of this

938

# node pool instance, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

939

"version": "A String", # The version of the Kubernetes of this node.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

940

"conditions": [ # Which conditions caused the current node pool state.

941

{ # StatusCondition describes why a cluster or a node pool has a certain status

942

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

943

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

944

"code": "A String", # Machine-friendly representation of the condition

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

945

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

946

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

947

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

948

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

949

#

950

# If unspecified, the default disk type is 'pd-standard'

951

"bootDiskKmsKey": "A String", #

952

# The Customer Managed Encryption Key used to encrypt the boot disk attached

953

# to each node in the node pool. This should be of the form

954

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

955

# For more information about protecting resources with Cloud KMS Keys please

956

# see:

957

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

958

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

959

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

960

#

961

# Enables monitoring and attestation of the boot integrity of the instance.

962

# The attestation is performed against the integrity policy baseline. This

963

# baseline is initially derived from the implicitly trusted boot image when

964

# the instance is created.

965

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

966

#

967

# Secure Boot helps ensure that the system only runs authentic software by

968

# verifying the digital signature of all boot components, and halting the

969

# boot process if signature verification fails.

970

},

971

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

972

# These will added in addition to any default label(s) that

973

# Kubernetes may apply to the node.

974

# In case of conflict in label keys, the applied set may differ depending on

975

# the Kubernetes version -- it's best to assume the behavior is undefined

976

# and conflicts should be avoided.

977

# For more information, including usage and the valid values, see:

978

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

979

"a_key": "A String",

980

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

981

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

982

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

983

#

984

# The following scopes are recommended, but not required, and by default are

985

# not included:

986

#

987

# * `https://www.googleapis.com/auth/compute` is required for mounting

988

# persistent storage on your nodes.

989

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

990

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

991

# (the [Google Container

992

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

993

#

994

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

995

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

996

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

997

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

998

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

999

# scheduled on the specified or newer CPU platform. Applicable values are the

1000

# friendly names of CPU platforms, such as

1001

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

1002

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

1003

# information, read [how to specify min CPU

1004

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1005

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

1006

#

1007

# The limit for this value is dependent upon the maximum number of

1008

# disks available on a machine per zone. See:

1009

# https://cloud.google.com/compute/docs/disks/local-ssd

1010

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1011

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1012

#

1013

# For more information, including usage and the valid values, see:

1014

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1015

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

1016

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

1017

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1018

# See

1019

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

1020

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1021

"value": "A String", # Value for taint.

1022

"key": "A String", # Key for taint.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1023

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1024

},

1025

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1026

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

1027

# the latest version of it will be used.

1028

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

1029

# the specified [Zonal Compute

1030

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

1031

# to this node pool.

1032

# is the configuration of desired reservation which instances could take

1033

# capacity from.

1034

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1035

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

1036

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

1037

# the key and specify the name of your reservation as its value.

1038

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1039

"A String",

1040

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1041

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1042

"machineType": "A String", # The name of a Google Compute Engine [machine

1043

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

1044

# `n1-standard-1`).

1045

#

1046

# If unspecified, the default machine type is

1047

# `n1-standard-1`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1048

"nodeGroup": "A String", # Setting this field will assign instances of this

1049

# pool to run on the specified node group. This is useful for running

1050

# workloads on [sole tenant

1051

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1052

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

1053

#

1054

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

1055

# in length. These are reflected as part of a URL in the metadata server.

1056

# Additionally, to avoid ambiguity, keys must not conflict with any other

1057

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1063

# "enable-os-login"

1064

# "gci-ensure-gke-docker"

1065

# "gci-metrics-enabled"

1066

# "gci-update-strategy"

1067

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1072

# "windows-startup-script-ps1"

1073

# "common-psm1"

1074

# "k8s-node-setup-psm1"

1075

# "install-ssh-psm1"

1076

# "user-profile-psm1"

1077

# "serial-port-logging-enable"

1078

#

1079

# Values are free-form strings, and only have meaning as interpreted by

1080

# the image running in the instance. The only restriction placed on them is

1081

# that each value's size must be less than or equal to 32 KB.

1082

#

1083

# The total size of all keys and values must be less than 512 KB.

1084

"a_key": "A String",

1085

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1086

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

1087

# valid sources or targets for network firewalls and are specified by

1088

# the client during cluster or node pool creation. Each tag within the list

1089

# must comply with RFC1035.

1090

"A String",

1091

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1092

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1093

"type": "A String", # Type of the sandbox to use for the node.

1094

},

1095

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

1096

# https://cloud.google.com/compute/docs/instances/preemptible for more

1097

# information about preemptible VM instances.

1098

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

1099

# workloads on the node pool.

1100

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

1101

# on the node pool.

1102

},

1103

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

1104

# The smallest allowed disk size is 10GB.

1105

#

1106

# If unspecified, the default disk size is 100GB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1107

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

1108

# Specify the email address of the Service Account; otherwise, if no Service

1109

# Account is specified, the "default" service account is used.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1110

"accelerators": [ # A list of hardware accelerators to be attached to each node.

1111

# See https://cloud.google.com/compute/docs/gpus for more information about

1112

# support for GPUs.

1113

{ # AcceleratorConfig represents a Hardware Accelerator request.

1114

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

1115

# [here](https://cloud.google.com/compute/docs/gpus)

1116

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1117

},

1118

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1119

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1120

"name": "A String", # The name of the node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1121

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

1122

# simultaneously on a node in the node pool.

1123

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1124

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1125

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

1126

# only if a valid configuration is present.

1127

# adjust the size of the node pool to the current cluster usage.

1128

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

1129

# max_node_count.

1130

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

1131

# has to enough quota to scale up the cluster.

1132

"enabled": True or False, # Is autoscaling enabled for this node pool.

1133

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1134

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1135

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

1136

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

1137

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

1138

# associated with this node pool.

1139

"A String",

1140

],

1141

"status": "A String", # [Output only] The status of the nodes in this pool instance.

1142

"locations": [ # The list of Google Compute Engine

1143

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1144

# NodePool's nodes should be located.

1145

"A String",

1146

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1153

<code class="details" id="rollback">rollback(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1154

<pre>Rolls back a previously Aborted or Failed NodePool upgrade.

1155

This makes no changes if the last upgrade successfully completed.

1156

1157

Args:

1158

name: string, The name (project, location, cluster, node pool id) of the node poll to

1159

rollback upgrade.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1160

Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1161

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1162

The object takes the form of:

1163

1164

{ # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed

1165

# NodePool upgrade. This will be an no-op if the last upgrade successfully

1166

# completed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1167

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1168

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1169

# cluster resides. This field has been deprecated and replaced by the name

1170

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1171

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

1172

# number](https://support.google.com/cloud/answer/6158840).

1173

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1174

"clusterId": "A String", # Deprecated. The name of the cluster to rollback.

1175

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1176

"name": "A String", # The name (project, location, cluster, node pool id) of the node poll to

1177

# rollback upgrade.

1178

# Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1179

"nodePoolId": "A String", # Deprecated. The name of the node pool to rollback.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1180

# This field has been deprecated and replaced by the name field.

1181

}

1182

1183

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1190

1191

{ # This operation resource represents operations that may have happened or are

1192

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1193

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1194

"name": "A String", # A non-parameterized string describing an operation stage.

1195

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1196

"metrics": [ # Progress metric bundle, for example:

1197

# metrics: [{name: "nodes done", int_value: 15},

1198

# {name: "nodes total", int_value: 32}]

1199

# or

1200

# metrics: [{name: "progress", double_value: 0.56},

1201

# {name: "progress scale", double_value: 1.0}]

1202

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1203

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1204

"doubleValue": 3.14, # For metrics with floating point value.

1205

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1206

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1207

},

1208

],

1209

"status": "A String", # Status of an operation stage.

1210

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1211

"stages": [ # Substages of an operation or a stage.

1212

# Object with schema name: OperationProgress

1213

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1214

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1215

"targetLink": "A String", # Server-defined URL for the target of the operation.

1216

"status": "A String", # The current status of the operation.

1217

"operationType": "A String", # The operation type.

1218

"startTime": "A String", # [Output only] The time the operation started, in

1219

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1220

"clusterConditions": [ # Which conditions caused the current cluster state.

1221

{ # StatusCondition describes why a cluster or a node pool has a certain status

1222

# (e.g., ERROR or DEGRADED).

1223

"message": "A String", # Human-friendly representation of the condition

1224

"code": "A String", # Machine-friendly representation of the condition

1225

},

1226

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1227

"zone": "A String", # The name of the Google Compute Engine

1228

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1229

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1230

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1231

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1232

"detail": "A String", # Detailed operation progress, if available.

1233

"endTime": "A String", # [Output only] The time the operation completed, in

1234

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1235

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1236

{ # StatusCondition describes why a cluster or a node pool has a certain status

1237

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1238

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1239

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1240

},

1241

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1242

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1243

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1244

# or

1245

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1246

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1247

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1252

<code class="details" id="setAutoscaling">setAutoscaling(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1253

<pre>Sets the autoscaling settings for the specified node pool.

1254

1255

Args:

1256

name: string, The name (project, location, cluster, node pool) of the node pool to set

1257

autoscaler settings. Specified in the format

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1258

`projects/*/locations/*/clusters/*/nodePools/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1259

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1260

The object takes the form of:

1261

1262

{ # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1263

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Required. Autoscaling configuration for the node pool.

1264

# adjust the size of the node pool to the current cluster usage.

1265

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

1266

# max_node_count.

1267

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

1268

# has to enough quota to scale up the cluster.

1269

"enabled": True or False, # Is autoscaling enabled for this node pool.

1270

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

1271

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1272

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1273

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1274

# cluster resides. This field has been deprecated and replaced by the name

1275

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1276

"nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1277

# This field has been deprecated and replaced by the name field.

1278

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

1279

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1280

"name": "A String", # The name (project, location, cluster, node pool) of the node pool to set

1281

# autoscaler settings. Specified in the format

1282

# `projects/*/locations/*/clusters/*/nodePools/*`.

1283

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

1284

# number](https://support.google.com/cloud/answer/6158840).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1285

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1286

}

1287

1288

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1295

1296

{ # This operation resource represents operations that may have happened or are

1297

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1298

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1299

"name": "A String", # A non-parameterized string describing an operation stage.

1300

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1301

"metrics": [ # Progress metric bundle, for example:

1302

# metrics: [{name: "nodes done", int_value: 15},

1303

# {name: "nodes total", int_value: 32}]

1304

# or

1305

# metrics: [{name: "progress", double_value: 0.56},

1306

# {name: "progress scale", double_value: 1.0}]

1307

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1308

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1309

"doubleValue": 3.14, # For metrics with floating point value.

1310

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1311

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1312

},

1313

],

1314

"status": "A String", # Status of an operation stage.

1315

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1316

"stages": [ # Substages of an operation or a stage.

1317

# Object with schema name: OperationProgress

1318

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1319

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1320

"targetLink": "A String", # Server-defined URL for the target of the operation.

1321

"status": "A String", # The current status of the operation.

1322

"operationType": "A String", # The operation type.

1323

"startTime": "A String", # [Output only] The time the operation started, in

1324

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1325

"clusterConditions": [ # Which conditions caused the current cluster state.

1326

{ # StatusCondition describes why a cluster or a node pool has a certain status

1327

# (e.g., ERROR or DEGRADED).

1328

"message": "A String", # Human-friendly representation of the condition

1329

"code": "A String", # Machine-friendly representation of the condition

1330

},

1331

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1332

"zone": "A String", # The name of the Google Compute Engine

1333

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1334

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1335

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1336

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1337

"detail": "A String", # Detailed operation progress, if available.

1338

"endTime": "A String", # [Output only] The time the operation completed, in

1339

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1340

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1341

{ # StatusCondition describes why a cluster or a node pool has a certain status

1342

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1343

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1344

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1345

},

1346

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1347

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1348

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1349

# or

1350

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1351

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1352

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1357

<code class="details" id="setManagement">setManagement(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1358

<pre>Sets the NodeManagement options for a node pool.

1359

1360

Args:

1361

name: string, The name (project, location, cluster, node pool id) of the node pool to set

1362

management properties. Specified in the format

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1363

`projects/*/locations/*/clusters/*/nodePools/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1364

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1365

The object takes the form of:

1366

1367

{ # SetNodePoolManagementRequest sets the node management properties of a node

1368

# pool.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1369

"nodePoolId": "A String", # Deprecated. The name of the node pool to update.

1370

# This field has been deprecated and replaced by the name field.

1371

"name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set

1372

# management properties. Specified in the format

1373

# `projects/*/locations/*/clusters/*/nodePools/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1374

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1375

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1376

# cluster resides. This field has been deprecated and replaced by the name

1377

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1378

"management": { # NodeManagement defines the set of node management services turned on for the # Required. NodeManagement configuration for the node pool.

1379

# node pool.

1380

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

1381

# the Auto Upgrades will proceed.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1382

"description": "A String", # [Output only] This field is set when upgrades are about to commence

1383

# with the description of the upgrade.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1384

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

1385

# with the approximate start time for the upgrades, in

1386

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1387

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1388

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

1389

# pool. If enabled, the nodes in this node pool will be monitored and, if

1390

# they fail health checks too many times, an automatic repair action will be

1391

# triggered.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1392

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

1393

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

1394

# up to date with the latest release version of Kubernetes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1395

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1396

"clusterId": "A String", # Deprecated. The name of the cluster to update.

1397

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1398

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

1399

# number](https://support.google.com/cloud/answer/6158840).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1400

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1401

}

1402

1403

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1410

1411

{ # This operation resource represents operations that may have happened or are

1412

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1413

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1414

"name": "A String", # A non-parameterized string describing an operation stage.

1415

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1416

"metrics": [ # Progress metric bundle, for example:

1417

# metrics: [{name: "nodes done", int_value: 15},

1418

# {name: "nodes total", int_value: 32}]

1419

# or

1420

# metrics: [{name: "progress", double_value: 0.56},

1421

# {name: "progress scale", double_value: 1.0}]

1422

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1423

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1424

"doubleValue": 3.14, # For metrics with floating point value.

1425

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1426

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1427

},

1428

],

1429

"status": "A String", # Status of an operation stage.

1430

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1431

"stages": [ # Substages of an operation or a stage.

1432

# Object with schema name: OperationProgress

1433

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1434

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1435

"targetLink": "A String", # Server-defined URL for the target of the operation.

1436

"status": "A String", # The current status of the operation.

1437

"operationType": "A String", # The operation type.

1438

"startTime": "A String", # [Output only] The time the operation started, in

1439

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1440

"clusterConditions": [ # Which conditions caused the current cluster state.

1441

{ # StatusCondition describes why a cluster or a node pool has a certain status

1442

# (e.g., ERROR or DEGRADED).

1443

"message": "A String", # Human-friendly representation of the condition

1444

"code": "A String", # Machine-friendly representation of the condition

1445

},

1446

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1447

"zone": "A String", # The name of the Google Compute Engine

1448

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1449

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1450

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1451

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1452

"detail": "A String", # Detailed operation progress, if available.

1453

"endTime": "A String", # [Output only] The time the operation completed, in

1454

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1455

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1456

{ # StatusCondition describes why a cluster or a node pool has a certain status

1457

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1458

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1459

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1460

},

1461

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1462

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1463

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1464

# or

1465

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1466

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1467

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1472

<code class="details" id="setSize">setSize(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1473

<pre>Sets the size for a specific node pool.

1474

1475

Args:

1476

name: string, The name (project, location, cluster, node pool id) of the node pool to set

1477

size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1478

Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1479

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1480

The object takes the form of:

1481

1482

{ # SetNodePoolSizeRequest sets the size a node

1483

# pool.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1484

"nodeCount": 42, # Required. The desired node count for the pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1485

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1486

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1487

# cluster resides. This field has been deprecated and replaced by the name

1488

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1489

"nodePoolId": "A String", # Deprecated. The name of the node pool to update.

1490

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1491

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1492

# number](https://support.google.com/cloud/answer/6158840).

1493

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1494

"name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set

1495

# size.

1496

# Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1497

"clusterId": "A String", # Deprecated. The name of the cluster to update.

1498

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1499

}

1500

1501

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1508

1509

{ # This operation resource represents operations that may have happened or are

1510

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1511

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1512

"name": "A String", # A non-parameterized string describing an operation stage.

1513

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1514

"metrics": [ # Progress metric bundle, for example:

1515

# metrics: [{name: "nodes done", int_value: 15},

1516

# {name: "nodes total", int_value: 32}]

1517

# or

1518

# metrics: [{name: "progress", double_value: 0.56},

1519

# {name: "progress scale", double_value: 1.0}]

1520

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1521

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1522

"doubleValue": 3.14, # For metrics with floating point value.

1523

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1524

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1525

},

1526

],

1527

"status": "A String", # Status of an operation stage.

1528

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1529

"stages": [ # Substages of an operation or a stage.

1530

# Object with schema name: OperationProgress

1531

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1532

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1533

"targetLink": "A String", # Server-defined URL for the target of the operation.

1534

"status": "A String", # The current status of the operation.

1535

"operationType": "A String", # The operation type.

1536

"startTime": "A String", # [Output only] The time the operation started, in

1537

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1538

"clusterConditions": [ # Which conditions caused the current cluster state.

1539

{ # StatusCondition describes why a cluster or a node pool has a certain status

1540

# (e.g., ERROR or DEGRADED).

1541

"message": "A String", # Human-friendly representation of the condition

1542

"code": "A String", # Machine-friendly representation of the condition

1543

},

1544

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1545

"zone": "A String", # The name of the Google Compute Engine

1546

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1547

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1548

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1549

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1550

"detail": "A String", # Detailed operation progress, if available.

1551

"endTime": "A String", # [Output only] The time the operation completed, in

1552

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1553

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1554

{ # StatusCondition describes why a cluster or a node pool has a certain status

1555

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1556

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1557

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1558

},

1559

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1560

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1561

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1562

# or

1563

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1564

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1565

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1570

<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1571

<pre>Updates the version and/or image type for the specified node pool.

1572

1573

Args:

1574

name: string, The name (project, location, cluster, node pool) of the node pool to

1575

update. Specified in the format

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1576

`projects/*/locations/*/clusters/*/nodePools/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1577

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1578

The object takes the form of:

1579

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1580

{ # UpdateNodePoolRequests update a node pool's image and/or version.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1581

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

1582

# This field has been deprecated and replaced by the name field.

1583

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The desired workload metadata config for the node pool.

1584

# workloads on the node pool.

1585

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

1586

# on the node pool.

1587

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1588

"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an

1589

# upgrade).

1590

#

1591

# Users may specify either explicit versions offered by Kubernetes Engine or

1592

# version aliases, which have the following behavior:

1593

#

1594

# - "latest": picks the highest valid Kubernetes version

1595

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

1596

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

1597

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

1598

# - "-": picks the Kubernetes master version

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1599

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1600

# disruption caused by an upgrade.

1601

#

1602

# maxUnavailable controls the number of nodes that can be simultaneously

1603

# unavailable.

1604

#

1605

# maxSurge controls the number of additional nodes that can be added to the

1606

# node pool temporarily for the time of the upgrade to increase the number of

1607

# available nodes.

1608

#

1609

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

1610

# nodes are being upgraded at the same time).

1611

#

1612

# Note: upgrades inevitably introduce some disruption since workloads need to

1613

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

1614

# this holds true. (Disruption stays within the limits of

1615

# PodDisruptionBudget, if it is configured.)

1616

#

1617

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

1618

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

1619

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

1620

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

1621

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1622

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1623

# the upgrade process. A node is considered available if its status is

1624

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1625

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

1626

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1627

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1628

"locations": [ # The desired list of Google Compute Engine

1629

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1630

# node pool's nodes should be located. Changing the locations for a node pool

1631

# will result in nodes being either created or removed from the node pool,

1632

# depending on whether locations are being added or removed.

1633

"A String",

1634

],

1635

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

1636

# number](https://support.google.com/cloud/answer/6158840).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1637

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1638

"nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade.

1639

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1640

"imageType": "A String", # Required. The desired image type for the node pool.

1641

"zone": "A String", # Deprecated. The name of the Google Compute Engine

1642

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1643

# cluster resides. This field has been deprecated and replaced by the name

1644

# field.

1645

"name": "A String", # The name (project, location, cluster, node pool) of the node pool to

1646

# update. Specified in the format

1647

# `projects/*/locations/*/clusters/*/nodePools/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1648

}

1649

1650

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1657

1658

{ # This operation resource represents operations that may have happened or are

1659

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1660

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1661

"name": "A String", # A non-parameterized string describing an operation stage.

1662

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1663

"metrics": [ # Progress metric bundle, for example:

1664

# metrics: [{name: "nodes done", int_value: 15},

1665

# {name: "nodes total", int_value: 32}]

1666

# or

1667

# metrics: [{name: "progress", double_value: 0.56},

1668

# {name: "progress scale", double_value: 1.0}]

1669

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1670

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1671

"doubleValue": 3.14, # For metrics with floating point value.

1672

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1673

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1674

},

1675

],

1676

"status": "A String", # Status of an operation stage.

1677

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1678

"stages": [ # Substages of an operation or a stage.

1679

# Object with schema name: OperationProgress

1680

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1681

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1682

"targetLink": "A String", # Server-defined URL for the target of the operation.

1683

"status": "A String", # The current status of the operation.

1684

"operationType": "A String", # The operation type.

1685

"startTime": "A String", # [Output only] The time the operation started, in

1686

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1687

"clusterConditions": [ # Which conditions caused the current cluster state.

1688

{ # StatusCondition describes why a cluster or a node pool has a certain status

1689

# (e.g., ERROR or DEGRADED).

1690

"message": "A String", # Human-friendly representation of the condition

1691

"code": "A String", # Machine-friendly representation of the condition

1692

},

1693

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1694

"zone": "A String", # The name of the Google Compute Engine

1695

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1696

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1697

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1698

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1699

"detail": "A String", # Detailed operation progress, if available.

1700

"endTime": "A String", # [Output only] The time the operation completed, in

1701

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1702

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1703

{ # StatusCondition describes why a cluster or a node pool has a certain status

1704

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1705

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1706

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1707

},

1708

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1709

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1710

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1711

# or

1712

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1713

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1714

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim