Blame - docs/dyn/container_v1beta1.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_v1beta1.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-27 12:20:54 -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 for 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 for 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-27 12:20:54 -0700

[diff] [blame]

153

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

154

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

Bu Sun Kim

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

[diff] [blame]

155

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

156

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

157

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

Bu Sun Kim

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

[diff] [blame]

158

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

159

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

Bu Sun Kim

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

[diff] [blame]

160

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

Dan O'Meara

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

[diff] [blame]

161

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

162

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

163

# field.

Bu Sun Kim

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

[diff] [blame]

164

}

165

166

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

173

174

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

175

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

Bu Sun Kim

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

[diff] [blame]

176

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

177

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

178

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

179

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

180

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

Bu Sun Kim

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

[diff] [blame]

181

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

Bu Sun Kim

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

[diff] [blame]

182

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

183

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

Bu Sun Kim

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

[diff] [blame]

184

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

185

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

Bu Sun Kim

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

[diff] [blame]

186

},

187

],

Bu Sun Kim

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

[diff] [blame]

188

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

189

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

Bu Sun Kim

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

[diff] [blame]

190

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

Dan O'Meara

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

[diff] [blame]

191

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

192

# or

193

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

194

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

},

203

],

204

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

Bu Sun Kim

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

[diff] [blame]

205

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

206

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

207

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

208

# or

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

},

217

],

Bu Sun Kim

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

[diff] [blame]

218

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

219

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

220

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

221

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

222

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

223

# Object with schema name: OperationProgress

224

],

Bu Sun Kim

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

[diff] [blame]

225

},

226

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

227

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

228

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

229

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

230

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

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-27 12:20:54 -0700

[diff] [blame]

258

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

259

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

Bu Sun Kim

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

[diff] [blame]

260

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

Dan O'Meara

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

[diff] [blame]

261

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

Bu Sun Kim

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

[diff] [blame]

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

# private networking.

270

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

271

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

272

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

273

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

274

"enabled": True or False, # Whenever master is accessible globally or not.

275

},

276

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

277

},

278

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

279

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

280

},

281

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

282

# required by Vertical Pod Autoscaler to automatically adjust

283

# the resources of pods controlled by it.

284

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

285

},

Bu Sun Kim

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

[diff] [blame]

286

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

287

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

288

# if cluster created with IP Alias support.

289

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

290

},

291

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

292

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

293

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

294

# network will be used. On output this shows the network ID instead of the

295

# name.

296

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

297

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

298

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

299

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

300

# mode.

Bu Sun Kim

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

[diff] [blame]

301

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

302

# master authorized networks will disallow all external traffic to access

303

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

304

# Google Compute Engine Public IPs and Google Prod IPs.

Bu Sun Kim

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

[diff] [blame]

305

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

Bu Sun Kim

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

[diff] [blame]

306

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

307

# Kubernetes master through HTTPS.

308

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

Bu Sun Kim

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

[diff] [blame]

309

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

Bu Sun Kim

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

[diff] [blame]

310

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

Bu Sun Kim

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

[diff] [blame]

311

},

312

],

Bu Sun Kim

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

[diff] [blame]

313

},

314

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

315

# cluster, if available.

316

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

317

# If unspecified, the defaults are used:

318

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

319

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

320

# certificate will be issued.

321

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

322

# certificates.

323

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

324

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

325

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

326

# must be non-empty.

327

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

328

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

329

# certificate is issued.

330

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

331

},

332

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

333

# to the cluster endpoint.

334

"clusterCaCertificate": "A String",

335

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

336

# authenticate to the cluster endpoint.

337

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

338

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

339

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

340

},

341

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

Bu Sun Kim

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

[diff] [blame]

342

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

343

# if enabled = true.

Bu Sun Kim

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

[diff] [blame]

344

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

345

# during authentication using a group of security groups.

Bu Sun Kim

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

[diff] [blame]

346

},

347

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

348

# This prefix will be used for assigning private IP addresses to the

349

# master or set of masters, as well as the ILB VIP.

350

# This field is deprecated, use

351

# private_cluster_config.master_ipv4_cidr_block instead.

352

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

353

"type": "A String", # Type of the integration.

354

},

355

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

Bu Sun Kim

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

[diff] [blame]

356

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

357

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

358

# must be valid under a PodSecurityPolicy to be created.

359

},

Bu Sun Kim

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

[diff] [blame]

360

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

361

# cluster, enabling additional functionality.

Bu Sun Kim

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

[diff] [blame]

362

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

363

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

364

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

365

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

366

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

367

# balancers.

368

},

369

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

370

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

371

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

372

# workloads and applications. For more information, see:

373

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

374

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

375

},

376

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

377

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

378

},

379

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

380

# applications.

381

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

382

},

383

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

384

# enabled at cluster creation time.

385

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

386

},

387

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

388

# microservices.

Bu Sun Kim

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

[diff] [blame]

389

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

Bu Sun Kim

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

[diff] [blame]

390

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

391

},

392

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

393

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

394

# is enabled for the nodes.

395

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

396

# is enabled for the nodes.

397

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

398

},

399

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

400

# enabled in order to enable Cloud Run addon. This option can only be enabled

401

# at cluster creation time.

402

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

403

},

404

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

405

# extension to manage hosted GCP services through the Kubernetes API

406

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

407

},

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

# Monitoring.

Bu Sun Kim

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

[diff] [blame]

416

},

417

},

Bu Sun Kim

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

[diff] [blame]

418

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

419

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

420

# the cluster is connected. On output this shows the subnetwork ID instead of

421

# the name.

Bu Sun Kim

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

[diff] [blame]

422

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

423

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

424

# instead. The current version of the node software components.

425

# If they are currently at multiple versions because they're in the process

426

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

Bu Sun Kim

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

[diff] [blame]

427

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

Bu Sun Kim

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

[diff] [blame]

428

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

Bu Sun Kim

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

[diff] [blame]

429

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

430

# occur in these windows.

431

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

432

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

433

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

434

# start time.

435

},

Bu Sun Kim

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

[diff] [blame]

436

},

437

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

438

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

439

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

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

442

# end time.

443

#

Bu Sun Kim

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

[diff] [blame]

444

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

Dan O'Meara

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

[diff] [blame]

445

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

446

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

447

# <code>FREQ=DAILY</code>

448

# For the first weekend of every month:

449

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

450

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

451

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

452

# <code>

453

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

454

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

455

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

456

# </code>

457

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

458

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

459

# <code>

460

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

461

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

462

# recurrence = FREQ=WEEKLY;BYDAY=SA

463

# </code>

Bu Sun Kim

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

[diff] [blame]

464

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

465

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

466

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

Bu Sun Kim

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

[diff] [blame]

467

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

Bu Sun Kim

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

[diff] [blame]

468

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

Bu Sun Kim

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

[diff] [blame]

469

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

470

# start time.

Dan O'Meara

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

[diff] [blame]

471

},

472

},

Bu Sun Kim

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

[diff] [blame]

473

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

474

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

475

# smallest possible in the given scenario.

476

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

477

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

Dan O'Meara

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

[diff] [blame]

478

},

Bu Sun Kim

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

[diff] [blame]

479

},

Bu Sun Kim

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

[diff] [blame]

480

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

481

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

482

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

483

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

484

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

Bu Sun Kim

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

[diff] [blame]

485

},

Bu Sun Kim

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

[diff] [blame]

486

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

487

# Google Compute Engine resources.

488

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

489

},

Bu Sun Kim

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

[diff] [blame]

490

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

491

# found in validMasterVersions returned by getServerConfig. The version can

492

# be upgraded over time; such upgrades are reflected in

493

# currentMasterVersion and currentNodeVersion.

Dan O'Meara

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

[diff] [blame]

494

#

Bu Sun Kim

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

[diff] [blame]

495

# Users may specify either explicit versions offered by

496

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

Dan O'Meara

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

[diff] [blame]

497

#

Bu Sun Kim

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

[diff] [blame]

498

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

499

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

500

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

501

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

502

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

503

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

504

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

505

# This is used in conjunction with use_ip_aliases. It cannot be true if

506

# use_ip_aliases is true. If both use_ip_aliases and use_routes are false,

507

# then the server picks the default IP allocation mode

508

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

509

# will be automatically chosen with the default size.

510

#

511

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

512

#

513

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

514

#

515

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

520

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

521

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

522

# to use.

Bu Sun Kim

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

[diff] [blame]

523

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain

524

# kinds of network routes. By default we do not allow cluster CIDR ranges to

525

# intersect with any user declared routes. With allow_route_overlap == true,

526

# we allow overlapping with CIDR ranges that are larger than the cluster CIDR

527

# range.

528

#

529

# If this field is set to true, then cluster and services CIDRs must be

530

# fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:

531

# 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and

532

# `services_ipv4_cidr_block` must be fully-specified.

533

# 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be

534

# fully-specified.

535

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

536

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

537

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

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

[diff] [blame]

538

#

539

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

Bu Sun Kim

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

[diff] [blame]

540

#

541

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

542

#

543

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

548

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

549

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

550

# to use.

551

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

552

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

553

# addresses. This must be an existing secondary range associated

554

# with the cluster subnetwork.

555

#

556

# This field is only applicable with use_ip_aliases and

557

# create_subnetwork is false.

558

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

559

#

560

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

561

#

562

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

563

#

564

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

569

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

570

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

571

# to use.

Bu Sun Kim

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

[diff] [blame]

572

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

573

# range will be automatically chosen with the default size.

574

#

575

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

576

#

577

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

578

#

579

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

584

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

585

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

586

# to use.

Dan O'Meara

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

[diff] [blame]

587

# This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

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

[diff] [blame]

588

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

589

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

590

# ClusterIPs. This must be an existing secondary range associated

591

# with the cluster subnetwork.

592

#

593

# This field is only applicable with use_ip_aliases and

594

# create_subnetwork is false.

Bu Sun Kim

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

[diff] [blame]

595

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

596

#

597

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

Bu Sun Kim

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

[diff] [blame]

598

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

599

# This is used in conjunction with use_routes. It cannot

600

# be true if use_routes is true. If both use_ip_aliases and use_routes are

601

# false, then the server picks the default IP allocation mode

Bu Sun Kim

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

[diff] [blame]

602

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

603

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

604

# subnetwork.

605

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

606

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

Bu Sun Kim

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

[diff] [blame]

607

},

Bu Sun Kim

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

[diff] [blame]

608

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

609

# mode.

610

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

611

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

612

# controllers, will have statically granted permissions beyond those

613

# provided by the RBAC configuration or IAM.

Bu Sun Kim

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

[diff] [blame]

614

},

Bu Sun Kim

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

[diff] [blame]

615

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

616

# disabled when this config unspecified.

617

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

618

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

619

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

620

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

621

# second BigQuery table will be created to hold resource consumption

622

# records.

Bu Sun Kim

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

[diff] [blame]

623

},

Bu Sun Kim

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

[diff] [blame]

624

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

625

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

Bu Sun Kim

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

[diff] [blame]

626

},

Bu Sun Kim

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

[diff] [blame]

627

},

Bu Sun Kim

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

[diff] [blame]

628

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

629

# This field is deprecated, use tpu_config.enabled instead.

Bu Sun Kim

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

[diff] [blame]

630

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

631

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

632

# specified.

Bu Sun Kim

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

[diff] [blame]

633

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

634

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

635

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

636

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

637

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

638

# the workload.

Bu Sun Kim

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

[diff] [blame]

639

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

640

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

Bu Sun Kim

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

[diff] [blame]

641

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

642

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

643

# friendly names of CPU platforms, such as

644

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

645

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

646

# information, read [how to specify min CPU

647

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

Bu Sun Kim

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

[diff] [blame]

648

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

649

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

650

#

651

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

652

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

653

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

654

# the instance is created.

655

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

656

#

657

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

658

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

659

# boot process if signature verification fails.

660

},

Bu Sun Kim

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

[diff] [blame]

661

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

662

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

663

# inforamtion about preemptible VM instances.

664

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

665

#

Bu Sun Kim

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

[diff] [blame]

666

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

667

# disks available on a machine per zone. See:

668

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

669

# for more information.

670

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

671

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

672

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

673

},

674

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

675

#

676

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

677

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

678

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

679

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

685

# "enable-oslogin"

686

# "gci-ensure-gke-docker"

687

# "gci-metrics-enabled"

688

# "gci-update-strategy"

689

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

694

# "windows-startup-script-ps1"

695

# "common-psm1"

696

# "k8s-node-setup-psm1"

697

# "install-ssh-psm1"

698

# "user-profile-psm1"

699

# "serial-port-logging-enable"

700

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

701

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

702

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

703

#

704

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

705

"a_key": "A String",

706

},

707

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

708

# the specified [Zonal Compute

709

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

710

# to this node pool.

711

# is the configuration of desired reservation which instances could take

712

# capacity from.

713

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

714

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

715

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

716

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

717

"A String",

718

],

719

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

720

},

721

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

722

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

723

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

724

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame]

725

"A String",

Bu Sun Kim

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

[diff] [blame]

726

],

Bu Sun Kim

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

[diff] [blame]

727

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

728

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

Bu Sun Kim

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

[diff] [blame]

729

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

730

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

731

# the latest version of it will be used.

732

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

733

# node VMs under the "default" service account.

Bu Sun Kim

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

[diff] [blame]

734

#

735

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

736

# not included:

737

#

738

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

739

# persistent storage on your nodes.

740

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

741

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

742

# (the [Google Container

743

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

Bu Sun Kim

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

[diff] [blame]

744

#

745

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

746

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

Bu Sun Kim

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

[diff] [blame]

747

"A String",

Bu Sun Kim

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

[diff] [blame]

748

],

Bu Sun Kim

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

[diff] [blame]

749

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

Bu Sun Kim

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

[diff] [blame]

750

#

751

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

752

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

753

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

754

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

755

#

Bu Sun Kim

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

[diff] [blame]

756

# See

757

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

758

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

Bu Sun Kim

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

[diff] [blame]

759

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

Bu Sun Kim

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

[diff] [blame]

760

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

761

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

Bu Sun Kim

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

[diff] [blame]

762

},

763

],

Bu Sun Kim

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

[diff] [blame]

764

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

765

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

766

# Kubernetes may apply to the node.

767

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

768

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

769

# and conflicts should be avoided.

770

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

771

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

772

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

773

},

Bu Sun Kim

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

[diff] [blame]

774

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

775

# The smallest allowed disk size is 10GB.

776

#

777

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

778

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

779

# workloads on the node pool.

780

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

781

# workloads running on the node.

782

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

783

# on the node pool.

784

},

785

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

786

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

787

# support for GPUs.

788

{ # AcceleratorConfig represents a Hardware Accelerator request.

789

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

790

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

791

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

792

},

793

],

794

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

795

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

796

# `n1-standard-1`).

797

#

798

# If unspecified, the default machine type is

799

# `n1-standard-1`.

800

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

801

#

802

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

803

"bootDiskKmsKey": "A String", #

804

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

805

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

806

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

807

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

808

# see:

809

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

Bu Sun Kim

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

[diff] [blame]

810

},

Bu Sun Kim

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

[diff] [blame]

811

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

812

# simultaneously on a node in the node pool.

813

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

814

},

Bu Sun Kim

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

[diff] [blame]

815

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

Bu Sun Kim

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

[diff] [blame]

816

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

817

# node pool.

Bu Sun Kim

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

[diff] [blame]

818

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

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

[diff] [blame]

819

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

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

[diff] [blame]

820

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

821

# the Auto Upgrades will proceed.

822

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

823

# with the description of the upgrade.

824

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

825

# with the approximate start time for the upgrades, in

826

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

827

},

828

},

Bu Sun Kim

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

[diff] [blame]

829

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

830

# node pool instance, if available.

831

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

832

# only if a valid configuration is present.

833

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

834

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

835

# has to enough quota to scale up the cluster.

836

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

837

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

838

# max_node_count.

839

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

840

},

841

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

842

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

843

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

844

# firewall and routes quota.

845

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

846

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

847

# NodePool's nodes should be located.

848

"A String",

849

],

850

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

851

# disruption caused by an upgrade.

852

#

853

# maxUnavailable controls the number of nodes that can be simultaneously

854

# unavailable.

855

#

856

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

857

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

858

# available nodes.

859

#

860

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

861

# nodes are being upgraded at the same time).

862

#

863

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

864

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

865

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

866

# PodDisruptionBudget, if it is configured.)

867

#

868

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

869

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

870

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

871

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

872

# there are always at least 4 nodes available.

873

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

874

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

875

# Ready.

876

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

877

# of the node pool during the upgrade process.

878

},

879

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

880

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

881

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

882

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

883

# associated with this node pool.

884

"A String",

885

],

886

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

887

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

888

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

889

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

890

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

891

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

892

},

893

],

Bu Sun Kim

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

[diff] [blame]

894

},

895

],

Bu Sun Kim

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

[diff] [blame]

896

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

897

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

898

# cluster's nodes should be located.

899

"A String",

900

],

Bu Sun Kim

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

[diff] [blame]

901

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

Bu Sun Kim

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

[diff] [blame]

902

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

903

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

904

# frequency of updates.

905

#

906

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

907

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

908

# defaults to true and cannot be disabled. Updates to version related

909

# fields (e.g. current_master_version) return an error.

910

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

911

},

Bu Sun Kim

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

[diff] [blame]

912

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

913

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

914

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

915

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

916

},

917

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

918

# this cluster, in

919

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

920

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

921

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

Bu Sun Kim

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

[diff] [blame]

922

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

923

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

924

# the kubernetes version of the master and nodes.

925

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

926

# Alpha enabled clusters are automatically deleted thirty days after

927

# creation.

928

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

929

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

930

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

931

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

932

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

933

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

934

},

935

],

936

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by

937

# default have no external IP addresses on the nodes and where nodes and the

938

# master communicate over private IP addresses.

939

# This field is deprecated, use private_cluster_config.enable_private_nodes

940

