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

2016-05-19 10:54:38 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dan O'Meara

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

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

80

Dan O'Meara

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

[diff] [blame]

81

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

82

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

83

Bu Sun Kim

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

[diff] [blame]

84

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

85

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

86

Bu Sun Kim

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

[diff] [blame]

87

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

88

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

89

Bu Sun Kim

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

[diff] [blame]

90

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

91

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

92

Dan O'Meara

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

95

Dan O'Meara

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

[diff] [blame]

96

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

97

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

Bu Sun Kim

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

[diff] [blame]

98

Dan O'Meara

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

[diff] [blame]

99

<code><a href="#setSize">setSize(projectId, zone, clusterId, nodePoolId, 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(projectId, zone, clusterId, nodePoolId, 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>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

104

<h3>Method Details</h3>

105

Dan O'Meara

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame]

107

<pre>Sets the autoscaling settings for the specified node pool.

108

109

Args:

110

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

111

number](https://support.google.com/cloud/answer/6158840).

112

This field has been deprecated and replaced by the name field. (required)

113

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

Dan O'Meara

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

[diff] [blame]

114

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

115

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

116

field. (required)

Bu Sun Kim

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

[diff] [blame]

117

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

118

This field has been deprecated and replaced by the name field. (required)

119

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

120

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

121

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

122

The object takes the form of:

123

124

{ # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

Bu Sun Kim

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

[diff] [blame^]

125

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

126

# number](https://support.google.com/cloud/answer/6158840).

127

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

128

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

129

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

130

"nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade.

131

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

132

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

Dan O'Meara

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

[diff] [blame]

133

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

134

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

135

# field.

Bu Sun Kim

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

[diff] [blame^]

136

"name": "A String", # The name (project, location, cluster, node pool) of the node pool to set

137

# autoscaler settings. Specified in the format

138

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

139

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Required. Autoscaling configuration for the node pool.

Bu Sun Kim

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

[diff] [blame]

140

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

Bu Sun Kim

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

[diff] [blame^]

141

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

142

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

Bu Sun Kim

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

[diff] [blame]

143

# has to enough quota to scale up the cluster.

Bu Sun Kim

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

[diff] [blame^]

144

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

145

# max_node_count.

146

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

Bu Sun Kim

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

[diff] [blame]

147

},

Bu Sun Kim

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

[diff] [blame]

148

}

149

150

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

157

158

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

159

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

Bu Sun Kim

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

[diff] [blame^]

160

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

161

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

Bu Sun Kim

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

[diff] [blame]

162

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

163

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

Bu Sun Kim

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

[diff] [blame^]

164

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

165

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

Bu Sun Kim

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

[diff] [blame]

166

},

167

],

Bu Sun Kim

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

[diff] [blame^]

168

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

Dan O'Meara

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

[diff] [blame]

169

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

Bu Sun Kim

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

[diff] [blame^]

170

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

Dan O'Meara

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

[diff] [blame]

171

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

172

# or

173

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

174

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

175

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

176

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

177

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

178

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

179

# Object with schema name: OperationProgress

180

],

181

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

182

# Unset for single-stage operations.

183

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

184

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

185

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

186

# or

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

},

195

],

196

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

197

# Unset for single-stage operations.

198

},

199

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

200

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

201

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

202

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

203

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

204

},

205

],

206

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

207

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

208

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

209

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

210

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

211

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

212

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

213

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

214

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

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]

219

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

220

<pre>Creates a node pool for a cluster.

221

222

Args:

Bu Sun Kim

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

[diff] [blame]

223

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

224

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

225

This field has been deprecated and replaced by the parent field. (required)

226

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

Dan O'Meara

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

[diff] [blame]

227

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

228

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

229

field. (required)

Bu Sun Kim

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

[diff] [blame]

230

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

231

This field has been deprecated and replaced by the parent field. (required)

Dan O'Meara

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

[diff] [blame]

232

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

233

The object takes the form of:

234

235

{ # CreateNodePoolRequest creates a node pool for a cluster.

Bu Sun Kim

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

[diff] [blame^]

236

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

Bu Sun Kim

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

[diff] [blame]

237

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

238

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

Bu Sun Kim

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

[diff] [blame^]

239

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

240

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

241

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

242

# field.

243

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

Bu Sun Kim

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

[diff] [blame]

244

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

Bu Sun Kim

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

[diff] [blame^]

245

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

246

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

247

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

248

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

249

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

250

# the workload.

Bu Sun Kim

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

[diff] [blame^]

251

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

252

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

253

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

254

# firewall and routes quota.

255

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

Dan O'Meara

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

[diff] [blame]

256

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

Bu Sun Kim

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

[diff] [blame^]

257

# NodePool's nodes should be located.

258

"A String",

Dan O'Meara

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

[diff] [blame]

259

],

Bu Sun Kim

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

[diff] [blame^]

260

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

261

"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]

262

# disruption caused by an upgrade.

263

#

264

# maxUnavailable controls the number of nodes that can be simultaneously

265

# unavailable.

266

#

267

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

268

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

269

# available nodes.

270

#

271

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

272

# nodes are being upgraded at the same time).

273

#

274

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

275

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

276

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

277

# PodDisruptionBudget, if it is configured.)

278

#

279

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

280

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

281

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

282

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

283

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame^]

284

"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]

285

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

286

# Ready.

Bu Sun Kim

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

