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-05-20 12:08:20 -0700

[diff] [blame]

94

<code><a href="#delete">delete(name, projectId=None, zone=None, clusterId=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-05-20 12:08:20 -0700

[diff] [blame]

97

<code><a href="#get">get(name, projectId=None, zone=None, clusterId=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-05-20 12:08:20 -0700

[diff] [blame]

103

<code><a href="#list">list(parent, projectId=None, zone=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/*`.

155

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

Bu Sun Kim

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

[diff] [blame]

156

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

157

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

Bu Sun Kim

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

[diff] [blame]

158

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

Dan O'Meara

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

[diff] [blame]

159

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

160

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

161

# field.

Bu Sun Kim

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

[diff] [blame]

162

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

163

# This field has been deprecated and replaced by the name 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-20 12:08:20 -0700

[diff] [blame]

176

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

177

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

Bu Sun Kim

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

[diff] [blame]

178

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

179

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

Bu Sun Kim

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

[diff] [blame]

180

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

181

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

Bu Sun Kim

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

[diff] [blame]

182

},

183

],

Bu Sun Kim

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

[diff] [blame]

184

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

Dan O'Meara

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

[diff] [blame]

185

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

Bu Sun Kim

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

[diff] [blame]

186

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

Dan O'Meara

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

[diff] [blame]

187

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

188

# or

189

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

190

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

191

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

192

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

193

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

194

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

195

# Object with schema name: OperationProgress

196

],

197

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

198

# Unset for single-stage operations.

199

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

200

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

201

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

202

# or

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

},

211

],

212

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

213

# Unset for single-stage operations.

214

},

215

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

216

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

217

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

218

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

219

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

220

},

221

],

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

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-05-20 12:08:20 -0700

[diff] [blame]

258

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

Bu Sun Kim

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

[diff] [blame]

259

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

260

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

Bu Sun Kim

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

[diff] [blame]

261

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

Dan O'Meara

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

[diff] [blame]

262

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

Bu Sun Kim

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

[diff] [blame]

263

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

264

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

265

# if cluster created with IP Alias support.

266

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

267

},

268

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

269

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

270

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

271

# network will be used.

272

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

273

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

274

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

275

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

276

# mode.

Bu Sun Kim

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

[diff] [blame]

277

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

278

# master authorized networks will disallow all external traffic to access

279

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

280

# Google Compute Engine Public IPs and Google Prod IPs.

281

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

282

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

283

# Kubernetes master through HTTPS.

284

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

285

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

286

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

},

],

},

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

291

# cluster, if available.

292

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

293

# If unspecified, the defaults are used:

294

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

295

# be set to "admin", a random password will be generated, and a client

296

# certificate will be issued.

297

# Authentication can be done using HTTP basic auth or using client

298

# certificates.

299

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

300

# trust for the cluster.

301

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

302

# authenticate to the cluster endpoint.

303

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

304

# For clusters v1.6.0 and later, basic authentication can be disabled by

305

# leaving username unspecified (or setting it to the empty string).

306

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

307

# Because the master endpoint is open to the Internet, you should create a

308

# strong password. If a password is provided for cluster creation, username

309

# must be non-empty.

310

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

311

# clusters before v1.12, if no configuration is specified, a client

312

# certificate is issued.

313

"issueClientCertificate": True or False, # Issue a client certificate.

314

},

315

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

316

# to the cluster endpoint.

317

},

318

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

319

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

320

# during authentication using a group of security groups.

321

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

322

# if enabled = true.

323

},

324

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

325

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

326

# cluster, enabling additional functionality.

327

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

328

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

329

# is enabled for the nodes.

330

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

331

# is enabled for the nodes.

332

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

333

},

334

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

335

# managed Knative service.

336

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

337

},

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

# Monitoring.

346

},

347

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

348

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

349

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

350

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

351

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

352

# balancers.

353

},

354

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

355

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

356

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

357

# workloads and applications. For more information, see:

358

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

359

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

360

},

361

},

362

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

363

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

364

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

365

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

366

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

367

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

368

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

369

# the cluster is connected.

370

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

371

# Google Compute Engine resources.

372

"a_key": "A String",

373

},

374

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

375

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

376

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

377

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

378

# smallest possible in the given scenario.

379

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

380

# format "PTnHnMnS".

381

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

382

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

383

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

384

},

385

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

386

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

387

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

Bu Sun Kim

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

[diff] [blame]

388

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

389

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

390

# end time.

391

#

Bu Sun Kim

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

[diff] [blame]

392

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

Dan O'Meara

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

[diff] [blame]

393

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

394

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

395

# <code>FREQ=DAILY</code>

396

# For the first weekend of every month:

397

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

398

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

399

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

400

# <code>

401

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

402

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

403

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

404

# </code>

405

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

406

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

407

# <code>

408

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

409

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

410

# recurrence = FREQ=WEEKLY;BYDAY=SA

411

# </code>

Bu Sun Kim

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

[diff] [blame]

412

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

413

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

414

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

Bu Sun Kim

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

[diff] [blame]

415

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

416

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

Dan O'Meara

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

[diff] [blame]

417

# start time.

Bu Sun Kim

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

[diff] [blame]

418

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

Dan O'Meara

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

[diff] [blame]

419

},

420

},

Bu Sun Kim

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

[diff] [blame]

421

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

Dan O'Meara

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

[diff] [blame]

422

# occur in these windows.

Bu Sun Kim

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

[diff] [blame]

423

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

424

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

Dan O'Meara

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

[diff] [blame]

425

# start time.

Bu Sun Kim

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

[diff] [blame]

426

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

Dan O'Meara

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

[diff] [blame]

427

},

428

},

Bu Sun Kim

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

[diff] [blame]

429

},

Bu Sun Kim

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

[diff] [blame]

430

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

431

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

432

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

433

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

434

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

Bu Sun Kim

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

[diff] [blame]

435

},

Bu Sun Kim

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

[diff] [blame]

436

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

437

# found in validMasterVersions returned by getServerConfig. The version can

438

# be upgraded over time; such upgrades are reflected in

439

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

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

[diff] [blame]

440

#

Bu Sun Kim

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

[diff] [blame]

441

# Users may specify either explicit versions offered by

442

# Kubernetes Engine or version aliases, which have the following behavior:

443

#

444

# - "latest": picks the highest valid Kubernetes version

445

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

446

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

447

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

448

# - "","-": picks the default Kubernetes version

449

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

450

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

451

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

452

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

Bu Sun Kim

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

[diff] [blame]

453

# will be automatically chosen with the default size.

454

#

455

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

456

#

457

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

458

#

459

# 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)

464

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

465

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

466

# to use.

Bu Sun Kim

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

[diff] [blame]

467

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

468

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

469

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

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

[diff] [blame]

470

#

471

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

Bu Sun Kim

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

[diff] [blame]

472

#

473

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

474

#

475

# 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)

480

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

481

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

482

# to use.

483

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

484

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

485

# addresses. This must be an existing secondary range associated

486

# with the cluster subnetwork.

487

#

488

# This field is only applicable with use_ip_aliases is true and

489

# create_subnetwork is false.

490

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

Bu Sun Kim

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

[diff] [blame]

491

#

492

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

493

#

494

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

495

#

496

# 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)

501

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

502

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

503

# to use.

Bu Sun Kim

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

[diff] [blame]

504

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

Bu Sun Kim

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

[diff] [blame]

505

# range will be automatically chosen with the default size.

506

#

507

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

508

#

509

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

510

#

511

# 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)

516

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

517

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

518

# to use.

Bu Sun Kim

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

[diff] [blame]

519

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

520

#

521

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

522

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

523

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

Bu Sun Kim

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

[diff] [blame]

524

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

525

# ClusterIPs. This must be an existing secondary range associated

526

# with the cluster subnetwork.

527

#

528

# This field is only applicable with use_ip_aliases is true and

529

# create_subnetwork is false.

Bu Sun Kim

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

[diff] [blame]

530

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

531

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

532

# subnetwork.

Bu Sun Kim

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

[diff] [blame]

533

},

Bu Sun Kim

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

[diff] [blame]

534

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

535

# mode.

536

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

537

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

538

# controllers, will have statically granted permissions beyond those

539

# provided by the RBAC configuration or IAM.

Dan O'Meara

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

[diff] [blame]

540

},

Bu Sun Kim

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

[diff] [blame]

541

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

Bu Sun Kim

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

[diff] [blame]

542

# disabled when this config is unspecified.

Bu Sun Kim

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

[diff] [blame]

543

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

Bu Sun Kim

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

[diff] [blame]

544

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

Bu Sun Kim

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

[diff] [blame]

545

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

546

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

Bu Sun Kim

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

[diff] [blame]

547

# second BigQuery table will be created to hold resource consumption

548

# records.

549

},

Bu Sun Kim

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

[diff] [blame]

550

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

551

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

Bu Sun Kim

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

[diff] [blame]

552

},

Bu Sun Kim

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

[diff] [blame]

553

},

554

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

555

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

556

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

557

# cluster's nodes should be located.

558

"A String",

Bu Sun Kim

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

[diff] [blame]

559

],

Bu Sun Kim

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

[diff] [blame]

560

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

561

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

Bu Sun Kim

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

[diff] [blame]

562

# specified.

Bu Sun Kim

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

[diff] [blame]

563

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

564

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

Bu Sun Kim

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

[diff] [blame]

565

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

566

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

567

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

568

# the workload.

Bu Sun Kim

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

[diff] [blame]

569

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

570

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

571

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

572

# firewall and routes quota.

573

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

Dan O'Meara

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

[diff] [blame]

574

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

Bu Sun Kim

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

[diff] [blame]

575

# NodePool's nodes should be located.

576

"A String",

Dan O'Meara

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

[diff] [blame]

577

],

Bu Sun Kim

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

[diff] [blame]

578

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

579

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

Dan O'Meara

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

[diff] [blame]

580

# disruption caused by an upgrade.

581

#

582

# maxUnavailable controls the number of nodes that can be simultaneously

583

# unavailable.

584

#

585

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

586

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

587

# available nodes.

588

#

589

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

590

# nodes are being upgraded at the same time).

591

#

592

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

593

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

594

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

595

# PodDisruptionBudget, if it is configured.)

596

#

597

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

598

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

599

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

600

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

601

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame]

602

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

603

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

604

# Ready.

Bu Sun Kim

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

[diff] [blame]

605

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

606

# of the node pool during the upgrade process.

Dan O'Meara

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

[diff] [blame]

607

},

Bu Sun Kim

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

[diff] [blame]

608

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

609

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

610

# associated with this node pool.

611

"A String",

612

],

613

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

614

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

615

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

616

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

617

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

618

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

619

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

Dan O'Meara

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

[diff] [blame]

620

},

Bu Sun Kim

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

[diff] [blame]

621

],

622

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

623

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

624

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

Bu Sun Kim

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

[diff] [blame]

625

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

626

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

627

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame]

628

"A String",

Bu Sun Kim

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

[diff] [blame]

629

],

Bu Sun Kim

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

[diff] [blame]

630

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

Dan O'Meara

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

[diff] [blame]

631

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

Bu Sun Kim

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

[diff] [blame]

632

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

633

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

634

# the latest version of it will be used.

635

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

636

# node VMs under the "default" service account.

Bu Sun Kim

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

[diff] [blame]

637

#

638

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

639

# not included:

640

#

641

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

642

# persistent storage on your nodes.

643

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

644

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

645

# (the [Google Container

646

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

Bu Sun Kim

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

[diff] [blame]

647

#

648

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

649

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

Bu Sun Kim

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

[diff] [blame]

650

"A String",

Bu Sun Kim

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

[diff] [blame]

651

],

Bu Sun Kim

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

[diff] [blame]

652

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

Dan O'Meara

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

[diff] [blame]

653

#

654

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

655

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

656

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

657

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

658

#

Bu Sun Kim

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

[diff] [blame]

659

# See

660

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

661

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

662

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

663

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

664

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

Dan O'Meara

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

[diff] [blame]

665

},

666

],

Bu Sun Kim

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

[diff] [blame]

667

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

668

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

669

# Kubernetes may apply to the node.

670

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

671

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

672

# and conflicts should be avoided.

673

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

674

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

675

"a_key": "A String",

676

},

677

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

678

# The smallest allowed disk size is 10GB.

679

#

680

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

681

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

682

# workloads on the node pool.

683

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

684

# on the node pool.

685

},

686

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

687

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

688

# support for GPUs.

689

{ # AcceleratorConfig represents a Hardware Accelerator request.

690

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

691

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

692

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

693

},

694

],

695

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

696

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

697

# `n1-standard-1`).

698

#

699

# If unspecified, the default machine type is

700

# `n1-standard-1`.

701

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

702

#

703

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

704

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

705

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

706

#

707

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

708

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

709

# boot process if signature verification fails.

710

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

711

#

712

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

713

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

714

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

715

# the instance is created.

716

},

717

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

718

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

719

# friendly names of CPU platforms, such as

720

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

721

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

722

# information, read [how to specify min CPU

723

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

724

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

725

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

726

# information about preemptible VM instances.

727

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

Bu Sun Kim

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

[diff] [blame]

728

#

Dan O'Meara

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

[diff] [blame]

729

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

Bu Sun Kim

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

[diff] [blame]

730

# disks available on a machine per zone. See:

Dan O'Meara

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

[diff] [blame]

731

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

Bu Sun Kim

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

[diff] [blame]

732

# for more information.

Bu Sun Kim

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

[diff] [blame]

733

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

734

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

Bu Sun Kim

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

[diff] [blame]

735

},

Bu Sun Kim

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

[diff] [blame]

736

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

737

#

738

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

739

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

740

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

741

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

747

# "enable-os-login"

748

# "gci-ensure-gke-docker"

749

# "gci-metrics-enabled"

750

# "gci-update-strategy"

751

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

756

# "windows-startup-script-ps1"

757

# "common-psm1"

758

# "k8s-node-setup-psm1"

759

# "install-ssh-psm1"

760

# "user-profile-psm1"

761

# "serial-port-logging-enable"

762

#

763

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

764

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

765

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

766

#

767

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

768

"a_key": "A String",

769

},

770

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

771

# the specified [Zonal Compute

772

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

773

# to this node pool.

774

# is the configuration of desired reservation which instances could take

775

# capacity from.

776

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

777

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

778

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

779

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

780

"A String",

781

],

782

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

783

},

784

},

785

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

786

# simultaneously on a node in the node pool.

787

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

788

},

789

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

790

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

791

# node pool.

792

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

793

# the Auto Upgrades will proceed.

794

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

795

# with the description of the upgrade.

796

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

797

# with the approximate start time for the upgrades, in

798

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

799

},

800

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

801

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

802

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

803

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

804

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

805

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

806

# triggered.

807

},

808

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

Dan O'Meara

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

[diff] [blame]

809

# node pool instance, if available.

Bu Sun Kim

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

[diff] [blame]

810

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

811

# only if a valid configuration is present.

812

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

813

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

814

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

815

# has to enough quota to scale up the cluster.

816

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

817

# max_node_count.

818

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

819

},

Bu Sun Kim

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

[diff] [blame]

820

},

821

],

Bu Sun Kim

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

[diff] [blame]

822

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

823

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

824

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

825

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

826

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

827

},

828

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

829

# this cluster, in

830

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

831

# notation (e.g. `1.2.3.4/29`). Service addresses are

832

# typically put in the last `/16` from the container CIDR.

833

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

834

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

835

# the kubernetes version of the master and nodes.

836

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

837

# Alpha enabled clusters are automatically deleted thirty days after

838

# creation.

839

"description": "A String", # An optional description of this cluster.

840

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

841

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

842

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

843

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

844

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

845

},

846

],

847

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

848

# Call Kubernetes API directly to retrieve node information.

849

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

Bu Sun Kim

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

[diff] [blame]

850

# Currently available options:

851

#

Bu Sun Kim

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

[diff] [blame]

852

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

Dan O'Meara

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

[diff] [blame]

853

# service with a Kubernetes-native resource model

854

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

855

# longer available as of GKE 1.15).

856

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

857

#

858

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

859

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

Bu Sun Kim

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

[diff] [blame]

860

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

861

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

862

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

863

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

Bu Sun Kim

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

[diff] [blame]

864

},

Bu Sun Kim

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

[diff] [blame]

865

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

866

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

867

# images will be validated by Binary Authorization.

868

},

869

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

870

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

871

# notation (e.g. `1.2.3.4/29`).

872

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

873

# policies.

874

# policies.

875

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

876

},

877

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

878

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

879

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

880

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

881

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

882

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

Bu Sun Kim

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

[diff] [blame]

883

# Currently available options:

884

#

Dan O'Meara

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

[diff] [blame]

885

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

886

# service with a Kubernetes-native resource model

887

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

888

# available as of GKE 1.15).

Bu Sun Kim

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

[diff] [blame]

889

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

Dan O'Meara

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

[diff] [blame]

890

#

891

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

892

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

Bu Sun Kim

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

[diff] [blame]

893

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

894

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

Bu Sun Kim

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

[diff] [blame]

895

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

896

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

897

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

898

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

899

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

900

# `node_pool.config`)

901

#

902

# If unspecified, the defaults are used.

903

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

Bu Sun Kim

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

[diff] [blame]

904

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

Bu Sun Kim

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

[diff] [blame]

905

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

906

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

907

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame]

908

"A String",

Bu Sun Kim

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

[diff] [blame]

909

],

Bu Sun Kim

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

[diff] [blame]

910

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

Dan O'Meara

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

[diff] [blame]

911

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

Bu Sun Kim

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

[diff] [blame]

912

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

913

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

914

# the latest version of it will be used.

915

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

916

# node VMs under the "default" service account.

Bu Sun Kim

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

[diff] [blame]

917

#

918

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

919

# not included:

920

#

921

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

922

# persistent storage on your nodes.

923

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

924

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

925

# (the [Google Container

926

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

Bu Sun Kim

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

[diff] [blame]

927

#

928

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

929

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

Bu Sun Kim

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

[diff] [blame]

930

"A String",

Bu Sun Kim

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

[diff] [blame]

931

],

Bu Sun Kim

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

[diff] [blame]

932

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

Dan O'Meara

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

[diff] [blame]

933

#

934

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

935

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

936

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

937

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

938

#

Bu Sun Kim

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

[diff] [blame]

939

# See

940

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

941

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

942

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

943

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

944

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

Dan O'Meara

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

[diff] [blame]

945

},

946

],

Bu Sun Kim

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

[diff] [blame]

947

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

948

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

949

# Kubernetes may apply to the node.

950

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

951

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

952

# and conflicts should be avoided.

953

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

954

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

955

"a_key": "A String",

956

},

957

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

958

# The smallest allowed disk size is 10GB.

959

#

960

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

961

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

962

# workloads on the node pool.

963

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

964

# on the node pool.

965

},

966

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

967

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

968

# support for GPUs.

969

{ # AcceleratorConfig represents a Hardware Accelerator request.

970

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

971

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

972

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

973

},

974

],

975

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

976

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

977

# `n1-standard-1`).

978

#

979

# If unspecified, the default machine type is

980

# `n1-standard-1`.

981

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

982

#

983

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

984

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

985

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

986

#

987

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

988

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

989

# boot process if signature verification fails.

990

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

991

#

992

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

993

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

994

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

995

# the instance is created.

996

},

997

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

998

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

999

# friendly names of CPU platforms, such as

1000

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

1001

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

1002

# information, read [how to specify min CPU

1003

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

1004

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

1005

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

1006

# information about preemptible VM instances.

1007

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

Bu Sun Kim

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

[diff] [blame]

1008

#

Dan O'Meara

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

[diff] [blame]

1009

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

Bu Sun Kim

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

[diff] [blame]

1010

# disks available on a machine per zone. See:

Dan O'Meara

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

[diff] [blame]

1011

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

Bu Sun Kim

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

[diff] [blame]

1012

# for more information.

Bu Sun Kim

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

[diff] [blame]

1013

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

1014

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

1015

},

1016

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

1017

#

1018

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

1019

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

1020

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

1021

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1027

# "enable-os-login"

1028

# "gci-ensure-gke-docker"

1029

# "gci-metrics-enabled"

1030

# "gci-update-strategy"

1031

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1036

# "windows-startup-script-ps1"

1037

# "common-psm1"

1038

# "k8s-node-setup-psm1"

1039

# "install-ssh-psm1"

1040

# "user-profile-psm1"

1041

# "serial-port-logging-enable"

1042

#

1043

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

1044

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

1045

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

1046

#

1047

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

1048

"a_key": "A String",

1049

},

1050

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

1051

# the specified [Zonal Compute

1052

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

1053

# to this node pool.

1054

# is the configuration of desired reservation which instances could take

1055

# capacity from.

1056

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

1057

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

1058

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

1059

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

1060

"A String",

1061

],

1062

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

1063

},

Bu Sun Kim

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

[diff] [blame]

1064

},

Bu Sun Kim

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

[diff] [blame]

1065

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

1066

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

1067

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

1068

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

1069

# cluster is connected. Example:

1070

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

1071

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

1072

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

1073

# to which the cluster is connected. Example:

1074

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

1075

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

1076

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

1077

},

1078

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

1079

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

1080

# the following restrictions:

1081

#

1082

# * Lowercase letters, numbers, and hyphens only.

1083

# * Must start with a letter.

1084

# * Must end with a number or a letter.

1085

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

1086

# The endpoint can be accessed from the internet at

1087

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

1088

#

1089

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

1090

# password information.

1091

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

1092

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

1093

# or

1094

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

1095

# in which the cluster resides.

1096

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

1097

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

1098

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

Bu Sun Kim

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

[diff] [blame]

1099

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

1100

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

1101

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

Bu Sun Kim

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

[diff] [blame]

1102

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

1103

# required by Cluster Autoscaler to automatically adjust

1104

# the size of the cluster and create/delete

1105

# node pools based on the current needs.

1106

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

1107

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

1108

# NodePool's nodes can be created by NAP.

1109

"A String",

1110

],

1111

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

1112

# amount of resources in the cluster.

1113

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

1114

# For memory, value should be in GB.

1115

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

1116

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

1117

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

1118

},

1119

],

1120

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

1121

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

1122

# created by NAP.

1123

# by NAP.

1124

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

1125

# specified, service_account should be empty.

1126

"A String",

1127

],

1128

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

1129

# node pool.

1130

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

1131

# the Auto Upgrades will proceed.

1132

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

1133

# with the description of the upgrade.

1134

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

1135

# with the approximate start time for the upgrades, in

1136

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

1137

},

1138

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

1139

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

1140

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

1141

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

1142

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

1143

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

1144

# triggered.

1145

},

1146

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

1147

# disruption caused by an upgrade.

1148

#

1149

# maxUnavailable controls the number of nodes that can be simultaneously

1150

# unavailable.

1151

#

1152

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

1153

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

1154

# available nodes.

1155

#

1156

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

1157

# nodes are being upgraded at the same time).

1158

#

1159

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

1160

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

1161

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

1162

# PodDisruptionBudget, if it is configured.)

1163

#

1164

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

1165

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

1166

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

1167

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

1168

# there are always at least 4 nodes available.

1169

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

1170

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

1171

# Ready.

1172

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

1173

# of the node pool during the upgrade process.

1174

},

1175

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

1176

# service_account is specified, scopes should be empty.

1177

},

1178

},

1179

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

1180

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

Bu Sun Kim

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

[diff] [blame]

1181

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

1182

# firewall and routes quota.

1183

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

Bu Sun Kim

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

[diff] [blame]

1184

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

1185

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

Bu Sun Kim

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

[diff] [blame]

1186

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

1187

#

1188

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

Bu Sun Kim

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

[diff] [blame]

1189

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

1190

"A String",

1191

],

1192

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

1193

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

1194

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

1195

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

1196

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

1197

# private networking.

1198

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

1199

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

1200

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

1201

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

1202

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

1203

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

1204

},

1205

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

1206

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

1207

},

1208

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

1209

# required by Vertical Pod Autoscaler to automatically adjust

1210

# the resources of pods controlled by it.

1211

"enabled": True or False, # Enables vertical pod autoscaling.

1212

},

Bu Sun Kim

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

[diff] [blame]

1213

},

Bu Sun Kim

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

[diff] [blame]

1214

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

1215

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

1216

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

1217

# field.

1218

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

1219

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

Bu Sun Kim

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

[diff] [blame]

1220

}

1221

1222

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1229

1230

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

1231

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

Bu Sun Kim

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

[diff] [blame]

1232

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

1233

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

Bu Sun Kim

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

[diff] [blame]

1234

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

1235

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

Bu Sun Kim

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

[diff] [blame]

1236

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

1237

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

Bu Sun Kim

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

[diff] [blame]

1238

},

1239

],

Bu Sun Kim

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

[diff] [blame]

1240

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

Dan O'Meara

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

[diff] [blame]

1241

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

Bu Sun Kim

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

[diff] [blame]

1242

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

Dan O'Meara

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

[diff] [blame]

1243

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

1244

# or

1245

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

1246

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

1247

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

1248

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

1249

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

1250

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

1251

# Object with schema name: OperationProgress

1252

],

1253

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

1254

# Unset for single-stage operations.

1255

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

1256

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

1257

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

1258

# or

1259

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

1260

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

1261

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

1262

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

1263

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

1264

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

1265

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

1266

},

1267

],

1268

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

1269

# Unset for single-stage operations.

1270

},

1271

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

1272

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

1273

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

1274

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

1275

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

1276

},

1277

],

1278

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

1279

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

1280

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

1281

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

1282

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

1283

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

1284

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

1285

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

1286

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1291

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

Bu Sun Kim

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

[diff] [blame]

1292

<pre>Deletes the cluster, including the Kubernetes endpoint and all worker

1293

nodes.

1294

1295

Firewalls and routes that were configured during cluster creation

1296

are also deleted.

1297

1298

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]

1299

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]

1300

when the cluster was initially created.

Args:

Bu Sun Kim

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

[diff] [blame]

1304

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

Bu Sun Kim

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

[diff] [blame]

1305

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

1306

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

1307

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

Bu Sun Kim

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

[diff] [blame]

1308

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

Dan O'Meara

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

[diff] [blame]

1309

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

1310

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

1311

field.

Bu Sun Kim

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

[diff] [blame]

1312

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

1313

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

Bu Sun Kim

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

[diff] [blame]

1314

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1321

1322

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

1323

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

Bu Sun Kim

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

[diff] [blame]

1324

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

1325

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

Bu Sun Kim

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

[diff] [blame]

1326

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

1327

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

Bu Sun Kim

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

[diff] [blame]

1328

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

1329

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

Bu Sun Kim

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

[diff] [blame]

1330

},

1331

],

Bu Sun Kim

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

[diff] [blame]

1332

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

Dan O'Meara

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

[diff] [blame]

1333

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

Bu Sun Kim

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

[diff] [blame]

1334

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

Dan O'Meara

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

[diff] [blame]

1335

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

1336

# or

1337

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

1338

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

1339

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

1340

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

1341

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

1342

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

1343

# Object with schema name: OperationProgress

1344

],

1345

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

1346

# Unset for single-stage operations.

1347

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

1348

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

1349

# {name: "nodes total", int_value: 32}]

1350

# or

1351

# metrics: [{name: "progress", double_value: 0.56},

1352

# {name: "progress scale", double_value: 1.0}]

1353

{ # Progress metric is (string, int|float|string) pair.

1354

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1355

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1356

"doubleValue": 3.14, # For metrics with floating point value.

1357

"intValue": "A String", # For metrics with integer value.

1358

},

1359

],

1360

"name": "A String", # A non-parameterized string describing an operation stage.

1361

# Unset for single-stage operations.

1362

},

1363

"clusterConditions": [ # Which conditions caused the current cluster state.

1364

{ # StatusCondition describes why a cluster or a node pool has a certain status

1365

# (e.g., ERROR or DEGRADED).

1366

"message": "A String", # Human-friendly representation of the condition

1367

"code": "A String", # Machine-friendly representation of the condition

1368

},

1369

],

1370

"zone": "A String", # The name of the Google Compute Engine

1371

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1372

# operation is taking place. This field is deprecated, use location instead.

1373

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1374

"selfLink": "A String", # Server-defined URL for the resource.

1375

"detail": "A String", # Detailed operation progress, if available.

1376

"targetLink": "A String", # Server-defined URL for the target of the operation.

1377

"operationType": "A String", # The operation type.

1378

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1383

<code class="details" id="get">get(name, projectId=None, zone=None, clusterId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1384

<pre>Gets the details of a specific cluster.

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1388

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1389

projectId: string, Deprecated. The Google Developers Console [project ID or project

1390

number](https://support.google.com/cloud/answer/6158840).

1391

This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1392

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1393

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1394

cluster resides. This field has been deprecated and replaced by the name

1395

field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1396

clusterId: string, Deprecated. The name of the cluster to retrieve.

1397

This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1398

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1405

1406

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1407

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

1408

# simultaneously on a node in the node pool of this cluster. Only honored

1409

# if cluster created with IP Alias support.

1410

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1411

},

1412

"network": "A String", # The name of the Google Compute Engine

1413

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1414

# to which the cluster is connected. If left unspecified, the `default`

1415

# network will be used.

1416

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

1417

"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]

1418

# containers. This is provisioned from within the `container_ipv4_cidr`

1419

# range. This field will only be set when cluster is in route-based network

1420

# mode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1421

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

1422

# master authorized networks will disallow all external traffic to access

1423

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

1424

# Google Compute Engine Public IPs and Google Prod IPs.

1425

"enabled": True or False, # Whether or not master authorized networks is enabled.

1426

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

1427

# Kubernetes master through HTTPS.

1428

{ # CidrBlock contains an optional name and one CIDR block.

1429

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

1430

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

},

],

},

"statusMessage": "A String", # [Output only] Additional information about the current status of this

1435

# cluster, if available.

1436

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

1437

# If unspecified, the defaults are used:

1438

# For clusters before v1.12, if master_auth is unspecified, `username` will

1439

# be set to "admin", a random password will be generated, and a client

1440

# certificate will be issued.

1441

# Authentication can be done using HTTP basic auth or using client

1442

# certificates.

1443

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

1444

# trust for the cluster.

1445

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

1446

# authenticate to the cluster endpoint.

1447

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

1448

# For clusters v1.6.0 and later, basic authentication can be disabled by

1449

# leaving username unspecified (or setting it to the empty string).

1450

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

1451

# Because the master endpoint is open to the Internet, you should create a

1452

# strong password. If a password is provided for cluster creation, username

1453

# must be non-empty.

1454

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

1455

# clusters before v1.12, if no configuration is specified, a client

1456

# certificate is issued.

1457

"issueClientCertificate": True or False, # Issue a client certificate.

1458

},

1459

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

1460

# to the cluster endpoint.

1461

},

1462

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

1463

"enabled": True or False, # Whether this cluster should return group membership lookups

1464

# during authentication using a group of security groups.

1465

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

1466

# if enabled = true.

1467

},

1468

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

1469

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

1470

# cluster, enabling additional functionality.

1471

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

1472

# is enabled or not on the Master, it does not track whether network policy

1473

# is enabled for the nodes.

1474

# is enabled or not on the Master, it does not track whether network policy

1475

# is enabled for the nodes.

1476

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1477

},

1478

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

1479

# managed Knative service.

1480

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1481

},

1482

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

1483

# increases or decreases the number of replica pods a replication controller

1484

# has based on the resource usage of the existing pods.

1485

# increases or decreases the number of replica pods a replication controller

1486

# has based on the resource usage of the existing pods.

1487

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

1488

# When enabled, it ensures that metrics are collected into Stackdriver

1489

# Monitoring.

1490

},

1491

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

1492

# makes it easy to set up HTTP load balancers for services in a cluster.

1493

# which makes it easy to set up HTTP load balancers for services in a cluster.

1494

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

1495

# When enabled, it runs a small pod in the cluster that manages the load

1496

# balancers.

1497

},

1498

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

1499

# This addon is deprecated, and will be disabled in 1.15. It is recommended

1500

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

1501

# workloads and applications. For more information, see:

1502

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

1503

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

1504

},

1505

},

1506

"currentNodeVersion": "A String", # [Output only] Deprecated, use

1507

# [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools)

1508

# instead. The current version of the node software components. If they are

1509

# currently at multiple versions because they're in the process of being

1510

# upgraded, this reflects the minimum version of all nodes.

1511

"subnetwork": "A String", # The name of the Google Compute Engine

1512

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

1513

# the cluster is connected.

1514

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

1515

# Google Compute Engine resources.

1516

"a_key": "A String",

1517

},

1518

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

1519

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

1520

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1521

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

1522

# smallest possible in the given scenario.

1523

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

1524

# format "PTnHnMnS".

1525

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

1526

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

1527

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

1528

},

1529

"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]

1530

# maintenance to occur. The time windows may be overlapping. If no

1531

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1532

"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]

1533

# this window reccurs. They go on for the span of time between the start and

1534

# end time.

1535

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1536

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1537

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

1538

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

1539

# <code>FREQ=DAILY</code>

1540

# For the first weekend of every month:

1541

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

1542

# 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]

1543

# 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]

1544

# <code>

1545

# start time = 2019-01-01T09:00:00-0400

1546

# end time = 2019-01-01T17:00:00-0400

1547

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

1548

# </code>

1549

# Windows can span multiple days. Eg, to make the window encompass every

1550

# weekend from midnight Saturday till the last minute of Sunday UTC:

1551

# <code>

1552

# start time = 2019-01-05T00:00:00Z

1553

# end time = 2019-01-07T23:59:00Z

1554

# recurrence = FREQ=WEEKLY;BYDAY=SA

1555

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1556

# 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]

1557

# to specify duration of the window and when it first starts.

1558

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1559

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

1560

"endTime": "A String", # The time that the window ends. The end time should take place after the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1561

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1562

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1563

},

1564

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1565

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1566

# occur in these windows.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1567

"a_key": { # Represents an arbitrary window of time.

1568

"endTime": "A String", # The time that the window ends. The end time should take place after the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1569

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1570

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1571

},

1572

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1573

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1574

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

1575

# the policy won't accidentally undo intermediate changes (and so that users

1576

# 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]

1577

# Make a <code>get()</code> request to the cluster to get the current

1578

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1579

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1580

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

1581

# found in validMasterVersions returned by getServerConfig. The version can

1582

# be upgraded over time; such upgrades are reflected in

1583

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1584

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1585

# Users may specify either explicit versions offered by

1586

# Kubernetes Engine or version aliases, which have the following behavior:

1587

#

1588

# - "latest": picks the highest valid Kubernetes version

1589

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

1590

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

1591

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

1592

# - "","-": picks the default Kubernetes version

1593

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

1594

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

1595

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

1596

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1597

# will be automatically chosen with the default size.

1598

#

1599

# This field is only applicable when `use_ip_aliases` is true.

1600

#

1601

# Set to blank to have a range chosen with the default size.

1602

#

1603

# 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)

1608

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1609

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1610

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1611

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1612

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

1613

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1614

#

1615

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1616

#

1617

# Set to blank to have a range chosen with the default size.

1618

#

1619

# 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)

1624

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1625

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1626

# to use.

1627

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

1628

# block. The secondary range will be used for pod IP

1629

# addresses. This must be an existing secondary range associated

1630

# with the cluster subnetwork.

1631

#

1632

# This field is only applicable with use_ip_aliases is true and

1633

# create_subnetwork is false.

1634

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1635

#

1636

# This is applicable only if `create_subnetwork` is true.

1637

#

1638

# Set to blank to have a range chosen with the default size.

1639

#

1640

# 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)

1645

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1646

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1647

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1648

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1649

# range will be automatically chosen with the default size.

1650

#

1651

# This field is only applicable when `use_ip_aliases` is true.

1652

#

1653

# If unspecified, the range will use the default size.

1654

#

1655

# 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)

1660

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1661

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1662

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1663

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

1664

#

1665

# This field is only applicable when `use_ip_aliases` is true.

1666

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

1667

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1668

# CIDR block. The secondary range will be used for service

1669

# ClusterIPs. This must be an existing secondary range associated

1670

# with the cluster subnetwork.

1671

#

1672

# This field is only applicable with use_ip_aliases is true and

1673

# create_subnetwork is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1674

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

1675

# this field is empty, then an automatic name will be chosen for the new

1676

# subnetwork.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1677

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1678

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

1679

# mode.

1680

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

1681

# identities in the system, including service accounts, nodes, and

1682

# controllers, will have statically granted permissions beyond those

1683

# provided by the RBAC configuration or IAM.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1684

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1685

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1686

# disabled when this config is unspecified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1687

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1688

# daemonset will be created in the cluster to meter network egress traffic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1689

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

1690

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1691

# second BigQuery table will be created to hold resource consumption

1692

# records.

1693

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1694

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

1695

"datasetId": "A String", # The ID of a BigQuery Dataset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1696

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1697

},

1698

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

1699

"locations": [ # The list of Google Compute Engine

1700

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1701

# cluster's nodes should be located.

1702

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1703

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1704

"nodePools": [ # The node pools associated with this cluster.

1705

# This field should not be set if "node_config" or "initial_node_count" are

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1706

# specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1707

{ # NodePool contains the name and configuration for a cluster's node pool.

1708

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1709

# specification, under the control of the cluster master. They may have a set

1710

# of Kubernetes labels applied to them, which may be used to reference them

1711

# during pod scheduling. They may also be resized up or down, to accommodate

1712

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1713

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

1714

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

1715

# is sufficient for this number of instances. You must also have available

1716

# firewall and routes quota.

1717

"locations": [ # The list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1718

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1719

# NodePool's nodes should be located.

1720

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1721

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1722

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1723

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1724

# disruption caused by an upgrade.

1725

#

1726

# maxUnavailable controls the number of nodes that can be simultaneously

1727

# unavailable.

1728

#

1729

# maxSurge controls the number of additional nodes that can be added to the

1730

# node pool temporarily for the time of the upgrade to increase the number of

1731

# available nodes.

1732

#

1733

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

1734

# nodes are being upgraded at the same time).

1735

#

1736

# Note: upgrades inevitably introduce some disruption since workloads need to

1737

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

1738

# this holds true. (Disruption stays within the limits of

1739

# PodDisruptionBudget, if it is configured.)

1740

#

1741

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

1742

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

1743

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

1744

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

1745

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1746

"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]

1747

# the upgrade process. A node is considered available if its status is

1748

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1749

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

1750

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1751

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1752

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

1753

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

1754

# associated with this node pool.

1755

"A String",

1756

],

1757

"version": "A String", # The version of the Kubernetes of this node.

1758

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

1759

"conditions": [ # Which conditions caused the current node pool state.

1760

{ # StatusCondition describes why a cluster or a node pool has a certain status

1761

# (e.g., ERROR or DEGRADED).

1762

"message": "A String", # Human-friendly representation of the condition

1763

"code": "A String", # Machine-friendly representation of the condition

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1764

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1765

],

1766

"status": "A String", # [Output only] The status of the nodes in this pool instance.

1767

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

1768

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1769

# valid sources or targets for network firewalls and are specified by

1770

# the client during cluster or node pool creation. Each tag within the list

1771

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1772

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1773

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1774

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1775

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1776

# Account is specified, the "default" service account is used.

1777

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

1778

# the latest version of it will be used.

1779

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

1780

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1781

#

1782

# The following scopes are recommended, but not required, and by default are

1783

# not included:

1784

#

1785

# * `https://www.googleapis.com/auth/compute` is required for mounting

1786

# persistent storage on your nodes.

1787

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

1788

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1789

# (the [Google Container

1790

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1791

#

1792

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

1793

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1794

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1795

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1796

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1797

#

1798

# For more information, including usage and the valid values, see:

1799

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1800

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

1801

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

1802

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1803

# See

1804

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

1805

# for more information, including usage and the valid values.

1806

"key": "A String", # Key for taint.

1807

"value": "A String", # Value for taint.

1808

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1809

},

1810

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1811

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

1812

# These will added in addition to any default label(s) that

1813

# Kubernetes may apply to the node.

1814

# In case of conflict in label keys, the applied set may differ depending on

1815

# the Kubernetes version -- it's best to assume the behavior is undefined

1816

# and conflicts should be avoided.

1817

# For more information, including usage and the valid values, see:

1818

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

1819

"a_key": "A String",

1820

},

1821

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

1822

# The smallest allowed disk size is 10GB.

1823

#

1824

# If unspecified, the default disk size is 100GB.

1825

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

1826

# workloads on the node pool.

1827

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

1828

# on the node pool.

1829

},

1830

"accelerators": [ # A list of hardware accelerators to be attached to each node.

1831

# See https://cloud.google.com/compute/docs/gpus for more information about

1832

# support for GPUs.

1833

{ # AcceleratorConfig represents a Hardware Accelerator request.

1834

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1835

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

1836

# [here](https://cloud.google.com/compute/docs/gpus)

1837

},

1838

],

1839

"machineType": "A String", # The name of a Google Compute Engine [machine

1840

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

1841

# `n1-standard-1`).

1842

#

1843

# If unspecified, the default machine type is

1844

# `n1-standard-1`.

1845

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

1846

#

1847

# If unspecified, the default disk type is 'pd-standard'

1848

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1849

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1850

#

1851

# Secure Boot helps ensure that the system only runs authentic software by

1852

# verifying the digital signature of all boot components, and halting the

1853

# boot process if signature verification fails.

1854

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1855

#

1856

# Enables monitoring and attestation of the boot integrity of the instance.

1857

# The attestation is performed against the integrity policy baseline. This

1858

# baseline is initially derived from the implicitly trusted boot image when

1859

# the instance is created.

1860

},

1861

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

1862

# scheduled on the specified or newer CPU platform. Applicable values are the

1863

# friendly names of CPU platforms, such as

1864

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

1865

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

1866

# information, read [how to specify min CPU

1867

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1868

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

1869

# https://cloud.google.com/compute/docs/instances/preemptible for more

1870

# information about preemptible VM instances.

1871

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1872

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1873

# The limit for this value is dependent upon the maximum number of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1874

# disks available on a machine per zone. See:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1875

# https://cloud.google.com/compute/docs/disks/local-ssd

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1876

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1877

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1878

"type": "A String", # Type of the sandbox to use for the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1879

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1880

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

1881

#

1882

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

1883

# in length. These are reflected as part of a URL in the metadata server.

1884

# Additionally, to avoid ambiguity, keys must not conflict with any other

1885

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1891

# "enable-os-login"

1892

# "gci-ensure-gke-docker"

1893

# "gci-metrics-enabled"

1894

# "gci-update-strategy"

1895

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1900

# "windows-startup-script-ps1"

1901

# "common-psm1"

1902

# "k8s-node-setup-psm1"

1903

# "install-ssh-psm1"

1904

# "user-profile-psm1"

1905

# "serial-port-logging-enable"

1906

#

1907

# Values are free-form strings, and only have meaning as interpreted by

1908

# the image running in the instance. The only restriction placed on them is

1909

# that each value's size must be less than or equal to 32 KB.

1910

#

1911

# The total size of all keys and values must be less than 512 KB.

1912

"a_key": "A String",

1913

},

1914

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

1915

# the specified [Zonal Compute

1916

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

1917

# to this node pool.

1918

# is the configuration of desired reservation which instances could take

1919

# capacity from.

1920

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

1921

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

1922

# the key and specify the name of your reservation as its value.

1923

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1924

"A String",

1925

],

1926

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1927

},

1928

},

1929

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

1930

# simultaneously on a node in the node pool.

1931

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1932

},

1933

"name": "A String", # The name of the node pool.

1934

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

1935

# node pool.

1936

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

1937

# the Auto Upgrades will proceed.

1938

"description": "A String", # [Output only] This field is set when upgrades are about to commence

1939

# with the description of the upgrade.

1940

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

1941

# with the approximate start time for the upgrades, in

1942

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1943

},

1944

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

1945

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

1946

# up to date with the latest release version of Kubernetes.

1947

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

1948

# pool. If enabled, the nodes in this node pool will be monitored and, if

1949

# they fail health checks too many times, an automatic repair action will be

1950

# triggered.

1951

},

1952

"statusMessage": "A String", # [Output only] Additional information about the current status of this

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1953

# node pool instance, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1954

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

1955

# only if a valid configuration is present.

1956

# adjust the size of the node pool to the current cluster usage.

1957

"enabled": True or False, # Is autoscaling enabled for this node pool.

1958

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

1959

# has to enough quota to scale up the cluster.

1960

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

1961

# max_node_count.

1962

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

1963

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1964

},

1965

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1966

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1967

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

1968

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

1969

"provider": "A String", # The selected network policy provider.

1970

"enabled": True or False, # Whether network policy is enabled on the cluster.

1971

},

1972

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

1973

# this cluster, in

1974

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1975

# notation (e.g. `1.2.3.4/29`). Service addresses are

1976

# typically put in the last `/16` from the container CIDR.

1977

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

1978

# API groups (e.g. v1alpha1) and features that may not be production ready in

1979

# the kubernetes version of the master and nodes.

1980

# The cluster has no SLA for uptime and master/node upgrades are disabled.

1981

# Alpha enabled clusters are automatically deleted thirty days after

1982

# creation.

1983

"description": "A String", # An optional description of this cluster.

1984

"conditions": [ # Which conditions caused the current cluster state.

1985

{ # StatusCondition describes why a cluster or a node pool has a certain status

1986

# (e.g., ERROR or DEGRADED).

1987

"message": "A String", # Human-friendly representation of the condition

1988

"code": "A String", # Machine-friendly representation of the condition

1989

},

1990

],

1991

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

1992

# Call Kubernetes API directly to retrieve node information.

1993

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1994

# Currently available options:

1995

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1996

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1997

# service with a Kubernetes-native resource model

1998

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

1999

# longer available as of GKE 1.15).

2000

# * `none` - No metrics will be exported from the cluster.

2001

#

2002

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

2003

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2004

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2005

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

2006

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

2007

"state": "A String", # Denotes the state of etcd encryption.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2008

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2009

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

2010

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

2011

# images will be validated by Binary Authorization.

2012

},

2013

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

2014

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2015

# notation (e.g. `1.2.3.4/29`).

2016

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

2017

# policies.

2018

# policies.

2019

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

2020

},

2021

"zone": "A String", # [Output only] The name of the Google Compute Engine

2022

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2023

# cluster resides. This field is deprecated, use location instead.

2024

"expireTime": "A String", # [Output only] The time the cluster will be automatically

2025

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2026

"loggingService": "A String", # The logging service the cluster should use to write logs.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2027

# Currently available options:

2028

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2029

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

2030

# service with a Kubernetes-native resource model

2031

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

2032

# available as of GKE 1.15).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2033

# * `none` - no logs will be exported from the cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2034

#

2035

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

2036

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2037

"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]

2038

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2039

# "node_pool" object, since this configuration (along with the

2040

# "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]

2041

# auto-generated name. Do not use this and a node_pool at the same time.

2042

# For responses, this field will be populated with the node configuration of

2043

# the first node pool. (For configuration of each node pool, see

2044

# `node_pool.config`)

2045

#

2046

# If unspecified, the defaults are used.

2047

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2048

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2049

# valid sources or targets for network firewalls and are specified by

2050

# the client during cluster or node pool creation. Each tag within the list

2051

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2052

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2053

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2054

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2055

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2056

# Account is specified, the "default" service account is used.

2057

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2058

# the latest version of it will be used.

2059

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2060

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2061

#

2062

# The following scopes are recommended, but not required, and by default are

2063

# not included:

2064

#

2065

# * `https://www.googleapis.com/auth/compute` is required for mounting

2066

# persistent storage on your nodes.

2067

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2068

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2069

# (the [Google Container

2070

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2071

#

2072

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2073

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2074

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2075

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2076

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2077

#

2078

# For more information, including usage and the valid values, see:

2079

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2080

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2081

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2082

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2083

# See

2084

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2085

# for more information, including usage and the valid values.

2086

"key": "A String", # Key for taint.

2087

"value": "A String", # Value for taint.

2088

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2089

},

2090

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2091

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2092

# These will added in addition to any default label(s) that

2093

# Kubernetes may apply to the node.

2094

# In case of conflict in label keys, the applied set may differ depending on

2095

# the Kubernetes version -- it's best to assume the behavior is undefined

2096

# and conflicts should be avoided.

2097

# For more information, including usage and the valid values, see:

2098

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2099

"a_key": "A String",

2100

},

2101

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2102

# The smallest allowed disk size is 10GB.

2103

#

2104

# If unspecified, the default disk size is 100GB.

2105

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2106

# workloads on the node pool.

2107

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2108

# on the node pool.

2109

},

2110

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2111

# See https://cloud.google.com/compute/docs/gpus for more information about

2112

# support for GPUs.

2113

{ # AcceleratorConfig represents a Hardware Accelerator request.

2114

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2115

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2116

# [here](https://cloud.google.com/compute/docs/gpus)

2117

},

2118

],

2119

"machineType": "A String", # The name of a Google Compute Engine [machine

2120

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2121

# `n1-standard-1`).

2122

#

2123

# If unspecified, the default machine type is

2124

# `n1-standard-1`.

2125

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2126

#

2127

# If unspecified, the default disk type is 'pd-standard'

2128

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2129

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2130

#

2131

# Secure Boot helps ensure that the system only runs authentic software by

2132

# verifying the digital signature of all boot components, and halting the

2133

# boot process if signature verification fails.

2134

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2135

#

2136

# Enables monitoring and attestation of the boot integrity of the instance.

2137

# The attestation is performed against the integrity policy baseline. This

2138

# baseline is initially derived from the implicitly trusted boot image when

2139

# the instance is created.

2140

},

2141

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2142

# scheduled on the specified or newer CPU platform. Applicable values are the

2143

# friendly names of CPU platforms, such as

2144

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2145

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2146

# information, read [how to specify min CPU

2147

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2148

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2149

# https://cloud.google.com/compute/docs/instances/preemptible for more

2150

# information about preemptible VM instances.

2151

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2152

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2153

# The limit for this value is dependent upon the maximum number of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2154

# disks available on a machine per zone. See:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2155

# https://cloud.google.com/compute/docs/disks/local-ssd

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2156

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2157

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2158

"type": "A String", # Type of the sandbox to use for the node.

2159

},

2160

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2161

#

2162

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2163

# in length. These are reflected as part of a URL in the metadata server.

2164

# Additionally, to avoid ambiguity, keys must not conflict with any other

2165

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2171

# "enable-os-login"

2172

# "gci-ensure-gke-docker"

2173

# "gci-metrics-enabled"

2174

# "gci-update-strategy"

2175

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2180

# "windows-startup-script-ps1"

2181

# "common-psm1"

2182

# "k8s-node-setup-psm1"

2183

# "install-ssh-psm1"

2184

# "user-profile-psm1"

2185

# "serial-port-logging-enable"

2186

#

2187

# Values are free-form strings, and only have meaning as interpreted by

2188

# the image running in the instance. The only restriction placed on them is

2189

# that each value's size must be less than or equal to 32 KB.

2190

#

2191

# The total size of all keys and values must be less than 512 KB.

2192

"a_key": "A String",

2193

},

2194

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2195

# the specified [Zonal Compute

2196

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2197

# to this node pool.

2198

# is the configuration of desired reservation which instances could take

2199

# capacity from.

2200

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2201

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2202

# the key and specify the name of your reservation as its value.

2203

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2204

"A String",

2205

],

2206

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2207

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2208

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2209

"status": "A String", # [Output only] The current status of this cluster.

2210

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

2211

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

2212

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

2213

# cluster is connected. Example:

2214

# projects/my-project/regions/us-central1/subnetworks/my-subnet

2215

"network": "A String", # Output only. The relative name of the Google Compute Engine

2216

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2217

# to which the cluster is connected. Example:

2218

# projects/my-project/global/networks/my-network

2219

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

2220

# This makes same node pod to pod traffic visible for VPC network.

2221

},

2222

"name": "A String", # The name of this cluster. The name must be unique within this project

2223

# and location (e.g. zone or region), and can be up to 40 characters with

2224

# the following restrictions:

2225

#

2226

# * Lowercase letters, numbers, and hyphens only.

2227

# * Must start with a letter.

2228

# * Must end with a number or a letter.

2229

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

2230

# The endpoint can be accessed from the internet at

2231

# `https://username:password@endpoint/`.

2232

#

2233

# See the `masterAuth` property of this resource for username and

2234

# password information.

2235

"location": "A String", # [Output only] The name of the Google Compute Engine

2236

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2237

# or

2238

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2239

# in which the cluster resides.

2240

"createTime": "A String", # [Output only] The time the cluster was created, in

2241

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2242

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2243

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2244

# notation (e.g. `10.96.0.0/14`). Leave blank to have

2245

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2246

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

2247

# required by Cluster Autoscaler to automatically adjust

2248

# the size of the cluster and create/delete

2249

# node pools based on the current needs.

2250

"autoprovisioningLocations": [ # The list of Google Compute Engine

2251

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2252

# NodePool's nodes can be created by NAP.

2253

"A String",

2254

],

2255

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

2256

# amount of resources in the cluster.

2257

{ # Contains information about amount of some resource in the cluster.

2258

# For memory, value should be in GB.

2259

"maximum": "A String", # Maximum amount of the resource in the cluster.

2260

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

2261

"minimum": "A String", # Minimum amount of the resource in the cluster.

2262

},

2263

],

2264

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

2265

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

2266

# created by NAP.

2267

# by NAP.

2268

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

2269

# specified, service_account should be empty.

2270

"A String",

2271

],

2272

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

2273

# node pool.

2274

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2275

# the Auto Upgrades will proceed.

2276

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2277

# with the description of the upgrade.

2278

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2279

# with the approximate start time for the upgrades, in

2280

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2281

},

2282

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

2283

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

2284

# up to date with the latest release version of Kubernetes.

2285

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

2286

# pool. If enabled, the nodes in this node pool will be monitored and, if

2287

# they fail health checks too many times, an automatic repair action will be

2288

# triggered.

2289

},

2290

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

2291

# disruption caused by an upgrade.

2292

#

2293

# maxUnavailable controls the number of nodes that can be simultaneously

2294

# unavailable.

2295

#

2296

# maxSurge controls the number of additional nodes that can be added to the

2297

# node pool temporarily for the time of the upgrade to increase the number of

2298

# available nodes.

2299

#

2300

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2301

# nodes are being upgraded at the same time).

2302

#

2303

# Note: upgrades inevitably introduce some disruption since workloads need to

2304

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2305

# this holds true. (Disruption stays within the limits of

2306

# PodDisruptionBudget, if it is configured.)

2307

#

2308

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2309

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2310

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2311

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2312

# there are always at least 4 nodes available.

2313

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2314

# the upgrade process. A node is considered available if its status is

2315

# Ready.

2316

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2317

# of the node pool during the upgrade process.

2318

},

2319

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

2320

# service_account is specified, scopes should be empty.

2321

},

2322

},

2323

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

2324

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2325

# is sufficient for this number of instances. You must also have available

2326

# firewall and routes quota.

2327

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2328

# "node_pool" object, since this configuration (along with the

2329

# "node_config") will be used to create a "NodePool" object with an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2330

# auto-generated name. Do not use this and a node_pool at the same time.

2331

#

2332

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2333

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

2334

"A String",

2335

],

2336

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

2337

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

2338

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

2339

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

2340

# given only RFC 1918 private addresses and communicate with the master via

2341

# private networking.

2342

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

2343

# range will be used for assigning internal IP addresses to the master or

2344

# set of masters, as well as the ILB VIP. This range must not overlap with

2345

# any other ranges in use within the cluster's network.

2346

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

2347

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

2348

},

2349

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

2350

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

2351

},

2352

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

2353

# required by Vertical Pod Autoscaler to automatically adjust

2354

# the resources of pods controlled by it.

2355

"enabled": True or False, # Enables vertical pod autoscaling.

2356

},

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>

2362

<pre>Gets the public component of the cluster signing keys in

2363

JSON Web Key format.

2364

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]

2369

the format `projects/*/locations/*/clusters/*`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2370

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2377

2378

{ # 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]

2379

"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]

2380

# requests.

2381

{ # Jwk is a JSON Web Key as specified in RFC 7517

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2382

"crv": "A String", # Used for ECDSA keys.

2383

"kid": "A String", # Key ID.

2384

"e": "A String", # Used for RSA keys.

2385

"kty": "A String", # Key Type.

2386

"alg": "A String", # Algorithm.

2387

"n": "A String", # Used for RSA keys.

2388

"use": "A String", # Permitted uses for the public keys.

2389

"y": "A String", # Used for ECDSA keys.

2390

"x": "A String", # Used for ECDSA keys.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2391

},

2392

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2393

"cacheHeader": { # RFC-2616: cache control support # OnePlatform automatically extracts this field and uses it to set the HTTP

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2394

# Cache-Control header.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2395

"age": "A String", # 14.6 response cache age, in seconds since the response is generated

2396

"expires": "A String", # 14.21 response cache expires, in RFC 1123 date format

2397

"directive": "A String", # 14.9 request and response directives

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2398

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2403

<code class="details" id="list">list(parent, projectId=None, zone=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2404

<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]

2409

Specified in the format `projects/*/locations/*`.

2410

Location "-" matches all zones and all regions. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2411

projectId: string, Deprecated. The Google Developers Console [project ID or project

2412

number](https://support.google.com/cloud/answer/6158840).

2413

This field has been deprecated and replaced by the parent field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2414

zone: string, Deprecated. The name of the Google Compute Engine

2415

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

2416

cluster resides, or "-" for all zones. This field has been deprecated and

2417

replaced by the parent field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2418

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2425

2426

{ # ListClustersResponse is the result of ListClustersRequest.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2427

"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]

2428

# across all ones.

2429

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2430

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

2431

# simultaneously on a node in the node pool of this cluster. Only honored

2432

# if cluster created with IP Alias support.

2433

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2434

},

2435

"network": "A String", # The name of the Google Compute Engine

2436

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2437

# to which the cluster is connected. If left unspecified, the `default`

2438

# network will be used.

2439

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

2440

"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]

2441

# containers. This is provisioned from within the `container_ipv4_cidr`

2442

# range. This field will only be set when cluster is in route-based network

2443

# mode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2444

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

2445

# master authorized networks will disallow all external traffic to access

2446

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

2447

# Google Compute Engine Public IPs and Google Prod IPs.

2448

"enabled": True or False, # Whether or not master authorized networks is enabled.

2449

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

2450

# Kubernetes master through HTTPS.

2451

{ # CidrBlock contains an optional name and one CIDR block.

2452

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

2453

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

},

],

},

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2458

# cluster, if available.

2459

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

2460

# If unspecified, the defaults are used:

2461

# For clusters before v1.12, if master_auth is unspecified, `username` will

2462

# be set to "admin", a random password will be generated, and a client

2463

# certificate will be issued.

2464

# Authentication can be done using HTTP basic auth or using client

2465

# certificates.

2466

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

2467

# trust for the cluster.

2468

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

2469

# authenticate to the cluster endpoint.

2470

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

2471

# For clusters v1.6.0 and later, basic authentication can be disabled by

2472

# leaving username unspecified (or setting it to the empty string).

2473

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

2474

# Because the master endpoint is open to the Internet, you should create a

2475

# strong password. If a password is provided for cluster creation, username

2476

# must be non-empty.

2477

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

2478

# clusters before v1.12, if no configuration is specified, a client

2479

# certificate is issued.

2480

"issueClientCertificate": True or False, # Issue a client certificate.

2481

},

2482

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

2483

# to the cluster endpoint.

2484

},

2485

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

2486

"enabled": True or False, # Whether this cluster should return group membership lookups

2487

# during authentication using a group of security groups.

2488

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

2489

# if enabled = true.

2490

},

2491

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

2492

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

2493

# cluster, enabling additional functionality.

2494

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

2495

# is enabled or not on the Master, it does not track whether network policy

2496

# is enabled for the nodes.

2497

# is enabled or not on the Master, it does not track whether network policy

2498

# is enabled for the nodes.

2499

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

2500

},

2501

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

2502

# managed Knative service.

2503

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2504

},

2505

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

2506

# increases or decreases the number of replica pods a replication controller

2507

# has based on the resource usage of the existing pods.

2508

# increases or decreases the number of replica pods a replication controller

2509

# has based on the resource usage of the existing pods.

2510

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

2511

# When enabled, it ensures that metrics are collected into Stackdriver

2512

# Monitoring.

2513

},

2514

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

2515

# makes it easy to set up HTTP load balancers for services in a cluster.

2516

# which makes it easy to set up HTTP load balancers for services in a cluster.

2517

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

2518

# When enabled, it runs a small pod in the cluster that manages the load

2519

# balancers.

2520

},

2521

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

2522

# This addon is deprecated, and will be disabled in 1.15. It is recommended

2523

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

2524

# workloads and applications. For more information, see:

2525

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

2526

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

2527

},

2528

},

2529

"currentNodeVersion": "A String", # [Output only] Deprecated, use

2530

# [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools)

2531

# instead. The current version of the node software components. If they are

2532

# currently at multiple versions because they're in the process of being

2533

# upgraded, this reflects the minimum version of all nodes.

2534

"subnetwork": "A String", # The name of the Google Compute Engine

2535

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

2536

# the cluster is connected.

2537

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

2538

# Google Compute Engine resources.

2539

"a_key": "A String",

2540

},

2541

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

2542

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

2543

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

2544

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

2545

# smallest possible in the given scenario.

2546

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

2547

# format "PTnHnMnS".

2548

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

2549

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

2550

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

2551

},

2552

"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]

2553

# maintenance to occur. The time windows may be overlapping. If no

2554

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2555

"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]

2556

# this window reccurs. They go on for the span of time between the start and

2557

# end time.

2558

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2559

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2560

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

2561

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

2562

# <code>FREQ=DAILY</code>

2563

# For the first weekend of every month:

2564

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

2565

# 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]

2566

# 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]

2567

# <code>

2568

# start time = 2019-01-01T09:00:00-0400

2569

# end time = 2019-01-01T17:00:00-0400

2570

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

2571

# </code>

2572

# Windows can span multiple days. Eg, to make the window encompass every

2573

# weekend from midnight Saturday till the last minute of Sunday UTC:

2574

# <code>

2575

# start time = 2019-01-05T00:00:00Z

2576

# end time = 2019-01-07T23:59:00Z

2577

# recurrence = FREQ=WEEKLY;BYDAY=SA

2578

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2579

# 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]

2580

# to specify duration of the window and when it first starts.

2581

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2582

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

2583

"endTime": "A String", # The time that the window ends. The end time should take place after the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2584

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2585

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2586

},

2587

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2588

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2589

# occur in these windows.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2590

"a_key": { # Represents an arbitrary window of time.

2591

"endTime": "A String", # The time that the window ends. The end time should take place after the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2592

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2593

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2594

},

2595

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2596

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2597

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

2598

# the policy won't accidentally undo intermediate changes (and so that users

2599

# 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]

2600

# Make a <code>get()</code> request to the cluster to get the current

2601

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2602

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2603

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

2604

# found in validMasterVersions returned by getServerConfig. The version can

2605

# be upgraded over time; such upgrades are reflected in

2606

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2607

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2608

# Users may specify either explicit versions offered by

2609

# Kubernetes Engine or version aliases, which have the following behavior:

2610

#

2611

# - "latest": picks the highest valid Kubernetes version

2612

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

2613

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

2614

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

2615

# - "","-": picks the default Kubernetes version

2616

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

2617

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

2618

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

2619

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2620

# will be automatically chosen with the default size.

2621

#

2622

# This field is only applicable when `use_ip_aliases` is true.

2623

#

2624

# Set to blank to have a range chosen with the default size.

2625

#

2626

# 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)

2631

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2632

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2633

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2634

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

2635

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

2636

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2637

#

2638

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2639

#

2640

# Set to blank to have a range chosen with the default size.

2641

#

2642

# 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)

2647

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2648

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2649

# to use.

2650

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

2651

# block. The secondary range will be used for pod IP

2652

# addresses. This must be an existing secondary range associated

2653

# with the cluster subnetwork.

2654

#

2655

# This field is only applicable with use_ip_aliases is true and

2656

# create_subnetwork is false.

2657

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2658

#

2659

# This is applicable only if `create_subnetwork` is true.

2660

#

2661

# Set to blank to have a range chosen with the default size.

2662

#

2663

# 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)

2668

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2669

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2670

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2671

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2672

# range will be automatically chosen with the default size.

2673

#

2674

# This field is only applicable when `use_ip_aliases` is true.

2675

#

2676

# If unspecified, the range will use the default size.

2677

#

2678

# 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)

2683

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2684

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2685

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2686

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

2687

#

2688

# This field is only applicable when `use_ip_aliases` is true.

2689

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

2690

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2691

# CIDR block. The secondary range will be used for service

2692

# ClusterIPs. This must be an existing secondary range associated

2693

# with the cluster subnetwork.

2694

#

2695

# This field is only applicable with use_ip_aliases is true and

2696

# create_subnetwork is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2697

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

2698

# this field is empty, then an automatic name will be chosen for the new

2699

# subnetwork.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2700

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2701

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

2702

# mode.

2703

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

2704

# identities in the system, including service accounts, nodes, and

2705

# controllers, will have statically granted permissions beyond those

2706

# provided by the RBAC configuration or IAM.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2707

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2708

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2709

# disabled when this config is unspecified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2710

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2711

# daemonset will be created in the cluster to meter network egress traffic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2712

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

2713

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2714

# second BigQuery table will be created to hold resource consumption

2715

# records.

2716

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2717

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2718

"datasetId": "A String", # The ID of a BigQuery Dataset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2719

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2720

},

2721

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

2722

"locations": [ # The list of Google Compute Engine

2723

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2724

# cluster's nodes should be located.

2725

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2726

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2727

"nodePools": [ # The node pools associated with this cluster.

2728

# This field should not be set if "node_config" or "initial_node_count" are

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2729

# specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2730

{ # NodePool contains the name and configuration for a cluster's node pool.

2731

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2732

# specification, under the control of the cluster master. They may have a set

2733

# of Kubernetes labels applied to them, which may be used to reference them

2734

# during pod scheduling. They may also be resized up or down, to accommodate

2735

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2736

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

2737

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

2738

# is sufficient for this number of instances. You must also have available

2739

# firewall and routes quota.

2740

"locations": [ # The list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2741

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2742

# NodePool's nodes should be located.

2743

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2744

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2745

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2746

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2747

# disruption caused by an upgrade.

2748

#

2749

# maxUnavailable controls the number of nodes that can be simultaneously

2750

# unavailable.

2751

#

2752

# maxSurge controls the number of additional nodes that can be added to the

2753

# node pool temporarily for the time of the upgrade to increase the number of

2754

# available nodes.

2755

#

2756

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2757

# nodes are being upgraded at the same time).

2758

#

2759

# Note: upgrades inevitably introduce some disruption since workloads need to

2760

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2761

# this holds true. (Disruption stays within the limits of

2762

# PodDisruptionBudget, if it is configured.)

2763

#

2764

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2765

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2766

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2767

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2768

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2769

"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]

2770

# the upgrade process. A node is considered available if its status is

2771

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2772

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2773

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2774

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2775

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

2776

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

2777

# associated with this node pool.

2778

"A String",

2779

],

2780

"version": "A String", # The version of the Kubernetes of this node.

2781

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

2782

"conditions": [ # Which conditions caused the current node pool state.

2783

{ # StatusCondition describes why a cluster or a node pool has a certain status

2784

# (e.g., ERROR or DEGRADED).

2785

"message": "A String", # Human-friendly representation of the condition

2786

"code": "A String", # Machine-friendly representation of the condition

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2787

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2788

],

2789

"status": "A String", # [Output only] The status of the nodes in this pool instance.

2790

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

2791

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2792

# valid sources or targets for network firewalls and are specified by

2793

# the client during cluster or node pool creation. Each tag within the list

2794

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2795

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2796

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2797

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2798

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2799

# Account is specified, the "default" service account is used.

2800

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2801

# the latest version of it will be used.

2802

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2803

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2804

#

2805

# The following scopes are recommended, but not required, and by default are

2806

# not included:

2807

#

2808

# * `https://www.googleapis.com/auth/compute` is required for mounting

2809

# persistent storage on your nodes.

2810

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2811

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2812

# (the [Google Container

2813

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2814

#

2815

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2816

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2817

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2818

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2819

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2820

#

2821

# For more information, including usage and the valid values, see:

2822

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2823

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2824

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2825

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2826

# See

2827

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2828

# for more information, including usage and the valid values.

2829

"key": "A String", # Key for taint.

2830

"value": "A String", # Value for taint.

2831

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2832

},

2833

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2834

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2835

# These will added in addition to any default label(s) that

2836

# Kubernetes may apply to the node.

2837

# In case of conflict in label keys, the applied set may differ depending on

2838

# the Kubernetes version -- it's best to assume the behavior is undefined

2839

# and conflicts should be avoided.

2840

# For more information, including usage and the valid values, see:

2841

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2842

"a_key": "A String",

2843

},

2844

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2845

# The smallest allowed disk size is 10GB.

2846

#

2847

# If unspecified, the default disk size is 100GB.

2848

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2849

# workloads on the node pool.

2850

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2851

# on the node pool.

2852

},

2853

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2854

# See https://cloud.google.com/compute/docs/gpus for more information about

2855

# support for GPUs.

2856

{ # AcceleratorConfig represents a Hardware Accelerator request.

2857

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2858

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2859

# [here](https://cloud.google.com/compute/docs/gpus)

2860

},

2861

],

2862

"machineType": "A String", # The name of a Google Compute Engine [machine

2863

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2864

# `n1-standard-1`).

2865

#

2866

# If unspecified, the default machine type is

2867

# `n1-standard-1`.

2868

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2869

#

2870

# If unspecified, the default disk type is 'pd-standard'

2871

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2872

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2873

#

2874

# Secure Boot helps ensure that the system only runs authentic software by

2875

# verifying the digital signature of all boot components, and halting the

2876

# boot process if signature verification fails.

2877

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2878

#

2879

# Enables monitoring and attestation of the boot integrity of the instance.

2880

# The attestation is performed against the integrity policy baseline. This

2881

# baseline is initially derived from the implicitly trusted boot image when

2882

# the instance is created.

2883

},

2884

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2885

# scheduled on the specified or newer CPU platform. Applicable values are the

2886

# friendly names of CPU platforms, such as

2887

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2888

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2889

# information, read [how to specify min CPU

2890

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2891

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2892

# https://cloud.google.com/compute/docs/instances/preemptible for more

2893

# information about preemptible VM instances.

2894

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2895

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2896

# The limit for this value is dependent upon the maximum number of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2897

# disks available on a machine per zone. See:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2898

# https://cloud.google.com/compute/docs/disks/local-ssd

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2899

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2900

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2901

"type": "A String", # Type of the sandbox to use for the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2902

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2903

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2904

#

2905

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2906

# in length. These are reflected as part of a URL in the metadata server.

2907

# Additionally, to avoid ambiguity, keys must not conflict with any other

2908

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2914

# "enable-os-login"

2915

# "gci-ensure-gke-docker"

2916

# "gci-metrics-enabled"

2917

# "gci-update-strategy"

2918

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2923

# "windows-startup-script-ps1"

2924

# "common-psm1"

2925

# "k8s-node-setup-psm1"

2926

# "install-ssh-psm1"

2927

# "user-profile-psm1"

2928

# "serial-port-logging-enable"

2929

#

2930

# Values are free-form strings, and only have meaning as interpreted by

2931

# the image running in the instance. The only restriction placed on them is

2932

# that each value's size must be less than or equal to 32 KB.

2933

#

2934

# The total size of all keys and values must be less than 512 KB.

2935

"a_key": "A String",

2936

},

2937

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2938

# the specified [Zonal Compute

2939

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2940

# to this node pool.

2941

# is the configuration of desired reservation which instances could take

2942

# capacity from.

2943

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2944

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2945

# the key and specify the name of your reservation as its value.

2946

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2947

"A String",

2948

],

2949

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2950

},

2951

},

2952

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

2953

# simultaneously on a node in the node pool.

2954

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2955

},

2956

"name": "A String", # The name of the node pool.

2957

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

2958

# node pool.

2959

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2960

# the Auto Upgrades will proceed.

2961

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2962

# with the description of the upgrade.

2963

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2964

# with the approximate start time for the upgrades, in

2965

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2966

},

2967

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

2968

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

2969

# up to date with the latest release version of Kubernetes.

2970

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

2971

# pool. If enabled, the nodes in this node pool will be monitored and, if

2972

# they fail health checks too many times, an automatic repair action will be

2973

# triggered.

2974

},

2975

"statusMessage": "A String", # [Output only] Additional information about the current status of this

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2976

# node pool instance, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2977

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

2978

# only if a valid configuration is present.

2979

# adjust the size of the node pool to the current cluster usage.

2980

"enabled": True or False, # Is autoscaling enabled for this node pool.

2981

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

2982

# has to enough quota to scale up the cluster.

2983

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

2984

# max_node_count.

2985

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2986

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2987

},

2988

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2989

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2990

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

2991

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

2992

"provider": "A String", # The selected network policy provider.

2993

"enabled": True or False, # Whether network policy is enabled on the cluster.

2994

},

2995

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

2996

# this cluster, in

2997

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2998

# notation (e.g. `1.2.3.4/29`). Service addresses are

2999

# typically put in the last `/16` from the container CIDR.

3000

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

3001

# API groups (e.g. v1alpha1) and features that may not be production ready in

3002

# the kubernetes version of the master and nodes.

3003

# The cluster has no SLA for uptime and master/node upgrades are disabled.

3004

# Alpha enabled clusters are automatically deleted thirty days after

3005

# creation.

3006

"description": "A String", # An optional description of this cluster.

3007

"conditions": [ # Which conditions caused the current cluster state.

3008

{ # StatusCondition describes why a cluster or a node pool has a certain status

3009

# (e.g., ERROR or DEGRADED).

3010

"message": "A String", # Human-friendly representation of the condition

3011

"code": "A String", # Machine-friendly representation of the condition

3012

},

3013

],

3014

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

3015

# Call Kubernetes API directly to retrieve node information.

3016

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3017

# Currently available options:

3018

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3019

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3020

# service with a Kubernetes-native resource model

3021

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

3022

# longer available as of GKE 1.15).

3023

# * `none` - No metrics will be exported from the cluster.

3024

#

3025

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

3026

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3027

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

3028

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

3029

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

3030

"state": "A String", # Denotes the state of etcd encryption.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3031

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3032

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

3033

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

3034

# images will be validated by Binary Authorization.

3035

},

3036

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

3037

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3038

# notation (e.g. `1.2.3.4/29`).

3039

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

3040

# policies.

3041

# policies.

3042

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

3043

},

3044

"zone": "A String", # [Output only] The name of the Google Compute Engine

3045

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3046

# cluster resides. This field is deprecated, use location instead.

3047

"expireTime": "A String", # [Output only] The time the cluster will be automatically

3048

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3049

"loggingService": "A String", # The logging service the cluster should use to write logs.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3050

# Currently available options:

3051

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3052

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

3053

# service with a Kubernetes-native resource model

3054

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

3055

# available as of GKE 1.15).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3056

# * `none` - no logs will be exported from the cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3057

#

3058

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

3059

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3060

"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]

3061

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3062

# "node_pool" object, since this configuration (along with the

3063

# "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]

3064

# auto-generated name. Do not use this and a node_pool at the same time.

3065

# For responses, this field will be populated with the node configuration of

3066

# the first node pool. (For configuration of each node pool, see

3067

# `node_pool.config`)

3068

#

3069

# If unspecified, the defaults are used.

3070

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3071

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3072

# valid sources or targets for network firewalls and are specified by

3073

# the client during cluster or node pool creation. Each tag within the list

3074

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3075

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3076

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3077

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3078

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3079

# Account is specified, the "default" service account is used.

3080

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3081

# the latest version of it will be used.

3082

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3083

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3084

#

3085

# The following scopes are recommended, but not required, and by default are

3086

# not included:

3087

#

3088

# * `https://www.googleapis.com/auth/compute` is required for mounting

3089

# persistent storage on your nodes.

3090

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3091

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3092

# (the [Google Container

3093

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3094

#

3095

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3096

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3097

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3098

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3099

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3100

#

3101

# For more information, including usage and the valid values, see:

3102

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3103

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3104

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3105

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3106

# See

3107

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3108

# for more information, including usage and the valid values.

3109

"key": "A String", # Key for taint.

3110

"value": "A String", # Value for taint.

3111

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3112

},

3113

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3114

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3115

# These will added in addition to any default label(s) that

3116

# Kubernetes may apply to the node.

3117

# In case of conflict in label keys, the applied set may differ depending on

3118

# the Kubernetes version -- it's best to assume the behavior is undefined

3119

# and conflicts should be avoided.

3120

# For more information, including usage and the valid values, see:

3121

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3122

"a_key": "A String",

3123

},

3124

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3125

# The smallest allowed disk size is 10GB.

3126

#

3127

# If unspecified, the default disk size is 100GB.

3128

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3129

# workloads on the node pool.

3130

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3131

# on the node pool.

3132

},

3133

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3134

# See https://cloud.google.com/compute/docs/gpus for more information about

3135

# support for GPUs.

3136

{ # AcceleratorConfig represents a Hardware Accelerator request.

3137

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3138

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3139

# [here](https://cloud.google.com/compute/docs/gpus)

3140

},

3141

],

3142

"machineType": "A String", # The name of a Google Compute Engine [machine

3143

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3144

# `n1-standard-1`).

3145

#

3146

# If unspecified, the default machine type is

3147

# `n1-standard-1`.

3148

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3149

#

3150

# If unspecified, the default disk type is 'pd-standard'

3151

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3152

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3153

#

3154

# Secure Boot helps ensure that the system only runs authentic software by

3155

# verifying the digital signature of all boot components, and halting the

3156

# boot process if signature verification fails.

3157

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3158

#

3159

# Enables monitoring and attestation of the boot integrity of the instance.

3160

# The attestation is performed against the integrity policy baseline. This

3161

# baseline is initially derived from the implicitly trusted boot image when

3162

# the instance is created.

3163

},

3164

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3165

# scheduled on the specified or newer CPU platform. Applicable values are the

3166

# friendly names of CPU platforms, such as

3167

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3168

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3169

# information, read [how to specify min CPU

3170

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3171

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3172

# https://cloud.google.com/compute/docs/instances/preemptible for more

3173

# information about preemptible VM instances.

3174

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3175

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3176

# The limit for this value is dependent upon the maximum number of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3177

# disks available on a machine per zone. See:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3178

# https://cloud.google.com/compute/docs/disks/local-ssd

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3179

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3180

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3181

"type": "A String", # Type of the sandbox to use for the node.

3182

},

3183

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3184

#

3185

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3186

# in length. These are reflected as part of a URL in the metadata server.

3187

# Additionally, to avoid ambiguity, keys must not conflict with any other

3188

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3194

# "enable-os-login"

3195

# "gci-ensure-gke-docker"

3196

# "gci-metrics-enabled"

3197

# "gci-update-strategy"

3198

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3203

# "windows-startup-script-ps1"

3204

# "common-psm1"

3205

# "k8s-node-setup-psm1"

3206

# "install-ssh-psm1"

3207

# "user-profile-psm1"

3208

# "serial-port-logging-enable"

3209

#

3210

# Values are free-form strings, and only have meaning as interpreted by

3211

# the image running in the instance. The only restriction placed on them is

3212

# that each value's size must be less than or equal to 32 KB.

3213

#

3214

# The total size of all keys and values must be less than 512 KB.

3215

"a_key": "A String",

3216

},

3217

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3218

# the specified [Zonal Compute

3219

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3220

# to this node pool.

3221

# is the configuration of desired reservation which instances could take

3222

# capacity from.

3223

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3224

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3225

# the key and specify the name of your reservation as its value.

3226

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3227

"A String",

3228

],

3229

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3230

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3231

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3232

"status": "A String", # [Output only] The current status of this cluster.

3233

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

3234

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

3235

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

3236

# cluster is connected. Example:

3237

# projects/my-project/regions/us-central1/subnetworks/my-subnet

3238

"network": "A String", # Output only. The relative name of the Google Compute Engine

3239

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

3240

# to which the cluster is connected. Example:

3241

# projects/my-project/global/networks/my-network

3242

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

3243

# This makes same node pod to pod traffic visible for VPC network.

3244

},

3245

"name": "A String", # The name of this cluster. The name must be unique within this project

3246

# and location (e.g. zone or region), and can be up to 40 characters with

3247

# the following restrictions:

3248

#

3249

# * Lowercase letters, numbers, and hyphens only.

3250

# * Must start with a letter.

3251

# * Must end with a number or a letter.

3252

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

3253

# The endpoint can be accessed from the internet at

3254

# `https://username:password@endpoint/`.

3255

#

3256

# See the `masterAuth` property of this resource for username and

3257

# password information.

3258

"location": "A String", # [Output only] The name of the Google Compute Engine

3259

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3260

# or

3261

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3262

# in which the cluster resides.

3263

"createTime": "A String", # [Output only] The time the cluster was created, in

3264

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3265

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3266

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3267

# notation (e.g. `10.96.0.0/14`). Leave blank to have

3268

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3269

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

3270

# required by Cluster Autoscaler to automatically adjust

3271

# the size of the cluster and create/delete

3272

# node pools based on the current needs.

3273

"autoprovisioningLocations": [ # The list of Google Compute Engine

3274

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3275

# NodePool's nodes can be created by NAP.

3276

"A String",

3277

],

3278

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

3279

# amount of resources in the cluster.

3280

{ # Contains information about amount of some resource in the cluster.

3281

# For memory, value should be in GB.

3282

"maximum": "A String", # Maximum amount of the resource in the cluster.

3283

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

3284

"minimum": "A String", # Minimum amount of the resource in the cluster.

3285

},

3286

],

3287

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

3288

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

3289

# created by NAP.

3290

# by NAP.

3291

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

3292

# specified, service_account should be empty.

3293

"A String",

3294

],

3295

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

3296

# node pool.

3297

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3298

# the Auto Upgrades will proceed.

3299

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3300

# with the description of the upgrade.

3301

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3302

# with the approximate start time for the upgrades, in

3303

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3304

},

3305

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

3306

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

3307

# up to date with the latest release version of Kubernetes.

3308

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

3309

# pool. If enabled, the nodes in this node pool will be monitored and, if

3310

# they fail health checks too many times, an automatic repair action will be

3311

# triggered.

3312

},

3313

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

3314

# disruption caused by an upgrade.

3315

#

3316

# maxUnavailable controls the number of nodes that can be simultaneously

3317

# unavailable.

3318

#

3319

# maxSurge controls the number of additional nodes that can be added to the

3320

# node pool temporarily for the time of the upgrade to increase the number of

3321

# available nodes.

3322

#

3323

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3324

# nodes are being upgraded at the same time).

3325

#

3326

# Note: upgrades inevitably introduce some disruption since workloads need to

3327

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3328

# this holds true. (Disruption stays within the limits of

3329

# PodDisruptionBudget, if it is configured.)

3330

#

3331

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3332

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3333

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3334

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3335

# there are always at least 4 nodes available.

3336

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3337

# the upgrade process. A node is considered available if its status is

3338

# Ready.

3339

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3340

# of the node pool during the upgrade process.

3341

},

3342

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

3343

# service_account is specified, scopes should be empty.

3344

},

3345

},

3346

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

3347

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3348

# is sufficient for this number of instances. You must also have available

3349

# firewall and routes quota.

3350

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3351

# "node_pool" object, since this configuration (along with the

3352

# "node_config") will be used to create a "NodePool" object with an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3353

# auto-generated name. Do not use this and a node_pool at the same time.

3354

#

3355

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3356

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

3357

"A String",

3358

],

3359

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

3360

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

3361

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

3362

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

3363

# given only RFC 1918 private addresses and communicate with the master via

3364

# private networking.

3365

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

3366

# range will be used for assigning internal IP addresses to the master or

3367

# set of masters, as well as the ILB VIP. This range must not overlap with

3368

# any other ranges in use within the cluster's network.

3369

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

3370

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

3371

},

3372

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

3373

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

3374

},

3375

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

3376

# required by Vertical Pod Autoscaler to automatically adjust

3377

# the resources of pods controlled by it.

3378

"enabled": True or False, # Enables vertical pod autoscaling.

3379

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3380

},

3381

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3382

"missingZones": [ # If any zones are listed here, the list of clusters returned

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3383

# may be missing those zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3384

"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]

3390

<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]

3391

<pre>Sets the addons for a specific cluster.

3392

3393

Args:

3394

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]

3395

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3396

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3397

The object takes the form of:

3398

3399

{ # SetAddonsConfigRequest sets the addons associated with the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3400

"name": "A String", # The name (project, location, cluster) of the cluster to set addons.

3401

# Specified in the format `projects/*/locations/*/clusters/*`.

3402

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3403

# number](https://support.google.com/cloud/answer/6158840).

3404

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3405

"zone": "A String", # Deprecated. The name of the Google Compute Engine

3406

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3407

# cluster resides. This field has been deprecated and replaced by the name

3408

# field.

3409

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3410

# This field has been deprecated and replaced by the name field.

3411

"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]

3412

# cluster.

3413

# cluster, enabling additional functionality.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3414

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

3415

# is enabled or not on the Master, it does not track whether network policy

3416

# is enabled for the nodes.

3417

# is enabled or not on the Master, it does not track whether network policy

3418

# is enabled for the nodes.

3419

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

3420

},

3421

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

3422

# managed Knative service.

3423

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

3424

},

3425

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

3426

# increases or decreases the number of replica pods a replication controller

3427

# has based on the resource usage of the existing pods.

3428

# increases or decreases the number of replica pods a replication controller

3429

# has based on the resource usage of the existing pods.

3430

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

3431

# When enabled, it ensures that metrics are collected into Stackdriver

3432

# Monitoring.

3433

},

3434

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3435

# makes it easy to set up HTTP load balancers for services in a cluster.

3436

# which makes it easy to set up HTTP load balancers for services in a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3437

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3438

# When enabled, it runs a small pod in the cluster that manages the load

3439

# balancers.

3440

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3441

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3442

# This addon is deprecated, and will be disabled in 1.15. It is recommended

3443

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

3444

# workloads and applications. For more information, see:

3445

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3446

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3447

},

3448

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3449

}

3450

3451

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3458

3459

{ # This operation resource represents operations that may have happened or are

3460

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3461

"name": "A String", # The server-assigned ID for the operation.

3462

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3463

{ # StatusCondition describes why a cluster or a node pool has a certain status

3464

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3465

"message": "A String", # Human-friendly representation of the condition

3466

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3467

},

3468

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3469

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3470

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3471

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3472

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3473

# or

3474

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3475

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3476

"startTime": "A String", # [Output only] The time the operation started, in

3477

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3478

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3479

"stages": [ # Substages of an operation or a stage.

3480

# Object with schema name: OperationProgress

3481

],

3482

"status": "A String", # Status of an operation stage.

3483

# Unset for single-stage operations.

3484

"metrics": [ # Progress metric bundle, for example:

3485

# metrics: [{name: "nodes done", int_value: 15},

3486

# {name: "nodes total", int_value: 32}]

3487

# or

3488

# metrics: [{name: "progress", double_value: 0.56},

3489

# {name: "progress scale", double_value: 1.0}]

3490

{ # Progress metric is (string, int|float|string) pair.

3491

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3492

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3493

"doubleValue": 3.14, # For metrics with floating point value.

3494

"intValue": "A String", # For metrics with integer value.

3495

},

3496

],

3497

"name": "A String", # A non-parameterized string describing an operation stage.

3498

# Unset for single-stage operations.

3499

},

3500

"clusterConditions": [ # Which conditions caused the current cluster state.

3501

{ # StatusCondition describes why a cluster or a node pool has a certain status

3502

# (e.g., ERROR or DEGRADED).

3503

"message": "A String", # Human-friendly representation of the condition

3504

"code": "A String", # Machine-friendly representation of the condition

3505

},

3506

],

3507

"zone": "A String", # The name of the Google Compute Engine

3508

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3509

# operation is taking place. This field is deprecated, use location instead.

3510

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3511

"selfLink": "A String", # Server-defined URL for the resource.

3512

"detail": "A String", # Detailed operation progress, if available.

3513

"targetLink": "A String", # Server-defined URL for the target of the operation.

3514

"operationType": "A String", # The operation type.

3515

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3520

<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]

3521

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

3522

3523

Args:

3524

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]

3525

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3526

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3527

The object takes the form of:

3528

3529

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for

3530

# a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3531

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac.

3532

# Specified in the format `projects/*/locations/*/clusters/*`.

3533

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

3534

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3535

# number](https://support.google.com/cloud/answer/6158840).

3536

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3537

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3538

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3539

# cluster resides. This field has been deprecated and replaced by the name

3540

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3541

"clusterId": "A String", # Deprecated. The name of the cluster to update.

3542

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3543

}

3544

3545

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3552

3553

{ # This operation resource represents operations that may have happened or are

3554

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3555

"name": "A String", # The server-assigned ID for the operation.

3556

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3557

{ # StatusCondition describes why a cluster or a node pool has a certain status

3558

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3559

"message": "A String", # Human-friendly representation of the condition

3560

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3561

},

3562

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3563

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3564

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3565

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3566

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3567

# or

3568

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3569

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3570

"startTime": "A String", # [Output only] The time the operation started, in

3571

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3572

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3573

"stages": [ # Substages of an operation or a stage.

3574

# Object with schema name: OperationProgress

3575

],

3576

"status": "A String", # Status of an operation stage.

3577

# Unset for single-stage operations.

3578

"metrics": [ # Progress metric bundle, for example:

3579

# metrics: [{name: "nodes done", int_value: 15},

3580

# {name: "nodes total", int_value: 32}]

3581

# or

3582

# metrics: [{name: "progress", double_value: 0.56},

3583

# {name: "progress scale", double_value: 1.0}]

3584

{ # Progress metric is (string, int|float|string) pair.

3585

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3586

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3587

"doubleValue": 3.14, # For metrics with floating point value.

3588

"intValue": "A String", # For metrics with integer value.

3589

},

3590

],

3591

"name": "A String", # A non-parameterized string describing an operation stage.

3592

# Unset for single-stage operations.

3593

},

3594

"clusterConditions": [ # Which conditions caused the current cluster state.

3595

{ # StatusCondition describes why a cluster or a node pool has a certain status

3596

# (e.g., ERROR or DEGRADED).

3597

"message": "A String", # Human-friendly representation of the condition

3598

"code": "A String", # Machine-friendly representation of the condition

3599

},

3600

],

3601

"zone": "A String", # The name of the Google Compute Engine

3602

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3603

# operation is taking place. This field is deprecated, use location instead.

3604

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3605

"selfLink": "A String", # Server-defined URL for the resource.

3606

"detail": "A String", # Detailed operation progress, if available.

3607

"targetLink": "A String", # Server-defined URL for the target of the operation.

3608

"operationType": "A String", # The operation type.

3609

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3614

<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]

3615

<pre>Sets the locations for a specific cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3616

Deprecated. Use

3617

[projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update)

3618

instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3619

3620

Args:

3621

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]

3622

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3623

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3624

The object takes the form of:

3625

3626

{ # SetLocationsRequest sets the locations of the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3627

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3628

# number](https://support.google.com/cloud/answer/6158840).

3629

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3630

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3631

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3632

# cluster resides. This field has been deprecated and replaced by the name

3633

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3634

"locations": [ # Required. The desired list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3635

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3636

# 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]

3637

# will result in nodes being either created or removed from the cluster,

3638

# depending on whether locations are being added or removed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3639

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3640

# This list must always include the cluster's primary zone.

3641

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3642

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3643

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3644

# This field has been deprecated and replaced by the name field.

3645

"name": "A String", # The name (project, location, cluster) of the cluster to set locations.

3646

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3647

}

3648

3649

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3656

3657

{ # This operation resource represents operations that may have happened or are

3658

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3659

"name": "A String", # The server-assigned ID for the operation.

3660

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3661

{ # StatusCondition describes why a cluster or a node pool has a certain status

3662

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3663

"message": "A String", # Human-friendly representation of the condition

3664

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3665

},

3666

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3667

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3668

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3669

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3670

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3671

# or

3672

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3673

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3674

"startTime": "A String", # [Output only] The time the operation started, in

3675

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3676

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3677

"stages": [ # Substages of an operation or a stage.

3678

# Object with schema name: OperationProgress

3679

],

3680

"status": "A String", # Status of an operation stage.

3681

# Unset for single-stage operations.

3682

"metrics": [ # Progress metric bundle, for example:

3683

# metrics: [{name: "nodes done", int_value: 15},

3684

# {name: "nodes total", int_value: 32}]

3685

# or

3686

# metrics: [{name: "progress", double_value: 0.56},

3687

# {name: "progress scale", double_value: 1.0}]

3688

{ # Progress metric is (string, int|float|string) pair.

3689

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3690

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3691

"doubleValue": 3.14, # For metrics with floating point value.

3692

"intValue": "A String", # For metrics with integer value.

3693

},

3694

],

3695

"name": "A String", # A non-parameterized string describing an operation stage.

3696

# Unset for single-stage operations.

3697

},

3698

"clusterConditions": [ # Which conditions caused the current cluster state.

3699

{ # StatusCondition describes why a cluster or a node pool has a certain status

3700

# (e.g., ERROR or DEGRADED).

3701

"message": "A String", # Human-friendly representation of the condition

3702

"code": "A String", # Machine-friendly representation of the condition

3703

},

3704

],

3705

"zone": "A String", # The name of the Google Compute Engine

3706

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3707

# operation is taking place. This field is deprecated, use location instead.

3708

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3709

"selfLink": "A String", # Server-defined URL for the resource.

3710

"detail": "A String", # Detailed operation progress, if available.

3711

"targetLink": "A String", # Server-defined URL for the target of the operation.

3712

"operationType": "A String", # The operation type.

3713

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3718

<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]

3719

<pre>Sets the logging service for a specific cluster.

3720

3721

Args:

3722

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]

3723

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3724

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3725

The object takes the form of:

3726

3727

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3728

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3729

# number](https://support.google.com/cloud/answer/6158840).

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

"zone": "A String", # Deprecated. The name of the Google Compute Engine

3732

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3733

# cluster resides. This field has been deprecated and replaced by the name

3734

# field.

3735

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3736

# This field has been deprecated and replaced by the name field.

3737

"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]

3738

# Currently available options:

3739

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3740

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

3741

# service with a Kubernetes-native resource model

3742

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

3743

# available as of GKE 1.15).

3744

# * `none` - no logs will be exported from the cluster.

3745

#

3746

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

3747

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3748

"name": "A String", # The name (project, location, cluster) of the cluster to set logging.

3749

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3750

}

3751

3752

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3759

3760

{ # This operation resource represents operations that may have happened or are

3761

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3762

"name": "A String", # The server-assigned ID for the operation.

3763

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3764

{ # StatusCondition describes why a cluster or a node pool has a certain status

3765

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3766

"message": "A String", # Human-friendly representation of the condition

3767

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3768

},

3769

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3770

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3771

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3772

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3773

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3774

# or

3775

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3776

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3777

"startTime": "A String", # [Output only] The time the operation started, in

3778

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3779

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3780

"stages": [ # Substages of an operation or a stage.

3781

# Object with schema name: OperationProgress

3782

],

3783

"status": "A String", # Status of an operation stage.

3784

# Unset for single-stage operations.

3785

"metrics": [ # Progress metric bundle, for example:

3786

# metrics: [{name: "nodes done", int_value: 15},

3787

# {name: "nodes total", int_value: 32}]

3788

# or

3789

# metrics: [{name: "progress", double_value: 0.56},

3790

# {name: "progress scale", double_value: 1.0}]

3791

{ # Progress metric is (string, int|float|string) pair.

3792

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3793

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3794

"doubleValue": 3.14, # For metrics with floating point value.

3795

"intValue": "A String", # For metrics with integer value.

3796

},

3797

],

3798

"name": "A String", # A non-parameterized string describing an operation stage.

3799

# Unset for single-stage operations.

3800

},

3801

"clusterConditions": [ # Which conditions caused the current cluster state.

3802

{ # StatusCondition describes why a cluster or a node pool has a certain status

3803

# (e.g., ERROR or DEGRADED).

3804

"message": "A String", # Human-friendly representation of the condition

3805

"code": "A String", # Machine-friendly representation of the condition

3806

},

3807

],

3808

"zone": "A String", # The name of the Google Compute Engine

3809

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3810

# operation is taking place. This field is deprecated, use location instead.

3811

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3812

"selfLink": "A String", # Server-defined URL for the resource.

3813

"detail": "A String", # Detailed operation progress, if available.

3814

"targetLink": "A String", # Server-defined URL for the target of the operation.

3815

"operationType": "A String", # The operation type.

3816

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3821

<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]

3822

<pre>Sets the maintenance policy for a cluster.

3823

3824

Args:

3825

name: string, The name (project, location, cluster id) of the cluster to set maintenance

3826

policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3827

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3828

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3829

The object takes the form of:

3830

3831

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3832

"clusterId": "A String", # Required. The name of the cluster to update.

3833

"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]

3834

# clears the existing maintenance policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3835

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

3836

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

3837

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

3838

# smallest possible in the given scenario.

3839

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

3840

# format "PTnHnMnS".

3841

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

3842

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

3843

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

3844

},

3845

"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]

3846

# maintenance to occur. The time windows may be overlapping. If no

3847

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3848

"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]

3849

# this window reccurs. They go on for the span of time between the start and

3850

# end time.

3851

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3852

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3853

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

3854

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

3855

# <code>FREQ=DAILY</code>

3856

# For the first weekend of every month:

3857

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

3858

# 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]

3859

# 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]

3860

# <code>

3861

# start time = 2019-01-01T09:00:00-0400

3862

# end time = 2019-01-01T17:00:00-0400

3863

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

3864

# </code>

3865

# Windows can span multiple days. Eg, to make the window encompass every

3866

# weekend from midnight Saturday till the last minute of Sunday UTC:

3867

# <code>

3868

# start time = 2019-01-05T00:00:00Z

3869

# end time = 2019-01-07T23:59:00Z

3870

# recurrence = FREQ=WEEKLY;BYDAY=SA

3871

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3872

# 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]

3873

# to specify duration of the window and when it first starts.

3874

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3875

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

3876

"endTime": "A String", # The time that the window ends. The end time should take place after the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3877

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3878

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3879

},

3880

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3881

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3882

# occur in these windows.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3883

"a_key": { # Represents an arbitrary window of time.

3884

"endTime": "A String", # The time that the window ends. The end time should take place after the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3885

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3886

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3887

},

3888

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3889

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3890

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

3891

# the policy won't accidentally undo intermediate changes (and so that users

3892

# 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]

3893

# Make a <code>get()</code> request to the cluster to get the current

3894

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3895

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3896

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3897

# policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3898

# Specified in the format `projects/*/locations/*/clusters/*`.

3899

"projectId": "A String", # Required. The Google Developers Console [project ID or project

3900

# number](https://support.google.com/cloud/answer/6158840).

3901

"zone": "A String", # Required. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3902

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3903

# cluster resides.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3904

}

3905

3906

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3913

3914

{ # This operation resource represents operations that may have happened or are

3915

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3916

"name": "A String", # The server-assigned ID for the operation.

3917

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3918

{ # StatusCondition describes why a cluster or a node pool has a certain status

3919

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3920

"message": "A String", # Human-friendly representation of the condition

3921

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3922

},

3923

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3924

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3925

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3926

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3927

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3928

# or

3929

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3930

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3931

"startTime": "A String", # [Output only] The time the operation started, in

3932

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3933

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3934

"stages": [ # Substages of an operation or a stage.

3935

# Object with schema name: OperationProgress

3936

],

3937

"status": "A String", # Status of an operation stage.

3938

# Unset for single-stage operations.

3939

"metrics": [ # Progress metric bundle, for example:

3940

# metrics: [{name: "nodes done", int_value: 15},

3941

# {name: "nodes total", int_value: 32}]

3942

# or

3943

# metrics: [{name: "progress", double_value: 0.56},

3944

# {name: "progress scale", double_value: 1.0}]

3945

{ # Progress metric is (string, int|float|string) pair.

3946

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3947

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3948

"doubleValue": 3.14, # For metrics with floating point value.

3949

"intValue": "A String", # For metrics with integer value.

3950

},

3951

],

3952

"name": "A String", # A non-parameterized string describing an operation stage.

3953

# Unset for single-stage operations.

3954

},

3955

"clusterConditions": [ # Which conditions caused the current cluster state.

3956

{ # StatusCondition describes why a cluster or a node pool has a certain status

3957

# (e.g., ERROR or DEGRADED).

3958

"message": "A String", # Human-friendly representation of the condition

3959

"code": "A String", # Machine-friendly representation of the condition

3960

},

3961

],

3962

"zone": "A String", # The name of the Google Compute Engine

3963

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3964

# operation is taking place. This field is deprecated, use location instead.

3965

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3966

"selfLink": "A String", # Server-defined URL for the resource.

3967

"detail": "A String", # Detailed operation progress, if available.

3968

"targetLink": "A String", # Server-defined URL for the target of the operation.

3969

"operationType": "A String", # The operation type.

3970

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3975

<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]

3976

<pre>Sets master auth materials. Currently supports changing the admin password

3977

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]

3982

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3983

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3984

The object takes the form of:

3985

3986

{ # SetMasterAuthRequest updates the admin password of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3987

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3988

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3989

# cluster resides. This field has been deprecated and replaced by the name

3990

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3991

"name": "A String", # The name (project, location, cluster) of the cluster to set auth.

3992

# Specified in the format `projects/*/locations/*/clusters/*`.

3993

"action": "A String", # Required. The exact form of action to be taken on the master auth.

3994

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3995

# number](https://support.google.com/cloud/answer/6158840).

3996

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3997

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3998

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3999

"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]

4000

# Authentication can be done using HTTP basic auth or using client

4001

# certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4002

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

4003

# trust for the cluster.

4004

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

4005

# authenticate to the cluster endpoint.

4006

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4007

# For clusters v1.6.0 and later, basic authentication can be disabled by

4008

# leaving username unspecified (or setting it to the empty string).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4009

"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]

4010

# Because the master endpoint is open to the Internet, you should create a

4011

# strong password. If a password is provided for cluster creation, username

4012

# must be non-empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4013

"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]

4014

# clusters before v1.12, if no configuration is specified, a client

4015

# certificate is issued.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4016

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4017

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4018

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

4019

# to the cluster endpoint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4020

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4021

}

4022

4023

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4030

4031

{ # This operation resource represents operations that may have happened or are

4032

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4033

"name": "A String", # The server-assigned ID for the operation.

4034

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4035

{ # StatusCondition describes why a cluster or a node pool has a certain status

4036

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4037

"message": "A String", # Human-friendly representation of the condition

4038

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4039

},

4040

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4041

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4042

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4043

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4044

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4045

# or

4046

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4047

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4048

"startTime": "A String", # [Output only] The time the operation started, in

4049

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4050

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4051

"stages": [ # Substages of an operation or a stage.

4052

# Object with schema name: OperationProgress

4053

],

4054

"status": "A String", # Status of an operation stage.

4055

# Unset for single-stage operations.

4056

"metrics": [ # Progress metric bundle, for example:

4057

# metrics: [{name: "nodes done", int_value: 15},

4058

# {name: "nodes total", int_value: 32}]

4059

# or

4060

# metrics: [{name: "progress", double_value: 0.56},

4061

# {name: "progress scale", double_value: 1.0}]

4062

{ # Progress metric is (string, int|float|string) pair.

4063

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4064

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4065

"doubleValue": 3.14, # For metrics with floating point value.

4066

"intValue": "A String", # For metrics with integer value.

4067

},

4068

],

4069

"name": "A String", # A non-parameterized string describing an operation stage.

4070

# Unset for single-stage operations.

4071

},

4072

"clusterConditions": [ # Which conditions caused the current cluster state.

4073

{ # StatusCondition describes why a cluster or a node pool has a certain status

4074

# (e.g., ERROR or DEGRADED).

4075

"message": "A String", # Human-friendly representation of the condition

4076

"code": "A String", # Machine-friendly representation of the condition

4077

},

4078

],

4079

"zone": "A String", # The name of the Google Compute Engine

4080

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4081

# operation is taking place. This field is deprecated, use location instead.

4082

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4083

"selfLink": "A String", # Server-defined URL for the resource.

4084

"detail": "A String", # Detailed operation progress, if available.

4085

"targetLink": "A String", # Server-defined URL for the target of the operation.

4086

"operationType": "A String", # The operation type.

4087

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4092

<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]

4093

<pre>Sets the monitoring service for a specific cluster.

4094

4095

Args:

4096

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]

4097

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4098

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4099

The object takes the form of:

4100

4101

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4102

"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]

4103

# Currently available options:

4104

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4105

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4106

# service with a Kubernetes-native resource model

4107

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4108

# longer available as of GKE 1.15).

4109

# * `none` - No metrics will be exported from the cluster.

4110

#

4111

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4112

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4113

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring.

4114

# Specified in the format `projects/*/locations/*/clusters/*`.

4115

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4116

# number](https://support.google.com/cloud/answer/6158840).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4117

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4118

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4119

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4120

# cluster resides. This field has been deprecated and replaced by the name

4121

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4122

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

4123

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4124

}

4125

4126

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4133

4134

{ # This operation resource represents operations that may have happened or are

4135

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4136

"name": "A String", # The server-assigned ID for the operation.

4137

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4138

{ # StatusCondition describes why a cluster or a node pool has a certain status

4139

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4140

"message": "A String", # Human-friendly representation of the condition

4141

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4142

},

4143

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4144

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4145

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4146

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4147

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4148

# or

4149

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4150

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4151

"startTime": "A String", # [Output only] The time the operation started, in

4152

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4153

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4154

"stages": [ # Substages of an operation or a stage.

4155

# Object with schema name: OperationProgress

4156

],

4157

"status": "A String", # Status of an operation stage.

4158

# Unset for single-stage operations.

4159

"metrics": [ # Progress metric bundle, for example:

4160

# metrics: [{name: "nodes done", int_value: 15},

4161

# {name: "nodes total", int_value: 32}]

4162

# or

4163

# metrics: [{name: "progress", double_value: 0.56},

4164

# {name: "progress scale", double_value: 1.0}]

4165

{ # Progress metric is (string, int|float|string) pair.

4166

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4167

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4168

"doubleValue": 3.14, # For metrics with floating point value.

4169

"intValue": "A String", # For metrics with integer value.

4170

},

4171

],

4172

"name": "A String", # A non-parameterized string describing an operation stage.

4173

# Unset for single-stage operations.

4174

},

4175

"clusterConditions": [ # Which conditions caused the current cluster state.

4176

{ # StatusCondition describes why a cluster or a node pool has a certain status

4177

# (e.g., ERROR or DEGRADED).

4178

"message": "A String", # Human-friendly representation of the condition

4179

"code": "A String", # Machine-friendly representation of the condition

4180

},

4181

],

4182

"zone": "A String", # The name of the Google Compute Engine

4183

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4184

# operation is taking place. This field is deprecated, use location instead.

4185

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4186

"selfLink": "A String", # Server-defined URL for the resource.

4187

"detail": "A String", # Detailed operation progress, if available.

4188

"targetLink": "A String", # Server-defined URL for the target of the operation.

4189

"operationType": "A String", # The operation type.

4190

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4195

<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]

4196

<pre>Enables or disables Network Policy for a cluster.

4197

4198

Args:

4199

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]

4200

policy. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4201

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4202

The object takes the form of:

4203

4204

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4205

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4206

# number](https://developers.google.com/console/help/new/#projectnumber).

4207

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4208

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4209

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4210

# cluster resides. This field has been deprecated and replaced by the name

4211

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4212

"clusterId": "A String", # Deprecated. The name of the cluster.

4213

# This field has been deprecated and replaced by the name field.

4214

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature.

4215

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

4216

"provider": "A String", # The selected network policy provider.

4217

"enabled": True or False, # Whether network policy is enabled on the cluster.

4218

},

4219

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking

4220

# policy. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4221

}

4222

4223

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4230

4231

{ # This operation resource represents operations that may have happened or are

4232

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4233

"name": "A String", # The server-assigned ID for the operation.

4234

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4235

{ # StatusCondition describes why a cluster or a node pool has a certain status

4236

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4237

"message": "A String", # Human-friendly representation of the condition

4238

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4239

},

4240

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4241

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4242

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4243

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4244

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4245

# or

4246

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4247

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4248

"startTime": "A String", # [Output only] The time the operation started, in

4249

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4250

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4251

"stages": [ # Substages of an operation or a stage.

4252

# Object with schema name: OperationProgress

4253

],

4254

"status": "A String", # Status of an operation stage.

4255

# Unset for single-stage operations.

4256

"metrics": [ # Progress metric bundle, for example:

4257

# metrics: [{name: "nodes done", int_value: 15},

4258

# {name: "nodes total", int_value: 32}]

4259

# or

4260

# metrics: [{name: "progress", double_value: 0.56},

4261

# {name: "progress scale", double_value: 1.0}]

4262

{ # Progress metric is (string, int|float|string) pair.

4263

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4264

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4265

"doubleValue": 3.14, # For metrics with floating point value.

4266

"intValue": "A String", # For metrics with integer value.

4267

},

4268

],

4269

"name": "A String", # A non-parameterized string describing an operation stage.

4270

# Unset for single-stage operations.

4271

},

4272

"clusterConditions": [ # Which conditions caused the current cluster state.

4273

{ # StatusCondition describes why a cluster or a node pool has a certain status

4274

# (e.g., ERROR or DEGRADED).

4275

"message": "A String", # Human-friendly representation of the condition

4276

"code": "A String", # Machine-friendly representation of the condition

4277

},

4278

],

4279

"zone": "A String", # The name of the Google Compute Engine

4280

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4281

# operation is taking place. This field is deprecated, use location instead.

4282

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4283

"selfLink": "A String", # Server-defined URL for the resource.

4284

"detail": "A String", # Detailed operation progress, if available.

4285

"targetLink": "A String", # Server-defined URL for the target of the operation.

4286

"operationType": "A String", # The operation type.

4287

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4292

<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]

4293

<pre>Sets labels on a cluster.

4294

4295

Args:

4296

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]

4297

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4298

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4299

The object takes the form of:

4300

4301

{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container

4302

# Engine cluster, which will in turn set them for Google Compute Engine

4303

# resources used by that cluster

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4304

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels.

4305

# Specified in the format `projects/*/locations/*/clusters/*`.

4306

"resourceLabels": { # Required. The labels to set for that cluster.

4307

"a_key": "A String",

4308

},

4309

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4310

# number](https://developers.google.com/console/help/new/#projectnumber).

4311

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4312

"clusterId": "A String", # Deprecated. The name of the cluster.

4313

# This field has been deprecated and replaced by the name field.

4314

"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]

4315

# used to detect conflicts. The fingerprint is initially generated by

4316

# Kubernetes Engine and changes after every request to modify or update

4317

# labels. You must always provide an up-to-date fingerprint hash when

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4318

# updating or changing labels. Make a <code>get()</code> request to the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4319

# resource to get the latest fingerprint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4320

"zone": "A String", # Deprecated. The name of the Google Compute Engine

4321

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4322

# cluster resides. This field has been deprecated and replaced by the name

4323

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4324

}

4325

4326

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4333

4334

{ # This operation resource represents operations that may have happened or are

4335

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4336

"name": "A String", # The server-assigned ID for the operation.

4337

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4338

{ # StatusCondition describes why a cluster or a node pool has a certain status

4339

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4340

"message": "A String", # Human-friendly representation of the condition

4341

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4342

},

4343

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4344

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4345

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4346

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4347

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4348

# or

4349

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4350

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4351

"startTime": "A String", # [Output only] The time the operation started, in

4352

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4353

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4354

"stages": [ # Substages of an operation or a stage.

4355

# Object with schema name: OperationProgress

4356

],

4357

"status": "A String", # Status of an operation stage.

4358

# Unset for single-stage operations.

4359

"metrics": [ # Progress metric bundle, for example:

4360

# metrics: [{name: "nodes done", int_value: 15},

4361

# {name: "nodes total", int_value: 32}]

4362

# or

4363

# metrics: [{name: "progress", double_value: 0.56},

4364

# {name: "progress scale", double_value: 1.0}]

4365

{ # Progress metric is (string, int|float|string) pair.

4366

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4367

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4368

"doubleValue": 3.14, # For metrics with floating point value.

4369

"intValue": "A String", # For metrics with integer value.

4370

},

4371

],

4372

"name": "A String", # A non-parameterized string describing an operation stage.

4373

# Unset for single-stage operations.

4374

},

4375

"clusterConditions": [ # Which conditions caused the current cluster state.

4376

{ # StatusCondition describes why a cluster or a node pool has a certain status

4377

# (e.g., ERROR or DEGRADED).

4378

"message": "A String", # Human-friendly representation of the condition

4379

"code": "A String", # Machine-friendly representation of the condition

4380

},

4381

],

4382

"zone": "A String", # The name of the Google Compute Engine

4383

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4384

# operation is taking place. This field is deprecated, use location instead.

4385

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4386

"selfLink": "A String", # Server-defined URL for the resource.

4387

"detail": "A String", # Detailed operation progress, if available.

4388

"targetLink": "A String", # Server-defined URL for the target of the operation.

4389

"operationType": "A String", # The operation type.

4390

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4395

<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]

4396

<pre>Starts master IP rotation.

4397

4398

Args:

4399

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]

4400

rotation. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4401

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4402

The object takes the form of:

4403

4404

{ # StartIPRotationRequest creates a new IP for the cluster and then performs

4405

# a node upgrade on each node pool to point to the new IP.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4406

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4407

# number](https://developers.google.com/console/help/new/#projectnumber).

4408

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4409

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4410

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4411

# cluster resides. This field has been deprecated and replaced by the name

4412

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4413

"clusterId": "A String", # Deprecated. The name of the cluster.

4414

# This field has been deprecated and replaced by the name field.

4415

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

4416

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP

4417

# rotation. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4418

}

4419

4420

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4427

4428

{ # This operation resource represents operations that may have happened or are

4429

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4430

"name": "A String", # The server-assigned ID for the operation.

4431

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4432

{ # StatusCondition describes why a cluster or a node pool has a certain status

4433

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4434

"message": "A String", # Human-friendly representation of the condition

4435

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4436

},

4437

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4438

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4439

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4440

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4441

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4442

# or

4443

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4444

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4445

"startTime": "A String", # [Output only] The time the operation started, in

4446

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4447

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4448

"stages": [ # Substages of an operation or a stage.

4449

# Object with schema name: OperationProgress

4450

],

4451

"status": "A String", # Status of an operation stage.

4452

# Unset for single-stage operations.

4453

"metrics": [ # Progress metric bundle, for example:

4454

# metrics: [{name: "nodes done", int_value: 15},

4455

# {name: "nodes total", int_value: 32}]

4456

# or

4457

# metrics: [{name: "progress", double_value: 0.56},

4458

# {name: "progress scale", double_value: 1.0}]

4459

{ # Progress metric is (string, int|float|string) pair.

4460

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4461

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4462

"doubleValue": 3.14, # For metrics with floating point value.

4463

"intValue": "A String", # For metrics with integer value.

4464

},

4465

],

4466

"name": "A String", # A non-parameterized string describing an operation stage.

4467

# Unset for single-stage operations.

4468

},

4469

"clusterConditions": [ # Which conditions caused the current cluster state.

4470

{ # StatusCondition describes why a cluster or a node pool has a certain status

4471

# (e.g., ERROR or DEGRADED).

4472

"message": "A String", # Human-friendly representation of the condition

4473

"code": "A String", # Machine-friendly representation of the condition

4474

},

4475

],

4476

"zone": "A String", # The name of the Google Compute Engine

4477

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4478

# operation is taking place. This field is deprecated, use location instead.

4479

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4480

"selfLink": "A String", # Server-defined URL for the resource.

4481

"detail": "A String", # Detailed operation progress, if available.

4482

"targetLink": "A String", # Server-defined URL for the target of the operation.

4483

"operationType": "A String", # The operation type.

4484

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4489

<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]

4490

<pre>Updates the settings of a specific cluster.

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4494

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4495

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4496

The object takes the form of:

4497

4498

{ # UpdateClusterRequest updates the settings of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4499

"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]

4500

# be applied to a cluster with each request, so at most one field can be

4501

# provided.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4502

"desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4503

# cluster, enabling additional functionality.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4504

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

4505

# is enabled or not on the Master, it does not track whether network policy

4506

# is enabled for the nodes.

4507

# is enabled or not on the Master, it does not track whether network policy

4508

# is enabled for the nodes.

4509

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

4510

},

4511

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

4512

# managed Knative service.

4513

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

4514

},

4515

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

4516

# increases or decreases the number of replica pods a replication controller

4517

# has based on the resource usage of the existing pods.

4518

# increases or decreases the number of replica pods a replication controller

4519

# has based on the resource usage of the existing pods.

4520

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

4521

# When enabled, it ensures that metrics are collected into Stackdriver

4522

# Monitoring.

4523

},

4524

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4525

# makes it easy to set up HTTP load balancers for services in a cluster.

4526

# which makes it easy to set up HTTP load balancers for services in a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4527

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4528

# When enabled, it runs a small pod in the cluster that manages the load

4529

# balancers.

4530

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4531

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4532

# This addon is deprecated, and will be disabled in 1.15. It is recommended

4533

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

4534

# workloads and applications. For more information, see:

4535

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4536

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4537

},

4538

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4539

"desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an

4540

# upgrade).

4541

#

4542

# Users may specify either explicit versions offered by

4543

# Kubernetes Engine or version aliases, which have the following behavior:

4544

#

4545

# - "latest": picks the highest valid Kubernetes version

4546

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4547

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4548

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4549

# - "-": picks the Kubernetes master version

4550

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility.

4551

# visibility on this cluster.

4552

"enabled": True or False, # Enables intra node visibility for this cluster.

4553

},

4554

"desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4555

# required by Cluster Autoscaler to automatically adjust

4556

# the size of the cluster and create/delete

4557

# node pools based on the current needs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4558

"autoprovisioningLocations": [ # The list of Google Compute Engine

4559

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4560

# NodePool's nodes can be created by NAP.

4561

"A String",

4562

],

4563

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

4564

# amount of resources in the cluster.

4565

{ # Contains information about amount of some resource in the cluster.

4566

# For memory, value should be in GB.

4567

"maximum": "A String", # Maximum amount of the resource in the cluster.

4568

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

4569

"minimum": "A String", # Minimum amount of the resource in the cluster.

4570

},

4571

],

4572

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

4573

"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]

4574

# created by NAP.

4575

# by NAP.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4576

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

4577

# specified, service_account should be empty.

4578

"A String",

4579

],

4580

"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]

4581

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4582

"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]

4583

# the Auto Upgrades will proceed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4584

"description": "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]

4585

# with the description of the upgrade.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4586

"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]

4587

# with the approximate start time for the upgrades, in

4588

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4589

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4590

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4591

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

4592

# up to date with the latest release version of Kubernetes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4593

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

4594

# pool. If enabled, the nodes in this node pool will be monitored and, if

4595

# they fail health checks too many times, an automatic repair action will be

4596

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4597

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4598

"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]

4599

# disruption caused by an upgrade.

4600

#

4601

# maxUnavailable controls the number of nodes that can be simultaneously

4602

# unavailable.

4603

#

4604

# maxSurge controls the number of additional nodes that can be added to the

4605

# node pool temporarily for the time of the upgrade to increase the number of

4606

# available nodes.

4607

#

4608

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

4609

# nodes are being upgraded at the same time).

4610

#

4611

# Note: upgrades inevitably introduce some disruption since workloads need to

4612

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

4613

# this holds true. (Disruption stays within the limits of

4614

# PodDisruptionBudget, if it is configured.)

4615

#

4616

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

4617

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

4618

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

4619

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

4620

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4621

"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]

4622

# the upgrade process. A node is considered available if its status is

4623

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4624

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

4625

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4626

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4627

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

4628

# service_account is specified, scopes should be empty.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4629

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4630

},

4631

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

4632

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

4633

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

4634

"state": "A String", # Denotes the state of etcd encryption.

4635

},

4636

"desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature.

4637

# master authorized networks will disallow all external traffic to access

4638

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

4639

# Google Compute Engine Public IPs and Google Prod IPs.

4640

"enabled": True or False, # Whether or not master authorized networks is enabled.

4641

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

4642

# Kubernetes master through HTTPS.

4643

{ # CidrBlock contains an optional name and one CIDR block.

4644

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

4645

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4646

},

4647

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4648

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4649

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

4650

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

4651

# daemonset will be created in the cluster to meter network egress traffic.

4652

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

4653

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

4654

# second BigQuery table will be created to hold resource consumption

4655

# records.

4656

},

4657

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

4658

"datasetId": "A String", # The ID of a BigQuery Dataset.

4659

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4660

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4661

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in

4662

# desired_node_pool_id. If there is only one pool in the

4663

# cluster and desired_node_pool_id is not provided then

4664

# the change applies to that single node pool.

4665

# adjust the size of the node pool to the current cluster usage.

4666

"enabled": True or False, # Is autoscaling enabled for this node pool.

4667

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

4668

# has to enough quota to scale up the cluster.

4669

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

4670

# max_node_count.

4671

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

4672

},

4673

"desiredLocations": [ # The desired list of Google Compute Engine

4674

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4675

# cluster's nodes should be located. Changing the locations a cluster is in

4676

# will result in nodes being either created or removed from the cluster,

4677

# depending on whether locations are being added or removed.

4678

#

4679

# This list must always include the cluster's primary zone.

4680

"A String",

4681

],

4682

"desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4683

# Currently available options:

4684

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4685

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4686

# service with a Kubernetes-native resource model

4687

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4688

# longer available as of GKE 1.15).

4689

# * `none` - No metrics will be exported from the cluster.

4690

#

4691

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4692

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4693

"desiredImageType": "A String", # The desired image type for the node pool.

4694

# NOTE: Set the "desired_node_pool" field as well.

4695

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4696

# policies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4697

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4698

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4699

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if

4700

# "desired_node_version", "desired_image_family" or

4701

# "desired_node_pool_autoscaling" is specified and there is more than one

4702

# node pool on the cluster.

4703

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

4704

"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]

4705

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4706

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to.

4707

#

4708

# Users may specify either explicit versions offered by

4709

# Kubernetes Engine or version aliases, which have the following behavior:

4710

#

4711

# - "latest": picks the highest valid Kubernetes version

4712

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4713

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4714

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4715

# - "-": picks the default Kubernetes version

4716

"desiredLoggingService": "A String", # The logging service the cluster should use to write logs.

4717

# Currently available options:

4718

#

4719

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

4720

# service with a Kubernetes-native resource model

4721

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

4722

# available as of GKE 1.15).

4723

# * `none` - no logs will be exported from the cluster.

4724

#

4725

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

4726

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

4727

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

4728

# required by Vertical Pod Autoscaler to automatically adjust

4729

# the resources of pods controlled by it.

4730

"enabled": True or False, # Enables vertical pod autoscaling.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4731

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4732

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

4733

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

4734

# images will be validated by Binary Authorization.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4735

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4736

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4737

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4738

# Specified in the format `projects/*/locations/*/clusters/*`.

4739

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4740

# number](https://support.google.com/cloud/answer/6158840).

4741

# This field has been deprecated and replaced by the name field.

4742

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4743

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4744

# cluster resides. This field has been deprecated and replaced by the name

4745

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4746

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

4747

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4748

}

4749

4750

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4757

4758

{ # This operation resource represents operations that may have happened or are

4759

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4760

"name": "A String", # The server-assigned ID for the operation.

4761

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4762

{ # StatusCondition describes why a cluster or a node pool has a certain status

4763

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4764

"message": "A String", # Human-friendly representation of the condition

4765

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4766

},

4767

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4768

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4769

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4770

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4771

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4772

# or

4773

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4774

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4775

"startTime": "A String", # [Output only] The time the operation started, in

4776

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4777

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4778

"stages": [ # Substages of an operation or a stage.

4779

# Object with schema name: OperationProgress

4780

],

4781

"status": "A String", # Status of an operation stage.

4782

# Unset for single-stage operations.

4783

"metrics": [ # Progress metric bundle, for example:

4784

# metrics: [{name: "nodes done", int_value: 15},

4785

# {name: "nodes total", int_value: 32}]

4786

# or

4787

# metrics: [{name: "progress", double_value: 0.56},

4788

# {name: "progress scale", double_value: 1.0}]

4789

{ # Progress metric is (string, int|float|string) pair.

4790

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4791

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4792

"doubleValue": 3.14, # For metrics with floating point value.

4793

"intValue": "A String", # For metrics with integer value.

4794

},

4795

],

4796

"name": "A String", # A non-parameterized string describing an operation stage.

4797

# Unset for single-stage operations.

4798

},

4799

"clusterConditions": [ # Which conditions caused the current cluster state.

4800

{ # StatusCondition describes why a cluster or a node pool has a certain status

4801

# (e.g., ERROR or DEGRADED).

4802

"message": "A String", # Human-friendly representation of the condition

4803

"code": "A String", # Machine-friendly representation of the condition

4804

},

4805

],

4806

"zone": "A String", # The name of the Google Compute Engine

4807

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4808

# operation is taking place. This field is deprecated, use location instead.

4809

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4810

"selfLink": "A String", # Server-defined URL for the resource.

4811

"detail": "A String", # Detailed operation progress, if available.

4812

"targetLink": "A String", # Server-defined URL for the target of the operation.

4813

"operationType": "A String", # The operation type.

4814

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4819

<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]

4820

<pre>Updates the master for a specific cluster.

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4824

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4825

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4826

The object takes the form of:

4827

4828

{ # UpdateMasterRequest updates the master of the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4829

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4830

# Specified in the format `projects/*/locations/*/clusters/*`.

4831

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4832

# number](https://support.google.com/cloud/answer/6158840).

4833

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4834

"zone": "A String", # Deprecated. The name of the Google Compute Engine

4835

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4836

# cluster resides. This field has been deprecated and replaced by the name

4837

# field.

4838

"masterVersion": "A String", # Required. The Kubernetes version to change the master to.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4839

#

4840

# Users may specify either explicit versions offered by Kubernetes Engine or

4841

# version aliases, which have the following behavior:

4842

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4843

# - "latest": picks the highest valid Kubernetes version

4844

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4845

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4846

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4847

# - "-": picks the default Kubernetes version

4848

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4849

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4850

}

4851

4852

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4859

4860

{ # This operation resource represents operations that may have happened or are

4861

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4862

"name": "A String", # The server-assigned ID for the operation.

4863

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4864

{ # StatusCondition describes why a cluster or a node pool has a certain status

4865

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4866

"message": "A String", # Human-friendly representation of the condition

4867

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4868

},

4869

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4870

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4871

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4872

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4873

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4874

# or

4875

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4876

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4877

"startTime": "A String", # [Output only] The time the operation started, in

4878

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4879

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4880

"stages": [ # Substages of an operation or a stage.

4881

# Object with schema name: OperationProgress

4882

],

4883

"status": "A String", # Status of an operation stage.

4884

# Unset for single-stage operations.

4885

"metrics": [ # Progress metric bundle, for example:

4886

# metrics: [{name: "nodes done", int_value: 15},

4887

# {name: "nodes total", int_value: 32}]

4888

# or

4889

# metrics: [{name: "progress", double_value: 0.56},

4890

# {name: "progress scale", double_value: 1.0}]

4891

{ # Progress metric is (string, int|float|string) pair.

4892

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4893

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4894

"doubleValue": 3.14, # For metrics with floating point value.

4895

"intValue": "A String", # For metrics with integer value.

4896

},

4897

],

4898

"name": "A String", # A non-parameterized string describing an operation stage.

4899

# Unset for single-stage operations.

4900

},

4901

"clusterConditions": [ # Which conditions caused the current cluster state.

4902

{ # StatusCondition describes why a cluster or a node pool has a certain status

4903

# (e.g., ERROR or DEGRADED).

4904

"message": "A String", # Human-friendly representation of the condition

4905

"code": "A String", # Machine-friendly representation of the condition

4906

},

4907

],

4908

"zone": "A String", # The name of the Google Compute Engine

4909

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4910

# operation is taking place. This field is deprecated, use location instead.

4911

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4912

"selfLink": "A String", # Server-defined URL for the resource.

4913

"detail": "A String", # Detailed operation progress, if available.

4914

"targetLink": "A String", # Server-defined URL for the target of the operation.

4915

"operationType": "A String", # The operation type.

4916

"status": "A String", # The current status of the operation.

Bu Sun Kim