# instead.

941

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

942

# Call Kubernetes API directly to retrieve node information.

943

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

944

# Currently available options:

945

#

Bu Sun Kim

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

[diff] [blame]

946

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

Dan O'Meara

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

[diff] [blame]

947

# service with a Kubernetes-native resource model

948

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

949

# longer available as of GKE 1.15).

950

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

951

#

952

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

953

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

Bu Sun Kim

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

[diff] [blame]

954

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

955

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

956

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

Dan O'Meara

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

[diff] [blame]

957

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

Bu Sun Kim

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

[diff] [blame]

958

},

Bu Sun Kim

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

[diff] [blame]

959

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

960

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

961

# images will be validated by Google Binauthz.

Bu Sun Kim

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

[diff] [blame]

962

},

Bu Sun Kim

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

[diff] [blame]

963

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

964

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

965

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

966

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

967

# policies.

968

# policies.

Bu Sun Kim

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

[diff] [blame]

969

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

Bu Sun Kim

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

[diff] [blame]

970

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

Bu Sun Kim

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

[diff] [blame]

971

},

972

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

Dan O'Meara

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

[diff] [blame]

973

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

974

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

Bu Sun Kim

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

[diff] [blame]

975

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

976

# Currently available options:

Bu Sun Kim

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

[diff] [blame]

977

#

Bu Sun Kim

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

[diff] [blame]

978

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

979

# service with a Kubernetes-native resource model

980

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

981

# available as of GKE 1.15).

982

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

Bu Sun Kim

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

[diff] [blame]

983

#

Bu Sun Kim

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

[diff] [blame]

984

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

985

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

986

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

987

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

988

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

989

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

Bu Sun Kim

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

[diff] [blame]

990

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

991

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

992

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

993

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

994

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

995

# `node_pool.config`)

996

#

997

# If unspecified, the defaults are used.

998

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

Bu Sun Kim

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

[diff] [blame]

999

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

1000

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

1001

# friendly names of CPU platforms, such as

1002

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

1003

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

1004

# information, read [how to specify min CPU

1005

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

Bu Sun Kim

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

[diff] [blame]

1006

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

1007

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

1008

#

1009

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

1010

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

1011

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

1012

# the instance is created.

1013

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

1014

#

1015

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

1016

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

1017

# boot process if signature verification fails.

1018

},

Bu Sun Kim

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

[diff] [blame]

1019

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

1020

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

1021

# inforamtion about preemptible VM instances.

1022

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

1023

#

Bu Sun Kim

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

[diff] [blame]

1024

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

1025

# disks available on a machine per zone. See:

1026

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

1027

# for more information.

1028

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

1029

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

1030

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

1031

},

1032

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

1033

#

1034

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

1035

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

1036

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

1037

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1043

# "enable-oslogin"

1044

# "gci-ensure-gke-docker"

1045

# "gci-metrics-enabled"

1046

# "gci-update-strategy"

1047

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1052

# "windows-startup-script-ps1"

1053

# "common-psm1"

1054

# "k8s-node-setup-psm1"

1055

# "install-ssh-psm1"

1056

# "user-profile-psm1"

1057

# "serial-port-logging-enable"

1058

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

1059

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

1060

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

1061

#

1062

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

1063

"a_key": "A String",

1064

},

1065

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

1066

# the specified [Zonal Compute

1067

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

1068

# to this node pool.

1069

# is the configuration of desired reservation which instances could take

1070

# capacity from.

1071

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

1072

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

1073

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

1074

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

1075

"A String",

1076

],

1077

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

1078

},

1079

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

1080

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

1081

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

1082

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame]

1083

"A String",

Bu Sun Kim

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

[diff] [blame]

1084

],

Bu Sun Kim

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

[diff] [blame]

1085

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

1086

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

Bu Sun Kim

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

[diff] [blame]

1087

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

1088

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

1089

# the latest version of it will be used.

1090

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

1091

# node VMs under the "default" service account.

Bu Sun Kim

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

[diff] [blame]

1092

#

1093

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

1094

# not included:

1095

#

1096

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

1097

# persistent storage on your nodes.

1098

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

1099

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

1100

# (the [Google Container

1101

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

Bu Sun Kim

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

[diff] [blame]

1102

#

1103

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

1104

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

Bu Sun Kim

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

[diff] [blame]

1105

"A String",

Bu Sun Kim

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

[diff] [blame]

1106

],

Bu Sun Kim

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

[diff] [blame]

1107

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

Bu Sun Kim

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

[diff] [blame]

1108

#

1109

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

1110

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

1111

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

1112

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

1113

#

Bu Sun Kim

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

[diff] [blame]

1114

# See

1115

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

1116

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

Bu Sun Kim

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

[diff] [blame]

1117

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

Bu Sun Kim

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

[diff] [blame]

1118

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

1119

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

Bu Sun Kim

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

[diff] [blame]

1120

},

1121

],

Bu Sun Kim

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

[diff] [blame]

1122

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

1123

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

1124

# Kubernetes may apply to the node.

1125

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

1126

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

1127

# and conflicts should be avoided.

1128

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

1129

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

1130

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1131

},

Bu Sun Kim

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

[diff] [blame]

1132

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

1133

# The smallest allowed disk size is 10GB.

1134

#

1135

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

1136

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

1137

# workloads on the node pool.

1138

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

1139

# workloads running on the node.

1140

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

1141

# on the node pool.

1142

},

1143

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

1144

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

1145

# support for GPUs.

1146

{ # AcceleratorConfig represents a Hardware Accelerator request.

1147

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

1148

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

1149

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

1150

},

1151

],

1152

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

1153

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

1154

# `n1-standard-1`).

1155

#

1156

# If unspecified, the default machine type is

1157

# `n1-standard-1`.

1158

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

1159

#

1160

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

1161

"bootDiskKmsKey": "A String", #

1162

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

1163

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

1164

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

1165

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

1166

# see:

1167

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

1168

},

1169

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

1170

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

1171

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

1172

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

Bu Sun Kim

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

[diff] [blame]

1173

},

Bu Sun Kim

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

[diff] [blame]

1174

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

Bu Sun Kim

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

[diff] [blame]

1175

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

Bu Sun Kim

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

[diff] [blame]

1176

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

1177

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

Bu Sun Kim

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

[diff] [blame]

1178

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

1179

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

1180

# cluster is connected. Example:

1181

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

1182

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

1183

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

1184

# to which the cluster is connected. Example:

1185

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

Bu Sun Kim

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

[diff] [blame]

1186

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules

1187

# will be disabled when default_snat_status is disabled. When disabled is set

1188

# to false, default IP masquerade rules will be applied to the nodes to

1189

# prevent sNAT on cluster internal traffic.

1190

# be disabled on the cluster.

1191

"disabled": True or False, # Disables cluster default sNAT rules.

1192

},

Bu Sun Kim

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

[diff] [blame]

1193

},

1194

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

1195

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

1196

# the following restrictions:

1197

#

1198

# * Lowercase letters, numbers, and hyphens only.

1199

# * Must start with a letter.

1200

# * Must end with a number or a letter.

Bu Sun Kim

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

[diff] [blame]

1201

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

1202

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

1203

# or

1204

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

1205

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

1206

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

1207

# The endpoint can be accessed from the internet at

1208

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

1209

#

1210

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

1211

# password information.

Bu Sun Kim

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

[diff] [blame]

1212

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

1213

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

1214

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

1215

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

1216

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

1217

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

1218

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

1219

# required by Cluster Autoscaler to automatically adjust

1220

# the size of the cluster and create/delete

1221

# node pools based on the current needs.

Bu Sun Kim

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

[diff] [blame]

1222

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

1223

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

1224

# NodePool's nodes can be created by NAP.

1225

"A String",

1226

],

Bu Sun Kim

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

[diff] [blame]

1227

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

1228

# amount of resources in the cluster.

1229

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

1230

# For memory, value should be in GB.

1231

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

1232

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

1233

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

1234

},

1235

],

1236

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

1237

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

1238

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

1239

# created by NAP.

1240

# by NAP.

Bu Sun Kim

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

[diff] [blame]

1241

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

1242

# service_account is specified, scopes should be empty.

1243

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

1244

# The instance may be scheduled on the specified or newer CPU platform.

1245

# Applicable values are the friendly names of CPU platforms, such as

1246

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

1247

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

1248

# information, read [how to specify min CPU

1249

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

1250

# To unset the min cpu platform field pass "automatic" as field value.

Bu Sun Kim

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

[diff] [blame]

1251

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

1252

# node pool.

Bu Sun Kim

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

[diff] [blame]

1253

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

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

[diff] [blame]

1254

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

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

[diff] [blame]

1255

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

1256

# the Auto Upgrades will proceed.

1257

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

1258

# with the description of the upgrade.

1259

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

1260

# with the approximate start time for the upgrades, in

1261

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

1262

},

1263

},

Bu Sun Kim

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

[diff] [blame]

1264

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

1265

# specified, service_account should be empty.

1266

"A String",

1267

],

Bu Sun Kim

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

[diff] [blame]

1268

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

1269

# disruption caused by an upgrade.

1270

#

1271

# maxUnavailable controls the number of nodes that can be simultaneously

1272

# unavailable.

1273

#

1274

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

1275

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

1276

# available nodes.

1277

#

1278

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

1279

# nodes are being upgraded at the same time).

1280

#

1281

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

1282

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

1283

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

1284

# PodDisruptionBudget, if it is configured.)

1285

#

1286

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

1287

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

1288

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

1289

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

1290

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame]

1291

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

1292

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

1293

# Ready.

Bu Sun Kim

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

[diff] [blame]

1294

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

1295

# of the node pool during the upgrade process.

Bu Sun Kim

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

[diff] [blame]

1296

},

Bu Sun Kim

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

[diff] [blame]

1297

},

Dan O'Meara

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

[diff] [blame]

1298

},

Bu Sun Kim

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

[diff] [blame]

1299

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

1300

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

Dan O'Meara

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

[diff] [blame]

1301

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

1302

# firewall and routes quota.

1303

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

Bu Sun Kim

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

[diff] [blame]

1304

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

1305

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

Dan O'Meara

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

[diff] [blame]

1306

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

1307

#

1308

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

Bu Sun Kim

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

[diff] [blame]

1309

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

1310

"A String",

1311

],

Bu Sun Kim

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

[diff] [blame]

1312

},

Bu Sun Kim

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

[diff] [blame]

1313

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

1314

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

1315

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

Bu Sun Kim

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

[diff] [blame]

1316

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

1317

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

1318

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

1319

# field.

Bu Sun Kim

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

[diff] [blame]

1320

}

1321

1322

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1329

1330

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

1331

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

Bu Sun Kim

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

[diff] [blame]

1332

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

1333

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

1334

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

1335

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

1336

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

Bu Sun Kim

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

[diff] [blame]

1337

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

Bu Sun Kim

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

[diff] [blame]

1338

{ # StatusCondition describes why a cluster or a node pool has a certain status

1339

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1340

"code": "A String", # Machine-friendly representation of the condition

1341

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1342

},

1343

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1344

"endTime": "A String", # [Output only] The time the operation completed, in

1345

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1346

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1347

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1348

# or

1349

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1350

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1351

"startTime": "A String", # [Output only] The time the operation started, in

1352

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1353

"clusterConditions": [ # Which conditions caused the current cluster state.

1354

{ # StatusCondition describes why a cluster or a node pool has a certain status

1355

# (e.g., ERROR or DEGRADED).

1356

"code": "A String", # Machine-friendly representation of the condition

1357

"message": "A String", # Human-friendly representation of the condition

1358

},

1359

],

1360

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1361

"metrics": [ # Progress metric bundle, for example:

1362

# metrics: [{name: "nodes done", int_value: 15},

1363

# {name: "nodes total", int_value: 32}]

1364

# or

1365

# metrics: [{name: "progress", double_value: 0.56},

1366

# {name: "progress scale", double_value: 1.0}]

1367

{ # Progress metric is (string, int|float|string) pair.

1368

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1369

"doubleValue": 3.14, # For metrics with floating point value.

1370

"intValue": "A String", # For metrics with integer value.

1371

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1372

},

1373

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1374

"status": "A String", # Status of an operation stage.

1375

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1376

"name": "A String", # A non-parameterized string describing an operation stage.

1377

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1378

"stages": [ # Substages of an operation or a stage.

1379

# Object with schema name: OperationProgress

1380

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1381

},

1382

"zone": "A String", # The name of the Google Compute Engine

1383

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1384

# operation is taking place. This field is deprecated, use location instead.

1385

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1386

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1391

<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]

1392

<pre>Deletes the cluster, including the Kubernetes endpoint and all worker

1393

nodes.

1394

1395

Firewalls and routes that were configured during cluster creation

1396

are also deleted.

1397

1398

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]

1399

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]

1400

when the cluster was initially created.

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1404

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1405

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1406

number](https://support.google.com/cloud/answer/6158840).

1407

This field has been deprecated and replaced by the name field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1408

zone: string, Required. Deprecated. The name of the Google Compute Engine

1409

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1410

cluster resides. This field has been deprecated and replaced by the name

1411

field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1412

clusterId: string, Required. Deprecated. The name of the cluster to delete.

1413

This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1414

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1421

1422

{ # This operation resource represents operations that may have happened or are

1423

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1424

"targetLink": "A String", # Server-defined URL for the target of the operation.

1425

"detail": "A String", # Detailed operation progress, if available.

1426

"operationType": "A String", # The operation type.

1427

"status": "A String", # The current status of the operation.

1428

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1429

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1430

{ # StatusCondition describes why a cluster or a node pool has a certain status

1431

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1432

"code": "A String", # Machine-friendly representation of the condition

1433

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1434

},

1435

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1436

"endTime": "A String", # [Output only] The time the operation completed, in

1437

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1438

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1439

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1440

# or

1441

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1442

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1443

"startTime": "A String", # [Output only] The time the operation started, in

1444

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1445

"clusterConditions": [ # Which conditions caused the current cluster state.

1446

{ # StatusCondition describes why a cluster or a node pool has a certain status

1447

# (e.g., ERROR or DEGRADED).

1448

"code": "A String", # Machine-friendly representation of the condition

1449

"message": "A String", # Human-friendly representation of the condition

1450

},

1451

],

1452

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1453

"metrics": [ # Progress metric bundle, for example:

1454

# metrics: [{name: "nodes done", int_value: 15},

1455

# {name: "nodes total", int_value: 32}]

1456

# or

1457

# metrics: [{name: "progress", double_value: 0.56},

1458

# {name: "progress scale", double_value: 1.0}]

1459

{ # Progress metric is (string, int|float|string) pair.

1460

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1461

"doubleValue": 3.14, # For metrics with floating point value.

1462

"intValue": "A String", # For metrics with integer value.

1463

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1464

},

1465

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1466

"status": "A String", # Status of an operation stage.

1467

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1468

"name": "A String", # A non-parameterized string describing an operation stage.

1469

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1470

"stages": [ # Substages of an operation or a stage.

1471

# Object with schema name: OperationProgress

1472

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1473

},

1474

"zone": "A String", # The name of the Google Compute Engine

1475

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1476

# operation is taking place. This field is deprecated, use location instead.

1477

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1478

"selfLink": "A String", # Server-defined URL for the resource.

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]

1483

<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]

1484

<pre>Gets the details for a specific cluster.

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1488

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1489

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1490

number](https://support.google.com/cloud/answer/6158840).

1491

This field has been deprecated and replaced by the name field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1492

zone: string, Required. Deprecated. The name of the Google Compute Engine

1493

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1494

cluster resides. This field has been deprecated and replaced by the name

1495

field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1496

clusterId: string, Required. Deprecated. The name of the cluster to retrieve.

1497

This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1498

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1505

1506

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1507

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

1508

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

1509

# range will be used for assigning internal IP addresses to the master or

1510

# set of masters, as well as the ILB VIP. This range must not overlap with

1511

# any other ranges in use within the cluster's network.

1512

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

1513

# given only RFC 1918 private addresses and communicate with the master via

1514

# private networking.

1515

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

1516

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

1517

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

1518

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

1519

"enabled": True or False, # Whenever master is accessible globally or not.

1520

},

1521

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

1522

},

1523

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

1524

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

1525

},

1526

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

1527

# required by Vertical Pod Autoscaler to automatically adjust

1528

# the resources of pods controlled by it.

1529

"enabled": True or False, # Enables vertical pod autoscaling.

1530

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1531

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

1532

# simultaneously on a node in the node pool of this cluster. Only honored

1533

# if cluster created with IP Alias support.

1534

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1535

},

1536

"network": "A String", # The name of the Google Compute Engine

1537

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1538

# to which the cluster is connected. If left unspecified, the `default`

1539

# network will be used. On output this shows the network ID instead of the

1540

# name.

1541

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

1542

"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]

1543

# containers. This is provisioned from within the `container_ipv4_cidr`

1544

# range. This field will only be set when cluster is in route-based network

1545

# mode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1546

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

1547

# master authorized networks will disallow all external traffic to access

1548

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

1549

# Google Compute Engine Public IPs and Google Prod IPs.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1550

"enabled": True or False, # Whether or not master authorized networks is enabled.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1551

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

1552

# Kubernetes master through HTTPS.

1553

{ # CidrBlock contains an optional name and one CIDR block.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1554

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1555

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1556

},

1557

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1558

},

1559

"statusMessage": "A String", # [Output only] Additional information about the current status of this

1560

# cluster, if available.

1561

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

1562

# If unspecified, the defaults are used:

1563

# For clusters before v1.12, if master_auth is unspecified, `username` will

1564

# be set to "admin", a random password will be generated, and a client

1565

# certificate will be issued.

1566

# Authentication can be done using HTTP basic auth or using client

1567

# certificates.

1568

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

1569

# Because the master endpoint is open to the Internet, you should create a

1570

# strong password. If a password is provided for cluster creation, username

1571

# must be non-empty.

1572

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

1573

# clusters before v1.12, if no configuration is specified, a client

1574

# certificate is issued.

1575

"issueClientCertificate": True or False, # Issue a client certificate.

1576

},

1577

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

1578

# to the cluster endpoint.

1579

"clusterCaCertificate": "A String",

1580

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

1581

# authenticate to the cluster endpoint.

1582

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

1583

# For clusters v1.6.0 and later, basic authentication can be disabled by

1584

# leaving username unspecified (or setting it to the empty string).

1585

},

1586

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1587

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

1588

# if enabled = true.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1589

"enabled": True or False, # Whether this cluster should return group membership lookups

1590

# during authentication using a group of security groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1591

},

1592

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network.

1593

# This prefix will be used for assigning private IP addresses to the

1594

# master or set of masters, as well as the ILB VIP.

1595

# This field is deprecated, use

1596

# private_cluster_config.master_ipv4_cidr_block instead.

1597

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

1598

"type": "A String", # Type of the integration.

1599

},

1600

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1601

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

1602

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

1603

# must be valid under a PodSecurityPolicy to be created.

1604

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1605

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

1606

# cluster, enabling additional functionality.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1607

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

1608

# makes it easy to set up HTTP load balancers for services in a cluster.

1609

# which makes it easy to set up HTTP load balancers for services in a cluster.

1610

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

1611

# When enabled, it runs a small pod in the cluster that manages the load

1612

# balancers.

1613

},

1614

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

1615

# This addon is deprecated, and will be disabled in 1.15. It is recommended

1616

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

1617

# workloads and applications. For more information, see:

1618

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

1619

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

1620

},

1621

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

1622

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

1623

},

1624

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

1625

# applications.

1626

"enabled": True or False, # Whether KALM is enabled for this cluster.

1627

},

1628

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

1629

# enabled at cluster creation time.

1630

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

1631

},

1632

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

1633

# microservices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1634

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1635

"disabled": True or False, # Whether Istio is enabled for this cluster.

1636

},

1637

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

1638

# is enabled or not on the Master, it does not track whether network policy

1639

# is enabled for the nodes.

1640

# is enabled or not on the Master, it does not track whether network policy

1641

# is enabled for the nodes.

1642

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1643

},

1644

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

1645

# enabled in order to enable Cloud Run addon. This option can only be enabled

1646

# at cluster creation time.

1647

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1648

},

1649

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

1650

# extension to manage hosted GCP services through the Kubernetes API

1651

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

1652

},

1653

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

1654

# increases or decreases the number of replica pods a replication controller

1655

# has based on the resource usage of the existing pods.

1656

# increases or decreases the number of replica pods a replication controller

1657

# has based on the resource usage of the existing pods.

1658

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

1659

# When enabled, it ensures that metrics are collected into Stackdriver

1660

# Monitoring.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1661

},

1662

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1663

"subnetwork": "A String", # The name of the Google Compute Engine

1664

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

1665

# the cluster is connected. On output this shows the subnetwork ID instead of

1666

# the name.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1667

"currentNodeVersion": "A String", # [Output only] Deprecated, use

1668

# [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools)

1669

# instead. The current version of the node software components.

1670

# If they are currently at multiple versions because they're in the process

1671

# of being upgraded, this reflects the minimum version of all nodes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1672

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1673

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1674

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

1675

# occur in these windows.

1676

"a_key": { # Represents an arbitrary window of time.

1677

"startTime": "A String", # The time that the window first starts.

1678

"endTime": "A String", # The time that the window ends. The end time should take place after the

1679

# start time.

1680

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1681

},

1682

"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]

1683

# maintenance to occur. The time windows may be overlapping. If no

1684

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1685

"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]

1686

# this window reccurs. They go on for the span of time between the start and

1687

# end time.

1688

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1689

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1690

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

1691

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

1692

# <code>FREQ=DAILY</code>

1693

# For the first weekend of every month:

1694

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

1695

# 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]

1696

# 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]

1697

# <code>

1698

# start time = 2019-01-01T09:00:00-0400

1699

# end time = 2019-01-01T17:00:00-0400

1700

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

1701

# </code>

1702

# Windows can span multiple days. Eg, to make the window encompass every

1703

# weekend from midnight Saturday till the last minute of Sunday UTC:

1704

# <code>

1705

# start time = 2019-01-05T00:00:00Z

1706

# end time = 2019-01-07T23:59:00Z

1707

# recurrence = FREQ=WEEKLY;BYDAY=SA

1708

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1709

# 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]

1710

# to specify duration of the window and when it first starts.

1711

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1712

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1713

"startTime": "A String", # The time that the window first starts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1714

"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]

1715

# start time.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1716

},

1717

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1718

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1719

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

1720

# smallest possible in the given scenario.

1721

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

1722

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1723

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1724

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1725

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

1726

# the policy won't accidentally undo intermediate changes (and so that users

1727

# of the API unaware of some fields won't accidentally remove other fields).

1728

# Make a <code>get()</code> request to the cluster to get the current

1729

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1730

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1731

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

1732

# Google Compute Engine resources.

1733

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1734

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1735

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

1736

# found in validMasterVersions returned by getServerConfig. The version can

1737

# be upgraded over time; such upgrades are reflected in

1738

# currentMasterVersion and currentNodeVersion.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1739

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1740

# Users may specify either explicit versions offered by

1741

# Kubernetes Engine or version aliases, which have the following behavior:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1742

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1743

# - "latest": picks the highest valid Kubernetes version

1744

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

1745

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

1746

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

1747

# - "","-": picks the default Kubernetes version

1748

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

1749

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster.

1750

# This is used in conjunction with use_ip_aliases. It cannot be true if

1751

# use_ip_aliases is true. If both use_ip_aliases and use_routes are false,

1752

# then the server picks the default IP allocation mode

1753

"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]

1754

# will be automatically chosen with the default size.

1755

#

1756

# This field is only applicable when `use_ip_aliases` is true.

1757

#

1758

# Set to blank to have a range chosen with the default size.

1759

#

1760

# 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)

1765

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1766

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1767

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1768

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain

1769

# kinds of network routes. By default we do not allow cluster CIDR ranges to

1770

# intersect with any user declared routes. With allow_route_overlap == true,

1771

# we allow overlapping with CIDR ranges that are larger than the cluster CIDR

1772

# range.

1773

#

1774

# If this field is set to true, then cluster and services CIDRs must be

1775

# fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:

1776

# 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and

1777

# `services_ipv4_cidr_block` must be fully-specified.

1778

# 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be

1779

# fully-specified.

1780

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1781

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

1782

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1783

#

1784

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1785

#

1786

# Set to blank to have a range chosen with the default size.

1787

#

1788

# 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)

1793

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1794

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1795

# to use.

1796

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

1797

# block. The secondary range will be used for pod IP

1798

# addresses. This must be an existing secondary range associated

1799

# with the cluster subnetwork.

1800

#

1801

# This field is only applicable with use_ip_aliases and

1802

# create_subnetwork is false.

1803

"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]

1804

#

1805

# This is applicable only if `create_subnetwork` is true.

1806

#

1807

# Set to blank to have a range chosen with the default size.

1808

#

1809

# 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)

1814

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1815

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1816

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1817

"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]

1818

# range will be automatically chosen with the default size.

1819

#

1820

# This field is only applicable when `use_ip_aliases` is true.

1821

#

1822

# If unspecified, the range will use the default size.

1823

#

1824

# 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)

1829

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1830

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1831

# to use.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1832

# This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1833

"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]

1834

# CIDR block. The secondary range will be used for service

1835

# ClusterIPs. This must be an existing secondary range associated

1836

# with the cluster subnetwork.

1837

#

1838

# This field is only applicable with use_ip_aliases and

1839

# create_subnetwork is false.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1840

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

1841

#

1842

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1843

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

1844

# This is used in conjunction with use_routes. It cannot

1845

# be true if use_routes is true. If both use_ip_aliases and use_routes are

1846

# false, then the server picks the default IP allocation mode

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1847

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

1848

# this field is empty, then an automatic name will be chosen for the new

1849

# subnetwork.

1850

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

1851

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1852

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1853

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

1854

# mode.

1855

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

1856

# identities in the system, including service accounts, nodes, and

1857

# controllers, will have statically granted permissions beyond those

1858

# provided by the RBAC configuration or IAM.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1859

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1860

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

1861

# disabled when this config unspecified.

1862

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

1863

# daemonset will be created in the cluster to meter network egress traffic.

1864

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

1865

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

1866

# second BigQuery table will be created to hold resource consumption

1867

# records.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1868

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1869

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

1870

"datasetId": "A String", # The ID of a BigQuery Dataset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1871

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1872

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1873

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

1874

# This field is deprecated, use tpu_config.enabled instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1875

"nodePools": [ # The node pools associated with this cluster.

1876

# 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]

1877

# specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1878

{ # NodePool contains the name and configuration for a cluster's node pool.

1879

# 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]

1880

# specification, under the control of the cluster master. They may have a set

1881

# of Kubernetes labels applied to them, which may be used to reference them

1882

# during pod scheduling. They may also be resized up or down, to accommodate

1883

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1884

"status": "A String", # [Output only] The status of the nodes in this pool instance.

1885

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1886

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

1887

# scheduled on the specified or newer CPU platform. Applicable values are the

1888

# friendly names of CPU platforms, such as

1889

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

1890

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

1891

# information, read [how to specify min CPU

1892

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1893

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1894

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1895

#

1896

# Enables monitoring and attestation of the boot integrity of the instance.

1897

# The attestation is performed against the integrity policy baseline. This

1898

# baseline is initially derived from the implicitly trusted boot image when

1899

# the instance is created.

1900

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1901

#

1902

# Secure Boot helps ensure that the system only runs authentic software by

1903

# verifying the digital signature of all boot components, and halting the

1904

# boot process if signature verification fails.

1905

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1906

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

1907

# https://cloud.google.com/compute/docs/instances/preemptible for more

1908

# inforamtion about preemptible VM instances.

1909

"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]

1910

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1911

# The limit for this value is dependent upon the maximum number of

1912

# disks available on a machine per zone. See:

1913

# https://cloud.google.com/compute/docs/disks/local-ssd

1914

# for more information.

1915

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1916

"type": "A String", # Type of the sandbox to use for the node.

1917

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

1918

},

1919

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

1920

#

1921

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

1922

# in length. These are reflected as part of a URL in the metadata server.

1923

# Additionally, to avoid ambiguity, keys must not conflict with any other

1924

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1930

# "enable-oslogin"

1931

# "gci-ensure-gke-docker"

1932

# "gci-metrics-enabled"

1933

# "gci-update-strategy"

1934

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1939

# "windows-startup-script-ps1"

1940

# "common-psm1"

1941

# "k8s-node-setup-psm1"

1942

# "install-ssh-psm1"

1943

# "user-profile-psm1"

1944

# "serial-port-logging-enable"

1945

# Values are free-form strings, and only have meaning as interpreted by

1946

# the image running in the instance. The only restriction placed on them is

1947

# that each value's size must be less than or equal to 32 KB.

1948

#

1949

# The total size of all keys and values must be less than 512 KB.

1950

"a_key": "A String",

1951

},

1952

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

1953

# the specified [Zonal Compute

1954

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

1955

# to this node pool.

1956

# is the configuration of desired reservation which instances could take

1957

# capacity from.

1958

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

1959

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

1960

# the key and specify the name of your reservation as its value.

1961

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1962

"A String",

1963

],

1964

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1965

},

1966

"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]

1967

# valid sources or targets for network firewalls and are specified by

1968

# the client during cluster or node pool creation. Each tag within the list

1969

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1970

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1971

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1972

"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]

1973

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1974

# Account is specified, the "default" service account is used.

1975

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

1976

# the latest version of it will be used.

1977

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

1978

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1979

#

1980

# The following scopes are recommended, but not required, and by default are

1981

# not included:

1982

#

1983

# * `https://www.googleapis.com/auth/compute` is required for mounting

1984

# persistent storage on your nodes.

1985

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

1986

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1987

# (the [Google Container

1988

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1989

#

1990

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

1991

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1992

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1993

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1994

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1995

#

1996

# For more information, including usage and the valid values, see:

1997

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1998

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

1999

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2000

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2001

# See

2002

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2003

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2004

"effect": "A String", # Effect for taint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2005

"value": "A String", # Value for taint.

2006

"key": "A String", # Key for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2007

},

2008

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2009

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2010

# These will added in addition to any default label(s) that

2011

# Kubernetes may apply to the node.

2012

# In case of conflict in label keys, the applied set may differ depending on

2013

# the Kubernetes version -- it's best to assume the behavior is undefined

2014

# and conflicts should be avoided.

2015

# For more information, including usage and the valid values, see:

2016

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2017

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2018

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2019

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2020

# The smallest allowed disk size is 10GB.

2021

#

2022

# If unspecified, the default disk size is 100GB.

2023

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2024

# workloads on the node pool.

2025

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

2026

# workloads running on the node.

2027

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2028

# on the node pool.

2029

},

2030

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2031

# See https://cloud.google.com/compute/docs/gpus for more information about

2032

# support for GPUs.

2033

{ # AcceleratorConfig represents a Hardware Accelerator request.

2034

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2035

# [here](https://cloud.google.com/compute/docs/gpus)

2036

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2037

},

2038

],

2039

"machineType": "A String", # The name of a Google Compute Engine [machine

2040

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2041

# `n1-standard-1`).

2042

#

2043

# If unspecified, the default machine type is

2044

# `n1-standard-1`.

2045

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2046

#

2047

# If unspecified, the default disk type is 'pd-standard'

2048

"bootDiskKmsKey": "A String", #

2049

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2050

# to each node in the node pool. This should be of the form

2051

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2052

# For more information about protecting resources with Cloud KMS Keys please

2053

# see:

2054

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2055

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2056

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

2057

# simultaneously on a node in the node pool.

2058

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2059

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2060

"name": "A String", # The name of the node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2061

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

2062

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2063

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2064

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2065

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2066

# the Auto Upgrades will proceed.

2067

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2068

# with the description of the upgrade.

2069

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2070

# with the approximate start time for the upgrades, in

2071

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2072

},

2073

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2074

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2075

# node pool instance, if available.

2076

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

2077

# only if a valid configuration is present.

2078

# adjust the size of the node pool to the current cluster usage.

2079

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

2080

# has to enough quota to scale up the cluster.

2081

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2082

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

2083

# max_node_count.

2084

"enabled": True or False, # Is autoscaling enabled for this node pool.

2085

},

2086

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

2087

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

2088

# is sufficient for this number of instances. You must also have available

2089

# firewall and routes quota.

2090

"locations": [ # The list of Google Compute Engine

2091

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2092

# NodePool's nodes should be located.

2093

"A String",

2094

],

2095

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

2096

# disruption caused by an upgrade.

2097

#

2098

# maxUnavailable controls the number of nodes that can be simultaneously

2099

# unavailable.

2100

#

2101

# maxSurge controls the number of additional nodes that can be added to the

2102

# node pool temporarily for the time of the upgrade to increase the number of

2103

# available nodes.

2104

#

2105

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2106

# nodes are being upgraded at the same time).

2107

#

2108

# Note: upgrades inevitably introduce some disruption since workloads need to

2109

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2110

# this holds true. (Disruption stays within the limits of

2111

# PodDisruptionBudget, if it is configured.)

2112

#

2113

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2114

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2115

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2116

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2117

# there are always at least 4 nodes available.

2118

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2119

# the upgrade process. A node is considered available if its status is

2120

# Ready.

2121

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2122

# of the node pool during the upgrade process.

2123

},

2124

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2125

"version": "A String", # The version of the Kubernetes of this node.

2126

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

2127

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

2128

# associated with this node pool.

2129

"A String",

2130

],

2131

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

2132

"conditions": [ # Which conditions caused the current node pool state.

2133

{ # StatusCondition describes why a cluster or a node pool has a certain status

2134

# (e.g., ERROR or DEGRADED).

2135

"code": "A String", # Machine-friendly representation of the condition

2136

"message": "A String", # Human-friendly representation of the condition

2137

},

2138

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2139

},

2140

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2141

"locations": [ # The list of Google Compute Engine

2142

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2143

# cluster's nodes should be located.

2144

"A String",

2145

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2146

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2147

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

2148

# subscribed to. Release channels are arranged in order of risk and

2149

# frequency of updates.

2150

#

2151

# When a cluster is subscribed to a release channel, Google maintains

2152

# both the master version and the node version. Node auto-upgrade

2153

# defaults to true and cannot be disabled. Updates to version related

2154

# fields (e.g. current_master_version) return an error.

2155

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

2156

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2157

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

2158

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

2159

"provider": "A String", # The selected network policy provider.

2160

"enabled": True or False, # Whether network policy is enabled on the cluster.

2161

},

2162

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

2163

# this cluster, in

2164

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2165

# notation (e.g. `1.2.3.4/29`). Service addresses are

2166

# typically put in the last `/16` from the container CIDR.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2167

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

2168

# API groups (e.g. v1beta1) and features that may not be production ready in

2169

# the kubernetes version of the master and nodes.

2170

# The cluster has no SLA for uptime and master/node upgrades are disabled.

2171

# Alpha enabled clusters are automatically deleted thirty days after

2172

# creation.

2173

"description": "A String", # An optional description of this cluster.

2174

"conditions": [ # Which conditions caused the current cluster state.

2175

{ # StatusCondition describes why a cluster or a node pool has a certain status

2176

# (e.g., ERROR or DEGRADED).

2177

"code": "A String", # Machine-friendly representation of the condition

2178

"message": "A String", # Human-friendly representation of the condition

2179

},

2180

],

2181

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by

2182

# default have no external IP addresses on the nodes and where nodes and the

2183

# master communicate over private IP addresses.

2184

# This field is deprecated, use private_cluster_config.enable_private_nodes

2185

# instead.

2186

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

2187

# Call Kubernetes API directly to retrieve node information.

2188

"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]

2189

# Currently available options:

2190

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2191

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2192

# service with a Kubernetes-native resource model

2193

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

2194

# longer available as of GKE 1.15).

2195

# * `none` - No metrics will be exported from the cluster.

2196

#

2197

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

2198

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2199

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2200

"state": "A String", # Denotes the state of etcd encryption.

2201

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2202

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2203

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2204

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

2205

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

2206

# images will be validated by Google Binauthz.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2207

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2208

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

2209

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2210

# notation (e.g. `1.2.3.4/29`).

2211

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

2212

# policies.

2213

# policies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2214

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2215

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2216

},

2217

"zone": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2218

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2219

# cluster resides. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2220

"loggingService": "A String", # The logging service the cluster should use to write logs.

2221

# Currently available options:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2222

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2223

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

2224

# service with a Kubernetes-native resource model

2225

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

2226

# available as of GKE 1.15).

2227

# * `none` - no logs will be exported from the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2228

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2229

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

2230

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

2231

"expireTime": "A String", # [Output only] The time the cluster will be automatically

2232

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2233

"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]

2234

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2235

# "node_pool" object, since this configuration (along with the

2236

# "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]

2237

# auto-generated name. Do not use this and a node_pool at the same time.

2238

# For responses, this field will be populated with the node configuration of

2239

# the first node pool. (For configuration of each node pool, see

2240

# `node_pool.config`)

2241

#

2242

# If unspecified, the defaults are used.

2243

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2244

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2245

# scheduled on the specified or newer CPU platform. Applicable values are the

2246

# friendly names of CPU platforms, such as

2247

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2248

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2249

# information, read [how to specify min CPU

2250

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2251

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2252

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2253

#

2254

# Enables monitoring and attestation of the boot integrity of the instance.

2255

# The attestation is performed against the integrity policy baseline. This

2256

# baseline is initially derived from the implicitly trusted boot image when

2257

# the instance is created.

2258

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2259

#

2260

# Secure Boot helps ensure that the system only runs authentic software by

2261

# verifying the digital signature of all boot components, and halting the

2262

# boot process if signature verification fails.

2263

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2264

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2265

# https://cloud.google.com/compute/docs/instances/preemptible for more

2266

# inforamtion about preemptible VM instances.

2267

"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]

2268

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2269

# The limit for this value is dependent upon the maximum number of

2270

# disks available on a machine per zone. See:

2271

# https://cloud.google.com/compute/docs/disks/local-ssd

2272

# for more information.

2273

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2274

"type": "A String", # Type of the sandbox to use for the node.

2275

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

2276

},

2277

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2278

#

2279

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2280

# in length. These are reflected as part of a URL in the metadata server.

2281

# Additionally, to avoid ambiguity, keys must not conflict with any other

2282

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2288

# "enable-oslogin"

2289

# "gci-ensure-gke-docker"

2290

# "gci-metrics-enabled"

2291

# "gci-update-strategy"

2292

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2297

# "windows-startup-script-ps1"

2298

# "common-psm1"

2299

# "k8s-node-setup-psm1"

2300

# "install-ssh-psm1"

2301

# "user-profile-psm1"

2302

# "serial-port-logging-enable"

2303

# Values are free-form strings, and only have meaning as interpreted by

2304

# the image running in the instance. The only restriction placed on them is

2305

# that each value's size must be less than or equal to 32 KB.

2306

#

2307

# The total size of all keys and values must be less than 512 KB.

2308

"a_key": "A String",

2309

},

2310

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2311

# the specified [Zonal Compute

2312

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2313

# to this node pool.

2314

# is the configuration of desired reservation which instances could take

2315

# capacity from.

2316

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2317

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2318

# the key and specify the name of your reservation as its value.

2319

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2320

"A String",

2321

],

2322

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2323

},

2324

"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]

2325

# valid sources or targets for network firewalls and are specified by

2326

# the client during cluster or node pool creation. Each tag within the list

2327

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2328

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2329

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2330

"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]

2331

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2332

# Account is specified, the "default" service account is used.

2333

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2334

# the latest version of it will be used.

2335

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2336

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2337

#

2338

# The following scopes are recommended, but not required, and by default are

2339

# not included:

2340

#

2341

# * `https://www.googleapis.com/auth/compute` is required for mounting

2342

# persistent storage on your nodes.

2343

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2344

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2345

# (the [Google Container

2346

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2347

#

2348

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2349

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2350

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2351

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2352

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2353

#

2354

# For more information, including usage and the valid values, see:

2355

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2356

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2357

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2358

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2359

# See

2360

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2361

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2362

"effect": "A String", # Effect for taint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2363

"value": "A String", # Value for taint.

2364

"key": "A String", # Key for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2365

},

2366

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2367

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2368

# These will added in addition to any default label(s) that

2369

# Kubernetes may apply to the node.

2370

# In case of conflict in label keys, the applied set may differ depending on

2371

# the Kubernetes version -- it's best to assume the behavior is undefined

2372

# and conflicts should be avoided.

2373

# For more information, including usage and the valid values, see:

2374

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2375

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2376

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2377

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2378

# The smallest allowed disk size is 10GB.

2379

#

2380

# If unspecified, the default disk size is 100GB.

2381

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2382

# workloads on the node pool.

2383

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

2384

# workloads running on the node.

2385

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2386

# on the node pool.

2387

},

2388

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2389

# See https://cloud.google.com/compute/docs/gpus for more information about

2390

# support for GPUs.

2391

{ # AcceleratorConfig represents a Hardware Accelerator request.

2392

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2393

# [here](https://cloud.google.com/compute/docs/gpus)

2394

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2395

},

2396

],

2397

"machineType": "A String", # The name of a Google Compute Engine [machine

2398

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2399

# `n1-standard-1`).

2400

#

2401

# If unspecified, the default machine type is

2402

# `n1-standard-1`.

2403

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2404

#

2405

# If unspecified, the default disk type is 'pd-standard'

2406

"bootDiskKmsKey": "A String", #

2407

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2408

# to each node in the node pool. This should be of the form

2409

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2410

# For more information about protecting resources with Cloud KMS Keys please

2411

# see:

2412

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

2413

},

2414

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

2415

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

2416

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

2417

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2418

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2419

"status": "A String", # [Output only] The current status of this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2420

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2421

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

2422

# This makes same node pod to pod traffic visible for VPC network.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2423

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

2424

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

2425

# cluster is connected. Example:

2426

# projects/my-project/regions/us-central1/subnetworks/my-subnet

2427

"network": "A String", # Output only. The relative name of the Google Compute Engine

2428

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2429

# to which the cluster is connected. Example:

2430

# projects/my-project/global/networks/my-network

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2431

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules

2432

# will be disabled when default_snat_status is disabled. When disabled is set

2433

# to false, default IP masquerade rules will be applied to the nodes to

2434

# prevent sNAT on cluster internal traffic.

2435

# be disabled on the cluster.

2436

"disabled": True or False, # Disables cluster default sNAT rules.

2437

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2438

},

2439

"name": "A String", # The name of this cluster. The name must be unique within this project

2440

# and location (e.g. zone or region), and can be up to 40 characters with

2441

# the following restrictions:

2442

#

2443

# * Lowercase letters, numbers, and hyphens only.

2444

# * Must start with a letter.

2445

# * Must end with a number or a letter.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2446

"location": "A String", # [Output only] The name of the Google Compute Engine

2447

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2448

# or

2449

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2450

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2451

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

2452

# The endpoint can be accessed from the internet at

2453

# `https://username:password@endpoint/`.

2454

#

2455

# See the `masterAuth` property of this resource for username and

2456

# password information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2457

"createTime": "A String", # [Output only] The time the cluster was created, in

2458

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2459

"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]

2460

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2461

# notation (e.g. `10.96.0.0/14`). Leave blank to have

2462

# 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]

2463

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

2464

# required by Cluster Autoscaler to automatically adjust

2465

# the size of the cluster and create/delete

2466

# node pools based on the current needs.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2467

"autoprovisioningLocations": [ # The list of Google Compute Engine

2468

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2469

# NodePool's nodes can be created by NAP.

2470

"A String",

2471

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2472

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

2473

# amount of resources in the cluster.

2474

{ # Contains information about amount of some resource in the cluster.

2475

# For memory, value should be in GB.

2476

"maximum": "A String", # Maximum amount of the resource in the cluster.

2477

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

2478

"minimum": "A String", # Minimum amount of the resource in the cluster.

2479

},

2480

],

2481

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

2482

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

2483

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

2484

# created by NAP.

2485

# by NAP.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2486

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

2487

# service_account is specified, scopes should be empty.

2488

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

2489

# The instance may be scheduled on the specified or newer CPU platform.

2490

# Applicable values are the friendly names of CPU platforms, such as

2491

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2492

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2493

# information, read [how to specify min CPU

2494

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2495

# To unset the min cpu platform field pass "automatic" as field value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2496

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

2497

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2498

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2499

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2500

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2501

# the Auto Upgrades will proceed.

2502

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2503

# with the description of the upgrade.

2504

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2505

# with the approximate start time for the upgrades, in

2506

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2507

},

2508

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2509

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

2510

# specified, service_account should be empty.

2511

"A String",

2512

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2513

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

2514

# disruption caused by an upgrade.

2515

#

2516

# maxUnavailable controls the number of nodes that can be simultaneously

2517

# unavailable.

2518

#

2519

# maxSurge controls the number of additional nodes that can be added to the

2520

# node pool temporarily for the time of the upgrade to increase the number of

2521

# available nodes.

2522

#

2523

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2524

# nodes are being upgraded at the same time).

2525

#

2526

# Note: upgrades inevitably introduce some disruption since workloads need to

2527

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2528

# this holds true. (Disruption stays within the limits of

2529

# PodDisruptionBudget, if it is configured.)

2530

#

2531

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2532

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2533

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2534

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2535

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2536

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2537

# the upgrade process. A node is considered available if its status is

2538

# Ready.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2539

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2540

# of the node pool during the upgrade process.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2541

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2542

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2543

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2544

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

2545

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2546

# is sufficient for this number of instances. You must also have available

2547

# firewall and routes quota.

2548

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2549

# "node_pool" object, since this configuration (along with the

2550

# "node_config") will be used to create a "NodePool" object with an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2551

# auto-generated name. Do not use this and a node_pool at the same time.

2552

#

2553

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2554

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

2555

"A String",

2556

],

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>

2562

<pre>Gets the public component of the cluster signing keys in

2563

JSON Web Key format.

2564

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]

2569

the format `projects/*/locations/*/clusters/*`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2570

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2577

2578

{ # GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2579

"cacheHeader": { # RFC-2616: cache control support # OnePlatform automatically extracts this field and uses it to set the HTTP

2580

# Cache-Control header.

2581

"age": "A String", # 14.6 response cache age, in seconds since the response is generated

2582

"expires": "A String", # 14.21 response cache expires, in RFC 1123 date format

2583

"directive": "A String", # 14.9 request and response directives

2584

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2585

"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]

2586

# requests.

2587

{ # Jwk is a JSON Web Key as specified in RFC 7517

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2588

"e": "A String", # Used for RSA keys.

2589

"kty": "A String", # Key Type.

2590

"alg": "A String", # Algorithm.

2591

"n": "A String", # Used for RSA keys.

2592

"y": "A String", # Used for ECDSA keys.

2593

"use": "A String", # Permitted uses for the public keys.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2594

"x": "A String", # Used for ECDSA keys.

2595

"crv": "A String", # Used for ECDSA keys.

2596

"kid": "A String", # Key ID.

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]

2603

<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]

2604

<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]

2609

Specified in the format `projects/*/locations/*`.

2610

Location "-" matches all zones and all regions. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2611

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2612

number](https://support.google.com/cloud/answer/6158840).

2613

This field has been deprecated and replaced by the parent field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2614

zone: string, Required. Deprecated. The name of the Google Compute Engine

2615

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

2616

cluster resides, or "-" for all zones. This field has been deprecated and

2617

replaced by the parent field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2618

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2625

2626

{ # ListClustersResponse is the result of ListClustersRequest.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2627

"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]

2628

# across all ones.

2629

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2630

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

2631

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

2632

# range will be used for assigning internal IP addresses to the master or

2633

# set of masters, as well as the ILB VIP. This range must not overlap with

2634

# any other ranges in use within the cluster's network.

2635

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

2636

# given only RFC 1918 private addresses and communicate with the master via

2637

# private networking.

2638

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

2639

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

2640

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

2641

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

2642

"enabled": True or False, # Whenever master is accessible globally or not.

2643

},

2644

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

2645

},

2646

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

2647

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

2648

},

2649

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

2650

# required by Vertical Pod Autoscaler to automatically adjust

2651

# the resources of pods controlled by it.

2652

"enabled": True or False, # Enables vertical pod autoscaling.

2653

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2654

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

2655

# simultaneously on a node in the node pool of this cluster. Only honored

2656

# if cluster created with IP Alias support.

2657

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2658

},

2659

"network": "A String", # The name of the Google Compute Engine

2660

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2661

# to which the cluster is connected. If left unspecified, the `default`

2662

# network will be used. On output this shows the network ID instead of the

2663

# name.

2664

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

2665

"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]

2666

# containers. This is provisioned from within the `container_ipv4_cidr`

2667

# range. This field will only be set when cluster is in route-based network

2668

# mode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2669

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

2670

# master authorized networks will disallow all external traffic to access

2671

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

2672

# Google Compute Engine Public IPs and Google Prod IPs.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2673

"enabled": True or False, # Whether or not master authorized networks is enabled.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2674

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

2675

# Kubernetes master through HTTPS.

2676

{ # CidrBlock contains an optional name and one CIDR block.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2677

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2678

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2679

},

2680

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2681

},

2682

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2683

# cluster, if available.

2684

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

2685

# If unspecified, the defaults are used:

2686

# For clusters before v1.12, if master_auth is unspecified, `username` will

2687

# be set to "admin", a random password will be generated, and a client

2688

# certificate will be issued.

2689

# Authentication can be done using HTTP basic auth or using client

2690

# certificates.

2691

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

2692

# Because the master endpoint is open to the Internet, you should create a

2693

# strong password. If a password is provided for cluster creation, username

2694

# must be non-empty.

2695

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

2696

# clusters before v1.12, if no configuration is specified, a client

2697

# certificate is issued.

2698

"issueClientCertificate": True or False, # Issue a client certificate.

2699

},

2700

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

2701

# to the cluster endpoint.

2702

"clusterCaCertificate": "A String",

2703

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

2704

# authenticate to the cluster endpoint.

2705

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

2706

# For clusters v1.6.0 and later, basic authentication can be disabled by

2707

# leaving username unspecified (or setting it to the empty string).

2708

},

2709

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2710

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

2711

# if enabled = true.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2712

"enabled": True or False, # Whether this cluster should return group membership lookups

2713

# during authentication using a group of security groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2714

},

2715

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network.

2716

# This prefix will be used for assigning private IP addresses to the

2717

# master or set of masters, as well as the ILB VIP.

2718

# This field is deprecated, use

2719

# private_cluster_config.master_ipv4_cidr_block instead.

2720

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

2721

"type": "A String", # Type of the integration.

2722

},

2723

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2724

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

2725

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

2726

# must be valid under a PodSecurityPolicy to be created.

2727

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2728

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

2729

# cluster, enabling additional functionality.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2730

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

2731

# makes it easy to set up HTTP load balancers for services in a cluster.

2732

# which makes it easy to set up HTTP load balancers for services in a cluster.

2733

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

2734

# When enabled, it runs a small pod in the cluster that manages the load

2735

# balancers.

2736

},

2737

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

2738

# This addon is deprecated, and will be disabled in 1.15. It is recommended

2739

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

2740

# workloads and applications. For more information, see:

2741

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

2742

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

2743

},

2744

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

2745

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

2746

},

2747

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

2748

# applications.

2749

"enabled": True or False, # Whether KALM is enabled for this cluster.

2750

},

2751

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

2752

# enabled at cluster creation time.

2753

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

2754

},

2755

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

2756

# microservices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2757

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2758

"disabled": True or False, # Whether Istio is enabled for this cluster.

2759

},

2760

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

2761

# is enabled or not on the Master, it does not track whether network policy

2762

# is enabled for the nodes.

2763

# is enabled or not on the Master, it does not track whether network policy

2764

# is enabled for the nodes.

2765

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

2766

},

2767

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

2768

# enabled in order to enable Cloud Run addon. This option can only be enabled

2769

# at cluster creation time.

2770

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2771

},

2772

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

2773

# extension to manage hosted GCP services through the Kubernetes API

2774

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

2775

},

2776

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

2777

# increases or decreases the number of replica pods a replication controller

2778

# has based on the resource usage of the existing pods.

2779

# increases or decreases the number of replica pods a replication controller

2780

# has based on the resource usage of the existing pods.

2781

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

2782

# When enabled, it ensures that metrics are collected into Stackdriver

2783

# Monitoring.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2784

},

2785

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2786

"subnetwork": "A String", # The name of the Google Compute Engine

2787

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

2788

# the cluster is connected. On output this shows the subnetwork ID instead of

2789

# the name.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2790

"currentNodeVersion": "A String", # [Output only] Deprecated, use

2791

# [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools)

2792

# instead. The current version of the node software components.

2793

# If they are currently at multiple versions because they're in the process

2794

# of being upgraded, this reflects the minimum version of all nodes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2795

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2796

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2797

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

2798

# occur in these windows.

2799

"a_key": { # Represents an arbitrary window of time.

2800

"startTime": "A String", # The time that the window first starts.

2801

"endTime": "A String", # The time that the window ends. The end time should take place after the

2802

# start time.

2803

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2804

},

2805

"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]

2806

# maintenance to occur. The time windows may be overlapping. If no

2807

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2808

"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]

2809

# this window reccurs. They go on for the span of time between the start and

2810

# end time.

2811

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2812

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2813

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

2814

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

2815

# <code>FREQ=DAILY</code>

2816

# For the first weekend of every month:

2817

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

2818

# 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]

2819

# 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]

2820

# <code>

2821

# start time = 2019-01-01T09:00:00-0400

2822

# end time = 2019-01-01T17:00:00-0400

2823

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

2824

# </code>

2825

# Windows can span multiple days. Eg, to make the window encompass every

2826

# weekend from midnight Saturday till the last minute of Sunday UTC:

2827

# <code>

2828

# start time = 2019-01-05T00:00:00Z

2829

# end time = 2019-01-07T23:59:00Z

2830

# recurrence = FREQ=WEEKLY;BYDAY=SA

2831

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2832

# 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]

2833

# to specify duration of the window and when it first starts.

2834

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2835

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2836

"startTime": "A String", # The time that the window first starts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2837

"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]

2838

# start time.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2839

},

2840

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2841

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

2842

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

2843

# smallest possible in the given scenario.

2844

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

2845

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2846

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2847

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2848

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

2849

# the policy won't accidentally undo intermediate changes (and so that users

2850

# of the API unaware of some fields won't accidentally remove other fields).

2851

# Make a <code>get()</code> request to the cluster to get the current

2852

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2853

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2854

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

2855

# Google Compute Engine resources.

2856

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2857

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2858

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

2859

# found in validMasterVersions returned by getServerConfig. The version can

2860

# be upgraded over time; such upgrades are reflected in

2861

# currentMasterVersion and currentNodeVersion.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2862

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2863

# Users may specify either explicit versions offered by

2864

# Kubernetes Engine or version aliases, which have the following behavior:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2865

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2866

# - "latest": picks the highest valid Kubernetes version

2867

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

2868

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

2869

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

2870

# - "","-": picks the default Kubernetes version

2871

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

2872

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster.

2873

# This is used in conjunction with use_ip_aliases. It cannot be true if

2874

# use_ip_aliases is true. If both use_ip_aliases and use_routes are false,

2875

# then the server picks the default IP allocation mode

2876

"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]

2877

# will be automatically chosen with the default size.

2878

#

2879

# This field is only applicable when `use_ip_aliases` is true.

2880

#

2881

# Set to blank to have a range chosen with the default size.

2882

#

2883

# 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)

2888

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2889

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2890

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2891

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain

2892

# kinds of network routes. By default we do not allow cluster CIDR ranges to

2893

# intersect with any user declared routes. With allow_route_overlap == true,

2894

# we allow overlapping with CIDR ranges that are larger than the cluster CIDR

2895

# range.

2896

#

2897

# If this field is set to true, then cluster and services CIDRs must be

2898

# fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:

2899

# 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and

2900

# `services_ipv4_cidr_block` must be fully-specified.

2901

# 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be

2902

# fully-specified.

2903

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

2904

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

2905

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2906

#

2907

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2908

#

2909

# Set to blank to have a range chosen with the default size.

2910

#

2911

# 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)

2916

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2917

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2918

# to use.

2919

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

2920

# block. The secondary range will be used for pod IP

2921

# addresses. This must be an existing secondary range associated

2922

# with the cluster subnetwork.

2923

#

2924

# This field is only applicable with use_ip_aliases and

2925

# create_subnetwork is false.

2926

"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]

2927

#

2928

# This is applicable only if `create_subnetwork` is true.

2929

#

2930

# Set to blank to have a range chosen with the default size.

2931

#

2932

# 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)

2937

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2938

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2939

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2940

"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]

2941

# range will be automatically chosen with the default size.

2942

#

2943

# This field is only applicable when `use_ip_aliases` is true.

2944

#

2945

# If unspecified, the range will use the default size.

2946

#

2947

# 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)

2952

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2953

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2954

# to use.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2955

# This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2956

"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]

2957

# CIDR block. The secondary range will be used for service

2958

# ClusterIPs. This must be an existing secondary range associated

2959

# with the cluster subnetwork.

2960

#

2961

# This field is only applicable with use_ip_aliases and

2962

# create_subnetwork is false.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2963

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

2964

#

2965

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2966

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

2967

# This is used in conjunction with use_routes. It cannot

2968

# be true if use_routes is true. If both use_ip_aliases and use_routes are

2969

# false, then the server picks the default IP allocation mode

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2970

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

2971

# this field is empty, then an automatic name will be chosen for the new

2972

# subnetwork.

2973

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

2974

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2975

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2976

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

2977

# mode.

2978

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

2979

# identities in the system, including service accounts, nodes, and

2980

# controllers, will have statically granted permissions beyond those

2981

# provided by the RBAC configuration or IAM.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2982

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2983

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

2984

# disabled when this config unspecified.

2985

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

2986

# daemonset will be created in the cluster to meter network egress traffic.

2987

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

2988

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

2989

# second BigQuery table will be created to hold resource consumption

2990

# records.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2991

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2992

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2993

"datasetId": "A String", # The ID of a BigQuery Dataset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2994

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2995

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2996

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

2997

# This field is deprecated, use tpu_config.enabled instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2998

"nodePools": [ # The node pools associated with this cluster.

2999

# 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]

3000

# specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3001

{ # NodePool contains the name and configuration for a cluster's node pool.

3002

# 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]

3003

# specification, under the control of the cluster master. They may have a set

3004

# of Kubernetes labels applied to them, which may be used to reference them

3005

# during pod scheduling. They may also be resized up or down, to accommodate

3006

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3007

"status": "A String", # [Output only] The status of the nodes in this pool instance.

3008

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3009

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3010

# scheduled on the specified or newer CPU platform. Applicable values are the

3011

# friendly names of CPU platforms, such as

3012

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3013

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3014

# information, read [how to specify min CPU

3015

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3016

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3017

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3018

#

3019

# Enables monitoring and attestation of the boot integrity of the instance.

3020

# The attestation is performed against the integrity policy baseline. This

3021

# baseline is initially derived from the implicitly trusted boot image when

3022

# the instance is created.

3023

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3024

#

3025

# Secure Boot helps ensure that the system only runs authentic software by

3026

# verifying the digital signature of all boot components, and halting the

3027

# boot process if signature verification fails.

3028

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3029

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3030

# https://cloud.google.com/compute/docs/instances/preemptible for more

3031

# inforamtion about preemptible VM instances.

3032

"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]

3033

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3034

# The limit for this value is dependent upon the maximum number of

3035

# disks available on a machine per zone. See:

3036

# https://cloud.google.com/compute/docs/disks/local-ssd

3037

# for more information.

3038

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3039

"type": "A String", # Type of the sandbox to use for the node.

3040

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

3041

},

3042

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3043

#

3044

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3045

# in length. These are reflected as part of a URL in the metadata server.

3046

# Additionally, to avoid ambiguity, keys must not conflict with any other

3047

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3053

# "enable-oslogin"

3054

# "gci-ensure-gke-docker"

3055

# "gci-metrics-enabled"

3056

# "gci-update-strategy"

3057

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3062

# "windows-startup-script-ps1"

3063

# "common-psm1"

3064

# "k8s-node-setup-psm1"

3065

# "install-ssh-psm1"

3066

# "user-profile-psm1"

3067

# "serial-port-logging-enable"

3068

# Values are free-form strings, and only have meaning as interpreted by

3069

# the image running in the instance. The only restriction placed on them is

3070

# that each value's size must be less than or equal to 32 KB.

3071

#

3072

# The total size of all keys and values must be less than 512 KB.

3073

"a_key": "A String",

3074

},

3075

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3076

# the specified [Zonal Compute

3077

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3078

# to this node pool.

3079

# is the configuration of desired reservation which instances could take

3080

# capacity from.

3081

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3082

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3083

# the key and specify the name of your reservation as its value.

3084

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3085

"A String",

3086

],

3087

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3088

},

3089

"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]

3090

# valid sources or targets for network firewalls and are specified by

3091

# the client during cluster or node pool creation. Each tag within the list

3092

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3093

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3094

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3095

"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]

3096

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3097

# Account is specified, the "default" service account is used.

3098

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3099

# the latest version of it will be used.

3100

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3101

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3102

#

3103

# The following scopes are recommended, but not required, and by default are

3104

# not included:

3105

#

3106

# * `https://www.googleapis.com/auth/compute` is required for mounting

3107

# persistent storage on your nodes.

3108

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3109

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3110

# (the [Google Container

3111

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3112

#

3113

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3114

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3115

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3116

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3117

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3118

#

3119

# For more information, including usage and the valid values, see:

3120

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3121

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3122

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3123

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3124

# See

3125

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3126

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3127

"effect": "A String", # Effect for taint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3128

"value": "A String", # Value for taint.

3129

"key": "A String", # Key for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3130

},

3131

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3132

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3133

# These will added in addition to any default label(s) that

3134

# Kubernetes may apply to the node.

3135

# In case of conflict in label keys, the applied set may differ depending on

3136

# the Kubernetes version -- it's best to assume the behavior is undefined

3137

# and conflicts should be avoided.

3138

# For more information, including usage and the valid values, see:

3139

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3140

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3141

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3142

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3143

# The smallest allowed disk size is 10GB.

3144

#

3145

# If unspecified, the default disk size is 100GB.

3146

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3147

# workloads on the node pool.

3148

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

3149

# workloads running on the node.

3150

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3151

# on the node pool.

3152

},

3153

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3154

# See https://cloud.google.com/compute/docs/gpus for more information about

3155

# support for GPUs.

3156

{ # AcceleratorConfig represents a Hardware Accelerator request.

3157

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3158

# [here](https://cloud.google.com/compute/docs/gpus)

3159

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3160

},

3161

],

3162

"machineType": "A String", # The name of a Google Compute Engine [machine

3163

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3164

# `n1-standard-1`).

3165

#

3166

# If unspecified, the default machine type is

3167

# `n1-standard-1`.

3168

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3169

#

3170

# If unspecified, the default disk type is 'pd-standard'

3171

"bootDiskKmsKey": "A String", #

3172

# The Customer Managed Encryption Key used to encrypt the boot disk attached

3173

# to each node in the node pool. This should be of the form

3174

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

3175

# For more information about protecting resources with Cloud KMS Keys please

3176

# see:

3177

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3178

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3179

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

3180

# simultaneously on a node in the node pool.

3181

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

3182

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3183

"name": "A String", # The name of the node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3184

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

3185

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3186

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3187

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3188

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3189

# the Auto Upgrades will proceed.

3190

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3191

# with the description of the upgrade.

3192

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3193

# with the approximate start time for the upgrades, in

3194

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3195

},

3196

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3197

"statusMessage": "A String", # [Output only] Additional information about the current status of this

3198

# node pool instance, if available.

3199

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

3200

# only if a valid configuration is present.

3201

# adjust the size of the node pool to the current cluster usage.

3202

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

3203

# has to enough quota to scale up the cluster.

3204

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

3205

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

3206

# max_node_count.

3207

"enabled": True or False, # Is autoscaling enabled for this node pool.

3208

},

3209

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

3210

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

3211

# is sufficient for this number of instances. You must also have available

3212

# firewall and routes quota.

3213

"locations": [ # The list of Google Compute Engine

3214

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3215

# NodePool's nodes should be located.

3216

"A String",

3217

],

3218

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

3219

# disruption caused by an upgrade.

3220

#

3221

# maxUnavailable controls the number of nodes that can be simultaneously

3222

# unavailable.

3223

#

3224

# maxSurge controls the number of additional nodes that can be added to the

3225

# node pool temporarily for the time of the upgrade to increase the number of

3226

# available nodes.

3227

#

3228

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3229

# nodes are being upgraded at the same time).

3230

#

3231

# Note: upgrades inevitably introduce some disruption since workloads need to

3232

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3233

# this holds true. (Disruption stays within the limits of

3234

# PodDisruptionBudget, if it is configured.)

3235

#

3236

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3237

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3238

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3239

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3240

# there are always at least 4 nodes available.

3241

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3242

# the upgrade process. A node is considered available if its status is

3243

# Ready.

3244

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3245

# of the node pool during the upgrade process.

3246

},

3247

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

3248

"version": "A String", # The version of the Kubernetes of this node.

3249

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

3250

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

3251

# associated with this node pool.

3252

"A String",

3253

],

3254

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

3255

"conditions": [ # Which conditions caused the current node pool state.

3256

{ # StatusCondition describes why a cluster or a node pool has a certain status

3257

# (e.g., ERROR or DEGRADED).

3258

"code": "A String", # Machine-friendly representation of the condition

3259

"message": "A String", # Human-friendly representation of the condition

3260

},

3261

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3262

},

3263

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3264

"locations": [ # The list of Google Compute Engine

3265

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3266

# cluster's nodes should be located.

3267

"A String",

3268

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3269

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3270

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

3271

# subscribed to. Release channels are arranged in order of risk and

3272

# frequency of updates.

3273

#

3274

# When a cluster is subscribed to a release channel, Google maintains

3275

# both the master version and the node version. Node auto-upgrade

3276

# defaults to true and cannot be disabled. Updates to version related

3277

# fields (e.g. current_master_version) return an error.

3278

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

3279

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3280

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

3281

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

3282

"provider": "A String", # The selected network policy provider.

3283

"enabled": True or False, # Whether network policy is enabled on the cluster.

3284

},

3285

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

3286

# this cluster, in

3287

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3288

# notation (e.g. `1.2.3.4/29`). Service addresses are

3289

# typically put in the last `/16` from the container CIDR.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3290

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

3291

# API groups (e.g. v1beta1) and features that may not be production ready in

3292

# the kubernetes version of the master and nodes.

3293

# The cluster has no SLA for uptime and master/node upgrades are disabled.

3294

# Alpha enabled clusters are automatically deleted thirty days after

3295

# creation.

3296

"description": "A String", # An optional description of this cluster.

3297

"conditions": [ # Which conditions caused the current cluster state.

3298

{ # StatusCondition describes why a cluster or a node pool has a certain status

3299

# (e.g., ERROR or DEGRADED).

3300

"code": "A String", # Machine-friendly representation of the condition

3301

"message": "A String", # Human-friendly representation of the condition

3302

},

3303

],

3304

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by

3305

# default have no external IP addresses on the nodes and where nodes and the

3306

# master communicate over private IP addresses.

3307

# This field is deprecated, use private_cluster_config.enable_private_nodes

3308

# instead.

3309

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

3310

# Call Kubernetes API directly to retrieve node information.

3311

"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]

3312

# Currently available options:

3313

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3314

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3315

# service with a Kubernetes-native resource model

3316

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

3317

# longer available as of GKE 1.15).

3318

# * `none` - No metrics will be exported from the cluster.

3319

#

3320

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

3321

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3322

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

3323

"state": "A String", # Denotes the state of etcd encryption.

3324

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3325

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3326

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3327

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

3328

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

3329

# images will be validated by Google Binauthz.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3330

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3331

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

3332

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3333

# notation (e.g. `1.2.3.4/29`).

3334

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

3335

# policies.

3336

# policies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3337

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3338

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3339

},

3340

"zone": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3341

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3342

# cluster resides. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3343

"loggingService": "A String", # The logging service the cluster should use to write logs.

3344

# Currently available options:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3345

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3346

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

3347

# service with a Kubernetes-native resource model

3348

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

3349

# available as of GKE 1.15).

3350

# * `none` - no logs will be exported from the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3351

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3352

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

3353

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

3354

"expireTime": "A String", # [Output only] The time the cluster will be automatically

3355

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3356

"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]

3357

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3358

# "node_pool" object, since this configuration (along with the

3359

# "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]

3360

# auto-generated name. Do not use this and a node_pool at the same time.

3361

# For responses, this field will be populated with the node configuration of

3362

# the first node pool. (For configuration of each node pool, see

3363

# `node_pool.config`)

3364

#

3365

# If unspecified, the defaults are used.

3366

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3367

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3368

# scheduled on the specified or newer CPU platform. Applicable values are the

3369

# friendly names of CPU platforms, such as

3370

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3371

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3372

# information, read [how to specify min CPU

3373

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3374

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3375

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3376

#

3377

# Enables monitoring and attestation of the boot integrity of the instance.

3378

# The attestation is performed against the integrity policy baseline. This

3379

# baseline is initially derived from the implicitly trusted boot image when

3380

# the instance is created.

3381

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3382

#

3383

# Secure Boot helps ensure that the system only runs authentic software by

3384

# verifying the digital signature of all boot components, and halting the

3385

# boot process if signature verification fails.

3386

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3387

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3388

# https://cloud.google.com/compute/docs/instances/preemptible for more

3389

# inforamtion about preemptible VM instances.

3390

"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]

3391

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3392

# The limit for this value is dependent upon the maximum number of

3393

# disks available on a machine per zone. See:

3394

# https://cloud.google.com/compute/docs/disks/local-ssd

3395

# for more information.

3396

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3397

"type": "A String", # Type of the sandbox to use for the node.

3398

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

3399

},

3400

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3401

#

3402

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3403

# in length. These are reflected as part of a URL in the metadata server.

3404

# Additionally, to avoid ambiguity, keys must not conflict with any other

3405

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3411

# "enable-oslogin"

3412

# "gci-ensure-gke-docker"

3413

# "gci-metrics-enabled"

3414

# "gci-update-strategy"

3415

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3420

# "windows-startup-script-ps1"

3421

# "common-psm1"

3422

# "k8s-node-setup-psm1"

3423

# "install-ssh-psm1"

3424

# "user-profile-psm1"

3425

# "serial-port-logging-enable"

3426

# Values are free-form strings, and only have meaning as interpreted by

3427

# the image running in the instance. The only restriction placed on them is

3428

# that each value's size must be less than or equal to 32 KB.

3429

#

3430

# The total size of all keys and values must be less than 512 KB.

3431

"a_key": "A String",

3432

},

3433

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3434

# the specified [Zonal Compute

3435

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3436

# to this node pool.

3437

# is the configuration of desired reservation which instances could take

3438

# capacity from.

3439

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3440

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3441

# the key and specify the name of your reservation as its value.

3442

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3443

"A String",

3444

],

3445

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3446

},

3447

"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]

3448

# valid sources or targets for network firewalls and are specified by

3449

# the client during cluster or node pool creation. Each tag within the list

3450

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3451

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3452

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3453

"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]

3454

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3455

# Account is specified, the "default" service account is used.

3456

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3457

# the latest version of it will be used.

3458

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3459

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3460

#

3461

# The following scopes are recommended, but not required, and by default are

3462

# not included:

3463

#

3464

# * `https://www.googleapis.com/auth/compute` is required for mounting

3465

# persistent storage on your nodes.

3466

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3467

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3468

# (the [Google Container

3469

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3470

#

3471

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3472

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3473

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3474

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3475

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3476

#

3477

# For more information, including usage and the valid values, see:

3478

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3479

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3480

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3481

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3482

# See

3483

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3484

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3485

"effect": "A String", # Effect for taint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3486

"value": "A String", # Value for taint.

3487

"key": "A String", # Key for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3488

},

3489

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3490

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3491

# These will added in addition to any default label(s) that

3492

# Kubernetes may apply to the node.

3493

# In case of conflict in label keys, the applied set may differ depending on

3494

# the Kubernetes version -- it's best to assume the behavior is undefined

3495

# and conflicts should be avoided.

3496

# For more information, including usage and the valid values, see:

3497

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3498

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3499

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3500

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3501

# The smallest allowed disk size is 10GB.

3502

#

3503

# If unspecified, the default disk size is 100GB.

3504

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3505

# workloads on the node pool.

3506

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

3507

# workloads running on the node.

3508

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3509

# on the node pool.

3510

},

3511

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3512

# See https://cloud.google.com/compute/docs/gpus for more information about

3513

# support for GPUs.

3514

{ # AcceleratorConfig represents a Hardware Accelerator request.

3515

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3516

# [here](https://cloud.google.com/compute/docs/gpus)

3517

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3518

},

3519

],

3520

"machineType": "A String", # The name of a Google Compute Engine [machine

3521

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3522

# `n1-standard-1`).

3523

#

3524

# If unspecified, the default machine type is

3525

# `n1-standard-1`.

3526

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3527

#

3528

# If unspecified, the default disk type is 'pd-standard'

3529

"bootDiskKmsKey": "A String", #

3530

# The Customer Managed Encryption Key used to encrypt the boot disk attached

3531

# to each node in the node pool. This should be of the form

3532

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

3533

# For more information about protecting resources with Cloud KMS Keys please

3534

# see:

3535

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

3536

},

3537

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

3538

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

3539

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

3540

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3541

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3542

"status": "A String", # [Output only] The current status of this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3543

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3544

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

3545

# This makes same node pod to pod traffic visible for VPC network.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3546

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

3547

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

3548

# cluster is connected. Example:

3549

# projects/my-project/regions/us-central1/subnetworks/my-subnet

3550

"network": "A String", # Output only. The relative name of the Google Compute Engine

3551

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

3552

# to which the cluster is connected. Example:

3553

# projects/my-project/global/networks/my-network

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3554

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules

3555

# will be disabled when default_snat_status is disabled. When disabled is set

3556

# to false, default IP masquerade rules will be applied to the nodes to

3557

# prevent sNAT on cluster internal traffic.

3558

# be disabled on the cluster.

3559

"disabled": True or False, # Disables cluster default sNAT rules.

3560

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3561

},

3562

"name": "A String", # The name of this cluster. The name must be unique within this project

3563

# and location (e.g. zone or region), and can be up to 40 characters with

3564

# the following restrictions:

3565

#

3566

# * Lowercase letters, numbers, and hyphens only.

3567

# * Must start with a letter.

3568

# * Must end with a number or a letter.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3569

"location": "A String", # [Output only] The name of the Google Compute Engine

3570

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3571

# or

3572

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3573

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3574

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

3575

# The endpoint can be accessed from the internet at

3576

# `https://username:password@endpoint/`.

3577

#

3578

# See the `masterAuth` property of this resource for username and

3579

# password information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3580

"createTime": "A String", # [Output only] The time the cluster was created, in

3581

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3582

"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]

3583

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3584

# notation (e.g. `10.96.0.0/14`). Leave blank to have

3585

# 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]

3586

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

3587

# required by Cluster Autoscaler to automatically adjust

3588

# the size of the cluster and create/delete

3589

# node pools based on the current needs.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3590

"autoprovisioningLocations": [ # The list of Google Compute Engine

3591

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3592

# NodePool's nodes can be created by NAP.

3593

"A String",

3594

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3595

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

3596

# amount of resources in the cluster.

3597

{ # Contains information about amount of some resource in the cluster.

3598

# For memory, value should be in GB.

3599

"maximum": "A String", # Maximum amount of the resource in the cluster.

3600

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

3601

"minimum": "A String", # Minimum amount of the resource in the cluster.

3602

},

3603

],

3604

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

3605

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

3606

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

3607

# created by NAP.

3608

# by NAP.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3609

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

3610

# service_account is specified, scopes should be empty.

3611

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

3612

# The instance may be scheduled on the specified or newer CPU platform.

3613

# Applicable values are the friendly names of CPU platforms, such as

3614

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3615

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3616

# information, read [how to specify min CPU

3617

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3618

# To unset the min cpu platform field pass "automatic" as field value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3619

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

3620

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3621

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3622

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3623

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3624

# the Auto Upgrades will proceed.

3625

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3626

# with the description of the upgrade.

3627

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3628

# with the approximate start time for the upgrades, in

3629

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3630

},

3631

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3632

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

3633

# specified, service_account should be empty.

3634

"A String",

3635

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3636

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

3637

# disruption caused by an upgrade.

3638

#

3639

# maxUnavailable controls the number of nodes that can be simultaneously

3640

# unavailable.

3641

#

3642

# maxSurge controls the number of additional nodes that can be added to the

3643

# node pool temporarily for the time of the upgrade to increase the number of

3644

# available nodes.

3645

#

3646

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3647

# nodes are being upgraded at the same time).

3648

#

3649

# Note: upgrades inevitably introduce some disruption since workloads need to

3650

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3651

# this holds true. (Disruption stays within the limits of

3652

# PodDisruptionBudget, if it is configured.)

3653

#

3654

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3655

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3656

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3657

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3658

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3659

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3660

# the upgrade process. A node is considered available if its status is

3661

# Ready.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3662

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3663

# of the node pool during the upgrade process.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3664

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3665

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3666

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3667

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

3668

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3669

# is sufficient for this number of instances. You must also have available

3670

# firewall and routes quota.

3671

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3672

# "node_pool" object, since this configuration (along with the

3673

# "node_config") will be used to create a "NodePool" object with an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3674

# auto-generated name. Do not use this and a node_pool at the same time.

3675

#

3676

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3677

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

3678

"A String",

3679

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3680

},

3681

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3682

"missingZones": [ # If any zones are listed here, the list of clusters returned

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3683

# may be missing those zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3684

"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]

3690

<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]

3691

<pre>Sets the addons for a specific cluster.

3692

3693

Args:

3694

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]

3695

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3696

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3697

The object takes the form of:

3698

3699

{ # SetAddonsRequest sets the addons associated with the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3700

"name": "A String", # The name (project, location, cluster) of the cluster to set addons.

3701

# Specified in the format `projects/*/locations/*/clusters/*`.

3702

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3703

# number](https://support.google.com/cloud/answer/6158840).

3704

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3705

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

3706

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3707

# cluster resides. This field has been deprecated and replaced by the name

3708

# field.

3709

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

3710

# This field has been deprecated and replaced by the name field.

3711

"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]

3712

# cluster.

3713

# cluster, enabling additional functionality.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3714

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

3715

# makes it easy to set up HTTP load balancers for services in a cluster.

3716

# which makes it easy to set up HTTP load balancers for services in a cluster.

3717

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

3718

# When enabled, it runs a small pod in the cluster that manages the load

3719

# balancers.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3720

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3721

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3722

# This addon is deprecated, and will be disabled in 1.15. It is recommended

3723

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

3724

# workloads and applications. For more information, see:

3725

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3726

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

3727

},

3728

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

3729

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

3730

},

3731

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

3732

# applications.

3733

"enabled": True or False, # Whether KALM is enabled for this cluster.

3734

},

3735

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

3736

# enabled at cluster creation time.

3737

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

3738

},

3739

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

3740

# microservices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3741

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3742

"disabled": True or False, # Whether Istio is enabled for this cluster.

3743

},

3744

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

3745

# is enabled or not on the Master, it does not track whether network policy

3746

# is enabled for the nodes.

3747

# is enabled or not on the Master, it does not track whether network policy

3748

# is enabled for the nodes.

3749

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

3750

},

3751

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

3752

# enabled in order to enable Cloud Run addon. This option can only be enabled

3753

# at cluster creation time.

3754

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

3755

},

3756

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

3757

# extension to manage hosted GCP services through the Kubernetes API

3758

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

3759

},

3760

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

3761

# increases or decreases the number of replica pods a replication controller

3762

# has based on the resource usage of the existing pods.

3763

# increases or decreases the number of replica pods a replication controller

3764

# has based on the resource usage of the existing pods.

3765

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

3766

# When enabled, it ensures that metrics are collected into Stackdriver

3767

# Monitoring.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3768

},

3769

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3770

}

3771

3772

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3779

3780

{ # This operation resource represents operations that may have happened or are

3781

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3782

"targetLink": "A String", # Server-defined URL for the target of the operation.

3783

"detail": "A String", # Detailed operation progress, if available.

3784

"operationType": "A String", # The operation type.

3785

"status": "A String", # The current status of the operation.

3786

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3787

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3788

{ # StatusCondition describes why a cluster or a node pool has a certain status

3789

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3790

"code": "A String", # Machine-friendly representation of the condition

3791

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3792

},

3793

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3794

"endTime": "A String", # [Output only] The time the operation completed, in

3795

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3796

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3797

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3798

# or

3799

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3800

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3801

"startTime": "A String", # [Output only] The time the operation started, in

3802

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3803

"clusterConditions": [ # Which conditions caused the current cluster state.

3804

{ # StatusCondition describes why a cluster or a node pool has a certain status

3805

# (e.g., ERROR or DEGRADED).

3806

"code": "A String", # Machine-friendly representation of the condition

3807

"message": "A String", # Human-friendly representation of the condition

3808

},

3809

],

3810

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3811

"metrics": [ # Progress metric bundle, for example:

3812

# metrics: [{name: "nodes done", int_value: 15},

3813

# {name: "nodes total", int_value: 32}]

3814

# or

3815

# metrics: [{name: "progress", double_value: 0.56},

3816

# {name: "progress scale", double_value: 1.0}]

3817

{ # Progress metric is (string, int|float|string) pair.

3818

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3819

"doubleValue": 3.14, # For metrics with floating point value.

3820

"intValue": "A String", # For metrics with integer value.

3821

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3822

},

3823

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3824

"status": "A String", # Status of an operation stage.

3825

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3826

"name": "A String", # A non-parameterized string describing an operation stage.

3827

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3828

"stages": [ # Substages of an operation or a stage.

3829

# Object with schema name: OperationProgress

3830

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3831

},

3832

"zone": "A String", # The name of the Google Compute Engine

3833

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3834

# operation is taking place. This field is deprecated, use location instead.

3835

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3836

"selfLink": "A String", # Server-defined URL for the resource.

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]

3841

<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]

3842

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

3843

3844

Args:

3845

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]

3846

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3847

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3848

The object takes the form of:

3849

3850

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for

3851

# a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3852

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac.

3853

# Specified in the format `projects/*/locations/*/clusters/*`.

3854

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

3855

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3856

# number](https://support.google.com/cloud/answer/6158840).

3857

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3858

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3859

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3860

# cluster resides. This field has been deprecated and replaced by the name

3861

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3862

"clusterId": "A String", # Required. Deprecated. The name of the cluster to update.

3863

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3864

}

3865

3866

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3873

3874

{ # This operation resource represents operations that may have happened or are

3875

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3876

"targetLink": "A String", # Server-defined URL for the target of the operation.

3877

"detail": "A String", # Detailed operation progress, if available.

3878

"operationType": "A String", # The operation type.

3879

"status": "A String", # The current status of the operation.

3880

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3881

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3882

{ # StatusCondition describes why a cluster or a node pool has a certain status

3883

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3884

"code": "A String", # Machine-friendly representation of the condition

3885

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3886

},

3887

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3888

"endTime": "A String", # [Output only] The time the operation completed, in

3889

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3890

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3891

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3892

# or

3893

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3894

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3895

"startTime": "A String", # [Output only] The time the operation started, in

3896

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3897

"clusterConditions": [ # Which conditions caused the current cluster state.

3898

{ # StatusCondition describes why a cluster or a node pool has a certain status

3899

# (e.g., ERROR or DEGRADED).

3900

"code": "A String", # Machine-friendly representation of the condition

3901

"message": "A String", # Human-friendly representation of the condition

3902

},

3903

],

3904

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3905

"metrics": [ # Progress metric bundle, for example:

3906

# metrics: [{name: "nodes done", int_value: 15},

3907

# {name: "nodes total", int_value: 32}]

3908

# or

3909

# metrics: [{name: "progress", double_value: 0.56},

3910

# {name: "progress scale", double_value: 1.0}]

3911

{ # Progress metric is (string, int|float|string) pair.

3912

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3913

"doubleValue": 3.14, # For metrics with floating point value.

3914

"intValue": "A String", # For metrics with integer value.

3915

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3916

},

3917

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3918

"status": "A String", # Status of an operation stage.

3919

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3920

"name": "A String", # A non-parameterized string describing an operation stage.

3921

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3922

"stages": [ # Substages of an operation or a stage.

3923

# Object with schema name: OperationProgress

3924

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3925

},

3926

"zone": "A String", # The name of the Google Compute Engine

3927

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3928

# operation is taking place. This field is deprecated, use location instead.

3929

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3930

"selfLink": "A String", # Server-defined URL for the resource.

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]

3935

<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]

3936

<pre>Sets the locations for a specific cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3937

Deprecated. Use

3938

[projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update)

3939

instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3940

3941

Args:

3942

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]

3943

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3944

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3945

The object takes the form of:

3946

3947

{ # SetLocationsRequest sets the locations of the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3948

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

3949

# This field has been deprecated and replaced by the name field.

3950

"name": "A String", # The name (project, location, cluster) of the cluster to set locations.

3951

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3952

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3953

# number](https://support.google.com/cloud/answer/6158840).

3954

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3955

"locations": [ # Required. The desired list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3956

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3957

# 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]

3958

# will result in nodes being either created or removed from the cluster,

3959

# depending on whether locations are being added or removed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3960

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3961

# This list must always include the cluster's primary zone.

3962

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3963

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3964

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

3965

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3966

# cluster resides. This field has been deprecated and replaced by the name

3967

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3968

}

3969

3970

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3977

3978

{ # This operation resource represents operations that may have happened or are

3979

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3980

"targetLink": "A String", # Server-defined URL for the target of the operation.

3981

"detail": "A String", # Detailed operation progress, if available.

3982

"operationType": "A String", # The operation type.

3983

"status": "A String", # The current status of the operation.

3984

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3985

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3986

{ # StatusCondition describes why a cluster or a node pool has a certain status

3987

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3988

"code": "A String", # Machine-friendly representation of the condition

3989

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3990

},

3991

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3992

"endTime": "A String", # [Output only] The time the operation completed, in

3993

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3994

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3995

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3996

# or

3997

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3998

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3999

"startTime": "A String", # [Output only] The time the operation started, in

4000

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4001

"clusterConditions": [ # Which conditions caused the current cluster state.

4002

{ # StatusCondition describes why a cluster or a node pool has a certain status

4003

# (e.g., ERROR or DEGRADED).

4004

"code": "A String", # Machine-friendly representation of the condition

4005

"message": "A String", # Human-friendly representation of the condition

4006

},

4007

],

4008

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4009

"metrics": [ # Progress metric bundle, for example:

4010

# metrics: [{name: "nodes done", int_value: 15},

4011

# {name: "nodes total", int_value: 32}]

4012

# or

4013

# metrics: [{name: "progress", double_value: 0.56},

4014

# {name: "progress scale", double_value: 1.0}]

4015

{ # Progress metric is (string, int|float|string) pair.

4016

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4017

"doubleValue": 3.14, # For metrics with floating point value.

4018

"intValue": "A String", # For metrics with integer value.

4019

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4020

},

4021

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4022

"status": "A String", # Status of an operation stage.

4023

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4024

"name": "A String", # A non-parameterized string describing an operation stage.

4025

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4026

"stages": [ # Substages of an operation or a stage.

4027

# Object with schema name: OperationProgress

4028

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4029

},

4030

"zone": "A String", # The name of the Google Compute Engine

4031

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4032

# operation is taking place. This field is deprecated, use location instead.

4033

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4034

"selfLink": "A String", # Server-defined URL for the resource.

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]

4039

<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]

4040

<pre>Sets the logging service for a specific cluster.

4041

4042

Args:

4043

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]

4044

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4045

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4046

The object takes the form of:

4047

4048

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4049

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

4050

# number](https://support.google.com/cloud/answer/6158840).

4051

# This field has been deprecated and replaced by the name field.

4052

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4053

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4054

# cluster resides. This field has been deprecated and replaced by the name

4055

# field.

4056

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

4057

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4058

"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]

4059

# Currently available options:

4060

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4061

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

4062

# service with a Kubernetes-native resource model

4063

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

4064

# available as of GKE 1.15).

4065

# * `none` - no logs will be exported from the cluster.

4066

#

4067

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

4068

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4069

"name": "A String", # The name (project, location, cluster) of the cluster to set logging.

4070

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4071

}

4072

4073

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4080

4081

{ # This operation resource represents operations that may have happened or are

4082

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4083

"targetLink": "A String", # Server-defined URL for the target of the operation.

4084

"detail": "A String", # Detailed operation progress, if available.

4085

"operationType": "A String", # The operation type.

4086

"status": "A String", # The current status of the operation.

4087

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4088

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4089

{ # StatusCondition describes why a cluster or a node pool has a certain status

4090

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4091

"code": "A String", # Machine-friendly representation of the condition

4092

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4093

},

4094

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4095

"endTime": "A String", # [Output only] The time the operation completed, in

4096

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4097

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4098

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4099

# or

4100

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4101

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4102

"startTime": "A String", # [Output only] The time the operation started, in

4103

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4104

"clusterConditions": [ # Which conditions caused the current cluster state.

4105

{ # StatusCondition describes why a cluster or a node pool has a certain status

4106

# (e.g., ERROR or DEGRADED).

4107

"code": "A String", # Machine-friendly representation of the condition

4108

"message": "A String", # Human-friendly representation of the condition

4109

},

4110

],

4111

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4112

"metrics": [ # Progress metric bundle, for example:

4113

# metrics: [{name: "nodes done", int_value: 15},

4114

# {name: "nodes total", int_value: 32}]

4115

# or

4116

# metrics: [{name: "progress", double_value: 0.56},

4117

# {name: "progress scale", double_value: 1.0}]

4118

{ # Progress metric is (string, int|float|string) pair.

4119

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4120

"doubleValue": 3.14, # For metrics with floating point value.

4121

"intValue": "A String", # For metrics with integer value.

4122

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4123

},

4124

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4125

"status": "A String", # Status of an operation stage.

4126

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4127

"name": "A String", # A non-parameterized string describing an operation stage.

4128

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4129

"stages": [ # Substages of an operation or a stage.

4130

# Object with schema name: OperationProgress

4131

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4132

},

4133

"zone": "A String", # The name of the Google Compute Engine

4134

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4135

# operation is taking place. This field is deprecated, use location instead.

4136

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4137

"selfLink": "A String", # Server-defined URL for the resource.

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]

4142

<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]

4143

<pre>Sets the maintenance policy for a cluster.

4144

4145

Args:

4146

name: string, The name (project, location, cluster id) of the cluster to set maintenance

4147

policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4148

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4149

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4150

The object takes the form of:

4151

4152

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4153

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance

4154

# policy.

4155

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4156

"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]

4157

# clears the existing maintenance policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4158

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4159

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

4160

# occur in these windows.

4161

"a_key": { # Represents an arbitrary window of time.

4162

"startTime": "A String", # The time that the window first starts.

4163

"endTime": "A String", # The time that the window ends. The end time should take place after the

4164

# start time.

4165

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4166

},

4167

"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]

4168

# maintenance to occur. The time windows may be overlapping. If no

4169

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4170

"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]

4171

# this window reccurs. They go on for the span of time between the start and

4172

# end time.

4173

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4174

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4175

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

4176

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

4177

# <code>FREQ=DAILY</code>

4178

# For the first weekend of every month:

4179

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

4180

# 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]

4181

# 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]

4182

# <code>

4183

# start time = 2019-01-01T09:00:00-0400

4184

# end time = 2019-01-01T17:00:00-0400

4185

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

4186

# </code>

4187

# Windows can span multiple days. Eg, to make the window encompass every

4188

# weekend from midnight Saturday till the last minute of Sunday UTC:

4189

# <code>

4190

# start time = 2019-01-05T00:00:00Z

4191

# end time = 2019-01-07T23:59:00Z

4192

# recurrence = FREQ=WEEKLY;BYDAY=SA

4193

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4194

# 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]

4195

# to specify duration of the window and when it first starts.

4196

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4197

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4198

"startTime": "A String", # The time that the window first starts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4199

"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]

4200

# start time.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4201

},

4202

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4203

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

4204

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

4205

# smallest possible in the given scenario.

4206

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

4207

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4208

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4209

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4210

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

4211

# the policy won't accidentally undo intermediate changes (and so that users

4212

# of the API unaware of some fields won't accidentally remove other fields).

4213

# Make a <code>get()</code> request to the cluster to get the current

4214

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4215

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4216

"projectId": "A String", # Required. The Google Developers Console [project ID or project

4217

# number](https://support.google.com/cloud/answer/6158840).

4218

"zone": "A String", # Required. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4219

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4220

# cluster resides.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4221

"clusterId": "A String", # Required. The name of the cluster to update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4222

}

4223

4224

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4231

4232

{ # This operation resource represents operations that may have happened or are

4233

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4234

"targetLink": "A String", # Server-defined URL for the target of the operation.

4235

"detail": "A String", # Detailed operation progress, if available.

4236

"operationType": "A String", # The operation type.

4237

"status": "A String", # The current status of the operation.

4238

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4239

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4240

{ # StatusCondition describes why a cluster or a node pool has a certain status

4241

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4242

"code": "A String", # Machine-friendly representation of the condition

4243

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4244

},

4245

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4246

"endTime": "A String", # [Output only] The time the operation completed, in

4247

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4248

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4249

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4250

# or

4251

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4252

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4253

"startTime": "A String", # [Output only] The time the operation started, in

4254

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4255

"clusterConditions": [ # Which conditions caused the current cluster state.

4256

{ # StatusCondition describes why a cluster or a node pool has a certain status

4257

# (e.g., ERROR or DEGRADED).

4258

"code": "A String", # Machine-friendly representation of the condition

4259

"message": "A String", # Human-friendly representation of the condition

4260

},

4261

],

4262

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4263

"metrics": [ # Progress metric bundle, for example:

4264

# metrics: [{name: "nodes done", int_value: 15},

4265

# {name: "nodes total", int_value: 32}]

4266

# or

4267

# metrics: [{name: "progress", double_value: 0.56},

4268

# {name: "progress scale", double_value: 1.0}]

4269

{ # Progress metric is (string, int|float|string) pair.

4270

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4271

"doubleValue": 3.14, # For metrics with floating point value.

4272

"intValue": "A String", # For metrics with integer value.

4273

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4274

},

4275

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4276

"status": "A String", # Status of an operation stage.

4277

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4278

"name": "A String", # A non-parameterized string describing an operation stage.

4279

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4280

"stages": [ # Substages of an operation or a stage.

4281

# Object with schema name: OperationProgress

4282

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4283

},

4284

"zone": "A String", # The name of the Google Compute Engine

4285

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4286

# operation is taking place. This field is deprecated, use location instead.

4287

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4288

"selfLink": "A String", # Server-defined URL for the resource.

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]

4293

<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]

4294

<pre>Sets master auth materials. Currently supports changing the admin password

4295

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]

4300

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4301

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4302

The object takes the form of:

4303

4304

{ # SetMasterAuthRequest updates the admin password of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4305

"name": "A String", # The name (project, location, cluster) of the cluster to set auth.

4306

# Specified in the format `projects/*/locations/*/clusters/*`.

4307

"action": "A String", # Required. The exact form of action to be taken on the master auth.

4308

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4309

# number](https://support.google.com/cloud/answer/6158840).

4310

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4311

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4312

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4313

"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]

4314

# Authentication can be done using HTTP basic auth or using client

4315

# certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4316

"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]

4317

# Because the master endpoint is open to the Internet, you should create a

4318

# strong password. If a password is provided for cluster creation, username

4319

# must be non-empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4320

"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]

4321

# clusters before v1.12, if no configuration is specified, a client

4322

# certificate is issued.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4323

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4324

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4325

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

4326

# to the cluster endpoint.

4327

"clusterCaCertificate": "A String",

4328

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

4329

# authenticate to the cluster endpoint.

4330

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

4331

# For clusters v1.6.0 and later, basic authentication can be disabled by

4332

# leaving username unspecified (or setting it to the empty string).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4333

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4334

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4335

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4336

# cluster resides. This field has been deprecated and replaced by the name

4337

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4338

}

4339

4340

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4347

4348

{ # This operation resource represents operations that may have happened or are

4349

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4350

"targetLink": "A String", # Server-defined URL for the target of the operation.

4351

"detail": "A String", # Detailed operation progress, if available.

4352

"operationType": "A String", # The operation type.

4353

"status": "A String", # The current status of the operation.

4354

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4355

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4356

{ # StatusCondition describes why a cluster or a node pool has a certain status

4357

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4358

"code": "A String", # Machine-friendly representation of the condition

4359

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4360

},

4361

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4362

"endTime": "A String", # [Output only] The time the operation completed, in

4363

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4364

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4365

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4366

# or

4367

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4368

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4369

"startTime": "A String", # [Output only] The time the operation started, in

4370

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4371

"clusterConditions": [ # Which conditions caused the current cluster state.

4372

{ # StatusCondition describes why a cluster or a node pool has a certain status

4373

# (e.g., ERROR or DEGRADED).

4374

"code": "A String", # Machine-friendly representation of the condition

4375

"message": "A String", # Human-friendly representation of the condition

4376

},

4377

],

4378

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4379

"metrics": [ # Progress metric bundle, for example:

4380

# metrics: [{name: "nodes done", int_value: 15},

4381

# {name: "nodes total", int_value: 32}]

4382

# or

4383

# metrics: [{name: "progress", double_value: 0.56},

4384

# {name: "progress scale", double_value: 1.0}]

4385

{ # Progress metric is (string, int|float|string) pair.

4386

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4387

"doubleValue": 3.14, # For metrics with floating point value.

4388

"intValue": "A String", # For metrics with integer value.

4389

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4390

},

4391

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4392

"status": "A String", # Status of an operation stage.

4393

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4394

"name": "A String", # A non-parameterized string describing an operation stage.

4395

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4396

"stages": [ # Substages of an operation or a stage.

4397

# Object with schema name: OperationProgress

4398

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4399

},

4400

"zone": "A String", # The name of the Google Compute Engine

4401

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4402

# operation is taking place. This field is deprecated, use location instead.

4403

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4404

"selfLink": "A String", # Server-defined URL for the resource.

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]

4409

<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]

4410

<pre>Sets the monitoring service for a specific cluster.

4411

4412

Args:

4413

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]

4414

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4415

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4416

The object takes the form of:

4417

4418

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4419

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4420

# number](https://support.google.com/cloud/answer/6158840).

4421

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4422

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4423

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4424

# cluster resides. This field has been deprecated and replaced by the name

4425

# field.

4426

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

4427

# This field has been deprecated and replaced by the name field.

4428

"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]

4429

# Currently available options:

4430

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4431

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4432

# service with a Kubernetes-native resource model

4433

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4434

# longer available as of GKE 1.15).

4435

# * `none` - No metrics will be exported from the cluster.

4436

#

4437

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4438

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4439

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring.

4440

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4441

}

4442

4443

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4450

4451

{ # This operation resource represents operations that may have happened or are

4452

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4453

"targetLink": "A String", # Server-defined URL for the target of the operation.

4454

"detail": "A String", # Detailed operation progress, if available.

4455

"operationType": "A String", # The operation type.

4456

"status": "A String", # The current status of the operation.

4457

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4458

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4459

{ # StatusCondition describes why a cluster or a node pool has a certain status

4460

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4461

"code": "A String", # Machine-friendly representation of the condition

4462

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4463

},

4464

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4465

"endTime": "A String", # [Output only] The time the operation completed, in

4466

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4467

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4468

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4469

# or

4470

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4471

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4472

"startTime": "A String", # [Output only] The time the operation started, in

4473

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4474

"clusterConditions": [ # Which conditions caused the current cluster state.

4475

{ # StatusCondition describes why a cluster or a node pool has a certain status

4476

# (e.g., ERROR or DEGRADED).

4477

"code": "A String", # Machine-friendly representation of the condition

4478

"message": "A String", # Human-friendly representation of the condition

4479

},

4480

],

4481

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4482

"metrics": [ # Progress metric bundle, for example:

4483

# metrics: [{name: "nodes done", int_value: 15},

4484

# {name: "nodes total", int_value: 32}]

4485

# or

4486

# metrics: [{name: "progress", double_value: 0.56},

4487

# {name: "progress scale", double_value: 1.0}]

4488

{ # Progress metric is (string, int|float|string) pair.

4489

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4490

"doubleValue": 3.14, # For metrics with floating point value.

4491

"intValue": "A String", # For metrics with integer value.

4492

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4493

},

4494

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4495

"status": "A String", # Status of an operation stage.

4496

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4497

"name": "A String", # A non-parameterized string describing an operation stage.

4498

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4499

"stages": [ # Substages of an operation or a stage.

4500

# Object with schema name: OperationProgress

4501

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4502

},

4503

"zone": "A String", # The name of the Google Compute Engine

4504

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4505

# operation is taking place. This field is deprecated, use location instead.

4506

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4507

"selfLink": "A String", # Server-defined URL for the resource.

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]

4512

<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]

4513

<pre>Enables or disables Network Policy for a cluster.

4514

4515

Args:

4516

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]

4517

policy. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4518

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4519

The object takes the form of:

4520

4521

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4522

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4523

# number](https://developers.google.com/console/help/new/#projectnumber).

4524

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4525

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4526

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4527

# cluster resides. This field has been deprecated and replaced by the name

4528

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4529

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

4530

# This field has been deprecated and replaced by the name field.

4531

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature.

4532

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4533

"provider": "A String", # The selected network policy provider.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4534

"enabled": True or False, # Whether network policy is enabled on the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4535

},

4536

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking

4537

# policy. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4538

}

4539

4540

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4547

4548

{ # This operation resource represents operations that may have happened or are

4549

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4550

"targetLink": "A String", # Server-defined URL for the target of the operation.

4551

"detail": "A String", # Detailed operation progress, if available.

4552

"operationType": "A String", # The operation type.

4553

"status": "A String", # The current status of the operation.

4554

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4555

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4556

{ # StatusCondition describes why a cluster or a node pool has a certain status

4557

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4558

"code": "A String", # Machine-friendly representation of the condition

4559

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4560

},

4561

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4562

"endTime": "A String", # [Output only] The time the operation completed, in

4563

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4564

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4565

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4566

# or

4567

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4568

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4569

"startTime": "A String", # [Output only] The time the operation started, in

4570

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4571

"clusterConditions": [ # Which conditions caused the current cluster state.

4572

{ # StatusCondition describes why a cluster or a node pool has a certain status

4573

# (e.g., ERROR or DEGRADED).

4574

"code": "A String", # Machine-friendly representation of the condition

4575

"message": "A String", # Human-friendly representation of the condition

4576

},

4577

],

4578

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4579

"metrics": [ # Progress metric bundle, for example:

4580

# metrics: [{name: "nodes done", int_value: 15},

4581

# {name: "nodes total", int_value: 32}]

4582

# or

4583

# metrics: [{name: "progress", double_value: 0.56},

4584

# {name: "progress scale", double_value: 1.0}]

4585

{ # Progress metric is (string, int|float|string) pair.

4586

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4587

"doubleValue": 3.14, # For metrics with floating point value.

4588

"intValue": "A String", # For metrics with integer value.

4589

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4590

},

4591

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4592

"status": "A String", # Status of an operation stage.

4593

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4594

"name": "A String", # A non-parameterized string describing an operation stage.

4595

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4596

"stages": [ # Substages of an operation or a stage.

4597

# Object with schema name: OperationProgress

4598

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4599

},

4600

"zone": "A String", # The name of the Google Compute Engine

4601

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4602

# operation is taking place. This field is deprecated, use location instead.

4603

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4604

"selfLink": "A String", # Server-defined URL for the resource.

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]

4609

<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]

4610

<pre>Sets labels on a cluster.

4611

4612

Args:

4613

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]

4614

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4615

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4616

The object takes the form of:

4617

4618

{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container

4619

# Engine cluster, which will in turn set them for Google Compute Engine

4620

# resources used by that cluster

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4621

"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]

4622

# used to detect conflicts. The fingerprint is initially generated by

4623

# Kubernetes Engine and changes after every request to modify or update

4624

# labels. You must always provide an up-to-date fingerprint hash when

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4625

# updating or changing labels. Make a <code>get()</code> request to the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4626

# resource to get the latest fingerprint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4627

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4628

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4629

# cluster resides. This field has been deprecated and replaced by the name

4630

# field.

4631

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels.

4632

# Specified in the format `projects/*/locations/*/clusters/*`.

4633

"resourceLabels": { # Required. The labels to set for that cluster.

4634

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4635

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4636

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

4637

# number](https://developers.google.com/console/help/new/#projectnumber).

4638

# This field has been deprecated and replaced by the name field.

4639

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

4640

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4641

}

4642

4643

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4650

4651

{ # This operation resource represents operations that may have happened or are

4652

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4653

"targetLink": "A String", # Server-defined URL for the target of the operation.

4654

"detail": "A String", # Detailed operation progress, if available.

4655

"operationType": "A String", # The operation type.

4656

"status": "A String", # The current status of the operation.

4657

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4658

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4659

{ # StatusCondition describes why a cluster or a node pool has a certain status

4660

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4661

"code": "A String", # Machine-friendly representation of the condition

4662

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4663

},

4664

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4665

"endTime": "A String", # [Output only] The time the operation completed, in

4666

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4667

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4668

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4669

# or

4670

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4671

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4672

"startTime": "A String", # [Output only] The time the operation started, in

4673

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4674

"clusterConditions": [ # Which conditions caused the current cluster state.

4675

{ # StatusCondition describes why a cluster or a node pool has a certain status

4676

# (e.g., ERROR or DEGRADED).

4677

"code": "A String", # Machine-friendly representation of the condition

4678

"message": "A String", # Human-friendly representation of the condition

4679

},

4680

],

4681

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4682

"metrics": [ # Progress metric bundle, for example:

4683

# metrics: [{name: "nodes done", int_value: 15},

4684

# {name: "nodes total", int_value: 32}]

4685

# or

4686

# metrics: [{name: "progress", double_value: 0.56},

4687

# {name: "progress scale", double_value: 1.0}]

4688

{ # Progress metric is (string, int|float|string) pair.

4689

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4690

"doubleValue": 3.14, # For metrics with floating point value.

4691

"intValue": "A String", # For metrics with integer value.

4692

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4693

},

4694

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4695

"status": "A String", # Status of an operation stage.

4696

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4697

"name": "A String", # A non-parameterized string describing an operation stage.

4698

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4699

"stages": [ # Substages of an operation or a stage.

4700

# Object with schema name: OperationProgress

4701

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4702

},

4703

"zone": "A String", # The name of the Google Compute Engine

4704

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4705

# operation is taking place. This field is deprecated, use location instead.

4706

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4707

"selfLink": "A String", # Server-defined URL for the resource.

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]

4712

<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]

4713

<pre>Starts master IP rotation.

4714

4715

Args:

4716

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]

4717

rotation. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4718

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4719

The object takes the form of:

4720

4721

{ # StartIPRotationRequest creates a new IP for the cluster and then performs

4722

# 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]

4723

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP

4724

# rotation. Specified in the format `projects/*/locations/*/clusters/*`.

4725

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4726

# number](https://developers.google.com/console/help/new/#projectnumber).

4727

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4728

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4729

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4730

# cluster resides. This field has been deprecated and replaced by the name

4731

# field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4732

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4733

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

4734

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4735

}

4736

4737

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4744

4745

{ # This operation resource represents operations that may have happened or are

4746

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4747

"targetLink": "A String", # Server-defined URL for the target of the operation.

4748

"detail": "A String", # Detailed operation progress, if available.

4749

"operationType": "A String", # The operation type.

4750

"status": "A String", # The current status of the operation.

4751

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4752

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4753

{ # StatusCondition describes why a cluster or a node pool has a certain status

4754

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4755

"code": "A String", # Machine-friendly representation of the condition

4756

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4757

},

4758

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4759

"endTime": "A String", # [Output only] The time the operation completed, in

4760

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4761

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4762

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4763

# or

4764

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4765

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4766

"startTime": "A String", # [Output only] The time the operation started, in

4767

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4768

"clusterConditions": [ # Which conditions caused the current cluster state.

4769

{ # StatusCondition describes why a cluster or a node pool has a certain status

4770

# (e.g., ERROR or DEGRADED).

4771

"code": "A String", # Machine-friendly representation of the condition

4772

"message": "A String", # Human-friendly representation of the condition

4773

},

4774

],

4775

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4776

"metrics": [ # Progress metric bundle, for example:

4777

# metrics: [{name: "nodes done", int_value: 15},

4778

# {name: "nodes total", int_value: 32}]

4779

# or

4780

# metrics: [{name: "progress", double_value: 0.56},

4781

# {name: "progress scale", double_value: 1.0}]

4782

{ # Progress metric is (string, int|float|string) pair.

4783

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4784

"doubleValue": 3.14, # For metrics with floating point value.

4785

"intValue": "A String", # For metrics with integer value.

4786

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4787

},

4788

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4789

"status": "A String", # Status of an operation stage.

4790

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4791

"name": "A String", # A non-parameterized string describing an operation stage.

4792

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4793

"stages": [ # Substages of an operation or a stage.

4794

# Object with schema name: OperationProgress

4795

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4796

},

4797

"zone": "A String", # The name of the Google Compute Engine

4798

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4799

# operation is taking place. This field is deprecated, use location instead.

4800

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4801

"selfLink": "A String", # Server-defined URL for the resource.

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]

4806

<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]

4807

<pre>Updates the settings for a specific cluster.

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4811

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4812

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4813

The object takes the form of:

4814

4815

{ # UpdateClusterRequest updates the settings of a cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4816

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4817

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4818

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4819

# number](https://support.google.com/cloud/answer/6158840).

4820

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4821

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4822

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4823

# cluster resides. This field has been deprecated and replaced by the name

4824

# field.

4825

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4826

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4827

"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]

4828

# be applied to a cluster with each request, so at most one field can be

4829

# provided.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4830

"desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an

4831

# upgrade).

4832

#

4833

# Users may specify either explicit versions offered by

4834

# Kubernetes Engine or version aliases, which have the following behavior:

4835

#

4836

# - "latest": picks the highest valid Kubernetes version

4837

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4838

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4839

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4840

# - "-": picks the Kubernetes master version

4841

"desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

4842

# required by Cluster Autoscaler to automatically adjust

4843

# the size of the cluster and create/delete

4844

# node pools based on the current needs.

4845

"autoprovisioningLocations": [ # The list of Google Compute Engine

4846

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4847

# NodePool's nodes can be created by NAP.

4848

"A String",

4849

],

4850

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

4851

# amount of resources in the cluster.

4852

{ # Contains information about amount of some resource in the cluster.

4853

# For memory, value should be in GB.

4854

"maximum": "A String", # Maximum amount of the resource in the cluster.

4855

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

4856

"minimum": "A String", # Minimum amount of the resource in the cluster.

4857

},

4858

],

4859

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

4860

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

4861

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

4862

# created by NAP.

4863

# by NAP.

4864

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

4865

# service_account is specified, scopes should be empty.

4866

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

4867

# The instance may be scheduled on the specified or newer CPU platform.

4868

# Applicable values are the friendly names of CPU platforms, such as

4869

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

4870

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

4871

# information, read [how to specify min CPU

4872

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

4873

# To unset the min cpu platform field pass "automatic" as field value.

4874

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

4875

# node pool.

4876

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

4877

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

4878

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

4879

# the Auto Upgrades will proceed.

4880

"description": "A String", # [Output only] This field is set when upgrades are about to commence

4881

# with the description of the upgrade.

4882

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

4883

# with the approximate start time for the upgrades, in

4884

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4885

},

4886

},

4887

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

4888

# specified, service_account should be empty.

4889

"A String",

4890

],

4891

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

4892

# disruption caused by an upgrade.

4893

#

4894

# maxUnavailable controls the number of nodes that can be simultaneously

4895

# unavailable.

4896

#

4897

# maxSurge controls the number of additional nodes that can be added to the

4898

# node pool temporarily for the time of the upgrade to increase the number of

4899

# available nodes.

4900

#

4901

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

4902

# nodes are being upgraded at the same time).

4903

#

4904

# Note: upgrades inevitably introduce some disruption since workloads need to

4905

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

4906

# this holds true. (Disruption stays within the limits of

4907

# PodDisruptionBudget, if it is configured.)

4908

#

4909

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

4910

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

4911

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

4912

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

4913

# there are always at least 4 nodes available.

4914

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

4915

# the upgrade process. A node is considered available if its status is

4916

# Ready.

4917

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

4918

# of the node pool during the upgrade process.

},

},

},

"desiredPodSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # The desired configuration options for the PodSecurityPolicy feature.

4923

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

4924

# must be valid under a PodSecurityPolicy to be created.

4925

},

4926

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility.

4927

# visibility on this cluster.

4928

"enabled": True or False, # Enables intra node visibility for this cluster.

4929

},

4930

"desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature.

4931

# master authorized networks will disallow all external traffic to access

4932

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

4933

# Google Compute Engine Public IPs and Google Prod IPs.

4934

"enabled": True or False, # Whether or not master authorized networks is enabled.

4935

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

4936

# Kubernetes master through HTTPS.

4937

{ # CidrBlock contains an optional name and one CIDR block.

4938

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

4939

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

},

],

},

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

4944

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

4945

# daemonset will be created in the cluster to meter network egress traffic.

4946

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

4947

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

4948

# second BigQuery table will be created to hold resource consumption

4949

# records.

4950

},

4951

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

4952

"datasetId": "A String", # The ID of a BigQuery Dataset.

4953

},

4954

},

4955

"desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics.

4956

# Currently available options:

4957

#

4958

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

4959

# service with a Kubernetes-native resource model

4960

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4961

# longer available as of GKE 1.15).

4962

# * `none` - No metrics will be exported from the cluster.

4963

#

4964

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4965

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

4966

"desiredImageType": "A String", # The desired image type for the node pool.

4967

# NOTE: Set the "desired_node_pool" field as well.

4968

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity.

4969

# policies.

4970

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

4971

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

4972

},

4973

"desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is # The desired release channel configuration.

4974

# subscribed to. Release channels are arranged in order of risk and

4975

# frequency of updates.

4976

#

4977

# When a cluster is subscribed to a release channel, Google maintains

4978

# both the master version and the node version. Node auto-upgrade

4979

# defaults to true and cannot be disabled. Updates to version related

4980

# fields (e.g. current_master_version) return an error.

4981

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

4982

},

4983

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

4984

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

4985

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4986

"desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4987

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

4988

# range will be used for assigning internal IP addresses to the master or

4989

# set of masters, as well as the ILB VIP. This range must not overlap with

4990

# any other ranges in use within the cluster's network.

4991

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

4992

# given only RFC 1918 private addresses and communicate with the master via

4993

# private networking.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4994

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

4995

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

4996

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

4997

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

4998

"enabled": True or False, # Whenever master is accessible globally or not.

4999

},

5000

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5001

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5002

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

5003

# required by Vertical Pod Autoscaler to automatically adjust

5004

# the resources of pods controlled by it.

5005

"enabled": True or False, # Enables vertical pod autoscaling.

5006

},

5007

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

5008

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

5009

# images will be validated by Google Binauthz.

5010

},

5011

"desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

5012

# cluster, enabling additional functionality.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5013

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

5014

# makes it easy to set up HTTP load balancers for services in a cluster.

5015

# which makes it easy to set up HTTP load balancers for services in a cluster.

5016

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

5017

# When enabled, it runs a small pod in the cluster that manages the load

5018

# balancers.

5019

},

5020

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

5021

# This addon is deprecated, and will be disabled in 1.15. It is recommended

5022

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

5023

# workloads and applications. For more information, see:

5024

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

5025

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

5026

},

5027

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

5028

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

5029

},

5030

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

5031

# applications.

5032

"enabled": True or False, # Whether KALM is enabled for this cluster.

5033

},

5034

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

5035

# enabled at cluster creation time.

5036

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

5037

},

5038

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

5039

# microservices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5040

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5041

"disabled": True or False, # Whether Istio is enabled for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5042

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5043

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

5044

# is enabled or not on the Master, it does not track whether network policy

5045

# is enabled for the nodes.

5046

# is enabled or not on the Master, it does not track whether network policy

5047

# is enabled for the nodes.

5048

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5049

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5050

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

5051

# enabled in order to enable Cloud Run addon. This option can only be enabled

5052

# at cluster creation time.

5053

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

5054

},

5055

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

5056

# extension to manage hosted GCP services through the Kubernetes API

5057

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

5058

},

5059

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

5060

# increases or decreases the number of replica pods a replication controller

5061

# has based on the resource usage of the existing pods.

5062

# increases or decreases the number of replica pods a replication controller

5063

# has based on the resource usage of the existing pods.

5064

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

5065

# When enabled, it ensures that metrics are collected into Stackdriver

5066

# Monitoring.

5067

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5068

},

5069

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

5070

"state": "A String", # Denotes the state of etcd encryption.

5071

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

5072

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

5073

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5074

"desiredDefaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # The desired status of whether to disable default sNAT for this cluster.

5075

# be disabled on the cluster.

5076

"disabled": True or False, # Disables cluster default sNAT rules.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5077

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5078

"desiredTpuConfig": { # Configuration for Cloud TPU. # The desired Cloud TPU configuration.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5079

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5080

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

5081

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5082

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5083

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in

5084

# desired_node_pool_id. If there is only one pool in the

5085

# cluster and desired_node_pool_id is not provided then

5086

# the change applies to that single node pool.

5087

# adjust the size of the node pool to the current cluster usage.

5088

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

5089

# has to enough quota to scale up the cluster.

5090

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

5091

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

5092

# max_node_count.

5093

"enabled": True or False, # Is autoscaling enabled for this node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5094

},

5095

"desiredLocations": [ # The desired list of Google Compute Engine

5096

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

5097

# cluster's nodes should be located. Changing the locations a cluster is in

5098

# will result in nodes being either created or removed from the cluster,

5099

# depending on whether locations are being added or removed.

5100

#

5101

# This list must always include the cluster's primary zone.

5102

"A String",

5103

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5104

"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster.

5105

"type": "A String", # Type of the integration.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5106

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5107

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if

5108

# "desired_node_version", "desired_image_family",

5109

# "desired_node_pool_autoscaling", or "desired_workload_metadata_config"

5110

# is specified and there is more than one node pool on the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5111

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the

5112

# latest supported version.

5113

#

5114

# Users may specify either explicit versions offered by

5115

# Kubernetes Engine or version aliases, which have the following behavior:

5116

#

5117

# - "latest": picks the highest valid Kubernetes version

5118

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

5119

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

5120

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

5121

# - "-": picks the default Kubernetes version

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5122

"desiredLoggingService": "A String", # The logging service the cluster should use to write logs.

5123

# Currently available options:

5124

#

5125

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

5126

# service with a Kubernetes-native resource model

5127

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

5128

# available as of GKE 1.15).

5129

# * `none` - no logs will be exported from the cluster.

5130

#

5131

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

5132

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5133

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5134

}

5135

5136

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5143

5144

{ # This operation resource represents operations that may have happened or are

5145

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5146

"targetLink": "A String", # Server-defined URL for the target of the operation.

5147

"detail": "A String", # Detailed operation progress, if available.

5148

"operationType": "A String", # The operation type.

5149

"status": "A String", # The current status of the operation.

5150

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5151

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5152

{ # StatusCondition describes why a cluster or a node pool has a certain status

5153

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5154

"code": "A String", # Machine-friendly representation of the condition

5155

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5156

},

5157

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5158

"endTime": "A String", # [Output only] The time the operation completed, in

5159

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5160

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5161

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5162

# or

5163

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5164

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5165

"startTime": "A String", # [Output only] The time the operation started, in

5166

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5167

"clusterConditions": [ # Which conditions caused the current cluster state.

5168

{ # StatusCondition describes why a cluster or a node pool has a certain status

5169

# (e.g., ERROR or DEGRADED).

5170

"code": "A String", # Machine-friendly representation of the condition

5171

"message": "A String", # Human-friendly representation of the condition

5172

},

5173

],

5174

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5175

"metrics": [ # Progress metric bundle, for example:

5176

# metrics: [{name: "nodes done", int_value: 15},

5177

# {name: "nodes total", int_value: 32}]

5178

# or

5179

# metrics: [{name: "progress", double_value: 0.56},

5180

# {name: "progress scale", double_value: 1.0}]

5181

{ # Progress metric is (string, int|float|string) pair.

5182

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

5183

"doubleValue": 3.14, # For metrics with floating point value.

5184

"intValue": "A String", # For metrics with integer value.

5185

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

5186

},

5187

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5188

"status": "A String", # Status of an operation stage.

5189

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5190

"name": "A String", # A non-parameterized string describing an operation stage.

5191

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5192

"stages": [ # Substages of an operation or a stage.

5193

# Object with schema name: OperationProgress

5194

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5195

},

5196

"zone": "A String", # The name of the Google Compute Engine

5197

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5198

# operation is taking place. This field is deprecated, use location instead.

5199

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

5200

"selfLink": "A String", # Server-defined URL for the resource.

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]

5205

<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]

5206

<pre>Updates the master for a specific cluster.

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5210

Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5211

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5212

The object takes the form of:

5213

5214

{ # UpdateMasterRequest updates the master of the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5215

"name": "A String", # The name (project, location, cluster) of the cluster to update.

5216

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5217

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5218

# number](https://support.google.com/cloud/answer/6158840).

5219

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5220

"masterVersion": "A String", # Required. The Kubernetes version to change the master to.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5221

#

5222

# Users may specify either explicit versions offered by

5223

# Kubernetes Engine or version aliases, which have the following behavior:

5224

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5225

# - "latest": picks the highest valid Kubernetes version

5226

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

5227

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

5228

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

5229

# - "-": picks the default Kubernetes version

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5230

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

5231

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5232

# cluster resides. This field has been deprecated and replaced by the name

5233

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5234

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5235

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5236

}

5237

5238

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5245

5246

{ # This operation resource represents operations that may have happened or are

5247

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5248

"targetLink": "A String", # Server-defined URL for the target of the operation.

5249

"detail": "A String", # Detailed operation progress, if available.

5250

"operationType": "A String", # The operation type.

5251

"status": "A String", # The current status of the operation.

5252

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5253

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5254

{ # StatusCondition describes why a cluster or a node pool has a certain status

5255

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5256

"code": "A String", # Machine-friendly representation of the condition

5257

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5258

},

5259

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5260

"endTime": "A String", # [Output only] The time the operation completed, in

5261

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5262

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5263

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5264

# or

5265

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5266

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5267

"startTime": "A String", # [Output only] The time the operation started, in

5268

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5269

"clusterConditions": [ # Which conditions caused the current cluster state.

5270

{ # StatusCondition describes why a cluster or a node pool has a certain status

5271

# (e.g., ERROR or DEGRADED).

5272

"code": "A String", # Machine-friendly representation of the condition

5273

"message": "A String", # Human-friendly representation of the condition

5274

},

5275

],

5276

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5277

"metrics": [ # Progress metric bundle, for example:

5278

# metrics: [{name: "nodes done", int_value: 15},

5279

# {name: "nodes total", int_value: 32}]

5280

# or

5281

# metrics: [{name: "progress", double_value: 0.56},

5282

# {name: "progress scale", double_value: 1.0}]

5283

{ # Progress metric is (string, int|float|string) pair.

5284

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

5285

"doubleValue": 3.14, # For metrics with floating point value.

5286

"intValue": "A String", # For metrics with integer value.

5287

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

5288

},

5289

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5290

"status": "A String", # Status of an operation stage.

5291

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5292

"name": "A String", # A non-parameterized string describing an operation stage.

5293

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5294

"stages": [ # Substages of an operation or a stage.

5295

# Object with schema name: OperationProgress

5296

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5297

},

5298

"zone": "A String", # The name of the Google Compute Engine

5299

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5300

# operation is taking place. This field is deprecated, use location instead.

5301

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

5302

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim