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

2015-09-11 13:55:40 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Jon Wayne Parrott

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

[diff] [blame]

78

<code><a href="container_v1.projects.zones.clusters.nodePools.html">nodePools()</a></code>

79

</p>

80

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

81

82

Dan O'Meara

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>

Sai Cheemalapati

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

[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>

Sai Cheemalapati

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

[diff] [blame]

90

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

91

Bu Sun Kim

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

[diff] [blame]

92

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

Sai Cheemalapati

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

[diff] [blame]

93

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

94

Bu Sun Kim

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

[diff] [blame]

95

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

Jon Wayne Parrott

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

[diff] [blame]

96

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

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>

Sai Cheemalapati

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

[diff] [blame]

99

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

100

Bu Sun Kim

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

[diff] [blame]

101

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

Sai Cheemalapati

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

[diff] [blame]

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>

Sai Cheemalapati

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

[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>

Sai Cheemalapati

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

[diff] [blame]

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>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

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>

Jon Wayne Parrott

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

[diff] [blame]

132

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

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.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

137

138

Args:

Bu Sun Kim

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

[diff] [blame]

139

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

140

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

141

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

142

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

Dan O'Meara

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

[diff] [blame]

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)

Bu Sun Kim

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

[diff] [blame]

146

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

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.

Sai Cheemalapati

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

[diff] [blame]

149

The object takes the form of:

150

Bu Sun Kim

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

[diff] [blame]

151

{ # SetAddonsConfigRequest sets the addons associated with the cluster.

Bu Sun Kim

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

[diff] [blame^]

152

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

153

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

154

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

Bu Sun Kim

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

[diff] [blame]

155

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

156

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

Bu Sun Kim

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

[diff] [blame^]

157

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

158

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

159

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

160

# field.

161

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

162

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

163

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

164

# cluster.

165

# cluster, enabling additional functionality.

Bu Sun Kim

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

[diff] [blame^]

166

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

167

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

168

# is enabled for the nodes.

169

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

170

# is enabled for the nodes.

171

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

172

},

173

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

174

# managed Knative service.

175

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

176

},

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

# Monitoring.

185

},

186

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

Bu Sun Kim

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

[diff] [blame]

187

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

188

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

Bu Sun Kim

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

[diff] [blame^]

189

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

Bu Sun Kim

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

[diff] [blame]

190

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

191

# balancers.

192

},

Bu Sun Kim

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

[diff] [blame^]

193

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

Bu Sun Kim

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

[diff] [blame]

194

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

195

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

196

# workloads and applications. For more information, see:

197

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

Bu Sun Kim

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

[diff] [blame^]

198

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

Bu Sun Kim

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

[diff] [blame]

199

},

200

},

Sai Cheemalapati

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

[diff] [blame]

201

}

202

203

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

210

211

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

212

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

Bu Sun Kim

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

[diff] [blame^]

213

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

214

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

Bu Sun Kim

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

[diff] [blame]

215

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

216

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

Bu Sun Kim

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

[diff] [blame^]

217

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

218

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

Bu Sun Kim

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

[diff] [blame]

219

},

220

],

Bu Sun Kim

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

[diff] [blame^]

221

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

Dan O'Meara

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

[diff] [blame]

222

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

Bu Sun Kim

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

[diff] [blame^]

223

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

Dan O'Meara

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

[diff] [blame]

224

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

225

# or

226

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

227

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

228

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

229

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

230

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

231

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

232

# Object with schema name: OperationProgress

233

],

234

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

235

# Unset for single-stage operations.

236

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

237

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

238

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

239

# or

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

},

248

],

249

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

250

# Unset for single-stage operations.

251

},

252

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

253

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

254

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

255

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

256

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

257

},

258

],

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

272

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

273

<pre>Completes master IP rotation.

274

275

Args:

276

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

277

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

278

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

279

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

Dan O'Meara

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

[diff] [blame]

280

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

281

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

282

field. (required)

Bu Sun Kim

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

[diff] [blame]

283

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

284

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

Dan O'Meara

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

[diff] [blame]

285

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

286

The object takes the form of:

287

288

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

Bu Sun Kim

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

[diff] [blame^]

289

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

290

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

291

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

Bu Sun Kim

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

[diff] [blame]

292

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

293

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

Bu Sun Kim

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

[diff] [blame^]

294

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

Dan O'Meara

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

[diff] [blame]

295

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

296

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

297

# field.

Bu Sun Kim

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

[diff] [blame^]

298

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

299

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

Bu Sun Kim

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

[diff] [blame]

300

}

301

302

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

309

310

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

311

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

Bu Sun Kim

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

[diff] [blame^]

312

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

313

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

Bu Sun Kim

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

[diff] [blame]

314

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

315

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

Bu Sun Kim

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

[diff] [blame^]

316

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

317

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

Bu Sun Kim

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

[diff] [blame]

318

},

319

],

Bu Sun Kim

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

[diff] [blame^]

320

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

Dan O'Meara

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

[diff] [blame]

321

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

Bu Sun Kim

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

[diff] [blame^]

322

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

Dan O'Meara

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

[diff] [blame]

323

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

324

# or

325

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

326

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

327

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

328

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

329

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

330

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

331

# Object with schema name: OperationProgress

332

],

333

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

334

# Unset for single-stage operations.

335

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

336

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

337

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

338

# or

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

},

347

],

348

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

349

# Unset for single-stage operations.

350

},

351

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

352

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

353

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

354

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

355

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

356

},

357

],

358

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

359

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

360

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

361

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

362

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

363

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

364

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

365

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

366

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

371

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

Sai Cheemalapati

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

[diff] [blame]

372

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

373

Compute Engine instances.

374

Bu Sun Kim

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

[diff] [blame^]

375

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

Dan O'Meara

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

[diff] [blame]

376

[default

377

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

Sai Cheemalapati

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

[diff] [blame]

378

379

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

Bu Sun Kim

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

[diff] [blame]

380

the Kubelet creates routes for each node to allow the containers

Sai Cheemalapati

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

[diff] [blame]

381

on that node to communicate with all other instances in the

382

cluster.

383

Bu Sun Kim

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

[diff] [blame^]

384

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

Bu Sun Kim

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

[diff] [blame]

385

which CIDR range the cluster is using.

Sai Cheemalapati

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

[diff] [blame]

386

387

Args:

Bu Sun Kim

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

[diff] [blame]

388

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

389

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

390

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

391

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

Dan O'Meara

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

[diff] [blame]

392

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

393

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

394

field. (required)

395

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

396

The object takes the form of:

397

398

{ # CreateClusterRequest creates a cluster.

Bu Sun Kim

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

[diff] [blame^]

399

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

Bu Sun Kim

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

[diff] [blame]

400

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

401

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

Bu Sun Kim

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

[diff] [blame^]

402

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

Dan O'Meara

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

[diff] [blame]

403

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

Bu Sun Kim

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

[diff] [blame^]

404

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

405

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

406

# if cluster created with IP Alias support.

407

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

408

},

409

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

410

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

411

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

412

# network will be used.

413

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

414

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

Sai Cheemalapati

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

[diff] [blame]

415

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

Bu Sun Kim

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

[diff] [blame]

416

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

417

# mode.

Bu Sun Kim

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

[diff] [blame^]

418

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

419

# master authorized networks will disallow all external traffic to access

420

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

421

# Google Compute Engine Public IPs and Google Prod IPs.

422

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

423

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

424

# Kubernetes master through HTTPS.

425

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

426

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

427

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

},

],

},

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

432

# cluster, if available.

433

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

434

# If unspecified, the defaults are used:

435

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

436

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

437

# certificate will be issued.

438

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

439

# certificates.

440

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

441

# trust for the cluster.

442

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

443

# authenticate to the cluster endpoint.

444

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

445

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

446

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

447

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

448

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

449

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

450

# must be non-empty.

451

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

452

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

453

# certificate is issued.

454

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

455

},

456

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

457

# to the cluster endpoint.

458

},

459

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

460

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

461

# during authentication using a group of security groups.

462

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

463

# if enabled = true.

464

},

465

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

466

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

467

# cluster, enabling additional functionality.

468

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

469

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

470

# is enabled for the nodes.

471

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

472

# is enabled for the nodes.

473

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

474

},

475

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

476

# managed Knative service.

477

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

478

},

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

# Monitoring.

487

},

488

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

489

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

490

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

491

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

492

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

493

# balancers.

494

},

495

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

496

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

497

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

498

# workloads and applications. For more information, see:

499

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

500

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

501

},

502

},

503

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

504

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

505

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

506

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

507

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

508

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

509

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

510

# the cluster is connected.

511

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

512

# Google Compute Engine resources.

513

"a_key": "A String",

514

},

515

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

516

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

517

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

518

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

519

# smallest possible in the given scenario.

520

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

521

# format "PTnHnMnS".

522

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

523

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

524

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

525

},

526

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

527

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

528

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

Bu Sun Kim

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

[diff] [blame^]

529

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

530

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

531

# end time.

532

#

Bu Sun Kim

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

[diff] [blame^]

533

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

Dan O'Meara

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

[diff] [blame]

534

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

535

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

536

# <code>FREQ=DAILY</code>

537

# For the first weekend of every month:

538

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

539

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

540

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

541

# <code>

542

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

543

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

544

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

545

# </code>

546

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

547

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

548

# <code>

549

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

550

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

551

# recurrence = FREQ=WEEKLY;BYDAY=SA

552

# </code>

Bu Sun Kim

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

[diff] [blame^]

553

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

554

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

555

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

Bu Sun Kim

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

[diff] [blame^]

556

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

557

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

558

# start time.

Bu Sun Kim

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

[diff] [blame^]

559

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

Dan O'Meara

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

[diff] [blame]

560

},

561

},

Bu Sun Kim

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

[diff] [blame^]

562

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

Dan O'Meara

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

[diff] [blame]

563

# occur in these windows.

Bu Sun Kim

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

[diff] [blame^]

564

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

565

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

566

# start time.

Bu Sun Kim

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

[diff] [blame^]

567

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

Dan O'Meara

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

[diff] [blame]

568

},

569

},

Bu Sun Kim

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

[diff] [blame]

570

},

Bu Sun Kim

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

[diff] [blame^]

571

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

572

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

573

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

Dan O'Meara

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

[diff] [blame]

574

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

575

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

Bu Sun Kim

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

[diff] [blame]

576

},

Bu Sun Kim

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

[diff] [blame^]

577

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

578

# found in validMasterVersions returned by getServerConfig. The version can

579

# be upgraded over time; such upgrades are reflected in

580

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

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

[diff] [blame]

581

#

Bu Sun Kim

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

[diff] [blame^]

582

# Users may specify either explicit versions offered by

583

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

584

#

585

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

586

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

587

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

588

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

589

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

590

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

591

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

592

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

593

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

594

# will be automatically chosen with the default size.

595

#

596

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

597

#

598

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

599

#

600

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

605

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

606

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

607

# to use.

Bu Sun Kim

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

[diff] [blame^]

608

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

609

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

610

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

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

[diff] [blame]

611

#

612

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

Bu Sun Kim

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

[diff] [blame^]

613

#

614

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

615

#

616

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

621

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

622

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

623

# to use.

624

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

625

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

626

# addresses. This must be an existing secondary range associated

627

# with the cluster subnetwork.

628

#

629

# This field is only applicable with use_ip_aliases is true and

630

# create_subnetwork is false.

631

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

Bu Sun Kim

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

[diff] [blame]

632

#

633

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

634

#

635

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

636

#

637

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

642

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

643

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

644

# to use.

Bu Sun Kim

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

[diff] [blame^]

645

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

646

# range will be automatically chosen with the default size.

647

#

648

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

649

#

650

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

651

#

652

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

657

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

658

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

659

# to use.

Bu Sun Kim

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

[diff] [blame^]

660

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

661

#

662

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

663

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

664

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

665

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

666

# ClusterIPs. This must be an existing secondary range associated

667

# with the cluster subnetwork.

668

#

669

# This field is only applicable with use_ip_aliases is true and

670

# create_subnetwork is false.

Bu Sun Kim

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

[diff] [blame^]

671

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

672

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

673

# subnetwork.

Bu Sun Kim

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

[diff] [blame]

674

},

Bu Sun Kim

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

[diff] [blame^]

675

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

676

# mode.

677

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

678

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

679

# controllers, will have statically granted permissions beyond those

680

# provided by the RBAC configuration or IAM.

Dan O'Meara

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

[diff] [blame]

681

},

Bu Sun Kim

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

[diff] [blame^]

682

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

Bu Sun Kim

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

[diff] [blame]

683

# disabled when this config is unspecified.

Bu Sun Kim

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

[diff] [blame^]

684

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

Bu Sun Kim

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

[diff] [blame]

685

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

Bu Sun Kim

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

[diff] [blame^]

686

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

687

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

Bu Sun Kim

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

[diff] [blame]

688

# second BigQuery table will be created to hold resource consumption

689

# records.

690

},

Bu Sun Kim

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

[diff] [blame^]

691

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

692

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

Bu Sun Kim

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

[diff] [blame]

693

},

Bu Sun Kim

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

[diff] [blame^]

694

},

695

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

696

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

697

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

698

# cluster's nodes should be located.

699

"A String",

Bu Sun Kim

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

[diff] [blame]

700

],

Bu Sun Kim

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

[diff] [blame^]

701

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

702

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

Sai Cheemalapati

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

[diff] [blame]

703

# specified.

Bu Sun Kim

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

[diff] [blame^]

704

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

705

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

Sai Cheemalapati

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

[diff] [blame]

706

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

707

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

708

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

709

# the workload.

Bu Sun Kim

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

[diff] [blame^]

710

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

711

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

712

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

713

# firewall and routes quota.

714

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

Dan O'Meara

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

[diff] [blame]

715

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

Bu Sun Kim

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

[diff] [blame^]

716

# NodePool's nodes should be located.

717

"A String",

Dan O'Meara

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

[diff] [blame]

718

],

Bu Sun Kim

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

[diff] [blame^]

719

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

720

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

Dan O'Meara

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

[diff] [blame]

721

# disruption caused by an upgrade.

722

#

723

# maxUnavailable controls the number of nodes that can be simultaneously

724

# unavailable.

725

#

726

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

727

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

728

# available nodes.

729

#

730

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

731

# nodes are being upgraded at the same time).

732

#

733

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

734

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

735

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

736

# PodDisruptionBudget, if it is configured.)

737

#

738

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

739

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

740

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

741

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

742

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame^]

743

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

Dan O'Meara

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

[diff] [blame]

744

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

745

# Ready.

Bu Sun Kim

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

[diff] [blame^]

746

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

747

# of the node pool during the upgrade process.

Dan O'Meara

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

[diff] [blame]

748

},

Bu Sun Kim

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

[diff] [blame^]

749

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

750

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

751

# associated with this node pool.

752

"A String",

753

],

754

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

755

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

756

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

757

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

758

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

759

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

760

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

Dan O'Meara

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

[diff] [blame]

761

},

Bu Sun Kim

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

[diff] [blame^]

762

],

763

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

764

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

765

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

Sai Cheemalapati

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

[diff] [blame]

766

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

767

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

768

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame^]

769

"A String",

Sai Cheemalapati

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

[diff] [blame]

770

],

Bu Sun Kim

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

[diff] [blame^]

771

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

772

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

Bu Sun Kim

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

[diff] [blame^]

773

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

774

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

775

# the latest version of it will be used.

776

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

777

# node VMs under the "default" service account.

Sai Cheemalapati

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

[diff] [blame]

778

#

779

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

780

# not included:

781

#

782

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

783

# persistent storage on your nodes.

784

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

785

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

786

# (the [Google Container

787

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

Sai Cheemalapati

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

[diff] [blame]

788

#

789

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

790

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

Bu Sun Kim

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

[diff] [blame^]

791

"A String",

Jon Wayne Parrott

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

[diff] [blame]

792

],

Bu Sun Kim

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

[diff] [blame^]

793

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

Dan O'Meara

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

[diff] [blame]

794

#

795

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

796

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

797

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

798

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

799

#

Bu Sun Kim

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

[diff] [blame^]

800

# See

801

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

802

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

803

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

804

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

805

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

Dan O'Meara

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

[diff] [blame]

806

},

807

],

Bu Sun Kim

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

[diff] [blame^]

808

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

809

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

810

# Kubernetes may apply to the node.

811

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

812

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

813

# and conflicts should be avoided.

814

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

815

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

816

"a_key": "A String",

817

},

818

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

819

# The smallest allowed disk size is 10GB.

820

#

821

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

822

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

823

# workloads on the node pool.

824

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

825

# on the node pool.

826

},

827

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

828

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

829

# support for GPUs.

830

{ # AcceleratorConfig represents a Hardware Accelerator request.

831

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

832

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

833

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

834

},

835

],

836

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

837

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

838

# `n1-standard-1`).

839

#

840

# If unspecified, the default machine type is

841

# `n1-standard-1`.

842

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

843

#

844

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

845

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

846

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

847

#

848

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

849

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

850

# boot process if signature verification fails.

851

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

852

#

853

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

854

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

855

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

856

# the instance is created.

857

},

858

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

859

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

860

# friendly names of CPU platforms, such as

861

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

862

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

863

# information, read [how to specify min CPU

864

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

865

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

866

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

867

# information about preemptible VM instances.

868

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

Sai Cheemalapati

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

[diff] [blame]

869

#

Dan O'Meara

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

[diff] [blame]

870

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

Sai Cheemalapati

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

[diff] [blame]

871

# disks available on a machine per zone. See:

Dan O'Meara

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

[diff] [blame]

872

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

Sai Cheemalapati

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

[diff] [blame]

873

# for more information.

Bu Sun Kim

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

[diff] [blame^]

874

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

875

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

Bu Sun Kim

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

[diff] [blame]

876

},

Bu Sun Kim

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

[diff] [blame^]

877

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

878

#

879

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

880

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

881

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

882

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

888

# "enable-os-login"

889

# "gci-ensure-gke-docker"

890

# "gci-metrics-enabled"

891

# "gci-update-strategy"

892

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

897

# "windows-startup-script-ps1"

898

# "common-psm1"

899

# "k8s-node-setup-psm1"

900

# "install-ssh-psm1"

901

# "user-profile-psm1"

902

# "serial-port-logging-enable"

903

#

904

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

905

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

906

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

907

#

908

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

909

"a_key": "A String",

910

},

911

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

912

# the specified [Zonal Compute

913

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

914

# to this node pool.

915

# is the configuration of desired reservation which instances could take

916

# capacity from.

917

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

918

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

919

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

920

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

921

"A String",

922

],

923

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

924

},

925

},

926

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

927

# simultaneously on a node in the node pool.

928

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

929

},

930

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

931

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

932

# node pool.

933

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

934

# the Auto Upgrades will proceed.

935

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

936

# with the description of the upgrade.

937

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

938

# with the approximate start time for the upgrades, in

939

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

940

},

941

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

942

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

943

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

944

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

945

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

946

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

947

# triggered.

948

},

949

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

Dan O'Meara

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

[diff] [blame]

950

# node pool instance, if available.

Bu Sun Kim

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

[diff] [blame^]

951

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

952

# only if a valid configuration is present.

953

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

954

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

955

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

956

# has to enough quota to scale up the cluster.

957

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

958

# max_node_count.

959

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

960

},

Jon Wayne Parrott

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

[diff] [blame]

961

},

962

],

Bu Sun Kim

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

[diff] [blame^]

963

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

964

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

965

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

966

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

967

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

968

},

969

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

970

# this cluster, in

971

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

972

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

973

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

974

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

975

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

976

# the kubernetes version of the master and nodes.

977

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

978

# Alpha enabled clusters are automatically deleted thirty days after

979

# creation.

980

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

981

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

982

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

983

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

984

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

985

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

986

},

987

],

988

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

989

# Call Kubernetes API directly to retrieve node information.

990

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

Sai Cheemalapati

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

[diff] [blame]

991

# Currently available options:

992

#

Bu Sun Kim

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

[diff] [blame^]

993

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

Dan O'Meara

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

[diff] [blame]

994

# service with a Kubernetes-native resource model

995

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

996

# longer available as of GKE 1.15).

997

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

998

#

999

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

1000

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

Bu Sun Kim

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

[diff] [blame^]

1001

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

1002

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

1003

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

1004

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1005

},

Bu Sun Kim

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

[diff] [blame^]

1006

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

1007

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

1008

# images will be validated by Binary Authorization.

1009

},

1010

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

1011

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

1012

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

1013

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

1014

# policies.

1015

# policies.

1016

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

1017

},

1018

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

1019

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

1020

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

1021

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

1022

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

1023

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

Bu Sun Kim

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

[diff] [blame]

1024

# Currently available options:

1025

#

Dan O'Meara

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

[diff] [blame]

1026

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

1027

# service with a Kubernetes-native resource model

1028

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

1029

# available as of GKE 1.15).

Bu Sun Kim

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

[diff] [blame]

1030

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

Dan O'Meara

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

[diff] [blame]

1031

#

1032

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

1033

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

Bu Sun Kim

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

[diff] [blame^]

1034

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

Sai Cheemalapati

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

[diff] [blame]

1035

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

Bu Sun Kim

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

[diff] [blame^]

1036

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

1037

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

Sai Cheemalapati

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

[diff] [blame]

1038

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

1039

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

Bu Sun Kim

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

[diff] [blame]

1040

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

1041

# `node_pool.config`)

Sai Cheemalapati

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

[diff] [blame]

1042

#

1043

# If unspecified, the defaults are used.

Bu Sun Kim

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

[diff] [blame]

1044

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

Bu Sun Kim

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

[diff] [blame^]

1045

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

Sai Cheemalapati

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

[diff] [blame]

1046

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

1047

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

1048

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame^]

1049

"A String",

Sai Cheemalapati

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

[diff] [blame]

1050

],

Bu Sun Kim

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

[diff] [blame^]

1051

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

1052

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

Bu Sun Kim

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

[diff] [blame^]

1053

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

1054

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

1055

# the latest version of it will be used.

1056

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

1057

# node VMs under the "default" service account.

Sai Cheemalapati

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

[diff] [blame]

1058

#

1059

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

1060

# not included:

1061

#

1062

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

1063

# persistent storage on your nodes.

1064

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

1065

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

1066

# (the [Google Container

1067

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

Sai Cheemalapati

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

[diff] [blame]

1068

#

1069

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

1070

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

Bu Sun Kim

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

[diff] [blame^]

1071

"A String",

Sai Cheemalapati

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

[diff] [blame]

1072

],

Bu Sun Kim

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

[diff] [blame^]

1073

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

Dan O'Meara

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

[diff] [blame]

1074

#

1075

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

1076

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

1077

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

1078

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

1079

#

Bu Sun Kim

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

[diff] [blame^]

1080

# See

1081

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

1082

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

1083

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

1084

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

1085

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

Dan O'Meara

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

[diff] [blame]

1086

},

1087

],

Bu Sun Kim

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

[diff] [blame^]

1088

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

1089

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

1090

# Kubernetes may apply to the node.

1091

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

1092

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

1093

# and conflicts should be avoided.

1094

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

1095

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

1096

"a_key": "A String",

1097

},

1098

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

1099

# The smallest allowed disk size is 10GB.

1100

#

1101

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

1102

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

1103

# workloads on the node pool.

1104

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

1105

# on the node pool.

1106

},

1107

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

1108

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

1109

# support for GPUs.

1110

{ # AcceleratorConfig represents a Hardware Accelerator request.

1111

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

1112

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

1113

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

1114

},

1115

],

1116

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

1117

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

1118

# `n1-standard-1`).

1119

#

1120

# If unspecified, the default machine type is

1121

# `n1-standard-1`.

1122

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

1123

#

1124

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

1125

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

1126

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

1127

#

1128

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

1129

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

1130

# boot process if signature verification fails.

1131

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

1132

#

1133

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

1134

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

1135

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

1136

# the instance is created.

1137

},

1138

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

1139

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

1140

# friendly names of CPU platforms, such as

1141

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

1142

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

1143

# information, read [how to specify min CPU

1144

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

1145

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

1146

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

1147

# information about preemptible VM instances.

1148

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

Sai Cheemalapati

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

[diff] [blame]

1149

#

Dan O'Meara

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

[diff] [blame]

1150

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

Sai Cheemalapati

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

[diff] [blame]

1151

# disks available on a machine per zone. See:

Dan O'Meara

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

[diff] [blame]

1152

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

Sai Cheemalapati

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

[diff] [blame]

1153

# for more information.

Bu Sun Kim

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

[diff] [blame^]

1154

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

1155

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

1156

},

1157

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

1158

#

1159

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

1160

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

1161

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

1162

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1168

# "enable-os-login"

1169

# "gci-ensure-gke-docker"

1170

# "gci-metrics-enabled"

1171

# "gci-update-strategy"

1172

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1177

# "windows-startup-script-ps1"

1178

# "common-psm1"

1179

# "k8s-node-setup-psm1"

1180

# "install-ssh-psm1"

1181

# "user-profile-psm1"

1182

# "serial-port-logging-enable"

1183

#

1184

# Values are free-form strings, and only have meaning as interpreted by

1185

# the image running in the instance. The only restriction placed on them is

1186

# that each value's size must be less than or equal to 32 KB.

1187

#

1188

# The total size of all keys and values must be less than 512 KB.

1189

"a_key": "A String",

1190

},

1191

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

1192

# the specified [Zonal Compute

1193

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

1194

# to this node pool.

1195

# is the configuration of desired reservation which instances could take

1196

# capacity from.

1197

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

1198

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

1199

# the key and specify the name of your reservation as its value.

1200

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1201

"A String",

1202

],

1203

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1204

},

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1205

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1206

"status": "A String", # [Output only] The current status of this cluster.

1207

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

1208

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

1209

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

1210

# cluster is connected. Example:

1211

# projects/my-project/regions/us-central1/subnetworks/my-subnet

1212

"network": "A String", # Output only. The relative name of the Google Compute Engine

1213

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1214

# to which the cluster is connected. Example:

1215

# projects/my-project/global/networks/my-network

1216

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

1217

# This makes same node pod to pod traffic visible for VPC network.

1218

},

1219

"name": "A String", # The name of this cluster. The name must be unique within this project

1220

# and location (e.g. zone or region), and can be up to 40 characters with

1221

# the following restrictions:

1222

#

1223

# * Lowercase letters, numbers, and hyphens only.

1224

# * Must start with a letter.

1225

# * Must end with a number or a letter.

1226

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

1227

# The endpoint can be accessed from the internet at

1228

# `https://username:password@endpoint/`.

1229

#

1230

# See the `masterAuth` property of this resource for username and

1231

# password information.

1232

"location": "A String", # [Output only] The name of the Google Compute Engine

1233

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1234

# or

1235

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1236

# in which the cluster resides.

1237

"createTime": "A String", # [Output only] The time the cluster was created, in

1238

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1239

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1240

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1241

# notation (e.g. `10.96.0.0/14`). Leave blank to have

1242

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1243

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

1244

# required by Cluster Autoscaler to automatically adjust

1245

# the size of the cluster and create/delete

1246

# node pools based on the current needs.

1247

"autoprovisioningLocations": [ # The list of Google Compute Engine

1248

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1249

# NodePool's nodes can be created by NAP.

1250

"A String",

1251

],

1252

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

1253

# amount of resources in the cluster.

1254

{ # Contains information about amount of some resource in the cluster.

1255

# For memory, value should be in GB.

1256

"maximum": "A String", # Maximum amount of the resource in the cluster.

1257

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

1258

"minimum": "A String", # Minimum amount of the resource in the cluster.

1259

},

1260

],

1261

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

1262

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

1263

# created by NAP.

1264

# by NAP.

1265

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

1266

# specified, service_account should be empty.

1267

"A String",

1268

],

1269

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

1270

# node pool.

1271

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

1272

# the Auto Upgrades will proceed.

1273

"description": "A String", # [Output only] This field is set when upgrades are about to commence

1274

# with the description of the upgrade.

1275

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

1276

# with the approximate start time for the upgrades, in

1277

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1278

},

1279

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

1280

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

1281

# up to date with the latest release version of Kubernetes.

1282

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

1283

# pool. If enabled, the nodes in this node pool will be monitored and, if

1284

# they fail health checks too many times, an automatic repair action will be

1285

# triggered.

1286

},

1287

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

1288

# disruption caused by an upgrade.

1289

#

1290

# maxUnavailable controls the number of nodes that can be simultaneously

1291

# unavailable.

1292

#

1293

# maxSurge controls the number of additional nodes that can be added to the

1294

# node pool temporarily for the time of the upgrade to increase the number of

1295

# available nodes.

1296

#

1297

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

1298

# nodes are being upgraded at the same time).

1299

#

1300

# Note: upgrades inevitably introduce some disruption since workloads need to

1301

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

1302

# this holds true. (Disruption stays within the limits of

1303

# PodDisruptionBudget, if it is configured.)

1304

#

1305

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

1306

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

1307

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

1308

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

1309

# there are always at least 4 nodes available.

1310

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

1311

# the upgrade process. A node is considered available if its status is

1312

# Ready.

1313

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

1314

# of the node pool during the upgrade process.

1315

},

1316

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

1317

# service_account is specified, scopes should be empty.

1318

},

1319

},

1320

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

1321

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1322

# is sufficient for this number of instances. You must also have available

1323

# firewall and routes quota.

1324

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1325

# "node_pool" object, since this configuration (along with the

1326

# "node_config") will be used to create a "NodePool" object with an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1327

# auto-generated name. Do not use this and a node_pool at the same time.

1328

#

1329

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1330

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

1331

"A String",

1332

],

1333

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

1334

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

1335

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

1336

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

1337

# given only RFC 1918 private addresses and communicate with the master via

1338

# private networking.

1339

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

1340

# range will be used for assigning internal IP addresses to the master or

1341

# set of masters, as well as the ILB VIP. This range must not overlap with

1342

# any other ranges in use within the cluster's network.

1343

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

1344

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

1345

},

1346

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

1347

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

1348

},

1349

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

1350

# required by Vertical Pod Autoscaler to automatically adjust

1351

# the resources of pods controlled by it.

1352

"enabled": True or False, # Enables vertical pod autoscaling.

1353

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1354

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1355

"zone": "A String", # Deprecated. The name of the Google Compute Engine

1356

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1357

# cluster resides. This field has been deprecated and replaced by the parent

1358

# field.

1359

"parent": "A String", # The parent (project and location) where the cluster will be created.

1360

# Specified in the format `projects/*/locations/*`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1361

}

1362

1363

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1364

Allowed values

1365

1 - v1 error format

1366

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1367

1368

Returns:

1369

An object of the form:

1370

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1371

{ # This operation resource represents operations that may have happened or are

1372

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1373

"name": "A String", # The server-assigned ID for the operation.

1374

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1375

{ # StatusCondition describes why a cluster or a node pool has a certain status

1376

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1377

"message": "A String", # Human-friendly representation of the condition

1378

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1379

},

1380

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1381

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1382

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1383

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1384

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1385

# or

1386

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1387

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1388

"startTime": "A String", # [Output only] The time the operation started, in

1389

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1390

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1391

"stages": [ # Substages of an operation or a stage.

1392

# Object with schema name: OperationProgress

1393

],

1394

"status": "A String", # Status of an operation stage.

1395

# Unset for single-stage operations.

1396

"metrics": [ # Progress metric bundle, for example:

1397

# metrics: [{name: "nodes done", int_value: 15},

1398

# {name: "nodes total", int_value: 32}]

1399

# or

1400

# metrics: [{name: "progress", double_value: 0.56},

1401

# {name: "progress scale", double_value: 1.0}]

1402

{ # Progress metric is (string, int|float|string) pair.

1403

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1404

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1405

"doubleValue": 3.14, # For metrics with floating point value.

1406

"intValue": "A String", # For metrics with integer value.

1407

},

1408

],

1409

"name": "A String", # A non-parameterized string describing an operation stage.

1410

# Unset for single-stage operations.

1411

},

1412

"clusterConditions": [ # Which conditions caused the current cluster state.

1413

{ # StatusCondition describes why a cluster or a node pool has a certain status

1414

# (e.g., ERROR or DEGRADED).

1415

"message": "A String", # Human-friendly representation of the condition

1416

"code": "A String", # Machine-friendly representation of the condition

1417

},

1418

],

1419

"zone": "A String", # The name of the Google Compute Engine

1420

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1421

# operation is taking place. This field is deprecated, use location instead.

1422

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1423

"selfLink": "A String", # Server-defined URL for the resource.

1424

"detail": "A String", # Detailed operation progress, if available.

1425

"targetLink": "A String", # Server-defined URL for the target of the operation.

1426

"operationType": "A String", # The operation type.

1427

"status": "A String", # The current status of the operation.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1432

<code class="details" id="delete">delete(projectId, zone, clusterId, name=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1433

<pre>Deletes the cluster, including the Kubernetes endpoint and all worker

1434

nodes.

1435

1436

Firewalls and routes that were configured during cluster creation

1437

are also deleted.

1438

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1439

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^]

1440

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]

1441

when the cluster was initially created.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1442

1443

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1444

projectId: string, Deprecated. The Google Developers Console [project ID or project

1445

number](https://support.google.com/cloud/answer/6158840).

1446

This field has been deprecated and replaced by the name field. (required)

1447

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1448

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1449

cluster resides. This field has been deprecated and replaced by the name

1450

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1451

clusterId: string, Deprecated. The name of the cluster to delete.

1452

This field has been deprecated and replaced by the name field. (required)

1453

name: string, The name (project, location, cluster) of the cluster to delete.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1454

Specified in the format `projects/*/locations/*/clusters/*`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1455

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1456

Allowed values

1457

1 - v1 error format

1458

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1459

1460

Returns:

1461

An object of the form:

1462

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1463

{ # This operation resource represents operations that may have happened or are

1464

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1465

"name": "A String", # The server-assigned ID for the operation.

1466

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1467

{ # StatusCondition describes why a cluster or a node pool has a certain status

1468

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1469

"message": "A String", # Human-friendly representation of the condition

1470

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1471

},

1472

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1473

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1474

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1475

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1476

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1477

# or

1478

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1479

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1480

"startTime": "A String", # [Output only] The time the operation started, in

1481

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1482

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1483

"stages": [ # Substages of an operation or a stage.

1484

# Object with schema name: OperationProgress

1485

],

1486

"status": "A String", # Status of an operation stage.

1487

# Unset for single-stage operations.

1488

"metrics": [ # Progress metric bundle, for example:

1489

# metrics: [{name: "nodes done", int_value: 15},

1490

# {name: "nodes total", int_value: 32}]

1491

# or

1492

# metrics: [{name: "progress", double_value: 0.56},

1493

# {name: "progress scale", double_value: 1.0}]

1494

{ # Progress metric is (string, int|float|string) pair.

1495

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1496

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1497

"doubleValue": 3.14, # For metrics with floating point value.

1498

"intValue": "A String", # For metrics with integer value.

1499

},

1500

],

1501

"name": "A String", # A non-parameterized string describing an operation stage.

1502

# Unset for single-stage operations.

1503

},

1504

"clusterConditions": [ # Which conditions caused the current cluster state.

1505

{ # StatusCondition describes why a cluster or a node pool has a certain status

1506

# (e.g., ERROR or DEGRADED).

1507

"message": "A String", # Human-friendly representation of the condition

1508

"code": "A String", # Machine-friendly representation of the condition

1509

},

1510

],

1511

"zone": "A String", # The name of the Google Compute Engine

1512

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1513

# operation is taking place. This field is deprecated, use location instead.

1514

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1515

"selfLink": "A String", # Server-defined URL for the resource.

1516

"detail": "A String", # Detailed operation progress, if available.

1517

"targetLink": "A String", # Server-defined URL for the target of the operation.

1518

"operationType": "A String", # The operation type.

1519

"status": "A String", # The current status of the operation.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1524

<code class="details" id="get">get(projectId, zone, clusterId, name=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1525

<pre>Gets the details of a specific cluster.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1526

1527

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1528

projectId: string, Deprecated. The Google Developers Console [project ID or project

1529

number](https://support.google.com/cloud/answer/6158840).

1530

This field has been deprecated and replaced by the name field. (required)

1531

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1532

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1533

cluster resides. This field has been deprecated and replaced by the name

1534

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1535

clusterId: string, Deprecated. The name of the cluster to retrieve.

1536

This field has been deprecated and replaced by the name field. (required)

1537

name: string, The name (project, location, cluster) of the cluster to retrieve.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1538

Specified in the format `projects/*/locations/*/clusters/*`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1539

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1540

Allowed values

1541

1 - v1 error format

1542

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1543

1544

Returns:

1545

An object of the form:

1546

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1547

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1548

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

1549

# simultaneously on a node in the node pool of this cluster. Only honored

1550

# if cluster created with IP Alias support.

1551

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1552

},

1553

"network": "A String", # The name of the Google Compute Engine

1554

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1555

# to which the cluster is connected. If left unspecified, the `default`

1556

# network will be used.

1557

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

1558

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1559

# containers. This is provisioned from within the `container_ipv4_cidr`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1560

# range. This field will only be set when cluster is in route-based network

1561

# mode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1562

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

1563

# master authorized networks will disallow all external traffic to access

1564

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

1565

# Google Compute Engine Public IPs and Google Prod IPs.

1566

"enabled": True or False, # Whether or not master authorized networks is enabled.

1567

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

1568

# Kubernetes master through HTTPS.

1569

{ # CidrBlock contains an optional name and one CIDR block.

1570

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

1571

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

},

],

},

"statusMessage": "A String", # [Output only] Additional information about the current status of this

1576

# cluster, if available.

1577

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

1578

# If unspecified, the defaults are used:

1579

# For clusters before v1.12, if master_auth is unspecified, `username` will

1580

# be set to "admin", a random password will be generated, and a client

1581

# certificate will be issued.

1582

# Authentication can be done using HTTP basic auth or using client

1583

# certificates.

1584

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

1585

# trust for the cluster.

1586

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

1587

# authenticate to the cluster endpoint.

1588

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

1589

# For clusters v1.6.0 and later, basic authentication can be disabled by

1590

# leaving username unspecified (or setting it to the empty string).

1591

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

1592

# Because the master endpoint is open to the Internet, you should create a

1593

# strong password. If a password is provided for cluster creation, username

1594

# must be non-empty.

1595

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

1596

# clusters before v1.12, if no configuration is specified, a client

1597

# certificate is issued.

1598

"issueClientCertificate": True or False, # Issue a client certificate.

1599

},

1600

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

1601

# to the cluster endpoint.

1602

},

1603

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

1604

"enabled": True or False, # Whether this cluster should return group membership lookups

1605

# during authentication using a group of security groups.

1606

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

1607

# if enabled = true.

1608

},

1609

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

1610

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

1611

# cluster, enabling additional functionality.

1612

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

1613

# is enabled or not on the Master, it does not track whether network policy

1614

# is enabled for the nodes.

1615

# is enabled or not on the Master, it does not track whether network policy

1616

# is enabled for the nodes.

1617

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1618

},

1619

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

1620

# managed Knative service.

1621

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1622

},

1623

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

1624

# increases or decreases the number of replica pods a replication controller

1625

# has based on the resource usage of the existing pods.

1626

# increases or decreases the number of replica pods a replication controller

1627

# has based on the resource usage of the existing pods.

1628

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

1629

# When enabled, it ensures that metrics are collected into Stackdriver

1630

# Monitoring.

1631

},

1632

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

1633

# makes it easy to set up HTTP load balancers for services in a cluster.

1634

# which makes it easy to set up HTTP load balancers for services in a cluster.

1635

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

1636

# When enabled, it runs a small pod in the cluster that manages the load

1637

# balancers.

1638

},

1639

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

1640

# This addon is deprecated, and will be disabled in 1.15. It is recommended

1641

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

1642

# workloads and applications. For more information, see:

1643

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

1644

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

1645

},

1646

},

1647

"currentNodeVersion": "A String", # [Output only] Deprecated, use

1648

# [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools)

1649

# instead. The current version of the node software components. If they are

1650

# currently at multiple versions because they're in the process of being

1651

# upgraded, this reflects the minimum version of all nodes.

1652

"subnetwork": "A String", # The name of the Google Compute Engine

1653

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

1654

# the cluster is connected.

1655

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

1656

# Google Compute Engine resources.

1657

"a_key": "A String",

1658

},

1659

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

1660

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

1661

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1662

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

1663

# smallest possible in the given scenario.

1664

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

1665

# format "PTnHnMnS".

1666

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

1667

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

1668

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

1669

},

1670

"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]

1671

# maintenance to occur. The time windows may be overlapping. If no

1672

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1673

"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]

1674

# this window reccurs. They go on for the span of time between the start and

1675

# end time.

1676

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1677

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1678

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

1679

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

1680

# <code>FREQ=DAILY</code>

1681

# For the first weekend of every month:

1682

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

1683

# 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^]

1684

# 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]

1685

# <code>

1686

# start time = 2019-01-01T09:00:00-0400

1687

# end time = 2019-01-01T17:00:00-0400

1688

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

1689

# </code>

1690

# Windows can span multiple days. Eg, to make the window encompass every

1691

# weekend from midnight Saturday till the last minute of Sunday UTC:

1692

# <code>

1693

# start time = 2019-01-05T00:00:00Z

1694

# end time = 2019-01-07T23:59:00Z

1695

# recurrence = FREQ=WEEKLY;BYDAY=SA

1696

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1697

# 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]

1698

# to specify duration of the window and when it first starts.

1699

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1700

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

1701

"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]

1702

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1703

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1704

},

1705

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1706

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1707

# occur in these windows.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1708

"a_key": { # Represents an arbitrary window of time.

1709

"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]

1710

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1711

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1712

},

1713

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1714

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1715

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

1716

# the policy won't accidentally undo intermediate changes (and so that users

1717

# of the API unaware of some fields won't accidentally remove other fields).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1718

# Make a <code>get()</code> request to the cluster to get the current

1719

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1720

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1721

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

1722

# found in validMasterVersions returned by getServerConfig. The version can

1723

# be upgraded over time; such upgrades are reflected in

1724

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1725

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1726

# Users may specify either explicit versions offered by

1727

# Kubernetes Engine or version aliases, which have the following behavior:

1728

#

1729

# - "latest": picks the highest valid Kubernetes version

1730

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

1731

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

1732

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

1733

# - "","-": picks the default Kubernetes version

1734

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

1735

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

1736

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

1737

"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]

1738

# will be automatically chosen with the default size.

1739

#

1740

# This field is only applicable when `use_ip_aliases` is true.

1741

#

1742

# Set to blank to have a range chosen with the default size.

1743

#

1744

# 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)

1749

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1750

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1751

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1752

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1753

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

1754

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1755

#

1756

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1757

#

1758

# Set to blank to have a range chosen with the default size.

1759

#

1760

# Set to /netmask (e.g. `/14`) to have a range chosen with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1765

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1766

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1767

# to use.

1768

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

1769

# block. The secondary range will be used for pod IP

1770

# addresses. This must be an existing secondary range associated

1771

# with the cluster subnetwork.

1772

#

1773

# This field is only applicable with use_ip_aliases is true and

1774

# create_subnetwork is false.

1775

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1776

#

1777

# This is applicable only if `create_subnetwork` is true.

1778

#

1779

# Set to blank to have a range chosen with the default size.

1780

#

1781

# 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)

1786

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1787

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1788

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1789

"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]

1790

# range will be automatically chosen with the default size.

1791

#

1792

# This field is only applicable when `use_ip_aliases` is true.

1793

#

1794

# If unspecified, the range will use the default size.

1795

#

1796

# 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)

1801

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1802

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1803

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1804

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

1805

#

1806

# This field is only applicable when `use_ip_aliases` is true.

1807

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

1808

"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]

1809

# CIDR block. The secondary range will be used for service

1810

# ClusterIPs. This must be an existing secondary range associated

1811

# with the cluster subnetwork.

1812

#

1813

# This field is only applicable with use_ip_aliases is true and

1814

# create_subnetwork is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1815

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

1816

# this field is empty, then an automatic name will be chosen for the new

1817

# subnetwork.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1818

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1819

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

1820

# mode.

1821

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

1822

# identities in the system, including service accounts, nodes, and

1823

# controllers, will have statically granted permissions beyond those

1824

# provided by the RBAC configuration or IAM.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1825

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1826

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1827

# disabled when this config is unspecified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1828

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1829

# daemonset will be created in the cluster to meter network egress traffic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1830

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

1831

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1832

# second BigQuery table will be created to hold resource consumption

1833

# records.

1834

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1835

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

1836

"datasetId": "A String", # The ID of a BigQuery Dataset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1837

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1838

},

1839

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

1840

"locations": [ # The list of Google Compute Engine

1841

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1842

# cluster's nodes should be located.

1843

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1844

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1845

"nodePools": [ # The node pools associated with this cluster.

1846

# This field should not be set if "node_config" or "initial_node_count" are

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1847

# specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1848

{ # NodePool contains the name and configuration for a cluster's node pool.

1849

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1850

# specification, under the control of the cluster master. They may have a set

1851

# of Kubernetes labels applied to them, which may be used to reference them

1852

# during pod scheduling. They may also be resized up or down, to accommodate

1853

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1854

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

1855

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

1856

# is sufficient for this number of instances. You must also have available

1857

# firewall and routes quota.

1858

"locations": [ # The list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1859

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1860

# NodePool's nodes should be located.

1861

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1862

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1863

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1864

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1865

# disruption caused by an upgrade.

1866

#

1867

# maxUnavailable controls the number of nodes that can be simultaneously

1868

# unavailable.

1869

#

1870

# maxSurge controls the number of additional nodes that can be added to the

1871

# node pool temporarily for the time of the upgrade to increase the number of

1872

# available nodes.

1873

#

1874

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

1875

# nodes are being upgraded at the same time).

1876

#

1877

# Note: upgrades inevitably introduce some disruption since workloads need to

1878

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

1879

# this holds true. (Disruption stays within the limits of

1880

# PodDisruptionBudget, if it is configured.)

1881

#

1882

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

1883

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

1884

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

1885

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

1886

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1887

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1888

# the upgrade process. A node is considered available if its status is

1889

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1890

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

1891

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1892

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1893

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

1894

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

1895

# associated with this node pool.

1896

"A String",

1897

],

1898

"version": "A String", # The version of the Kubernetes of this node.

1899

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

1900

"conditions": [ # Which conditions caused the current node pool state.

1901

{ # StatusCondition describes why a cluster or a node pool has a certain status

1902

# (e.g., ERROR or DEGRADED).

1903

"message": "A String", # Human-friendly representation of the condition

1904

"code": "A String", # Machine-friendly representation of the condition

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1905

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1906

],

1907

"status": "A String", # [Output only] The status of the nodes in this pool instance.

1908

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

1909

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1910

# valid sources or targets for network firewalls and are specified by

1911

# the client during cluster or node pool creation. Each tag within the list

1912

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1913

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1914

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1915

"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]

1916

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1917

# Account is specified, the "default" service account is used.

1918

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

1919

# the latest version of it will be used.

1920

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

1921

# node VMs under the "default" service account.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1922

#

1923

# The following scopes are recommended, but not required, and by default are

1924

# not included:

1925

#

1926

# * `https://www.googleapis.com/auth/compute` is required for mounting

1927

# persistent storage on your nodes.

1928

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

1929

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1930

# (the [Google Container

1931

# Registry](https://cloud.google.com/container-registry/)).

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1932

#

1933

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

1934

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1935

"A String",

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1936

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1937

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1938

#

1939

# For more information, including usage and the valid values, see:

1940

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1941

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

1942

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

1943

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1944

# See

1945

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

1946

# for more information, including usage and the valid values.

1947

"key": "A String", # Key for taint.

1948

"value": "A String", # Value for taint.

1949

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1950

},

1951

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1952

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

1953

# These will added in addition to any default label(s) that

1954

# Kubernetes may apply to the node.

1955

# In case of conflict in label keys, the applied set may differ depending on

1956

# the Kubernetes version -- it's best to assume the behavior is undefined

1957

# and conflicts should be avoided.

1958

# For more information, including usage and the valid values, see:

1959

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

1960

"a_key": "A String",

1961

},

1962

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

1963

# The smallest allowed disk size is 10GB.

1964

#

1965

# If unspecified, the default disk size is 100GB.

1966

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

1967

# workloads on the node pool.

1968

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

1969

# on the node pool.

1970

},

1971

"accelerators": [ # A list of hardware accelerators to be attached to each node.

1972

# See https://cloud.google.com/compute/docs/gpus for more information about

1973

# support for GPUs.

1974

{ # AcceleratorConfig represents a Hardware Accelerator request.

1975

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1976

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

1977

# [here](https://cloud.google.com/compute/docs/gpus)

1978

},

1979

],

1980

"machineType": "A String", # The name of a Google Compute Engine [machine

1981

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

1982

# `n1-standard-1`).

1983

#

1984

# If unspecified, the default machine type is

1985

# `n1-standard-1`.

1986

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

1987

#

1988

# If unspecified, the default disk type is 'pd-standard'

1989

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1990

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1991

#

1992

# Secure Boot helps ensure that the system only runs authentic software by

1993

# verifying the digital signature of all boot components, and halting the

1994

# boot process if signature verification fails.

1995

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1996

#

1997

# Enables monitoring and attestation of the boot integrity of the instance.

1998

# The attestation is performed against the integrity policy baseline. This

1999

# baseline is initially derived from the implicitly trusted boot image when

2000

# the instance is created.

2001

},

2002

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2003

# scheduled on the specified or newer CPU platform. Applicable values are the

2004

# friendly names of CPU platforms, such as

2005

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2006

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2007

# information, read [how to specify min CPU

2008

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2009

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2010

# https://cloud.google.com/compute/docs/instances/preemptible for more

2011

# information about preemptible VM instances.

2012

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2013

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2014

# The limit for this value is dependent upon the maximum number of

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2015

# disks available on a machine per zone. See:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2016

# https://cloud.google.com/compute/docs/disks/local-ssd

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2017

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2018

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2019

"type": "A String", # Type of the sandbox to use for the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2020

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2021

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2022

#

2023

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2024

# in length. These are reflected as part of a URL in the metadata server.

2025

# Additionally, to avoid ambiguity, keys must not conflict with any other

2026

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2032

# "enable-os-login"

2033

# "gci-ensure-gke-docker"

2034

# "gci-metrics-enabled"

2035

# "gci-update-strategy"

2036

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2041

# "windows-startup-script-ps1"

2042

# "common-psm1"

2043

# "k8s-node-setup-psm1"

2044

# "install-ssh-psm1"

2045

# "user-profile-psm1"

2046

# "serial-port-logging-enable"

2047

#

2048

# Values are free-form strings, and only have meaning as interpreted by

2049

# the image running in the instance. The only restriction placed on them is

2050

# that each value's size must be less than or equal to 32 KB.

2051

#

2052

# The total size of all keys and values must be less than 512 KB.

2053

"a_key": "A String",

2054

},

2055

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2056

# the specified [Zonal Compute

2057

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2058

# to this node pool.

2059

# is the configuration of desired reservation which instances could take

2060

# capacity from.

2061

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2062

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2063

# the key and specify the name of your reservation as its value.

2064

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2065

"A String",

2066

],

2067

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2068

},

2069

},

2070

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

2071

# simultaneously on a node in the node pool.

2072

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2073

},

2074

"name": "A String", # The name of the node pool.

2075

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

2076

# node pool.

2077

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2078

# the Auto Upgrades will proceed.

2079

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2080

# with the description of the upgrade.

2081

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2082

# with the approximate start time for the upgrades, in

2083

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2084

},

2085

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

2086

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

2087

# up to date with the latest release version of Kubernetes.

2088

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

2089

# pool. If enabled, the nodes in this node pool will be monitored and, if

2090

# they fail health checks too many times, an automatic repair action will be

2091

# triggered.

2092

},

2093

"statusMessage": "A String", # [Output only] Additional information about the current status of this

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2094

# node pool instance, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2095

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

2096

# only if a valid configuration is present.

2097

# adjust the size of the node pool to the current cluster usage.

2098

"enabled": True or False, # Is autoscaling enabled for this node pool.

2099

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

2100

# has to enough quota to scale up the cluster.

2101

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

2102

# max_node_count.

2103

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2104

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2105

},

2106

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2107

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2108

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

2109

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

2110

"provider": "A String", # The selected network policy provider.

2111

"enabled": True or False, # Whether network policy is enabled on the cluster.

2112

},

2113

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

2114

# this cluster, in

2115

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2116

# notation (e.g. `1.2.3.4/29`). Service addresses are

2117

# typically put in the last `/16` from the container CIDR.

2118

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

2119

# API groups (e.g. v1alpha1) and features that may not be production ready in

2120

# the kubernetes version of the master and nodes.

2121

# The cluster has no SLA for uptime and master/node upgrades are disabled.

2122

# Alpha enabled clusters are automatically deleted thirty days after

2123

# creation.

2124

"description": "A String", # An optional description of this cluster.

2125

"conditions": [ # Which conditions caused the current cluster state.

2126

{ # StatusCondition describes why a cluster or a node pool has a certain status

2127

# (e.g., ERROR or DEGRADED).

2128

"message": "A String", # Human-friendly representation of the condition

2129

"code": "A String", # Machine-friendly representation of the condition

2130

},

2131

],

2132

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

2133

# Call Kubernetes API directly to retrieve node information.

2134

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2135

# Currently available options:

2136

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2137

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2138

# service with a Kubernetes-native resource model

2139

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

2140

# longer available as of GKE 1.15).

2141

# * `none` - No metrics will be exported from the cluster.

2142

#

2143

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

2144

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2145

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2146

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

2147

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

2148

"state": "A String", # Denotes the state of etcd encryption.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2149

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2150

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

2151

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

2152

# images will be validated by Binary Authorization.

2153

},

2154

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

2155

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2156

# notation (e.g. `1.2.3.4/29`).

2157

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

2158

# policies.

2159

# policies.

2160

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

2161

},

2162

"zone": "A String", # [Output only] The name of the Google Compute Engine

2163

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2164

# cluster resides. This field is deprecated, use location instead.

2165

"expireTime": "A String", # [Output only] The time the cluster will be automatically

2166

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2167

"loggingService": "A String", # The logging service the cluster should use to write logs.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2168

# Currently available options:

2169

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2170

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

2171

# service with a Kubernetes-native resource model

2172

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

2173

# available as of GKE 1.15).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2174

# * `none` - no logs will be exported from the cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2175

#

2176

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

2177

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2178

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2179

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2180

# "node_pool" object, since this configuration (along with the

2181

# "initial_node_count") will be used to create a "NodePool" object with an

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2182

# auto-generated name. Do not use this and a node_pool at the same time.

2183

# For responses, this field will be populated with the node configuration of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2184

# the first node pool. (For configuration of each node pool, see

2185

# `node_pool.config`)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2186

#

2187

# If unspecified, the defaults are used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2188

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2189

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2190

# valid sources or targets for network firewalls and are specified by

2191

# the client during cluster or node pool creation. Each tag within the list

2192

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2193

"A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2194

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2195

"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]

2196

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2197

# Account is specified, the "default" service account is used.

2198

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2199

# the latest version of it will be used.

2200

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2201

# node VMs under the "default" service account.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2202

#

2203

# The following scopes are recommended, but not required, and by default are

2204

# not included:

2205

#

2206

# * `https://www.googleapis.com/auth/compute` is required for mounting

2207

# persistent storage on your nodes.

2208

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2209

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2210

# (the [Google Container

2211

# Registry](https://cloud.google.com/container-registry/)).

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2212

#

2213

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2214

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2215

"A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2216

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2217

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2218

#

2219

# For more information, including usage and the valid values, see:

2220

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2221

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2222

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2223

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2224

# See

2225

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2226

# for more information, including usage and the valid values.

2227

"key": "A String", # Key for taint.

2228

"value": "A String", # Value for taint.

2229

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2230

},

2231

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2232

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2233

# These will added in addition to any default label(s) that

2234

# Kubernetes may apply to the node.

2235

# In case of conflict in label keys, the applied set may differ depending on

2236

# the Kubernetes version -- it's best to assume the behavior is undefined

2237

# and conflicts should be avoided.

2238

# For more information, including usage and the valid values, see:

2239

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2240

"a_key": "A String",

2241

},

2242

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2243

# The smallest allowed disk size is 10GB.

2244

#

2245

# If unspecified, the default disk size is 100GB.

2246

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2247

# workloads on the node pool.

2248

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2249

# on the node pool.

2250

},

2251

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2252

# See https://cloud.google.com/compute/docs/gpus for more information about

2253

# support for GPUs.

2254

{ # AcceleratorConfig represents a Hardware Accelerator request.

2255

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2256

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2257

# [here](https://cloud.google.com/compute/docs/gpus)

2258

},

2259

],

2260

"machineType": "A String", # The name of a Google Compute Engine [machine

2261

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2262

# `n1-standard-1`).

2263

#

2264

# If unspecified, the default machine type is

2265

# `n1-standard-1`.

2266

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2267

#

2268

# If unspecified, the default disk type is 'pd-standard'

2269

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2270

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2271

#

2272

# Secure Boot helps ensure that the system only runs authentic software by

2273

# verifying the digital signature of all boot components, and halting the

2274

# boot process if signature verification fails.

2275

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2276

#

2277

# Enables monitoring and attestation of the boot integrity of the instance.

2278

# The attestation is performed against the integrity policy baseline. This

2279

# baseline is initially derived from the implicitly trusted boot image when

2280

# the instance is created.

2281

},

2282

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2283

# scheduled on the specified or newer CPU platform. Applicable values are the

2284

# friendly names of CPU platforms, such as

2285

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2286

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2287

# information, read [how to specify min CPU

2288

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2289

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2290

# https://cloud.google.com/compute/docs/instances/preemptible for more

2291

# information about preemptible VM instances.

2292

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2293

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2294

# The limit for this value is dependent upon the maximum number of

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2295

# disks available on a machine per zone. See:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2296

# https://cloud.google.com/compute/docs/disks/local-ssd

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2297

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2298

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2299

"type": "A String", # Type of the sandbox to use for the node.

2300

},

2301

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2302

#

2303

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2304

# in length. These are reflected as part of a URL in the metadata server.

2305

# Additionally, to avoid ambiguity, keys must not conflict with any other

2306

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2312

# "enable-os-login"

2313

# "gci-ensure-gke-docker"

2314

# "gci-metrics-enabled"

2315

# "gci-update-strategy"

2316

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2321

# "windows-startup-script-ps1"

2322

# "common-psm1"

2323

# "k8s-node-setup-psm1"

2324

# "install-ssh-psm1"

2325

# "user-profile-psm1"

2326

# "serial-port-logging-enable"

2327

#

2328

# Values are free-form strings, and only have meaning as interpreted by

2329

# the image running in the instance. The only restriction placed on them is

2330

# that each value's size must be less than or equal to 32 KB.

2331

#

2332

# The total size of all keys and values must be less than 512 KB.

2333

"a_key": "A String",

2334

},

2335

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2336

# the specified [Zonal Compute

2337

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2338

# to this node pool.

2339

# is the configuration of desired reservation which instances could take

2340

# capacity from.

2341

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2342

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2343

# the key and specify the name of your reservation as its value.

2344

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2345

"A String",

2346

],

2347

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2348

},

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2349

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2350

"status": "A String", # [Output only] The current status of this cluster.

2351

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

2352

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

2353

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

2354

# cluster is connected. Example:

2355

# projects/my-project/regions/us-central1/subnetworks/my-subnet

2356

"network": "A String", # Output only. The relative name of the Google Compute Engine

2357

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2358

# to which the cluster is connected. Example:

2359

# projects/my-project/global/networks/my-network

2360

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

2361

# This makes same node pod to pod traffic visible for VPC network.

2362

},

2363

"name": "A String", # The name of this cluster. The name must be unique within this project

2364

# and location (e.g. zone or region), and can be up to 40 characters with

2365

# the following restrictions:

2366

#

2367

# * Lowercase letters, numbers, and hyphens only.

2368

# * Must start with a letter.

2369

# * Must end with a number or a letter.

2370

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

2371

# The endpoint can be accessed from the internet at

2372

# `https://username:password@endpoint/`.

2373

#

2374

# See the `masterAuth` property of this resource for username and

2375

# password information.

2376

"location": "A String", # [Output only] The name of the Google Compute Engine

2377

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2378

# or

2379

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2380

# in which the cluster resides.

2381

"createTime": "A String", # [Output only] The time the cluster was created, in

2382

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2383

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2384

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2385

# notation (e.g. `10.96.0.0/14`). Leave blank to have

2386

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2387

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

2388

# required by Cluster Autoscaler to automatically adjust

2389

# the size of the cluster and create/delete

2390

# node pools based on the current needs.

2391

"autoprovisioningLocations": [ # The list of Google Compute Engine

2392

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2393

# NodePool's nodes can be created by NAP.

2394

"A String",

2395

],

2396

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

2397

# amount of resources in the cluster.

2398

{ # Contains information about amount of some resource in the cluster.

2399

# For memory, value should be in GB.

2400

"maximum": "A String", # Maximum amount of the resource in the cluster.

2401

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

2402

"minimum": "A String", # Minimum amount of the resource in the cluster.

2403

},

2404

],

2405

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

2406

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

2407

# created by NAP.

2408

# by NAP.

2409

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

2410

# specified, service_account should be empty.

2411

"A String",

2412

],

2413

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

2414

# node pool.

2415

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2416

# the Auto Upgrades will proceed.

2417

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2418

# with the description of the upgrade.

2419

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2420

# with the approximate start time for the upgrades, in

2421

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2422

},

2423

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

2424

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

2425

# up to date with the latest release version of Kubernetes.

2426

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

2427

# pool. If enabled, the nodes in this node pool will be monitored and, if

2428

# they fail health checks too many times, an automatic repair action will be

2429

# triggered.

2430

},

2431

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

2432

# disruption caused by an upgrade.

2433

#

2434

# maxUnavailable controls the number of nodes that can be simultaneously

2435

# unavailable.

2436

#

2437

# maxSurge controls the number of additional nodes that can be added to the

2438

# node pool temporarily for the time of the upgrade to increase the number of

2439

# available nodes.

2440

#

2441

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2442

# nodes are being upgraded at the same time).

2443

#

2444

# Note: upgrades inevitably introduce some disruption since workloads need to

2445

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2446

# this holds true. (Disruption stays within the limits of

2447

# PodDisruptionBudget, if it is configured.)

2448

#

2449

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2450

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2451

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2452

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2453

# there are always at least 4 nodes available.

2454

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2455

# the upgrade process. A node is considered available if its status is

2456

# Ready.

2457

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2458

# of the node pool during the upgrade process.

2459

},

2460

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

2461

# service_account is specified, scopes should be empty.

2462

},

2463

},

2464

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

2465

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2466

# is sufficient for this number of instances. You must also have available

2467

# firewall and routes quota.

2468

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2469

# "node_pool" object, since this configuration (along with the

2470

# "node_config") will be used to create a "NodePool" object with an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2471

# auto-generated name. Do not use this and a node_pool at the same time.

2472

#

2473

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2474

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

2475

"A String",

2476

],

2477

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

2478

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

2479

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

2480

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

2481

# given only RFC 1918 private addresses and communicate with the master via

2482

# private networking.

2483

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

2484

# range will be used for assigning internal IP addresses to the master or

2485

# set of masters, as well as the ILB VIP. This range must not overlap with

2486

# any other ranges in use within the cluster's network.

2487

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

2488

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

2489

},

2490

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

2491

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

2492

},

2493

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

2494

# required by Vertical Pod Autoscaler to automatically adjust

2495

# the resources of pods controlled by it.

2496

"enabled": True or False, # Enables vertical pod autoscaling.

2497

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2502

<code class="details" id="legacyAbac">legacyAbac(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2503

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2504

2505

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2506

projectId: string, Deprecated. The Google Developers Console [project ID or project

2507

number](https://support.google.com/cloud/answer/6158840).

2508

This field has been deprecated and replaced by the name field. (required)

2509

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2510

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

2511

cluster resides. This field has been deprecated and replaced by the name

2512

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2513

clusterId: string, Deprecated. The name of the cluster to update.

2514

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2515

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2516

The object takes the form of:

2517

2518

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for

2519

# a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2520

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac.

2521

# Specified in the format `projects/*/locations/*/clusters/*`.

2522

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

2523

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2524

# number](https://support.google.com/cloud/answer/6158840).

2525

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2526

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2527

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2528

# cluster resides. This field has been deprecated and replaced by the name

2529

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2530

"clusterId": "A String", # Deprecated. The name of the cluster to update.

2531

# This field has been deprecated and replaced by the name field.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2532

}

2533

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2534

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2541

2542

{ # This operation resource represents operations that may have happened or are

2543

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2544

"name": "A String", # The server-assigned ID for the operation.

2545

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2546

{ # StatusCondition describes why a cluster or a node pool has a certain status

2547

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2548

"message": "A String", # Human-friendly representation of the condition

2549

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2550

},

2551

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2552

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2553

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2554

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2555

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2556

# or

2557

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2558

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2559

"startTime": "A String", # [Output only] The time the operation started, in

2560

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2561

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2562

"stages": [ # Substages of an operation or a stage.

2563

# Object with schema name: OperationProgress

2564

],

2565

"status": "A String", # Status of an operation stage.

2566

# Unset for single-stage operations.

2567

"metrics": [ # Progress metric bundle, for example:

2568

# metrics: [{name: "nodes done", int_value: 15},

2569

# {name: "nodes total", int_value: 32}]

2570

# or

2571

# metrics: [{name: "progress", double_value: 0.56},

2572

# {name: "progress scale", double_value: 1.0}]

2573

{ # Progress metric is (string, int|float|string) pair.

2574

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2575

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2576

"doubleValue": 3.14, # For metrics with floating point value.

2577

"intValue": "A String", # For metrics with integer value.

2578

},

2579

],

2580

"name": "A String", # A non-parameterized string describing an operation stage.

2581

# Unset for single-stage operations.

2582

},

2583

"clusterConditions": [ # Which conditions caused the current cluster state.

2584

{ # StatusCondition describes why a cluster or a node pool has a certain status

2585

# (e.g., ERROR or DEGRADED).

2586

"message": "A String", # Human-friendly representation of the condition

2587

"code": "A String", # Machine-friendly representation of the condition

2588

},

2589

],

2590

"zone": "A String", # The name of the Google Compute Engine

2591

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2592

# operation is taking place. This field is deprecated, use location instead.

2593

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

2594

"selfLink": "A String", # Server-defined URL for the resource.

2595

"detail": "A String", # Detailed operation progress, if available.

2596

"targetLink": "A String", # Server-defined URL for the target of the operation.

2597

"operationType": "A String", # The operation type.

2598

"status": "A String", # The current status of the operation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2603

<code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2604

<pre>Lists all clusters owned by a project in either the specified zone or all

2605

zones.

2606

2607

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2608

projectId: string, Deprecated. The Google Developers Console [project ID or project

2609

number](https://support.google.com/cloud/answer/6158840).

2610

This field has been deprecated and replaced by the parent field. (required)

2611

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2612

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2613

cluster resides, or "-" for all zones. This field has been deprecated and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2614

replaced by the parent field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2615

parent: string, The parent (project and location) where the clusters will be listed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2616

Specified in the format `projects/*/locations/*`.

2617

Location "-" matches all zones and all regions.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2618

x__xgafv: string, V1 error format.

2619

Allowed values

2620

1 - v1 error format

2621

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2622

2623

Returns:

2624

An object of the form:

2625

2626

{ # ListClustersResponse is the result of ListClustersRequest.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2627

"clusters": [ # A list of clusters in the project in the specified zone, or

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2628

# across all ones.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2629

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2630

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

2631

# simultaneously on a node in the node pool of this cluster. Only honored

2632

# if cluster created with IP Alias support.

2633

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2634

},

2635

"network": "A String", # The name of the Google Compute Engine

2636

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2637

# to which the cluster is connected. If left unspecified, the `default`

2638

# network will be used.

2639

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

2640

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2641

# containers. This is provisioned from within the `container_ipv4_cidr`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2642

# range. This field will only be set when cluster is in route-based network

2643

# mode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2644

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

2645

# master authorized networks will disallow all external traffic to access

2646

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

2647

# Google Compute Engine Public IPs and Google Prod IPs.

2648

"enabled": True or False, # Whether or not master authorized networks is enabled.

2649

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

2650

# Kubernetes master through HTTPS.

2651

{ # CidrBlock contains an optional name and one CIDR block.

2652

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

2653

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

},

],

},

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2658

# cluster, if available.

2659

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

2660

# If unspecified, the defaults are used:

2661

# For clusters before v1.12, if master_auth is unspecified, `username` will

2662

# be set to "admin", a random password will be generated, and a client

2663

# certificate will be issued.

2664

# Authentication can be done using HTTP basic auth or using client

2665

# certificates.

2666

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

2667

# trust for the cluster.

2668

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

2669

# authenticate to the cluster endpoint.

2670

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

2671

# For clusters v1.6.0 and later, basic authentication can be disabled by

2672

# leaving username unspecified (or setting it to the empty string).

2673

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

2674

# Because the master endpoint is open to the Internet, you should create a

2675

# strong password. If a password is provided for cluster creation, username

2676

# must be non-empty.

2677

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

2678

# clusters before v1.12, if no configuration is specified, a client

2679

# certificate is issued.

2680

"issueClientCertificate": True or False, # Issue a client certificate.

2681

},

2682

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

2683

# to the cluster endpoint.

2684

},

2685

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

2686

"enabled": True or False, # Whether this cluster should return group membership lookups

2687

# during authentication using a group of security groups.

2688

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

2689

# if enabled = true.

2690

},

2691

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

2692

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

2693

# cluster, enabling additional functionality.

2694

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

2695

# is enabled or not on the Master, it does not track whether network policy

2696

# is enabled for the nodes.

2697

# is enabled or not on the Master, it does not track whether network policy

2698

# is enabled for the nodes.

2699

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

2700

},

2701

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

2702

# managed Knative service.

2703

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2704

},

2705

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

2706

# increases or decreases the number of replica pods a replication controller

2707

# has based on the resource usage of the existing pods.

2708

# increases or decreases the number of replica pods a replication controller

2709

# has based on the resource usage of the existing pods.

2710

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

2711

# When enabled, it ensures that metrics are collected into Stackdriver

2712

# Monitoring.

2713

},

2714

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

2715

# makes it easy to set up HTTP load balancers for services in a cluster.

2716

# which makes it easy to set up HTTP load balancers for services in a cluster.

2717

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

2718

# When enabled, it runs a small pod in the cluster that manages the load

2719

# balancers.

2720

},

2721

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

2722

# This addon is deprecated, and will be disabled in 1.15. It is recommended

2723

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

2724

# workloads and applications. For more information, see:

2725

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

2726

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

2727

},

2728

},

2729

"currentNodeVersion": "A String", # [Output only] Deprecated, use

2730

# [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools)

2731

# instead. The current version of the node software components. If they are

2732

# currently at multiple versions because they're in the process of being

2733

# upgraded, this reflects the minimum version of all nodes.

2734

"subnetwork": "A String", # The name of the Google Compute Engine

2735

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

2736

# the cluster is connected.

2737

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

2738

# Google Compute Engine resources.

2739

"a_key": "A String",

2740

},

2741

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

2742

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

2743

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

2744

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

2745

# smallest possible in the given scenario.

2746

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

2747

# format "PTnHnMnS".

2748

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

2749

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

2750

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

2751

},

2752

"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]

2753

# maintenance to occur. The time windows may be overlapping. If no

2754

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2755

"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]

2756

# this window reccurs. They go on for the span of time between the start and

2757

# end time.

2758

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2759

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2760

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

2761

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

2762

# <code>FREQ=DAILY</code>

2763

# For the first weekend of every month:

2764

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

2765

# 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^]

2766

# 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]

2767

# <code>

2768

# start time = 2019-01-01T09:00:00-0400

2769

# end time = 2019-01-01T17:00:00-0400

2770

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

2771

# </code>

2772

# Windows can span multiple days. Eg, to make the window encompass every

2773

# weekend from midnight Saturday till the last minute of Sunday UTC:

2774

# <code>

2775

# start time = 2019-01-05T00:00:00Z

2776

# end time = 2019-01-07T23:59:00Z

2777

# recurrence = FREQ=WEEKLY;BYDAY=SA

2778

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2779

# 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]

2780

# to specify duration of the window and when it first starts.

2781

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2782

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

2783

"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]

2784

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2785

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2786

},

2787

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2788

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2789

# occur in these windows.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2790

"a_key": { # Represents an arbitrary window of time.

2791

"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]

2792

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2793

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2794

},

2795

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2796

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2797

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

2798

# the policy won't accidentally undo intermediate changes (and so that users

2799

# of the API unaware of some fields won't accidentally remove other fields).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2800

# Make a <code>get()</code> request to the cluster to get the current

2801

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2802

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2803

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

2804

# found in validMasterVersions returned by getServerConfig. The version can

2805

# be upgraded over time; such upgrades are reflected in

2806

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2807

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2808

# Users may specify either explicit versions offered by

2809

# Kubernetes Engine or version aliases, which have the following behavior:

2810

#

2811

# - "latest": picks the highest valid Kubernetes version

2812

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

2813

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

2814

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

2815

# - "","-": picks the default Kubernetes version

2816

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

2817

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

2818

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

2819

"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]

2820

# will be automatically chosen with the default size.

2821

#

2822

# This field is only applicable when `use_ip_aliases` is true.

2823

#

2824

# Set to blank to have a range chosen with the default size.

2825

#

2826

# 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)

2831

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2832

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2833

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2834

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

2835

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

2836

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2837

#

2838

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2839

#

2840

# Set to blank to have a range chosen with the default size.

2841

#

2842

# 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)

2847

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2848

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2849

# to use.

2850

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

2851

# block. The secondary range will be used for pod IP

2852

# addresses. This must be an existing secondary range associated

2853

# with the cluster subnetwork.

2854

#

2855

# This field is only applicable with use_ip_aliases is true and

2856

# create_subnetwork is false.

2857

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2858

#

2859

# This is applicable only if `create_subnetwork` is true.

2860

#

2861

# Set to blank to have a range chosen with the default size.

2862

#

2863

# 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)

2868

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2869

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2870

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2871

"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]

2872

# range will be automatically chosen with the default size.

2873

#

2874

# This field is only applicable when `use_ip_aliases` is true.

2875

#

2876

# If unspecified, the range will use the default size.

2877

#

2878

# 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)

2883

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2884

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2885

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2886

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

2887

#

2888

# This field is only applicable when `use_ip_aliases` is true.

2889

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

2890

"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]

2891

# CIDR block. The secondary range will be used for service

2892

# ClusterIPs. This must be an existing secondary range associated

2893

# with the cluster subnetwork.

2894

#

2895

# This field is only applicable with use_ip_aliases is true and

2896

# create_subnetwork is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2897

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

2898

# this field is empty, then an automatic name will be chosen for the new

2899

# subnetwork.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2900

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2901

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

2902

# mode.

2903

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

2904

# identities in the system, including service accounts, nodes, and

2905

# controllers, will have statically granted permissions beyond those

2906

# provided by the RBAC configuration or IAM.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2907

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2908

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2909

# disabled when this config is unspecified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2910

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2911

# daemonset will be created in the cluster to meter network egress traffic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2912

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

2913

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2914

# second BigQuery table will be created to hold resource consumption

2915

# records.

2916

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2917

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2918

"datasetId": "A String", # The ID of a BigQuery Dataset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2919

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2920

},

2921

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

2922

"locations": [ # The list of Google Compute Engine

2923

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2924

# cluster's nodes should be located.

2925

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2926

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2927

"nodePools": [ # The node pools associated with this cluster.

2928

# This field should not be set if "node_config" or "initial_node_count" are

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2929

# specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2930

{ # NodePool contains the name and configuration for a cluster's node pool.

2931

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2932

# specification, under the control of the cluster master. They may have a set

2933

# of Kubernetes labels applied to them, which may be used to reference them

2934

# during pod scheduling. They may also be resized up or down, to accommodate

2935

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2936

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

2937

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

2938

# is sufficient for this number of instances. You must also have available

2939

# firewall and routes quota.

2940

"locations": [ # The list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2941

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2942

# NodePool's nodes should be located.

2943

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2944

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2945

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2946

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2947

# disruption caused by an upgrade.

2948

#

2949

# maxUnavailable controls the number of nodes that can be simultaneously

2950

# unavailable.

2951

#

2952

# maxSurge controls the number of additional nodes that can be added to the

2953

# node pool temporarily for the time of the upgrade to increase the number of

2954

# available nodes.

2955

#

2956

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2957

# nodes are being upgraded at the same time).

2958

#

2959

# Note: upgrades inevitably introduce some disruption since workloads need to

2960

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2961

# this holds true. (Disruption stays within the limits of

2962

# PodDisruptionBudget, if it is configured.)

2963

#

2964

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2965

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2966

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2967

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2968

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2969

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2970

# the upgrade process. A node is considered available if its status is

2971

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2972

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2973

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2974

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2975

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

2976

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

2977

# associated with this node pool.

2978

"A String",

2979

],

2980

"version": "A String", # The version of the Kubernetes of this node.

2981

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

2982

"conditions": [ # Which conditions caused the current node pool state.

2983

{ # StatusCondition describes why a cluster or a node pool has a certain status

2984

# (e.g., ERROR or DEGRADED).

2985

"message": "A String", # Human-friendly representation of the condition

2986

"code": "A String", # Machine-friendly representation of the condition

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2987

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2988

],

2989

"status": "A String", # [Output only] The status of the nodes in this pool instance.

2990

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

2991

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2992

# valid sources or targets for network firewalls and are specified by

2993

# the client during cluster or node pool creation. Each tag within the list

2994

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2995

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2996

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2997

"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]

2998

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2999

# Account is specified, the "default" service account is used.

3000

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3001

# the latest version of it will be used.

3002

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3003

# node VMs under the "default" service account.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3004

#

3005

# The following scopes are recommended, but not required, and by default are

3006

# not included:

3007

#

3008

# * `https://www.googleapis.com/auth/compute` is required for mounting

3009

# persistent storage on your nodes.

3010

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3011

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3012

# (the [Google Container

3013

# Registry](https://cloud.google.com/container-registry/)).

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3014

#

3015

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3016

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3017

"A String",

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

3018

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3019

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3020

#

3021

# For more information, including usage and the valid values, see:

3022

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3023

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3024

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3025

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3026

# See

3027

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3028

# for more information, including usage and the valid values.

3029

"key": "A String", # Key for taint.

3030

"value": "A String", # Value for taint.

3031

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3032

},

3033

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3034

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3035

# These will added in addition to any default label(s) that

3036

# Kubernetes may apply to the node.

3037

# In case of conflict in label keys, the applied set may differ depending on

3038

# the Kubernetes version -- it's best to assume the behavior is undefined

3039

# and conflicts should be avoided.

3040

# For more information, including usage and the valid values, see:

3041

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3042

"a_key": "A String",

3043

},

3044

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3045

# The smallest allowed disk size is 10GB.

3046

#

3047

# If unspecified, the default disk size is 100GB.

3048

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3049

# workloads on the node pool.

3050

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3051

# on the node pool.

3052

},

3053

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3054

# See https://cloud.google.com/compute/docs/gpus for more information about

3055

# support for GPUs.

3056

{ # AcceleratorConfig represents a Hardware Accelerator request.

3057

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3058

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3059

# [here](https://cloud.google.com/compute/docs/gpus)

3060

},

3061

],

3062

"machineType": "A String", # The name of a Google Compute Engine [machine

3063

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3064

# `n1-standard-1`).

3065

#

3066

# If unspecified, the default machine type is

3067

# `n1-standard-1`.

3068

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3069

#

3070

# If unspecified, the default disk type is 'pd-standard'

3071

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3072

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3073

#

3074

# Secure Boot helps ensure that the system only runs authentic software by

3075

# verifying the digital signature of all boot components, and halting the

3076

# boot process if signature verification fails.

3077

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3078

#

3079

# Enables monitoring and attestation of the boot integrity of the instance.

3080

# The attestation is performed against the integrity policy baseline. This

3081

# baseline is initially derived from the implicitly trusted boot image when

3082

# the instance is created.

3083

},

3084

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3085

# scheduled on the specified or newer CPU platform. Applicable values are the

3086

# friendly names of CPU platforms, such as

3087

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3088

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3089

# information, read [how to specify min CPU

3090

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3091

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3092

# https://cloud.google.com/compute/docs/instances/preemptible for more

3093

# information about preemptible VM instances.

3094

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3095

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3096

# The limit for this value is dependent upon the maximum number of

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3097

# disks available on a machine per zone. See:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3098

# https://cloud.google.com/compute/docs/disks/local-ssd

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3099

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3100

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3101

"type": "A String", # Type of the sandbox to use for the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3102

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3103

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3104

#

3105

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3106

# in length. These are reflected as part of a URL in the metadata server.

3107

# Additionally, to avoid ambiguity, keys must not conflict with any other

3108

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3114

# "enable-os-login"

3115

# "gci-ensure-gke-docker"

3116

# "gci-metrics-enabled"

3117

# "gci-update-strategy"

3118

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3123

# "windows-startup-script-ps1"

3124

# "common-psm1"

3125

# "k8s-node-setup-psm1"

3126

# "install-ssh-psm1"

3127

# "user-profile-psm1"

3128

# "serial-port-logging-enable"

3129

#

3130

# Values are free-form strings, and only have meaning as interpreted by

3131

# the image running in the instance. The only restriction placed on them is

3132

# that each value's size must be less than or equal to 32 KB.

3133

#

3134

# The total size of all keys and values must be less than 512 KB.

3135

"a_key": "A String",

3136

},

3137

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3138

# the specified [Zonal Compute

3139

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3140

# to this node pool.

3141

# is the configuration of desired reservation which instances could take

3142

# capacity from.

3143

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3144

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3145

# the key and specify the name of your reservation as its value.

3146

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3147

"A String",

3148

],

3149

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3150

},

3151

},

3152

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

3153

# simultaneously on a node in the node pool.

3154

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

3155

},

3156

"name": "A String", # The name of the node pool.

3157

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

3158

# node pool.

3159

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3160

# the Auto Upgrades will proceed.

3161

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3162

# with the description of the upgrade.

3163

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3164

# with the approximate start time for the upgrades, in

3165

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3166

},

3167

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

3168

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

3169

# up to date with the latest release version of Kubernetes.

3170

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

3171

# pool. If enabled, the nodes in this node pool will be monitored and, if

3172

# they fail health checks too many times, an automatic repair action will be

3173

# triggered.

3174

},

3175

"statusMessage": "A String", # [Output only] Additional information about the current status of this

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3176

# node pool instance, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3177

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

3178

# only if a valid configuration is present.

3179

# adjust the size of the node pool to the current cluster usage.

3180

"enabled": True or False, # Is autoscaling enabled for this node pool.

3181

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

3182

# has to enough quota to scale up the cluster.

3183

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

3184

# max_node_count.

3185

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

3186

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

3187

},

3188

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3189

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

3190

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

3191

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

3192

"provider": "A String", # The selected network policy provider.

3193

"enabled": True or False, # Whether network policy is enabled on the cluster.

3194

},

3195

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

3196

# this cluster, in

3197

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3198

# notation (e.g. `1.2.3.4/29`). Service addresses are

3199

# typically put in the last `/16` from the container CIDR.

3200

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

3201

# API groups (e.g. v1alpha1) and features that may not be production ready in

3202

# the kubernetes version of the master and nodes.

3203

# The cluster has no SLA for uptime and master/node upgrades are disabled.

3204

# Alpha enabled clusters are automatically deleted thirty days after

3205

# creation.

3206

"description": "A String", # An optional description of this cluster.

3207

"conditions": [ # Which conditions caused the current cluster state.

3208

{ # StatusCondition describes why a cluster or a node pool has a certain status

3209

# (e.g., ERROR or DEGRADED).

3210

"message": "A String", # Human-friendly representation of the condition

3211

"code": "A String", # Machine-friendly representation of the condition

3212

},

3213

],

3214

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

3215

# Call Kubernetes API directly to retrieve node information.

3216

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3217

# Currently available options:

3218

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3219

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3220

# service with a Kubernetes-native resource model

3221

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

3222

# longer available as of GKE 1.15).

3223

# * `none` - No metrics will be exported from the cluster.

3224

#

3225

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

3226

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3227

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

3228

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

3229

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

3230

"state": "A String", # Denotes the state of etcd encryption.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

3231

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3232

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

3233

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

3234

# images will be validated by Binary Authorization.

3235

},

3236

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

3237

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3238

# notation (e.g. `1.2.3.4/29`).

3239

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

3240

# policies.

3241

# policies.

3242

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

3243

},

3244

"zone": "A String", # [Output only] The name of the Google Compute Engine

3245

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3246

# cluster resides. This field is deprecated, use location instead.

3247

"expireTime": "A String", # [Output only] The time the cluster will be automatically

3248

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3249

"loggingService": "A String", # The logging service the cluster should use to write logs.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3250

# Currently available options:

3251

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3252

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

3253

# service with a Kubernetes-native resource model

3254

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

3255

# available as of GKE 1.15).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3256

# * `none` - no logs will be exported from the cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3257

#

3258

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

3259

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3260

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3261

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3262

# "node_pool" object, since this configuration (along with the

3263

# "initial_node_count") will be used to create a "NodePool" object with an

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3264

# auto-generated name. Do not use this and a node_pool at the same time.

3265

# For responses, this field will be populated with the node configuration of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3266

# the first node pool. (For configuration of each node pool, see

3267

# `node_pool.config`)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3268

#

3269

# If unspecified, the defaults are used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3270

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3271

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3272

# valid sources or targets for network firewalls and are specified by

3273

# the client during cluster or node pool creation. Each tag within the list

3274

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3275

"A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3276

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3277

"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]

3278

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3279

# Account is specified, the "default" service account is used.

3280

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3281

# the latest version of it will be used.

3282

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3283

# node VMs under the "default" service account.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3284

#

3285

# The following scopes are recommended, but not required, and by default are

3286

# not included:

3287

#

3288

# * `https://www.googleapis.com/auth/compute` is required for mounting

3289

# persistent storage on your nodes.

3290

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3291

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3292

# (the [Google Container

3293

# Registry](https://cloud.google.com/container-registry/)).

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3294

#

3295

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3296

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3297

"A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3298

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3299

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3300

#

3301

# For more information, including usage and the valid values, see:

3302

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3303

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3304

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3305

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3306

# See

3307

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3308

# for more information, including usage and the valid values.

3309

"key": "A String", # Key for taint.

3310

"value": "A String", # Value for taint.

3311

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3312

},

3313

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3314

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3315

# These will added in addition to any default label(s) that

3316

# Kubernetes may apply to the node.

3317

# In case of conflict in label keys, the applied set may differ depending on

3318

# the Kubernetes version -- it's best to assume the behavior is undefined

3319

# and conflicts should be avoided.

3320

# For more information, including usage and the valid values, see:

3321

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3322

"a_key": "A String",

3323

},

3324

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3325

# The smallest allowed disk size is 10GB.

3326

#

3327

# If unspecified, the default disk size is 100GB.

3328

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3329

# workloads on the node pool.

3330

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3331

# on the node pool.

3332

},

3333

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3334

# See https://cloud.google.com/compute/docs/gpus for more information about

3335

# support for GPUs.

3336

{ # AcceleratorConfig represents a Hardware Accelerator request.

3337

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3338

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3339

# [here](https://cloud.google.com/compute/docs/gpus)

3340

},

3341

],

3342

"machineType": "A String", # The name of a Google Compute Engine [machine

3343

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3344

# `n1-standard-1`).

3345

#

3346

# If unspecified, the default machine type is

3347

# `n1-standard-1`.

3348

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3349

#

3350

# If unspecified, the default disk type is 'pd-standard'

3351

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3352

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3353

#

3354

# Secure Boot helps ensure that the system only runs authentic software by

3355

# verifying the digital signature of all boot components, and halting the

3356

# boot process if signature verification fails.

3357

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3358

#

3359

# Enables monitoring and attestation of the boot integrity of the instance.

3360

# The attestation is performed against the integrity policy baseline. This

3361

# baseline is initially derived from the implicitly trusted boot image when

3362

# the instance is created.

3363

},

3364

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3365

# scheduled on the specified or newer CPU platform. Applicable values are the

3366

# friendly names of CPU platforms, such as

3367

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3368

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3369

# information, read [how to specify min CPU

3370

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3371

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3372

# https://cloud.google.com/compute/docs/instances/preemptible for more

3373

# information about preemptible VM instances.

3374

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3375

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3376

# The limit for this value is dependent upon the maximum number of

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3377

# disks available on a machine per zone. See:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3378

# https://cloud.google.com/compute/docs/disks/local-ssd

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3379

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3380

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3381

"type": "A String", # Type of the sandbox to use for the node.

3382

},

3383

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3384

#

3385

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3386

# in length. These are reflected as part of a URL in the metadata server.

3387

# Additionally, to avoid ambiguity, keys must not conflict with any other

3388

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3394

# "enable-os-login"

3395

# "gci-ensure-gke-docker"

3396

# "gci-metrics-enabled"

3397

# "gci-update-strategy"

3398

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3403

# "windows-startup-script-ps1"

3404

# "common-psm1"

3405

# "k8s-node-setup-psm1"

3406

# "install-ssh-psm1"

3407

# "user-profile-psm1"

3408

# "serial-port-logging-enable"

3409

#

3410

# Values are free-form strings, and only have meaning as interpreted by

3411

# the image running in the instance. The only restriction placed on them is

3412

# that each value's size must be less than or equal to 32 KB.

3413

#

3414

# The total size of all keys and values must be less than 512 KB.

3415

"a_key": "A String",

3416

},

3417

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3418

# the specified [Zonal Compute

3419

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3420

# to this node pool.

3421

# is the configuration of desired reservation which instances could take

3422

# capacity from.

3423

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3424

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3425

# the key and specify the name of your reservation as its value.

3426

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3427

"A String",

3428

],

3429

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3430

},

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3431

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3432

"status": "A String", # [Output only] The current status of this cluster.

3433

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

3434

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

3435

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

3436

# cluster is connected. Example:

3437

# projects/my-project/regions/us-central1/subnetworks/my-subnet

3438

"network": "A String", # Output only. The relative name of the Google Compute Engine

3439

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

3440

# to which the cluster is connected. Example:

3441

# projects/my-project/global/networks/my-network

3442

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

3443

# This makes same node pod to pod traffic visible for VPC network.

3444

},

3445

"name": "A String", # The name of this cluster. The name must be unique within this project

3446

# and location (e.g. zone or region), and can be up to 40 characters with

3447

# the following restrictions:

3448

#

3449

# * Lowercase letters, numbers, and hyphens only.

3450

# * Must start with a letter.

3451

# * Must end with a number or a letter.

3452

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

3453

# The endpoint can be accessed from the internet at

3454

# `https://username:password@endpoint/`.

3455

#

3456

# See the `masterAuth` property of this resource for username and

3457

# password information.

3458

"location": "A String", # [Output only] The name of the Google Compute Engine

3459

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3460

# or

3461

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3462

# in which the cluster resides.

3463

"createTime": "A String", # [Output only] The time the cluster was created, in

3464

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3465

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3466

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3467

# notation (e.g. `10.96.0.0/14`). Leave blank to have

3468

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3469

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

3470

# required by Cluster Autoscaler to automatically adjust

3471

# the size of the cluster and create/delete

3472

# node pools based on the current needs.

3473

"autoprovisioningLocations": [ # The list of Google Compute Engine

3474

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3475

# NodePool's nodes can be created by NAP.

3476

"A String",

3477

],

3478

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

3479

# amount of resources in the cluster.

3480

{ # Contains information about amount of some resource in the cluster.

3481

# For memory, value should be in GB.

3482

"maximum": "A String", # Maximum amount of the resource in the cluster.

3483

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

3484

"minimum": "A String", # Minimum amount of the resource in the cluster.

3485

},

3486

],

3487

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

3488

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

3489

# created by NAP.

3490

# by NAP.

3491

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

3492

# specified, service_account should be empty.

3493

"A String",

3494

],

3495

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

3496

# node pool.

3497

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3498

# the Auto Upgrades will proceed.

3499

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3500

# with the description of the upgrade.

3501

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3502

# with the approximate start time for the upgrades, in

3503

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3504

},

3505

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

3506

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

3507

# up to date with the latest release version of Kubernetes.

3508

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

3509

# pool. If enabled, the nodes in this node pool will be monitored and, if

3510

# they fail health checks too many times, an automatic repair action will be

3511

# triggered.

3512

},

3513

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

3514

# disruption caused by an upgrade.

3515

#

3516

# maxUnavailable controls the number of nodes that can be simultaneously

3517

# unavailable.

3518

#

3519

# maxSurge controls the number of additional nodes that can be added to the

3520

# node pool temporarily for the time of the upgrade to increase the number of

3521

# available nodes.

3522

#

3523

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3524

# nodes are being upgraded at the same time).

3525

#

3526

# Note: upgrades inevitably introduce some disruption since workloads need to

3527

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3528

# this holds true. (Disruption stays within the limits of

3529

# PodDisruptionBudget, if it is configured.)

3530

#

3531

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3532

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3533

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3534

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3535

# there are always at least 4 nodes available.

3536

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3537

# the upgrade process. A node is considered available if its status is

3538

# Ready.

3539

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3540

# of the node pool during the upgrade process.

3541

},

3542

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

3543

# service_account is specified, scopes should be empty.

3544

},

3545

},

3546

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

3547

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3548

# is sufficient for this number of instances. You must also have available

3549

# firewall and routes quota.

3550

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3551

# "node_pool" object, since this configuration (along with the

3552

# "node_config") will be used to create a "NodePool" object with an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3553

# auto-generated name. Do not use this and a node_pool at the same time.

3554

#

3555

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3556

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

3557

"A String",

3558

],

3559

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

3560

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

3561

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

3562

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

3563

# given only RFC 1918 private addresses and communicate with the master via

3564

# private networking.

3565

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

3566

# range will be used for assigning internal IP addresses to the master or

3567

# set of masters, as well as the ILB VIP. This range must not overlap with

3568

# any other ranges in use within the cluster's network.

3569

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

3570

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

3571

},

3572

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

3573

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

3574

},

3575

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

3576

# required by Vertical Pod Autoscaler to automatically adjust

3577

# the resources of pods controlled by it.

3578

"enabled": True or False, # Enables vertical pod autoscaling.

3579

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3580

},

3581

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3582

"missingZones": [ # If any zones are listed here, the list of clusters returned

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3583

# may be missing those zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3584

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3590

<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]

3591

<pre>Sets the locations for a specific cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3592

Deprecated. Use

3593

[projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update)

3594

instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3595

3596

Args:

3597

projectId: string, Deprecated. The Google Developers Console [project ID or project

3598

number](https://support.google.com/cloud/answer/6158840).

3599

This field has been deprecated and replaced by the name field. (required)

3600

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3601

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

3602

cluster resides. This field has been deprecated and replaced by the name

3603

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3604

clusterId: string, Deprecated. The name of the cluster to upgrade.

3605

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3606

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3607

The object takes the form of:

3608

3609

{ # SetLocationsRequest sets the locations of the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3610

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3611

# number](https://support.google.com/cloud/answer/6158840).

3612

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3613

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3614

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3615

# cluster resides. This field has been deprecated and replaced by the name

3616

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3617

"locations": [ # Required. The desired list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3618

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3619

# 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]

3620

# will result in nodes being either created or removed from the cluster,

3621

# depending on whether locations are being added or removed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3622

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3623

# This list must always include the cluster's primary zone.

3624

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3625

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3626

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3627

# This field has been deprecated and replaced by the name field.

3628

"name": "A String", # The name (project, location, cluster) of the cluster to set locations.

3629

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3630

}

3631

3632

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3639

3640

{ # This operation resource represents operations that may have happened or are

3641

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3642

"name": "A String", # The server-assigned ID for the operation.

3643

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3644

{ # StatusCondition describes why a cluster or a node pool has a certain status

3645

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3646

"message": "A String", # Human-friendly representation of the condition

3647

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3648

},

3649

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3650

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3651

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3652

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3653

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3654

# or

3655

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3656

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3657

"startTime": "A String", # [Output only] The time the operation started, in

3658

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3659

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3660

"stages": [ # Substages of an operation or a stage.

3661

# Object with schema name: OperationProgress

3662

],

3663

"status": "A String", # Status of an operation stage.

3664

# Unset for single-stage operations.

3665

"metrics": [ # Progress metric bundle, for example:

3666

# metrics: [{name: "nodes done", int_value: 15},

3667

# {name: "nodes total", int_value: 32}]

3668

# or

3669

# metrics: [{name: "progress", double_value: 0.56},

3670

# {name: "progress scale", double_value: 1.0}]

3671

{ # Progress metric is (string, int|float|string) pair.

3672

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3673

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3674

"doubleValue": 3.14, # For metrics with floating point value.

3675

"intValue": "A String", # For metrics with integer value.

3676

},

3677

],

3678

"name": "A String", # A non-parameterized string describing an operation stage.

3679

# Unset for single-stage operations.

3680

},

3681

"clusterConditions": [ # Which conditions caused the current cluster state.

3682

{ # StatusCondition describes why a cluster or a node pool has a certain status

3683

# (e.g., ERROR or DEGRADED).

3684

"message": "A String", # Human-friendly representation of the condition

3685

"code": "A String", # Machine-friendly representation of the condition

3686

},

3687

],

3688

"zone": "A String", # The name of the Google Compute Engine

3689

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3690

# operation is taking place. This field is deprecated, use location instead.

3691

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3692

"selfLink": "A String", # Server-defined URL for the resource.

3693

"detail": "A String", # Detailed operation progress, if available.

3694

"targetLink": "A String", # Server-defined URL for the target of the operation.

3695

"operationType": "A String", # The operation type.

3696

"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]

3701

<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]

3702

<pre>Sets the logging service for a specific cluster.

3703

3704

Args:

3705

projectId: string, Deprecated. The Google Developers Console [project ID or project

3706

number](https://support.google.com/cloud/answer/6158840).

3707

This field has been deprecated and replaced by the name field. (required)

3708

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3709

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

3710

cluster resides. This field has been deprecated and replaced by the name

3711

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3712

clusterId: string, Deprecated. The name of the cluster to upgrade.

3713

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3714

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3715

The object takes the form of:

3716

3717

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3718

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3719

# number](https://support.google.com/cloud/answer/6158840).

3720

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3721

"zone": "A String", # Deprecated. The name of the Google Compute Engine

3722

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3723

# cluster resides. This field has been deprecated and replaced by the name

3724

# field.

3725

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3726

# This field has been deprecated and replaced by the name field.

3727

"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]

3728

# Currently available options:

3729

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3730

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

3731

# service with a Kubernetes-native resource model

3732

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

3733

# available as of GKE 1.15).

3734

# * `none` - no logs will be exported from the cluster.

3735

#

3736

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

3737

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3738

"name": "A String", # The name (project, location, cluster) of the cluster to set logging.

3739

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3740

}

3741

3742

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3749

3750

{ # This operation resource represents operations that may have happened or are

3751

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3752

"name": "A String", # The server-assigned ID for the operation.

3753

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3754

{ # StatusCondition describes why a cluster or a node pool has a certain status

3755

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3756

"message": "A String", # Human-friendly representation of the condition

3757

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3758

},

3759

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3760

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3761

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3762

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3763

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3764

# or

3765

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3766

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3767

"startTime": "A String", # [Output only] The time the operation started, in

3768

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3769

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3770

"stages": [ # Substages of an operation or a stage.

3771

# Object with schema name: OperationProgress

3772

],

3773

"status": "A String", # Status of an operation stage.

3774

# Unset for single-stage operations.

3775

"metrics": [ # Progress metric bundle, for example:

3776

# metrics: [{name: "nodes done", int_value: 15},

3777

# {name: "nodes total", int_value: 32}]

3778

# or

3779

# metrics: [{name: "progress", double_value: 0.56},

3780

# {name: "progress scale", double_value: 1.0}]

3781

{ # Progress metric is (string, int|float|string) pair.

3782

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3783

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3784

"doubleValue": 3.14, # For metrics with floating point value.

3785

"intValue": "A String", # For metrics with integer value.

3786

},

3787

],

3788

"name": "A String", # A non-parameterized string describing an operation stage.

3789

# Unset for single-stage operations.

3790

},

3791

"clusterConditions": [ # Which conditions caused the current cluster state.

3792

{ # StatusCondition describes why a cluster or a node pool has a certain status

3793

# (e.g., ERROR or DEGRADED).

3794

"message": "A String", # Human-friendly representation of the condition

3795

"code": "A String", # Machine-friendly representation of the condition

3796

},

3797

],

3798

"zone": "A String", # The name of the Google Compute Engine

3799

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3800

# operation is taking place. This field is deprecated, use location instead.

3801

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3802

"selfLink": "A String", # Server-defined URL for the resource.

3803

"detail": "A String", # Detailed operation progress, if available.

3804

"targetLink": "A String", # Server-defined URL for the target of the operation.

3805

"operationType": "A String", # The operation type.

3806

"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]

3811

<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]

3812

<pre>Updates the master for a specific cluster.

3813

3814

Args:

3815

projectId: string, Deprecated. The Google Developers Console [project ID or project

3816

number](https://support.google.com/cloud/answer/6158840).

3817

This field has been deprecated and replaced by the name field. (required)

3818

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3819

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

3820

cluster resides. This field has been deprecated and replaced by the name

3821

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3822

clusterId: string, Deprecated. The name of the cluster to upgrade.

3823

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3824

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3825

The object takes the form of:

3826

3827

{ # UpdateMasterRequest updates the master of the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3828

"name": "A String", # The name (project, location, cluster) of the cluster to update.

3829

# Specified in the format `projects/*/locations/*/clusters/*`.

3830

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3831

# number](https://support.google.com/cloud/answer/6158840).

3832

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3833

"zone": "A String", # Deprecated. The name of the Google Compute Engine

3834

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3835

# cluster resides. This field has been deprecated and replaced by the name

3836

# field.

3837

"masterVersion": "A String", # Required. The Kubernetes version to change the master to.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3838

#

3839

# Users may specify either explicit versions offered by Kubernetes Engine or

3840

# version aliases, which have the following behavior:

3841

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3842

# - "latest": picks the highest valid Kubernetes version

3843

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

3844

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

3845

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

3846

# - "-": picks the default Kubernetes version

3847

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3848

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3849

}

3850

3851

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3858

3859

{ # This operation resource represents operations that may have happened or are

3860

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3861

"name": "A String", # The server-assigned ID for the operation.

3862

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3863

{ # StatusCondition describes why a cluster or a node pool has a certain status

3864

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3865

"message": "A String", # Human-friendly representation of the condition

3866

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3867

},

3868

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3869

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3870

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3871

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3872

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3873

# or

3874

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3875

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3876

"startTime": "A String", # [Output only] The time the operation started, in

3877

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3878

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3879

"stages": [ # Substages of an operation or a stage.

3880

# Object with schema name: OperationProgress

3881

],

3882

"status": "A String", # Status of an operation stage.

3883

# Unset for single-stage operations.

3884

"metrics": [ # Progress metric bundle, for example:

3885

# metrics: [{name: "nodes done", int_value: 15},

3886

# {name: "nodes total", int_value: 32}]

3887

# or

3888

# metrics: [{name: "progress", double_value: 0.56},

3889

# {name: "progress scale", double_value: 1.0}]

3890

{ # Progress metric is (string, int|float|string) pair.

3891

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3892

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3893

"doubleValue": 3.14, # For metrics with floating point value.

3894

"intValue": "A String", # For metrics with integer value.

3895

},

3896

],

3897

"name": "A String", # A non-parameterized string describing an operation stage.

3898

# Unset for single-stage operations.

3899

},

3900

"clusterConditions": [ # Which conditions caused the current cluster state.

3901

{ # StatusCondition describes why a cluster or a node pool has a certain status

3902

# (e.g., ERROR or DEGRADED).

3903

"message": "A String", # Human-friendly representation of the condition

3904

"code": "A String", # Machine-friendly representation of the condition

3905

},

3906

],

3907

"zone": "A String", # The name of the Google Compute Engine

3908

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3909

# operation is taking place. This field is deprecated, use location instead.

3910

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3911

"selfLink": "A String", # Server-defined URL for the resource.

3912

"detail": "A String", # Detailed operation progress, if available.

3913

"targetLink": "A String", # Server-defined URL for the target of the operation.

3914

"operationType": "A String", # The operation type.

3915

"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]

3920

<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]

3921

<pre>Sets the monitoring service for a specific cluster.

3922

3923

Args:

3924

projectId: string, Deprecated. The Google Developers Console [project ID or project

3925

number](https://support.google.com/cloud/answer/6158840).

3926

This field has been deprecated and replaced by the name field. (required)

3927

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3928

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

3929

cluster resides. This field has been deprecated and replaced by the name

3930

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3931

clusterId: string, Deprecated. The name of the cluster to upgrade.

3932

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3933

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3934

The object takes the form of:

3935

3936

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3937

"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]

3938

# Currently available options:

3939

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3940

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3941

# service with a Kubernetes-native resource model

3942

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

3943

# longer available as of GKE 1.15).

3944

# * `none` - No metrics will be exported from the cluster.

3945

#

3946

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

3947

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3948

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring.

3949

# Specified in the format `projects/*/locations/*/clusters/*`.

3950

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

3951

# number](https://support.google.com/cloud/answer/6158840).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3952

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3953

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3954

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3955

# cluster resides. This field has been deprecated and replaced by the name

3956

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3957

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3958

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3959

}

3960

3961

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3968

3969

{ # This operation resource represents operations that may have happened or are

3970

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3971

"name": "A String", # The server-assigned ID for the operation.

3972

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3973

{ # StatusCondition describes why a cluster or a node pool has a certain status

3974

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3975

"message": "A String", # Human-friendly representation of the condition

3976

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3977

},

3978

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3979

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3980

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3981

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3982

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3983

# or

3984

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3985

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3986

"startTime": "A String", # [Output only] The time the operation started, in

3987

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3988

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3989

"stages": [ # Substages of an operation or a stage.

3990

# Object with schema name: OperationProgress

3991

],

3992

"status": "A String", # Status of an operation stage.

3993

# Unset for single-stage operations.

3994

"metrics": [ # Progress metric bundle, for example:

3995

# metrics: [{name: "nodes done", int_value: 15},

3996

# {name: "nodes total", int_value: 32}]

3997

# or

3998

# metrics: [{name: "progress", double_value: 0.56},

3999

# {name: "progress scale", double_value: 1.0}]

4000

{ # Progress metric is (string, int|float|string) pair.

4001

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4002

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4003

"doubleValue": 3.14, # For metrics with floating point value.

4004

"intValue": "A String", # For metrics with integer value.

4005

},

4006

],

4007

"name": "A String", # A non-parameterized string describing an operation stage.

4008

# Unset for single-stage operations.

4009

},

4010

"clusterConditions": [ # Which conditions caused the current cluster state.

4011

{ # StatusCondition describes why a cluster or a node pool has a certain status

4012

# (e.g., ERROR or DEGRADED).

4013

"message": "A String", # Human-friendly representation of the condition

4014

"code": "A String", # Machine-friendly representation of the condition

4015

},

4016

],

4017

"zone": "A String", # The name of the Google Compute Engine

4018

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4019

# operation is taking place. This field is deprecated, use location instead.

4020

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4021

"selfLink": "A String", # Server-defined URL for the resource.

4022

"detail": "A String", # Detailed operation progress, if available.

4023

"targetLink": "A String", # Server-defined URL for the target of the operation.

4024

"operationType": "A String", # The operation type.

4025

"status": "A String", # The current status of the operation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4030

<code class="details" id="resourceLabels">resourceLabels(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4031

<pre>Sets labels on a cluster.

4032

4033

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4034

projectId: string, Deprecated. The Google Developers Console [project ID or project

4035

number](https://developers.google.com/console/help/new/#projectnumber).

4036

This field has been deprecated and replaced by the name field. (required)

4037

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4038

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4039

cluster resides. This field has been deprecated and replaced by the name

4040

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4041

clusterId: string, Deprecated. The name of the cluster.

4042

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4043

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4044

The object takes the form of:

4045

4046

{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container

4047

# Engine cluster, which will in turn set them for Google Compute Engine

4048

# resources used by that cluster

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4049

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels.

4050

# Specified in the format `projects/*/locations/*/clusters/*`.

4051

"resourceLabels": { # Required. The labels to set for that cluster.

4052

"a_key": "A String",

4053

},

4054

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4055

# number](https://developers.google.com/console/help/new/#projectnumber).

4056

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4057

"clusterId": "A String", # Deprecated. The name of the cluster.

4058

# This field has been deprecated and replaced by the name field.

4059

"labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource,

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4060

# used to detect conflicts. The fingerprint is initially generated by

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4061

# Kubernetes Engine and changes after every request to modify or update

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4062

# labels. You must always provide an up-to-date fingerprint hash when

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4063

# updating or changing labels. Make a <code>get()</code> request to the

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4064

# resource to get the latest fingerprint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4065

"zone": "A String", # Deprecated. The name of the Google Compute Engine

4066

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4067

# cluster resides. This field has been deprecated and replaced by the name

4068

# field.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4069

}

4070

4071

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4078

4079

{ # This operation resource represents operations that may have happened or are

4080

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4081

"name": "A String", # The server-assigned ID for the operation.

4082

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4083

{ # StatusCondition describes why a cluster or a node pool has a certain status

4084

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4085

"message": "A String", # Human-friendly representation of the condition

4086

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4087

},

4088

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4089

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4090

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4091

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4092

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4093

# or

4094

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4095

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4096

"startTime": "A String", # [Output only] The time the operation started, in

4097

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4098

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4099

"stages": [ # Substages of an operation or a stage.

4100

# Object with schema name: OperationProgress

4101

],

4102

"status": "A String", # Status of an operation stage.

4103

# Unset for single-stage operations.

4104

"metrics": [ # Progress metric bundle, for example:

4105

# metrics: [{name: "nodes done", int_value: 15},

4106

# {name: "nodes total", int_value: 32}]

4107

# or

4108

# metrics: [{name: "progress", double_value: 0.56},

4109

# {name: "progress scale", double_value: 1.0}]

4110

{ # Progress metric is (string, int|float|string) pair.

4111

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4112

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4113

"doubleValue": 3.14, # For metrics with floating point value.

4114

"intValue": "A String", # For metrics with integer value.

4115

},

4116

],

4117

"name": "A String", # A non-parameterized string describing an operation stage.

4118

# Unset for single-stage operations.

4119

},

4120

"clusterConditions": [ # Which conditions caused the current cluster state.

4121

{ # StatusCondition describes why a cluster or a node pool has a certain status

4122

# (e.g., ERROR or DEGRADED).

4123

"message": "A String", # Human-friendly representation of the condition

4124

"code": "A String", # Machine-friendly representation of the condition

4125

},

4126

],

4127

"zone": "A String", # The name of the Google Compute Engine

4128

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4129

# operation is taking place. This field is deprecated, use location instead.

4130

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4131

"selfLink": "A String", # Server-defined URL for the resource.

4132

"detail": "A String", # Detailed operation progress, if available.

4133

"targetLink": "A String", # Server-defined URL for the target of the operation.

4134

"operationType": "A String", # The operation type.

4135

"status": "A String", # The current status of the operation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4140

<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]

4141

<pre>Sets the maintenance policy for a cluster.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4142

4143

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4144

projectId: string, Required. The Google Developers Console [project ID or project

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4145

number](https://support.google.com/cloud/answer/6158840). (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4146

zone: string, Required. The name of the Google Compute Engine

4147

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4148

cluster resides. (required)

4149

clusterId: string, Required. The name of the cluster to update. (required)

4150

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4151

The object takes the form of:

4152

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4153

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4154

"clusterId": "A String", # Required. The name of the cluster to update.

4155

"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]

4156

# clears the existing maintenance policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4157

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

4158

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

4159

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

4160

# smallest possible in the given scenario.

4161

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

4162

# format "PTnHnMnS".

4163

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

4164

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

4165

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

4166

},

4167

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4168

# maintenance to occur. The time windows may be overlapping. If no

4169

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4170

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4171

# this window reccurs. They go on for the span of time between the start and

4172

# end time.

4173

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4174

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4175

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

4176

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

4177

# <code>FREQ=DAILY</code>

4178

# For the first weekend of every month:

4179

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

4180

# This specifies how frequently the window starts. Eg, if you wanted to have

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4181

# a 9-5 UTC-4 window every weekday, you'd use something like:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4182

# <code>

4183

# start time = 2019-01-01T09:00:00-0400

4184

# end time = 2019-01-01T17:00:00-0400

4185

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

4186

# </code>

4187

# Windows can span multiple days. Eg, to make the window encompass every

4188

# weekend from midnight Saturday till the last minute of Sunday UTC:

4189

# <code>

4190

# start time = 2019-01-05T00:00:00Z

4191

# end time = 2019-01-07T23:59:00Z

4192

# recurrence = FREQ=WEEKLY;BYDAY=SA

4193

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4194

# Note the start and end time's specific dates are largely arbitrary except

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4195

# to specify duration of the window and when it first starts.

4196

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4197

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

4198

"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]

4199

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4200

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4201

},

4202

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4203

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4204

# occur in these windows.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4205

"a_key": { # Represents an arbitrary window of time.

4206

"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]

4207

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4208

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4209

},

4210

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4211

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4212

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

4213

# the policy won't accidentally undo intermediate changes (and so that users

4214

# of the API unaware of some fields won't accidentally remove other fields).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4215

# Make a <code>get()</code> request to the cluster to get the current

4216

# resource version and include it with requests to set the policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4217

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4218

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4219

# policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4220

# Specified in the format `projects/*/locations/*/clusters/*`.

4221

"projectId": "A String", # Required. The Google Developers Console [project ID or project

4222

# number](https://support.google.com/cloud/answer/6158840).

4223

"zone": "A String", # Required. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4224

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4225

# cluster resides.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4226

}

4227

4228

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4235

4236

{ # This operation resource represents operations that may have happened or are

4237

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4238

"name": "A String", # The server-assigned ID for the operation.

4239

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4240

{ # StatusCondition describes why a cluster or a node pool has a certain status

4241

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4242

"message": "A String", # Human-friendly representation of the condition

4243

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4244

},

4245

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4246

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4247

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4248

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4249

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4250

# or

4251

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4252

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4253

"startTime": "A String", # [Output only] The time the operation started, in

4254

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4255

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4256

"stages": [ # Substages of an operation or a stage.

4257

# Object with schema name: OperationProgress

4258

],

4259

"status": "A String", # Status of an operation stage.

4260

# Unset for single-stage operations.

4261

"metrics": [ # Progress metric bundle, for example:

4262

# metrics: [{name: "nodes done", int_value: 15},

4263

# {name: "nodes total", int_value: 32}]

4264

# or

4265

# metrics: [{name: "progress", double_value: 0.56},

4266

# {name: "progress scale", double_value: 1.0}]

4267

{ # Progress metric is (string, int|float|string) pair.

4268

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4269

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4270

"doubleValue": 3.14, # For metrics with floating point value.

4271

"intValue": "A String", # For metrics with integer value.

4272

},

4273

],

4274

"name": "A String", # A non-parameterized string describing an operation stage.

4275

# Unset for single-stage operations.

4276

},

4277

"clusterConditions": [ # Which conditions caused the current cluster state.

4278

{ # StatusCondition describes why a cluster or a node pool has a certain status

4279

# (e.g., ERROR or DEGRADED).

4280

"message": "A String", # Human-friendly representation of the condition

4281

"code": "A String", # Machine-friendly representation of the condition

4282

},

4283

],

4284

"zone": "A String", # The name of the Google Compute Engine

4285

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4286

# operation is taking place. This field is deprecated, use location instead.

4287

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4288

"selfLink": "A String", # Server-defined URL for the resource.

4289

"detail": "A String", # Detailed operation progress, if available.

4290

"targetLink": "A String", # Server-defined URL for the target of the operation.

4291

"operationType": "A String", # The operation type.

4292

"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]

4297

<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]

4298

<pre>Sets master auth materials. Currently supports changing the admin password

4299

or a specific cluster, either via password generation or explicitly setting

the password.

Args:

projectId: string, Deprecated. The Google Developers Console [project ID or project

4304

number](https://support.google.com/cloud/answer/6158840).

4305

This field has been deprecated and replaced by the name field. (required)

4306

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4307

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4308

cluster resides. This field has been deprecated and replaced by the name

4309

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4310

clusterId: string, Deprecated. The name of the cluster to upgrade.

4311

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4312

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4313

The object takes the form of:

4314

4315

{ # SetMasterAuthRequest updates the admin password of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4316

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4317

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4318

# cluster resides. This field has been deprecated and replaced by the name

4319

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4320

"name": "A String", # The name (project, location, cluster) of the cluster to set auth.

4321

# Specified in the format `projects/*/locations/*/clusters/*`.

4322

"action": "A String", # Required. The exact form of action to be taken on the master auth.

4323

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4324

# number](https://support.google.com/cloud/answer/6158840).

4325

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4326

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4327

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4328

"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]

4329

# Authentication can be done using HTTP basic auth or using client

4330

# certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4331

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

4332

# trust for the cluster.

4333

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

4334

# authenticate to the cluster endpoint.

4335

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4336

# For clusters v1.6.0 and later, basic authentication can be disabled by

4337

# leaving username unspecified (or setting it to the empty string).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4338

"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]

4339

# Because the master endpoint is open to the Internet, you should create a

4340

# strong password. If a password is provided for cluster creation, username

4341

# must be non-empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4342

"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]

4343

# clusters before v1.12, if no configuration is specified, a client

4344

# certificate is issued.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4345

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4346

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4347

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

4348

# to the cluster endpoint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4349

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4350

}

4351

4352

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4359

4360

{ # This operation resource represents operations that may have happened or are

4361

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4362

"name": "A String", # The server-assigned ID for the operation.

4363

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4364

{ # StatusCondition describes why a cluster or a node pool has a certain status

4365

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4366

"message": "A String", # Human-friendly representation of the condition

4367

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4368

},

4369

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4370

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4371

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4372

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4373

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4374

# or

4375

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4376

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4377

"startTime": "A String", # [Output only] The time the operation started, in

4378

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4379

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4380

"stages": [ # Substages of an operation or a stage.

4381

# Object with schema name: OperationProgress

4382

],

4383

"status": "A String", # Status of an operation stage.

4384

# Unset for single-stage operations.

4385

"metrics": [ # Progress metric bundle, for example:

4386

# metrics: [{name: "nodes done", int_value: 15},

4387

# {name: "nodes total", int_value: 32}]

4388

# or

4389

# metrics: [{name: "progress", double_value: 0.56},

4390

# {name: "progress scale", double_value: 1.0}]

4391

{ # Progress metric is (string, int|float|string) pair.

4392

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4393

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4394

"doubleValue": 3.14, # For metrics with floating point value.

4395

"intValue": "A String", # For metrics with integer value.

4396

},

4397

],

4398

"name": "A String", # A non-parameterized string describing an operation stage.

4399

# Unset for single-stage operations.

4400

},

4401

"clusterConditions": [ # Which conditions caused the current cluster state.

4402

{ # StatusCondition describes why a cluster or a node pool has a certain status

4403

# (e.g., ERROR or DEGRADED).

4404

"message": "A String", # Human-friendly representation of the condition

4405

"code": "A String", # Machine-friendly representation of the condition

4406

},

4407

],

4408

"zone": "A String", # The name of the Google Compute Engine

4409

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4410

# operation is taking place. This field is deprecated, use location instead.

4411

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4412

"selfLink": "A String", # Server-defined URL for the resource.

4413

"detail": "A String", # Detailed operation progress, if available.

4414

"targetLink": "A String", # Server-defined URL for the target of the operation.

4415

"operationType": "A String", # The operation type.

4416

"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]

4421

<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]

4422

<pre>Enables or disables Network Policy for a cluster.

4423

4424

Args:

4425

projectId: string, Deprecated. The Google Developers Console [project ID or project

4426

number](https://developers.google.com/console/help/new/#projectnumber).

4427

This field has been deprecated and replaced by the name field. (required)

4428

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4429

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4430

cluster resides. This field has been deprecated and replaced by the name

4431

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4432

clusterId: string, Deprecated. The name of the cluster.

4433

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4434

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4435

The object takes the form of:

4436

4437

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4438

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4439

# number](https://developers.google.com/console/help/new/#projectnumber).

4440

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4441

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4442

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4443

# cluster resides. This field has been deprecated and replaced by the name

4444

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4445

"clusterId": "A String", # Deprecated. The name of the cluster.

4446

# This field has been deprecated and replaced by the name field.

4447

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature.

4448

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

4449

"provider": "A String", # The selected network policy provider.

4450

"enabled": True or False, # Whether network policy is enabled on the cluster.

4451

},

4452

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking

4453

# policy. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4454

}

4455

4456

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4463

4464

{ # This operation resource represents operations that may have happened or are

4465

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4466

"name": "A String", # The server-assigned ID for the operation.

4467

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4468

{ # StatusCondition describes why a cluster or a node pool has a certain status

4469

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4470

"message": "A String", # Human-friendly representation of the condition

4471

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4472

},

4473

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4474

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4475

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4476

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4477

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4478

# or

4479

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4480

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4481

"startTime": "A String", # [Output only] The time the operation started, in

4482

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4483

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4484

"stages": [ # Substages of an operation or a stage.

4485

# Object with schema name: OperationProgress

4486

],

4487

"status": "A String", # Status of an operation stage.

4488

# Unset for single-stage operations.

4489

"metrics": [ # Progress metric bundle, for example:

4490

# metrics: [{name: "nodes done", int_value: 15},

4491

# {name: "nodes total", int_value: 32}]

4492

# or

4493

# metrics: [{name: "progress", double_value: 0.56},

4494

# {name: "progress scale", double_value: 1.0}]

4495

{ # Progress metric is (string, int|float|string) pair.

4496

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4497

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4498

"doubleValue": 3.14, # For metrics with floating point value.

4499

"intValue": "A String", # For metrics with integer value.

4500

},

4501

],

4502

"name": "A String", # A non-parameterized string describing an operation stage.

4503

# Unset for single-stage operations.

4504

},

4505

"clusterConditions": [ # Which conditions caused the current cluster state.

4506

{ # StatusCondition describes why a cluster or a node pool has a certain status

4507

# (e.g., ERROR or DEGRADED).

4508

"message": "A String", # Human-friendly representation of the condition

4509

"code": "A String", # Machine-friendly representation of the condition

4510

},

4511

],

4512

"zone": "A String", # The name of the Google Compute Engine

4513

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4514

# operation is taking place. This field is deprecated, use location instead.

4515

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4516

"selfLink": "A String", # Server-defined URL for the resource.

4517

"detail": "A String", # Detailed operation progress, if available.

4518

"targetLink": "A String", # Server-defined URL for the target of the operation.

4519

"operationType": "A String", # The operation type.

4520

"status": "A String", # The current status of the operation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4525

<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]

4526

<pre>Starts master IP rotation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4527

4528

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4529

projectId: string, Deprecated. The Google Developers Console [project ID or project

4530

number](https://developers.google.com/console/help/new/#projectnumber).

4531

This field has been deprecated and replaced by the name field. (required)

4532

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4533

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4534

cluster resides. This field has been deprecated and replaced by the name

4535

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4536

clusterId: string, Deprecated. The name of the cluster.

4537

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4538

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4539

The object takes the form of:

4540

4541

{ # StartIPRotationRequest creates a new IP for the cluster and then performs

4542

# a node upgrade on each node pool to point to the new IP.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4543

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4544

# number](https://developers.google.com/console/help/new/#projectnumber).

4545

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4546

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4547

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4548

# cluster resides. This field has been deprecated and replaced by the name

4549

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4550

"clusterId": "A String", # Deprecated. The name of the cluster.

4551

# This field has been deprecated and replaced by the name field.

4552

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

4553

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP

4554

# rotation. Specified in the format `projects/*/locations/*/clusters/*`.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4555

}

4556

4557

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4564

4565

{ # This operation resource represents operations that may have happened or are

4566

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4567

"name": "A String", # The server-assigned ID for the operation.

4568

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4569

{ # StatusCondition describes why a cluster or a node pool has a certain status

4570

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4571

"message": "A String", # Human-friendly representation of the condition

4572

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4573

},

4574

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4575

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4576

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4577

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4578

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4579

# or

4580

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4581

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4582

"startTime": "A String", # [Output only] The time the operation started, in

4583

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4584

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4585

"stages": [ # Substages of an operation or a stage.

4586

# Object with schema name: OperationProgress

4587

],

4588

"status": "A String", # Status of an operation stage.

4589

# Unset for single-stage operations.

4590

"metrics": [ # Progress metric bundle, for example:

4591

# metrics: [{name: "nodes done", int_value: 15},

4592

# {name: "nodes total", int_value: 32}]

4593

# or

4594

# metrics: [{name: "progress", double_value: 0.56},

4595

# {name: "progress scale", double_value: 1.0}]

4596

{ # Progress metric is (string, int|float|string) pair.

4597

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4598

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4599

"doubleValue": 3.14, # For metrics with floating point value.

4600

"intValue": "A String", # For metrics with integer value.

4601

},

4602

],

4603

"name": "A String", # A non-parameterized string describing an operation stage.

4604

# Unset for single-stage operations.

4605

},

4606

"clusterConditions": [ # Which conditions caused the current cluster state.

4607

{ # StatusCondition describes why a cluster or a node pool has a certain status

4608

# (e.g., ERROR or DEGRADED).

4609

"message": "A String", # Human-friendly representation of the condition

4610

"code": "A String", # Machine-friendly representation of the condition

4611

},

4612

],

4613

"zone": "A String", # The name of the Google Compute Engine

4614

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4615

# operation is taking place. This field is deprecated, use location instead.

4616

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4617

"selfLink": "A String", # Server-defined URL for the resource.

4618

"detail": "A String", # Detailed operation progress, if available.

4619

"targetLink": "A String", # Server-defined URL for the target of the operation.

4620

"operationType": "A String", # The operation type.

4621

"status": "A String", # The current status of the operation.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4626

<code class="details" id="update">update(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4627

<pre>Updates the settings of a specific cluster.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4628

4629

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4630

projectId: string, Deprecated. The Google Developers Console [project ID or project

4631

number](https://support.google.com/cloud/answer/6158840).

4632

This field has been deprecated and replaced by the name field. (required)

4633

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4634

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4635

cluster resides. This field has been deprecated and replaced by the name

4636

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4637

clusterId: string, Deprecated. The name of the cluster to upgrade.

4638

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4639

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4640

The object takes the form of:

4641

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4642

{ # UpdateClusterRequest updates the settings of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4643

"update": { # ClusterUpdate describes an update to the cluster. Exactly one update can # Required. A description of the update.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4644

# be applied to a cluster with each request, so at most one field can be

4645

# provided.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4646

"desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4647

# cluster, enabling additional functionality.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4648

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

4649

# is enabled or not on the Master, it does not track whether network policy

4650

# is enabled for the nodes.

4651

# is enabled or not on the Master, it does not track whether network policy

4652

# is enabled for the nodes.

4653

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

4654

},

4655

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

4656

# managed Knative service.

4657

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

4658

},

4659

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

4660

# increases or decreases the number of replica pods a replication controller

4661

# has based on the resource usage of the existing pods.

4662

# increases or decreases the number of replica pods a replication controller

4663

# has based on the resource usage of the existing pods.

4664

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

4665

# When enabled, it ensures that metrics are collected into Stackdriver

4666

# Monitoring.

4667

},

4668

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4669

# makes it easy to set up HTTP load balancers for services in a cluster.

4670

# which makes it easy to set up HTTP load balancers for services in a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4671

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4672

# When enabled, it runs a small pod in the cluster that manages the load

4673

# balancers.

4674

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4675

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4676

# This addon is deprecated, and will be disabled in 1.15. It is recommended

4677

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

4678

# workloads and applications. For more information, see:

4679

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4680

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4681

},

4682

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4683

"desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an

4684

# upgrade).

4685

#

4686

# Users may specify either explicit versions offered by

4687

# Kubernetes Engine or version aliases, which have the following behavior:

4688

#

4689

# - "latest": picks the highest valid Kubernetes version

4690

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4691

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4692

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4693

# - "-": picks the Kubernetes master version

4694

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility.

4695

# visibility on this cluster.

4696

"enabled": True or False, # Enables intra node visibility for this cluster.

4697

},

4698

"desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4699

# required by Cluster Autoscaler to automatically adjust

4700

# the size of the cluster and create/delete

4701

# node pools based on the current needs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4702

"autoprovisioningLocations": [ # The list of Google Compute Engine

4703

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4704

# NodePool's nodes can be created by NAP.

4705

"A String",

4706

],

4707

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

4708

# amount of resources in the cluster.

4709

{ # Contains information about amount of some resource in the cluster.

4710

# For memory, value should be in GB.

4711

"maximum": "A String", # Maximum amount of the resource in the cluster.

4712

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

4713

"minimum": "A String", # Minimum amount of the resource in the cluster.

4714

},

4715

],

4716

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

4717

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4718

# created by NAP.

4719

# by NAP.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4720

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

4721

# specified, service_account should be empty.

4722

"A String",

4723

],

4724

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4725

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4726

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4727

# the Auto Upgrades will proceed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4728

"description": "A String", # [Output only] This field is set when upgrades are about to commence

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4729

# with the description of the upgrade.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4730

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4731

# with the approximate start time for the upgrades, in

4732

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4733

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4734

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4735

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

4736

# up to date with the latest release version of Kubernetes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4737

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

4738

# pool. If enabled, the nodes in this node pool will be monitored and, if

4739

# they fail health checks too many times, an automatic repair action will be

4740

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4741

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4742

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4743

# disruption caused by an upgrade.

4744

#

4745

# maxUnavailable controls the number of nodes that can be simultaneously

4746

# unavailable.

4747

#

4748

# maxSurge controls the number of additional nodes that can be added to the

4749

# node pool temporarily for the time of the upgrade to increase the number of

4750

# available nodes.

4751

#

4752

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

4753

# nodes are being upgraded at the same time).

4754

#

4755

# Note: upgrades inevitably introduce some disruption since workloads need to

4756

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

4757

# this holds true. (Disruption stays within the limits of

4758

# PodDisruptionBudget, if it is configured.)

4759

#

4760

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

4761

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

4762

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

4763

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

4764

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4765

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4766

# the upgrade process. A node is considered available if its status is

4767

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4768

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

4769

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4770

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4771

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

4772

# service_account is specified, scopes should be empty.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4773

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4774

},

4775

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

4776

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

4777

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

4778

"state": "A String", # Denotes the state of etcd encryption.

4779

},

4780

"desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature.

4781

# master authorized networks will disallow all external traffic to access

4782

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

4783

# Google Compute Engine Public IPs and Google Prod IPs.

4784

"enabled": True or False, # Whether or not master authorized networks is enabled.

4785

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

4786

# Kubernetes master through HTTPS.

4787

{ # CidrBlock contains an optional name and one CIDR block.

4788

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

4789

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4790

},

4791

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4792

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4793

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

4794

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

4795

# daemonset will be created in the cluster to meter network egress traffic.

4796

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

4797

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

4798

# second BigQuery table will be created to hold resource consumption

4799

# records.

4800

},

4801

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

4802

"datasetId": "A String", # The ID of a BigQuery Dataset.

4803

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4804

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4805

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in

4806

# desired_node_pool_id. If there is only one pool in the

4807

# cluster and desired_node_pool_id is not provided then

4808

# the change applies to that single node pool.

4809

# adjust the size of the node pool to the current cluster usage.

4810

"enabled": True or False, # Is autoscaling enabled for this node pool.

4811

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

4812

# has to enough quota to scale up the cluster.

4813

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

4814

# max_node_count.

4815

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

4816

},

4817

"desiredLocations": [ # The desired list of Google Compute Engine

4818

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4819

# cluster's nodes should be located. Changing the locations a cluster is in

4820

# will result in nodes being either created or removed from the cluster,

4821

# depending on whether locations are being added or removed.

4822

#

4823

# This list must always include the cluster's primary zone.

4824

"A String",

4825

],

4826

"desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4827

# Currently available options:

4828

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4829

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4830

# service with a Kubernetes-native resource model

4831

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4832

# longer available as of GKE 1.15).

4833

# * `none` - No metrics will be exported from the cluster.

4834

#

4835

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4836

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4837

"desiredImageType": "A String", # The desired image type for the node pool.

4838

# NOTE: Set the "desired_node_pool" field as well.

4839

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4840

# policies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4841

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4842

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4843

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if

4844

# "desired_node_version", "desired_image_family" or

4845

# "desired_node_pool_autoscaling" is specified and there is more than one

4846

# node pool on the cluster.

4847

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

4848

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4849

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4850

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to.

4851

#

4852

# Users may specify either explicit versions offered by

4853

# Kubernetes Engine or version aliases, which have the following behavior:

4854

#

4855

# - "latest": picks the highest valid Kubernetes version

4856

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4857

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4858

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4859

# - "-": picks the default Kubernetes version

4860

"desiredLoggingService": "A String", # The logging service the cluster should use to write logs.

4861

# Currently available options:

4862

#

4863

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

4864

# service with a Kubernetes-native resource model

4865

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

4866

# available as of GKE 1.15).

4867

# * `none` - no logs will be exported from the cluster.

4868

#

4869

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

4870

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

4871

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

4872

# required by Vertical Pod Autoscaler to automatically adjust

4873

# the resources of pods controlled by it.

4874

"enabled": True or False, # Enables vertical pod autoscaling.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4875

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4876

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

4877

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

4878

# images will be validated by Binary Authorization.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4879

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4880

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4881

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4882

# Specified in the format `projects/*/locations/*/clusters/*`.

4883

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4884

# number](https://support.google.com/cloud/answer/6158840).

4885

# This field has been deprecated and replaced by the name field.

4886

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4887

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4888

# cluster resides. This field has been deprecated and replaced by the name

4889

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4890

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

4891

# This field has been deprecated and replaced by the name field.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4892

}

4893

4894

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4895

Allowed values

4896

1 - v1 error format

4897

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4898

4899

Returns:

4900

An object of the form:

4901

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4902

{ # This operation resource represents operations that may have happened or are

4903

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4904

"name": "A String", # The server-assigned ID for the operation.

4905

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4906

{ # StatusCondition describes why a cluster or a node pool has a certain status

4907

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4908

"message": "A String", # Human-friendly representation of the condition

4909

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4910

},

4911

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4912

"endTime": "A String", # [Output only] The time the operation completed, in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4913

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4914

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4915

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4916

# or

4917

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4918

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4919

"startTime": "A String", # [Output only] The time the operation started, in

4920

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4921

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4922

"stages": [ # Substages of an operation or a stage.

4923

# Object with schema name: OperationProgress

4924

],

4925

"status": "A String", # Status of an operation stage.

4926

# Unset for single-stage operations.

4927

"metrics": [ # Progress metric bundle, for example:

4928

# metrics: [{name: "nodes done", int_value: 15},

4929

# {name: "nodes total", int_value: 32}]

4930

# or

4931

# metrics: [{name: "progress", double_value: 0.56},

4932

# {name: "progress scale", double_value: 1.0}]

4933

{ # Progress metric is (string, int|float|string) pair.

4934

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4935

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4936

"doubleValue": 3.14, # For metrics with floating point value.

4937

"intValue": "A String", # For metrics with integer value.

4938

},

4939

],

4940

"name": "A String", # A non-parameterized string describing an operation stage.

4941

# Unset for single-stage operations.

4942

},

4943

"clusterConditions": [ # Which conditions caused the current cluster state.

4944

{ # StatusCondition describes why a cluster or a node pool has a certain status

4945

# (e.g., ERROR or DEGRADED).

4946

"message": "A String", # Human-friendly representation of the condition

4947

"code": "A String", # Machine-friendly representation of the condition

4948

},

4949

],

4950

"zone": "A String", # The name of the Google Compute Engine

4951

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4952

# operation is taking place. This field is deprecated, use location instead.

4953

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4954

"selfLink": "A String", # Server-defined URL for the resource.

4955

"detail": "A String", # Detailed operation progress, if available.

4956

"targetLink": "A String", # Server-defined URL for the target of the operation.

4957

"operationType": "A String", # The operation type.

4958

"status": "A String", # The current status of the operation.

Takashi Matsuo