[diff] [blame^]

287

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

288

# of the node pool during the upgrade process.

Dan O'Meara

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

[diff] [blame]

289

},

Bu Sun Kim

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

[diff] [blame^]

290

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

291

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

292

# associated with this node pool.

293

"A String",

294

],

295

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

296

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

297

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

298

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

299

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

300

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

301

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

Dan O'Meara

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

[diff] [blame]

302

},

Bu Sun Kim

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

[diff] [blame^]

303

],

304

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

305

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

306

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

307

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

308

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

309

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame^]

310

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

311

],

Bu Sun Kim

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

[diff] [blame^]

312

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

Dan O'Meara

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

[diff] [blame]

313

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

Bu Sun Kim

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

[diff] [blame^]

314

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

315

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

316

# the latest version of it will be used.

317

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

318

# node VMs under the "default" service account.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

319

#

320

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

321

# not included:

322

#

323

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

324

# persistent storage on your nodes.

325

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

326

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

327

# (the [Google Container

328

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

329

#

330

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

331

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

Bu Sun Kim

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

[diff] [blame^]

332

"A String",

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

333

],

Bu Sun Kim

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

[diff] [blame^]

334

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

Dan O'Meara

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

[diff] [blame]

335

#

336

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

337

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

338

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

339

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

340

#

Bu Sun Kim

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

[diff] [blame^]

341

# See

342

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

343

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

344

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

345

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

346

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

Dan O'Meara

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

[diff] [blame]

347

},

348

],

Bu Sun Kim

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

[diff] [blame^]

349

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

350

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

351

# Kubernetes may apply to the node.

352

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

353

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

354

# and conflicts should be avoided.

355

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

356

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

357

"a_key": "A String",

358

},

359

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

360

# The smallest allowed disk size is 10GB.

361

#

362

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

363

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

364

# workloads on the node pool.

365

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

366

# on the node pool.

367

},

368

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

369

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

370

# support for GPUs.

371

{ # AcceleratorConfig represents a Hardware Accelerator request.

372

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

373

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

374

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

375

},

376

],

377

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

378

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

379

# `n1-standard-1`).

380

#

381

# If unspecified, the default machine type is

382

# `n1-standard-1`.

383

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

384

#

385

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

386

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

387

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

388

#

389

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

390

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

391

# boot process if signature verification fails.

392

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

393

#

394

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

395

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

396

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

397

# the instance is created.

398

},

399

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

400

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

401

# friendly names of CPU platforms, such as

402

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

403

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

404

# information, read [how to specify min CPU

405

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

406

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

407

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

408

# information about preemptible VM instances.

409

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

410

#

Dan O'Meara

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

[diff] [blame]

411

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

412

# disks available on a machine per zone. See:

Dan O'Meara

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

[diff] [blame]

413

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

414

# for more information.

Bu Sun Kim

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

[diff] [blame^]

415

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

416

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

Bu Sun Kim

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

[diff] [blame]

417

},

Bu Sun Kim

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

[diff] [blame^]

418

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

419

#

420

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

421

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

422

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

423

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

429

# "enable-os-login"

430

# "gci-ensure-gke-docker"

431

# "gci-metrics-enabled"

432

# "gci-update-strategy"

433

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

438

# "windows-startup-script-ps1"

439

# "common-psm1"

440

# "k8s-node-setup-psm1"

441

# "install-ssh-psm1"

442

# "user-profile-psm1"

443

# "serial-port-logging-enable"

444

#

445

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

446

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

447

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

448

#

449

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

450

"a_key": "A String",

451

},

452

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

453

# the specified [Zonal Compute

454

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

455

# to this node pool.

456

# is the configuration of desired reservation which instances could take

457

# capacity from.

458

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

459

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

460

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

461

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

462

"A String",

463

],

464

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

465

},

466

},

467

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

468

# simultaneously on a node in the node pool.

469

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

470

},

471

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

472

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

473

# node pool.

474

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

475

# the Auto Upgrades will proceed.

476

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

477

# with the description of the upgrade.

478

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

479

# with the approximate start time for the upgrades, in

480

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

481

},

482

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

483

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

484

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

485

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

486

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

487

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

488

# triggered.

489

},

490

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

Dan O'Meara

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

[diff] [blame]

491

# node pool instance, if available.

Bu Sun Kim

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

[diff] [blame^]

492

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

493

# only if a valid configuration is present.

494

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

495

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

496

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

497

# has to enough quota to scale up the cluster.

498

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

499

# max_node_count.

500

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

501

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

502

},

Bu Sun Kim

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

[diff] [blame^]

503

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

504

# created. Specified in the format

505

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

506

}

507

508

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

509

Allowed values

510

1 - v1 error format

511

2 - v2 error format

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

512

513

Returns:

514

An object of the form:

515

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

516

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

517

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

Bu Sun Kim

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

[diff] [blame^]

518

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

519

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

Bu Sun Kim

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

[diff] [blame]

520

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

521

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

Bu Sun Kim

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

[diff] [blame^]

522

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

523

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

Bu Sun Kim

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

[diff] [blame]

524

},

525

],

Bu Sun Kim

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

[diff] [blame^]

526

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

Dan O'Meara

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

[diff] [blame]

527

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

Bu Sun Kim

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

[diff] [blame^]

528

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

Dan O'Meara

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

[diff] [blame]

529

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

530

# or

531

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

532

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

533

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

534

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

535

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

536

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

537

# Object with schema name: OperationProgress

538

],

539

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

540

# Unset for single-stage operations.

541

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

542

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

543

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

544

# or

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

},

553

],

554

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

555

# Unset for single-stage operations.

556

},

557

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

558

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

559

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

560

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

561

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

562

},

563

],

564

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

565

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

566

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

567

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

568

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

569

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

570

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

571

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

572

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

577

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

578

<pre>Deletes a node pool from a cluster.

579

580

Args:

Bu Sun Kim

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

[diff] [blame]

581

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

582

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

583

This field has been deprecated and replaced by the name field. (required)

584

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

Dan O'Meara

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

[diff] [blame]

585

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

586

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

587

field. (required)

Bu Sun Kim

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

[diff] [blame]

588

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

589

This field has been deprecated and replaced by the name field. (required)

590

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

591

This field has been deprecated and replaced by the name field. (required)

592

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

593

delete. Specified in the format

Bu Sun Kim

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

[diff] [blame^]

594

`projects/*/locations/*/clusters/*/nodePools/*`.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

595

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

596

Allowed values

597

1 - v1 error format

598

2 - v2 error format

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

599

600

Returns:

601

An object of the form:

602

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

603

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

604

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

Bu Sun Kim

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

[diff] [blame^]

605

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

606

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

Bu Sun Kim

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

[diff] [blame]

607

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

608

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

Bu Sun Kim

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

[diff] [blame^]

609

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

610

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

Bu Sun Kim

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

[diff] [blame]

611

},

612

],

Bu Sun Kim

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

[diff] [blame^]

613

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

Dan O'Meara

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

[diff] [blame]

614

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

Bu Sun Kim

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

[diff] [blame^]

615

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

Dan O'Meara

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

[diff] [blame]

616

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

617

# or

618

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

619

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

620

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

621

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

622

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

623

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

624

# Object with schema name: OperationProgress

625

],

626

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

627

# Unset for single-stage operations.

628

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

629

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

630

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

631

# or

632

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

633

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

634

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

635

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

636

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

637

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

638

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

639

},

640

],

641

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

642

# Unset for single-stage operations.

643

},

644

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

645

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

646

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

647

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

648

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

649

},

650

],

651

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

652

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

653

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

654

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

655

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

656

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

657

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

658

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

659

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

664

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

665

<pre>Retrieves the requested node pool.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

666

667

Args:

Bu Sun Kim

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

[diff] [blame]

668

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

669

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

670

This field has been deprecated and replaced by the name field. (required)

671

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

Dan O'Meara

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

[diff] [blame]

672

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

673

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

674

field. (required)

Bu Sun Kim

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

[diff] [blame]

675

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

676

This field has been deprecated and replaced by the name field. (required)

677

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

678

This field has been deprecated and replaced by the name field. (required)

679

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

680

get. Specified in the format

Bu Sun Kim

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

[diff] [blame^]

681

`projects/*/locations/*/clusters/*/nodePools/*`.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

682

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

683

Allowed values

684

1 - v1 error format

685

2 - v2 error format

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

686

687

Returns:

688

An object of the form:

689

Bu Sun Kim

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

[diff] [blame^]

690

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

691

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

692

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

693

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

694

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

695

# the workload.

Bu Sun Kim

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

[diff] [blame^]

696

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

697

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

698

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

699

# firewall and routes quota.

700

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

Dan O'Meara

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

[diff] [blame]

701

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

Bu Sun Kim

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

[diff] [blame^]

702

# NodePool's nodes should be located.

703

"A String",

Dan O'Meara

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

[diff] [blame]

704

],

Bu Sun Kim

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

[diff] [blame^]

705

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

706

"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]

707

# disruption caused by an upgrade.

708

#

709

# maxUnavailable controls the number of nodes that can be simultaneously

710

# unavailable.

711

#

712

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

713

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

714

# available nodes.

715

#

716

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

717

# nodes are being upgraded at the same time).

718

#

719

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

720

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

721

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

722

# PodDisruptionBudget, if it is configured.)

723

#

724

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

725

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

726

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

727

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

728

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame^]

729

"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]

730

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

731

# Ready.

Bu Sun Kim

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

[diff] [blame^]

732

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

733

# of the node pool during the upgrade process.

Dan O'Meara

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

[diff] [blame]

734

},

Bu Sun Kim

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

[diff] [blame^]

735

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

736

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

737

# associated with this node pool.

738

"A String",

739

],

740

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

741

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

742

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

743

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

744

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

745

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

746

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

Dan O'Meara

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

[diff] [blame]

747

},

Bu Sun Kim

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

[diff] [blame^]

748

],

749

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

750

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

751

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

752

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

753

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

754

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame^]

755

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

756

],

Bu Sun Kim

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

[diff] [blame^]

757

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

Dan O'Meara

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

[diff] [blame]

758

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

Bu Sun Kim

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

[diff] [blame^]

759

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

760

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

761

# the latest version of it will be used.

762

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

763

# node VMs under the "default" service account.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

764

#

765

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

766

# not included:

767

#

768

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

769

# persistent storage on your nodes.

770

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

771

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

772

# (the [Google Container

773

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

774

#

775

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

776

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

Bu Sun Kim

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

[diff] [blame^]

777

"A String",

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

778

],

Bu Sun Kim

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

[diff] [blame^]

779

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

Dan O'Meara

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

[diff] [blame]

780

#

781

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

782

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

783

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

784

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

785

#

Bu Sun Kim

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

[diff] [blame^]

786

# See

787

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

788

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

789

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

790

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

791

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

Dan O'Meara

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

[diff] [blame]

792

},

793

],

Bu Sun Kim

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

[diff] [blame^]

794

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

795

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

796

# Kubernetes may apply to the node.

797

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

798

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

799

# and conflicts should be avoided.

800

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

801

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

802

"a_key": "A String",

803

},

804

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

805

# The smallest allowed disk size is 10GB.

806

#

807

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

808

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

809

# workloads on the node pool.

810

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

811

# on the node pool.

812

},

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

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

818

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

819

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

820

},

821

],

822

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

823

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

824

# `n1-standard-1`).

825

#

826

# If unspecified, the default machine type is

827

# `n1-standard-1`.

828

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

829

#

830

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

831

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

832

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

833

#

834

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

835

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

836

# boot process if signature verification fails.

837

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

838

#

839

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

840

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

841

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

842

# the instance is created.

843

},

844

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

845

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

846

# friendly names of CPU platforms, such as

847

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

848

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

849

# information, read [how to specify min CPU

850

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

851

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

852

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

853

# information about preemptible VM instances.

854

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

855

#

Dan O'Meara

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

[diff] [blame]

856

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

857

# disks available on a machine per zone. See:

Dan O'Meara

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

[diff] [blame]

858

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

859

# for more information.

Bu Sun Kim

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

[diff] [blame^]

860

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

861

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

Bu Sun Kim

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

[diff] [blame]

862

},

Bu Sun Kim

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

[diff] [blame^]

863

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

864

#

865

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

866

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

867

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

868

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

874

# "enable-os-login"

875

# "gci-ensure-gke-docker"

876

# "gci-metrics-enabled"

877

# "gci-update-strategy"

878

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

883

# "windows-startup-script-ps1"

884

# "common-psm1"

885

# "k8s-node-setup-psm1"

886

# "install-ssh-psm1"

887

# "user-profile-psm1"

888

# "serial-port-logging-enable"

889

#

890

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

891

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

892

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

893

#

894

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

895

"a_key": "A String",

896

},

897

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

898

# the specified [Zonal Compute

899

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

900

# to this node pool.

901

# is the configuration of desired reservation which instances could take

902

# capacity from.

903

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

904

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

905

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

906

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

907

"A String",

908

],

909

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

910

},

911

},

912

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

913

# simultaneously on a node in the node pool.

914

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

915

},

916

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

917

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

918

# node pool.

919

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

920

# the Auto Upgrades will proceed.

921

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

922

# with the description of the upgrade.

923

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

924

# with the approximate start time for the upgrades, in

925

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

926

},

927

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

928

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

929

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

930

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

931

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

932

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

933

# triggered.

934

},

935

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

Dan O'Meara

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

[diff] [blame]

936

# node pool instance, if available.

Bu Sun Kim

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

[diff] [blame^]

937

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

938

# only if a valid configuration is present.

939

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

940

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

941

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

942

# has to enough quota to scale up the cluster.

943

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

944

# max_node_count.

945

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

946

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

951

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

952

<pre>Lists the node pools for a cluster.

953

954

Args:

Bu Sun Kim

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

[diff] [blame]

955

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

956

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

957

This field has been deprecated and replaced by the parent field. (required)

958

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

Dan O'Meara

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

[diff] [blame]

959

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

960

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

961

field. (required)

Bu Sun Kim

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

[diff] [blame]

962

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

963

This field has been deprecated and replaced by the parent field. (required)

964

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^]

965

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

966

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

967

Allowed values

968

1 - v1 error format

969

2 - v2 error format

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

970

971

Returns:

972

An object of the form:

973

974

{ # ListNodePoolsResponse is the result of ListNodePoolsRequest.

Bu Sun Kim

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

[diff] [blame^]

975

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

976

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

977

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

978

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

979

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

980

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

981

# the workload.

Bu Sun Kim

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

[diff] [blame^]

982

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

983

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

984

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

985

# firewall and routes quota.

986

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

Dan O'Meara

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

[diff] [blame]

987

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

Bu Sun Kim

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

[diff] [blame^]

988

# NodePool's nodes should be located.

989

"A String",

Dan O'Meara

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

[diff] [blame]

990

],

Bu Sun Kim

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

[diff] [blame^]

991

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

992

"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]

993

# disruption caused by an upgrade.

994

#

995

# maxUnavailable controls the number of nodes that can be simultaneously

996

# unavailable.

997

#

998

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

999

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

1000

# available nodes.

1001

#

1002

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

1003

# nodes are being upgraded at the same time).

1004

#

1005

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

1006

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

1007

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

1008

# PodDisruptionBudget, if it is configured.)

1009

#

1010

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

1011

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

1012

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

1013

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

1014

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame^]

1015

"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]

1016

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

1017

# Ready.

Bu Sun Kim

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

[diff] [blame^]

1018

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

1019

# of the node pool during the upgrade process.

Dan O'Meara

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

[diff] [blame]

1020

},

Bu Sun Kim

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

[diff] [blame^]

1021

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

1022

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

1023

# associated with this node pool.

1024

"A String",

1025

],

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

Dan O'Meara

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

[diff] [blame]

1033

},

Bu Sun Kim

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

[diff] [blame^]

1034

],

1035

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

1036

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

1037

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1038

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

1039

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

1040

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame^]

1041

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1042

],

Bu Sun Kim

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

[diff] [blame^]

1043

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

Dan O'Meara

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

[diff] [blame]

1044

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

Bu Sun Kim

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

[diff] [blame^]

1045

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

1046

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

1047

# the latest version of it will be used.

1048

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

1049

# node VMs under the "default" service account.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1050

#

1051

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

1052

# not included:

1053

#

1054

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

1055

# persistent storage on your nodes.

1056

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

1057

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

1058

# (the [Google Container

1059

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1060

#

1061

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

1062

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

Bu Sun Kim

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

[diff] [blame^]

1063

"A String",

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1064

],

Bu Sun Kim

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

[diff] [blame^]

1065

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

Dan O'Meara

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

[diff] [blame]

1066

#

1067

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

1068

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

1069

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

1070

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

1071

#

Bu Sun Kim

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

[diff] [blame^]

1072

# See

1073

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

1074

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

1075

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

1076

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

1077

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

Dan O'Meara

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

[diff] [blame]

1078

},

1079

],

Bu Sun Kim

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

[diff] [blame^]

1080

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

1081

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

1082

# Kubernetes may apply to the node.

1083

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

1084

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

1085

# and conflicts should be avoided.

1086

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

1087

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

1088

"a_key": "A String",

1089

},

1090

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

1091

# The smallest allowed disk size is 10GB.

1092

#

1093

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

1094

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

1095

# workloads on the node pool.

1096

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

1097

# on the node pool.

1098

},

1099

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

1100

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

1101

# support for GPUs.

1102

{ # AcceleratorConfig represents a Hardware Accelerator request.

1103

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

1104

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

1105

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

1106

},

1107

],

1108

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

1109

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

1110

# `n1-standard-1`).

1111

#

1112

# If unspecified, the default machine type is

1113

# `n1-standard-1`.

1114

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

1115

#

1116

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

1117

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

1118

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

1119

#

1120

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

1121

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

1122

# boot process if signature verification fails.

1123

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

1124

#

1125

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

1126

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

1127

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

1128

# the instance is created.

1129

},

1130

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

1131

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

1132

# friendly names of CPU platforms, such as

1133

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

1134

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

1135

# information, read [how to specify min CPU

1136

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

1137

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

1138

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

1139

# information about preemptible VM instances.

1140

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1141

#

Dan O'Meara

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

[diff] [blame]

1142

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1143

# disks available on a machine per zone. See:

Dan O'Meara

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

[diff] [blame]

1144

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1145

# for more information.

Bu Sun Kim

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

[diff] [blame^]

1146

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

1147

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

Bu Sun Kim

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

[diff] [blame]

1148

},

Bu Sun Kim

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

[diff] [blame^]

1149

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

1150

#

1151

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

1152

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

1153

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

1154

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1160

# "enable-os-login"

1161

# "gci-ensure-gke-docker"

1162

# "gci-metrics-enabled"

1163

# "gci-update-strategy"

1164

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1169

# "windows-startup-script-ps1"

1170

# "common-psm1"

1171

# "k8s-node-setup-psm1"

1172

# "install-ssh-psm1"

1173

# "user-profile-psm1"

1174

# "serial-port-logging-enable"

1175

#

1176

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

1177

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

1178

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

1179

#

1180

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

1181

"a_key": "A String",

1182

},

1183

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

1184

# the specified [Zonal Compute

1185

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

1186

# to this node pool.

1187

# is the configuration of desired reservation which instances could take

1188

# capacity from.

1189

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

1190

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

1191

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

1192

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

1193

"A String",

1194

],

1195

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

1196

},

1197

},

1198

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

1199

# simultaneously on a node in the node pool.

1200

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

1201

},

1202

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

1203

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

1204

# node pool.

1205

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

1206

# the Auto Upgrades will proceed.

1207

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

1208

# with the description of the upgrade.

1209

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

1210

# with the approximate start time for the upgrades, in

1211

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

1212

},

1213

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

1214

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

1215

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

1216

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

1217

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

1218

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

1219

# triggered.

1220

},

1221

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

Dan O'Meara

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

[diff] [blame]

1222

# node pool instance, if available.

Bu Sun Kim

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

[diff] [blame^]

1223

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

1224

# only if a valid configuration is present.

1225

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

1226

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

1227

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

1228

# has to enough quota to scale up the cluster.

1229

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

1230

# max_node_count.

1231

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

1232

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

},

],

}</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1238

Dan O'Meara

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

[diff] [blame]

1239

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

Bu Sun Kim

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

[diff] [blame]

1240

<pre>Rolls back a previously Aborted or Failed NodePool upgrade.

1241

This makes no changes if the last upgrade successfully completed.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1242

1243

Args:

Bu Sun Kim

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

[diff] [blame]

1244

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

1245

number](https://support.google.com/cloud/answer/6158840).

1246

This field has been deprecated and replaced by the name field. (required)

1247

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

Dan O'Meara

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

[diff] [blame]

1248

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

1249

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

1250

field. (required)

Bu Sun Kim

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

[diff] [blame]

1251

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

1252

This field has been deprecated and replaced by the name field. (required)

1253

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

1254

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

1255

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1256

The object takes the form of:

1257

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1258

{ # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed

1259

# NodePool upgrade. This will be an no-op if the last upgrade successfully

1260

# completed.

Bu Sun Kim

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

[diff] [blame^]

1261

"name": "A String", # The name (project, location, cluster, node pool id) of the node poll to

1262

# rollback upgrade.

1263

# Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.

1264

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

Bu Sun Kim

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

[diff] [blame]

1265

# number](https://support.google.com/cloud/answer/6158840).

1266

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

Bu Sun Kim

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

[diff] [blame^]

1267

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

Dan O'Meara

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

[diff] [blame]

1268

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

1269

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

1270

# field.

Bu Sun Kim

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

[diff] [blame^]

1271

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

1272

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

1273

"nodePoolId": "A String", # Deprecated. The name of the node pool to rollback.

Bu Sun Kim

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

[diff] [blame]

1274

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1275

}

1276

1277

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1278

Allowed values

1279

1 - v1 error format

1280

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1281

1282

Returns:

1283

An object of the form:

1284

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1285

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

1286

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1287

"name": "A String", # The server-assigned ID for the operation.

1288

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1289

{ # StatusCondition describes why a cluster or a node pool has a certain status

1290

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1291

"message": "A String", # Human-friendly representation of the condition

1292

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1293

},

1294

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1295

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1296

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1297

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1298

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1299

# or

1300

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1301

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1302

"startTime": "A String", # [Output only] The time the operation started, in

1303

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1304

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1305

"stages": [ # Substages of an operation or a stage.

1306

# Object with schema name: OperationProgress

1307

],

1308

"status": "A String", # Status of an operation stage.

1309

# Unset for single-stage operations.

1310

"metrics": [ # Progress metric bundle, for example:

1311

# metrics: [{name: "nodes done", int_value: 15},

1312

# {name: "nodes total", int_value: 32}]

1313

# or

1314

# metrics: [{name: "progress", double_value: 0.56},

1315

# {name: "progress scale", double_value: 1.0}]

1316

{ # Progress metric is (string, int|float|string) pair.

1317

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1318

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1319

"doubleValue": 3.14, # For metrics with floating point value.

1320

"intValue": "A String", # For metrics with integer value.

1321

},

1322

],

1323

"name": "A String", # A non-parameterized string describing an operation stage.

1324

# Unset for single-stage operations.

1325

},

1326

"clusterConditions": [ # Which conditions caused the current cluster state.

1327

{ # StatusCondition describes why a cluster or a node pool has a certain status

1328

# (e.g., ERROR or DEGRADED).

1329

"message": "A String", # Human-friendly representation of the condition

1330

"code": "A String", # Machine-friendly representation of the condition

1331

},

1332

],

1333

"zone": "A String", # The name of the Google Compute Engine

1334

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1335

# operation is taking place. This field is deprecated, use location instead.

1336

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1337

"selfLink": "A String", # Server-defined URL for the resource.

1338

"detail": "A String", # Detailed operation progress, if available.

1339

"targetLink": "A String", # Server-defined URL for the target of the operation.

1340

"operationType": "A String", # The operation type.

1341

"status": "A String", # The current status of the operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1346

<code class="details" id="setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1347

<pre>Sets the NodeManagement options for a node pool.

1348

1349

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1350

projectId: string, Deprecated. The Google Developers Console [project ID or project

1351

number](https://support.google.com/cloud/answer/6158840).

1352

This field has been deprecated and replaced by the name field. (required)

1353

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1354

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1355

cluster resides. This field has been deprecated and replaced by the name

1356

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1357

clusterId: string, Deprecated. The name of the cluster to update.

1358

This field has been deprecated and replaced by the name field. (required)

1359

nodePoolId: string, Deprecated. The name of the node pool to update.

1360

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1361

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1362

The object takes the form of:

1363

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1364

{ # SetNodePoolManagementRequest sets the node management properties of a node

1365

# pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1366

"clusterId": "A String", # Deprecated. The name of the cluster to update.

1367

# This field has been deprecated and replaced by the name field.

1368

"nodePoolId": "A String", # Deprecated. The name of the node pool to update.

1369

# This field has been deprecated and replaced by the name field.

1370

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1371

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1372

# cluster resides. This field has been deprecated and replaced by the name

1373

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1374

"name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set

1375

# management properties. Specified in the format

1376

# `projects/*/locations/*/clusters/*/nodePools/*`.

1377

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1378

# number](https://support.google.com/cloud/answer/6158840).

1379

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1380

"management": { # NodeManagement defines the set of node management services turned on for the # Required. NodeManagement configuration for the node pool.

1381

# node pool.

1382

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

1383

# the Auto Upgrades will proceed.

1384

"description": "A String", # [Output only] This field is set when upgrades are about to commence

1385

# with the description of the upgrade.

1386

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

1387

# with the approximate start time for the upgrades, in

1388

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1389

},

1390

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

1391

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

1392

# up to date with the latest release version of Kubernetes.

1393

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

1394

# pool. If enabled, the nodes in this node pool will be monitored and, if

1395

# they fail health checks too many times, an automatic repair action will be

1396

# triggered.

1397

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1398

}

1399

1400

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1401

Allowed values

1402

1 - v1 error format

1403

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1404

1405

Returns:

1406

An object of the form:

1407

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1408

{ # This operation resource represents operations that may have happened or are

1409

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1410

"name": "A String", # The server-assigned ID for the operation.

1411

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1412

{ # StatusCondition describes why a cluster or a node pool has a certain status

1413

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1414

"message": "A String", # Human-friendly representation of the condition

1415

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1416

},

1417

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1418

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1419

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1420

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1421

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1422

# or

1423

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1424

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1425

"startTime": "A String", # [Output only] The time the operation started, in

1426

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1427

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1428

"stages": [ # Substages of an operation or a stage.

1429

# Object with schema name: OperationProgress

1430

],

1431

"status": "A String", # Status of an operation stage.

1432

# Unset for single-stage operations.

1433

"metrics": [ # Progress metric bundle, for example:

1434

# metrics: [{name: "nodes done", int_value: 15},

1435

# {name: "nodes total", int_value: 32}]

1436

# or

1437

# metrics: [{name: "progress", double_value: 0.56},

1438

# {name: "progress scale", double_value: 1.0}]

1439

{ # Progress metric is (string, int|float|string) pair.

1440

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1441

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1442

"doubleValue": 3.14, # For metrics with floating point value.

1443

"intValue": "A String", # For metrics with integer value.

1444

},

1445

],

1446

"name": "A String", # A non-parameterized string describing an operation stage.

1447

# Unset for single-stage operations.

1448

},

1449

"clusterConditions": [ # Which conditions caused the current cluster state.

1450

{ # StatusCondition describes why a cluster or a node pool has a certain status

1451

# (e.g., ERROR or DEGRADED).

1452

"message": "A String", # Human-friendly representation of the condition

1453

"code": "A String", # Machine-friendly representation of the condition

1454

},

1455

],

1456

"zone": "A String", # The name of the Google Compute Engine

1457

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1458

# operation is taking place. This field is deprecated, use location instead.

1459

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1460

"selfLink": "A String", # Server-defined URL for the resource.

1461

"detail": "A String", # Detailed operation progress, if available.

1462

"targetLink": "A String", # Server-defined URL for the target of the operation.

1463

"operationType": "A String", # The operation type.

1464

"status": "A String", # The current status of the operation.

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]

1469

<code class="details" id="setSize">setSize(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1470

<pre>Sets the size for a specific node pool.

1471

1472

Args:

1473

projectId: string, Deprecated. The Google Developers Console [project ID or project

1474

number](https://support.google.com/cloud/answer/6158840).

1475

This field has been deprecated and replaced by the name field. (required)

1476

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1477

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1478

cluster resides. This field has been deprecated and replaced by the name

1479

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1480

clusterId: string, Deprecated. The name of the cluster to update.

1481

This field has been deprecated and replaced by the name field. (required)

1482

nodePoolId: string, Deprecated. The name of the node pool to update.

1483

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1484

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1485

The object takes the form of:

1486

1487

{ # SetNodePoolSizeRequest sets the size a node

1488

# pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1489

"clusterId": "A String", # Deprecated. The name of the cluster to update.

1490

# This field has been deprecated and replaced by the name field.

1491

"nodePoolId": "A String", # Deprecated. The name of the node pool to update.

1492

# This field has been deprecated and replaced by the name field.

1493

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1494

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1495

# cluster resides. This field has been deprecated and replaced by the name

1496

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1497

"nodeCount": 42, # Required. The desired node count for the pool.

1498

"name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set

1499

# size.

1500

# Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.

1501

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1502

# number](https://support.google.com/cloud/answer/6158840).

1503

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1504

}

1505

1506

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1513

1514

{ # This operation resource represents operations that may have happened or are

1515

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1516

"name": "A String", # The server-assigned ID for the operation.

1517

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1518

{ # StatusCondition describes why a cluster or a node pool has a certain status

1519

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1520

"message": "A String", # Human-friendly representation of the condition

1521

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1522

},

1523

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1524

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1525

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1526

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1527

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1528

# or

1529

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1530

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1531

"startTime": "A String", # [Output only] The time the operation started, in

1532

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1533

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1534

"stages": [ # Substages of an operation or a stage.

1535

# Object with schema name: OperationProgress

1536

],

1537

"status": "A String", # Status of an operation stage.

1538

# Unset for single-stage operations.

1539

"metrics": [ # Progress metric bundle, for example:

1540

# metrics: [{name: "nodes done", int_value: 15},

1541

# {name: "nodes total", int_value: 32}]

1542

# or

1543

# metrics: [{name: "progress", double_value: 0.56},

1544

# {name: "progress scale", double_value: 1.0}]

1545

{ # Progress metric is (string, int|float|string) pair.

1546

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1547

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1548

"doubleValue": 3.14, # For metrics with floating point value.

1549

"intValue": "A String", # For metrics with integer value.

1550

},

1551

],

1552

"name": "A String", # A non-parameterized string describing an operation stage.

1553

# Unset for single-stage operations.

1554

},

1555

"clusterConditions": [ # Which conditions caused the current cluster state.

1556

{ # StatusCondition describes why a cluster or a node pool has a certain status

1557

# (e.g., ERROR or DEGRADED).

1558

"message": "A String", # Human-friendly representation of the condition

1559

"code": "A String", # Machine-friendly representation of the condition

1560

},

1561

],

1562

"zone": "A String", # The name of the Google Compute Engine

1563

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1564

# operation is taking place. This field is deprecated, use location instead.

1565

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1566

"selfLink": "A String", # Server-defined URL for the resource.

1567

"detail": "A String", # Detailed operation progress, if available.

1568

"targetLink": "A String", # Server-defined URL for the target of the operation.

1569

"operationType": "A String", # The operation type.

1570

"status": "A String", # The current status of the operation.

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]

1575

<code class="details" id="update">update(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1576

<pre>Updates the version and/or image type for the specified node pool.

1577

1578

Args:

1579

projectId: string, Deprecated. The Google Developers Console [project ID or project

1580

number](https://support.google.com/cloud/answer/6158840).

1581

This field has been deprecated and replaced by the name field. (required)

1582

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1583

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1584

cluster resides. This field has been deprecated and replaced by the name

1585

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1586

clusterId: string, Deprecated. The name of the cluster to upgrade.

1587

This field has been deprecated and replaced by the name field. (required)

1588

nodePoolId: string, Deprecated. The name of the node pool to upgrade.

1589

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1590

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1591

The object takes the form of:

1592

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1593

{ # UpdateNodePoolRequests update a node pool's image and/or version.

1594

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

1595

# This field has been deprecated and replaced by the name field.

1596

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The desired workload metadata config for the node pool.

1597

# workloads on the node pool.

1598

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

1599

# on the node pool.

1600

},

1601

"nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade.

1602

# This field has been deprecated and replaced by the name field.

1603

"imageType": "A String", # Required. The desired image type for the node pool.

1604

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1605

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1606

# cluster resides. This field has been deprecated and replaced by the name

1607

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1608

"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an

1609

# upgrade).

1610

#

1611

# Users may specify either explicit versions offered by Kubernetes Engine or

1612

# version aliases, which have the following behavior:

1613

#

1614

# - "latest": picks the highest valid Kubernetes version

1615

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

1616

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

1617

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

1618

# - "-": picks the Kubernetes master version

1619

"name": "A String", # The name (project, location, cluster, node pool) of the node pool to

1620

# update. Specified in the format

1621

# `projects/*/locations/*/clusters/*/nodePools/*`.

1622

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1623

# number](https://support.google.com/cloud/answer/6158840).

1624

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1625

"locations": [ # The desired list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1626

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1627

# node pool's nodes should be located. Changing the locations for a node pool

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1628

# will result in nodes being either created or removed from the node pool,

1629

# depending on whether locations are being added or removed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1630

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1631

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1632

"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]

1633

# disruption caused by an upgrade.

1634

#

1635

# maxUnavailable controls the number of nodes that can be simultaneously

1636

# unavailable.

1637

#

1638

# maxSurge controls the number of additional nodes that can be added to the

1639

# node pool temporarily for the time of the upgrade to increase the number of

1640

# available nodes.

1641

#

1642

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

1643

# nodes are being upgraded at the same time).

1644

#

1645

# Note: upgrades inevitably introduce some disruption since workloads need to

1646

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

1647

# this holds true. (Disruption stays within the limits of

1648

# PodDisruptionBudget, if it is configured.)

1649

#

1650

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

1651

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

1652

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

1653

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

1654

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1655

"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]

1656

# the upgrade process. A node is considered available if its status is

1657

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1658

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

1659

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1660

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1661

}

1662

1663

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1670

1671

{ # This operation resource represents operations that may have happened or are

1672

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1673

"name": "A String", # The server-assigned ID for the operation.

1674

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1675

{ # StatusCondition describes why a cluster or a node pool has a certain status

1676

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1677

"message": "A String", # Human-friendly representation of the condition

1678

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1679

},

1680

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1681

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1682

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1683

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1684

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1685

# or

1686

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1687

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1688

"startTime": "A String", # [Output only] The time the operation started, in

1689

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1690

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1691

"stages": [ # Substages of an operation or a stage.

1692

# Object with schema name: OperationProgress

1693

],

1694

"status": "A String", # Status of an operation stage.

1695

# Unset for single-stage operations.

1696

"metrics": [ # Progress metric bundle, for example:

1697

# metrics: [{name: "nodes done", int_value: 15},

1698

# {name: "nodes total", int_value: 32}]

1699

# or

1700

# metrics: [{name: "progress", double_value: 0.56},

1701

# {name: "progress scale", double_value: 1.0}]

1702

{ # Progress metric is (string, int|float|string) pair.

1703

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1704

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1705

"doubleValue": 3.14, # For metrics with floating point value.

1706

"intValue": "A String", # For metrics with integer value.

1707

},

1708

],

1709

"name": "A String", # A non-parameterized string describing an operation stage.

1710

# Unset for single-stage operations.

1711

},

1712

"clusterConditions": [ # Which conditions caused the current cluster state.

1713

{ # StatusCondition describes why a cluster or a node pool has a certain status

1714

# (e.g., ERROR or DEGRADED).

1715

"message": "A String", # Human-friendly representation of the condition

1716

"code": "A String", # Machine-friendly representation of the condition

1717

},

1718

],

1719

"zone": "A String", # The name of the Google Compute Engine

1720

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1721

# operation is taking place. This field is deprecated, use location instead.

1722

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1723

"selfLink": "A String", # Server-defined URL for the resource.

1724

"detail": "A String", # Detailed operation progress, if available.

1725

"targetLink": "A String", # Server-defined URL for the target of the operation.

1726

"operationType": "A String", # The operation type.

1727

"status": "A String", # The current status of the operation.

Sai Cheemalapati