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

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

[diff] [blame]

83

<code><a href="container_v1.projects.locations.clusters.well_known.html">well_known()</a></code>

Bu Sun Kim

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

[diff] [blame]

84

</p>

Dan O'Meara

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

[diff] [blame]

85

<p class="firstline">Returns the well_known Resource.</p>

Bu Sun Kim

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

[diff] [blame]

86

87

Dan O'Meara

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

[diff] [blame]

88

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

Bu Sun Kim

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

[diff] [blame]

89

<p class="firstline">Completes master IP rotation.</p>

90

Dan O'Meara

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

[diff] [blame]

91

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

Bu Sun Kim

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

[diff] [blame]

92

<p class="firstline">Creates a cluster, consisting of the specified number and type of Google</p>

93

Bu Sun Kim

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

[diff] [blame^]

94

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

Bu Sun Kim

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

[diff] [blame]

95

<p class="firstline">Deletes the cluster, including the Kubernetes endpoint and all worker</p>

96

Bu Sun Kim

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

[diff] [blame^]

97

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

Bu Sun Kim

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

[diff] [blame]

98

<p class="firstline">Gets the details of a specific cluster.</p>

99

100

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

101

<p class="firstline">Gets the public component of the cluster signing keys in</p>

102

Bu Sun Kim

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

[diff] [blame^]

103

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

Bu Sun Kim

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

[diff] [blame]

104

<p class="firstline">Lists all clusters owned by a project in either the specified zone or all</p>

105

Dan O'Meara

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame]

107

<p class="firstline">Sets the addons for a specific cluster.</p>

108

Dan O'Meara

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

[diff] [blame]

109

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

Bu Sun Kim

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

[diff] [blame]

110

<p class="firstline">Enables or disables the ABAC authorization mechanism on a cluster.</p>

111

Dan O'Meara

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

[diff] [blame]

112

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

Bu Sun Kim

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

[diff] [blame]

113

<p class="firstline">Sets the locations for a specific cluster.</p>

114

Dan O'Meara

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

[diff] [blame]

115

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

Bu Sun Kim

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

[diff] [blame]

116

<p class="firstline">Sets the logging service for a specific cluster.</p>

117

Dan O'Meara

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

[diff] [blame]

118

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

Bu Sun Kim

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

[diff] [blame]

119

<p class="firstline">Sets the maintenance policy for a cluster.</p>

120

Dan O'Meara

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

[diff] [blame]

121

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

Bu Sun Kim

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

[diff] [blame]

122

<p class="firstline">Sets master auth materials. Currently supports changing the admin password</p>

123

Dan O'Meara

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

[diff] [blame]

124

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

Bu Sun Kim

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

[diff] [blame]

125

<p class="firstline">Sets the monitoring service for a specific cluster.</p>

126

Dan O'Meara

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

[diff] [blame]

127

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

Bu Sun Kim

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

[diff] [blame]

128

<p class="firstline">Enables or disables Network Policy for a cluster.</p>

129

Dan O'Meara

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

[diff] [blame]

130

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

Bu Sun Kim

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

[diff] [blame]

131

<p class="firstline">Sets labels on a cluster.</p>

132

Dan O'Meara

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

[diff] [blame]

133

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

Bu Sun Kim

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

[diff] [blame]

134

<p class="firstline">Starts master IP rotation.</p>

135

Dan O'Meara

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

[diff] [blame]

136

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

Bu Sun Kim

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

[diff] [blame]

137

<p class="firstline">Updates the settings of a specific cluster.</p>

138

Dan O'Meara

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

[diff] [blame]

139

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

Bu Sun Kim

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

[diff] [blame]

140

<p class="firstline">Updates the master for a specific cluster.</p>

141

<h3>Method Details</h3>

142

Dan O'Meara

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

[diff] [blame]

143

<code class="details" id="completeIpRotation">completeIpRotation(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

144

<pre>Completes master IP rotation.

145

146

Args:

147

name: string, The name (project, location, cluster id) of the cluster to complete IP

Bu Sun Kim

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

[diff] [blame]

148

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

Dan O'Meara

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

[diff] [blame]

149

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

150

The object takes the form of:

151

152

{ # CompleteIPRotationRequest moves the cluster master back into single-IP mode.

Bu Sun Kim

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

[diff] [blame]

153

"name": "A String", # The name (project, location, cluster id) of the cluster to complete IP

154

# rotation. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

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

[diff] [blame^]

155

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

156

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

Bu Sun Kim

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

[diff] [blame]

157

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

Bu Sun Kim

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

[diff] [blame]

158

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

159

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

Bu Sun Kim

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

[diff] [blame]

160

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

Dan O'Meara

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

[diff] [blame]

161

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

162

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

163

# field.

Bu Sun Kim

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

[diff] [blame]

164

}

165

166

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

173

174

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

175

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

Bu Sun Kim

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

[diff] [blame]

176

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

177

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

178

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

179

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

180

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

181

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

182

# or

183

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

184

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

185

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

Bu Sun Kim

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

[diff] [blame^]

186

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

Bu Sun Kim

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

[diff] [blame]

187

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

188

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

Bu Sun Kim

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

[diff] [blame^]

189

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

Bu Sun Kim

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

[diff] [blame]

190

},

191

],

192

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

193

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame^]

194

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

195

# Object with schema name: OperationProgress

196

],

Bu Sun Kim

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

[diff] [blame]

197

},

Bu Sun Kim

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

[diff] [blame^]

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

},

209

],

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

212

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

Bu Sun Kim

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

[diff] [blame]

213

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

Bu Sun Kim

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

[diff] [blame]

214

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

Bu Sun Kim

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

[diff] [blame^]

215

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

216

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

217

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

Bu Sun Kim

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

[diff] [blame]

218

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

Bu Sun Kim

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

[diff] [blame]

219

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

220

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

Bu Sun Kim

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

[diff] [blame]

221

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

Bu Sun Kim

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

[diff] [blame^]

222

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

Bu Sun Kim

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

[diff] [blame]

223

},

224

],

Bu Sun Kim

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

[diff] [blame]

225

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

Dan O'Meara

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

[diff] [blame]

226

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

227

# or

228

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

229

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

230

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

235

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

Bu Sun Kim

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

[diff] [blame]

236

<pre>Creates a cluster, consisting of the specified number and type of Google

237

Compute Engine instances.

238

Bu Sun Kim

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

[diff] [blame]

239

By default, the cluster is created in the project's

Dan O'Meara

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

[diff] [blame]

240

[default

241

network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks).

Bu Sun Kim

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

[diff] [blame]

242

243

One firewall is added for the cluster. After cluster creation,

244

the Kubelet creates routes for each node to allow the containers

245

on that node to communicate with all other instances in the

246

cluster.

247

Bu Sun Kim

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

[diff] [blame]

248

Finally, an entry is added to the project's global metadata indicating

Bu Sun Kim

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

[diff] [blame]

249

which CIDR range the cluster is using.

250

251

Args:

252

parent: string, The parent (project and location) where the cluster will be created.

Bu Sun Kim

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

[diff] [blame]

253

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

Dan O'Meara

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

[diff] [blame]

254

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

255

The object takes the form of:

256

257

{ # CreateClusterRequest creates a cluster.

Bu Sun Kim

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

[diff] [blame^]

258

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

259

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

260

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

261

# field.

Bu Sun Kim

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

[diff] [blame]

262

"parent": "A String", # The parent (project and location) where the cluster will be created.

263

# Specified in the format `projects/*/locations/*`.

Bu Sun Kim

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

[diff] [blame]

264

"cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster

Bu Sun Kim

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

[diff] [blame^]

265

# resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters)

266

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

267

"currentNodeVersion": "A String", # [Output only] Deprecated, use

268

# [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools)

269

# instead. The current version of the node software components. If they are

270

# currently at multiple versions because they're in the process of being

271

# upgraded, this reflects the minimum version of all nodes.

272

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

273

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

274

# if enabled = true.

275

"enabled": True or False, # Whether this cluster should return group membership lookups

276

# during authentication using a group of security groups.

Bu Sun Kim

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

[diff] [blame]

277

},

Bu Sun Kim

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

[diff] [blame^]

278

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

279

# API groups (e.g. v1alpha1) and features that may not be production ready in

280

# the kubernetes version of the master and nodes.

281

# The cluster has no SLA for uptime and master/node upgrades are disabled.

282

# Alpha enabled clusters are automatically deleted thirty days after

283

# creation.

284

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

285

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services

286

# CIDR block. The secondary range will be used for service

287

# ClusterIPs. This must be an existing secondary range associated

288

# with the cluster subnetwork.

289

#

290

# This field is only applicable with use_ip_aliases is true and

291

# create_subnetwork is false.

292

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

293

# this field is empty, then an automatic name will be chosen for the new

294

# subnetwork.

295

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

296

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range

297

# will be automatically chosen with the default size.

298

#

299

# This field is only applicable when `use_ip_aliases` is true.

300

#

301

# Set to blank to have a range chosen with the default size.

302

#

303

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

308

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

309

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

310

# to use.

311

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

312

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

313

# block. The secondary range will be used for pod IP

314

# addresses. This must be an existing secondary range associated

315

# with the cluster subnetwork.

316

#

317

# This field is only applicable with use_ip_aliases is true and

318

# create_subnetwork is false.

319

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a

320

# range will be automatically chosen with the default size.

321

#

322

# This field is only applicable when `use_ip_aliases` is true.

323

#

324

# If unspecified, the range will use the default size.

325

#

326

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

331

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

332

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

333

# to use.

334

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

335

#

336

# This is applicable only if `create_subnetwork` is true.

337

#

338

# Set to blank to have a range chosen with the default size.

339

#

340

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

345

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

346

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

347

# to use.

348

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

349

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

350

#

351

# This field is only applicable when `use_ip_aliases` is true.

352

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

353

# `cluster.cluster_ipv4_cidr` must be left blank.

354

#

355

# This field is only applicable when `use_ip_aliases` is true.

356

#

357

# Set to blank to have a range chosen with the default size.

358

#

359

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

364

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

365

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

366

# to use.

367

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

368

},

369

"loggingService": "A String", # The logging service the cluster should use to write logs.

370

# Currently available options:

Bu Sun Kim

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

[diff] [blame]

371

#

Bu Sun Kim

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

[diff] [blame^]

372

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

373

# service with a Kubernetes-native resource model

374

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

375

# available as of GKE 1.15).

376

# * `none` - no logs will be exported from the cluster.

377

#

378

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

379

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

380

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

381

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

382

# cluster resides. This field is deprecated, use location instead.

383

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

384

# mode.

385

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

386

# identities in the system, including service accounts, nodes, and

387

# controllers, will have statically granted permissions beyond those

388

# provided by the RBAC configuration or IAM.

Bu Sun Kim

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

[diff] [blame]

389

},

Bu Sun Kim

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

[diff] [blame^]

390

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

391

# Google Compute Engine resources.

392

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

393

},

Bu Sun Kim

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

[diff] [blame]

394

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

Bu Sun Kim

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

[diff] [blame]

395

# containers. This is provisioned from within the `container_ipv4_cidr`

396

# range. This field will only be set when cluster is in route-based network

397

# mode.

Bu Sun Kim

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

[diff] [blame^]

398

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

399

# subscribed to. Release channels are arranged in order of risk.

400

#

401

# When a cluster is subscribed to a release channel, Google maintains

402

# both the master version and the node version. Node auto-upgrade

403

# defaults to true and cannot be disabled.

404

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

Bu Sun Kim

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

[diff] [blame]

405

},

406

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

407

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

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

[diff] [blame]

408

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

409

# occur in these windows.

410

"a_key": { # Represents an arbitrary window of time.

411

"endTime": "A String", # The time that the window ends. The end time should take place after the

412

# start time.

413

"startTime": "A String", # The time that the window first starts.

414

},

Bu Sun Kim

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

[diff] [blame]

415

},

Bu Sun Kim

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

[diff] [blame^]

416

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

417

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

418

# smallest possible in the given scenario.

419

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

420

# format "PTnHnMnS".

421

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

422

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

423

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

424

},

Bu Sun Kim

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

[diff] [blame]

425

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for

Dan O'Meara

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

[diff] [blame]

426

# maintenance to occur. The time windows may be overlapping. If no

427

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

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

[diff] [blame]

428

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

429

"endTime": "A String", # The time that the window ends. The end time should take place after the

430

# start time.

431

"startTime": "A String", # The time that the window first starts.

432

},

Bu Sun Kim

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

[diff] [blame]

433

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how

Dan O'Meara

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

[diff] [blame]

434

# this window reccurs. They go on for the span of time between the start and

435

# end time.

436

#

Bu Sun Kim

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

[diff] [blame]

437

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

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

[diff] [blame]

438

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

439

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

440

# <code>FREQ=DAILY</code>

441

# For the first weekend of every month:

442

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

443

# This specifies how frequently the window starts. Eg, if you wanted to have

Bu Sun Kim

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

[diff] [blame]

444

# a 9-5 UTC-4 window every weekday, you'd use something like:

Dan O'Meara

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

[diff] [blame]

445

# <code>

446

# start time = 2019-01-01T09:00:00-0400

447

# end time = 2019-01-01T17:00:00-0400

448

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

449

# </code>

450

# Windows can span multiple days. Eg, to make the window encompass every

451

# weekend from midnight Saturday till the last minute of Sunday UTC:

452

# <code>

453

# start time = 2019-01-05T00:00:00Z

454

# end time = 2019-01-07T23:59:00Z

455

# recurrence = FREQ=WEEKLY;BYDAY=SA

456

# </code>

Bu Sun Kim

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

[diff] [blame]

457

# Note the start and end time's specific dates are largely arbitrary except

Dan O'Meara

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

[diff] [blame]

458

# to specify duration of the window and when it first starts.

459

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Dan O'Meara

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

[diff] [blame]

460

},

Bu Sun Kim

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

[diff] [blame]

461

},

Bu Sun Kim

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

[diff] [blame]

462

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

463

# the policy won't accidentally undo intermediate changes (and so that users

464

# of the API unaware of some fields won't accidentally remove other fields).

Dan O'Meara

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

[diff] [blame]

465

# Make a <code>get()</code> request to the cluster to get the current

466

# resource version and include it with requests to set the policy.

Bu Sun Kim

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

[diff] [blame]

467

},

Bu Sun Kim

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

[diff] [blame^]

468

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

469

# Currently available options:

Bu Sun Kim

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

[diff] [blame]

470

#

Bu Sun Kim

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

[diff] [blame^]

471

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

472

# service with a Kubernetes-native resource model

473

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

474

# longer available as of GKE 1.15).

475

# * `none` - No metrics will be exported from the cluster.

Bu Sun Kim

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

[diff] [blame]

476

#

Bu Sun Kim

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

[diff] [blame^]

477

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

478

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

479

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

480

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

481

# images will be validated by Binary Authorization.

Bu Sun Kim

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

[diff] [blame]

482

},

Bu Sun Kim

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

[diff] [blame^]

483

"expireTime": "A String", # [Output only] The time the cluster will be automatically

484

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

485

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

Bu Sun Kim

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

[diff] [blame]

486

"A String",

Bu Sun Kim

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

[diff] [blame]

487

],

Bu Sun Kim

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

[diff] [blame^]

488

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

489

# The endpoint can be accessed from the internet at

490

# `https://username:password@endpoint/`.

491

#

492

# See the `masterAuth` property of this resource for username and

493

# password information.

494

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

495

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

496

},

497

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

498

# master authorized networks will disallow all external traffic to access

499

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

500

# Google Compute Engine Public IPs and Google Prod IPs.

501

"enabled": True or False, # Whether or not master authorized networks is enabled.

502

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

503

# Kubernetes master through HTTPS.

504

{ # CidrBlock contains an optional name and one CIDR block.

505

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

506

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

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

[diff] [blame]

507

},

Bu Sun Kim

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

[diff] [blame^]

508

],

509

},

510

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

511

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

512

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

513

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

514

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

515

},

516

],

517

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

518

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

519

# to which the cluster is connected. If left unspecified, the `default`

520

# network will be used.

521

"status": "A String", # [Output only] The current status of this cluster.

522

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

523

# required by Cluster Autoscaler to automatically adjust

524

# the size of the cluster and create/delete

525

# node pools based on the current needs.

526

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

527

# amount of resources in the cluster.

528

{ # Contains information about amount of some resource in the cluster.

529

# For memory, value should be in GB.

530

"minimum": "A String", # Minimum amount of the resource in the cluster.

531

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

532

"maximum": "A String", # Maximum amount of the resource in the cluster.

533

},

534

],

535

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

536

# created by NAP.

537

# by NAP.

538

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

539

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

540

# node pool.

541

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

542

# the Auto Upgrades will proceed.

543

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

544

# with the description of the upgrade.

545

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

546

# with the approximate start time for the upgrades, in

547

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

548

},

549

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

550

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

551

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

552

# triggered.

553

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

554

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

555

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

556

},

557

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

Dan O'Meara

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

[diff] [blame]

558

# disruption caused by an upgrade.

559

#

560

# maxUnavailable controls the number of nodes that can be simultaneously

561

# unavailable.

562

#

563

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

564

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

565

# available nodes.

566

#

567

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

568

# nodes are being upgraded at the same time).

569

#

570

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

571

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

572

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

573

# PodDisruptionBudget, if it is configured.)

574

#

575

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

576

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

577

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

578

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

579

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame]

580

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

581

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

582

# Ready.

Bu Sun Kim

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

[diff] [blame]

583

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

584

# of the node pool during the upgrade process.

Dan O'Meara

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

[diff] [blame]

585

},

Bu Sun Kim

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

[diff] [blame^]

586

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

Bu Sun Kim

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

[diff] [blame]

587

"A String",

588

],

Bu Sun Kim

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

[diff] [blame]

589

},

Bu Sun Kim

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

[diff] [blame^]

590

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

591

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

592

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

593

# NodePool's nodes can be created by NAP.

"A String",

],

},

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

Bu Sun Kim

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

[diff] [blame]

598

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

599

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Bu Sun Kim

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

[diff] [blame]

600

