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

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

[diff] [blame]

83

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

Bu Sun Kim

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

[diff] [blame]

84

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

85

Dan O'Meara

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

[diff] [blame]

86

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

Bu Sun Kim

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

[diff] [blame]

87

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

88

Dan O'Meara

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

[diff] [blame]

89

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

Bu Sun Kim

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

[diff] [blame]

90

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

91

92

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

93

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

94

95

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

96

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

97

Dan O'Meara

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

[diff] [blame]

98

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

Bu Sun Kim

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

[diff] [blame]

99

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

100

101

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

102

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

103

Dan O'Meara

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

[diff] [blame]

104

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

Bu Sun Kim

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

[diff] [blame]

105

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

106

Dan O'Meara

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

[diff] [blame]

107

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

Bu Sun Kim

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

[diff] [blame]

108

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

109

Dan O'Meara

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

[diff] [blame]

110

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

Bu Sun Kim

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

[diff] [blame]

111

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

112

Dan O'Meara

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

[diff] [blame]

113

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

Bu Sun Kim

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

[diff] [blame]

114

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

115

Dan O'Meara

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

[diff] [blame]

116

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

Bu Sun Kim

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

[diff] [blame]

117

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

118

Dan O'Meara

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

[diff] [blame]

119

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

Bu Sun Kim

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

[diff] [blame]

120

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

121

Dan O'Meara

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

[diff] [blame]

122

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

Bu Sun Kim

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

[diff] [blame]

123

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

124

Dan O'Meara

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

127

Dan O'Meara

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

[diff] [blame]

128

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

Bu Sun Kim

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

[diff] [blame]

129

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

130

Dan O'Meara

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

[diff] [blame]

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

133

<h3>Method Details</h3>

134

Dan O'Meara

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

[diff] [blame]

135

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

Bu Sun Kim

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

[diff] [blame]

136

<pre>Sets the addons for a specific cluster.

137

138

Args:

Dan O'Meara

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

[diff] [blame]

139

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

Bu Sun Kim

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

[diff] [blame]

140

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

141

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

Dan O'Meara

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

[diff] [blame]

142

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

143

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

144

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

145

field. (required)

146

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

Bu Sun Kim

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

[diff] [blame]

147

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

Dan O'Meara

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

[diff] [blame]

148

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

149

The object takes the form of:

150

151

{ # SetAddonsRequest sets the addons associated with the cluster.

Bu Sun Kim

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

[diff] [blame]

152

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

153

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

Bu Sun Kim

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

[diff] [blame^]

154

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

155

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

Bu Sun Kim

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

[diff] [blame]

156

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

157

# cluster.

158

# cluster, enabling additional functionality.

Bu Sun Kim

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

[diff] [blame^]

159

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

160

# extension to manage hosted GCP services through the Kubernetes API

161

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

Bu Sun Kim

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

[diff] [blame]

162

},

163

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

164

# enabled at cluster creation time.

165

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

166

},

Bu Sun Kim

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

[diff] [blame^]

167

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

168

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

Bu Sun Kim

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

[diff] [blame]

169

},

170

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

171

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

172

# is enabled for the nodes.

173

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

174

# is enabled for the nodes.

175

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

176

},

Bu Sun Kim

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

[diff] [blame^]

177

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

178

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

179

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

180

# workloads and applications. For more information, see:

181

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

182

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

Bu Sun Kim

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

[diff] [blame]

183

},

Bu Sun Kim

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

[diff] [blame^]

184

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

185

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

186

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

187

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

188

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

189

# balancers.

190

},

191

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

192

# microservices.

193

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

194

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

195

},

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

# Monitoring.

Bu Sun Kim

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

[diff] [blame]

204

},

Bu Sun Kim

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

[diff] [blame^]

205

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

206

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

207

# at cluster creation time.

208

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

209

},

210

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

211

# applications.

212

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

213

},

Bu Sun Kim

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

[diff] [blame]

214

},

Bu Sun Kim

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

[diff] [blame^]

215

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

216

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

217

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

218

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

219

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

220

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

221

# field.

Bu Sun Kim

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

[diff] [blame]

222

}

223

224

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

231

232

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

233

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

Bu Sun Kim

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

[diff] [blame]

234

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

Bu Sun Kim

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

[diff] [blame]

235

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

Bu Sun Kim

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

[diff] [blame]

236

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

Bu Sun Kim

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

[diff] [blame^]

237

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

238

# Object with schema name: OperationProgress

239

],

240

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

241

# Unset for single-stage operations.

242

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

243

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

244

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

245

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

246

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

247

# or

248

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

249

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

250

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

Bu Sun Kim

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

[diff] [blame]

251

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

Bu Sun Kim

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

[diff] [blame]

252

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

Bu Sun Kim

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

[diff] [blame^]

253

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

254

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

Bu Sun Kim

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

[diff] [blame]

255

},

256

],

Bu Sun Kim

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

[diff] [blame]

257

},

Bu Sun Kim

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

[diff] [blame^]

258

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

259

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

260

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

261

# or

262

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

263

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

264

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

265

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

266

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

Bu Sun Kim

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

[diff] [blame^]

267

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

268

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

Bu Sun Kim

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

[diff] [blame]

269

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

Bu Sun Kim

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

[diff] [blame^]

270

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

271

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

272

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

273

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

274

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

275

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

276

},

277

],

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

},

287

],

288

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

293

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

Bu Sun Kim

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

[diff] [blame]

294

<pre>Completes master IP rotation.

295

296

Args:

Dan O'Meara

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

[diff] [blame]

297

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

Bu Sun Kim

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

[diff] [blame]

298

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

299

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

Dan O'Meara

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

[diff] [blame]

300

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

301

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

302

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

303

field. (required)

304

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

Bu Sun Kim

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

[diff] [blame]

305

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

Dan O'Meara

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

[diff] [blame]

306

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

307

The object takes the form of:

308

309

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

Bu Sun Kim

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

[diff] [blame]

310

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

Dan O'Meara

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

[diff] [blame]

311

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

312

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

313

# field.

Bu Sun Kim

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

[diff] [blame^]

314

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

315

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

316

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

317

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

318

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

319

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

320

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

Bu Sun Kim

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

[diff] [blame]

321

}

322

323

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

330

331

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

332

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

Bu Sun Kim

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

[diff] [blame]

333

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

Bu Sun Kim

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

[diff] [blame]

334

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

Bu Sun Kim

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

[diff] [blame]

335

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

Bu Sun Kim

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

[diff] [blame^]

336

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

337

# Object with schema name: OperationProgress

338

],

339

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

340

# Unset for single-stage operations.

341

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

342

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

343

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

344

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

345

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

346

# or

347

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

348

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

349

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

Bu Sun Kim

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

[diff] [blame]

350

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

Bu Sun Kim

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

[diff] [blame]

351

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

Bu Sun Kim

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

[diff] [blame^]

352

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

353

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

Bu Sun Kim

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

[diff] [blame]

354

},

355

],

Bu Sun Kim

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

[diff] [blame]

356

},

Bu Sun Kim

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

[diff] [blame^]

357

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

358

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

359

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

360

# or

361

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

362

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

363

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

364

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

365

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

Bu Sun Kim

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

[diff] [blame^]

366

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

367

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

Bu Sun Kim

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

[diff] [blame]

368

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

Bu Sun Kim

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

[diff] [blame^]

369

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

370

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

371

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

372

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

373

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

374

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

375

},

376

],

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

},

386

],

387

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

392

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

Bu Sun Kim

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

[diff] [blame]

393

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

394

Compute Engine instances.

395

Bu Sun Kim

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

[diff] [blame]

396

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

Dan O'Meara

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

[diff] [blame]

397

[default

398

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

Bu Sun Kim

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

[diff] [blame]

399

400

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

401

the Kubelet creates routes for each node to allow the containers

402

on that node to communicate with all other instances in the

403

cluster.

404

Bu Sun Kim

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

[diff] [blame]

405

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

Bu Sun Kim

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

[diff] [blame]

406

which CIDR range the cluster is using.

407

408

Args:

Dan O'Meara

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

[diff] [blame]

409

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

Bu Sun Kim

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

[diff] [blame]

410

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

411

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

Dan O'Meara

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

[diff] [blame]

412

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

413

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

414

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

415

field. (required)

416

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

417

The object takes the form of:

418

419

{ # CreateClusterRequest creates a cluster.

Bu Sun Kim

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

[diff] [blame^]

420

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

421

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

422

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

423

# field.

Bu Sun Kim

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

[diff] [blame]

424

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

425

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

Bu Sun Kim

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

[diff] [blame^]

426

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

427

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

428

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

Bu Sun Kim

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

[diff] [blame]

429

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

Bu Sun Kim

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

[diff] [blame^]

430

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

Bu Sun Kim

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

[diff] [blame]

431

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

432

# cluster, enabling additional functionality.

Bu Sun Kim

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

[diff] [blame^]

433

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

434

# extension to manage hosted GCP services through the Kubernetes API

435

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

Bu Sun Kim

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

[diff] [blame]

436

},

437

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

438

# enabled at cluster creation time.

439

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

440

},

Bu Sun Kim

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

[diff] [blame^]

441

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

442

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

Bu Sun Kim

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

[diff] [blame]

443

},

444

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

445

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

446

# is enabled for the nodes.

447

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

448

# is enabled for the nodes.

449

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

450

},

Bu Sun Kim

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

[diff] [blame^]

451

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

452

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

453

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

454

# workloads and applications. For more information, see:

455

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

456

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

Bu Sun Kim

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

[diff] [blame]

457

},

Bu Sun Kim

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

[diff] [blame^]

458

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

459

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

460

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

461

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

462

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

463

# balancers.

464

},

465

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

466

# microservices.

467

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

468

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

469

},

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

# Monitoring.

Bu Sun Kim

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

[diff] [blame]

478

},

Bu Sun Kim

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

[diff] [blame^]

479

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

480

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

481

# at cluster creation time.

482

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

483

},

484

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

485

# applications.

486

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

487

},

Bu Sun Kim

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

[diff] [blame]

488

},

Bu Sun Kim

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

[diff] [blame^]

489

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

490

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

491

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

492

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

493

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

494

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

495

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

496

# mode.

497

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

498

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

499

# controllers, will have statically granted permissions beyond those

500

# provided by the RBAC configuration or IAM.

501

},

502

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

503

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

504

# images will be validated by Google Binauthz.

505

},

Bu Sun Kim

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

[diff] [blame]

506

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

507

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

508

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

509

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

510

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

Bu Sun Kim

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

[diff] [blame^]

511

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

512

# Call Kubernetes API directly to retrieve node information.

Bu Sun Kim

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

[diff] [blame]

513

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

Bu Sun Kim

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

[diff] [blame]

514

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

515

# will be automatically chosen with the default size.

516

#

517

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

518

#

519

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

520

#

521

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

526

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

527

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

528

# to use.

Bu Sun Kim

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

[diff] [blame^]

529

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

Bu Sun Kim

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

[diff] [blame]

530

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

531

# range will be automatically chosen with the default size.

532

#

533

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

534

#

535

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

536

#

537

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

542

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

543

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

544

# to use.

Dan O'Meara

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

[diff] [blame]

545

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

Bu Sun Kim

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

[diff] [blame^]

546

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

547

# This is used in conjunction with use_routes. It cannot

548

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

549

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

550

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

551

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

552

#

553

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

554

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

555

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

556

# addresses. This must be an existing secondary range associated

557

# with the cluster subnetwork.

558

#

559

# This field is only applicable with use_ip_aliases and

560

# create_subnetwork is false.

Bu Sun Kim

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

[diff] [blame]

561

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

562

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

563

# ClusterIPs. This must be an existing secondary range associated

564

# with the cluster subnetwork.

565

#

566

# This field is only applicable with use_ip_aliases and

567

# create_subnetwork is false.

Bu Sun Kim

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

[diff] [blame^]

568

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

569

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

570

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

571

# then the server picks the default IP allocation mode

Bu Sun Kim

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

[diff] [blame]

572

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

573

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

574

# subnetwork.

Bu Sun Kim

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

[diff] [blame^]

575

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

576

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

577

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

578

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

579

# range.

580

#

581

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

582

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

583

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

584

# `services_ipv4_cidr_block` must be fully-specified.

585

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

586

# fully-specified.

Bu Sun Kim

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

[diff] [blame]

587

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

Bu Sun Kim

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

[diff] [blame^]

588

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

589

#

590

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

591

#

592

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

593

#

594

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

599

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

600

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

601

# to use.

602

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

603

# `cluster.cluster_ipv4_cidr` must be left blank.

604

#

605

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

606

#

607

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

608

#

609

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

614

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

615

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

616

# to use.

Bu Sun Kim

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

[diff] [blame]

617

},

Bu Sun Kim

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

[diff] [blame]

618

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

619

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

620

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

621

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

622

},

Bu Sun Kim

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

[diff] [blame^]

623

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

624

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

625

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

626

# private networking.

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

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

635

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

Bu Sun Kim

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

[diff] [blame]

636

},

Bu Sun Kim

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

[diff] [blame^]

637

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

638

},

639

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

640

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

641

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

642

# policies.

643

# policies.

644

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

645

"identityProvider": "A String", # identity provider is the third party identity provider.

646

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

647

},

Bu Sun Kim

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

[diff] [blame]

648

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

649

# Currently available options:

650

#

Bu Sun Kim

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

[diff] [blame]

651

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

Dan O'Meara

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

[diff] [blame]

652

# service with a Kubernetes-native resource model

653

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

654

# longer available as of GKE 1.15).

655

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

656

#

657

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

658

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

Bu Sun Kim

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

[diff] [blame^]

659

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

660

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

661

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

662

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

663

# prevent sNAT on cluster internal traffic.

664

# be disabled on the cluster.

665

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

666

},

667

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

668

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

669

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

670

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

671

# cluster is connected. Example:

672

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

673

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

674

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

675

# to which the cluster is connected. Example:

676

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

Bu Sun Kim

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

[diff] [blame]

677

},

Bu Sun Kim

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

[diff] [blame^]

678

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

679

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

Bu Sun Kim

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

[diff] [blame]

680

},

Bu Sun Kim

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

[diff] [blame^]

681

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

682

# If unspecified, the defaults are used:

683

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

684

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

685

# certificate will be issued.

686

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

687

# certificates.

688

"clusterCaCertificate": "A String",

689

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

690

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

691

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

692

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

693

# authenticate to the cluster endpoint.

694

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

695

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

696

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

697

# must be non-empty.

698

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

699

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

700

# certificate is issued.

701

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

702

},

703

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

704

# to the cluster endpoint.

Bu Sun Kim

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

[diff] [blame]

705

},

Bu Sun Kim

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

[diff] [blame^]

706

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

707

# found in validMasterVersions returned by getServerConfig. The version can

708

# be upgraded over time; such upgrades are reflected in

709

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

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

[diff] [blame]

710

#

Bu Sun Kim

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

[diff] [blame^]

711

# Users may specify either explicit versions offered by

712

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

Bu Sun Kim

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

[diff] [blame]

713

#

Bu Sun Kim

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

[diff] [blame^]

714

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

715

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

716

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

717

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

718

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

719

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

720

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

721

# master communicate over private IP addresses.

722

# This field is deprecated, use private_cluster_config.enable_private_nodes

723

# instead.

Bu Sun Kim

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

[diff] [blame]

724

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

725

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

Bu Sun Kim

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

[diff] [blame]

726

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

727

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

728

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

729

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

730

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

731

# `node_pool.config`)

732

#

733

# If unspecified, the defaults are used.

734

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

Bu Sun Kim

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

[diff] [blame^]

735

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

736

# node VMs under the "default" service account.

Bu Sun Kim

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

[diff] [blame]

737

#

Bu Sun Kim

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

[diff] [blame^]

738

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

739

# not included:

740

#

741

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

742

# persistent storage on your nodes.

743

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

744

# communicating with **gcr.io**

745

# (the [Google Container

746

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

747

#

748

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

749

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

750

"A String",

751

],

Bu Sun Kim

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

[diff] [blame]

752

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

753

#

754

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

755

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

756

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

757

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

763

# "enable-oslogin"

764

# "gci-ensure-gke-docker"

765

# "gci-metrics-enabled"

766

# "gci-update-strategy"

767

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

772

# "windows-startup-script-ps1"

773

# "common-psm1"

774

# "k8s-node-setup-psm1"

775

# "install-ssh-psm1"

776

# "user-profile-psm1"

777

# "serial-port-logging-enable"

778

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

779

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

780

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

781

#

782

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

783

"a_key": "A String",

784

},

Bu Sun Kim

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

[diff] [blame^]

785

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

786

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

787

# `n1-standard-1`).

788

#

789

# If unspecified, the default machine type is

790

# `n1-standard-1`.

791

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

792

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

793

# workloads on [sole tenant

794

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

795

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

796

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

797

#

798

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

799

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

800

# boot process if signature verification fails.

801

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

802

#

803

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

804

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

805

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

806

# the instance is created.

Bu Sun Kim

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

[diff] [blame]

807

},

Bu Sun Kim

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

[diff] [blame]

808

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

809

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

Bu Sun Kim

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

[diff] [blame]

810

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

Bu Sun Kim

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

[diff] [blame^]

811

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

812

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running

813

# on the nodes.

814

#

815

# The following parameters are supported.

816

#

817

# net.core.netdev_max_backlog

818

# net.core.rmem_max

819

# net.core.wmem_default

820

# net.core.wmem_max

821

# net.core.optmem_max

# net.core.somaxconn

# net.ipv4.tcp_rmem

# net.ipv4.tcp_wmem

# net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

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

830

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

831

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

832

},

Bu Sun Kim

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

[diff] [blame]

833

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

Bu Sun Kim

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

[diff] [blame]

834

#

835

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

836

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

837

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

838

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

839

#

Bu Sun Kim

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

[diff] [blame]

840

# See

841

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

842

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

Bu Sun Kim

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

[diff] [blame]

843

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

Bu Sun Kim

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

[diff] [blame]

844

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

Bu Sun Kim

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

[diff] [blame^]

845

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

Bu Sun Kim

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

[diff] [blame]

846

},

847

],

Bu Sun Kim

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

[diff] [blame^]

848

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

849

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'.

850

#

851

# The string must be a sequence of decimal numbers, each with optional

852

# fraction and a unit suffix, such as "300ms".

853

# Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

854

# The value must be a positive duration.

855

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits.

856

#

857

# If this option is enabled, kubelet uses CFS quota

858

# (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to

859

# enforce container CPU limits. Otherwise, CPU limits will not be enforced at

860

# all.

861

#

862

# Disable this option to mitigate CPU throttling problems while still having

863

# your pods to be in Guaranteed QoS class by specifying the CPU limits.

864

#

865

# The default value is 'true' if unspecified.

866

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node.

867

# See

868

# https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

869

#

870

# The following values are allowed.

871

# - "none": the default, which represents the existing scheduling behavior.

872

# - "static": allows pods with certain resource characteristics to be

873

# granted increased CPU affinity and exclusivity on the node.

874

},

Bu Sun Kim

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

[diff] [blame]

875

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

876

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

877

# Kubernetes may apply to the node.

878

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

879

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

880

# and conflicts should be avoided.

881

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

882

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

883

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

884

},

Bu Sun Kim

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

[diff] [blame^]

885

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

Bu Sun Kim

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

[diff] [blame]

886

#

Bu Sun Kim

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

[diff] [blame^]

887

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

Bu Sun Kim

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

[diff] [blame]

888

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

889

# workloads on the node pool.

890

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

891

# workloads running on the node.

892

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

893

# on the node pool.

894

},

Bu Sun Kim

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

[diff] [blame]

895

"bootDiskKmsKey": "A String", #

896

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

897

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

898

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

899

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

900

# see:

901

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

Bu Sun Kim

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

[diff] [blame^]

902

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

903

# The smallest allowed disk size is 10GB.

904

#

905

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

906

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

907

# the specified [Zonal Compute

908

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

909

# to this node pool.

910

# is the configuration of desired reservation which instances could take

911

# capacity from.

912

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

913

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

914

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

915

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

916

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

917

"A String",

918

],

Bu Sun Kim

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

[diff] [blame]

919

},

Bu Sun Kim

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

[diff] [blame^]

920

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

921

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

922

# inforamtion about preemptible VM instances.

923

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

924

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

925

# friendly names of CPU platforms, such as

926

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

927

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

928

# information, read [how to specify min CPU

929

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

930

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

931

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

932

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

933

# must comply with RFC1035.

934

"A String",

935

],

936

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

937

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

938

# support for GPUs.

939

{ # AcceleratorConfig represents a Hardware Accelerator request.

940

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

941

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

942

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

943

},

944

],

945

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

946

#

947

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

948

# disks available on a machine per zone. See:

949

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

950

# for more information.

951

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

952

# the latest version of it will be used.

Bu Sun Kim

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

[diff] [blame]

953

},

Bu Sun Kim

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

[diff] [blame^]

954

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

955

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

956

# master authorized networks will disallow all external traffic to access

957

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

958

# Google Compute Engine Public IPs and Google Prod IPs.

959

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

960

# Kubernetes master through HTTPS.

961

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

962

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

963

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

964

},

965

],

966

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

967

},

968

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

969

# this cluster, in

Bu Sun Kim

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

[diff] [blame]

970

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

Bu Sun Kim

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

[diff] [blame^]

971

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

972

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

973

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

974

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

975

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

976

# This field is deprecated, use

977

# private_cluster_config.master_ipv4_cidr_block instead.

Bu Sun Kim

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

[diff] [blame]

978

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

979

# required by Cluster Autoscaler to automatically adjust

980

# the size of the cluster and create/delete

981

# node pools based on the current needs.

Bu Sun Kim

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

[diff] [blame]

982

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

983

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

984

# created by NAP.

985

# by NAP.

Bu Sun Kim

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

[diff] [blame^]

986

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

Bu Sun Kim

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

[diff] [blame]

987

# disruption caused by an upgrade.

988

#

989

# maxUnavailable controls the number of nodes that can be simultaneously

990

# unavailable.

991

#

992

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

993

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

994

# available nodes.

995

#

996

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

997

# nodes are being upgraded at the same time).

998

#

999

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

1000

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

1001

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

1002

# PodDisruptionBudget, if it is configured.)

1003

#

1004

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

1005

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

1006

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

1007

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

1008

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame]

1009

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

1010

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

1011

# Ready.

Bu Sun Kim

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

[diff] [blame]

1012

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

1013

# of the node pool during the upgrade process.

Bu Sun Kim

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

[diff] [blame]

1014

},

Bu Sun Kim

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

[diff] [blame^]

1015

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

1016

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

1017

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

1018

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

1019

# node VMs under the "default" service account.

1020

#

1021

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

1022

# not included:

1023

#

1024

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

1025

# persistent storage on your nodes.

1026

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

1027

# communicating with **gcr.io**

1028

# (the [Google Container

1029

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

1030

#

1031

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

1032

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

1033

"A String",

1034

],

1035

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

1036

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

1037

# friendly names of CPU platforms, such as

1038

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

1039

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

1040

# information, read [how to specify min CPU

1041

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

1042

# To unset the min cpu platform field pass "automatic"

1043

# as field value.

1044

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

1045

# node pool.

1046

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

1047

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

1048

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

1049

# the Auto Upgrades will proceed.

1050

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

1051

# with the description of the upgrade.

1052

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

1053

# with the approximate start time for the upgrades, in

1054

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

1055

},

1056

},

Bu Sun Kim

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

[diff] [blame]

1057

},

Bu Sun Kim

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

[diff] [blame^]

1058

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

1059

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

1060

# amount of resources in the cluster.

1061

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

1062

# For memory, value should be in GB.

1063

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

1064

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

1065

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

1066

},

1067

],

1068

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

1069

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

1070

# NodePool's nodes can be created by NAP.

1071

"A String",

1072

],

Dan O'Meara

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

[diff] [blame]

1073

},

Bu Sun Kim

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

[diff] [blame^]

1074

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

1075

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

1076

# cluster's nodes should be located.

1077

"A String",

1078

],

1079

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

1080

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

1081

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

1082

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

1083

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

1084

},

1085

],

1086

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

1087

# Currently available options:

1088

#

1089

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

1090

# service with a Kubernetes-native resource model

1091

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

1092

# available as of GKE 1.15).

1093

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

1094

#

1095

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

1096

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

1097

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

1098

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

1099

# the kubernetes version of the master and nodes.

1100

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

1101

# Alpha enabled clusters are automatically deleted thirty days after

1102

# creation.

1103

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

1104

"A String",

1105

],

1106

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

1107

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

1108

# the following restrictions:

1109

#

1110

# * Lowercase letters, numbers, and hyphens only.

1111

# * Must start with a letter.

1112

# * Must end with a number or a letter.

1113

"master": { # Master is the configuration for components on master. # Configuration for master components.

1114

},

1115

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

1116

# The endpoint can be accessed from the internet at

1117

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

1118

#

1119

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

1120

# password information.

1121

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

1122

# disabled when this config unspecified.

1123

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

1124

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

1125

# second BigQuery table will be created to hold resource consumption

1126

# records.

1127

},

1128

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

1129

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

1130

},

1131

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

1132

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

1133

},

1134

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

1135

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

1136

# or

1137

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

1138

# in which the cluster resides.

1139

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

1140

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

1141

# if enabled = true.

1142

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

1143

# during authentication using a group of security groups.

1144

},

1145

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

1146

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

1147

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

1148

# the name.

1149

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

1150

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

1151

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

1152

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

1153

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

1154

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

1155

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

1156

# end time.

1157

#

1158

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

1159

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

1160

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

1161

# <code>FREQ=DAILY</code>

1162

# For the first weekend of every month:

1163

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

1164

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

1165

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

1166

# <code>

1167

# start time = 2019-01-01T09:00:00-0400

1168

# end time = 2019-01-01T17:00:00-0400

1169

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

1170

# </code>

1171

# Windows can span multiple days. Eg, to make the window encompass every

1172

# weekend from midnight Saturday till the last minute of Sunday UTC:

1173

# <code>

1174

# start time = 2019-01-05T00:00:00Z

1175

# end time = 2019-01-07T23:59:00Z

1176

# recurrence = FREQ=WEEKLY;BYDAY=SA

1177

# </code>

1178

# Note the start and end time's specific dates are largely arbitrary except

1179

# to specify duration of the window and when it first starts.

1180

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

1181

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

1182

"endTime": "A String", # The time that the window ends. The end time should take place after the

1183

# start time.

1184

"startTime": "A String", # The time that the window first starts.

1185

},

1186

},

1187

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1188

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

1189

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

1190

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

1191

# smallest possible in the given scenario.

1192

},

1193

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

1194

# occur in these windows.

1195

"a_key": { # Represents an arbitrary window of time.

1196

"endTime": "A String", # The time that the window ends. The end time should take place after the

1197

# start time.

1198

"startTime": "A String", # The time that the window first starts.

},

},

},

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

1203

# the policy won't accidentally undo intermediate changes (and so that users

1204

# of the API unaware of some fields won't accidentally remove other fields).

1205

# Make a <code>get()</code> request to the cluster to get the current

1206

# resource version and include it with requests to set the policy.

1207

},

1208

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

1209

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

1210

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

1211

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

1212

},

1213

"nodePools": [ # The node pools associated with this cluster.

1214

# This field should not be set if "node_config" or "initial_node_count" are

1215

# specified.

1216

{ # NodePool contains the name and configuration for a cluster's node pool.

1217

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

1218

# specification, under the control of the cluster master. They may have a set

1219

# of Kubernetes labels applied to them, which may be used to reference them

1220

# during pod scheduling. They may also be resized up or down, to accommodate

1221

# the workload.

1222

"status": "A String", # [Output only] The status of the nodes in this pool instance.

1223

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

1224

# disruption caused by an upgrade.

1225

#

1226

# maxUnavailable controls the number of nodes that can be simultaneously

1227

# unavailable.

1228

#

1229

# maxSurge controls the number of additional nodes that can be added to the

1230

# node pool temporarily for the time of the upgrade to increase the number of

1231

# available nodes.

1232

#

1233

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

1234

# nodes are being upgraded at the same time).

1235

#

1236

# Note: upgrades inevitably introduce some disruption since workloads need to

1237

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

1238

# this holds true. (Disruption stays within the limits of

1239

# PodDisruptionBudget, if it is configured.)

1240

#

1241

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

1242

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

1243

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

1244

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

1245

# there are always at least 4 nodes available.

1246

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

1247

# the upgrade process. A node is considered available if its status is

1248

# Ready.

1249

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

1250

# of the node pool during the upgrade process.

1251

},

1252

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

1253

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

1254

# associated with this node pool.

1255

"A String",

1256

],

1257

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

1258

# only if a valid configuration is present.

1259

# adjust the size of the node pool to the current cluster usage.

1260

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

1261

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

1262

# max_node_count.

1263

"enabled": True or False, # Is autoscaling enabled for this node pool.

1264

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

1265

# has to enough quota to scale up the cluster.

1266

},

1267

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

1268

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

1269

# is sufficient for this number of instances. You must also have available

1270

# firewall and routes quota.

1271

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

1272

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

1273

# node VMs under the "default" service account.

1274

#

1275

# The following scopes are recommended, but not required, and by default are

1276

# not included:

1277

#

1278

# * `https://www.googleapis.com/auth/compute` is required for mounting

1279

# persistent storage on your nodes.

1280

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

1281

# communicating with **gcr.io**

1282

# (the [Google Container

1283

# Registry](https://cloud.google.com/container-registry/)).

1284

#

1285

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

1286

# Monitoring are enabled, in which case their required scopes will be added.

1287

"A String",

1288

],

1289

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

1290

#

1291

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

1292

# in length. These are reflected as part of a URL in the metadata server.

1293

# Additionally, to avoid ambiguity, keys must not conflict with any other

1294

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1300

# "enable-oslogin"

1301

# "gci-ensure-gke-docker"

1302

# "gci-metrics-enabled"

1303

# "gci-update-strategy"

1304

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1309

# "windows-startup-script-ps1"

1310

# "common-psm1"

1311

# "k8s-node-setup-psm1"

1312

# "install-ssh-psm1"

1313

# "user-profile-psm1"

1314

# "serial-port-logging-enable"

1315

# Values are free-form strings, and only have meaning as interpreted by

1316

# the image running in the instance. The only restriction placed on them is

1317

# that each value's size must be less than or equal to 32 KB.

1318

#

1319

# The total size of all keys and values must be less than 512 KB.

1320

"a_key": "A String",

1321

},

1322

"machineType": "A String", # The name of a Google Compute Engine [machine

1323

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

1324

# `n1-standard-1`).

1325

#

1326

# If unspecified, the default machine type is

1327

# `n1-standard-1`.

1328

"nodeGroup": "A String", # Setting this field will assign instances of this

1329

# pool to run on the specified node group. This is useful for running

1330

# workloads on [sole tenant

1331

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

1332

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1333

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1334

#

1335

# Secure Boot helps ensure that the system only runs authentic software by

1336

# verifying the digital signature of all boot components, and halting the

1337

# boot process if signature verification fails.

1338

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1339

#

1340

# Enables monitoring and attestation of the boot integrity of the instance.

1341

# The attestation is performed against the integrity policy baseline. This

1342

# baseline is initially derived from the implicitly trusted boot image when

1343

# the instance is created.

1344

},

1345

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

1346

# Specify the email address of the Service Account; otherwise, if no Service

1347

# Account is specified, the "default" service account is used.

1348

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1349

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running

1350

# on the nodes.

1351

#

1352

# The following parameters are supported.

1353

#

1354

# net.core.netdev_max_backlog

1355

# net.core.rmem_max

1356

# net.core.wmem_default

1357

# net.core.wmem_max

1358

# net.core.optmem_max

# net.core.somaxconn

# net.ipv4.tcp_rmem

# net.ipv4.tcp_wmem

# net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1367

"type": "A String", # Type of the sandbox to use for the node.

1368

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

1369

},

1370

"taints": [ # List of kubernetes taints to be applied to each node.

1371

#

1372

# For more information, including usage and the valid values, see:

1373

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1374

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

1375

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

1376

#

1377

# See

1378

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

1379

# for more information, including usage and the valid values.

1380

"effect": "A String", # Effect for taint.

1381

"key": "A String", # Key for taint.

1382

"value": "A String", # Value for taint.

1383

},

1384

],

1385

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1386

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'.

1387

#

1388

# The string must be a sequence of decimal numbers, each with optional

1389

# fraction and a unit suffix, such as "300ms".

1390

# Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

1391

# The value must be a positive duration.

1392

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits.

1393

#

1394

# If this option is enabled, kubelet uses CFS quota

1395

# (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to

1396

# enforce container CPU limits. Otherwise, CPU limits will not be enforced at

1397

# all.

1398

#

1399

# Disable this option to mitigate CPU throttling problems while still having

1400

# your pods to be in Guaranteed QoS class by specifying the CPU limits.

1401

#

1402

# The default value is 'true' if unspecified.

1403

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node.

1404

# See

1405

# https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

1406

#

1407

# The following values are allowed.

1408

# - "none": the default, which represents the existing scheduling behavior.

1409

# - "static": allows pods with certain resource characteristics to be

1410

# granted increased CPU affinity and exclusivity on the node.

1411

},

1412

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

1413

# These will added in addition to any default label(s) that

1414

# Kubernetes may apply to the node.

1415

# In case of conflict in label keys, the applied set may differ depending on

1416

# the Kubernetes version -- it's best to assume the behavior is undefined

1417

# and conflicts should be avoided.

1418

# For more information, including usage and the valid values, see:

1419

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

1420

"a_key": "A String",

1421

},

1422

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

1423

#

1424

# If unspecified, the default disk type is 'pd-standard'

1425

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

1426

# workloads on the node pool.

1427

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

1428

# workloads running on the node.

1429

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

1430

# on the node pool.

1431

},

1432

"bootDiskKmsKey": "A String", #

1433

# The Customer Managed Encryption Key used to encrypt the boot disk attached

1434

# to each node in the node pool. This should be of the form

1435

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

1436

# For more information about protecting resources with Cloud KMS Keys please

1437

# see:

1438

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

1439

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

1440

# The smallest allowed disk size is 10GB.

1441

#

1442

# If unspecified, the default disk size is 100GB.

1443

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

1444

# the specified [Zonal Compute

1445

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

1446

# to this node pool.

1447

# is the configuration of desired reservation which instances could take

1448

# capacity from.

1449

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1450

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

1451

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

1452

# the key and specify the name of your reservation as its value.

1453

"values": [ # Corresponds to the label value(s) of reservation resource(s).

"A String",

],

},

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

1458

# https://cloud.google.com/compute/docs/instances/preemptible for more

1459

# inforamtion about preemptible VM instances.

1460

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

1461

# scheduled on the specified or newer CPU platform. Applicable values are the

1462

# friendly names of CPU platforms, such as

1463

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

1464

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

1465

# information, read [how to specify min CPU

1466

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1467

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

1468

# valid sources or targets for network firewalls and are specified by

1469

# the client during cluster or node pool creation. Each tag within the list

1470

# must comply with RFC1035.

1471

"A String",

1472

],

1473

"accelerators": [ # A list of hardware accelerators to be attached to each node.

1474

# See https://cloud.google.com/compute/docs/gpus for more information about

1475

# support for GPUs.

1476

{ # AcceleratorConfig represents a Hardware Accelerator request.

1477

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1478

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

1479

# [here](https://cloud.google.com/compute/docs/gpus)

1480

},

1481

],

1482

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

1483

#

1484

# The limit for this value is dependent upon the maximum number of

1485

# disks available on a machine per zone. See:

1486

# https://cloud.google.com/compute/docs/disks/local-ssd

1487

# for more information.

1488

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

1489

# the latest version of it will be used.

1490

},

1491

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1492

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

1493

# node pool.

1494

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

1495

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

1496

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

1497

# the Auto Upgrades will proceed.

1498

"description": "A String", # [Output only] This field is set when upgrades are about to commence

1499

# with the description of the upgrade.

1500

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

1501

# with the approximate start time for the upgrades, in

1502

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1503

},

1504

},

1505

"name": "A String", # The name of the node pool.

1506

"version": "A String", # The version of the Kubernetes of this node.

1507

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

1508

# simultaneously on a node in the node pool.

1509

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1510

},

1511

"statusMessage": "A String", # [Output only] Additional information about the current status of this

1512

# node pool instance, if available.

1513

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

1514

"conditions": [ # Which conditions caused the current node pool state.

1515

{ # StatusCondition describes why a cluster or a node pool has a certain status

1516

# (e.g., ERROR or DEGRADED).

1517

"code": "A String", # Machine-friendly representation of the condition

1518

"message": "A String", # Human-friendly representation of the condition

1519

},

1520

],

1521

"locations": [ # The list of Google Compute Engine

1522

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1523

# NodePool's nodes should be located.

"A String",

],

},

],

"statusMessage": "A String", # [Output only] Additional information about the current status of this

1529

# cluster, if available.

1530

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

1531

# subscribed to. Release channels are arranged in order of risk.

1532

#

1533

# When a cluster is subscribed to a release channel, Google maintains

1534

# both the master version and the node version. Node auto-upgrade

1535

# defaults to true and cannot be disabled.

1536

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

1537

},

1538

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1539

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

1540

# simultaneously on a node in the node pool of this cluster. Only honored

1541

# if cluster created with IP Alias support.

1542

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1543

},

1544

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

1545

"type": "A String", # Type of the integration.

1546

},

1547

"status": "A String", # [Output only] The current status of this cluster.

1548

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

1549

# Google Compute Engine resources.

1550

"a_key": "A String",

1551

},

1552

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

1553

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1554

# notation (e.g. `1.2.3.4/29`).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1555

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1556

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1557

# is sufficient for this number of instances. You must also have available

1558

# firewall and routes quota.

1559

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1560

# "node_pool" object, since this configuration (along with the

1561

# "node_config") will be used to create a "NodePool" object with an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1562

# auto-generated name. Do not use this and a node_pool at the same time.

1563

#

1564

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1565

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

1566

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

1567

# must be valid under a PodSecurityPolicy to be created.

1568

},

1569

"description": "A String", # An optional description of this cluster.

1570

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

1571

"state": "A String", # Denotes the state of etcd encryption.

1572

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

1573

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

1574

},

1575

"network": "A String", # The name of the Google Compute Engine

1576

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1577

# to which the cluster is connected. If left unspecified, the `default`

1578

# network will be used. On output this shows the network ID instead of the

1579

# name.

1580

"zone": "A String", # [Output only] The name of the Google Compute Engine

1581

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1582

# cluster resides. This field is deprecated, use location instead.

1583

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

1584

# required by Vertical Pod Autoscaler to automatically adjust

1585

# the resources of pods controlled by it.

1586

"enabled": True or False, # Enables vertical pod autoscaling.

1587

},

1588

"expireTime": "A String", # [Output only] The time the cluster will be automatically

1589

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1590

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

1591

# containers. This is provisioned from within the `container_ipv4_cidr`

1592

# range. This field will only be set when cluster is in route-based network

1593

# mode.

1594

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1605

1606

{ # This operation resource represents operations that may have happened or are

1607

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1608

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1609

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1610

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1611

"stages": [ # Substages of an operation or a stage.

1612

# Object with schema name: OperationProgress

1613

],

1614

"name": "A String", # A non-parameterized string describing an operation stage.

1615

# Unset for single-stage operations.

1616

"status": "A String", # Status of an operation stage.

1617

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1618

"metrics": [ # Progress metric bundle, for example:

1619

# metrics: [{name: "nodes done", int_value: 15},

1620

# {name: "nodes total", int_value: 32}]

1621

# or

1622

# metrics: [{name: "progress", double_value: 0.56},

1623

# {name: "progress scale", double_value: 1.0}]

1624

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1625

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1626

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1627

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1628

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1629

},

1630

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1631

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1632

"selfLink": "A String", # Server-defined URL for the resource.

1633

"location": "A String", # [Output only] The name of the Google Compute Engine

1634

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1635

# or

1636

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1637

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1638

"zone": "A String", # The name of the Google Compute Engine

1639

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1640

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1641

"endTime": "A String", # [Output only] The time the operation completed, in

1642

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1643

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1644

"name": "A String", # The server-assigned ID for the operation.

1645

"clusterConditions": [ # Which conditions caused the current cluster state.

1646

{ # StatusCondition describes why a cluster or a node pool has a certain status

1647

# (e.g., ERROR or DEGRADED).

1648

"code": "A String", # Machine-friendly representation of the condition

1649

"message": "A String", # Human-friendly representation of the condition

1650

},

1651

],

1652

"startTime": "A String", # [Output only] The time the operation started, in

1653

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1654

"detail": "A String", # Detailed operation progress, if available.

1655

"nodepoolConditions": [ # Which conditions caused the current node pool state.

1656

{ # StatusCondition describes why a cluster or a node pool has a certain status

1657

# (e.g., ERROR or DEGRADED).

1658

"code": "A String", # Machine-friendly representation of the condition

1659

"message": "A String", # Human-friendly representation of the condition

1660

},

1661

],

1662

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(projectId, zone, clusterId, name=None, x__xgafv=None)</code>

1668

<pre>Deletes the cluster, including the Kubernetes endpoint and all worker

1669

nodes.

1670

1671

Firewalls and routes that were configured during cluster creation

1672

are also deleted.

1673

1674

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]

1675

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]

1676

when the cluster was initially created.

1677

1678

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1679

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1680

number](https://support.google.com/cloud/answer/6158840).

1681

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1682

zone: string, Required. Deprecated. The name of the Google Compute Engine

1683

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1684

cluster resides. This field has been deprecated and replaced by the name

1685

field. (required)

1686

clusterId: string, Required. Deprecated. The name of the cluster to delete.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1687

This field has been deprecated and replaced by the name field. (required)

1688

name: string, The name (project, location, cluster) of the cluster to delete.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1689

Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1690

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1697

1698

{ # This operation resource represents operations that may have happened or are

1699

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1700

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1701

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1702

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1703

"stages": [ # Substages of an operation or a stage.

1704

# Object with schema name: OperationProgress

1705

],

1706

"name": "A String", # A non-parameterized string describing an operation stage.

1707

# Unset for single-stage operations.

1708

"status": "A String", # Status of an operation stage.

1709

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1710

"metrics": [ # Progress metric bundle, for example:

1711

# metrics: [{name: "nodes done", int_value: 15},

1712

# {name: "nodes total", int_value: 32}]

1713

# or

1714

# metrics: [{name: "progress", double_value: 0.56},

1715

# {name: "progress scale", double_value: 1.0}]

1716

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1717

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1718

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1719

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1720

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1721

},

1722

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1723

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1724

"selfLink": "A String", # Server-defined URL for the resource.

1725

"location": "A String", # [Output only] The name of the Google Compute Engine

1726

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1727

# or

1728

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1729

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1730

"zone": "A String", # The name of the Google Compute Engine

1731

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1732

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1733

"endTime": "A String", # [Output only] The time the operation completed, in

1734

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1735

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1736

"name": "A String", # The server-assigned ID for the operation.

1737

"clusterConditions": [ # Which conditions caused the current cluster state.

1738

{ # StatusCondition describes why a cluster or a node pool has a certain status

1739

# (e.g., ERROR or DEGRADED).

1740

"code": "A String", # Machine-friendly representation of the condition

1741

"message": "A String", # Human-friendly representation of the condition

1742

},

1743

],

1744

"startTime": "A String", # [Output only] The time the operation started, in

1745

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1746

"detail": "A String", # Detailed operation progress, if available.

1747

"nodepoolConditions": [ # Which conditions caused the current node pool state.

1748

{ # StatusCondition describes why a cluster or a node pool has a certain status

1749

# (e.g., ERROR or DEGRADED).

1750

"code": "A String", # Machine-friendly representation of the condition

1751

"message": "A String", # Human-friendly representation of the condition

1752

},

1753

],

1754

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(projectId, zone, clusterId, name=None, x__xgafv=None)</code>

1760

<pre>Gets the details for a specific cluster.

1761

1762

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1763

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1764

number](https://support.google.com/cloud/answer/6158840).

1765

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1766

zone: string, Required. Deprecated. The name of the Google Compute Engine

1767

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1768

cluster resides. This field has been deprecated and replaced by the name

1769

field. (required)

1770

clusterId: string, Required. Deprecated. The name of the cluster to retrieve.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1771

This field has been deprecated and replaced by the name field. (required)

1772

name: string, The name (project, location, cluster) of the cluster to retrieve.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1773

Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1774

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1781

1782

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1783

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

1784

# cluster, enabling additional functionality.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1785

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

1786

# extension to manage hosted GCP services through the Kubernetes API

1787

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1788

},

1789

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

1790

# enabled at cluster creation time.

1791

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

1792

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1793

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

1794

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1795

},

1796

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

1797

# is enabled or not on the Master, it does not track whether network policy

1798

# is enabled for the nodes.

1799

# is enabled or not on the Master, it does not track whether network policy

1800

# is enabled for the nodes.

1801

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1802

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1803

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

1804

# This addon is deprecated, and will be disabled in 1.15. It is recommended

1805

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

1806

# workloads and applications. For more information, see:

1807

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

1808

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1809

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1810

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

1811

# makes it easy to set up HTTP load balancers for services in a cluster.

1812

# which makes it easy to set up HTTP load balancers for services in a cluster.

1813

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

1814

# When enabled, it runs a small pod in the cluster that manages the load

1815

# balancers.

1816

},

1817

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

1818

# microservices.

1819

"disabled": True or False, # Whether Istio is enabled for this cluster.

1820

"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]

1821

},

1822

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

1823

# increases or decreases the number of replica pods a replication controller

1824

# has based on the resource usage of the existing pods.

1825

# increases or decreases the number of replica pods a replication controller

1826

# has based on the resource usage of the existing pods.

1827

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

1828

# When enabled, it ensures that metrics are collected into Stackdriver

1829

# Monitoring.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1830

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1831

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

1832

# enabled in order to enable Cloud Run addon. This option can only be enabled

1833

# at cluster creation time.

1834

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1835

},

1836

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

1837

# applications.

1838

"enabled": True or False, # Whether KALM is enabled for this cluster.

1839

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1840

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1841

"createTime": "A String", # [Output only] The time the cluster was created, in

1842

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1843

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

1844

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1845

# notation (e.g. `10.96.0.0/14`). Leave blank to have

1846

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

1847

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

1848

# mode.

1849

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

1850

# identities in the system, including service accounts, nodes, and

1851

# controllers, will have statically granted permissions beyond those

1852

# provided by the RBAC configuration or IAM.

1853

},

1854

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

1855

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

1856

# images will be validated by Google Binauthz.

1857

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1858

"currentNodeVersion": "A String", # [Output only] Deprecated, use

1859

# [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools)

1860

# instead. The current version of the node software components.

1861

# If they are currently at multiple versions because they're in the process

1862

# of being upgraded, this reflects the minimum version of all nodes.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1863

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

1864

# Call Kubernetes API directly to retrieve node information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1865

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1866

"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]

1867

# will be automatically chosen with the default size.

1868

#

1869

# This field is only applicable when `use_ip_aliases` is true.

1870

#

1871

# Set to blank to have a range chosen with the default size.

1872

#

1873

# 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)

1878

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1879

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1880

# to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1881

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1882

"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]

1883

# range will be automatically chosen with the default size.

1884

#

1885

# This field is only applicable when `use_ip_aliases` is true.

1886

#

1887

# If unspecified, the range will use the default size.

1888

#

1889

# 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)

1894

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1895

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1896

# to use.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1897

# This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1898

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

1899

# This is used in conjunction with use_routes. It cannot

1900

# be true if use_routes is true. If both use_ip_aliases and use_routes are

1901

# false, then the server picks the default IP allocation mode

1902

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1903

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

1904

#

1905

# This field is only applicable when `use_ip_aliases` is true.

1906

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

1907

# block. The secondary range will be used for pod IP

1908

# addresses. This must be an existing secondary range associated

1909

# with the cluster subnetwork.

1910

#

1911

# This field is only applicable with use_ip_aliases and

1912

# create_subnetwork is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1913

"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]

1914

# CIDR block. The secondary range will be used for service

1915

# ClusterIPs. This must be an existing secondary range associated

1916

# with the cluster subnetwork.

1917

#

1918

# This field is only applicable with use_ip_aliases and

1919

# create_subnetwork is false.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1920

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster.

1921

# This is used in conjunction with use_ip_aliases. It cannot be true if

1922

# use_ip_aliases is true. If both use_ip_aliases and use_routes are false,

1923

# then the server picks the default IP allocation mode

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1924

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

1925

# this field is empty, then an automatic name will be chosen for the new

1926

# subnetwork.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1927

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain

1928

# kinds of network routes. By default we do not allow cluster CIDR ranges to

1929

# intersect with any user declared routes. With allow_route_overlap == true,

1930

# we allow overlapping with CIDR ranges that are larger than the cluster CIDR

1931

# range.

1932

#

1933

# If this field is set to true, then cluster and services CIDRs must be

1934

# fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:

1935

# 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and

1936

# `services_ipv4_cidr_block` must be fully-specified.

1937

# 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be

1938

# fully-specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1939

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1940

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

1941

#

1942

# This is applicable only if `create_subnetwork` is true.

1943

#

1944

# Set to blank to have a range chosen with the default size.

1945

#

1946

# 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)

1951

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1952

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1953

# to use.

1954

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

1955

# `cluster.cluster_ipv4_cidr` must be left blank.

1956

#

1957

# This field is only applicable when `use_ip_aliases` is true.

1958

#

1959

# Set to blank to have a range chosen with the default size.

1960

#

1961

# 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)

1966

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1967

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1968

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1969

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1970

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

1971

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

1972

"provider": "A String", # The selected network policy provider.

1973

"enabled": True or False, # Whether network policy is enabled on the cluster.

1974

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1975

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

1976

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

1977

# given only RFC 1918 private addresses and communicate with the master via

1978

# private networking.

1979

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

1980

# range will be used for assigning internal IP addresses to the master or

1981

# set of masters, as well as the ILB VIP. This range must not overlap with

1982

# any other ranges in use within the cluster's network.

1983

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

1984

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

1985

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

1986

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

1987

"enabled": True or False, # Whenever master is accessible globally or not.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1988

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1989

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

1990

},

1991

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

1992

# This field is deprecated, use tpu_config.enabled instead.

1993

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

1994

# policies.

1995

# policies.

1996

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

1997

"identityProvider": "A String", # identity provider is the third party identity provider.

1998

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

1999

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2000

"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]

2001

# Currently available options:

2002

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2003

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2004

# service with a Kubernetes-native resource model

2005

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

2006

# longer available as of GKE 1.15).

2007

# * `none` - No metrics will be exported from the cluster.

2008

#

2009

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

2010

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2011

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

2012

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules

2013

# will be disabled when default_snat_status is disabled. When disabled is set

2014

# to false, default IP masquerade rules will be applied to the nodes to

2015

# prevent sNAT on cluster internal traffic.

2016

# be disabled on the cluster.

2017

"disabled": True or False, # Disables cluster default sNAT rules.

2018

},

2019

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

2020

# This makes same node pod to pod traffic visible for VPC network.

2021

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

2022

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

2023

# cluster is connected. Example:

2024

# projects/my-project/regions/us-central1/subnetworks/my-subnet

2025

"network": "A String", # Output only. The relative name of the Google Compute Engine

2026

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2027

# to which the cluster is connected. Example:

2028

# projects/my-project/global/networks/my-network

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2029

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2030

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

2031

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2032

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2033

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

2034

# If unspecified, the defaults are used:

2035

# For clusters before v1.12, if master_auth is unspecified, `username` will

2036

# be set to "admin", a random password will be generated, and a client

2037

# certificate will be issued.

2038

# Authentication can be done using HTTP basic auth or using client

2039

# certificates.

2040

"clusterCaCertificate": "A String",

2041

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

2042

# For clusters v1.6.0 and later, basic authentication can be disabled by

2043

# leaving username unspecified (or setting it to the empty string).

2044

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

2045

# authenticate to the cluster endpoint.

2046

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

2047

# Because the master endpoint is open to the Internet, you should create a

2048

# strong password. If a password is provided for cluster creation, username

2049

# must be non-empty.

2050

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

2051

# clusters before v1.12, if no configuration is specified, a client

2052

# certificate is issued.

2053

"issueClientCertificate": True or False, # Issue a client certificate.

2054

},

2055

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

2056

# to the cluster endpoint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2057

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2058

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

2059

# found in validMasterVersions returned by getServerConfig. The version can

2060

# be upgraded over time; such upgrades are reflected in

2061

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2062

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2063

# Users may specify either explicit versions offered by

2064

# Kubernetes Engine or version aliases, which have the following behavior:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2065

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2066

# - "latest": picks the highest valid Kubernetes version

2067

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

2068

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

2069

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

2070

# - "","-": picks the default Kubernetes version

2071

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by

2072

# default have no external IP addresses on the nodes and where nodes and the

2073

# master communicate over private IP addresses.

2074

# This field is deprecated, use private_cluster_config.enable_private_nodes

2075

# instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2076

"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]

2077

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2078

# "node_pool" object, since this configuration (along with the

2079

# "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]

2080

# auto-generated name. Do not use this and a node_pool at the same time.

2081

# For responses, this field will be populated with the node configuration of

2082

# the first node pool. (For configuration of each node pool, see

2083

# `node_pool.config`)

2084

#

2085

# If unspecified, the defaults are used.

2086

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2087

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2088

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2089

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2090

# The following scopes are recommended, but not required, and by default are

2091

# not included:

2092

#

2093

# * `https://www.googleapis.com/auth/compute` is required for mounting

2094

# persistent storage on your nodes.

2095

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2096

# communicating with **gcr.io**

2097

# (the [Google Container

2098

# Registry](https://cloud.google.com/container-registry/)).

2099

#

2100

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2101

# Monitoring are enabled, in which case their required scopes will be added.

2102

"A String",

2103

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2104

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2105

#

2106

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2107

# in length. These are reflected as part of a URL in the metadata server.

2108

# Additionally, to avoid ambiguity, keys must not conflict with any other

2109

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2115

# "enable-oslogin"

2116

# "gci-ensure-gke-docker"

2117

# "gci-metrics-enabled"

2118

# "gci-update-strategy"

2119

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2124

# "windows-startup-script-ps1"

2125

# "common-psm1"

2126

# "k8s-node-setup-psm1"

2127

# "install-ssh-psm1"

2128

# "user-profile-psm1"

2129

# "serial-port-logging-enable"

2130

# Values are free-form strings, and only have meaning as interpreted by

2131

# the image running in the instance. The only restriction placed on them is

2132

# that each value's size must be less than or equal to 32 KB.

2133

#

2134

# The total size of all keys and values must be less than 512 KB.

2135

"a_key": "A String",

2136

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2137

"machineType": "A String", # The name of a Google Compute Engine [machine

2138

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2139

# `n1-standard-1`).

2140

#

2141

# If unspecified, the default machine type is

2142

# `n1-standard-1`.

2143

"nodeGroup": "A String", # Setting this field will assign instances of this

2144

# pool to run on the specified node group. This is useful for running

2145

# workloads on [sole tenant

2146

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

2147

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2148

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2149

#

2150

# Secure Boot helps ensure that the system only runs authentic software by

2151

# verifying the digital signature of all boot components, and halting the

2152

# boot process if signature verification fails.

2153

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2154

#

2155

# Enables monitoring and attestation of the boot integrity of the instance.

2156

# The attestation is performed against the integrity policy baseline. This

2157

# baseline is initially derived from the implicitly trusted boot image when

2158

# the instance is created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2159

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2160

"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]

2161

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2162

# Account is specified, the "default" service account is used.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2163

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

2164

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running

2165

# on the nodes.

2166

#

2167

# The following parameters are supported.

2168

#

2169

# net.core.netdev_max_backlog

2170

# net.core.rmem_max

2171

# net.core.wmem_default

2172

# net.core.wmem_max

2173

# net.core.optmem_max

# net.core.somaxconn

# net.ipv4.tcp_rmem

# net.ipv4.tcp_wmem

# net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2182

"type": "A String", # Type of the sandbox to use for the node.

2183

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

2184

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2185

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2186

#

2187

# For more information, including usage and the valid values, see:

2188

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2189

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2190

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2191

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2192

# See

2193

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2194

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2195

"effect": "A String", # Effect for taint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2196

"key": "A String", # Key for taint.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2197

"value": "A String", # Value for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2198

},

2199

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2200

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

2201

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'.

2202

#

2203

# The string must be a sequence of decimal numbers, each with optional

2204

# fraction and a unit suffix, such as "300ms".

2205

# Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

2206

# The value must be a positive duration.

2207

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits.

2208

#

2209

# If this option is enabled, kubelet uses CFS quota

2210

# (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to

2211

# enforce container CPU limits. Otherwise, CPU limits will not be enforced at

2212

# all.

2213

#

2214

# Disable this option to mitigate CPU throttling problems while still having

2215

# your pods to be in Guaranteed QoS class by specifying the CPU limits.

2216

#

2217

# The default value is 'true' if unspecified.

2218

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node.

2219

# See

2220

# https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

2221

#

2222

# The following values are allowed.

2223

# - "none": the default, which represents the existing scheduling behavior.

2224

# - "static": allows pods with certain resource characteristics to be

2225

# granted increased CPU affinity and exclusivity on the node.

2226

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2227

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2228

# These will added in addition to any default label(s) that

2229

# Kubernetes may apply to the node.

2230

# In case of conflict in label keys, the applied set may differ depending on

2231

# the Kubernetes version -- it's best to assume the behavior is undefined

2232

# and conflicts should be avoided.

2233

# For more information, including usage and the valid values, see:

2234

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2235

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2236

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2237

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2238

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2239

# If unspecified, the default disk type is 'pd-standard'

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2240

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2241

# workloads on the node pool.

2242

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

2243

# workloads running on the node.

2244

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2245

# on the node pool.

2246

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2247

"bootDiskKmsKey": "A String", #

2248

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2249

# to each node in the node pool. This should be of the form

2250

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2251

# For more information about protecting resources with Cloud KMS Keys please

2252

# see:

2253

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2254

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2255

# The smallest allowed disk size is 10GB.

2256

#

2257

# If unspecified, the default disk size is 100GB.

2258

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2259

# the specified [Zonal Compute

2260

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2261

# to this node pool.

2262

# is the configuration of desired reservation which instances could take

2263

# capacity from.

2264

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2265

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2266

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2267

# the key and specify the name of your reservation as its value.

2268

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2269

"A String",

2270

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2271

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2272

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2273

# https://cloud.google.com/compute/docs/instances/preemptible for more

2274

# inforamtion about preemptible VM instances.

2275

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2276

# scheduled on the specified or newer CPU platform. Applicable values are the

2277

# friendly names of CPU platforms, such as

2278

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2279

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2280

# information, read [how to specify min CPU

2281

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2282

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

2283

# valid sources or targets for network firewalls and are specified by

2284

# the client during cluster or node pool creation. Each tag within the list

2285

# must comply with RFC1035.

2286

"A String",

2287

],

2288

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2289

# See https://cloud.google.com/compute/docs/gpus for more information about

2290

# support for GPUs.

2291

{ # AcceleratorConfig represents a Hardware Accelerator request.

2292

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2293

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2294

# [here](https://cloud.google.com/compute/docs/gpus)

2295

},

2296

],

2297

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

2298

#

2299

# The limit for this value is dependent upon the maximum number of

2300

# disks available on a machine per zone. See:

2301

# https://cloud.google.com/compute/docs/disks/local-ssd

2302

# for more information.

2303

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2304

# the latest version of it will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2305

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2306

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

2307

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

2308

# master authorized networks will disallow all external traffic to access

2309

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

2310

# Google Compute Engine Public IPs and Google Prod IPs.

2311

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

2312

# Kubernetes master through HTTPS.

2313

{ # CidrBlock contains an optional name and one CIDR block.

2314

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

2315

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

2316

},

2317

],

2318

"enabled": True or False, # Whether or not master authorized networks is enabled.

2319

},

2320

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

2321

# this cluster, in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2322

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2323

# notation (e.g. `1.2.3.4/29`). Service addresses are

2324

# typically put in the last `/16` from the container CIDR.

2325

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network.

2326

# This prefix will be used for assigning private IP addresses to the

2327

# master or set of masters, as well as the ILB VIP.

2328

# This field is deprecated, use

2329

# private_cluster_config.master_ipv4_cidr_block instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2330

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

2331

# required by Cluster Autoscaler to automatically adjust

2332

# the size of the cluster and create/delete

2333

# node pools based on the current needs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2334

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

2335

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

2336

# created by NAP.

2337

# by NAP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2338

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2339

# disruption caused by an upgrade.

2340

#

2341

# maxUnavailable controls the number of nodes that can be simultaneously

2342

# unavailable.

2343

#

2344

# maxSurge controls the number of additional nodes that can be added to the

2345

# node pool temporarily for the time of the upgrade to increase the number of

2346

# available nodes.

2347

#

2348

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2349

# nodes are being upgraded at the same time).

2350

#

2351

# Note: upgrades inevitably introduce some disruption since workloads need to

2352

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2353

# this holds true. (Disruption stays within the limits of

2354

# PodDisruptionBudget, if it is configured.)

2355

#

2356

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2357

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2358

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2359

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2360

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2361

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2362

# the upgrade process. A node is considered available if its status is

2363

# Ready.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2364

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2365

# of the node pool during the upgrade process.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2366

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2367

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

2368

# Specify the email address of the Service Account; otherwise, if no Service

2369

# Account is specified, the "default" service account is used.

2370

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2371

# node VMs under the "default" service account.

2372

#

2373

# The following scopes are recommended, but not required, and by default are

2374

# not included:

2375

#

2376

# * `https://www.googleapis.com/auth/compute` is required for mounting

2377

# persistent storage on your nodes.

2378

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2379

# communicating with **gcr.io**

2380

# (the [Google Container

2381

# Registry](https://cloud.google.com/container-registry/)).

2382

#

2383

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2384

# Monitoring are enabled, in which case their required scopes will be added.

2385

"A String",

2386

],

2387

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2388

# scheduled on the specified or newer CPU platform. Applicable values are the

2389

# friendly names of CPU platforms, such as

2390

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2391

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2392

# information, read [how to specify min CPU

2393

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2394

# To unset the min cpu platform field pass "automatic"

2395

# as field value.

2396

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

2397

# node pool.

2398

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

2399

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

2400

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2401

# the Auto Upgrades will proceed.

2402

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2403

# with the description of the upgrade.

2404

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2405

# with the approximate start time for the upgrades, in

2406

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2407

},

2408

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2409

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2410

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

2411

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

2412

# amount of resources in the cluster.

2413

{ # Contains information about amount of some resource in the cluster.

2414

# For memory, value should be in GB.

2415

"minimum": "A String", # Minimum amount of the resource in the cluster.

2416

"maximum": "A String", # Maximum amount of the resource in the cluster.

2417

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

2418

},

2419

],

2420

"autoprovisioningLocations": [ # The list of Google Compute Engine

2421

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2422

# NodePool's nodes can be created by NAP.

2423

"A String",

2424

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2425

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2426

"locations": [ # The list of Google Compute Engine

2427

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2428

# cluster's nodes should be located.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2429

"A String",

2430

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2431

"conditions": [ # Which conditions caused the current cluster state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2432

{ # StatusCondition describes why a cluster or a node pool has a certain status

2433

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2434

"code": "A String", # Machine-friendly representation of the condition

2435

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2436

},

2437

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2438

"loggingService": "A String", # The logging service the cluster should use to write logs.

2439

# Currently available options:

2440

#

2441

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

2442

# service with a Kubernetes-native resource model

2443

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

2444

# available as of GKE 1.15).

2445

# * `none` - no logs will be exported from the cluster.

2446

#

2447

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

2448

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

2449

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

2450

# API groups (e.g. v1beta1) and features that may not be production ready in

2451

# the kubernetes version of the master and nodes.

2452

# The cluster has no SLA for uptime and master/node upgrades are disabled.

2453

# Alpha enabled clusters are automatically deleted thirty days after

2454

# creation.

2455

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

2456

"A String",

2457

],

2458

"name": "A String", # The name of this cluster. The name must be unique within this project

2459

# and location (e.g. zone or region), and can be up to 40 characters with

2460

# the following restrictions:

2461

#

2462

# * Lowercase letters, numbers, and hyphens only.

2463

# * Must start with a letter.

2464

# * Must end with a number or a letter.

2465

"master": { # Master is the configuration for components on master. # Configuration for master components.

2466

},

2467

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

2468

# The endpoint can be accessed from the internet at

2469

# `https://username:password@endpoint/`.

2470

#

2471

# See the `masterAuth` property of this resource for username and

2472

# password information.

2473

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

2474

# disabled when this config unspecified.

2475

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

2476

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

2477

# second BigQuery table will be created to hold resource consumption

2478

# records.

2479

},

2480

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2481

"datasetId": "A String", # The ID of a BigQuery Dataset.

2482

},

2483

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

2484

# daemonset will be created in the cluster to meter network egress traffic.

2485

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2486

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2487

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2488

# or

2489

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2490

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2491

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

2492

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

2493

# if enabled = true.

2494

"enabled": True or False, # Whether this cluster should return group membership lookups

2495

# during authentication using a group of security groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2496

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2497

"subnetwork": "A String", # The name of the Google Compute Engine

2498

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

2499

# the cluster is connected. On output this shows the subnetwork ID instead of

2500

# the name.

2501

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

2502

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

2503

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for

2504

# maintenance to occur. The time windows may be overlapping. If no

2505

# maintenance windows are set, maintenance can occur at any time.

2506

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how

2507

# this window reccurs. They go on for the span of time between the start and

2508

# end time.

2509

#

2510

# For example, to have something repeat every weekday, you'd use:

2511

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

2512

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

2513

# <code>FREQ=DAILY</code>

2514

# For the first weekend of every month:

2515

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

2516

# This specifies how frequently the window starts. Eg, if you wanted to have

2517

# a 9-5 UTC-4 window every weekday, you'd use something like:

2518

# <code>

2519

# start time = 2019-01-01T09:00:00-0400

2520

# end time = 2019-01-01T17:00:00-0400

2521

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

2522

# </code>

2523

# Windows can span multiple days. Eg, to make the window encompass every

2524

# weekend from midnight Saturday till the last minute of Sunday UTC:

2525

# <code>

2526

# start time = 2019-01-05T00:00:00Z

2527

# end time = 2019-01-07T23:59:00Z

2528

# recurrence = FREQ=WEEKLY;BYDAY=SA

2529

# </code>

2530

# Note the start and end time's specific dates are largely arbitrary except

2531

# to specify duration of the window and when it first starts.

2532

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

2533

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

2534

"endTime": "A String", # The time that the window ends. The end time should take place after the

2535

# start time.

2536

"startTime": "A String", # The time that the window first starts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2537

},

2538

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2539

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

2540

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

2541

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

2542

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

2543

# smallest possible in the given scenario.

2544

},

2545

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

2546

# occur in these windows.

2547

"a_key": { # Represents an arbitrary window of time.

2548

"endTime": "A String", # The time that the window ends. The end time should take place after the

2549

# start time.

2550

"startTime": "A String", # The time that the window first starts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2551

},

2552

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2553

},

2554

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

2555

# the policy won't accidentally undo intermediate changes (and so that users

2556

# of the API unaware of some fields won't accidentally remove other fields).

2557

# Make a <code>get()</code> request to the cluster to get the current

2558

# resource version and include it with requests to set the policy.

2559

},

2560

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

2561

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

2562

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

2563

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

2564

},

2565

"nodePools": [ # The node pools associated with this cluster.

2566

# This field should not be set if "node_config" or "initial_node_count" are

2567

# specified.

2568

{ # NodePool contains the name and configuration for a cluster's node pool.

2569

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

2570

# specification, under the control of the cluster master. They may have a set

2571

# of Kubernetes labels applied to them, which may be used to reference them

2572

# during pod scheduling. They may also be resized up or down, to accommodate

2573

# the workload.

2574

"status": "A String", # [Output only] The status of the nodes in this pool instance.

2575

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

2576

# disruption caused by an upgrade.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2577

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2578

# maxUnavailable controls the number of nodes that can be simultaneously

2579

# unavailable.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2580

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2581

# maxSurge controls the number of additional nodes that can be added to the

2582

# node pool temporarily for the time of the upgrade to increase the number of

2583

# available nodes.

2584

#

2585

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2586

# nodes are being upgraded at the same time).

2587

#

2588

# Note: upgrades inevitably introduce some disruption since workloads need to

2589

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2590

# this holds true. (Disruption stays within the limits of

2591

# PodDisruptionBudget, if it is configured.)

2592

#

2593

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2594

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2595

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2596

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2597

# there are always at least 4 nodes available.

2598

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2599

# the upgrade process. A node is considered available if its status is

2600

# Ready.

2601

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2602

# of the node pool during the upgrade process.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2603

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2604

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

2605

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

2606

# associated with this node pool.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2607

"A String",

2608

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2609

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

2610

# only if a valid configuration is present.

2611

# adjust the size of the node pool to the current cluster usage.

2612

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2613

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

2614

# max_node_count.

2615

"enabled": True or False, # Is autoscaling enabled for this node pool.

2616

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

2617

# has to enough quota to scale up the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2618

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2619

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

2620

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

2621

# is sufficient for this number of instances. You must also have available

2622

# firewall and routes quota.

2623

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

2624

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2625

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2626

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2627

# The following scopes are recommended, but not required, and by default are

2628

# not included:

2629

#

2630

# * `https://www.googleapis.com/auth/compute` is required for mounting

2631

# persistent storage on your nodes.

2632

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2633

# communicating with **gcr.io**

2634

# (the [Google Container

2635

# Registry](https://cloud.google.com/container-registry/)).

2636

#

2637

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2638

# Monitoring are enabled, in which case their required scopes will be added.

2639

"A String",

2640

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2641

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2642

#

2643

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2644

# in length. These are reflected as part of a URL in the metadata server.

2645

# Additionally, to avoid ambiguity, keys must not conflict with any other

2646

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2652

# "enable-oslogin"

2653

# "gci-ensure-gke-docker"

2654

# "gci-metrics-enabled"

2655

# "gci-update-strategy"

2656

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2661

# "windows-startup-script-ps1"

2662

# "common-psm1"

2663

# "k8s-node-setup-psm1"

2664

# "install-ssh-psm1"

2665

# "user-profile-psm1"

2666

# "serial-port-logging-enable"

2667

# Values are free-form strings, and only have meaning as interpreted by

2668

# the image running in the instance. The only restriction placed on them is

2669

# that each value's size must be less than or equal to 32 KB.

2670

#

2671

# The total size of all keys and values must be less than 512 KB.

2672

"a_key": "A String",

2673

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2674

"machineType": "A String", # The name of a Google Compute Engine [machine

2675

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2676

# `n1-standard-1`).

2677

#

2678

# If unspecified, the default machine type is

2679

# `n1-standard-1`.

2680

"nodeGroup": "A String", # Setting this field will assign instances of this

2681

# pool to run on the specified node group. This is useful for running

2682

# workloads on [sole tenant

2683

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

2684

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2685

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2686

#

2687

# Secure Boot helps ensure that the system only runs authentic software by

2688

# verifying the digital signature of all boot components, and halting the

2689

# boot process if signature verification fails.

2690

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2691

#

2692

# Enables monitoring and attestation of the boot integrity of the instance.

2693

# The attestation is performed against the integrity policy baseline. This

2694

# baseline is initially derived from the implicitly trusted boot image when

2695

# the instance is created.

2696

},

2697

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

2698

# Specify the email address of the Service Account; otherwise, if no Service

2699

# Account is specified, the "default" service account is used.

2700

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

2701

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running

2702

# on the nodes.

2703

#

2704

# The following parameters are supported.

2705

#

2706

# net.core.netdev_max_backlog

2707

# net.core.rmem_max

2708

# net.core.wmem_default

2709

# net.core.wmem_max

2710

# net.core.optmem_max

# net.core.somaxconn

# net.ipv4.tcp_rmem

# net.ipv4.tcp_wmem

# net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2719

"type": "A String", # Type of the sandbox to use for the node.

2720

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

2721

},

2722

"taints": [ # List of kubernetes taints to be applied to each node.

2723

#

2724

# For more information, including usage and the valid values, see:

2725

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2726

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2727

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2728

#

2729

# See

2730

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2731

# for more information, including usage and the valid values.

2732

"effect": "A String", # Effect for taint.

2733

"key": "A String", # Key for taint.

2734

"value": "A String", # Value for taint.

2735

},

2736

],

2737

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

2738

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'.

2739

#

2740

# The string must be a sequence of decimal numbers, each with optional

2741

# fraction and a unit suffix, such as "300ms".

2742

# Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

2743

# The value must be a positive duration.

2744

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits.

2745

#

2746

# If this option is enabled, kubelet uses CFS quota

2747

# (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to

2748

# enforce container CPU limits. Otherwise, CPU limits will not be enforced at

2749

# all.

2750

#

2751

# Disable this option to mitigate CPU throttling problems while still having

2752

# your pods to be in Guaranteed QoS class by specifying the CPU limits.

2753

#

2754

# The default value is 'true' if unspecified.

2755

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node.

2756

# See

2757

# https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

2758

#

2759

# The following values are allowed.

2760

# - "none": the default, which represents the existing scheduling behavior.

2761

# - "static": allows pods with certain resource characteristics to be

2762

# granted increased CPU affinity and exclusivity on the node.

2763

},

2764

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2765

# These will added in addition to any default label(s) that

2766

# Kubernetes may apply to the node.

2767

# In case of conflict in label keys, the applied set may differ depending on

2768

# the Kubernetes version -- it's best to assume the behavior is undefined

2769

# and conflicts should be avoided.

2770

# For more information, including usage and the valid values, see:

2771

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2772

"a_key": "A String",

2773

},

2774

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2775

#

2776

# If unspecified, the default disk type is 'pd-standard'

2777

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2778

# workloads on the node pool.

2779

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

2780

# workloads running on the node.

2781

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2782

# on the node pool.

2783

},

2784

"bootDiskKmsKey": "A String", #

2785

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2786

# to each node in the node pool. This should be of the form

2787

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2788

# For more information about protecting resources with Cloud KMS Keys please

2789

# see:

2790

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

2791

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2792

# The smallest allowed disk size is 10GB.

2793

#

2794

# If unspecified, the default disk size is 100GB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2795

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2796

# the specified [Zonal Compute

2797

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2798

# to this node pool.

2799

# is the configuration of desired reservation which instances could take

2800

# capacity from.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2801

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2802

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2803

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2804

# the key and specify the name of your reservation as its value.

2805

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2806

"A String",

2807

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2808

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2809

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2810

# https://cloud.google.com/compute/docs/instances/preemptible for more

2811

# inforamtion about preemptible VM instances.

2812

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2813

# scheduled on the specified or newer CPU platform. Applicable values are the

2814

# friendly names of CPU platforms, such as

2815

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2816

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2817

# information, read [how to specify min CPU

2818

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2819

"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]

2820

# valid sources or targets for network firewalls and are specified by

2821

# the client during cluster or node pool creation. Each tag within the list

2822

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2823

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2824

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2825

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2826

# See https://cloud.google.com/compute/docs/gpus for more information about

2827

# support for GPUs.

2828

{ # AcceleratorConfig represents a Hardware Accelerator request.

2829

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2830

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2831

# [here](https://cloud.google.com/compute/docs/gpus)

2832

},

2833

],

2834

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

2835

#

2836

# The limit for this value is dependent upon the maximum number of

2837

# disks available on a machine per zone. See:

2838

# https://cloud.google.com/compute/docs/disks/local-ssd

2839

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2840

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2841

# the latest version of it will be used.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2842

},

2843

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2844

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

2845

# node pool.

2846

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

2847

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

2848

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2849

# the Auto Upgrades will proceed.

2850

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2851

# with the description of the upgrade.

2852

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2853

# with the approximate start time for the upgrades, in

2854

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2855

},

2856

},

2857

"name": "A String", # The name of the node pool.

2858

"version": "A String", # The version of the Kubernetes of this node.

2859

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

2860

# simultaneously on a node in the node pool.

2861

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2862

},

2863

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2864

# node pool instance, if available.

2865

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

2866

"conditions": [ # Which conditions caused the current node pool state.

2867

{ # StatusCondition describes why a cluster or a node pool has a certain status

2868

# (e.g., ERROR or DEGRADED).

2869

"code": "A String", # Machine-friendly representation of the condition

2870

"message": "A String", # Human-friendly representation of the condition

2871

},

2872

],

2873

"locations": [ # The list of Google Compute Engine

2874

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2875

# NodePool's nodes should be located.

"A String",

],

},

],

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2881

# cluster, if available.

2882

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

2883

# subscribed to. Release channels are arranged in order of risk.

2884

#

2885

# When a cluster is subscribed to a release channel, Google maintains

2886

# both the master version and the node version. Node auto-upgrade

2887

# defaults to true and cannot be disabled.

2888

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

2889

},

2890

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2891

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

2892

# simultaneously on a node in the node pool of this cluster. Only honored

2893

# if cluster created with IP Alias support.

2894

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2895

},

2896

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

2897

"type": "A String", # Type of the integration.

2898

},

2899

"status": "A String", # [Output only] The current status of this cluster.

2900

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

2901

# Google Compute Engine resources.

2902

"a_key": "A String",

2903

},

2904

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

2905

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2906

# notation (e.g. `1.2.3.4/29`).

2907

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

2908

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

2909

# is sufficient for this number of instances. You must also have available

2910

# firewall and routes quota.

2911

# For requests, this field should only be used in lieu of a

2912

# "node_pool" object, since this configuration (along with the

2913

# "node_config") will be used to create a "NodePool" object with an

2914

# auto-generated name. Do not use this and a node_pool at the same time.

2915

#

2916

# This field is deprecated, use node_pool.initial_node_count instead.

2917

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

2918

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

2919

# must be valid under a PodSecurityPolicy to be created.

2920

},

2921

"description": "A String", # An optional description of this cluster.

2922

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2923

"state": "A String", # Denotes the state of etcd encryption.

2924

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

2925

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

2926

},

2927

"network": "A String", # The name of the Google Compute Engine

2928

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2929

# to which the cluster is connected. If left unspecified, the `default`

2930

# network will be used. On output this shows the network ID instead of the

2931

# name.

2932

"zone": "A String", # [Output only] The name of the Google Compute Engine

2933

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2934

# cluster resides. This field is deprecated, use location instead.

2935

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

2936

# required by Vertical Pod Autoscaler to automatically adjust

2937

# the resources of pods controlled by it.

2938

"enabled": True or False, # Enables vertical pod autoscaling.

2939

},

2940

"expireTime": "A String", # [Output only] The time the cluster will be automatically

2941

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2942

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

2943

# containers. This is provisioned from within the `container_ipv4_cidr`

2944

# range. This field will only be set when cluster is in route-based network

2945

# mode.

2946

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

}</pre>

</div>

<code class="details" id="legacyAbac">legacyAbac(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

2952

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

2953

2954

Args:

2955

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

2956

number](https://support.google.com/cloud/answer/6158840).

2957

This field has been deprecated and replaced by the name field. (required)

2958

zone: string, Required. Deprecated. The name of the Google Compute Engine

2959

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

2960

cluster resides. This field has been deprecated and replaced by the name

2961

field. (required)

2962

clusterId: string, Required. Deprecated. The name of the cluster to update.

2963

This field has been deprecated and replaced by the name field. (required)

2964

body: object, The request body.

2965

The object takes the form of:

2966

2967

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for

2968

# a cluster.

2969

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

2970

# number](https://support.google.com/cloud/answer/6158840).

2971

# This field has been deprecated and replaced by the name field.

2972

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

2973

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2974

# cluster resides. This field has been deprecated and replaced by the name

2975

# field.

2976

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

2977

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac.

2978

# Specified in the format `projects/*/locations/*/clusters/*`.

2979

"clusterId": "A String", # Required. Deprecated. The name of the cluster to update.

2980

# This field has been deprecated and replaced by the name field.

2981

}

2982

2983

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2990

2991

{ # This operation resource represents operations that may have happened or are

2992

# happening on the cluster. All fields are output only.

2993

"targetLink": "A String", # Server-defined URL for the target of the operation.

2994

"operationType": "A String", # The operation type.

2995

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2996

"stages": [ # Substages of an operation or a stage.

2997

# Object with schema name: OperationProgress

2998

],

2999

"name": "A String", # A non-parameterized string describing an operation stage.

3000

# Unset for single-stage operations.

3001

"status": "A String", # Status of an operation stage.

3002

# Unset for single-stage operations.

3003

"metrics": [ # Progress metric bundle, for example:

3004

# metrics: [{name: "nodes done", int_value: 15},

3005

# {name: "nodes total", int_value: 32}]

3006

# or

3007

# metrics: [{name: "progress", double_value: 0.56},

3008

# {name: "progress scale", double_value: 1.0}]

3009

{ # Progress metric is (string, int|float|string) pair.

3010

"doubleValue": 3.14, # For metrics with floating point value.

3011

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3012

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3013

"intValue": "A String", # For metrics with integer value.

},

],

},

"selfLink": "A String", # Server-defined URL for the resource.

3018

"location": "A String", # [Output only] The name of the Google Compute Engine

3019

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3020

# or

3021

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3022

# in which the cluster resides.

3023

"zone": "A String", # The name of the Google Compute Engine

3024

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3025

# operation is taking place. This field is deprecated, use location instead.

3026

"endTime": "A String", # [Output only] The time the operation completed, in

3027

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3028

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3029

"name": "A String", # The server-assigned ID for the operation.

3030

"clusterConditions": [ # Which conditions caused the current cluster state.

3031

{ # StatusCondition describes why a cluster or a node pool has a certain status

3032

# (e.g., ERROR or DEGRADED).

3033

"code": "A String", # Machine-friendly representation of the condition

3034

"message": "A String", # Human-friendly representation of the condition

3035

},

3036

],

3037

"startTime": "A String", # [Output only] The time the operation started, in

3038

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3039

"detail": "A String", # Detailed operation progress, if available.

3040

"nodepoolConditions": [ # Which conditions caused the current node pool state.

3041

{ # StatusCondition describes why a cluster or a node pool has a certain status

3042

# (e.g., ERROR or DEGRADED).

3043

"code": "A String", # Machine-friendly representation of the condition

3044

"message": "A String", # Human-friendly representation of the condition

3045

},

3046

],

3047

"status": "A String", # The current status of the operation.

}</pre>

</div>

<code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code>

3053

<pre>Lists all clusters owned by a project in either the specified zone or all

zones.

Args:

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

3058

number](https://support.google.com/cloud/answer/6158840).

3059

This field has been deprecated and replaced by the parent field. (required)

3060

zone: string, Required. Deprecated. The name of the Google Compute Engine

3061

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

3062

cluster resides, or "-" for all zones. This field has been deprecated and

3063

replaced by the parent field. (required)

3064

parent: string, The parent (project and location) where the clusters will be listed.

3065

Specified in the format `projects/*/locations/*`.

3066

Location "-" matches all zones and all regions.

3067

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3074

3075

{ # ListClustersResponse is the result of ListClustersRequest.

3076

"missingZones": [ # If any zones are listed here, the list of clusters returned

3077

# may be missing those zones.

3078

"A String",

3079

],

3080

"clusters": [ # A list of clusters in the project in the specified zone, or

3081

# across all ones.

3082

{ # A Google Kubernetes Engine cluster.

3083

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

3084

# cluster, enabling additional functionality.

3085

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

3086

# extension to manage hosted GCP services through the Kubernetes API

3087

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

3088

},

3089

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

3090

# enabled at cluster creation time.

3091

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

3092

},

3093

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

3094

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

3095

},

3096

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

3097

# is enabled or not on the Master, it does not track whether network policy

3098

# is enabled for the nodes.

3099

# is enabled or not on the Master, it does not track whether network policy

3100

# is enabled for the nodes.

3101

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

3102

},

3103

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

3104

# This addon is deprecated, and will be disabled in 1.15. It is recommended

3105

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

3106

# workloads and applications. For more information, see:

3107

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

3108

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

3109

},

3110

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

3111

# makes it easy to set up HTTP load balancers for services in a cluster.

3112

# which makes it easy to set up HTTP load balancers for services in a cluster.

3113

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

3114

# When enabled, it runs a small pod in the cluster that manages the load

3115

# balancers.

3116

},

3117

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

3118

# microservices.

3119

"disabled": True or False, # Whether Istio is enabled for this cluster.

3120

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

3121

},

3122

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

3123

# increases or decreases the number of replica pods a replication controller

3124

# has based on the resource usage of the existing pods.

3125

# increases or decreases the number of replica pods a replication controller

3126

# has based on the resource usage of the existing pods.

3127

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

3128

# When enabled, it ensures that metrics are collected into Stackdriver

3129

# Monitoring.

3130

},

3131

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

3132

# enabled in order to enable Cloud Run addon. This option can only be enabled

3133

# at cluster creation time.

3134

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

3135

},

3136

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

3137

# applications.

3138

"enabled": True or False, # Whether KALM is enabled for this cluster.

3139

},

3140

},

3141

"createTime": "A String", # [Output only] The time the cluster was created, in

3142

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3143

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

3144

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3145

# notation (e.g. `10.96.0.0/14`). Leave blank to have

3146

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

3147

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

3148

# mode.

3149

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

3150

# identities in the system, including service accounts, nodes, and

3151

# controllers, will have statically granted permissions beyond those

3152

# provided by the RBAC configuration or IAM.

3153

},

3154

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

3155

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

3156

# images will be validated by Google Binauthz.

3157

},

3158

"currentNodeVersion": "A String", # [Output only] Deprecated, use

3159

# [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools)

3160

# instead. The current version of the node software components.

3161

# If they are currently at multiple versions because they're in the process

3162

# of being upgraded, this reflects the minimum version of all nodes.

3163

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

3164

# Call Kubernetes API directly to retrieve node information.

3165

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

3166

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range

3167

# will be automatically chosen with the default size.

3168

#

3169

# This field is only applicable when `use_ip_aliases` is true.

3170

#

3171

# Set to blank to have a range chosen with the default size.

3172

#

3173

# 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)

3178

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3179

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3180

# to use.

3181

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

3182

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a

3183

# range will be automatically chosen with the default size.

3184

#

3185

# This field is only applicable when `use_ip_aliases` is true.

3186

#

3187

# If unspecified, the range will use the default size.

3188

#

3189

# 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)

3194

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3195

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3196

# to use.

3197

# This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

3198

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

3199

# This is used in conjunction with use_routes. It cannot

3200

# be true if use_routes is true. If both use_ip_aliases and use_routes are

3201

# false, then the server picks the default IP allocation mode

3202

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

3203

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

3204

#

3205

# This field is only applicable when `use_ip_aliases` is true.

3206

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

3207

# block. The secondary range will be used for pod IP

3208

# addresses. This must be an existing secondary range associated

3209

# with the cluster subnetwork.

3210

#

3211

# This field is only applicable with use_ip_aliases and

3212

# create_subnetwork is false.

3213

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services

3214

# CIDR block. The secondary range will be used for service

3215

# ClusterIPs. This must be an existing secondary range associated

3216

# with the cluster subnetwork.

3217

#

3218

# This field is only applicable with use_ip_aliases and

3219

# create_subnetwork is false.

3220

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster.

3221

# This is used in conjunction with use_ip_aliases. It cannot be true if

3222

# use_ip_aliases is true. If both use_ip_aliases and use_routes are false,

3223

# then the server picks the default IP allocation mode

3224

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

3225

# this field is empty, then an automatic name will be chosen for the new

3226

# subnetwork.

3227

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain

3228

# kinds of network routes. By default we do not allow cluster CIDR ranges to

3229

# intersect with any user declared routes. With allow_route_overlap == true,

3230

# we allow overlapping with CIDR ranges that are larger than the cluster CIDR

3231

# range.

3232

#

3233

# If this field is set to true, then cluster and services CIDRs must be

3234

# fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:

3235

# 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and

3236

# `services_ipv4_cidr_block` must be fully-specified.

3237

# 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be

3238

# fully-specified.

3239

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

3240

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

3241

#

3242

# This is applicable only if `create_subnetwork` is true.

3243

#

3244

# Set to blank to have a range chosen with the default size.

3245

#

3246

# 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)

3251

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3252

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3253

# to use.

3254

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

3255

# `cluster.cluster_ipv4_cidr` must be left blank.

3256

#

3257

# This field is only applicable when `use_ip_aliases` is true.

3258

#

3259

# Set to blank to have a range chosen with the default size.

3260

#

3261

# 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)

3266

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3267

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3268

# to use.

3269

},

3270

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

3271

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

3272

"provider": "A String", # The selected network policy provider.

3273

"enabled": True or False, # Whether network policy is enabled on the cluster.

3274

},

3275

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

3276

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

3277

# given only RFC 1918 private addresses and communicate with the master via

3278

# private networking.

3279

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

3280

# range will be used for assigning internal IP addresses to the master or

3281

# set of masters, as well as the ILB VIP. This range must not overlap with

3282

# any other ranges in use within the cluster's network.

3283

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

3284

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

3285

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

3286

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

3287

"enabled": True or False, # Whenever master is accessible globally or not.

3288

},

3289

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

3290

},

3291

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

3292

# This field is deprecated, use tpu_config.enabled instead.

3293

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

3294

# policies.

3295

# policies.

3296

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

3297

"identityProvider": "A String", # identity provider is the third party identity provider.

3298

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

3299

},

3300

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

3301

# Currently available options:

3302

#

3303

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

3304

# service with a Kubernetes-native resource model

3305

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

3306

# longer available as of GKE 1.15).

3307

# * `none` - No metrics will be exported from the cluster.

3308

#

3309

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

3310

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

3311

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

3312

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules

3313

# will be disabled when default_snat_status is disabled. When disabled is set

3314

# to false, default IP masquerade rules will be applied to the nodes to

3315

# prevent sNAT on cluster internal traffic.

3316

# be disabled on the cluster.

3317

"disabled": True or False, # Disables cluster default sNAT rules.

3318

},

3319

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

3320

# This makes same node pod to pod traffic visible for VPC network.

3321

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

3322

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

3323

# cluster is connected. Example:

3324

# projects/my-project/regions/us-central1/subnetworks/my-subnet

3325

"network": "A String", # Output only. The relative name of the Google Compute Engine

3326

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

3327

# to which the cluster is connected. Example:

3328

# projects/my-project/global/networks/my-network

3329

},

3330

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

3331

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

3332

},

3333

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

3334

# If unspecified, the defaults are used:

3335

# For clusters before v1.12, if master_auth is unspecified, `username` will

3336

# be set to "admin", a random password will be generated, and a client

3337

# certificate will be issued.

3338

# Authentication can be done using HTTP basic auth or using client

3339

# certificates.

3340

"clusterCaCertificate": "A String",

3341

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

3342

# For clusters v1.6.0 and later, basic authentication can be disabled by

3343

# leaving username unspecified (or setting it to the empty string).

3344

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

3345

# authenticate to the cluster endpoint.

3346

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

3347

# Because the master endpoint is open to the Internet, you should create a

3348

# strong password. If a password is provided for cluster creation, username

3349

# must be non-empty.

3350

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

3351

# clusters before v1.12, if no configuration is specified, a client

3352

# certificate is issued.

3353

"issueClientCertificate": True or False, # Issue a client certificate.

3354

},

3355

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

3356

# to the cluster endpoint.

3357

},

3358

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

3359

# found in validMasterVersions returned by getServerConfig. The version can

3360

# be upgraded over time; such upgrades are reflected in

3361

# currentMasterVersion and currentNodeVersion.

3362

#

3363

# Users may specify either explicit versions offered by

3364

# Kubernetes Engine or version aliases, which have the following behavior:

3365

#

3366

# - "latest": picks the highest valid Kubernetes version

3367

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

3368

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

3369

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

3370

# - "","-": picks the default Kubernetes version

3371

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by

3372

# default have no external IP addresses on the nodes and where nodes and the

3373

# master communicate over private IP addresses.

3374

# This field is deprecated, use private_cluster_config.enable_private_nodes

3375

# instead.

3376

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

3377

# For requests, this field should only be used in lieu of a

3378

# "node_pool" object, since this configuration (along with the

3379

# "initial_node_count") will be used to create a "NodePool" object with an

3380

# auto-generated name. Do not use this and a node_pool at the same time.

3381

# For responses, this field will be populated with the node configuration of

3382

# the first node pool. (For configuration of each node pool, see

3383

# `node_pool.config`)

3384

#

3385

# If unspecified, the defaults are used.

3386

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3387

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3388

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3389

#

3390

# The following scopes are recommended, but not required, and by default are

3391

# not included:

3392

#

3393

# * `https://www.googleapis.com/auth/compute` is required for mounting

3394

# persistent storage on your nodes.

3395

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3396

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3397

# (the [Google Container

3398

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3399

#

3400

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3401

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3402

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3403

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3404

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3405

#

3406

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3407

# in length. These are reflected as part of a URL in the metadata server.

3408

# Additionally, to avoid ambiguity, keys must not conflict with any other

3409

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3415

# "enable-oslogin"

3416

# "gci-ensure-gke-docker"

3417

# "gci-metrics-enabled"

3418

# "gci-update-strategy"

3419

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3424

# "windows-startup-script-ps1"

3425

# "common-psm1"

3426

# "k8s-node-setup-psm1"

3427

# "install-ssh-psm1"

3428

# "user-profile-psm1"

3429

# "serial-port-logging-enable"

3430

# Values are free-form strings, and only have meaning as interpreted by

3431

# the image running in the instance. The only restriction placed on them is

3432

# that each value's size must be less than or equal to 32 KB.

3433

#

3434

# The total size of all keys and values must be less than 512 KB.

3435

"a_key": "A String",

3436

},

3437

"machineType": "A String", # The name of a Google Compute Engine [machine

3438

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3439

# `n1-standard-1`).

3440

#

3441

# If unspecified, the default machine type is

3442

# `n1-standard-1`.

3443

"nodeGroup": "A String", # Setting this field will assign instances of this

3444

# pool to run on the specified node group. This is useful for running

3445

# workloads on [sole tenant

3446

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

3447

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3448

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3449

#

3450

# Secure Boot helps ensure that the system only runs authentic software by

3451

# verifying the digital signature of all boot components, and halting the

3452

# boot process if signature verification fails.

3453

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3454

#

3455

# Enables monitoring and attestation of the boot integrity of the instance.

3456

# The attestation is performed against the integrity policy baseline. This

3457

# baseline is initially derived from the implicitly trusted boot image when

3458

# the instance is created.

3459

},

3460

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

3461

# Specify the email address of the Service Account; otherwise, if no Service

3462

# Account is specified, the "default" service account is used.

3463

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

3464

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running

3465

# on the nodes.

3466

#

3467

# The following parameters are supported.

3468

#

3469

# net.core.netdev_max_backlog

3470

# net.core.rmem_max

3471

# net.core.wmem_default

3472

# net.core.wmem_max

3473

# net.core.optmem_max

# net.core.somaxconn

# net.ipv4.tcp_rmem

# net.ipv4.tcp_wmem

# net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3482

"type": "A String", # Type of the sandbox to use for the node.

3483

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

3484

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3485

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3486

#

3487

# For more information, including usage and the valid values, see:

3488

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3489

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3490

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3491

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3492

# See

3493

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3494

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3495

"effect": "A String", # Effect for taint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3496

"key": "A String", # Key for taint.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3497

"value": "A String", # Value for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3498

},

3499

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3500

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

3501

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'.

3502

#

3503

# The string must be a sequence of decimal numbers, each with optional

3504

# fraction and a unit suffix, such as "300ms".

3505

# Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

3506

# The value must be a positive duration.

3507

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits.

3508

#

3509

# If this option is enabled, kubelet uses CFS quota

3510

# (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to

3511

# enforce container CPU limits. Otherwise, CPU limits will not be enforced at

3512

# all.

3513

#

3514

# Disable this option to mitigate CPU throttling problems while still having

3515

# your pods to be in Guaranteed QoS class by specifying the CPU limits.

3516

#

3517

# The default value is 'true' if unspecified.

3518

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node.

3519

# See

3520

# https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

3521

#

3522

# The following values are allowed.

3523

# - "none": the default, which represents the existing scheduling behavior.

3524

# - "static": allows pods with certain resource characteristics to be

3525

# granted increased CPU affinity and exclusivity on the node.

3526

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3527

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3528

# These will added in addition to any default label(s) that

3529

# Kubernetes may apply to the node.

3530

# In case of conflict in label keys, the applied set may differ depending on

3531

# the Kubernetes version -- it's best to assume the behavior is undefined

3532

# and conflicts should be avoided.

3533

# For more information, including usage and the valid values, see:

3534

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3535

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3536

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3537

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3538

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3539

# If unspecified, the default disk type is 'pd-standard'

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3540

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3541

# workloads on the node pool.

3542

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

3543

# workloads running on the node.

3544

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3545

# on the node pool.

3546

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3547

"bootDiskKmsKey": "A String", #

3548

# The Customer Managed Encryption Key used to encrypt the boot disk attached

3549

# to each node in the node pool. This should be of the form

3550

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

3551

# For more information about protecting resources with Cloud KMS Keys please

3552

# see:

3553

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3554

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3555

# The smallest allowed disk size is 10GB.

3556

#

3557

# If unspecified, the default disk size is 100GB.

3558

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3559

# the specified [Zonal Compute

3560

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3561

# to this node pool.

3562

# is the configuration of desired reservation which instances could take

3563

# capacity from.

3564

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3565

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3566

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3567

# the key and specify the name of your reservation as its value.

3568

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3569

"A String",

3570

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3571

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3572

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3573

# https://cloud.google.com/compute/docs/instances/preemptible for more

3574

# inforamtion about preemptible VM instances.

3575

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3576

# scheduled on the specified or newer CPU platform. Applicable values are the

3577

# friendly names of CPU platforms, such as

3578

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3579

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3580

# information, read [how to specify min CPU

3581

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3582

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

3583

# valid sources or targets for network firewalls and are specified by

3584

# the client during cluster or node pool creation. Each tag within the list

3585

# must comply with RFC1035.

3586

"A String",

3587

],

3588

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3589

# See https://cloud.google.com/compute/docs/gpus for more information about

3590

# support for GPUs.

3591

{ # AcceleratorConfig represents a Hardware Accelerator request.

3592

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3593

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3594

# [here](https://cloud.google.com/compute/docs/gpus)

3595

},

3596

],

3597

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

3598

#

3599

# The limit for this value is dependent upon the maximum number of

3600

# disks available on a machine per zone. See:

3601

# https://cloud.google.com/compute/docs/disks/local-ssd

3602

# for more information.

3603

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3604

# the latest version of it will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3605

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3606

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

3607

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

3608

# master authorized networks will disallow all external traffic to access

3609

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

3610

# Google Compute Engine Public IPs and Google Prod IPs.

3611

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

3612

# Kubernetes master through HTTPS.

3613

{ # CidrBlock contains an optional name and one CIDR block.

3614

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

3615

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

3616

},

3617

],

3618

"enabled": True or False, # Whether or not master authorized networks is enabled.

3619

},

3620

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

3621

# this cluster, in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3622

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3623

# notation (e.g. `1.2.3.4/29`). Service addresses are

3624

# typically put in the last `/16` from the container CIDR.

3625

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network.

3626

# This prefix will be used for assigning private IP addresses to the

3627

# master or set of masters, as well as the ILB VIP.

3628

# This field is deprecated, use

3629

# private_cluster_config.master_ipv4_cidr_block instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3630

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

3631

# required by Cluster Autoscaler to automatically adjust

3632

# the size of the cluster and create/delete

3633

# node pools based on the current needs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3634

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

3635

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

3636

# created by NAP.

3637

# by NAP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3638

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3639

# disruption caused by an upgrade.

3640

#

3641

# maxUnavailable controls the number of nodes that can be simultaneously

3642

# unavailable.

3643

#

3644

# maxSurge controls the number of additional nodes that can be added to the

3645

# node pool temporarily for the time of the upgrade to increase the number of

3646

# available nodes.

3647

#

3648

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3649

# nodes are being upgraded at the same time).

3650

#

3651

# Note: upgrades inevitably introduce some disruption since workloads need to

3652

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3653

# this holds true. (Disruption stays within the limits of

3654

# PodDisruptionBudget, if it is configured.)

3655

#

3656

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3657

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3658

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3659

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3660

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3661

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3662

# the upgrade process. A node is considered available if its status is

3663

# Ready.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3664

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3665

# of the node pool during the upgrade process.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3666

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3667

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

3668

# Specify the email address of the Service Account; otherwise, if no Service

3669

# Account is specified, the "default" service account is used.

3670

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3671

# node VMs under the "default" service account.

3672

#

3673

# The following scopes are recommended, but not required, and by default are

3674

# not included:

3675

#

3676

# * `https://www.googleapis.com/auth/compute` is required for mounting

3677

# persistent storage on your nodes.

3678

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3679

# communicating with **gcr.io**

3680

# (the [Google Container

3681

# Registry](https://cloud.google.com/container-registry/)).

3682

#

3683

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3684

# Monitoring are enabled, in which case their required scopes will be added.

3685

"A String",

3686

],

3687

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3688

# scheduled on the specified or newer CPU platform. Applicable values are the

3689

# friendly names of CPU platforms, such as

3690

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3691

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3692

# information, read [how to specify min CPU

3693

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3694

# To unset the min cpu platform field pass "automatic"

3695

# as field value.

3696

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

3697

# node pool.

3698

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

3699

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

3700

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3701

# the Auto Upgrades will proceed.

3702

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3703

# with the description of the upgrade.

3704

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3705

# with the approximate start time for the upgrades, in

3706

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3707

},

3708

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3709

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3710

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

3711

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

3712

# amount of resources in the cluster.

3713

{ # Contains information about amount of some resource in the cluster.

3714

# For memory, value should be in GB.

3715

"minimum": "A String", # Minimum amount of the resource in the cluster.

3716

"maximum": "A String", # Maximum amount of the resource in the cluster.

3717

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

3718

},

3719

],

3720

"autoprovisioningLocations": [ # The list of Google Compute Engine

3721

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3722

# NodePool's nodes can be created by NAP.

3723

"A String",

3724

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3725

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3726

"locations": [ # The list of Google Compute Engine

3727

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3728

# cluster's nodes should be located.

3729

"A String",

3730

],

3731

"conditions": [ # Which conditions caused the current cluster state.

3732

{ # StatusCondition describes why a cluster or a node pool has a certain status

3733

# (e.g., ERROR or DEGRADED).

3734

"code": "A String", # Machine-friendly representation of the condition

3735

"message": "A String", # Human-friendly representation of the condition

3736

},

3737

],

3738

"loggingService": "A String", # The logging service the cluster should use to write logs.

3739

# Currently available options:

3740

#

3741

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

3742

# service with a Kubernetes-native resource model

3743

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

3744

# available as of GKE 1.15).

3745

# * `none` - no logs will be exported from the cluster.

3746

#

3747

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

3748

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

3749

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

3750

# API groups (e.g. v1beta1) and features that may not be production ready in

3751

# the kubernetes version of the master and nodes.

3752

# The cluster has no SLA for uptime and master/node upgrades are disabled.

3753

# Alpha enabled clusters are automatically deleted thirty days after

3754

# creation.

3755

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

3756

"A String",

3757

],

3758

"name": "A String", # The name of this cluster. The name must be unique within this project

3759

# and location (e.g. zone or region), and can be up to 40 characters with

3760

# the following restrictions:

3761

#

3762

# * Lowercase letters, numbers, and hyphens only.

3763

# * Must start with a letter.

3764

# * Must end with a number or a letter.

3765

"master": { # Master is the configuration for components on master. # Configuration for master components.

3766

},

3767

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

3768

# The endpoint can be accessed from the internet at

3769

# `https://username:password@endpoint/`.

3770

#

3771

# See the `masterAuth` property of this resource for username and

3772

# password information.

3773

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

3774

# disabled when this config unspecified.

3775

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

3776

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

3777

# second BigQuery table will be created to hold resource consumption

3778

# records.

3779

},

3780

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

3781

"datasetId": "A String", # The ID of a BigQuery Dataset.

3782

},

3783

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

3784

# daemonset will be created in the cluster to meter network egress traffic.

3785

},

3786

"location": "A String", # [Output only] The name of the Google Compute Engine

3787

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3788

# or

3789

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3790

# in which the cluster resides.

3791

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

3792

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

3793

# if enabled = true.

3794

"enabled": True or False, # Whether this cluster should return group membership lookups

3795

# during authentication using a group of security groups.

3796

},

3797

"subnetwork": "A String", # The name of the Google Compute Engine

3798

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

3799

# the cluster is connected. On output this shows the subnetwork ID instead of

3800

# the name.

3801

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

3802

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

3803

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for

3804

# maintenance to occur. The time windows may be overlapping. If no

3805

# maintenance windows are set, maintenance can occur at any time.

3806

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how

3807

# this window reccurs. They go on for the span of time between the start and

3808

# end time.

3809

#

3810

# For example, to have something repeat every weekday, you'd use:

3811

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

3812

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

3813

# <code>FREQ=DAILY</code>

3814

# For the first weekend of every month:

3815

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

3816

# This specifies how frequently the window starts. Eg, if you wanted to have

3817

# a 9-5 UTC-4 window every weekday, you'd use something like:

3818

# <code>

3819

# start time = 2019-01-01T09:00:00-0400

3820

# end time = 2019-01-01T17:00:00-0400

3821

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

3822

# </code>

3823

# Windows can span multiple days. Eg, to make the window encompass every

3824

# weekend from midnight Saturday till the last minute of Sunday UTC:

3825

# <code>

3826

# start time = 2019-01-05T00:00:00Z

3827

# end time = 2019-01-07T23:59:00Z

3828

# recurrence = FREQ=WEEKLY;BYDAY=SA

3829

# </code>

3830

# Note the start and end time's specific dates are largely arbitrary except

3831

# to specify duration of the window and when it first starts.

3832

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

3833

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

3834

"endTime": "A String", # The time that the window ends. The end time should take place after the

3835

# start time.

3836

"startTime": "A String", # The time that the window first starts.

3837

},

3838

},

3839

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

3840

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

3841

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

3842

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

3843

# smallest possible in the given scenario.

3844

},

3845

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

3846

# occur in these windows.

3847

"a_key": { # Represents an arbitrary window of time.

3848

"endTime": "A String", # The time that the window ends. The end time should take place after the

3849

# start time.

3850

"startTime": "A String", # The time that the window first starts.

},

},

},

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

3855

# the policy won't accidentally undo intermediate changes (and so that users

3856

# of the API unaware of some fields won't accidentally remove other fields).

3857

# Make a <code>get()</code> request to the cluster to get the current

3858

# resource version and include it with requests to set the policy.

3859

},

3860

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

3861

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

3862

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

3863

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

3864

},

3865

"nodePools": [ # The node pools associated with this cluster.

3866

# This field should not be set if "node_config" or "initial_node_count" are

3867

# specified.

3868

{ # NodePool contains the name and configuration for a cluster's node pool.

3869

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

3870

# specification, under the control of the cluster master. They may have a set

3871

# of Kubernetes labels applied to them, which may be used to reference them

3872

# during pod scheduling. They may also be resized up or down, to accommodate

3873

# the workload.

3874

"status": "A String", # [Output only] The status of the nodes in this pool instance.

3875

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

3876

# disruption caused by an upgrade.

3877

#

3878

# maxUnavailable controls the number of nodes that can be simultaneously

3879

# unavailable.

3880

#

3881

# maxSurge controls the number of additional nodes that can be added to the

3882

# node pool temporarily for the time of the upgrade to increase the number of

3883

# available nodes.

3884

#

3885

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3886

# nodes are being upgraded at the same time).

3887

#

3888

# Note: upgrades inevitably introduce some disruption since workloads need to

3889

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3890

# this holds true. (Disruption stays within the limits of

3891

# PodDisruptionBudget, if it is configured.)

3892

#

3893

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3894

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3895

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3896

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3897

# there are always at least 4 nodes available.

3898

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3899

# the upgrade process. A node is considered available if its status is

3900

# Ready.

3901

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3902

# of the node pool during the upgrade process.

3903

},

3904

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

3905

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

3906

# associated with this node pool.

3907

"A String",

3908

],

3909

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

3910

# only if a valid configuration is present.

3911

# adjust the size of the node pool to the current cluster usage.

3912

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

3913

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

3914

# max_node_count.

3915

"enabled": True or False, # Is autoscaling enabled for this node pool.

3916

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

3917

# has to enough quota to scale up the cluster.

3918

},

3919

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

3920

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

3921

# is sufficient for this number of instances. You must also have available

3922

# firewall and routes quota.

3923

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

3924

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3925

# node VMs under the "default" service account.

3926

#

3927

# The following scopes are recommended, but not required, and by default are

3928

# not included:

3929

#

3930

# * `https://www.googleapis.com/auth/compute` is required for mounting

3931

# persistent storage on your nodes.

3932

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3933

# communicating with **gcr.io**

3934

# (the [Google Container

3935

# Registry](https://cloud.google.com/container-registry/)).

3936

#

3937

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3938

# Monitoring are enabled, in which case their required scopes will be added.

3939

"A String",

3940

],

3941

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3942

#

3943

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3944

# in length. These are reflected as part of a URL in the metadata server.

3945

# Additionally, to avoid ambiguity, keys must not conflict with any other

3946

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3952

# "enable-oslogin"

3953

# "gci-ensure-gke-docker"

3954

# "gci-metrics-enabled"

3955

# "gci-update-strategy"

3956

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3961

# "windows-startup-script-ps1"

3962

# "common-psm1"

3963

# "k8s-node-setup-psm1"

3964

# "install-ssh-psm1"

3965

# "user-profile-psm1"

3966

# "serial-port-logging-enable"

3967

# Values are free-form strings, and only have meaning as interpreted by

3968

# the image running in the instance. The only restriction placed on them is

3969

# that each value's size must be less than or equal to 32 KB.

3970

#

3971

# The total size of all keys and values must be less than 512 KB.

3972

"a_key": "A String",

3973

},

3974

"machineType": "A String", # The name of a Google Compute Engine [machine

3975

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3976

# `n1-standard-1`).

3977

#

3978

# If unspecified, the default machine type is

3979

# `n1-standard-1`.

3980

"nodeGroup": "A String", # Setting this field will assign instances of this

3981

# pool to run on the specified node group. This is useful for running

3982

# workloads on [sole tenant

3983

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

3984

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3985

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3986

#

3987

# Secure Boot helps ensure that the system only runs authentic software by

3988

# verifying the digital signature of all boot components, and halting the

3989

# boot process if signature verification fails.

3990

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3991

#

3992

# Enables monitoring and attestation of the boot integrity of the instance.

3993

# The attestation is performed against the integrity policy baseline. This

3994

# baseline is initially derived from the implicitly trusted boot image when

3995

# the instance is created.

3996

},

3997

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

3998

# Specify the email address of the Service Account; otherwise, if no Service

3999

# Account is specified, the "default" service account is used.

4000

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

4001

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running

4002

# on the nodes.

4003

#

4004

# The following parameters are supported.

4005

#

4006

# net.core.netdev_max_backlog

4007

# net.core.rmem_max

4008

# net.core.wmem_default

4009

# net.core.wmem_max

4010

# net.core.optmem_max

# net.core.somaxconn

# net.ipv4.tcp_rmem

# net.ipv4.tcp_wmem

# net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

4019

"type": "A String", # Type of the sandbox to use for the node.

4020

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

4021

},

4022

"taints": [ # List of kubernetes taints to be applied to each node.

4023

#

4024

# For more information, including usage and the valid values, see:

4025

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

4026

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

4027

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

4028

#

4029

# See

4030

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

4031

# for more information, including usage and the valid values.

4032

"effect": "A String", # Effect for taint.

4033

"key": "A String", # Key for taint.

4034

"value": "A String", # Value for taint.

4035

},

4036

],

4037

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

4038

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'.

4039

#

4040

# The string must be a sequence of decimal numbers, each with optional

4041

# fraction and a unit suffix, such as "300ms".

4042

# Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

4043

# The value must be a positive duration.

4044

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits.

4045

#

4046

# If this option is enabled, kubelet uses CFS quota

4047

# (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to

4048

# enforce container CPU limits. Otherwise, CPU limits will not be enforced at

4049

# all.

4050

#

4051

# Disable this option to mitigate CPU throttling problems while still having

4052

# your pods to be in Guaranteed QoS class by specifying the CPU limits.

4053

#

4054

# The default value is 'true' if unspecified.

4055

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node.

4056

# See

4057

# https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

4058

#

4059

# The following values are allowed.

4060

# - "none": the default, which represents the existing scheduling behavior.

4061

# - "static": allows pods with certain resource characteristics to be

4062

# granted increased CPU affinity and exclusivity on the node.

4063

},

4064

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

4065

# These will added in addition to any default label(s) that

4066

# Kubernetes may apply to the node.

4067

# In case of conflict in label keys, the applied set may differ depending on

4068

# the Kubernetes version -- it's best to assume the behavior is undefined

4069

# and conflicts should be avoided.

4070

# For more information, including usage and the valid values, see:

4071

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

4072

"a_key": "A String",

4073

},

4074

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

4075

#

4076

# If unspecified, the default disk type is 'pd-standard'

4077

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

4078

# workloads on the node pool.

4079

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

4080

# workloads running on the node.

4081

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

4082

# on the node pool.

4083

},

4084

"bootDiskKmsKey": "A String", #

4085

# The Customer Managed Encryption Key used to encrypt the boot disk attached

4086

# to each node in the node pool. This should be of the form

4087

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

4088

# For more information about protecting resources with Cloud KMS Keys please

4089

# see:

4090

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

4091

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

4092

# The smallest allowed disk size is 10GB.

4093

#

4094

# If unspecified, the default disk size is 100GB.

4095

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

4096

# the specified [Zonal Compute

4097

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

4098

# to this node pool.

4099

# is the configuration of desired reservation which instances could take

4100

# capacity from.

4101

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

4102

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

4103

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

4104

# the key and specify the name of your reservation as its value.

4105

"values": [ # Corresponds to the label value(s) of reservation resource(s).

"A String",

],

},

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

4110

# https://cloud.google.com/compute/docs/instances/preemptible for more

4111

# inforamtion about preemptible VM instances.

4112

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

4113

# scheduled on the specified or newer CPU platform. Applicable values are the

4114

# friendly names of CPU platforms, such as

4115

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

4116

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

4117

# information, read [how to specify min CPU

4118

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

4119

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

4120

# valid sources or targets for network firewalls and are specified by

4121

# the client during cluster or node pool creation. Each tag within the list

4122

# must comply with RFC1035.

4123

"A String",

4124

],

4125

"accelerators": [ # A list of hardware accelerators to be attached to each node.

4126

# See https://cloud.google.com/compute/docs/gpus for more information about

4127

# support for GPUs.

4128

{ # AcceleratorConfig represents a Hardware Accelerator request.

4129

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

4130

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

4131

# [here](https://cloud.google.com/compute/docs/gpus)

4132

},

4133

],

4134

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

4135

#

4136

# The limit for this value is dependent upon the maximum number of

4137

# disks available on a machine per zone. See:

4138

# https://cloud.google.com/compute/docs/disks/local-ssd

4139

# for more information.

4140

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

4141

# the latest version of it will be used.

4142

},

4143

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

4144

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

4145

# node pool.

4146

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

4147

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

4148

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

4149

# the Auto Upgrades will proceed.

4150

"description": "A String", # [Output only] This field is set when upgrades are about to commence

4151

# with the description of the upgrade.

4152

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

4153

# with the approximate start time for the upgrades, in

4154

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4155

},

4156

},

4157

"name": "A String", # The name of the node pool.

4158

"version": "A String", # The version of the Kubernetes of this node.

4159

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

4160

# simultaneously on a node in the node pool.

4161

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

4162

},

4163

"statusMessage": "A String", # [Output only] Additional information about the current status of this

4164

# node pool instance, if available.

4165

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

4166

"conditions": [ # Which conditions caused the current node pool state.

4167

{ # StatusCondition describes why a cluster or a node pool has a certain status

4168

# (e.g., ERROR or DEGRADED).

4169

"code": "A String", # Machine-friendly representation of the condition

4170

"message": "A String", # Human-friendly representation of the condition

4171

},

4172

],

4173

"locations": [ # The list of Google Compute Engine

4174

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4175

# NodePool's nodes should be located.

"A String",

],

},

],

"statusMessage": "A String", # [Output only] Additional information about the current status of this

4181

# cluster, if available.

4182

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

4183

# subscribed to. Release channels are arranged in order of risk.

4184

#

4185

# When a cluster is subscribed to a release channel, Google maintains

4186

# both the master version and the node version. Node auto-upgrade

4187

# defaults to true and cannot be disabled.

4188

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

4189

},

4190

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

4191

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

4192

# simultaneously on a node in the node pool of this cluster. Only honored

4193

# if cluster created with IP Alias support.

4194

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

4195

},

4196

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

4197

"type": "A String", # Type of the integration.

4198

},

4199

"status": "A String", # [Output only] The current status of this cluster.

4200

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

4201

# Google Compute Engine resources.

4202

"a_key": "A String",

4203

},

4204

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

4205

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

4206

# notation (e.g. `1.2.3.4/29`).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4207

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4208

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4209

# is sufficient for this number of instances. You must also have available

4210

# firewall and routes quota.

4211

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4212

# "node_pool" object, since this configuration (along with the

4213

# "node_config") will be used to create a "NodePool" object with an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4214

# auto-generated name. Do not use this and a node_pool at the same time.

4215

#

4216

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4217

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

4218

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

4219

# must be valid under a PodSecurityPolicy to be created.

4220

},

4221

"description": "A String", # An optional description of this cluster.

4222

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

4223

"state": "A String", # Denotes the state of etcd encryption.

4224

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

4225

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

4226

},

4227

"network": "A String", # The name of the Google Compute Engine

4228

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

4229

# to which the cluster is connected. If left unspecified, the `default`

4230

# network will be used. On output this shows the network ID instead of the

4231

# name.

4232

"zone": "A String", # [Output only] The name of the Google Compute Engine

4233

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4234

# cluster resides. This field is deprecated, use location instead.

4235

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

4236

# required by Vertical Pod Autoscaler to automatically adjust

4237

# the resources of pods controlled by it.

4238

"enabled": True or False, # Enables vertical pod autoscaling.

4239

},

4240

"expireTime": "A String", # [Output only] The time the cluster will be automatically

4241

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4242

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

4243

# containers. This is provisioned from within the `container_ipv4_cidr`

4244

# range. This field will only be set when cluster is in route-based network

4245

# mode.

4246

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4247

},

4248

],

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]

4253

<code class="details" id="locations">locations(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4254

<pre>Sets the locations for a specific cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4255

Deprecated. Use

4256

[projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update)

4257

instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4258

4259

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4260

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4261

number](https://support.google.com/cloud/answer/6158840).

4262

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4263

zone: string, Required. Deprecated. The name of the Google Compute Engine

4264

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4265

cluster resides. This field has been deprecated and replaced by the name

4266

field. (required)

4267

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4268

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4269

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4270

The object takes the form of:

4271

4272

{ # SetLocationsRequest sets the locations of the cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4273

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

4274

# number](https://support.google.com/cloud/answer/6158840).

4275

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4276

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

4277

# This field has been deprecated and replaced by the name field.

4278

"name": "A String", # The name (project, location, cluster) of the cluster to set locations.

4279

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4280

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4281

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4282

# cluster resides. This field has been deprecated and replaced by the name

4283

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4284

"locations": [ # Required. The desired list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4285

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4286

# 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]

4287

# will result in nodes being either created or removed from the cluster,

4288

# depending on whether locations are being added or removed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4289

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4290

# This list must always include the cluster's primary zone.

4291

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4292

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4293

}

4294

4295

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4302

4303

{ # This operation resource represents operations that may have happened or are

4304

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4305

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4306

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4307

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4308

"stages": [ # Substages of an operation or a stage.

4309

# Object with schema name: OperationProgress

4310

],

4311

"name": "A String", # A non-parameterized string describing an operation stage.

4312

# Unset for single-stage operations.

4313

"status": "A String", # Status of an operation stage.

4314

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4315

"metrics": [ # Progress metric bundle, for example:

4316

# metrics: [{name: "nodes done", int_value: 15},

4317

# {name: "nodes total", int_value: 32}]

4318

# or

4319

# metrics: [{name: "progress", double_value: 0.56},

4320

# {name: "progress scale", double_value: 1.0}]

4321

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4322

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4323

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4324

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4325

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4326

},

4327

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4328

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4329

"selfLink": "A String", # Server-defined URL for the resource.

4330

"location": "A String", # [Output only] The name of the Google Compute Engine

4331

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4332

# or

4333

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4334

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4335

"zone": "A String", # The name of the Google Compute Engine

4336

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4337

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4338

"endTime": "A String", # [Output only] The time the operation completed, in

4339

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4340

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4341

"name": "A String", # The server-assigned ID for the operation.

4342

"clusterConditions": [ # Which conditions caused the current cluster state.

4343

{ # StatusCondition describes why a cluster or a node pool has a certain status

4344

# (e.g., ERROR or DEGRADED).

4345

"code": "A String", # Machine-friendly representation of the condition

4346

"message": "A String", # Human-friendly representation of the condition

4347

},

4348

],

4349

"startTime": "A String", # [Output only] The time the operation started, in

4350

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4351

"detail": "A String", # Detailed operation progress, if available.

4352

"nodepoolConditions": [ # Which conditions caused the current node pool state.

4353

{ # StatusCondition describes why a cluster or a node pool has a certain status

4354

# (e.g., ERROR or DEGRADED).

4355

"code": "A String", # Machine-friendly representation of the condition

4356

"message": "A String", # Human-friendly representation of the condition

4357

},

4358

],

4359

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4364

<code class="details" id="logging">logging(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4365

<pre>Sets the logging service for a specific cluster.

4366

4367

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4368

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4369

number](https://support.google.com/cloud/answer/6158840).

4370

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4371

zone: string, Required. Deprecated. The name of the Google Compute Engine

4372

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4373

cluster resides. This field has been deprecated and replaced by the name

4374

field. (required)

4375

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4376

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4377

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4378

The object takes the form of:

4379

4380

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4381

"name": "A String", # The name (project, location, cluster) of the cluster to set logging.

4382

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4383

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

4384

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4385

"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]

4386

# Currently available options:

4387

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4388

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

4389

# service with a Kubernetes-native resource model

4390

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

4391

# available as of GKE 1.15).

4392

# * `none` - no logs will be exported from the cluster.

4393

#

4394

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

4395

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4396

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4397

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4398

# cluster resides. This field has been deprecated and replaced by the name

4399

# field.

4400

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

4401

# number](https://support.google.com/cloud/answer/6158840).

4402

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4403

}

4404

4405

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4412

4413

{ # This operation resource represents operations that may have happened or are

4414

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4415

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4416

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4417

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4418

"stages": [ # Substages of an operation or a stage.

4419

# Object with schema name: OperationProgress

4420

],

4421

"name": "A String", # A non-parameterized string describing an operation stage.

4422

# Unset for single-stage operations.

4423

"status": "A String", # Status of an operation stage.

4424

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4425

"metrics": [ # Progress metric bundle, for example:

4426

# metrics: [{name: "nodes done", int_value: 15},

4427

# {name: "nodes total", int_value: 32}]

4428

# or

4429

# metrics: [{name: "progress", double_value: 0.56},

4430

# {name: "progress scale", double_value: 1.0}]

4431

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4432

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4433

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4434

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4435

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4436

},

4437

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4438

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4439

"selfLink": "A String", # Server-defined URL for the resource.

4440

"location": "A String", # [Output only] The name of the Google Compute Engine

4441

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4442

# or

4443

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4444

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4445

"zone": "A String", # The name of the Google Compute Engine

4446

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4447

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4448

"endTime": "A String", # [Output only] The time the operation completed, in

4449

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4450

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4451

"name": "A String", # The server-assigned ID for the operation.

4452

"clusterConditions": [ # Which conditions caused the current cluster state.

4453

{ # StatusCondition describes why a cluster or a node pool has a certain status

4454

# (e.g., ERROR or DEGRADED).

4455

"code": "A String", # Machine-friendly representation of the condition

4456

"message": "A String", # Human-friendly representation of the condition

4457

},

4458

],

4459

"startTime": "A String", # [Output only] The time the operation started, in

4460

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4461

"detail": "A String", # Detailed operation progress, if available.

4462

"nodepoolConditions": [ # Which conditions caused the current node pool state.

4463

{ # StatusCondition describes why a cluster or a node pool has a certain status

4464

# (e.g., ERROR or DEGRADED).

4465

"code": "A String", # Machine-friendly representation of the condition

4466

"message": "A String", # Human-friendly representation of the condition

4467

},

4468

],

4469

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4474

<code class="details" id="master">master(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4475

<pre>Updates the master for a specific cluster.

4476

4477

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4478

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4479

number](https://support.google.com/cloud/answer/6158840).

4480

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4481

zone: string, Required. Deprecated. The name of the Google Compute Engine

4482

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4483

cluster resides. This field has been deprecated and replaced by the name

4484

field. (required)

4485

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4486

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4487

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4488

The object takes the form of:

4489

4490

{ # UpdateMasterRequest updates the master of the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4491

"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]

4492

# number](https://support.google.com/cloud/answer/6158840).

4493

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4494

"masterVersion": "A String", # Required. The Kubernetes version to change the master to.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4495

#

4496

# Users may specify either explicit versions offered by

4497

# Kubernetes Engine or version aliases, which have the following behavior:

4498

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4499

# - "latest": picks the highest valid Kubernetes version

4500

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4501

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4502

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4503

# - "-": picks the default Kubernetes version

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4504

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

4505

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4506

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4507

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4508

# cluster resides. This field has been deprecated and replaced by the name

4509

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4510

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4511

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4512

}

4513

4514

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4521

4522

{ # This operation resource represents operations that may have happened or are

4523

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4524

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4525

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4526

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4527

"stages": [ # Substages of an operation or a stage.

4528

# Object with schema name: OperationProgress

4529

],

4530

"name": "A String", # A non-parameterized string describing an operation stage.

4531

# Unset for single-stage operations.

4532

"status": "A String", # Status of an operation stage.

4533

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4534

"metrics": [ # Progress metric bundle, for example:

4535

# metrics: [{name: "nodes done", int_value: 15},

4536

# {name: "nodes total", int_value: 32}]

4537

# or

4538

# metrics: [{name: "progress", double_value: 0.56},

4539

# {name: "progress scale", double_value: 1.0}]

4540

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4541

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4542

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4543

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4544

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4545

},

4546

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4547

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4548

"selfLink": "A String", # Server-defined URL for the resource.

4549

"location": "A String", # [Output only] The name of the Google Compute Engine

4550

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4551

# or

4552

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4553

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4554

"zone": "A String", # The name of the Google Compute Engine

4555

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4556

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4557

"endTime": "A String", # [Output only] The time the operation completed, in

4558

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4559

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4560

"name": "A String", # The server-assigned ID for the operation.

4561

"clusterConditions": [ # Which conditions caused the current cluster state.

4562

{ # StatusCondition describes why a cluster or a node pool has a certain status

4563

# (e.g., ERROR or DEGRADED).

4564

"code": "A String", # Machine-friendly representation of the condition

4565

"message": "A String", # Human-friendly representation of the condition

4566

},

4567

],

4568

"startTime": "A String", # [Output only] The time the operation started, in

4569

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4570

"detail": "A String", # Detailed operation progress, if available.

4571

"nodepoolConditions": [ # Which conditions caused the current node pool 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

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4583

<code class="details" id="monitoring">monitoring(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4584

<pre>Sets the monitoring service for a specific cluster.

4585

4586

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4587

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4588

number](https://support.google.com/cloud/answer/6158840).

4589

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4590

zone: string, Required. Deprecated. The name of the Google Compute Engine

4591

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4592

cluster resides. This field has been deprecated and replaced by the name

4593

field. (required)

4594

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4595

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4596

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4597

The object takes the form of:

4598

4599

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4600

"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]

4601

# Currently available options:

4602

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4603

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4604

# service with a Kubernetes-native resource model

4605

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4606

# longer available as of GKE 1.15).

4607

# * `none` - No metrics will be exported from the cluster.

4608

#

4609

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4610

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4611

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4612

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4613

# cluster resides. This field has been deprecated and replaced by the name

4614

# field.

4615

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

4616

# number](https://support.google.com/cloud/answer/6158840).

4617

# This field has been deprecated and replaced by the name field.

4618

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

4619

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4620

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring.

4621

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4622

}

4623

4624

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4631

4632

{ # This operation resource represents operations that may have happened or are

4633

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4634

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4635

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4636

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4637

"stages": [ # Substages of an operation or a stage.

4638

# Object with schema name: OperationProgress

4639

],

4640

"name": "A String", # A non-parameterized string describing an operation stage.

4641

# Unset for single-stage operations.

4642

"status": "A String", # Status of an operation stage.

4643

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4644

"metrics": [ # Progress metric bundle, for example:

4645

# metrics: [{name: "nodes done", int_value: 15},

4646

# {name: "nodes total", int_value: 32}]

4647

# or

4648

# metrics: [{name: "progress", double_value: 0.56},

4649

# {name: "progress scale", double_value: 1.0}]

4650

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4651

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4652

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4653

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4654

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4655

},

4656

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4657

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4658

"selfLink": "A String", # Server-defined URL for the resource.

4659

"location": "A String", # [Output only] The name of the Google Compute Engine

4660

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4661

# or

4662

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4663

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4664

"zone": "A String", # The name of the Google Compute Engine

4665

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4666

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4667

"endTime": "A String", # [Output only] The time the operation completed, in

4668

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4669

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4670

"name": "A String", # The server-assigned ID for the operation.

4671

"clusterConditions": [ # Which conditions caused the current cluster state.

4672

{ # StatusCondition describes why a cluster or a node pool has a certain status

4673

# (e.g., ERROR or DEGRADED).

4674

"code": "A String", # Machine-friendly representation of the condition

4675

"message": "A String", # Human-friendly representation of the condition

4676

},

4677

],

4678

"startTime": "A String", # [Output only] The time the operation started, in

4679

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4680

"detail": "A String", # Detailed operation progress, if available.

4681

"nodepoolConditions": [ # Which conditions caused the current node pool state.

4682

{ # StatusCondition describes why a cluster or a node pool has a certain status

4683

# (e.g., ERROR or DEGRADED).

4684

"code": "A String", # Machine-friendly representation of the condition

4685

"message": "A String", # Human-friendly representation of the condition

4686

},

4687

],

4688

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4693

<code class="details" id="resourceLabels">resourceLabels(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4694

<pre>Sets labels on a cluster.

4695

4696

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4697

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4698

number](https://developers.google.com/console/help/new/#projectnumber).

4699

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4700

zone: string, Required. Deprecated. The name of the Google Compute Engine

4701

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4702

cluster resides. This field has been deprecated and replaced by the name

4703

field. (required)

4704

clusterId: string, Required. Deprecated. The name of the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4705

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4706

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4707

The object takes the form of:

4708

4709

{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container

4710

# Engine cluster, which will in turn set them for Google Compute Engine

4711

# resources used by that cluster

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4712

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4713

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4714

# cluster resides. This field has been deprecated and replaced by the name

4715

# field.

4716

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels.

4717

# Specified in the format `projects/*/locations/*/clusters/*`.

4718

"resourceLabels": { # Required. The labels to set for that cluster.

4719

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4720

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4721

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

4722

# number](https://developers.google.com/console/help/new/#projectnumber).

4723

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4724

"labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource,

4725

# used to detect conflicts. The fingerprint is initially generated by

4726

# Kubernetes Engine and changes after every request to modify or update

4727

# labels. You must always provide an up-to-date fingerprint hash when

4728

# updating or changing labels. Make a <code>get()</code> request to the

4729

# resource to get the latest fingerprint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4730

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

4731

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4732

}

4733

4734

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4741

4742

{ # This operation resource represents operations that may have happened or are

4743

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4744

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4745

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4746

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4747

"stages": [ # Substages of an operation or a stage.

4748

# Object with schema name: OperationProgress

4749

],

4750

"name": "A String", # A non-parameterized string describing an operation stage.

4751

# Unset for single-stage operations.

4752

"status": "A String", # Status of an operation stage.

4753

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4754

"metrics": [ # Progress metric bundle, for example:

4755

# metrics: [{name: "nodes done", int_value: 15},

4756

# {name: "nodes total", int_value: 32}]

4757

# or

4758

# metrics: [{name: "progress", double_value: 0.56},

4759

# {name: "progress scale", double_value: 1.0}]

4760

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4761

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4762

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4763

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4764

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4765

},

4766

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4767

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4768

"selfLink": "A String", # Server-defined URL for the resource.

4769

"location": "A String", # [Output only] The name of the Google Compute Engine

4770

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4771

# or

4772

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4773

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4774

"zone": "A String", # The name of the Google Compute Engine

4775

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4776

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4777

"endTime": "A String", # [Output only] The time the operation completed, in

4778

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4779

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4780

"name": "A String", # The server-assigned ID for the operation.

4781

"clusterConditions": [ # Which conditions caused the current cluster state.

4782

{ # StatusCondition describes why a cluster or a node pool has a certain status

4783

# (e.g., ERROR or DEGRADED).

4784

"code": "A String", # Machine-friendly representation of the condition

4785

"message": "A String", # Human-friendly representation of the condition

4786

},

4787

],

4788

"startTime": "A String", # [Output only] The time the operation started, in

4789

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4790

"detail": "A String", # Detailed operation progress, if available.

4791

"nodepoolConditions": [ # Which conditions caused the current node pool state.

4792

{ # StatusCondition describes why a cluster or a node pool has a certain status

4793

# (e.g., ERROR or DEGRADED).

4794

"code": "A String", # Machine-friendly representation of the condition

4795

"message": "A String", # Human-friendly representation of the condition

4796

},

4797

],

4798

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4803

<code class="details" id="setMaintenancePolicy">setMaintenancePolicy(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4804

<pre>Sets the maintenance policy for a cluster.

4805

4806

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4807

projectId: string, Required. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4808

number](https://support.google.com/cloud/answer/6158840). (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4809

zone: string, Required. The name of the Google Compute Engine

4810

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4811

cluster resides. (required)

4812

clusterId: string, Required. The name of the cluster to update. (required)

4813

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4814

The object takes the form of:

4815

4816

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4817

"clusterId": "A String", # Required. The name of the cluster to update.

4818

"zone": "A String", # Required. The name of the Google Compute Engine

4819

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4820

# cluster resides.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4821

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance

4822

# policy.

4823

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4824

"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]

4825

# clears the existing maintenance policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4826

"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-20 12:08:20 -0700

[diff] [blame]

4827

"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]

4828

# maintenance to occur. The time windows may be overlapping. If no

4829

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4830

"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]

4831

# this window reccurs. They go on for the span of time between the start and

4832

# end time.

4833

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4834

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4835

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

4836

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

4837

# <code>FREQ=DAILY</code>

4838

# For the first weekend of every month:

4839

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

4840

# 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]

4841

# 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]

4842

# <code>

4843

# start time = 2019-01-01T09:00:00-0400

4844

# end time = 2019-01-01T17:00:00-0400

4845

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

4846

# </code>

4847

# Windows can span multiple days. Eg, to make the window encompass every

4848

# weekend from midnight Saturday till the last minute of Sunday UTC:

4849

# <code>

4850

# start time = 2019-01-05T00:00:00Z

4851

# end time = 2019-01-07T23:59:00Z

4852

# recurrence = FREQ=WEEKLY;BYDAY=SA

4853

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4854

# 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]

4855

# to specify duration of the window and when it first starts.

4856

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4857

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

4858

"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]

4859

# start time.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4860

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4861

},

4862

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4863

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4864

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

4865

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4866

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

4867

# smallest possible in the given scenario.

4868

},

4869

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

4870

# occur in these windows.

4871

"a_key": { # Represents an arbitrary window of time.

4872

"endTime": "A String", # The time that the window ends. The end time should take place after the

4873

# start time.

4874

"startTime": "A String", # The time that the window first starts.

4875

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4876

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4877

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4878

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

4879

# the policy won't accidentally undo intermediate changes (and so that users

4880

# of the API unaware of some fields won't accidentally remove other fields).

4881

# Make a <code>get()</code> request to the cluster to get the current

4882

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4883

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4884

"projectId": "A String", # Required. The Google Developers Console [project ID or project

4885

# number](https://support.google.com/cloud/answer/6158840).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4886

}

4887

4888

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4895

4896

{ # This operation resource represents operations that may have happened or are

4897

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4898

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4899

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4900

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4901

"stages": [ # Substages of an operation or a stage.

4902

# Object with schema name: OperationProgress

4903

],

4904

"name": "A String", # A non-parameterized string describing an operation stage.

4905

# Unset for single-stage operations.

4906

"status": "A String", # Status of an operation stage.

4907

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4908

"metrics": [ # Progress metric bundle, for example:

4909

# metrics: [{name: "nodes done", int_value: 15},

4910

# {name: "nodes total", int_value: 32}]

4911

# or

4912

# metrics: [{name: "progress", double_value: 0.56},

4913

# {name: "progress scale", double_value: 1.0}]

4914

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4915

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4916

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4917

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4918

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4919

},

4920

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4921

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4922

"selfLink": "A String", # Server-defined URL for the resource.

4923

"location": "A String", # [Output only] The name of the Google Compute Engine

4924

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4925

# or

4926

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4927

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4928

"zone": "A String", # The name of the Google Compute Engine

4929

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4930

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4931

"endTime": "A String", # [Output only] The time the operation completed, in

4932

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4933

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4934

"name": "A String", # The server-assigned ID for the operation.

4935

"clusterConditions": [ # Which conditions caused the current cluster state.

4936

{ # StatusCondition describes why a cluster or a node pool has a certain status

4937

# (e.g., ERROR or DEGRADED).

4938

"code": "A String", # Machine-friendly representation of the condition

4939

"message": "A String", # Human-friendly representation of the condition

4940

},

4941

],

4942

"startTime": "A String", # [Output only] The time the operation started, in

4943

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4944

"detail": "A String", # Detailed operation progress, if available.

4945

"nodepoolConditions": [ # Which conditions caused the current node pool state.

4946

{ # StatusCondition describes why a cluster or a node pool has a certain status

4947

# (e.g., ERROR or DEGRADED).

4948

"code": "A String", # Machine-friendly representation of the condition

4949

"message": "A String", # Human-friendly representation of the condition

4950

},

4951

],

4952

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4957

<code class="details" id="setMasterAuth">setMasterAuth(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4958

<pre>Sets master auth materials. Currently supports changing the admin password

4959

or a specific cluster, either via password generation or explicitly setting

4960

the password.

4961

4962

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4963

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4964

number](https://support.google.com/cloud/answer/6158840).

4965

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4966

zone: string, Required. Deprecated. The name of the Google Compute Engine

4967

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4968

cluster resides. This field has been deprecated and replaced by the name

4969

field. (required)

4970

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4971

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4972

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4973

The object takes the form of:

4974

4975

{ # SetMasterAuthRequest updates the admin password of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4976

"name": "A String", # The name (project, location, cluster) of the cluster to set auth.

4977

# Specified in the format `projects/*/locations/*/clusters/*`.

4978

"action": "A String", # Required. The exact form of action to be taken on the master auth.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4979

"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]

4980

# Authentication can be done using HTTP basic auth or using client

4981

# certificates.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4982

"clusterCaCertificate": "A String",

4983

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

4984

# For clusters v1.6.0 and later, basic authentication can be disabled by

4985

# leaving username unspecified (or setting it to the empty string).

4986

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

4987

# authenticate to the cluster endpoint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4988

"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]

4989

# Because the master endpoint is open to the Internet, you should create a

4990

# strong password. If a password is provided for cluster creation, username

4991

# must be non-empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4992

"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]

4993

# clusters before v1.12, if no configuration is specified, a client

4994

# certificate is issued.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4995

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4996

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4997

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

4998

# to the cluster endpoint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4999

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5000

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

5001

# number](https://support.google.com/cloud/answer/6158840).

5002

# This field has been deprecated and replaced by the name field.

5003

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

5004

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5005

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

5006

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5007

# cluster resides. This field has been deprecated and replaced by the name

5008

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5009

}

5010

5011

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5018

5019

{ # This operation resource represents operations that may have happened or are

5020

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5021

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5022

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5023

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5024

"stages": [ # Substages of an operation or a stage.

5025

# Object with schema name: OperationProgress

5026

],

5027

"name": "A String", # A non-parameterized string describing an operation stage.

5028

# Unset for single-stage operations.

5029

"status": "A String", # Status of an operation stage.

5030

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5031

"metrics": [ # Progress metric bundle, for example:

5032

# metrics: [{name: "nodes done", int_value: 15},

5033

# {name: "nodes total", int_value: 32}]

5034

# or

5035

# metrics: [{name: "progress", double_value: 0.56},

5036

# {name: "progress scale", double_value: 1.0}]

5037

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5038

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5039

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5040

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

5041

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5042

},

5043

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5044

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5045

"selfLink": "A String", # Server-defined URL for the resource.

5046

"location": "A String", # [Output only] The name of the Google Compute Engine

5047

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5048

# or

5049

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5050

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5051

"zone": "A String", # The name of the Google Compute Engine

5052

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5053

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5054

"endTime": "A String", # [Output only] The time the operation completed, in

5055

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5056

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5057

"name": "A String", # The server-assigned ID for the operation.

5058

"clusterConditions": [ # Which conditions caused the current cluster state.

5059

{ # StatusCondition describes why a cluster or a node pool has a certain status

5060

# (e.g., ERROR or DEGRADED).

5061

"code": "A String", # Machine-friendly representation of the condition

5062

"message": "A String", # Human-friendly representation of the condition

5063

},

5064

],

5065

"startTime": "A String", # [Output only] The time the operation started, in

5066

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5067

"detail": "A String", # Detailed operation progress, if available.

5068

"nodepoolConditions": [ # Which conditions caused the current node pool state.

5069

{ # StatusCondition describes why a cluster or a node pool has a certain status

5070

# (e.g., ERROR or DEGRADED).

5071

"code": "A String", # Machine-friendly representation of the condition

5072

"message": "A String", # Human-friendly representation of the condition

5073

},

5074

],

5075

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5080

<code class="details" id="setNetworkPolicy">setNetworkPolicy(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5081

<pre>Enables or disables Network Policy for a cluster.

5082

5083

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5084

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5085

number](https://developers.google.com/console/help/new/#projectnumber).

5086

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5087

zone: string, Required. Deprecated. The name of the Google Compute Engine

5088

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

5089

cluster resides. This field has been deprecated and replaced by the name

5090

field. (required)

5091

clusterId: string, Required. Deprecated. The name of the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5092

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5093

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5094

The object takes the form of:

5095

5096

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5097

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

5098

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5099

"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]

5100

# number](https://developers.google.com/console/help/new/#projectnumber).

5101

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5102

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5103

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5104

# cluster resides. This field has been deprecated and replaced by the name

5105

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5106

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking

5107

# policy. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5108

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature.

5109

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5110

"provider": "A String", # The selected network policy provider.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5111

"enabled": True or False, # Whether network policy is enabled on the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5112

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5113

}

5114

5115

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5122

5123

{ # This operation resource represents operations that may have happened or are

5124

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5125

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5126

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5127

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5128

"stages": [ # Substages of an operation or a stage.

5129

# Object with schema name: OperationProgress

5130

],

5131

"name": "A String", # A non-parameterized string describing an operation stage.

5132

# Unset for single-stage operations.

5133

"status": "A String", # Status of an operation stage.

5134

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5135

"metrics": [ # Progress metric bundle, for example:

5136

# metrics: [{name: "nodes done", int_value: 15},

5137

# {name: "nodes total", int_value: 32}]

5138

# or

5139

# metrics: [{name: "progress", double_value: 0.56},

5140

# {name: "progress scale", double_value: 1.0}]

5141

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5142

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5143

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5144

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

5145

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5146

},

5147

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5148

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5149

"selfLink": "A String", # Server-defined URL for the resource.

5150

"location": "A String", # [Output only] The name of the Google Compute Engine

5151

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5152

# or

5153

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5154

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5155

"zone": "A String", # The name of the Google Compute Engine

5156

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5157

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -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

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5161

"name": "A String", # The server-assigned ID for the operation.

5162

"clusterConditions": [ # Which conditions caused the current cluster state.

5163

{ # StatusCondition describes why a cluster or a node pool has a certain status

5164

# (e.g., ERROR or DEGRADED).

5165

"code": "A String", # Machine-friendly representation of the condition

5166

"message": "A String", # Human-friendly representation of the condition

5167

},

5168

],

5169

"startTime": "A String", # [Output only] The time the operation started, in

5170

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5171

"detail": "A String", # Detailed operation progress, if available.

5172

"nodepoolConditions": [ # Which conditions caused the current node pool state.

5173

{ # StatusCondition describes why a cluster or a node pool has a certain status

5174

# (e.g., ERROR or DEGRADED).

5175

"code": "A String", # Machine-friendly representation of the condition

5176

"message": "A String", # Human-friendly representation of the condition

5177

},

5178

],

5179

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5184

<code class="details" id="startIpRotation">startIpRotation(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5185

<pre>Starts master IP rotation.

5186

5187

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5188

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5189

number](https://developers.google.com/console/help/new/#projectnumber).

5190

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5191

zone: string, Required. Deprecated. The name of the Google Compute Engine

5192

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

5193

cluster resides. This field has been deprecated and replaced by the name

5194

field. (required)

5195

clusterId: string, Required. Deprecated. The name of the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5196

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5197

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5198

The object takes the form of:

5199

5200

{ # StartIPRotationRequest creates a new IP for the cluster and then performs

5201

# a node upgrade on each node pool to point to the new IP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5202

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

5203

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5204

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP

5205

# rotation. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5206

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5207

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5208

# cluster resides. This field has been deprecated and replaced by the name

5209

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5210

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

5211

# number](https://developers.google.com/console/help/new/#projectnumber).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5212

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5213

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5214

}

5215

5216

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5223

5224

{ # This operation resource represents operations that may have happened or are

5225

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5226

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5227

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5228

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5229

"stages": [ # Substages of an operation or a stage.

5230

# Object with schema name: OperationProgress

5231

],

5232

"name": "A String", # A non-parameterized string describing an operation stage.

5233

# Unset for single-stage operations.

5234

"status": "A String", # Status of an operation stage.

5235

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5236

"metrics": [ # Progress metric bundle, for example:

5237

# metrics: [{name: "nodes done", int_value: 15},

5238

# {name: "nodes total", int_value: 32}]

5239

# or

5240

# metrics: [{name: "progress", double_value: 0.56},

5241

# {name: "progress scale", double_value: 1.0}]

5242

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5243

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5244

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5245

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

5246

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5247

},

5248

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5249

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5250

"selfLink": "A String", # Server-defined URL for the resource.

5251

"location": "A String", # [Output only] The name of the Google Compute Engine

5252

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5253

# or

5254

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5255

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5256

"zone": "A String", # The name of the Google Compute Engine

5257

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5258

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5259

"endTime": "A String", # [Output only] The time the operation completed, in

5260

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5261

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5262

"name": "A String", # The server-assigned ID for the operation.

5263

"clusterConditions": [ # Which conditions caused the current cluster state.

5264

{ # StatusCondition describes why a cluster or a node pool has a certain status

5265

# (e.g., ERROR or DEGRADED).

5266

"code": "A String", # Machine-friendly representation of the condition

5267

"message": "A String", # Human-friendly representation of the condition

5268

},

5269

],

5270

"startTime": "A String", # [Output only] The time the operation started, in

5271

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5272

"detail": "A String", # Detailed operation progress, if available.

5273

"nodepoolConditions": [ # Which conditions caused the current node pool state.

5274

{ # StatusCondition describes why a cluster or a node pool has a certain status

5275

# (e.g., ERROR or DEGRADED).

5276

"code": "A String", # Machine-friendly representation of the condition

5277

"message": "A String", # Human-friendly representation of the condition

5278

},

5279

],

5280

"status": "A String", # The current status of the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5285

<code class="details" id="update">update(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5286

<pre>Updates the settings for a specific cluster.

5287

5288

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5289

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5290

number](https://support.google.com/cloud/answer/6158840).

5291

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5292

zone: string, Required. Deprecated. The name of the Google Compute Engine

5293

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

5294

cluster resides. This field has been deprecated and replaced by the name

5295

field. (required)

5296

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5297

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5298

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5299

The object takes the form of:

5300

5301

{ # UpdateClusterRequest updates the settings of a cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5302

"name": "A String", # The name (project, location, cluster) of the cluster to update.

5303

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5304

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5305

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5306

"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]

5307

# be applied to a cluster with each request, so at most one field can be

5308

# provided.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5309

"desiredLoggingService": "A String", # The logging service the cluster should use to write logs.

5310

# Currently available options:

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5311

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5312

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

5313

# service with a Kubernetes-native resource model

5314

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

5315

# available as of GKE 1.15).

5316

# * `none` - no logs will be exported from the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5317

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5318

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

5319

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

5320

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

5321

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

5322

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5323

"desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

5324

# required by Cluster Autoscaler to automatically adjust

5325

# the size of the cluster and create/delete

5326

# node pools based on the current needs.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5327

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

5328

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

5329

# created by NAP.

5330

# by NAP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5331

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5332

# disruption caused by an upgrade.

5333

#

5334

# maxUnavailable controls the number of nodes that can be simultaneously

5335

# unavailable.

5336

#

5337

# maxSurge controls the number of additional nodes that can be added to the

5338

# node pool temporarily for the time of the upgrade to increase the number of

5339

# available nodes.

5340

#

5341

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

5342

# nodes are being upgraded at the same time).

5343

#

5344

# Note: upgrades inevitably introduce some disruption since workloads need to

5345

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

5346

# this holds true. (Disruption stays within the limits of

5347

# PodDisruptionBudget, if it is configured.)

5348

#

5349

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

5350

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

5351

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

5352

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

5353

# there are always at least 4 nodes available.

5354

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

5355

# the upgrade process. A node is considered available if its status is

5356

# Ready.

5357

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

5358

# of the node pool during the upgrade process.

5359

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5360

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

5361

# Specify the email address of the Service Account; otherwise, if no Service

5362

# Account is specified, the "default" service account is used.

5363

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

5364

# node VMs under the "default" service account.

5365

#

5366

# The following scopes are recommended, but not required, and by default are

5367

# not included:

5368

#

5369

# * `https://www.googleapis.com/auth/compute` is required for mounting

5370

# persistent storage on your nodes.

5371

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

5372

# communicating with **gcr.io**

5373

# (the [Google Container

5374

# Registry](https://cloud.google.com/container-registry/)).

5375

#

5376

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

5377

# Monitoring are enabled, in which case their required scopes will be added.

5378

"A String",

5379

],

5380

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

5381

# scheduled on the specified or newer CPU platform. Applicable values are the

5382

# friendly names of CPU platforms, such as

5383

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

5384

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

5385

# information, read [how to specify min CPU

5386

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

5387

# To unset the min cpu platform field pass "automatic"

5388

# as field value.

5389

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

5390

# node pool.

5391

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

5392

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

5393

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

5394

# the Auto Upgrades will proceed.

5395

"description": "A String", # [Output only] This field is set when upgrades are about to commence

5396

# with the description of the upgrade.

5397

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

5398

# with the approximate start time for the upgrades, in

5399

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5400

},

5401

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5402

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5403

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

5404

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

5405

# amount of resources in the cluster.

5406

{ # Contains information about amount of some resource in the cluster.

5407

# For memory, value should be in GB.

5408

"minimum": "A String", # Minimum amount of the resource in the cluster.

5409

"maximum": "A String", # Maximum amount of the resource in the cluster.

5410

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5411

},

5412

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5413

"autoprovisioningLocations": [ # The list of Google Compute Engine

5414

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

5415

# NodePool's nodes can be created by NAP.

5416

"A String",

5417

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5418

},

5419

"desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics.

5420

# Currently available options:

5421

#

5422

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

5423

# service with a Kubernetes-native resource model

5424

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

5425

# longer available as of GKE 1.15).

5426

# * `none` - No metrics will be exported from the cluster.

5427

#

5428

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

5429

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5430

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

5431

# required by Vertical Pod Autoscaler to automatically adjust

5432

# the resources of pods controlled by it.

5433

"enabled": True or False, # Enables vertical pod autoscaling.

5434

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5435

"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster.

5436

"type": "A String", # Type of the integration.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5437

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5438

"desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is # The desired release channel configuration.

5439

# subscribed to. Release channels are arranged in order of risk.

5440

#

5441

# When a cluster is subscribed to a release channel, Google maintains

5442

# both the master version and the node version. Node auto-upgrade

5443

# defaults to true and cannot be disabled.

5444

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5445

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5446

"desiredTpuConfig": { # Configuration for Cloud TPU. # The desired Cloud TPU configuration.

5447

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

5448

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

5449

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

5450

},

5451

"desiredMaster": { # Master is the configuration for components on master. # Configuration for master components.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5452

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5453

"desiredDefaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # The desired status of whether to disable default sNAT for this cluster.

5454

# be disabled on the cluster.

5455

"disabled": True or False, # Disables cluster default sNAT rules.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5456

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5457

"desiredPodSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # The desired configuration options for the PodSecurityPolicy feature.

5458

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

5459

# must be valid under a PodSecurityPolicy to be created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5460

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5461

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in

5462

# desired_node_pool_id. If there is only one pool in the

5463

# cluster and desired_node_pool_id is not provided then

5464

# the change applies to that single node pool.

5465

# adjust the size of the node pool to the current cluster usage.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5466

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

5467

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

5468

# max_node_count.

5469

"enabled": True or False, # Is autoscaling enabled for this node pool.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5470

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

5471

# has to enough quota to scale up the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5472

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5473

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the

5474

# latest supported version.

5475

#

5476

# Users may specify either explicit versions offered by

5477

# Kubernetes Engine or version aliases, which have the following behavior:

5478

#

5479

# - "latest": picks the highest valid Kubernetes version

5480

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

5481

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

5482

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

5483

# - "-": picks the default Kubernetes version

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5484

"desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an

5485

# upgrade).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5486

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5487

# Users may specify either explicit versions offered by

5488

# Kubernetes Engine or version aliases, which have the following behavior:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5489

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5490

# - "latest": picks the highest valid Kubernetes version

5491

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

5492

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

5493

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

5494

# - "-": picks the Kubernetes master version

5495

"desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature.

5496

# master authorized networks will disallow all external traffic to access

5497

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

5498

# Google Compute Engine Public IPs and Google Prod IPs.

5499

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

5500

# Kubernetes master through HTTPS.

5501

{ # CidrBlock contains an optional name and one CIDR block.

5502

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

5503

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

5504

},

5505

],

5506

"enabled": True or False, # Whether or not master authorized networks is enabled.

5507

},

5508

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

5509

"state": "A String", # Denotes the state of etcd encryption.

5510

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

5511

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

5512

},

5513

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility.

5514

# visibility on this cluster.

5515

"enabled": True or False, # Enables intra node visibility for this cluster.

5516

},

5517

"desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

5518

# cluster, enabling additional functionality.

5519

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

5520

# extension to manage hosted GCP services through the Kubernetes API

5521

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

5522

},

5523

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

5524

# enabled at cluster creation time.

5525

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

5526

},

5527

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

5528

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

5529

},

5530

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

5531

# is enabled or not on the Master, it does not track whether network policy

5532

# is enabled for the nodes.

5533

# is enabled or not on the Master, it does not track whether network policy

5534

# is enabled for the nodes.

5535

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

5536

},

5537

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

5538

# This addon is deprecated, and will be disabled in 1.15. It is recommended

5539

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

5540

# workloads and applications. For more information, see:

5541

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

5542

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

5543

},

5544

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

5545

# makes it easy to set up HTTP load balancers for services in a cluster.

5546

# which makes it easy to set up HTTP load balancers for services in a cluster.

5547

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

5548

# When enabled, it runs a small pod in the cluster that manages the load

5549

# balancers.

5550

},

5551

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

5552

# microservices.

5553

"disabled": True or False, # Whether Istio is enabled for this cluster.

5554

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

5555

},

5556

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

5557

# increases or decreases the number of replica pods a replication controller

5558

# has based on the resource usage of the existing pods.

5559

# increases or decreases the number of replica pods a replication controller

5560

# has based on the resource usage of the existing pods.

5561

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

5562

# When enabled, it ensures that metrics are collected into Stackdriver

5563

# Monitoring.

5564

},

5565

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

5566

# enabled in order to enable Cloud Run addon. This option can only be enabled

5567

# at cluster creation time.

5568

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

5569

},

5570

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

5571

# applications.

5572

"enabled": True or False, # Whether KALM is enabled for this cluster.

5573

},

5574

},

5575

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity.

5576

# policies.

5577

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

5578

"identityProvider": "A String", # identity provider is the third party identity provider.

5579

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

5580

},

5581

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

5582

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

5583

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

5584

# second BigQuery table will be created to hold resource consumption

5585

# records.

5586

},

5587

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

5588

"datasetId": "A String", # The ID of a BigQuery Dataset.

5589

},

5590

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

5591

# daemonset will be created in the cluster to meter network egress traffic.

5592

},

5593

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

5594

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

5595

# images will be validated by Google Binauthz.

5596

},

5597

"desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration.

5598

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

5599

# given only RFC 1918 private addresses and communicate with the master via

5600

# private networking.

5601

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

5602

# range will be used for assigning internal IP addresses to the master or

5603

# set of masters, as well as the ILB VIP. This range must not overlap with

5604

# any other ranges in use within the cluster's network.

5605

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

5606

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

5607

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

5608

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

5609

"enabled": True or False, # Whenever master is accessible globally or not.

5610

},

5611

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

5612

},

5613

"desiredLocations": [ # The desired list of Google Compute Engine

5614

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

5615

# cluster's nodes should be located. Changing the locations a cluster is in

5616

# will result in nodes being either created or removed from the cluster,

5617

# depending on whether locations are being added or removed.

5618

#

5619

# This list must always include the cluster's primary zone.

5620

"A String",

5621

],

5622

"desiredImageType": "A String", # The desired image type for the node pool.

5623

# NOTE: Set the "desired_node_pool" field as well.

5624

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if

5625

# "desired_node_version", "desired_image_family",

5626

# "desired_node_pool_autoscaling", or "desired_workload_metadata_config"

5627

# is specified and there is more than one node pool on the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5628

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5629

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

5630

# number](https://support.google.com/cloud/answer/6158840).

5631

# This field has been deprecated and replaced by the name field.

5632

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

5633

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5634

# cluster resides. This field has been deprecated and replaced by the name

5635

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5636

}

5637

5638

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5645

5646

{ # This operation resource represents operations that may have happened or are

5647

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5648

"targetLink": "A String", # Server-defined URL for the target of the operation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5649

"operationType": "A String", # The operation type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5650

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5651

"stages": [ # Substages of an operation or a stage.

5652

# Object with schema name: OperationProgress

5653

],

5654

"name": "A String", # A non-parameterized string describing an operation stage.

5655

# Unset for single-stage operations.

5656

"status": "A String", # Status of an operation stage.

5657

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5658

"metrics": [ # Progress metric bundle, for example:

5659

# metrics: [{name: "nodes done", int_value: 15},

5660

# {name: "nodes total", int_value: 32}]

5661

# or

5662

# metrics: [{name: "progress", double_value: 0.56},

5663

# {name: "progress scale", double_value: 1.0}]

5664

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5665

"doubleValue": 3.14, # For metrics with floating point value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5666

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5667

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

5668

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5669

},

5670

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5671

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5672

"selfLink": "A String", # Server-defined URL for the resource.

5673

"location": "A String", # [Output only] The name of the Google Compute Engine

5674

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5675

# or

5676

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5677

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5678

"zone": "A String", # The name of the Google Compute Engine

5679

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5680

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5681

"endTime": "A String", # [Output only] The time the operation completed, in

5682

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5683

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5684

"name": "A String", # The server-assigned ID for the operation.

5685

"clusterConditions": [ # Which conditions caused the current cluster state.

5686

{ # StatusCondition describes why a cluster or a node pool has a certain status

5687

# (e.g., ERROR or DEGRADED).

5688

"code": "A String", # Machine-friendly representation of the condition

5689

"message": "A String", # Human-friendly representation of the condition

5690

},

5691

],

5692

"startTime": "A String", # [Output only] The time the operation started, in

5693

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5694

"detail": "A String", # Detailed operation progress, if available.

5695

"nodepoolConditions": [ # Which conditions caused the current node pool state.

5696

{ # StatusCondition describes why a cluster or a node pool has a certain status

5697

# (e.g., ERROR or DEGRADED).

5698

"code": "A String", # Machine-friendly representation of the condition

5699

"message": "A String", # Human-friendly representation of the condition

5700

},

5701

],

5702

"status": "A String", # The current status of the operation.

Bu Sun Kim