"enabled": True or False, # Whether network policy is enabled on the cluster.

Bu Sun Kim

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

[diff] [blame^]

601

"provider": "A String", # The selected network policy provider.

Bu Sun Kim

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

[diff] [blame]

602

},

Bu Sun Kim

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

[diff] [blame^]

603

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Bu Sun Kim

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

[diff] [blame]

604

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

Bu Sun Kim

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

[diff] [blame^]

605

# notation (e.g. `10.96.0.0/14`). Leave blank to have

606

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

607

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

608

# simultaneously on a node in the node pool of this cluster. Only honored

609

# if cluster created with IP Alias support.

610

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

Bu Sun Kim

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

[diff] [blame]

611

},

Bu Sun Kim

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

[diff] [blame]

612

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

Bu Sun Kim

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

[diff] [blame]

613

# For requests, this field should only be used in lieu of a

Bu Sun Kim

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

[diff] [blame]

614

# "node_pool" object, since this configuration (along with the

615

# "initial_node_count") will be used to create a "NodePool" object with an

Bu Sun Kim

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

[diff] [blame]

616

# auto-generated name. Do not use this and a node_pool at the same time.

617

# For responses, this field will be populated with the node configuration of

618

# the first node pool. (For configuration of each node pool, see

619

# `node_pool.config`)

620

#

621

# If unspecified, the defaults are used.

622

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

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

[diff] [blame^]

623

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

624

#

625

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

626

"bootDiskKmsKey": "A String", #

627

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

628

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

629

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

630

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

631

# see:

632

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

633

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

634

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

635

#

636

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

637

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

638

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

639

# the instance is created.

640

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

641

#

642

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

643

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

644

# boot process if signature verification fails.

645

},

646

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

647

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

648

# Kubernetes may apply to the node.

649

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

650

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

651

# and conflicts should be avoided.

652

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

653

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

654

"a_key": "A String",

655

},

Bu Sun Kim

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

[diff] [blame]

656

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

657

# node VMs under the "default" service account.

Bu Sun Kim

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

[diff] [blame]

658

#

659

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

660

# not included:

661

#

662

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

663

# persistent storage on your nodes.

664

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

665

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

666

# (the [Google Container

667

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

Bu Sun Kim

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

[diff] [blame]

668

#

669

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

670

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

Bu Sun Kim

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

[diff] [blame]

671

"A String",

Bu Sun Kim

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

[diff] [blame]

672

],

Bu Sun Kim

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

[diff] [blame^]

673

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

674

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

675

# friendly names of CPU platforms, such as

676

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

677

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

678

# information, read [how to specify min CPU

679

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

680

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

681

#

682

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

683

# disks available on a machine per zone. See:

684

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

685

# for more information.

Bu Sun Kim

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

[diff] [blame]

686

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

Dan O'Meara

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

[diff] [blame]

687

#

688

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

689

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

690

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

691

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

692

#

Bu Sun Kim

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

[diff] [blame]

693

# See

694

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

695

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

Bu Sun Kim

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

[diff] [blame]

696

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

697

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

Bu Sun Kim

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

[diff] [blame^]

698

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

Dan O'Meara

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

[diff] [blame]

699

},

700

],

Bu Sun Kim

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

[diff] [blame^]

701

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

702

# the latest version of it will be used.

703

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

704

# the specified [Zonal Compute

705

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

706

# to this node pool.

707

# is the configuration of desired reservation which instances could take

708

# capacity from.

709

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

710

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

711

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

712

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

713

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

714

"A String",

715

],

Bu Sun Kim

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

[diff] [blame]

716

},

Bu Sun Kim

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

[diff] [blame]

717

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

718

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

719

# `n1-standard-1`).

720

#

721

# If unspecified, the default machine type is

722

# `n1-standard-1`.

Bu Sun Kim

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

[diff] [blame^]

723

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

724

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

725

# workloads on [sole tenant

726

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

Bu Sun Kim

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

[diff] [blame]

727

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

728

#

729

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

730

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

731

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

732

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

738

# "enable-os-login"

739

# "gci-ensure-gke-docker"

740

# "gci-metrics-enabled"

741

# "gci-update-strategy"

742

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

747

# "windows-startup-script-ps1"

748

# "common-psm1"

749

# "k8s-node-setup-psm1"

750

# "install-ssh-psm1"

751

# "user-profile-psm1"

752

# "serial-port-logging-enable"

753

#

754

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

755

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

756

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

757

#

758

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

759

"a_key": "A String",

760

},

Bu Sun Kim

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

[diff] [blame]

761

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

762

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

763

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

764

# must comply with RFC1035.

765

"A String",

766

],

Bu Sun Kim

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

[diff] [blame^]

767

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

768

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

769

},

770

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

771

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

772

# information about preemptible VM instances.

773

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

774

# workloads on the node pool.

775

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

776

# on the node pool.

777

},

778

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

779

# The smallest allowed disk size is 10GB.

780

#

781

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

Bu Sun Kim

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

[diff] [blame]

782

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

783

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

784

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

Bu Sun Kim

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

[diff] [blame^]

785

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

786

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

787

# support for GPUs.

788

{ # AcceleratorConfig represents a Hardware Accelerator request.

789

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

790

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

791

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

792

},

793

],

Bu Sun Kim

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

[diff] [blame]

794

},

Bu Sun Kim

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

[diff] [blame^]

795

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

796

# disabled when this config is unspecified.

797

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

798

# daemonset will be created in the cluster to meter network egress traffic.

799

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

800

"datasetId": "A String", # The ID of a BigQuery Dataset.

801

},

802

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

803

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

804

# second BigQuery table will be created to hold resource consumption

805

# records.

806

},

Bu Sun Kim

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

[diff] [blame]

807

},

Bu Sun Kim

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

[diff] [blame^]

808

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

809

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

810

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

811

# firewall and routes quota.

812

# For requests, this field should only be used in lieu of a

813

# "node_pool" object, since this configuration (along with the

814

# "node_config") will be used to create a "NodePool" object with an

815

# auto-generated name. Do not use this and a node_pool at the same time.

816

#

817

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

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

[diff] [blame]

818

"name": "A String", # The name of this cluster. The name must be unique within this project

819

# and location (e.g. zone or region), and can be up to 40 characters with

820

# the following restrictions:

821

#

822

# * Lowercase letters, numbers, and hyphens only.

823

# * Must start with a letter.

824

# * Must end with a number or a letter.

Bu Sun Kim

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

[diff] [blame^]

825

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

826

# policies.

827

# policies.

828

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

829

},

830

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

831

"network": "A String", # Output only. The relative name of the Google Compute Engine

832

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

833

# to which the cluster is connected. Example:

834

# projects/my-project/global/networks/my-network

835

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

836

# This makes same node pod to pod traffic visible for VPC network.

837

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

838

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

839

# cluster is connected. Example:

840

# projects/my-project/regions/us-central1/subnetworks/my-subnet

841

},

842

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

843

"state": "A String", # Denotes the state of etcd encryption.

844

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

845

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

846

},

847

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

848

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

849

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

850

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

851

# given only RFC 1918 private addresses and communicate with the master via

852

# private networking.

853

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

854

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

855

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

856

# range will be used for assigning internal IP addresses to the master or

857

# set of masters, as well as the ILB VIP. This range must not overlap with

858

# any other ranges in use within the cluster's network.

859

},

860

"createTime": "A String", # [Output only] The time the cluster was created, in

861

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

862

"nodePools": [ # The node pools associated with this cluster.

863

# This field should not be set if "node_config" or "initial_node_count" are

864

# specified.

865

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

866

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

867

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

868

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

869

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

870

# the workload.

871

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

872

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

873

# node pool.

874

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

875

# the Auto Upgrades will proceed.

876

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

877

# with the description of the upgrade.

878

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

879

# with the approximate start time for the upgrades, in

880

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

881

},

882

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

883

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

884

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

885

# triggered.

886

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

887

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

888

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

889

},

890

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

891

# disruption caused by an upgrade.

892

#

893

# maxUnavailable controls the number of nodes that can be simultaneously

894

# unavailable.

895

#

896

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

897

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

898

# available nodes.

899

#

900

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

901

# nodes are being upgraded at the same time).

902

#

903

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

904

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

905

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

906

# PodDisruptionBudget, if it is configured.)

907

#

908

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

909

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

910

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

911

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

912

# there are always at least 4 nodes available.

913

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

914

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

915

# Ready.

916

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

917

# of the node pool during the upgrade process.

918

},

919

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

920

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

921

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

922

# firewall and routes quota.

923

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

924

# node pool instance, if available.

925

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

926

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

927

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

928

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

929

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

930

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

931

},

932

],

933

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

934

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

935

#

936

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

937

"bootDiskKmsKey": "A String", #

938

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

939

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

940

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

941

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

942

# see:

943

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

944

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

945

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

946

#

947

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

948

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

949

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

950

# the instance is created.

951

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

952

#

953

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

954

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

955

# boot process if signature verification fails.

956

},

957

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

958

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

959

# Kubernetes may apply to the node.

960

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

961

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

962

# and conflicts should be avoided.

963

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

964

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

965

"a_key": "A String",

966

},

967

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

968

# node VMs under the "default" service account.

969

#

970

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

971

# not included:

972

#

973

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

974

# persistent storage on your nodes.

975

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

976

# communicating with **gcr.io**

977

# (the [Google Container

978

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

979

#

980

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

981

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

982

"A String",

983

],

984

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

985

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

986

# friendly names of CPU platforms, such as

987

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

988

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

989

# information, read [how to specify min CPU

990

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

991

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

992

#

993

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

994

# disks available on a machine per zone. See:

995

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

996

# for more information.

997

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

998

#

999

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

1000

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

1001

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

1002

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

1003

#

1004

# See

1005

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

1006

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

1007

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

1008

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

1009

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

1010

},

1011

],

1012

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

1013

# the latest version of it will be used.

1014

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

1015

# the specified [Zonal Compute

1016

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

1017

# to this node pool.

1018

# is the configuration of desired reservation which instances could take

1019

# capacity from.

1020

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

1021

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

1022

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

1023

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

1024

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

"A String",

],

},

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

1029

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

1030

# `n1-standard-1`).

1031

#

1032

# If unspecified, the default machine type is

1033

# `n1-standard-1`.

1034

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

1035

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

1036

# workloads on [sole tenant

1037

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

1038

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

1039

#

1040

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

1041

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

1042

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

1043

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1049

# "enable-os-login"

1050

# "gci-ensure-gke-docker"

1051

# "gci-metrics-enabled"

1052

# "gci-update-strategy"

1053

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1058

# "windows-startup-script-ps1"

1059

# "common-psm1"

1060

# "k8s-node-setup-psm1"

1061

# "install-ssh-psm1"

1062

# "user-profile-psm1"

1063

# "serial-port-logging-enable"

1064

#

1065

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

1066

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

1067

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

1068

#

1069

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

1070

"a_key": "A String",

1071

},

1072

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

1073

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

1074

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

1075

# must comply with RFC1035.

1076

"A String",

1077

],

1078

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

1079

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

1080

},

1081

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

1082

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

1083

# information about preemptible VM instances.

1084

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

1085

# workloads on the node pool.

1086

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

1087

# on the node pool.

1088

},

1089

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

1090

# The smallest allowed disk size is 10GB.

1091

#

1092

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

1093

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

1094

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

1095

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

1096

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

1097

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

1098

# support for GPUs.

1099

{ # AcceleratorConfig represents a Hardware Accelerator request.

1100

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

1101

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

1102

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

},

],

},

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

1107

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

1108

# simultaneously on a node in the node pool.

1109

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

1110

},

1111

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

1112

# only if a valid configuration is present.

1113

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

1114

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

1115

# max_node_count.

1116

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

1117

# has to enough quota to scale up the cluster.

1118

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

1119

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

1120

},

1121

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

1122

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

1123

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

1124

# associated with this node pool.

1125

"A String",

1126

],

1127

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

1128

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

1129

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

1130

# NodePool's nodes should be located.

"A String",

],

},

],

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

1136

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

1137

# the cluster is connected.

1138

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

1139

# cluster, enabling additional functionality.

1140

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

1141

# This addon is deprecated, and will be disabled in 1.15. It is recommended

1142

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

1143

# workloads and applications. For more information, see:

1144

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

1145

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

1146

},

1147

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

1148

# managed Knative service.

1149

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1150

},

1151

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

1152

# makes it easy to set up HTTP load balancers for services in a cluster.

1153

# which makes it easy to set up HTTP load balancers for services in a cluster.

1154

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

1155

# When enabled, it runs a small pod in the cluster that manages the load

1156

# balancers.

1157

},

1158

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

1159

# increases or decreases the number of replica pods a replication controller

1160

# has based on the resource usage of the existing pods.

1161

# increases or decreases the number of replica pods a replication controller

1162

# has based on the resource usage of the existing pods.

1163

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

1164

# When enabled, it ensures that metrics are collected into Stackdriver

1165

# Monitoring.

1166

},

1167

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

1168

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

1169

},

1170

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

1171

# is enabled or not on the Master, it does not track whether network policy

1172

# is enabled for the nodes.

1173

# is enabled or not on the Master, it does not track whether network policy

1174

# is enabled for the nodes.

1175

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1176

},

1177

},

1178

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

1179

# If unspecified, the defaults are used:

1180

# For clusters before v1.12, if master_auth is unspecified, `username` will

1181

# be set to "admin", a random password will be generated, and a client

1182

# certificate will be issued.

1183

# Authentication can be done using HTTP basic auth or using client

1184

# certificates.

1185

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

1186

# to the cluster endpoint.

1187

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

1188

# authenticate to the cluster endpoint.

1189

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

1190

# For clusters v1.6.0 and later, basic authentication can be disabled by

1191

# leaving username unspecified (or setting it to the empty string).

1192

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

1193

# Because the master endpoint is open to the Internet, you should create a

1194

# strong password. If a password is provided for cluster creation, username

1195

# must be non-empty.

1196

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

1197

# clusters before v1.12, if no configuration is specified, a client

1198

# certificate is issued.

1199

"issueClientCertificate": True or False, # Issue a client certificate.

1200

},

1201

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

1202

# trust for the cluster.

1203

},

1204

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

1205

# required by Vertical Pod Autoscaler to automatically adjust

1206

# the resources of pods controlled by it.

1207

"enabled": True or False, # Enables vertical pod autoscaling.

1208

},

1209

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

1210

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

1211

# found in validMasterVersions returned by getServerConfig. The version can

1212

# be upgraded over time; such upgrades are reflected in

1213

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

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

[diff] [blame]

1214

#

Bu Sun Kim

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

[diff] [blame^]

1215

# Users may specify either explicit versions offered by

1216

# Kubernetes Engine or version aliases, which have the following behavior:

1217

#

1218

# - "latest": picks the highest valid Kubernetes version

1219

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

1220

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

1221

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

1222

# - "","-": picks the default Kubernetes version

1223

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

1224

# Call Kubernetes API directly to retrieve node information.

1225

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

1226

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1227

# notation (e.g. `1.2.3.4/29`).

1228

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

1229

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

1230

# cluster's nodes should be located.

1231

"A String",

1232

],

1233

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

1234

"description": "A String", # An optional description of this cluster.

1235

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

1236

# cluster, if available.

Bu Sun Kim

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

[diff] [blame]

1237

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

1238

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

1239

# or

1240

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

1241

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

1242

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

1243

# this cluster, in

1244

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1245

# notation (e.g. `1.2.3.4/29`). Service addresses are

1246

# typically put in the last `/16` from the container CIDR.

Bu Sun Kim

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

[diff] [blame]

1247

},

Bu Sun Kim

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

[diff] [blame]

1248

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

1249

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

1250

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

Bu Sun Kim

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

[diff] [blame]

1251

}

1252

1253

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1260

1261

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

1262

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

Bu Sun Kim

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

[diff] [blame]

1263

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

1264

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

1265

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

1266

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

1267

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

1268

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

1269

# or

1270

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

1271

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

1272

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

Bu Sun Kim

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

[diff] [blame^]

1273

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

Bu Sun Kim

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

[diff] [blame]

1274

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

1275

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

Bu Sun Kim

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

[diff] [blame^]

1276

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

Bu Sun Kim

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

[diff] [blame]

1277

},

1278

],

1279

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

1280

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame^]

1281

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

1282

# Object with schema name: OperationProgress

1283

],

Bu Sun Kim

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

[diff] [blame]

1284

},

Bu Sun Kim

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

[diff] [blame^]

1285

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

1286

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

1287

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

1288

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

1289

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

1290

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

1291

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

1292

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

1293

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

1294

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

1295

},

1296

],

Bu Sun Kim

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

[diff] [blame]

1297

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

1298

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

1299

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

Bu Sun Kim

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

[diff] [blame]

1300

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

Bu Sun Kim

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

[diff] [blame]

1301

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

Bu Sun Kim

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

[diff] [blame^]

1302

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

1303

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

1304

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

Bu Sun Kim

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

[diff] [blame]

1305

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

Bu Sun Kim

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

[diff] [blame]

1306

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

1307

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

Bu Sun Kim

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

[diff] [blame]

1308

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

Bu Sun Kim

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

[diff] [blame^]

1309

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

Bu Sun Kim

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

[diff] [blame]

1310

},

1311

],

Bu Sun Kim

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

[diff] [blame]

1312

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

Dan O'Meara

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

[diff] [blame]

1313

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

1314

# or

1315

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

1316

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

1317

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

1322

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

Bu Sun Kim

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

[diff] [blame]

1323

<pre>Deletes the cluster, including the Kubernetes endpoint and all worker

1324

nodes.

1325

1326

Firewalls and routes that were configured during cluster creation

1327

are also deleted.

1328

1329

Other Google Compute Engine resources that might be in use by the cluster,

Bu Sun Kim

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

[diff] [blame]

1330

such as load balancer resources, are not deleted if they weren't present

Bu Sun Kim

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

[diff] [blame]

1331

when the cluster was initially created.

Args:

Bu Sun Kim

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

[diff] [blame]

1335

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

Bu Sun Kim

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

[diff] [blame^]

1336

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

1337

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

Bu Sun Kim

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

[diff] [blame]

1338

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

1339

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

1340

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

Bu Sun Kim

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

[diff] [blame]

1341

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

Dan O'Meara

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

[diff] [blame]

1342

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

1343

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

1344

field.

Bu Sun Kim

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

[diff] [blame]

1345

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1352

1353

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

1354

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

Bu Sun Kim

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

[diff] [blame]

1355

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

1356

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

1357

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

1358

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

1359

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

1360

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

1361

# or

1362

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

1363

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

1364

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

Bu Sun Kim

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

[diff] [blame^]

1365

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

Bu Sun Kim

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

[diff] [blame]

1366

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

1367

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

Bu Sun Kim

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

[diff] [blame^]

1368

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

Bu Sun Kim

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

[diff] [blame]

1369

},

1370

],

1371

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

1372

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame^]

1373

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

1374

# Object with schema name: OperationProgress

1375

],

Bu Sun Kim

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

[diff] [blame]

1376

},

Bu Sun Kim

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

[diff] [blame^]

1377

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

1378

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

1379

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

1380

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

1381

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

1382

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

1383

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

1384

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

1385

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

1386

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

1387

},

1388

],

Bu Sun Kim

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

[diff] [blame]

1389

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

1390

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

1391

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

Bu Sun Kim

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

[diff] [blame]

1392

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

Bu Sun Kim

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

[diff] [blame]

1393

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

Bu Sun Kim

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

[diff] [blame^]

1394

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

1395

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

1396

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

Bu Sun Kim

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

[diff] [blame]

1397

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

Bu Sun Kim

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

[diff] [blame]

1398

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

1399

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

Bu Sun Kim

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

[diff] [blame]

1400

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

Bu Sun Kim

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

[diff] [blame^]

1401

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

Bu Sun Kim

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

[diff] [blame]

1402

},

1403

],

Bu Sun Kim

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

[diff] [blame]

1404

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

Dan O'Meara

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

[diff] [blame]

1405

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

1406

# or

1407

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

1408

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

1409

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

1414

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

Bu Sun Kim

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

[diff] [blame]

1415

<pre>Gets the details of a specific cluster.

Args:

Bu Sun Kim

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

[diff] [blame]

1419

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

Bu Sun Kim

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

[diff] [blame]

1420

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

1421

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

Bu Sun Kim

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

[diff] [blame]

1422

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

Dan O'Meara

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

[diff] [blame]

1423

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

1424

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

1425

field.

Bu Sun Kim

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

[diff] [blame^]

1426

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

1427

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

1428

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

Bu Sun Kim

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

[diff] [blame]

1429

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1436

1437

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

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

[diff] [blame^]

1438

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

1439

"currentNodeVersion": "A String", # [Output only] Deprecated, use

1440

# [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools)

1441

# instead. The current version of the node software components. If they are

1442

# currently at multiple versions because they're in the process of being

1443

# upgraded, this reflects the minimum version of all nodes.

1444

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

1445

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

1446

# if enabled = true.

1447

"enabled": True or False, # Whether this cluster should return group membership lookups

1448

# during authentication using a group of security groups.

Bu Sun Kim

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

[diff] [blame]

1449

},

Bu Sun Kim

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

[diff] [blame^]

1450

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

1451

# API groups (e.g. v1alpha1) and features that may not be production ready in

1452

# the kubernetes version of the master and nodes.

1453

# The cluster has no SLA for uptime and master/node upgrades are disabled.

1454

# Alpha enabled clusters are automatically deleted thirty days after

1455

# creation.

1456

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

1457

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services

1458

# CIDR block. The secondary range will be used for service

1459

# ClusterIPs. This must be an existing secondary range associated

1460

# with the cluster subnetwork.

1461

#

1462

# This field is only applicable with use_ip_aliases is true and

1463

# create_subnetwork is false.

1464

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

1465

# this field is empty, then an automatic name will be chosen for the new

1466

# subnetwork.

1467

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1468

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range

1469

# will be automatically chosen with the default size.

1470

#

1471

# This field is only applicable when `use_ip_aliases` is true.

1472

#

1473

# Set to blank to have a range chosen with the default size.

1474

#

1475

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1480

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1481

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1482

# to use.

1483

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

1484

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

1485

# block. The secondary range will be used for pod IP

1486

# addresses. This must be an existing secondary range associated

1487

# with the cluster subnetwork.

1488

#

1489

# This field is only applicable with use_ip_aliases is true and

1490

# create_subnetwork is false.

1491

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a

1492

# range will be automatically chosen with the default size.

1493

#

1494

# This field is only applicable when `use_ip_aliases` is true.

1495

#

1496

# If unspecified, the range will use the default size.

1497

#

1498

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1503

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1504

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1505

# to use.

1506

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

1507

#

1508

# This is applicable only if `create_subnetwork` is true.

1509

#

1510

# Set to blank to have a range chosen with the default size.

1511

#

1512

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1517

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1518

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1519

# to use.

1520

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

1521

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

1522

#

1523

# This field is only applicable when `use_ip_aliases` is true.

1524

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

1525

# `cluster.cluster_ipv4_cidr` must be left blank.

1526

#

1527

# This field is only applicable when `use_ip_aliases` is true.

1528

#

1529

# Set to blank to have a range chosen with the default size.

1530

#

1531

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1536

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1537

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1538

# to use.

1539

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

1540

},

1541

"loggingService": "A String", # The logging service the cluster should use to write logs.

1542

# Currently available options:

Bu Sun Kim

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

[diff] [blame]

1543

#

Bu Sun Kim

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

[diff] [blame^]

1544

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

1545

# service with a Kubernetes-native resource model

1546

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

1547

# available as of GKE 1.15).

1548

# * `none` - no logs will be exported from the cluster.

1549

#

1550

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

1551

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

1552

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

1553

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

1554

# cluster resides. This field is deprecated, use location instead.

1555

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

1556

# mode.

1557

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

1558

# identities in the system, including service accounts, nodes, and

1559

# controllers, will have statically granted permissions beyond those

1560

# provided by the RBAC configuration or IAM.

Bu Sun Kim

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

[diff] [blame]

1561

},

Bu Sun Kim

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

[diff] [blame^]

1562

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

1563

# Google Compute Engine resources.

1564

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1565

},

Bu Sun Kim

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

[diff] [blame]

1566

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

Bu Sun Kim

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

[diff] [blame]

1567

# containers. This is provisioned from within the `container_ipv4_cidr`

1568

# range. This field will only be set when cluster is in route-based network

1569

# mode.

Bu Sun Kim

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

[diff] [blame^]

1570

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

1571

# subscribed to. Release channels are arranged in order of risk.

1572

#

1573

# When a cluster is subscribed to a release channel, Google maintains

1574

# both the master version and the node version. Node auto-upgrade

1575

# defaults to true and cannot be disabled.

1576

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

Bu Sun Kim

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

[diff] [blame]

1577

},

1578

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

1579

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

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

[diff] [blame]

1580

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

1581

# occur in these windows.

1582

"a_key": { # Represents an arbitrary window of time.

1583

"endTime": "A String", # The time that the window ends. The end time should take place after the

1584

# start time.

1585

"startTime": "A String", # The time that the window first starts.

1586

},

Bu Sun Kim

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

[diff] [blame]

1587

},

Bu Sun Kim

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

[diff] [blame^]

1588

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1589

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

1590

# smallest possible in the given scenario.

1591

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

1592

# format "PTnHnMnS".

1593

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

1594

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

1595

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

1596

},

Bu Sun Kim

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

[diff] [blame]

1597

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for

Dan O'Meara

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

[diff] [blame]

1598

# maintenance to occur. The time windows may be overlapping. If no

1599

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

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

[diff] [blame]

1600

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

1601

"endTime": "A String", # The time that the window ends. The end time should take place after the

1602

# start time.

1603

"startTime": "A String", # The time that the window first starts.

1604

},

Bu Sun Kim

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

[diff] [blame]

1605

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how

Dan O'Meara

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

[diff] [blame]

1606

# this window reccurs. They go on for the span of time between the start and

1607

# end time.

1608

#

Bu Sun Kim

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

[diff] [blame]

1609

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

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

[diff] [blame]

1610

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

1611

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

1612

# <code>FREQ=DAILY</code>

1613

# For the first weekend of every month:

1614

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

1615

# This specifies how frequently the window starts. Eg, if you wanted to have

Bu Sun Kim

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

[diff] [blame]

1616

# a 9-5 UTC-4 window every weekday, you'd use something like:

Dan O'Meara

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

[diff] [blame]

1617

# <code>

1618

# start time = 2019-01-01T09:00:00-0400

1619

# end time = 2019-01-01T17:00:00-0400

1620

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

1621

# </code>

1622

# Windows can span multiple days. Eg, to make the window encompass every

1623

# weekend from midnight Saturday till the last minute of Sunday UTC:

1624

# <code>

1625

# start time = 2019-01-05T00:00:00Z

1626

# end time = 2019-01-07T23:59:00Z

1627

# recurrence = FREQ=WEEKLY;BYDAY=SA

1628

# </code>

Bu Sun Kim

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

[diff] [blame]

1629

# Note the start and end time's specific dates are largely arbitrary except

Dan O'Meara

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

[diff] [blame]

1630

# to specify duration of the window and when it first starts.

1631

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Dan O'Meara

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

[diff] [blame]

1632

},

Bu Sun Kim

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

[diff] [blame]

1633

},

Bu Sun Kim

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

[diff] [blame]

1634

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

1635

# the policy won't accidentally undo intermediate changes (and so that users

1636

# of the API unaware of some fields won't accidentally remove other fields).

Dan O'Meara

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

[diff] [blame]

1637

# Make a <code>get()</code> request to the cluster to get the current

1638

# resource version and include it with requests to set the policy.

Bu Sun Kim

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

[diff] [blame]

1639

},

Bu Sun Kim

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

[diff] [blame^]

1640

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

1641

# Currently available options:

Bu Sun Kim

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

[diff] [blame]

1642

#

Bu Sun Kim

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

[diff] [blame^]

1643

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

1644

# service with a Kubernetes-native resource model

1645

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

1646

# longer available as of GKE 1.15).

1647

# * `none` - No metrics will be exported from the cluster.

Bu Sun Kim

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

[diff] [blame]

1648

#

Bu Sun Kim

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

[diff] [blame^]

1649

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

1650

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

1651

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

1652

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

1653

# images will be validated by Binary Authorization.

Bu Sun Kim

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

[diff] [blame]

1654

},

Bu Sun Kim

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

[diff] [blame^]

1655

"expireTime": "A String", # [Output only] The time the cluster will be automatically

1656

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

1657

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

Bu Sun Kim

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

[diff] [blame]

1658

"A String",

Bu Sun Kim

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

[diff] [blame]

1659

],

Bu Sun Kim

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

[diff] [blame^]

1660

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

1661

# The endpoint can be accessed from the internet at

1662

# `https://username:password@endpoint/`.

1663

#

1664

# See the `masterAuth` property of this resource for username and

1665

# password information.

1666

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

1667

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

1668

},

1669

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

1670

# master authorized networks will disallow all external traffic to access

1671

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

1672

# Google Compute Engine Public IPs and Google Prod IPs.

1673

"enabled": True or False, # Whether or not master authorized networks is enabled.

1674

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

1675

# Kubernetes master through HTTPS.

1676

{ # CidrBlock contains an optional name and one CIDR block.

1677

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

1678

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

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

[diff] [blame]

1679

},

Bu Sun Kim

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

[diff] [blame^]

1680

],

1681

},

1682

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

1683

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

1684

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

1685

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

1686

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

1687

},

1688

],

1689

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

1690

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1691

# to which the cluster is connected. If left unspecified, the `default`

1692

# network will be used.

1693

"status": "A String", # [Output only] The current status of this cluster.

1694

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

1695

# required by Cluster Autoscaler to automatically adjust

1696

# the size of the cluster and create/delete

1697

# node pools based on the current needs.

1698

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

1699

# amount of resources in the cluster.

1700

{ # Contains information about amount of some resource in the cluster.

1701

# For memory, value should be in GB.

1702

"minimum": "A String", # Minimum amount of the resource in the cluster.

1703

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

1704

"maximum": "A String", # Maximum amount of the resource in the cluster.

1705

},

1706

],

1707

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

1708

# created by NAP.

1709

# by NAP.

1710

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

1711

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

1712

# node pool.

1713

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

1714

# the Auto Upgrades will proceed.

1715

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

1716

# with the description of the upgrade.

1717

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

1718

# with the approximate start time for the upgrades, in

1719

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

1720

},

1721

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

1722

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

1723

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

1724

# triggered.

1725

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

1726

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

1727

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

1728

},

1729

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

Dan O'Meara

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

[diff] [blame]

1730

# disruption caused by an upgrade.

1731

#

1732

# maxUnavailable controls the number of nodes that can be simultaneously

1733

# unavailable.

1734

#

1735

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

1736

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

1737

# available nodes.

1738

#

1739

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

1740

# nodes are being upgraded at the same time).

1741

#

1742

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

1743

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

1744

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

1745

# PodDisruptionBudget, if it is configured.)

1746

#

1747

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

1748

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

1749

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

1750

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

1751

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame]

1752

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

1753

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

1754

# Ready.

Bu Sun Kim

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

[diff] [blame]

1755

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

1756

# of the node pool during the upgrade process.

Dan O'Meara

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

[diff] [blame]

1757

},

Bu Sun Kim

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

[diff] [blame^]

1758

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

Bu Sun Kim

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

[diff] [blame]

1759

"A String",

1760

],

Bu Sun Kim

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

[diff] [blame]

1761

},

Bu Sun Kim

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

[diff] [blame^]

1762

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

1763

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

1764

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

1765

# NodePool's nodes can be created by NAP.

"A String",

],

},

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

Bu Sun Kim

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

[diff] [blame]

1770

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

1771

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Bu Sun Kim

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

[diff] [blame]

1772

"enabled": True or False, # Whether network policy is enabled on the cluster.

Bu Sun Kim

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

[diff] [blame^]

1773

"provider": "A String", # The selected network policy provider.

Bu Sun Kim

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

[diff] [blame]

1774

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1775

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1776

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1777

# notation (e.g. `10.96.0.0/14`). Leave blank to have

1778

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

1779

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

1780

# simultaneously on a node in the node pool of this cluster. Only honored

1781

# if cluster created with IP Alias support.

1782

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1783

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1784

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1785

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1786

# "node_pool" object, since this configuration (along with the

1787

# "initial_node_count") will be used to create a "NodePool" object with an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1788

# auto-generated name. Do not use this and a node_pool at the same time.

1789

# For responses, this field will be populated with the node configuration of

1790

# the first node pool. (For configuration of each node pool, see

1791

# `node_pool.config`)

1792

#

1793

# If unspecified, the defaults are used.

1794

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1795

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

1796

#

1797

# If unspecified, the default disk type is 'pd-standard'

1798

"bootDiskKmsKey": "A String", #

1799

# The Customer Managed Encryption Key used to encrypt the boot disk attached

1800

# to each node in the node pool. This should be of the form

1801

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

1802

# For more information about protecting resources with Cloud KMS Keys please

1803

# see:

1804

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

1805

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1806

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1807

#

1808

# Enables monitoring and attestation of the boot integrity of the instance.

1809

# The attestation is performed against the integrity policy baseline. This

1810

# baseline is initially derived from the implicitly trusted boot image when

1811

# the instance is created.

1812

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1813

#

1814

# Secure Boot helps ensure that the system only runs authentic software by

1815

# verifying the digital signature of all boot components, and halting the

1816

# boot process if signature verification fails.

1817

},

1818

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

1819

# These will added in addition to any default label(s) that

1820

# Kubernetes may apply to the node.

1821

# In case of conflict in label keys, the applied set may differ depending on

1822

# the Kubernetes version -- it's best to assume the behavior is undefined

1823

# and conflicts should be avoided.

1824

# For more information, including usage and the valid values, see:

1825

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

1826

"a_key": "A String",

1827

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1828

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

1829

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1830

#

1831

# The following scopes are recommended, but not required, and by default are

1832

# not included:

1833

#

1834

# * `https://www.googleapis.com/auth/compute` is required for mounting

1835

# persistent storage on your nodes.

1836

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

1837

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1838

# (the [Google Container

1839

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1840

#

1841

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

1842

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1843

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1844

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1845

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

1846

# scheduled on the specified or newer CPU platform. Applicable values are the

1847

# friendly names of CPU platforms, such as

1848

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

1849

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

1850

# information, read [how to specify min CPU

1851

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1852

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

1853

#

1854

# The limit for this value is dependent upon the maximum number of

1855

# disks available on a machine per zone. See:

1856

# https://cloud.google.com/compute/docs/disks/local-ssd

1857

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1858

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1859

#

1860

# For more information, including usage and the valid values, see:

1861

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1862

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

1863

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

1864

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1865

# See

1866

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

1867

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1868

"value": "A String", # Value for taint.

1869

"key": "A String", # Key for taint.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1870

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1871

},

1872

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1873

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

1874

# the latest version of it will be used.

1875

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

1876

# the specified [Zonal Compute

1877

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

1878

# to this node pool.

1879

# is the configuration of desired reservation which instances could take

1880

# capacity from.

1881

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1882

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

1883

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

1884

# the key and specify the name of your reservation as its value.

1885

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1886

"A String",

1887

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1888

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1889

"machineType": "A String", # The name of a Google Compute Engine [machine

1890

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

1891

# `n1-standard-1`).

1892

#

1893

# If unspecified, the default machine type is

1894

# `n1-standard-1`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1895

"nodeGroup": "A String", # Setting this field will assign instances of this

1896

# pool to run on the specified node group. This is useful for running

1897

# workloads on [sole tenant

1898

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1899

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

1900

#

1901

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

1902

# in length. These are reflected as part of a URL in the metadata server.

1903

# Additionally, to avoid ambiguity, keys must not conflict with any other

1904

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1910

# "enable-os-login"

1911

# "gci-ensure-gke-docker"

1912

# "gci-metrics-enabled"

1913

# "gci-update-strategy"

1914

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1919

# "windows-startup-script-ps1"

1920

# "common-psm1"

1921

# "k8s-node-setup-psm1"

1922

# "install-ssh-psm1"

1923

# "user-profile-psm1"

1924

# "serial-port-logging-enable"

1925

#

1926

# Values are free-form strings, and only have meaning as interpreted by

1927

# the image running in the instance. The only restriction placed on them is

1928

# that each value's size must be less than or equal to 32 KB.

1929

#

1930

# The total size of all keys and values must be less than 512 KB.

1931

"a_key": "A String",

1932

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1933

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

1934

# valid sources or targets for network firewalls and are specified by

1935

# the client during cluster or node pool creation. Each tag within the list

1936

# must comply with RFC1035.

1937

"A String",

1938

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1939

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1940

"type": "A String", # Type of the sandbox to use for the node.

1941

},

1942

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

1943

# https://cloud.google.com/compute/docs/instances/preemptible for more

1944

# information about preemptible VM instances.

1945

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

1946

# workloads on the node pool.

1947

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

1948

# on the node pool.

1949

},

1950

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

1951

# The smallest allowed disk size is 10GB.

1952

#

1953

# If unspecified, the default disk size is 100GB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1954

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

1955

# Specify the email address of the Service Account; otherwise, if no Service

1956

# Account is specified, the "default" service account is used.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1957

"accelerators": [ # A list of hardware accelerators to be attached to each node.

1958

# See https://cloud.google.com/compute/docs/gpus for more information about

1959

# support for GPUs.

1960

{ # AcceleratorConfig represents a Hardware Accelerator request.

1961

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

1962

# [here](https://cloud.google.com/compute/docs/gpus)

1963

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1964

},

1965

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1966

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1967

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

1968

# disabled when this config is unspecified.

1969

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

1970

# daemonset will be created in the cluster to meter network egress traffic.

1971

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

1972

"datasetId": "A String", # The ID of a BigQuery Dataset.

1973

},

1974

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

1975

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

1976

# second BigQuery table will be created to hold resource consumption

1977

# records.

1978

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1979

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1980

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

1981

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

1982

# is sufficient for this number of instances. You must also have available

1983

# firewall and routes quota.

1984

# For requests, this field should only be used in lieu of a

1985

# "node_pool" object, since this configuration (along with the

1986

# "node_config") will be used to create a "NodePool" object with an

1987

# auto-generated name. Do not use this and a node_pool at the same time.

1988

#

1989

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1990

"name": "A String", # The name of this cluster. The name must be unique within this project

1991

# and location (e.g. zone or region), and can be up to 40 characters with

1992

# the following restrictions:

1993

#

1994

# * Lowercase letters, numbers, and hyphens only.

1995

# * Must start with a letter.

1996

# * Must end with a number or a letter.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1997

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

1998

# policies.

1999

# policies.

2000

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

2001

},

2002

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

2003

"network": "A String", # Output only. The relative name of the Google Compute Engine

2004

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2005

# to which the cluster is connected. Example:

2006

# projects/my-project/global/networks/my-network

2007

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

2008

# This makes same node pod to pod traffic visible for VPC network.

2009

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

2010

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

2011

# cluster is connected. Example:

2012

# projects/my-project/regions/us-central1/subnetworks/my-subnet

2013

},

2014

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2015

"state": "A String", # Denotes the state of etcd encryption.

2016

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

2017

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

2018

},

2019

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

2020

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

2021

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

2022

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

2023

# given only RFC 1918 private addresses and communicate with the master via

2024

# private networking.

2025

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

2026

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

2027

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

2028

# range will be used for assigning internal IP addresses to the master or

2029

# set of masters, as well as the ILB VIP. This range must not overlap with

2030

# any other ranges in use within the cluster's network.

2031

},

2032

"createTime": "A String", # [Output only] The time the cluster was created, in

2033

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2034

"nodePools": [ # The node pools associated with this cluster.

2035

# This field should not be set if "node_config" or "initial_node_count" are

2036

# specified.

2037

{ # NodePool contains the name and configuration for a cluster's node pool.

2038

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

2039

# specification, under the control of the cluster master. They may have a set

2040

# of Kubernetes labels applied to them, which may be used to reference them

2041

# during pod scheduling. They may also be resized up or down, to accommodate

2042

# the workload.

2043

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2044

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

2045

# node pool.

2046

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2047

# the Auto Upgrades will proceed.

2048

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2049

# with the description of the upgrade.

2050

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2051

# with the approximate start time for the upgrades, in

2052

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2053

},

2054

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

2055

# pool. If enabled, the nodes in this node pool will be monitored and, if

2056

# they fail health checks too many times, an automatic repair action will be

2057

# triggered.

2058

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

2059

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

2060

# up to date with the latest release version of Kubernetes.

2061

},

2062

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

2063

# disruption caused by an upgrade.

2064

#

2065

# maxUnavailable controls the number of nodes that can be simultaneously

2066

# unavailable.

2067

#

2068

# maxSurge controls the number of additional nodes that can be added to the

2069

# node pool temporarily for the time of the upgrade to increase the number of

2070

# available nodes.

2071

#

2072

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2073

# nodes are being upgraded at the same time).

2074

#

2075

# Note: upgrades inevitably introduce some disruption since workloads need to

2076

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2077

# this holds true. (Disruption stays within the limits of

2078

# PodDisruptionBudget, if it is configured.)

2079

#

2080

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2081

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2082

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2083

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2084

# there are always at least 4 nodes available.

2085

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2086

# the upgrade process. A node is considered available if its status is

2087

# Ready.

2088

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2089

# of the node pool during the upgrade process.

2090

},

2091

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

2092

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

2093

# is sufficient for this number of instances. You must also have available

2094

# firewall and routes quota.

2095

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2096

# node pool instance, if available.

2097

"version": "A String", # The version of the Kubernetes of this node.

2098

"conditions": [ # Which conditions caused the current node pool state.

2099

{ # StatusCondition describes why a cluster or a node pool has a certain status

2100

# (e.g., ERROR or DEGRADED).

2101

"message": "A String", # Human-friendly representation of the condition

2102

"code": "A String", # Machine-friendly representation of the condition

2103

},

2104

],

2105

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

2106

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2107

#

2108

# If unspecified, the default disk type is 'pd-standard'

2109

"bootDiskKmsKey": "A String", #

2110

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2111

# to each node in the node pool. This should be of the form

2112

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2113

# For more information about protecting resources with Cloud KMS Keys please

2114

# see:

2115

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

2116

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2117

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2118

#

2119

# Enables monitoring and attestation of the boot integrity of the instance.

2120

# The attestation is performed against the integrity policy baseline. This

2121

# baseline is initially derived from the implicitly trusted boot image when

2122

# the instance is created.

2123

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2124

#

2125

# Secure Boot helps ensure that the system only runs authentic software by

2126

# verifying the digital signature of all boot components, and halting the

2127

# boot process if signature verification fails.

2128

},

2129

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2130

# These will added in addition to any default label(s) that

2131

# Kubernetes may apply to the node.

2132

# In case of conflict in label keys, the applied set may differ depending on

2133

# the Kubernetes version -- it's best to assume the behavior is undefined

2134

# and conflicts should be avoided.

2135

# For more information, including usage and the valid values, see:

2136

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2137

"a_key": "A String",

2138

},

2139

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2140

# node VMs under the "default" service account.

2141

#

2142

# The following scopes are recommended, but not required, and by default are

2143

# not included:

2144

#

2145

# * `https://www.googleapis.com/auth/compute` is required for mounting

2146

# persistent storage on your nodes.

2147

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2148

# communicating with **gcr.io**

2149

# (the [Google Container

2150

# Registry](https://cloud.google.com/container-registry/)).

2151

#

2152

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2153

# Monitoring are enabled, in which case their required scopes will be added.

2154

"A String",

2155

],

2156

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2157

# scheduled on the specified or newer CPU platform. Applicable values are the

2158

# friendly names of CPU platforms, such as

2159

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2160

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2161

# information, read [how to specify min CPU

2162

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2163

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

2164

#

2165

# The limit for this value is dependent upon the maximum number of

2166

# disks available on a machine per zone. See:

2167

# https://cloud.google.com/compute/docs/disks/local-ssd

2168

# for more information.

2169

"taints": [ # List of kubernetes taints to be applied to each node.

2170

#

2171

# For more information, including usage and the valid values, see:

2172

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2173

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2174

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2175

#

2176

# See

2177

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2178

# for more information, including usage and the valid values.

2179

"value": "A String", # Value for taint.

2180

"key": "A String", # Key for taint.

2181

"effect": "A String", # Effect for taint.

2182

},

2183

],

2184

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2185

# the latest version of it will be used.

2186

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2187

# the specified [Zonal Compute

2188

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2189

# to this node pool.

2190

# is the configuration of desired reservation which instances could take

2191

# capacity from.

2192

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2193

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2194

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2195

# the key and specify the name of your reservation as its value.

2196

"values": [ # Corresponds to the label value(s) of reservation resource(s).

"A String",

],

},

"machineType": "A String", # The name of a Google Compute Engine [machine

2201

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2202

# `n1-standard-1`).

2203

#

2204

# If unspecified, the default machine type is

2205

# `n1-standard-1`.

2206

"nodeGroup": "A String", # Setting this field will assign instances of this

2207

# pool to run on the specified node group. This is useful for running

2208

# workloads on [sole tenant

2209

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

2210

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2211

#

2212

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2213

# in length. These are reflected as part of a URL in the metadata server.

2214

# Additionally, to avoid ambiguity, keys must not conflict with any other

2215

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2221

# "enable-os-login"

2222

# "gci-ensure-gke-docker"

2223

# "gci-metrics-enabled"

2224

# "gci-update-strategy"

2225

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2230

# "windows-startup-script-ps1"

2231

# "common-psm1"

2232

# "k8s-node-setup-psm1"

2233

# "install-ssh-psm1"

2234

# "user-profile-psm1"

2235

# "serial-port-logging-enable"

2236

#

2237

# Values are free-form strings, and only have meaning as interpreted by

2238

# the image running in the instance. The only restriction placed on them is

2239

# that each value's size must be less than or equal to 32 KB.

2240

#

2241

# The total size of all keys and values must be less than 512 KB.

2242

"a_key": "A String",

2243

},

2244

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

2245

# valid sources or targets for network firewalls and are specified by

2246

# the client during cluster or node pool creation. Each tag within the list

2247

# must comply with RFC1035.

2248

"A String",

2249

],

2250

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2251

"type": "A String", # Type of the sandbox to use for the node.

2252

},

2253

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2254

# https://cloud.google.com/compute/docs/instances/preemptible for more

2255

# information about preemptible VM instances.

2256

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2257

# workloads on the node pool.

2258

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2259

# on the node pool.

2260

},

2261

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2262

# The smallest allowed disk size is 10GB.

2263

#

2264

# If unspecified, the default disk size is 100GB.

2265

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

2266

# Specify the email address of the Service Account; otherwise, if no Service

2267

# Account is specified, the "default" service account is used.

2268

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2269

# See https://cloud.google.com/compute/docs/gpus for more information about

2270

# support for GPUs.

2271

{ # AcceleratorConfig represents a Hardware Accelerator request.

2272

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2273

# [here](https://cloud.google.com/compute/docs/gpus)

2274

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

},

],

},

"name": "A String", # The name of the node pool.

2279

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

2280

# simultaneously on a node in the node pool.

2281

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2282

},

2283

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

2284

# only if a valid configuration is present.

2285

# adjust the size of the node pool to the current cluster usage.

2286

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

2287

# max_node_count.

2288

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

2289

# has to enough quota to scale up the cluster.

2290

"enabled": True or False, # Is autoscaling enabled for this node pool.

2291

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2292

},

2293

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

2294

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

2295

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

2296

# associated with this node pool.

2297

"A String",

2298

],

2299

"status": "A String", # [Output only] The status of the nodes in this pool instance.

2300

"locations": [ # The list of Google Compute Engine

2301

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2302

# NodePool's nodes should be located.

"A String",

],

},

],

"subnetwork": "A String", # The name of the Google Compute Engine

2308

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

2309

# the cluster is connected.

2310

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

2311

# cluster, enabling additional functionality.

2312

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

2313

# This addon is deprecated, and will be disabled in 1.15. It is recommended

2314

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

2315

# workloads and applications. For more information, see:

2316

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

2317

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

2318

},

2319

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

2320

# managed Knative service.

2321

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2322

},

2323

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

2324

# makes it easy to set up HTTP load balancers for services in a cluster.

2325

# which makes it easy to set up HTTP load balancers for services in a cluster.

2326

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

2327

# When enabled, it runs a small pod in the cluster that manages the load

2328

# balancers.

2329

},

2330

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

2331

# increases or decreases the number of replica pods a replication controller

2332

# has based on the resource usage of the existing pods.

2333

# increases or decreases the number of replica pods a replication controller

2334

# has based on the resource usage of the existing pods.

2335

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

2336

# When enabled, it ensures that metrics are collected into Stackdriver

2337

# Monitoring.

2338

},

2339

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

2340

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

2341

},

2342

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

2343

# is enabled or not on the Master, it does not track whether network policy

2344

# is enabled for the nodes.

2345

# is enabled or not on the Master, it does not track whether network policy

2346

# is enabled for the nodes.

2347

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

2348

},

2349

},

2350

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

2351

# If unspecified, the defaults are used:

2352

# For clusters before v1.12, if master_auth is unspecified, `username` will

2353

# be set to "admin", a random password will be generated, and a client

2354

# certificate will be issued.

2355

# Authentication can be done using HTTP basic auth or using client

2356

# certificates.

2357

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

2358

# to the cluster endpoint.

2359

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

2360

# authenticate to the cluster endpoint.

2361

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

2362

# For clusters v1.6.0 and later, basic authentication can be disabled by

2363

# leaving username unspecified (or setting it to the empty string).

2364

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

2365

# Because the master endpoint is open to the Internet, you should create a

2366

# strong password. If a password is provided for cluster creation, username

2367

# must be non-empty.

2368

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

2369

# clusters before v1.12, if no configuration is specified, a client

2370

# certificate is issued.

2371

"issueClientCertificate": True or False, # Issue a client certificate.

2372

},

2373

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

2374

# trust for the cluster.

2375

},

2376

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

2377

# required by Vertical Pod Autoscaler to automatically adjust

2378

# the resources of pods controlled by it.

2379

"enabled": True or False, # Enables vertical pod autoscaling.

2380

},

2381

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

2382

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

2383

# found in validMasterVersions returned by getServerConfig. The version can

2384

# be upgraded over time; such upgrades are reflected in

2385

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2386

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2387

# Users may specify either explicit versions offered by

2388

# Kubernetes Engine or version aliases, which have the following behavior:

2389

#

2390

# - "latest": picks the highest valid Kubernetes version

2391

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

2392

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

2393

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

2394

# - "","-": picks the default Kubernetes version

2395

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

2396

# Call Kubernetes API directly to retrieve node information.

2397

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

2398

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2399

# notation (e.g. `1.2.3.4/29`).

2400

"locations": [ # The list of Google Compute Engine

2401

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2402

# cluster's nodes should be located.

2403

"A String",

2404

],

2405

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2406

"description": "A String", # An optional description of this cluster.

2407

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2408

# cluster, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2409

"location": "A String", # [Output only] The name of the Google Compute Engine

2410

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2411

# or

2412

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2413

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2414

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

2415

# this cluster, in

2416

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2417

# notation (e.g. `1.2.3.4/29`). Service addresses are

2418

# typically put in the last `/16` from the container CIDR.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="getJwks">getJwks(parent, x__xgafv=None)</code>

2424

<pre>Gets the public component of the cluster signing keys in

2425

JSON Web Key format.

2426

This API is not yet intended for general use, and is not available for all

clusters.

Args:

parent: string, The cluster (project, location, cluster id) to get keys for. Specified in

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2431

the format `projects/*/locations/*/clusters/*`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2432

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2439

2440

{ # GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2441

"keys": [ # The public component of the keys used by the cluster to sign token

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2442

# requests.

2443

{ # Jwk is a JSON Web Key as specified in RFC 7517

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2444

"alg": "A String", # Algorithm.

2445

"y": "A String", # Used for ECDSA keys.

2446

"use": "A String", # Permitted uses for the public keys.

2447

"e": "A String", # Used for RSA keys.

2448

"kid": "A String", # Key ID.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2449

"x": "A String", # Used for ECDSA keys.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2450

"crv": "A String", # Used for ECDSA keys.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2451

"n": "A String", # Used for RSA keys.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2452

"kty": "A String", # Key Type.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2453

},

2454

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2455

"cacheHeader": { # RFC-2616: cache control support # OnePlatform automatically extracts this field and uses it to set the HTTP

2456

# Cache-Control header.

2457

"expires": "A String", # 14.21 response cache expires, in RFC 1123 date format

2458

"directive": "A String", # 14.9 request and response directives

2459

"age": "A String", # 14.6 response cache age, in seconds since the response is generated

2460

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2465

<code class="details" id="list">list(parent, zone=None, projectId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2466

<pre>Lists all clusters owned by a project in either the specified zone or all

zones.

Args:

parent: string, The parent (project and location) where the clusters will be listed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2471

Specified in the format `projects/*/locations/*`.

2472

Location "-" matches all zones and all regions. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2473

zone: string, Deprecated. The name of the Google Compute Engine

2474

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

2475

cluster resides, or "-" for all zones. This field has been deprecated and

2476

replaced by the parent field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2477

projectId: string, Deprecated. The Google Developers Console [project ID or project

2478

number](https://support.google.com/cloud/answer/6158840).

2479

This field has been deprecated and replaced by the parent field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2480

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2487

2488

{ # ListClustersResponse is the result of ListClustersRequest.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2489

"clusters": [ # A list of clusters in the project in the specified zone, or

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2490

# across all ones.

2491

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2492

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

2493

"currentNodeVersion": "A String", # [Output only] Deprecated, use

2494

# [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools)

2495

# instead. The current version of the node software components. If they are

2496

# currently at multiple versions because they're in the process of being

2497

# upgraded, this reflects the minimum version of all nodes.

2498

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

2499

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

2500

# if enabled = true.

2501

"enabled": True or False, # Whether this cluster should return group membership lookups

2502

# during authentication using a group of security groups.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2503

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2504

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

2505

# API groups (e.g. v1alpha1) and features that may not be production ready in

2506

# the kubernetes version of the master and nodes.

2507

# The cluster has no SLA for uptime and master/node upgrades are disabled.

2508

# Alpha enabled clusters are automatically deleted thirty days after

2509

# creation.

2510

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

2511

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services

2512

# CIDR block. The secondary range will be used for service

2513

# ClusterIPs. This must be an existing secondary range associated

2514

# with the cluster subnetwork.

2515

#

2516

# This field is only applicable with use_ip_aliases is true and

2517

# create_subnetwork is false.

2518

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

2519

# this field is empty, then an automatic name will be chosen for the new

2520

# subnetwork.

2521

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

2522

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range

2523

# will be automatically chosen with the default size.

2524

#

2525

# This field is only applicable when `use_ip_aliases` is true.

2526

#

2527

# Set to blank to have a range chosen with the default size.

2528

#

2529

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2534

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2535

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2536

# to use.

2537

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

2538

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

2539

# block. The secondary range will be used for pod IP

2540

# addresses. This must be an existing secondary range associated

2541

# with the cluster subnetwork.

2542

#

2543

# This field is only applicable with use_ip_aliases is true and

2544

# create_subnetwork is false.

2545

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a

2546

# range will be automatically chosen with the default size.

2547

#

2548

# This field is only applicable when `use_ip_aliases` is true.

2549

#

2550

# If unspecified, the range will use the default size.

2551

#

2552

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2557

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2558

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2559

# to use.

2560

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

2561

#

2562

# This is applicable only if `create_subnetwork` is true.

2563

#

2564

# Set to blank to have a range chosen with the default size.

2565

#

2566

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2571

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2572

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2573

# to use.

2574

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

2575

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

2576

#

2577

# This field is only applicable when `use_ip_aliases` is true.

2578

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

2579

# `cluster.cluster_ipv4_cidr` must be left blank.

2580

#

2581

# This field is only applicable when `use_ip_aliases` is true.

2582

#

2583

# Set to blank to have a range chosen with the default size.

2584

#

2585

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2590

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2591

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2592

# to use.

2593

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

2594

},

2595

"loggingService": "A String", # The logging service the cluster should use to write logs.

2596

# Currently available options:

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2597

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2598

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

2599

# service with a Kubernetes-native resource model

2600

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

2601

# available as of GKE 1.15).

2602

# * `none` - no logs will be exported from the cluster.

2603

#

2604

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

2605

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

2606

"zone": "A String", # [Output only] The name of the Google Compute Engine

2607

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2608

# cluster resides. This field is deprecated, use location instead.

2609

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

2610

# mode.

2611

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

2612

# identities in the system, including service accounts, nodes, and

2613

# controllers, will have statically granted permissions beyond those

2614

# provided by the RBAC configuration or IAM.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2615

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2616

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

2617

# Google Compute Engine resources.

2618

"a_key": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2619

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2620

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2621

# containers. This is provisioned from within the `container_ipv4_cidr`

2622

# range. This field will only be set when cluster is in route-based network

2623

# mode.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2624

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

2625

# subscribed to. Release channels are arranged in order of risk.

2626

#

2627

# When a cluster is subscribed to a release channel, Google maintains

2628

# both the master version and the node version. Node auto-upgrade

2629

# defaults to true and cannot be disabled.

2630

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2631

},

2632

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

2633

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2634

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

2635

# occur in these windows.

2636

"a_key": { # Represents an arbitrary window of time.

2637

"endTime": "A String", # The time that the window ends. The end time should take place after the

2638

# start time.

2639

"startTime": "A String", # The time that the window first starts.

2640

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2641

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2642

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

2643

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

2644

# smallest possible in the given scenario.

2645

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

2646

# format "PTnHnMnS".

2647

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

2648

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

2649

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

2650

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2651

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2652

# maintenance to occur. The time windows may be overlapping. If no

2653

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2654

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

2655

"endTime": "A String", # The time that the window ends. The end time should take place after the

2656

# start time.

2657

"startTime": "A String", # The time that the window first starts.

2658

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2659

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2660

# this window reccurs. They go on for the span of time between the start and

2661

# end time.

2662

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2663

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2664

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

2665

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

2666

# <code>FREQ=DAILY</code>

2667

# For the first weekend of every month:

2668

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

2669

# This specifies how frequently the window starts. Eg, if you wanted to have

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2670

# a 9-5 UTC-4 window every weekday, you'd use something like:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2671

# <code>

2672

# start time = 2019-01-01T09:00:00-0400

2673

# end time = 2019-01-01T17:00:00-0400

2674

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

2675

# </code>

2676

# Windows can span multiple days. Eg, to make the window encompass every

2677

# weekend from midnight Saturday till the last minute of Sunday UTC:

2678

# <code>

2679

# start time = 2019-01-05T00:00:00Z

2680

# end time = 2019-01-07T23:59:00Z

2681

# recurrence = FREQ=WEEKLY;BYDAY=SA

2682

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2683

# Note the start and end time's specific dates are largely arbitrary except

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2684

# to specify duration of the window and when it first starts.

2685

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2686

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2687

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2688

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

2689

# the policy won't accidentally undo intermediate changes (and so that users

2690

# of the API unaware of some fields won't accidentally remove other fields).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2691

# Make a <code>get()</code> request to the cluster to get the current

2692

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2693

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2694

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

2695

# Currently available options:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2696

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2697

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

2698

# service with a Kubernetes-native resource model

2699

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

2700

# longer available as of GKE 1.15).

2701

# * `none` - No metrics will be exported from the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2702

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2703

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

2704

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

2705

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

2706

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

2707

# images will be validated by Binary Authorization.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2708

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2709

"expireTime": "A String", # [Output only] The time the cluster will be automatically

2710

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2711

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2712

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2713

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2714

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

2715

# The endpoint can be accessed from the internet at

2716

# `https://username:password@endpoint/`.

2717

#

2718

# See the `masterAuth` property of this resource for username and

2719

# password information.

2720

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

2721

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

2722

},

2723

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

2724

# master authorized networks will disallow all external traffic to access

2725

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

2726

# Google Compute Engine Public IPs and Google Prod IPs.

2727

"enabled": True or False, # Whether or not master authorized networks is enabled.

2728

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

2729

# Kubernetes master through HTTPS.

2730

{ # CidrBlock contains an optional name and one CIDR block.

2731

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

2732

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2733

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2734

],

2735

},

2736

"conditions": [ # Which conditions caused the current cluster state.

2737

{ # StatusCondition describes why a cluster or a node pool has a certain status

2738

# (e.g., ERROR or DEGRADED).

2739

"message": "A String", # Human-friendly representation of the condition

2740

"code": "A String", # Machine-friendly representation of the condition

2741

},

2742

],

2743

"network": "A String", # The name of the Google Compute Engine

2744

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2745

# to which the cluster is connected. If left unspecified, the `default`

2746

# network will be used.

2747

"status": "A String", # [Output only] The current status of this cluster.

2748

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

2749

# required by Cluster Autoscaler to automatically adjust

2750

# the size of the cluster and create/delete

2751

# node pools based on the current needs.

2752

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

2753

# amount of resources in the cluster.

2754

{ # Contains information about amount of some resource in the cluster.

2755

# For memory, value should be in GB.

2756

"minimum": "A String", # Minimum amount of the resource in the cluster.

2757

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

2758

"maximum": "A String", # Maximum amount of the resource in the cluster.

2759

},

2760

],

2761

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

2762

# created by NAP.

2763

# by NAP.

2764

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

2765

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

2766

# node pool.

2767

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2768

# the Auto Upgrades will proceed.

2769

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2770

# with the description of the upgrade.

2771

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2772

# with the approximate start time for the upgrades, in

2773

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2774

},

2775

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

2776

# pool. If enabled, the nodes in this node pool will be monitored and, if

2777

# they fail health checks too many times, an automatic repair action will be

2778

# triggered.

2779

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

2780

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

2781

# up to date with the latest release version of Kubernetes.

2782

},

2783

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2784

# disruption caused by an upgrade.

2785

#

2786

# maxUnavailable controls the number of nodes that can be simultaneously

2787

# unavailable.

2788

#

2789

# maxSurge controls the number of additional nodes that can be added to the

2790

# node pool temporarily for the time of the upgrade to increase the number of

2791

# available nodes.

2792

#

2793

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2794

# nodes are being upgraded at the same time).

2795

#

2796

# Note: upgrades inevitably introduce some disruption since workloads need to

2797

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2798

# this holds true. (Disruption stays within the limits of

2799

# PodDisruptionBudget, if it is configured.)

2800

#

2801

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2802

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2803

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2804

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2805

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2806

"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]

2807

# the upgrade process. A node is considered available if its status is

2808

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2809

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2810

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2811

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2812

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2813

"A String",

2814

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2815

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2816

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

2817

"autoprovisioningLocations": [ # The list of Google Compute Engine

2818

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2819

# NodePool's nodes can be created by NAP.

"A String",

],

},

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2824

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

2825

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2826

"enabled": True or False, # Whether network policy is enabled on the cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2827

"provider": "A String", # The selected network policy provider.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2828

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2829

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2830

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2831

# notation (e.g. `10.96.0.0/14`). Leave blank to have

2832

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

2833

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

2834

# simultaneously on a node in the node pool of this cluster. Only honored

2835

# if cluster created with IP Alias support.

2836

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2837

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2838

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2839

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2840

# "node_pool" object, since this configuration (along with the

2841

# "initial_node_count") will be used to create a "NodePool" object with an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2842

# auto-generated name. Do not use this and a node_pool at the same time.

2843

# For responses, this field will be populated with the node configuration of

2844

# the first node pool. (For configuration of each node pool, see

2845

# `node_pool.config`)

2846

#

2847

# If unspecified, the defaults are used.

2848

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2849

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2850

#

2851

# If unspecified, the default disk type is 'pd-standard'

2852

"bootDiskKmsKey": "A String", #

2853

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2854

# to each node in the node pool. This should be of the form

2855

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2856

# For more information about protecting resources with Cloud KMS Keys please

2857

# see:

2858

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

2859

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2860

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2861

#

2862

# Enables monitoring and attestation of the boot integrity of the instance.

2863

# The attestation is performed against the integrity policy baseline. This

2864

# baseline is initially derived from the implicitly trusted boot image when

2865

# the instance is created.

2866

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2867

#

2868

# Secure Boot helps ensure that the system only runs authentic software by

2869

# verifying the digital signature of all boot components, and halting the

2870

# boot process if signature verification fails.

2871

},

2872

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2873

# These will added in addition to any default label(s) that

2874

# Kubernetes may apply to the node.

2875

# In case of conflict in label keys, the applied set may differ depending on

2876

# the Kubernetes version -- it's best to assume the behavior is undefined

2877

# and conflicts should be avoided.

2878

# For more information, including usage and the valid values, see:

2879

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2880

"a_key": "A String",

2881

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2882

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2883

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2884

#

2885

# The following scopes are recommended, but not required, and by default are

2886

# not included:

2887

#

2888

# * `https://www.googleapis.com/auth/compute` is required for mounting

2889

# persistent storage on your nodes.

2890

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2891

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2892

# (the [Google Container

2893

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2894

#

2895

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2896

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2897

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2898

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2899

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2900

# scheduled on the specified or newer CPU platform. Applicable values are the

2901

# friendly names of CPU platforms, such as

2902

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2903

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2904

# information, read [how to specify min CPU

2905

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2906

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

2907

#

2908

# The limit for this value is dependent upon the maximum number of

2909

# disks available on a machine per zone. See:

2910

# https://cloud.google.com/compute/docs/disks/local-ssd

2911

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2912

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2913

#

2914

# For more information, including usage and the valid values, see:

2915

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2916

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2917

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2918

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2919

# See

2920

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2921

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2922

"value": "A String", # Value for taint.

2923

"key": "A String", # Key for taint.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2924

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2925

},

2926

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2927

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2928

# the latest version of it will be used.

2929

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2930

# the specified [Zonal Compute

2931

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2932

# to this node pool.

2933

# is the configuration of desired reservation which instances could take

2934

# capacity from.

2935

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2936

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2937

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2938

# the key and specify the name of your reservation as its value.

2939

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2940

"A String",

2941

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2942

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2943

"machineType": "A String", # The name of a Google Compute Engine [machine

2944

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2945

# `n1-standard-1`).

2946

#

2947

# If unspecified, the default machine type is

2948

# `n1-standard-1`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2949

"nodeGroup": "A String", # Setting this field will assign instances of this

2950

# pool to run on the specified node group. This is useful for running

2951

# workloads on [sole tenant

2952

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2953

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2954

#

2955

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2956

# in length. These are reflected as part of a URL in the metadata server.

2957

# Additionally, to avoid ambiguity, keys must not conflict with any other

2958

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2964

# "enable-os-login"

2965

# "gci-ensure-gke-docker"

2966

# "gci-metrics-enabled"

2967

# "gci-update-strategy"

2968

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2973

# "windows-startup-script-ps1"

2974

# "common-psm1"

2975

# "k8s-node-setup-psm1"

2976

# "install-ssh-psm1"

2977

# "user-profile-psm1"

2978

# "serial-port-logging-enable"

2979

#

2980

# Values are free-form strings, and only have meaning as interpreted by

2981

# the image running in the instance. The only restriction placed on them is

2982

# that each value's size must be less than or equal to 32 KB.

2983

#

2984

# The total size of all keys and values must be less than 512 KB.

2985

"a_key": "A String",

2986

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2987

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

2988

# valid sources or targets for network firewalls and are specified by

2989

# the client during cluster or node pool creation. Each tag within the list

2990

# must comply with RFC1035.

2991

"A String",

2992

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2993

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2994

"type": "A String", # Type of the sandbox to use for the node.

2995

},

2996

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2997

# https://cloud.google.com/compute/docs/instances/preemptible for more

2998

# information about preemptible VM instances.

2999

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3000

# workloads on the node pool.

3001

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3002

# on the node pool.

3003

},

3004

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3005

# The smallest allowed disk size is 10GB.

3006

#

3007

# If unspecified, the default disk size is 100GB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3008

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

3009

# Specify the email address of the Service Account; otherwise, if no Service

3010

# Account is specified, the "default" service account is used.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3011

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3012

# See https://cloud.google.com/compute/docs/gpus for more information about

3013

# support for GPUs.

3014

{ # AcceleratorConfig represents a Hardware Accelerator request.

3015

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3016

# [here](https://cloud.google.com/compute/docs/gpus)

3017

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3018

},

3019

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3020

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3021

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

3022

# disabled when this config is unspecified.

3023

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

3024

# daemonset will be created in the cluster to meter network egress traffic.

3025

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

3026

"datasetId": "A String", # The ID of a BigQuery Dataset.

3027

},

3028

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

3029

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

3030

# second BigQuery table will be created to hold resource consumption

3031

# records.

3032

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3033

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3034

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

3035

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

3036

# is sufficient for this number of instances. You must also have available

3037

# firewall and routes quota.

3038

# For requests, this field should only be used in lieu of a

3039

# "node_pool" object, since this configuration (along with the

3040

# "node_config") will be used to create a "NodePool" object with an

3041

# auto-generated name. Do not use this and a node_pool at the same time.

3042

#

3043

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3044

"name": "A String", # The name of this cluster. The name must be unique within this project

3045

# and location (e.g. zone or region), and can be up to 40 characters with

3046

# the following restrictions:

3047

#

3048

# * Lowercase letters, numbers, and hyphens only.

3049

# * Must start with a letter.

3050

# * Must end with a number or a letter.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3051

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

3052

# policies.

3053

# policies.

3054

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

3055

},

3056

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

3057

"network": "A String", # Output only. The relative name of the Google Compute Engine

3058

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

3059

# to which the cluster is connected. Example:

3060

# projects/my-project/global/networks/my-network

3061

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

3062

# This makes same node pod to pod traffic visible for VPC network.

3063

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

3064

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

3065

# cluster is connected. Example:

3066

# projects/my-project/regions/us-central1/subnetworks/my-subnet

3067

},

3068

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

3069

"state": "A String", # Denotes the state of etcd encryption.

3070

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

3071

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

3072

},

3073

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

3074

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

3075

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

3076

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

3077

# given only RFC 1918 private addresses and communicate with the master via

3078

# private networking.

3079

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

3080

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

3081

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

3082

# range will be used for assigning internal IP addresses to the master or

3083

# set of masters, as well as the ILB VIP. This range must not overlap with

3084

# any other ranges in use within the cluster's network.

3085

},

3086

"createTime": "A String", # [Output only] The time the cluster was created, in

3087

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3088

"nodePools": [ # The node pools associated with this cluster.

3089

# This field should not be set if "node_config" or "initial_node_count" are

3090

# specified.

3091

{ # NodePool contains the name and configuration for a cluster's node pool.

3092

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

3093

# specification, under the control of the cluster master. They may have a set

3094

# of Kubernetes labels applied to them, which may be used to reference them

3095

# during pod scheduling. They may also be resized up or down, to accommodate

3096

# the workload.

3097

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

3098

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

3099

# node pool.

3100

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3101

# the Auto Upgrades will proceed.

3102

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3103

# with the description of the upgrade.

3104

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3105

# with the approximate start time for the upgrades, in

3106

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3107

},

3108

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

3109

# pool. If enabled, the nodes in this node pool will be monitored and, if

3110

# they fail health checks too many times, an automatic repair action will be

3111

# triggered.

3112

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

3113

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

3114

# up to date with the latest release version of Kubernetes.

3115

},

3116

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

3117

# disruption caused by an upgrade.

3118

#

3119

# maxUnavailable controls the number of nodes that can be simultaneously

3120

# unavailable.

3121

#

3122

# maxSurge controls the number of additional nodes that can be added to the

3123

# node pool temporarily for the time of the upgrade to increase the number of

3124

# available nodes.

3125

#

3126

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3127

# nodes are being upgraded at the same time).

3128

#

3129

# Note: upgrades inevitably introduce some disruption since workloads need to

3130

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3131

# this holds true. (Disruption stays within the limits of

3132

# PodDisruptionBudget, if it is configured.)

3133

#

3134

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3135

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3136

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3137

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3138

# there are always at least 4 nodes available.

3139

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3140

# the upgrade process. A node is considered available if its status is

3141

# Ready.

3142

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3143

# of the node pool during the upgrade process.

3144

},

3145

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

3146

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

3147

# is sufficient for this number of instances. You must also have available

3148

# firewall and routes quota.

3149

"statusMessage": "A String", # [Output only] Additional information about the current status of this

3150

# node pool instance, if available.

3151

"version": "A String", # The version of the Kubernetes of this node.

3152

"conditions": [ # Which conditions caused the current node pool state.

3153

{ # StatusCondition describes why a cluster or a node pool has a certain status

3154

# (e.g., ERROR or DEGRADED).

3155

"message": "A String", # Human-friendly representation of the condition

3156

"code": "A String", # Machine-friendly representation of the condition

3157

},

3158

],

3159

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

3160

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3161

#

3162

# If unspecified, the default disk type is 'pd-standard'

3163

"bootDiskKmsKey": "A String", #

3164

# The Customer Managed Encryption Key used to encrypt the boot disk attached

3165

# to each node in the node pool. This should be of the form

3166

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

3167

# For more information about protecting resources with Cloud KMS Keys please

3168

# see:

3169

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

3170

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3171

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3172

#

3173

# Enables monitoring and attestation of the boot integrity of the instance.

3174

# The attestation is performed against the integrity policy baseline. This

3175

# baseline is initially derived from the implicitly trusted boot image when

3176

# the instance is created.

3177

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3178

#

3179

# Secure Boot helps ensure that the system only runs authentic software by

3180

# verifying the digital signature of all boot components, and halting the

3181

# boot process if signature verification fails.

3182

},

3183

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3184

# These will added in addition to any default label(s) that

3185

# Kubernetes may apply to the node.

3186

# In case of conflict in label keys, the applied set may differ depending on

3187

# the Kubernetes version -- it's best to assume the behavior is undefined

3188

# and conflicts should be avoided.

3189

# For more information, including usage and the valid values, see:

3190

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3191

"a_key": "A String",

3192

},

3193

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3194

# node VMs under the "default" service account.

3195

#

3196

# The following scopes are recommended, but not required, and by default are

3197

# not included:

3198

#

3199

# * `https://www.googleapis.com/auth/compute` is required for mounting

3200

# persistent storage on your nodes.

3201

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3202

# communicating with **gcr.io**

3203

# (the [Google Container

3204

# Registry](https://cloud.google.com/container-registry/)).

3205

#

3206

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3207

# Monitoring are enabled, in which case their required scopes will be added.

3208

"A String",

3209

],

3210

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3211

# scheduled on the specified or newer CPU platform. Applicable values are the

3212

# friendly names of CPU platforms, such as

3213

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3214

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3215

# information, read [how to specify min CPU

3216

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3217

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

3218

#

3219

# The limit for this value is dependent upon the maximum number of

3220

# disks available on a machine per zone. See:

3221

# https://cloud.google.com/compute/docs/disks/local-ssd

3222

# for more information.

3223

"taints": [ # List of kubernetes taints to be applied to each node.

3224

#

3225

# For more information, including usage and the valid values, see:

3226

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3227

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3228

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3229

#

3230

# See

3231

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3232

# for more information, including usage and the valid values.

3233

"value": "A String", # Value for taint.

3234

"key": "A String", # Key for taint.

3235

"effect": "A String", # Effect for taint.

3236

},

3237

],

3238

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3239

# the latest version of it will be used.

3240

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3241

# the specified [Zonal Compute

3242

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3243

# to this node pool.

3244

# is the configuration of desired reservation which instances could take

3245

# capacity from.

3246

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3247

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3248

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3249

# the key and specify the name of your reservation as its value.

3250

"values": [ # Corresponds to the label value(s) of reservation resource(s).

"A String",

],

},

"machineType": "A String", # The name of a Google Compute Engine [machine

3255

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3256

# `n1-standard-1`).

3257

#

3258

# If unspecified, the default machine type is

3259

# `n1-standard-1`.

3260

"nodeGroup": "A String", # Setting this field will assign instances of this

3261

# pool to run on the specified node group. This is useful for running

3262

# workloads on [sole tenant

3263

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

3264

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3265

#

3266

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3267

# in length. These are reflected as part of a URL in the metadata server.

3268

# Additionally, to avoid ambiguity, keys must not conflict with any other

3269

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3275

# "enable-os-login"

3276

# "gci-ensure-gke-docker"

3277

# "gci-metrics-enabled"

3278

# "gci-update-strategy"

3279

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3284

# "windows-startup-script-ps1"

3285

# "common-psm1"

3286

# "k8s-node-setup-psm1"

3287

# "install-ssh-psm1"

3288

# "user-profile-psm1"

3289

# "serial-port-logging-enable"

3290

#

3291

# Values are free-form strings, and only have meaning as interpreted by

3292

# the image running in the instance. The only restriction placed on them is

3293

# that each value's size must be less than or equal to 32 KB.

3294

#

3295

# The total size of all keys and values must be less than 512 KB.

3296

"a_key": "A String",

3297

},

3298

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

3299

# valid sources or targets for network firewalls and are specified by

3300

# the client during cluster or node pool creation. Each tag within the list

3301

# must comply with RFC1035.

3302

"A String",

3303

],

3304

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3305

"type": "A String", # Type of the sandbox to use for the node.

3306

},

3307

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3308

# https://cloud.google.com/compute/docs/instances/preemptible for more

3309

# information about preemptible VM instances.

3310

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3311

# workloads on the node pool.

3312

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3313

# on the node pool.

3314

},

3315

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3316

# The smallest allowed disk size is 10GB.

3317

#

3318

# If unspecified, the default disk size is 100GB.

3319

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

3320

# Specify the email address of the Service Account; otherwise, if no Service

3321

# Account is specified, the "default" service account is used.

3322

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3323

# See https://cloud.google.com/compute/docs/gpus for more information about

3324

# support for GPUs.

3325

{ # AcceleratorConfig represents a Hardware Accelerator request.

3326

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3327

# [here](https://cloud.google.com/compute/docs/gpus)

3328

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

},

],

},

"name": "A String", # The name of the node pool.

3333

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

3334

# simultaneously on a node in the node pool.

3335

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

3336

},

3337

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

3338

# only if a valid configuration is present.

3339

# adjust the size of the node pool to the current cluster usage.

3340

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

3341

# max_node_count.

3342

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

3343

# has to enough quota to scale up the cluster.

3344

"enabled": True or False, # Is autoscaling enabled for this node pool.

3345

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

3346

},

3347

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

3348

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

3349

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

3350

# associated with this node pool.

3351

"A String",

3352

],

3353

"status": "A String", # [Output only] The status of the nodes in this pool instance.

3354

"locations": [ # The list of Google Compute Engine

3355

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3356

# NodePool's nodes should be located.

"A String",

],

},

],

"subnetwork": "A String", # The name of the Google Compute Engine

3362

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

3363

# the cluster is connected.

3364

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

3365

# cluster, enabling additional functionality.

3366

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

3367

# This addon is deprecated, and will be disabled in 1.15. It is recommended

3368

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

3369

# workloads and applications. For more information, see:

3370

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

3371

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

3372

},

3373

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

3374

# managed Knative service.

3375

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

3376

},

3377

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

3378

# makes it easy to set up HTTP load balancers for services in a cluster.

3379

# which makes it easy to set up HTTP load balancers for services in a cluster.

3380

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

3381

# When enabled, it runs a small pod in the cluster that manages the load

3382

# balancers.

3383

},

3384

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

3385

# increases or decreases the number of replica pods a replication controller

3386

# has based on the resource usage of the existing pods.

3387

# increases or decreases the number of replica pods a replication controller

3388

# has based on the resource usage of the existing pods.

3389

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

3390

# When enabled, it ensures that metrics are collected into Stackdriver

3391

# Monitoring.

3392

},

3393

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

3394

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

3395

},

3396

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

3397

# is enabled or not on the Master, it does not track whether network policy

3398

# is enabled for the nodes.

3399

# is enabled or not on the Master, it does not track whether network policy

3400

# is enabled for the nodes.

3401

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

3402

},

3403

},

3404

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

3405

# If unspecified, the defaults are used:

3406

# For clusters before v1.12, if master_auth is unspecified, `username` will

3407

# be set to "admin", a random password will be generated, and a client

3408

# certificate will be issued.

3409

# Authentication can be done using HTTP basic auth or using client

3410

# certificates.

3411

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

3412

# to the cluster endpoint.

3413

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

3414

# authenticate to the cluster endpoint.

3415

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

3416

# For clusters v1.6.0 and later, basic authentication can be disabled by

3417

# leaving username unspecified (or setting it to the empty string).

3418

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

3419

# Because the master endpoint is open to the Internet, you should create a

3420

# strong password. If a password is provided for cluster creation, username

3421

# must be non-empty.

3422

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

3423

# clusters before v1.12, if no configuration is specified, a client

3424

# certificate is issued.

3425

"issueClientCertificate": True or False, # Issue a client certificate.

3426

},

3427

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

3428

# trust for the cluster.

3429

},

3430

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

3431

# required by Vertical Pod Autoscaler to automatically adjust

3432

# the resources of pods controlled by it.

3433

"enabled": True or False, # Enables vertical pod autoscaling.

3434

},

3435

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

3436

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

3437

# found in validMasterVersions returned by getServerConfig. The version can

3438

# be upgraded over time; such upgrades are reflected in

3439

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3440

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3441

# Users may specify either explicit versions offered by

3442

# Kubernetes Engine or version aliases, which have the following behavior:

3443

#

3444

# - "latest": picks the highest valid Kubernetes version

3445

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

3446

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

3447

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

3448

# - "","-": picks the default Kubernetes version

3449

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

3450

# Call Kubernetes API directly to retrieve node information.

3451

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

3452

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3453

# notation (e.g. `1.2.3.4/29`).

3454

"locations": [ # The list of Google Compute Engine

3455

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3456

# cluster's nodes should be located.

3457

"A String",

3458

],

3459

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

3460

"description": "A String", # An optional description of this cluster.

3461

"statusMessage": "A String", # [Output only] Additional information about the current status of this

3462

# cluster, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3463

"location": "A String", # [Output only] The name of the Google Compute Engine

3464

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3465

# or

3466

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3467

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3468

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

3469

# this cluster, in

3470

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3471

# notation (e.g. `1.2.3.4/29`). Service addresses are

3472

# typically put in the last `/16` from the container CIDR.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3473

},

3474

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3475

"missingZones": [ # If any zones are listed here, the list of clusters returned

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3476

# may be missing those zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3477

"A String",

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]

3483

<code class="details" id="setAddons">setAddons(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3484

<pre>Sets the addons for a specific cluster.

3485

3486

Args:

3487

name: string, The name (project, location, cluster) of the cluster to set addons.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3488

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3489

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3490

The object takes the form of:

3491

3492

{ # SetAddonsConfigRequest sets the addons associated with the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3493

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Required. The desired configurations for the various addons available to run in the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3494

# cluster.

3495

# cluster, enabling additional functionality.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3496

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

3497

# This addon is deprecated, and will be disabled in 1.15. It is recommended

3498

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

3499

# workloads and applications. For more information, see:

3500

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

3501

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3502

},

3503

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

3504

# managed Knative service.

3505

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

3506

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3507

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

3508

# makes it easy to set up HTTP load balancers for services in a cluster.

3509

# which makes it easy to set up HTTP load balancers for services in a cluster.

3510

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

3511

# When enabled, it runs a small pod in the cluster that manages the load

3512

# balancers.

3513

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3514

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

3515

# increases or decreases the number of replica pods a replication controller

3516

# has based on the resource usage of the existing pods.

3517

# increases or decreases the number of replica pods a replication controller

3518

# has based on the resource usage of the existing pods.

3519

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

3520

# When enabled, it ensures that metrics are collected into Stackdriver

3521

# Monitoring.

3522

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3523

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

3524

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3525

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3526

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

3527

# is enabled or not on the Master, it does not track whether network policy

3528

# is enabled for the nodes.

3529

# is enabled or not on the Master, it does not track whether network policy

3530

# is enabled for the nodes.

3531

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3532

},

3533

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3534

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3535

# This field has been deprecated and replaced by the name field.

3536

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

3537

# number](https://support.google.com/cloud/answer/6158840).

3538

# This field has been deprecated and replaced by the name field.

3539

"name": "A String", # The name (project, location, cluster) of the cluster to set addons.

3540

# Specified in the format `projects/*/locations/*/clusters/*`.

3541

"zone": "A String", # Deprecated. The name of the Google Compute Engine

3542

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3543

# cluster resides. This field has been deprecated and replaced by the name

3544

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3545

}

3546

3547

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3554

3555

{ # This operation resource represents operations that may have happened or are

3556

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3557

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3558

"name": "A String", # A non-parameterized string describing an operation stage.

3559

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3560

"metrics": [ # Progress metric bundle, for example:

3561

# metrics: [{name: "nodes done", int_value: 15},

3562

# {name: "nodes total", int_value: 32}]

3563

# or

3564

# metrics: [{name: "progress", double_value: 0.56},

3565

# {name: "progress scale", double_value: 1.0}]

3566

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3567

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3568

"doubleValue": 3.14, # For metrics with floating point value.

3569

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3570

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3571

},

3572

],

3573

"status": "A String", # Status of an operation stage.

3574

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3575

"stages": [ # Substages of an operation or a stage.

3576

# Object with schema name: OperationProgress

3577

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3578

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3579

"targetLink": "A String", # Server-defined URL for the target of the operation.

3580

"status": "A String", # The current status of the operation.

3581

"operationType": "A String", # The operation type.

3582

"startTime": "A String", # [Output only] The time the operation started, in

3583

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3584

"clusterConditions": [ # Which conditions caused the current cluster state.

3585

{ # StatusCondition describes why a cluster or a node pool has a certain status

3586

# (e.g., ERROR or DEGRADED).

3587

"message": "A String", # Human-friendly representation of the condition

3588

"code": "A String", # Machine-friendly representation of the condition

3589

},

3590

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3591

"zone": "A String", # The name of the Google Compute Engine

3592

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3593

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3594

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3595

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3596

"detail": "A String", # Detailed operation progress, if available.

3597

"endTime": "A String", # [Output only] The time the operation completed, in

3598

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3599

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3600

{ # StatusCondition describes why a cluster or a node pool has a certain status

3601

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3602

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3603

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3604

},

3605

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3606

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3607

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3608

# or

3609

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3610

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3611

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3616

<code class="details" id="setLegacyAbac">setLegacyAbac(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3617

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

3618

3619

Args:

3620

name: string, The name (project, location, cluster id) of the cluster to set legacy abac.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3621

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3622

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3623

The object takes the form of:

3624

3625

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for

3626

# a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3627

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac.

3628

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3629

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3630

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3631

# cluster resides. This field has been deprecated and replaced by the name

3632

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3633

"clusterId": "A String", # Deprecated. The name of the cluster to update.

3634

# This field has been deprecated and replaced by the name field.

3635

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

3636

# number](https://support.google.com/cloud/answer/6158840).

3637

# This field has been deprecated and replaced by the name field.

3638

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3639

}

3640

3641

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3648

3649

{ # This operation resource represents operations that may have happened or are

3650

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3651

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3652

"name": "A String", # A non-parameterized string describing an operation stage.

3653

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3654

"metrics": [ # Progress metric bundle, for example:

3655

# metrics: [{name: "nodes done", int_value: 15},

3656

# {name: "nodes total", int_value: 32}]

3657

# or

3658

# metrics: [{name: "progress", double_value: 0.56},

3659

# {name: "progress scale", double_value: 1.0}]

3660

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3661

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3662

"doubleValue": 3.14, # For metrics with floating point value.

3663

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3664

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3665

},

3666

],

3667

"status": "A String", # Status of an operation stage.

3668

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3669

"stages": [ # Substages of an operation or a stage.

3670

# Object with schema name: OperationProgress

3671

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3672

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3673

"targetLink": "A String", # Server-defined URL for the target of the operation.

3674

"status": "A String", # The current status of the operation.

3675

"operationType": "A String", # The operation type.

3676

"startTime": "A String", # [Output only] The time the operation started, in

3677

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3678

"clusterConditions": [ # Which conditions caused the current cluster state.

3679

{ # StatusCondition describes why a cluster or a node pool has a certain status

3680

# (e.g., ERROR or DEGRADED).

3681

"message": "A String", # Human-friendly representation of the condition

3682

"code": "A String", # Machine-friendly representation of the condition

3683

},

3684

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3685

"zone": "A String", # The name of the Google Compute Engine

3686

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3687

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3688

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3689

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3690

"detail": "A String", # Detailed operation progress, if available.

3691

"endTime": "A String", # [Output only] The time the operation completed, in

3692

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3693

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3694

{ # StatusCondition describes why a cluster or a node pool has a certain status

3695

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3696

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3697

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3698

},

3699

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3700

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3701

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3702

# or

3703

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3704

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3705

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3710

<code class="details" id="setLocations">setLocations(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3711

<pre>Sets the locations for a specific cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3712

Deprecated. Use

3713

[projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update)

3714

instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3715

3716

Args:

3717

name: string, The name (project, location, cluster) of the cluster to set locations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3718

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3719

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3720

The object takes the form of:

3721

3722

{ # SetLocationsRequest sets the locations of the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3723

"name": "A String", # The name (project, location, cluster) of the cluster to set locations.

3724

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3725

"zone": "A String", # Deprecated. The name of the Google Compute Engine

3726

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3727

# cluster resides. This field has been deprecated and replaced by the name

3728

# field.

3729

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3730

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3731

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3732

# number](https://support.google.com/cloud/answer/6158840).

3733

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3734

"locations": [ # Required. The desired list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3735

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3736

# cluster's nodes should be located. Changing the locations a cluster is in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3737

# will result in nodes being either created or removed from the cluster,

3738

# depending on whether locations are being added or removed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3739

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3740

# This list must always include the cluster's primary zone.

3741

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3742

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3743

}

3744

3745

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3752

3753

{ # This operation resource represents operations that may have happened or are

3754

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3755

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3756

"name": "A String", # A non-parameterized string describing an operation stage.

3757

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3758

"metrics": [ # Progress metric bundle, for example:

3759

# metrics: [{name: "nodes done", int_value: 15},

3760

# {name: "nodes total", int_value: 32}]

3761

# or

3762

# metrics: [{name: "progress", double_value: 0.56},

3763

# {name: "progress scale", double_value: 1.0}]

3764

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3765

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3766

"doubleValue": 3.14, # For metrics with floating point value.

3767

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3768

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3769

},

3770

],

3771

"status": "A String", # Status of an operation stage.

3772

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3773

"stages": [ # Substages of an operation or a stage.

3774

# Object with schema name: OperationProgress

3775

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3776

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3777

"targetLink": "A String", # Server-defined URL for the target of the operation.

3778

"status": "A String", # The current status of the operation.

3779

"operationType": "A String", # The operation type.

3780

"startTime": "A String", # [Output only] The time the operation started, in

3781

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3782

"clusterConditions": [ # Which conditions caused the current cluster state.

3783

{ # StatusCondition describes why a cluster or a node pool has a certain status

3784

# (e.g., ERROR or DEGRADED).

3785

"message": "A String", # Human-friendly representation of the condition

3786

"code": "A String", # Machine-friendly representation of the condition

3787

},

3788

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3789

"zone": "A String", # The name of the Google Compute Engine

3790

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3791

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3792

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3793

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3794

"detail": "A String", # Detailed operation progress, if available.

3795

"endTime": "A String", # [Output only] The time the operation completed, in

3796

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3797

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3798

{ # StatusCondition describes why a cluster or a node pool has a certain status

3799

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3800

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3801

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3802

},

3803

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3804

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3805

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3806

# or

3807

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3808

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3809

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3814

<code class="details" id="setLogging">setLogging(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3815

<pre>Sets the logging service for a specific cluster.

3816

3817

Args:

3818

name: string, The name (project, location, cluster) of the cluster to set logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3819

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3820

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3821

The object takes the form of:

3822

3823

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3824

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3825

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3826

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3827

# number](https://support.google.com/cloud/answer/6158840).

3828

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3829

"name": "A String", # The name (project, location, cluster) of the cluster to set logging.

3830

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3831

"zone": "A String", # Deprecated. The name of the Google Compute Engine

3832

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3833

# cluster resides. This field has been deprecated and replaced by the name

3834

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3835

"loggingService": "A String", # Required. The logging service the cluster should use to write logs.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3836

# Currently available options:

3837

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3838

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

3839

# service with a Kubernetes-native resource model

3840

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

3841

# available as of GKE 1.15).

3842

# * `none` - no logs will be exported from the cluster.

3843

#

3844

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

3845

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3846

}

3847

3848

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3855

3856

{ # This operation resource represents operations that may have happened or are

3857

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3858

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3859

"name": "A String", # A non-parameterized string describing an operation stage.

3860

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3861

"metrics": [ # Progress metric bundle, for example:

3862

# metrics: [{name: "nodes done", int_value: 15},

3863

# {name: "nodes total", int_value: 32}]

3864

# or

3865

# metrics: [{name: "progress", double_value: 0.56},

3866

# {name: "progress scale", double_value: 1.0}]

3867

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3868

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3869

"doubleValue": 3.14, # For metrics with floating point value.

3870

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3871

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3872

},

3873

],

3874

"status": "A String", # Status of an operation stage.

3875

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3876

"stages": [ # Substages of an operation or a stage.

3877

# Object with schema name: OperationProgress

3878

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3879

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3880

"targetLink": "A String", # Server-defined URL for the target of the operation.

3881

"status": "A String", # The current status of the operation.

3882

"operationType": "A String", # The operation type.

3883

"startTime": "A String", # [Output only] The time the operation started, in

3884

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3885

"clusterConditions": [ # Which conditions caused the current cluster state.

3886

{ # StatusCondition describes why a cluster or a node pool has a certain status

3887

# (e.g., ERROR or DEGRADED).

3888

"message": "A String", # Human-friendly representation of the condition

3889

"code": "A String", # Machine-friendly representation of the condition

3890

},

3891

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3892

"zone": "A String", # The name of the Google Compute Engine

3893

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3894

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3895

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3896

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3897

"detail": "A String", # Detailed operation progress, if available.

3898

"endTime": "A String", # [Output only] The time the operation completed, in

3899

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3900

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3901

{ # StatusCondition describes why a cluster or a node pool has a certain status

3902

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3903

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3904

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3905

},

3906

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3907

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3908

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3909

# or

3910

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3911

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3912

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3917

<code class="details" id="setMaintenancePolicy">setMaintenancePolicy(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3918

<pre>Sets the maintenance policy for a cluster.

3919

3920

Args:

3921

name: string, The name (project, location, cluster id) of the cluster to set maintenance

3922

policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3923

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3924

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3925

The object takes the form of:

3926

3927

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3928

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance

3929

# policy.

3930

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3931

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Required. The maintenance policy to be set for the cluster. An empty field

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3932

# clears the existing maintenance policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3933

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3934

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

3935

# occur in these windows.

3936

"a_key": { # Represents an arbitrary window of time.

3937

"endTime": "A String", # The time that the window ends. The end time should take place after the

3938

# start time.

3939

"startTime": "A String", # The time that the window first starts.

3940

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3941

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3942

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

3943

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

3944

# smallest possible in the given scenario.

3945

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

3946

# format "PTnHnMnS".

3947

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

3948

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

3949

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

3950

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3951

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3952

# maintenance to occur. The time windows may be overlapping. If no

3953

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3954

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

3955

"endTime": "A String", # The time that the window ends. The end time should take place after the

3956

# start time.

3957

"startTime": "A String", # The time that the window first starts.

3958

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3959

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3960

# this window reccurs. They go on for the span of time between the start and

3961

# end time.

3962

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3963

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3964

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

3965

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

3966

# <code>FREQ=DAILY</code>

3967

# For the first weekend of every month:

3968

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

3969

# This specifies how frequently the window starts. Eg, if you wanted to have

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3970

# a 9-5 UTC-4 window every weekday, you'd use something like:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3971

# <code>

3972

# start time = 2019-01-01T09:00:00-0400

3973

# end time = 2019-01-01T17:00:00-0400

3974

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

3975

# </code>

3976

# Windows can span multiple days. Eg, to make the window encompass every

3977

# weekend from midnight Saturday till the last minute of Sunday UTC:

3978

# <code>

3979

# start time = 2019-01-05T00:00:00Z

3980

# end time = 2019-01-07T23:59:00Z

3981

# recurrence = FREQ=WEEKLY;BYDAY=SA

3982

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3983

# Note the start and end time's specific dates are largely arbitrary except

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3984

# to specify duration of the window and when it first starts.

3985

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3986

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3987

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3988

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

3989

# the policy won't accidentally undo intermediate changes (and so that users

3990

# of the API unaware of some fields won't accidentally remove other fields).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3991

# Make a <code>get()</code> request to the cluster to get the current

3992

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3993

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3994

"projectId": "A String", # Required. The Google Developers Console [project ID or project

3995

# number](https://support.google.com/cloud/answer/6158840).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3996

"clusterId": "A String", # Required. The name of the cluster to update.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3997

"zone": "A String", # Required. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3998

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3999

# cluster resides.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4000

}

4001

4002

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4009

4010

{ # This operation resource represents operations that may have happened or are

4011

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4012

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4013

"name": "A String", # A non-parameterized string describing an operation stage.

4014

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4015

"metrics": [ # Progress metric bundle, for example:

4016

# metrics: [{name: "nodes done", int_value: 15},

4017

# {name: "nodes total", int_value: 32}]

4018

# or

4019

# metrics: [{name: "progress", double_value: 0.56},

4020

# {name: "progress scale", double_value: 1.0}]

4021

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4022

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4023

"doubleValue": 3.14, # For metrics with floating point value.

4024

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4025

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4026

},

4027

],

4028

"status": "A String", # Status of an operation stage.

4029

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4030

"stages": [ # Substages of an operation or a stage.

4031

# Object with schema name: OperationProgress

4032

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4033

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4034

"targetLink": "A String", # Server-defined URL for the target of the operation.

4035

"status": "A String", # The current status of the operation.

4036

"operationType": "A String", # The operation type.

4037

"startTime": "A String", # [Output only] The time the operation started, in

4038

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4039

"clusterConditions": [ # Which conditions caused the current cluster state.

4040

{ # StatusCondition describes why a cluster or a node pool has a certain status

4041

# (e.g., ERROR or DEGRADED).

4042

"message": "A String", # Human-friendly representation of the condition

4043

"code": "A String", # Machine-friendly representation of the condition

4044

},

4045

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4046

"zone": "A String", # The name of the Google Compute Engine

4047

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4048

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4049

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4050

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4051

"detail": "A String", # Detailed operation progress, if available.

4052

"endTime": "A String", # [Output only] The time the operation completed, in

4053

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4054

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4055

{ # StatusCondition describes why a cluster or a node pool has a certain status

4056

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4057

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4058

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4059

},

4060

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4061

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4062

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4063

# or

4064

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4065

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4066

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4071

<code class="details" id="setMasterAuth">setMasterAuth(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4072

<pre>Sets master auth materials. Currently supports changing the admin password

4073

or a specific cluster, either via password generation or explicitly setting

the password.

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4078

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4079

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4080

The object takes the form of:

4081

4082

{ # SetMasterAuthRequest updates the admin password of a cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4083

"zone": "A String", # Deprecated. The name of the Google Compute Engine

4084

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4085

# cluster resides. This field has been deprecated and replaced by the name

4086

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4087

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4088

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4089

"update": { # The authentication information for accessing the master endpoint. # Required. A description of the update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4090

# Authentication can be done using HTTP basic auth or using client

4091

# certificates.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4092

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

4093

# to the cluster endpoint.

4094

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

4095

# authenticate to the cluster endpoint.

4096

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

4097

# For clusters v1.6.0 and later, basic authentication can be disabled by

4098

# leaving username unspecified (or setting it to the empty string).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4099

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4100

# Because the master endpoint is open to the Internet, you should create a

4101

# strong password. If a password is provided for cluster creation, username

4102

# must be non-empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4103

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4104

# clusters before v1.12, if no configuration is specified, a client

4105

# certificate is issued.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4106

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4107

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4108

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

4109

# trust for the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4110

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4111

"name": "A String", # The name (project, location, cluster) of the cluster to set auth.

4112

# Specified in the format `projects/*/locations/*/clusters/*`.

4113

"action": "A String", # Required. The exact form of action to be taken on the master auth.

4114

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4115

# number](https://support.google.com/cloud/answer/6158840).

4116

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4117

}

4118

4119

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4126

4127

{ # This operation resource represents operations that may have happened or are

4128

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4129

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4130

"name": "A String", # A non-parameterized string describing an operation stage.

4131

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4132

"metrics": [ # Progress metric bundle, for example:

4133

# metrics: [{name: "nodes done", int_value: 15},

4134

# {name: "nodes total", int_value: 32}]

4135

# or

4136

# metrics: [{name: "progress", double_value: 0.56},

4137

# {name: "progress scale", double_value: 1.0}]

4138

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4139

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4140

"doubleValue": 3.14, # For metrics with floating point value.

4141

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4142

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4143

},

4144

],

4145

"status": "A String", # Status of an operation stage.

4146

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4147

"stages": [ # Substages of an operation or a stage.

4148

# Object with schema name: OperationProgress

4149

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4150

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4151

"targetLink": "A String", # Server-defined URL for the target of the operation.

4152

"status": "A String", # The current status of the operation.

4153

"operationType": "A String", # The operation type.

4154

"startTime": "A String", # [Output only] The time the operation started, in

4155

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4156

"clusterConditions": [ # Which conditions caused the current cluster state.

4157

{ # StatusCondition describes why a cluster or a node pool has a certain status

4158

# (e.g., ERROR or DEGRADED).

4159

"message": "A String", # Human-friendly representation of the condition

4160

"code": "A String", # Machine-friendly representation of the condition

4161

},

4162

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4163

"zone": "A String", # The name of the Google Compute Engine

4164

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4165

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4166

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4167

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4168

"detail": "A String", # Detailed operation progress, if available.

4169

"endTime": "A String", # [Output only] The time the operation completed, in

4170

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4171

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4172

{ # StatusCondition describes why a cluster or a node pool has a certain status

4173

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4174

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4175

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4176

},

4177

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4178

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4179

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4180

# or

4181

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4182

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4183

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4188

<code class="details" id="setMonitoring">setMonitoring(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4189

<pre>Sets the monitoring service for a specific cluster.

4190

4191

Args:

4192

name: string, The name (project, location, cluster) of the cluster to set monitoring.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4193

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4194

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4195

The object takes the form of:

4196

4197

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4198

"monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4199

# Currently available options:

4200

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4201

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4202

# service with a Kubernetes-native resource model

4203

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4204

# longer available as of GKE 1.15).

4205

# * `none` - No metrics will be exported from the cluster.

4206

#

4207

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4208

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4209

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4210

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4211

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4212

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4213

# cluster resides. This field has been deprecated and replaced by the name

4214

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4215

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4216

# number](https://support.google.com/cloud/answer/6158840).

4217

# This field has been deprecated and replaced by the name field.

4218

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring.

4219

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4220

}

4221

4222

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4229

4230

{ # This operation resource represents operations that may have happened or are

4231

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4232

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4233

"name": "A String", # A non-parameterized string describing an operation stage.

4234

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4235

"metrics": [ # Progress metric bundle, for example:

4236

# metrics: [{name: "nodes done", int_value: 15},

4237

# {name: "nodes total", int_value: 32}]

4238

# or

4239

# metrics: [{name: "progress", double_value: 0.56},

4240

# {name: "progress scale", double_value: 1.0}]

4241

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4242

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4243

"doubleValue": 3.14, # For metrics with floating point value.

4244

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4245

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4246

},

4247

],

4248

"status": "A String", # Status of an operation stage.

4249

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4250

"stages": [ # Substages of an operation or a stage.

4251

# Object with schema name: OperationProgress

4252

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4253

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4254

"targetLink": "A String", # Server-defined URL for the target of the operation.

4255

"status": "A String", # The current status of the operation.

4256

"operationType": "A String", # The operation type.

4257

"startTime": "A String", # [Output only] The time the operation started, in

4258

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4259

"clusterConditions": [ # Which conditions caused the current cluster state.

4260

{ # StatusCondition describes why a cluster or a node pool has a certain status

4261

# (e.g., ERROR or DEGRADED).

4262

"message": "A String", # Human-friendly representation of the condition

4263

"code": "A String", # Machine-friendly representation of the condition

4264

},

4265

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4266

"zone": "A String", # The name of the Google Compute Engine

4267

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4268

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4269

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4270

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4271

"detail": "A String", # Detailed operation progress, if available.

4272

"endTime": "A String", # [Output only] The time the operation completed, in

4273

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4274

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4275

{ # StatusCondition describes why a cluster or a node pool has a certain status

4276

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4277

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4278

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4279

},

4280

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4281

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4282

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4283

# or

4284

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4285

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4286

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4291

<code class="details" id="setNetworkPolicy">setNetworkPolicy(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4292

<pre>Enables or disables Network Policy for a cluster.

4293

4294

Args:

4295

name: string, The name (project, location, cluster id) of the cluster to set networking

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4296

policy. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4297

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4298

The object takes the form of:

4299

4300

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4301

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking

4302

# policy. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4303

"clusterId": "A String", # Deprecated. The name of the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4304

# This field has been deprecated and replaced by the name field.

4305

"zone": "A String", # Deprecated. The name of the Google Compute Engine

4306

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4307

# cluster resides. This field has been deprecated and replaced by the name

4308

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4309

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature.

4310

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

4311

"enabled": True or False, # Whether network policy is enabled on the cluster.

4312

"provider": "A String", # The selected network policy provider.

4313

},

4314

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4315

# number](https://developers.google.com/console/help/new/#projectnumber).

4316

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4317

}

4318

4319

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4326

4327

{ # This operation resource represents operations that may have happened or are

4328

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4329

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4330

"name": "A String", # A non-parameterized string describing an operation stage.

4331

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4332

"metrics": [ # Progress metric bundle, for example:

4333

# metrics: [{name: "nodes done", int_value: 15},

4334

# {name: "nodes total", int_value: 32}]

4335

# or

4336

# metrics: [{name: "progress", double_value: 0.56},

4337

# {name: "progress scale", double_value: 1.0}]

4338

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4339

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4340

"doubleValue": 3.14, # For metrics with floating point value.

4341

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4342

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4343

},

4344

],

4345

"status": "A String", # Status of an operation stage.

4346

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4347

"stages": [ # Substages of an operation or a stage.

4348

# Object with schema name: OperationProgress

4349

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4350

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4351

"targetLink": "A String", # Server-defined URL for the target of the operation.

4352

"status": "A String", # The current status of the operation.

4353

"operationType": "A String", # The operation type.

4354

"startTime": "A String", # [Output only] The time the operation started, in

4355

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4356

"clusterConditions": [ # Which conditions caused the current cluster state.

4357

{ # StatusCondition describes why a cluster or a node pool has a certain status

4358

# (e.g., ERROR or DEGRADED).

4359

"message": "A String", # Human-friendly representation of the condition

4360

"code": "A String", # Machine-friendly representation of the condition

4361

},

4362

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4363

"zone": "A String", # The name of the Google Compute Engine

4364

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4365

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4366

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4367

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4368

"detail": "A String", # Detailed operation progress, if available.

4369

"endTime": "A String", # [Output only] The time the operation completed, in

4370

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4371

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4372

{ # StatusCondition describes why a cluster or a node pool has a certain status

4373

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4374

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4375

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4376

},

4377

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4378

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4379

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4380

# or

4381

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4382

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4383

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4388

<code class="details" id="setResourceLabels">setResourceLabels(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4389

<pre>Sets labels on a cluster.

4390

4391

Args:

4392

name: string, The name (project, location, cluster id) of the cluster to set labels.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4393

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4394

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4395

The object takes the form of:

4396

4397

{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container

4398

# Engine cluster, which will in turn set them for Google Compute Engine

4399

# resources used by that cluster

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4400

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels.

4401

# Specified in the format `projects/*/locations/*/clusters/*`.

4402

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4403

# number](https://developers.google.com/console/help/new/#projectnumber).

4404

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4405

"clusterId": "A String", # Deprecated. The name of the cluster.

4406

# This field has been deprecated and replaced by the name field.

4407

"labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4408

# used to detect conflicts. The fingerprint is initially generated by

4409

# Kubernetes Engine and changes after every request to modify or update

4410

# labels. You must always provide an up-to-date fingerprint hash when

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4411

# updating or changing labels. Make a <code>get()</code> request to the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4412

# resource to get the latest fingerprint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4413

"zone": "A String", # Deprecated. The name of the Google Compute Engine

4414

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4415

# cluster resides. This field has been deprecated and replaced by the name

4416

# field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4417

"resourceLabels": { # Required. The labels to set for that cluster.

4418

"a_key": "A String",

4419

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4420

}

4421

4422

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4429

4430

{ # This operation resource represents operations that may have happened or are

4431

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4432

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4433

"name": "A String", # A non-parameterized string describing an operation stage.

4434

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4435

"metrics": [ # Progress metric bundle, for example:

4436

# metrics: [{name: "nodes done", int_value: 15},

4437

# {name: "nodes total", int_value: 32}]

4438

# or

4439

# metrics: [{name: "progress", double_value: 0.56},

4440

# {name: "progress scale", double_value: 1.0}]

4441

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4442

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4443

"doubleValue": 3.14, # For metrics with floating point value.

4444

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4445

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4446

},

4447

],

4448

"status": "A String", # Status of an operation stage.

4449

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4450

"stages": [ # Substages of an operation or a stage.

4451

# Object with schema name: OperationProgress

4452

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4453

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4454

"targetLink": "A String", # Server-defined URL for the target of the operation.

4455

"status": "A String", # The current status of the operation.

4456

"operationType": "A String", # The operation type.

4457

"startTime": "A String", # [Output only] The time the operation started, in

4458

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4459

"clusterConditions": [ # Which conditions caused the current cluster state.

4460

{ # StatusCondition describes why a cluster or a node pool has a certain status

4461

# (e.g., ERROR or DEGRADED).

4462

"message": "A String", # Human-friendly representation of the condition

4463

"code": "A String", # Machine-friendly representation of the condition

4464

},

4465

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4466

"zone": "A String", # The name of the Google Compute Engine

4467

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4468

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4469

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4470

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4471

"detail": "A String", # Detailed operation progress, if available.

4472

"endTime": "A String", # [Output only] The time the operation completed, in

4473

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4474

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4475

{ # StatusCondition describes why a cluster or a node pool has a certain status

4476

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4477

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4478

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4479

},

4480

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4481

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4482

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4483

# or

4484

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4485

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4486

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4491

<code class="details" id="startIpRotation">startIpRotation(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4492

<pre>Starts master IP rotation.

4493

4494

Args:

4495

name: string, The name (project, location, cluster id) of the cluster to start IP

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4496

rotation. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4497

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4498

The object takes the form of:

4499

4500

{ # StartIPRotationRequest creates a new IP for the cluster and then performs

4501

# a node upgrade on each node pool to point to the new IP.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4502

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP

4503

# rotation. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4504

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4505

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4506

# cluster resides. This field has been deprecated and replaced by the name

4507

# field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4508

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4509

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4510

# number](https://developers.google.com/console/help/new/#projectnumber).

4511

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4512

"clusterId": "A String", # Deprecated. The name of the cluster.

4513

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4514

}

4515

4516

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4523

4524

{ # This operation resource represents operations that may have happened or are

4525

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4526

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4527

"name": "A String", # A non-parameterized string describing an operation stage.

4528

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4529

"metrics": [ # Progress metric bundle, for example:

4530

# metrics: [{name: "nodes done", int_value: 15},

4531

# {name: "nodes total", int_value: 32}]

4532

# or

4533

# metrics: [{name: "progress", double_value: 0.56},

4534

# {name: "progress scale", double_value: 1.0}]

4535

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4536

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4537

"doubleValue": 3.14, # For metrics with floating point value.

4538

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4539

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4540

},

4541

],

4542

"status": "A String", # Status of an operation stage.

4543

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4544

"stages": [ # Substages of an operation or a stage.

4545

# Object with schema name: OperationProgress

4546

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4547

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4548

"targetLink": "A String", # Server-defined URL for the target of the operation.

4549

"status": "A String", # The current status of the operation.

4550

"operationType": "A String", # The operation type.

4551

"startTime": "A String", # [Output only] The time the operation started, in

4552

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4553

"clusterConditions": [ # Which conditions caused the current cluster state.

4554

{ # StatusCondition describes why a cluster or a node pool has a certain status

4555

# (e.g., ERROR or DEGRADED).

4556

"message": "A String", # Human-friendly representation of the condition

4557

"code": "A String", # Machine-friendly representation of the condition

4558

},

4559

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4560

"zone": "A String", # The name of the Google Compute Engine

4561

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4562

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4563

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4564

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4565

"detail": "A String", # Detailed operation progress, if available.

4566

"endTime": "A String", # [Output only] The time the operation completed, in

4567

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4568

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4569

{ # StatusCondition describes why a cluster or a node pool has a certain status

4570

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4571

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4572

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4573

},

4574

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4575

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4576

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4577

# or

4578

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4579

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4580

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4585

<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4586

<pre>Updates the settings of a specific cluster.

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4590

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4591

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4592

The object takes the form of:

4593

4594

{ # UpdateClusterRequest updates the settings of a cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4595

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

4596

# This field has been deprecated and replaced by the name field.

4597

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4598

# number](https://support.google.com/cloud/answer/6158840).

4599

# This field has been deprecated and replaced by the name field.

4600

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4601

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4602

"update": { # ClusterUpdate describes an update to the cluster. Exactly one update can # Required. A description of the update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4603

# be applied to a cluster with each request, so at most one field can be

4604

# provided.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4605

"desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an

4606

# upgrade).

4607

#

4608

# Users may specify either explicit versions offered by

4609

# Kubernetes Engine or version aliases, which have the following behavior:

4610

#

4611

# - "latest": picks the highest valid Kubernetes version

4612

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4613

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4614

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4615

# - "-": picks the Kubernetes master version

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4616

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity.

4617

# policies.

4618

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

4619

},

4620

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

4621

# required by Vertical Pod Autoscaler to automatically adjust

4622

# the resources of pods controlled by it.

4623

"enabled": True or False, # Enables vertical pod autoscaling.

4624

},

4625

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

4626

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

4627

# daemonset will be created in the cluster to meter network egress traffic.

4628

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

4629

"datasetId": "A String", # The ID of a BigQuery Dataset.

4630

},

4631

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

4632

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

4633

# second BigQuery table will be created to hold resource consumption

# records.

},

},

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to.

4638

#

4639

# Users may specify either explicit versions offered by

4640

# Kubernetes Engine or version aliases, which have the following behavior:

4641

#

4642

# - "latest": picks the highest valid Kubernetes version

4643

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4644

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4645

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4646

# - "-": picks the default Kubernetes version

4647

"desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics.

4648

# Currently available options:

4649

#

4650

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

4651

# service with a Kubernetes-native resource model

4652

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4653

# longer available as of GKE 1.15).

4654

# * `none` - No metrics will be exported from the cluster.

4655

#

4656

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4657

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

4658

"desiredLoggingService": "A String", # The logging service the cluster should use to write logs.

4659

# Currently available options:

4660

#

4661

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

4662

# service with a Kubernetes-native resource model

4663

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

4664

# available as of GKE 1.15).

4665

# * `none` - no logs will be exported from the cluster.

4666

#

4667

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

4668

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

4669

"desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

4670

# cluster, enabling additional functionality.

4671

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

4672

# This addon is deprecated, and will be disabled in 1.15. It is recommended

4673

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

4674

# workloads and applications. For more information, see:

4675

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

4676

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

4677

},

4678

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

4679

# managed Knative service.

4680

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

4681

},

4682

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

4683

# makes it easy to set up HTTP load balancers for services in a cluster.

4684

# which makes it easy to set up HTTP load balancers for services in a cluster.

4685

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

4686

# When enabled, it runs a small pod in the cluster that manages the load

4687

# balancers.

4688

},

4689

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

4690

# increases or decreases the number of replica pods a replication controller

4691

# has based on the resource usage of the existing pods.

4692

# increases or decreases the number of replica pods a replication controller

4693

# has based on the resource usage of the existing pods.

4694

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

4695

# When enabled, it ensures that metrics are collected into Stackdriver

4696

# Monitoring.

4697

},

4698

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

4699

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

4700

},

4701

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

4702

# is enabled or not on the Master, it does not track whether network policy

4703

# is enabled for the nodes.

4704

# is enabled or not on the Master, it does not track whether network policy

4705

# is enabled for the nodes.

4706

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

4707

},

4708

},

4709

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in

4710

# desired_node_pool_id. If there is only one pool in the

4711

# cluster and desired_node_pool_id is not provided then

4712

# the change applies to that single node pool.

4713

# adjust the size of the node pool to the current cluster usage.

4714

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

4715

# max_node_count.

4716

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

4717

# has to enough quota to scale up the cluster.

4718

"enabled": True or False, # Is autoscaling enabled for this node pool.

4719

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

4720

},

4721

"desiredLocations": [ # The desired list of Google Compute Engine

4722

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4723

# cluster's nodes should be located. Changing the locations a cluster is in

4724

# will result in nodes being either created or removed from the cluster,

4725

# depending on whether locations are being added or removed.

4726

#

4727

# This list must always include the cluster's primary zone.

4728

"A String",

4729

],

4730

"desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature.

4731

# master authorized networks will disallow all external traffic to access

4732

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

4733

# Google Compute Engine Public IPs and Google Prod IPs.

4734

"enabled": True or False, # Whether or not master authorized networks is enabled.

4735

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

4736

# Kubernetes master through HTTPS.

4737

{ # CidrBlock contains an optional name and one CIDR block.

4738

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

4739

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

4740

},

4741

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4742

},

4743

"desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4744

# required by Cluster Autoscaler to automatically adjust

4745

# the size of the cluster and create/delete

4746

# node pools based on the current needs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4747

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

4748

# amount of resources in the cluster.

4749

{ # Contains information about amount of some resource in the cluster.

4750

# For memory, value should be in GB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4751

"minimum": "A String", # Minimum amount of the resource in the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4752

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4753

"maximum": "A String", # Maximum amount of the resource in the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4754

},

4755

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4756

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4757

# created by NAP.

4758

# by NAP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4759

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4760

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4761

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4762

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4763

# the Auto Upgrades will proceed.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4764

"description": "A String", # [Output only] This field is set when upgrades are about to commence

4765

# with the description of the upgrade.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4766

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4767

# with the approximate start time for the upgrades, in

4768

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4769

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4770

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

4771

# pool. If enabled, the nodes in this node pool will be monitored and, if

4772

# they fail health checks too many times, an automatic repair action will be

4773

# triggered.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4774

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

4775

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

4776

# up to date with the latest release version of Kubernetes.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4777

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4778

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4779

# disruption caused by an upgrade.

4780

#

4781

# maxUnavailable controls the number of nodes that can be simultaneously

4782

# unavailable.

4783

#

4784

# maxSurge controls the number of additional nodes that can be added to the

4785

# node pool temporarily for the time of the upgrade to increase the number of

4786

# available nodes.

4787

#

4788

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

4789

# nodes are being upgraded at the same time).

4790

#

4791

# Note: upgrades inevitably introduce some disruption since workloads need to

4792

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

4793

# this holds true. (Disruption stays within the limits of

4794

# PodDisruptionBudget, if it is configured.)

4795

#

4796

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

4797

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

4798

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

4799

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

4800

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4801

"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]

4802

# the upgrade process. A node is considered available if its status is

4803

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4804

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

4805

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4806

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4807

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

4808

"A String",

4809

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4810

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4811

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

4812

"autoprovisioningLocations": [ # The list of Google Compute Engine

4813

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4814

# NodePool's nodes can be created by NAP.

"A String",

],

},

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if

4819

# "desired_node_version", "desired_image_family" or

4820

# "desired_node_pool_autoscaling" is specified and there is more than one

4821

# node pool on the cluster.

4822

"desiredImageType": "A String", # The desired image type for the node pool.

4823

# NOTE: Set the "desired_node_pool" field as well.

4824

"desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is # The desired release channel configuration.

4825

# subscribed to. Release channels are arranged in order of risk.

4826

#

4827

# When a cluster is subscribed to a release channel, Google maintains

4828

# both the master version and the node version. Node auto-upgrade

4829

# defaults to true and cannot be disabled.

4830

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

4831

},

4832

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility.

4833

# visibility on this cluster.

4834

"enabled": True or False, # Enables intra node visibility for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4835

},

4836

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4837

"state": "A String", # Denotes the state of etcd encryption.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4838

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

4839

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4840

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4841

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

4842

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4843

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4844

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

4845

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

4846

# images will be validated by Binary Authorization.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4847

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4848

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4849

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4850

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4851

# cluster resides. This field has been deprecated and replaced by the name

4852

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4853

}

4854

4855

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4862

4863

{ # This operation resource represents operations that may have happened or are

4864

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4865

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4866

"name": "A String", # A non-parameterized string describing an operation stage.

4867

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4868

"metrics": [ # Progress metric bundle, for example:

4869

# metrics: [{name: "nodes done", int_value: 15},

4870

# {name: "nodes total", int_value: 32}]

4871

# or

4872

# metrics: [{name: "progress", double_value: 0.56},

4873

# {name: "progress scale", double_value: 1.0}]

4874

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4875

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4876

"doubleValue": 3.14, # For metrics with floating point value.

4877

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4878

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4879

},

4880

],

4881

"status": "A String", # Status of an operation stage.

4882

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4883

"stages": [ # Substages of an operation or a stage.

4884

# Object with schema name: OperationProgress

4885

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4886

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4887

"targetLink": "A String", # Server-defined URL for the target of the operation.

4888

"status": "A String", # The current status of the operation.

4889

"operationType": "A String", # The operation type.

4890

"startTime": "A String", # [Output only] The time the operation started, in

4891

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4892

"clusterConditions": [ # Which conditions caused the current cluster state.

4893

{ # StatusCondition describes why a cluster or a node pool has a certain status

4894

# (e.g., ERROR or DEGRADED).

4895

"message": "A String", # Human-friendly representation of the condition

4896

"code": "A String", # Machine-friendly representation of the condition

4897

},

4898

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4899

"zone": "A String", # The name of the Google Compute Engine

4900

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4901

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4902

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4903

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4904

"detail": "A String", # Detailed operation progress, if available.

4905

"endTime": "A String", # [Output only] The time the operation completed, in

4906

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4907

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4908

{ # StatusCondition describes why a cluster or a node pool has a certain status

4909

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4910

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4911

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4912

},

4913

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4914

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4915

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4916

# or

4917

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4918

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4919

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4924

<code class="details" id="updateMaster">updateMaster(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4925

<pre>Updates the master for a specific cluster.

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4929

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4930

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4931

The object takes the form of:

4932

4933

{ # UpdateMasterRequest updates the master of the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4934

"masterVersion": "A String", # Required. The Kubernetes version to change the master to.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4935

#

4936

# Users may specify either explicit versions offered by Kubernetes Engine or

4937

# version aliases, which have the following behavior:

4938

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4939

# - "latest": picks the highest valid Kubernetes version

4940

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4941

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4942

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4943

# - "-": picks the default Kubernetes version

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4944

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4945

# number](https://support.google.com/cloud/answer/6158840).

4946

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4947

"zone": "A String", # Deprecated. The name of the Google Compute Engine

4948

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4949

# cluster resides. This field has been deprecated and replaced by the name

4950

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4951

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4952

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4953

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4954

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4955

}

4956

4957

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4964

4965

{ # This operation resource represents operations that may have happened or are

4966

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4967

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4968

"name": "A String", # A non-parameterized string describing an operation stage.

4969

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4970

"metrics": [ # Progress metric bundle, for example:

4971

# metrics: [{name: "nodes done", int_value: 15},

4972

# {name: "nodes total", int_value: 32}]

4973

# or

4974

# metrics: [{name: "progress", double_value: 0.56},

4975

# {name: "progress scale", double_value: 1.0}]

4976

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4977

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4978

"doubleValue": 3.14, # For metrics with floating point value.

4979

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4980

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4981

},

4982

],

4983

"status": "A String", # Status of an operation stage.

4984

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4985

"stages": [ # Substages of an operation or a stage.

4986

# Object with schema name: OperationProgress

4987

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4988

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4989

"targetLink": "A String", # Server-defined URL for the target of the operation.

4990

"status": "A String", # The current status of the operation.

4991

"operationType": "A String", # The operation type.

4992

"startTime": "A String", # [Output only] The time the operation started, in

4993

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4994

"clusterConditions": [ # Which conditions caused the current cluster state.

4995

{ # StatusCondition describes why a cluster or a node pool has a certain status

4996

# (e.g., ERROR or DEGRADED).

4997

"message": "A String", # Human-friendly representation of the condition

4998

"code": "A String", # Machine-friendly representation of the condition

4999

},

5000

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5001

"zone": "A String", # The name of the Google Compute Engine

5002

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5003

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5004

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5005

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5006

"detail": "A String", # Detailed operation progress, if available.

5007

"endTime": "A String", # [Output only] The time the operation completed, in

5008

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5009

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5010

{ # StatusCondition describes why a cluster or a node pool has a certain status

5011

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5012

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5013

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5014

},

5015

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5016

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5017

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5018

# or

5019

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5020

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5021

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim