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

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

[diff] [blame]

83

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

Bu Sun Kim

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

[diff] [blame]

84

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

85

Dan O'Meara

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

[diff] [blame]

86

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

Bu Sun Kim

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

[diff] [blame]

87

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

88

Dan O'Meara

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

[diff] [blame]

89

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

Bu Sun Kim

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

[diff] [blame]

90

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

91

92

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

93

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

94

95

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

96

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

97

Dan O'Meara

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

[diff] [blame]

98

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

Bu Sun Kim

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

[diff] [blame]

99

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

100

101

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

102

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

103

Dan O'Meara

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

[diff] [blame]

104

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

Bu Sun Kim

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

[diff] [blame]

105

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

106

Dan O'Meara

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

[diff] [blame]

107

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

Bu Sun Kim

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

[diff] [blame]

108

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

109

Dan O'Meara

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

[diff] [blame]

110

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

Bu Sun Kim

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

[diff] [blame]

111

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

112

Dan O'Meara

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

[diff] [blame]

113

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

Bu Sun Kim

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

[diff] [blame]

114

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

115

Dan O'Meara

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

[diff] [blame]

116

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

Bu Sun Kim

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

[diff] [blame]

117

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

118

Dan O'Meara

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

[diff] [blame]

119

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

Bu Sun Kim

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

[diff] [blame]

120

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

121

Dan O'Meara

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

[diff] [blame]

122

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

Bu Sun Kim

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

[diff] [blame]

123

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

124

Dan O'Meara

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

127

Dan O'Meara

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

[diff] [blame]

128

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

Bu Sun Kim

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

[diff] [blame]

129

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

130

Dan O'Meara

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

[diff] [blame]

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

133

<h3>Method Details</h3>

134

Dan O'Meara

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

[diff] [blame]

135

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

Bu Sun Kim

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

[diff] [blame]

136

<pre>Sets the addons for a specific cluster.

137

138

Args:

Dan O'Meara

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

[diff] [blame]

139

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

Bu Sun Kim

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

[diff] [blame]

140

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

141

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

Dan O'Meara

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

[diff] [blame]

142

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

143

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

144

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

145

field. (required)

146

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

Bu Sun Kim

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

[diff] [blame]

147

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

Dan O'Meara

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

[diff] [blame]

148

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

149

The object takes the form of:

150

151

{ # SetAddonsRequest sets the addons associated with the cluster.

Bu Sun Kim

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

[diff] [blame^]

152

"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", # Required. 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", # Required. 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", # Required. 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

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame^]

171

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

Bu Sun Kim

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

[diff] [blame]

172

},

Bu Sun Kim

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

[diff] [blame^]

173

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

174

# extension to manage hosted GCP services through the Kubernetes API

175

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

176

},

177

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

Bu Sun Kim

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

[diff] [blame]

178

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

179

# at cluster creation time.

Bu Sun Kim

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

[diff] [blame^]

180

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

Bu Sun Kim

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

[diff] [blame]

181

},

Bu Sun Kim

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

[diff] [blame^]

182

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

Bu Sun Kim

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

[diff] [blame]

183

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

184

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

185

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

186

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

Bu Sun Kim

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

[diff] [blame^]

187

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

Dan O'Meara

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

[diff] [blame]

188

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

189

# Monitoring.

190

},

Bu Sun Kim

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

[diff] [blame^]

191

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

192

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

193

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

194

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

195

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

196

# balancers.

Dan O'Meara

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

[diff] [blame]

197

},

Bu Sun Kim

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

[diff] [blame^]

198

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

Bu Sun Kim

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

[diff] [blame]

199

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

200

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

201

# workloads and applications. For more information, see:

202

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

Bu Sun Kim

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

[diff] [blame^]

203

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

204

},

205

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

206

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

207

},

208

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

209

# applications.

210

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

211

},

212

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

213

# enabled at cluster creation time.

214

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

215

},

216

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

217

# microservices.

218

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

219

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

Bu Sun Kim

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

[diff] [blame]

220

},

221

},

Bu Sun Kim

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

[diff] [blame]

222

}

223

224

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

231

232

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

233

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

Bu Sun Kim

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

[diff] [blame^]

234

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

Bu Sun Kim

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

[diff] [blame]

235

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

236

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

Bu Sun Kim

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

[diff] [blame^]

237

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

238

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

Bu Sun Kim

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

[diff] [blame]

239

},

240

],

Bu Sun Kim

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

[diff] [blame^]

241

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

Dan O'Meara

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

[diff] [blame]

242

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

243

# or

244

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

245

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

},

256

],

257

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

258

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

259

# Object with schema name: OperationProgress

260

],

261

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

262

# Unset for single-stage operations.

263

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

264

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

265

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

266

# or

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

},

275

],

276

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

277

# Unset for single-stage operations.

278

},

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

293

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

Bu Sun Kim

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

[diff] [blame]

294

<pre>Completes master IP rotation.

295

296

Args:

Dan O'Meara

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

[diff] [blame]

297

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

Bu Sun Kim

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

[diff] [blame]

298

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

299

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

Dan O'Meara

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

[diff] [blame]

300

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

301

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

302

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

303

field. (required)

304

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

Bu Sun Kim

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

[diff] [blame]

305

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

Dan O'Meara

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

[diff] [blame]

306

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

307

The object takes the form of:

308

309

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

Bu Sun Kim

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

[diff] [blame^]

310

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

311

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

312

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

Bu Sun Kim

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

[diff] [blame]

313

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

314

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

Bu Sun Kim

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

[diff] [blame^]

315

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

Dan O'Meara

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

[diff] [blame]

316

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

317

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

318

# field.

Bu Sun Kim

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

[diff] [blame^]

319

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

320

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

Bu Sun Kim

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

[diff] [blame]

321

}

322

323

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

330

331

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

332

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

Bu Sun Kim

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

[diff] [blame^]

333

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

Bu Sun Kim

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

[diff] [blame]

334

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

335

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

Bu Sun Kim

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

[diff] [blame^]

336

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

337

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

Bu Sun Kim

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

[diff] [blame]

338

},

339

],

Bu Sun Kim

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

[diff] [blame^]

340

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

Dan O'Meara

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

[diff] [blame]

341

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

342

# or

343

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

344

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame^]

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

},

355

],

356

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

357

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

358

# Object with schema name: OperationProgress

359

],

360

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

361

# Unset for single-stage operations.

362

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

363

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

364

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

365

# or

366

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

367

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

368

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

369

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

370

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

371

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

372

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

373

},

374

],

375

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

376

# Unset for single-stage operations.

377

},

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

392

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

Bu Sun Kim

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

[diff] [blame]

393

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

394

Compute Engine instances.

395

Bu Sun Kim

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

[diff] [blame^]

396

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

Dan O'Meara

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

[diff] [blame]

397

[default

398

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

Bu Sun Kim

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

[diff] [blame]

399

400

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

401

the Kubelet creates routes for each node to allow the containers

402

on that node to communicate with all other instances in the

403

cluster.

404

Bu Sun Kim

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

[diff] [blame^]

405

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

Bu Sun Kim

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

[diff] [blame]

406

which CIDR range the cluster is using.

407

408

Args:

Dan O'Meara

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

[diff] [blame]

409

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

Bu Sun Kim

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

[diff] [blame]

410

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

411

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

Dan O'Meara

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

[diff] [blame]

412

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

413

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

414

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

415

field. (required)

416

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

417

The object takes the form of:

418

419

{ # CreateClusterRequest creates a cluster.

Bu Sun Kim

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

[diff] [blame^]

420

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

Bu Sun Kim

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

[diff] [blame]

421

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

422

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

Bu Sun Kim

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

[diff] [blame^]

423

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

Dan O'Meara

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

[diff] [blame]

424

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

Bu Sun Kim

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

[diff] [blame^]

425

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

426

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

427

# if cluster created with IP Alias support.

428

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

429

},

430

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

431

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

432

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

433

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

434

# name.

435

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

436

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

Bu Sun Kim

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

[diff] [blame]

437

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

438

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

439

# mode.

Bu Sun Kim

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

[diff] [blame^]

440

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

441

# master authorized networks will disallow all external traffic to access

442

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

443

# Google Compute Engine Public IPs and Google Prod IPs.

444

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

445

# Kubernetes master through HTTPS.

446

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

447

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

448

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

449

},

450

],

451

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

452

},

453

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

454

# cluster, if available.

455

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

456

# If unspecified, the defaults are used:

457

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

458

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

459

# certificate will be issued.

460

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

461

# certificates.

462

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

463

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

464

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

465

# must be non-empty.

466

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

467

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

468

# certificate is issued.

469

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

470

},

471

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

472

# to the cluster endpoint.

473

"clusterCaCertificate": "A String",

474

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

475

# authenticate to the cluster endpoint.

476

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

477

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

478

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

479

},

480

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

481

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

482

# during authentication using a group of security groups.

483

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

484

# if enabled = true.

485

},

486

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

487

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

488

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

489

# This field is deprecated, use

490

# private_cluster_config.master_ipv4_cidr_block instead.

491

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

492

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

493

},

494

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

495

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

496

# cluster, enabling additional functionality.

497

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

498

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

499

# is enabled for the nodes.

500

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

501

# is enabled for the nodes.

502

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

503

},

504

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

505

# extension to manage hosted GCP services through the Kubernetes API

506

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

507

},

508

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

509

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

510

# at cluster creation time.

511

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

512

},

513

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

514

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

515

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

516

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

517

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

518

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

519

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

520

# Monitoring.

521

},

522

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

523

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

524

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

525

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

526

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

527

# balancers.

528

},

529

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

530

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

531

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

532

# workloads and applications. For more information, see:

533

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

534

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

535

},

536

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

537

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

538

},

539

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

540

# applications.

541

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

542

},

543

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

544

# enabled at cluster creation time.

545

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

546

},

547

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

548

# microservices.

549

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

550

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

551

},

552

},

553

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

554

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

555

# must be valid under a PodSecurityPolicy to be created.

556

},

557

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

558

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

559

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

560

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

561

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

562

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

563

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

564

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

565

# the name.

566

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

567

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

568

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

569

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

570

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

571

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

572

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

573

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

574

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

575

# smallest possible in the given scenario.

576

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

577

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

578

},

579

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

580

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

581

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

Bu Sun Kim

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

[diff] [blame^]

582

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

583

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

584

# end time.

585

#

Bu Sun Kim

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

[diff] [blame^]

586

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

Dan O'Meara

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

[diff] [blame]

587

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

588

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

589

# <code>FREQ=DAILY</code>

590

# For the first weekend of every month:

591

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

592

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

593

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

594

# <code>

595

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

596

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

597

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

598

# </code>

599

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

600

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

601

# <code>

602

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

603

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

604

# recurrence = FREQ=WEEKLY;BYDAY=SA

605

# </code>

Bu Sun Kim

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

[diff] [blame^]

606

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

607

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

608

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

Bu Sun Kim

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

[diff] [blame^]

609

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

610

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

611

# start time.

Bu Sun Kim

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

[diff] [blame^]

612

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

Dan O'Meara

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

[diff] [blame]

613

},

614

},

Bu Sun Kim

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

[diff] [blame^]

615

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

Dan O'Meara

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

[diff] [blame]

616

# occur in these windows.

Bu Sun Kim

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

[diff] [blame^]

617

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

618

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

619

# start time.

Bu Sun Kim

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

[diff] [blame^]

620

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

Dan O'Meara

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

[diff] [blame]

621

},

622

},

Bu Sun Kim

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

[diff] [blame]

623

},

624

},

Bu Sun Kim

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

[diff] [blame^]

625

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

626

# Google Compute Engine resources.

627

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

628

},

Bu Sun Kim

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

[diff] [blame^]

629

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

630

# found in validMasterVersions returned by getServerConfig. The version can

631

# be upgraded over time; such upgrades are reflected in

632

# currentMasterVersion and currentNodeVersion.

Dan O'Meara

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

[diff] [blame]

633

#

Bu Sun Kim

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

[diff] [blame^]

634

# Users may specify either explicit versions offered by

635

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

Dan O'Meara

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

[diff] [blame]

636

#

Bu Sun Kim

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

[diff] [blame^]

637

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

638

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

639

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

640

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

641

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

642

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

643

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

644

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

645

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

646

# then the server picks the default IP allocation mode

647

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

648

# will be automatically chosen with the default size.

649

#

650

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

651

#

652

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

653

#

654

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

659

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

660

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

661

# to use.

Bu Sun Kim

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

[diff] [blame^]

662

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

663

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

664

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

665

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

666

# range.

667

#

668

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

669

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

670

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

671

# `services_ipv4_cidr_block` must be fully-specified.

672

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

673

# fully-specified.

674

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

675

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

676

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

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

[diff] [blame]

677

#

678

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

Bu Sun Kim

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

[diff] [blame^]

679

#

680

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

681

#

682

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

687

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

688

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

689

# to use.

690

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

691

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

692

# addresses. This must be an existing secondary range associated

693

# with the cluster subnetwork.

694

#

695

# This field is only applicable with use_ip_aliases and

696

# create_subnetwork is false.

697

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

698

#

699

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

700

#

701

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

702

#

703

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

708

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

709

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

710

# to use.

Bu Sun Kim

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

[diff] [blame^]

711

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

712

# range will be automatically chosen with the default size.

713

#

714

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

715

#

716

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

717

#

718

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

723

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

724

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

725

# to use.

Dan O'Meara

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

[diff] [blame]

726

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

Bu Sun Kim

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

[diff] [blame^]

727

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

728

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

729

# ClusterIPs. This must be an existing secondary range associated

730

# with the cluster subnetwork.

731

#

732

# This field is only applicable with use_ip_aliases and

733

# create_subnetwork is false.

Bu Sun Kim

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

[diff] [blame^]

734

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

735

# This is used in conjunction with use_routes. It cannot

736

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

737

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

738

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

739

#

740

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

741

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

742

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

743

# subnetwork.

744

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

745

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

Bu Sun Kim

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

[diff] [blame]

746

},

Bu Sun Kim

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

[diff] [blame^]

747

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

748

# mode.

749

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

750

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

751

# controllers, will have statically granted permissions beyond those

752

# provided by the RBAC configuration or IAM.

Bu Sun Kim

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

[diff] [blame]

753

},

Bu Sun Kim

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

[diff] [blame^]

754

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

755

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

756

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

757

# disabled when this config unspecified.

758

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

759

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

760

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

761

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

762

# second BigQuery table will be created to hold resource consumption

763

# records.

Bu Sun Kim

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

[diff] [blame]

764

},

Bu Sun Kim

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

[diff] [blame^]

765

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

766

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

Bu Sun Kim

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

[diff] [blame]

767

},

Bu Sun Kim

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

[diff] [blame]

768

},

Bu Sun Kim

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

[diff] [blame^]

769

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

770

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

771

# cluster's nodes should be located.

772

"A String",

773

],

774

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

775

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

Bu Sun Kim

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

[diff] [blame]

776

# specified.

Bu Sun Kim

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

[diff] [blame^]

777

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

778

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

Bu Sun Kim

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

[diff] [blame]

779

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

780

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

781

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

782

# the workload.

Bu Sun Kim

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

[diff] [blame^]

783

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

784

# node pool instance, if available.

785

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

Bu Sun Kim

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

[diff] [blame]

786

# only if a valid configuration is present.

787

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

Bu Sun Kim

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

[diff] [blame^]

788

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

Bu Sun Kim

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

[diff] [blame]

789

# max_node_count.

Bu Sun Kim

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

[diff] [blame^]

790

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

791

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

792

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

Bu Sun Kim

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

[diff] [blame]

793

# has to enough quota to scale up the cluster.

794

},

Bu Sun Kim

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

[diff] [blame^]

795

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

796

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

797

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

798

# firewall and routes quota.

799

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

800

# disruption caused by an upgrade.

801

#

802

# maxUnavailable controls the number of nodes that can be simultaneously

803

# unavailable.

804

#

805

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

806

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

807

# available nodes.

808

#

809

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

810

# nodes are being upgraded at the same time).

811

#

812

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

813

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

814

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

815

# PodDisruptionBudget, if it is configured.)

816

#

817

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

818

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

819

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

820

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

821

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame^]

822

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

Dan O'Meara

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

[diff] [blame]

823

# of the node pool during the upgrade process.

Bu Sun Kim

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

[diff] [blame^]

824

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

825

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

826

# Ready.

827

},

Bu Sun Kim

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

[diff] [blame^]

828

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

829

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

830

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

831

# NodePool's nodes should be located.

832

"A String",

833

],

834

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

Dan O'Meara

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

[diff] [blame]

835

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

836

# associated with this node pool.

Bu Sun Kim

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

[diff] [blame^]

837

"A String",

Dan O'Meara

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

[diff] [blame]

838

],

Bu Sun Kim

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

[diff] [blame^]

839

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

840

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

841

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

842

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

843

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

844

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

845

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

Dan O'Meara

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

[diff] [blame]

846

},

Bu Sun Kim

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

[diff] [blame^]

847

],

848

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

849

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

850

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

851

# The smallest allowed disk size is 10GB.

852

#

853

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

854

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

855

# workloads on the node pool.

856

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

857

# workloads running on the node.

858

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

859

# on the node pool.

Bu Sun Kim

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

[diff] [blame]

860

},

Bu Sun Kim

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

[diff] [blame^]

861

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

862

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

863

# support for GPUs.

864

{ # AcceleratorConfig represents a Hardware Accelerator request.

865

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

866

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

867

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

868

},

869

],

870

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

Dan O'Meara

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

[diff] [blame]

871

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

Bu Sun Kim

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

[diff] [blame]

872

# `n1-standard-1`).

873

#

874

# If unspecified, the default machine type is

875

# `n1-standard-1`.

Bu Sun Kim

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

[diff] [blame^]

876

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

877

#

878

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

879

"bootDiskKmsKey": "A String", #

880

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

881

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

882

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

883

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

884

# see:

885

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

886

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

887

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

888

#

889

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

890

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

891

# boot process if signature verification fails.

892

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

Bu Sun Kim

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

[diff] [blame]

893

#

894

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

895

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

896

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

897

# the instance is created.

Bu Sun Kim

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

[diff] [blame]

898

},

Bu Sun Kim

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

[diff] [blame^]

899

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

900

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

901

# friendly names of CPU platforms, such as

902

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

903

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

904

# information, read [how to specify min CPU

905

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

906

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

907

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

908

# inforamtion about preemptible VM instances.

909

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

Bu Sun Kim

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

[diff] [blame]

910

#

Bu Sun Kim

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

[diff] [blame^]

911

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

912

# disks available on a machine per zone. See:

913

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

914

# for more information.

915

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

916

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

917

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

918

},

919

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

920

#

921

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

922

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

923

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

924

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

930

# "enable-oslogin"

931

# "gci-ensure-gke-docker"

932

# "gci-metrics-enabled"

933

# "gci-update-strategy"

934

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

939

# "windows-startup-script-ps1"

940

# "common-psm1"

941

# "k8s-node-setup-psm1"

942

# "install-ssh-psm1"

943

# "user-profile-psm1"

944

# "serial-port-logging-enable"

945

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

946

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

947

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

948

#

949

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

950

"a_key": "A String",

951

},

952

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

953

# the specified [Zonal Compute

954

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

955

# to this node pool.

956

# is the configuration of desired reservation which instances could take

957

# capacity from.

958

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

959

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

960

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

961

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

962

"A String",

963

],

964

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

965

},

966

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

Bu Sun Kim

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

[diff] [blame]

967

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

968

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

969

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame^]

970

"A String",

Bu Sun Kim

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

[diff] [blame]

971

],

Bu Sun Kim

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

[diff] [blame^]

972

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

973

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

Bu Sun Kim

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

[diff] [blame^]

974

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

975

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

976

# the latest version of it will be used.

977

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

978

# node VMs under the "default" service account.

Bu Sun Kim

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

[diff] [blame]

979

#

980

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

981

# not included:

982

#

983

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

984

# persistent storage on your nodes.

985

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

986

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

987

# (the [Google Container

988

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

Bu Sun Kim

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

[diff] [blame]

989

#

990

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

991

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

Bu Sun Kim

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

[diff] [blame^]

992

"A String",

Bu Sun Kim

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

[diff] [blame]

993

],

Bu Sun Kim

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

[diff] [blame^]

994

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

Bu Sun Kim

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

[diff] [blame]

995

#

996

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

997

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

998

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

999

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

1000

#

Bu Sun Kim

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

[diff] [blame^]

1001

# See

1002

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

1003

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

1004

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

1005

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

1006

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

Bu Sun Kim

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

[diff] [blame]

1007

},

1008

],

Bu Sun Kim

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

[diff] [blame^]

1009

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

1010

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

1011

# Kubernetes may apply to the node.

1012

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

1013

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

1014

# and conflicts should be avoided.

1015

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

1016

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

1017

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1018

},

1019

},

Bu Sun Kim

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

[diff] [blame^]

1020

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

1021

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

1022

# simultaneously on a node in the node pool.

1023

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

1024

},

1025

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

1026

# node pool.

1027

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

1028

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

1029

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

1030

# the Auto Upgrades will proceed.

1031

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

1032

# with the description of the upgrade.

1033

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

1034

# with the approximate start time for the upgrades, in

1035

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

1036

},

1037

},

Bu Sun Kim

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

[diff] [blame]

1038

},

1039

],

Bu Sun Kim

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

[diff] [blame^]

1040

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

1041

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

1042

# this cluster, in

1043

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

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

},

1051

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

1052

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

1053

# frequency of updates.

1054

#

1055

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

1056

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

1057

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

1058

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

1059

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

1060

},

1061

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

1062

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

1063

# the kubernetes version of the master and nodes.

1064

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

1065

# Alpha enabled clusters are automatically deleted thirty days after

1066

# creation.

1067

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

1068

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

1069

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

1070

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

1071

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

1072

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

1073

},

1074

],

1075

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

1076

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

1077

# master communicate over private IP addresses.

1078

# This field is deprecated, use private_cluster_config.enable_private_nodes

1079

# instead.

1080

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

1081

# Call Kubernetes API directly to retrieve node information.

1082

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

Bu Sun Kim

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

[diff] [blame]

1083

# Currently available options:

1084

#

Bu Sun Kim

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

[diff] [blame^]

1085

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

Dan O'Meara

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

[diff] [blame]

1086

# service with a Kubernetes-native resource model

1087

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

1088

# longer available as of GKE 1.15).

1089

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

1090

#

1091

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

1092

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

Bu Sun Kim

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

[diff] [blame^]

1093

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

1094

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

1095

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

Dan O'Meara

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

[diff] [blame]

1096

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

Bu Sun Kim

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

[diff] [blame]

1097

},

Bu Sun Kim

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

[diff] [blame^]

1098

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

1099

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

1100

# images will be validated by Google Binauthz.

Bu Sun Kim

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

[diff] [blame]

1101

},

Bu Sun Kim

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

[diff] [blame^]

1102

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

1103

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

1104

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

1105

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

1106

# policies.

1107

# policies.

1108

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

1109

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

1110

},

1111

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

Dan O'Meara

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

[diff] [blame]

1112

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

1113

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

Bu Sun Kim

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

[diff] [blame^]

1114

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

1115

# Currently available options:

Bu Sun Kim

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

[diff] [blame]

1116

#

Bu Sun Kim

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

[diff] [blame^]

1117

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

1118

# service with a Kubernetes-native resource model

1119

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

1120

# available as of GKE 1.15).

1121

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

Bu Sun Kim

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

[diff] [blame]

1122

#

Bu Sun Kim

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

[diff] [blame^]

1123

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

1124

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

1125

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

1126

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1127

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1128

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1129

# "node_pool" object, since this configuration (along with the

1130

# "initial_node_count") will be used to create a "NodePool" object with an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1131

# auto-generated name. Do not use this and a node_pool at the same time.

1132

# For responses, this field will be populated with the node configuration of

1133

# the first node pool. (For configuration of each node pool, see

1134

# `node_pool.config`)

1135

#

1136

# If unspecified, the defaults are used.

1137

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1138

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

1139

# The smallest allowed disk size is 10GB.

1140

#

1141

# If unspecified, the default disk size is 100GB.

1142

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

1143

# workloads on the node pool.

1144

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

1145

# workloads running on the node.

1146

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

1147

# on the node pool.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1148

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1149

"accelerators": [ # A list of hardware accelerators to be attached to each node.

1150

# See https://cloud.google.com/compute/docs/gpus for more information about

1151

# support for GPUs.

1152

{ # AcceleratorConfig represents a Hardware Accelerator request.

1153

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1154

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

1155

# [here](https://cloud.google.com/compute/docs/gpus)

1156

},

1157

],

1158

"machineType": "A String", # The name of a Google Compute Engine [machine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1159

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1160

# `n1-standard-1`).

1161

#

1162

# If unspecified, the default machine type is

1163

# `n1-standard-1`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1164

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

1165

#

1166

# If unspecified, the default disk type is 'pd-standard'

1167

"bootDiskKmsKey": "A String", #

1168

# The Customer Managed Encryption Key used to encrypt the boot disk attached

1169

# to each node in the node pool. This should be of the form

1170

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

1171

# For more information about protecting resources with Cloud KMS Keys please

1172

# see:

1173

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

1174

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1175

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1176

#

1177

# Secure Boot helps ensure that the system only runs authentic software by

1178

# verifying the digital signature of all boot components, and halting the

1179

# boot process if signature verification fails.

1180

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1181

#

1182

# Enables monitoring and attestation of the boot integrity of the instance.

1183

# The attestation is performed against the integrity policy baseline. This

1184

# baseline is initially derived from the implicitly trusted boot image when

1185

# the instance is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1186

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1187

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

1188

# scheduled on the specified or newer CPU platform. Applicable values are the

1189

# friendly names of CPU platforms, such as

1190

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

1191

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

1192

# information, read [how to specify min CPU

1193

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1194

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

1195

# https://cloud.google.com/compute/docs/instances/preemptible for more

1196

# inforamtion about preemptible VM instances.

1197

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1198

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1199

# The limit for this value is dependent upon the maximum number of

1200

# disks available on a machine per zone. See:

1201

# https://cloud.google.com/compute/docs/disks/local-ssd

1202

# for more information.

1203

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1204

"type": "A String", # Type of the sandbox to use for the node.

1205

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

1206

},

1207

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

1208

#

1209

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

1210

# in length. These are reflected as part of a URL in the metadata server.

1211

# Additionally, to avoid ambiguity, keys must not conflict with any other

1212

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1218

# "enable-oslogin"

1219

# "gci-ensure-gke-docker"

1220

# "gci-metrics-enabled"

1221

# "gci-update-strategy"

1222

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1227

# "windows-startup-script-ps1"

1228

# "common-psm1"

1229

# "k8s-node-setup-psm1"

1230

# "install-ssh-psm1"

1231

# "user-profile-psm1"

1232

# "serial-port-logging-enable"

1233

# Values are free-form strings, and only have meaning as interpreted by

1234

# the image running in the instance. The only restriction placed on them is

1235

# that each value's size must be less than or equal to 32 KB.

1236

#

1237

# The total size of all keys and values must be less than 512 KB.

1238

"a_key": "A String",

1239

},

1240

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

1241

# the specified [Zonal Compute

1242

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

1243

# to this node pool.

1244

# is the configuration of desired reservation which instances could take

1245

# capacity from.

1246

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

1247

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

1248

# the key and specify the name of your reservation as its value.

1249

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1250

"A String",

1251

],

1252

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1253

},

1254

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1255

# valid sources or targets for network firewalls and are specified by

1256

# the client during cluster or node pool creation. Each tag within the list

1257

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1258

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1259

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1260

"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]

1261

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1262

# Account is specified, the "default" service account is used.

1263

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

1264

# the latest version of it will be used.

1265

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

1266

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1267

#

1268

# The following scopes are recommended, but not required, and by default are

1269

# not included:

1270

#

1271

# * `https://www.googleapis.com/auth/compute` is required for mounting

1272

# persistent storage on your nodes.

1273

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

1274

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1275

# (the [Google Container

1276

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1277

#

1278

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

1279

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1280

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1281

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1282

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1283

#

1284

# For more information, including usage and the valid values, see:

1285

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1286

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

1287

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

1288

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1289

# See

1290

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

1291

# for more information, including usage and the valid values.

1292

"key": "A String", # Key for taint.

1293

"value": "A String", # Value for taint.

1294

"effect": "A String", # Effect for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1295

},

1296

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1297

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

1298

# These will added in addition to any default label(s) that

1299

# Kubernetes may apply to the node.

1300

# In case of conflict in label keys, the applied set may differ depending on

1301

# the Kubernetes version -- it's best to assume the behavior is undefined

1302

# and conflicts should be avoided.

1303

# For more information, including usage and the valid values, see:

1304

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

1305

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1306

},

1307

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1308

"status": "A String", # [Output only] The current status of this cluster.

1309

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

1310

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

1311

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

1312

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

1313

},

1314

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

1315

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

1316

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

1317

# cluster is connected. Example:

1318

# projects/my-project/regions/us-central1/subnetworks/my-subnet

1319

"network": "A String", # Output only. The relative name of the Google Compute Engine

1320

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1321

# to which the cluster is connected. Example:

1322

# projects/my-project/global/networks/my-network

1323

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

1324

# This makes same node pod to pod traffic visible for VPC network.

1325

},

1326

"name": "A String", # The name of this cluster. The name must be unique within this project

1327

# and location (e.g. zone or region), and can be up to 40 characters with

1328

# the following restrictions:

1329

#

1330

# * Lowercase letters, numbers, and hyphens only.

1331

# * Must start with a letter.

1332

# * Must end with a number or a letter.

1333

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

1334

# The endpoint can be accessed from the internet at

1335

# `https://username:password@endpoint/`.

1336

#

1337

# See the `masterAuth` property of this resource for username and

1338

# password information.

1339

"location": "A String", # [Output only] The name of the Google Compute Engine

1340

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1341

# or

1342

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1343

# in which the cluster resides.

1344

"createTime": "A String", # [Output only] The time the cluster was created, in

1345

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1346

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1347

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1348

# notation (e.g. `10.96.0.0/14`). Leave blank to have

1349

# 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^]

1350

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

1351

# required by Cluster Autoscaler to automatically adjust

1352

# the size of the cluster and create/delete

1353

# node pools based on the current needs.

1354

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

1355

# amount of resources in the cluster.

1356

{ # Contains information about amount of some resource in the cluster.

1357

# For memory, value should be in GB.

1358

"maximum": "A String", # Maximum amount of the resource in the cluster.

1359

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

1360

"minimum": "A String", # Minimum amount of the resource in the cluster.

1361

},

1362

],

1363

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

1364

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

1365

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

1366

# created by NAP.

1367

# by NAP.

1368

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

1369

# specified, service_account should be empty.

1370

"A String",

1371

],

1372

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

1373

# node pool.

1374

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

1375

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

1376

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

1377

# the Auto Upgrades will proceed.

1378

"description": "A String", # [Output only] This field is set when upgrades are about to commence

1379

# with the description of the upgrade.

1380

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

1381

# with the approximate start time for the upgrades, in

1382

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1383

},

1384

},

1385

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

1386

# The instance may be scheduled on the specified or newer CPU platform.

1387

# Applicable values are the friendly names of CPU platforms, such as

1388

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

1389

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

1390

# information, read [how to specify min CPU

1391

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1392

# To unset the min cpu platform field pass "automatic" as field value.

1393

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

1394

# disruption caused by an upgrade.

1395

#

1396

# maxUnavailable controls the number of nodes that can be simultaneously

1397

# unavailable.

1398

#

1399

# maxSurge controls the number of additional nodes that can be added to the

1400

# node pool temporarily for the time of the upgrade to increase the number of

1401

# available nodes.

1402

#

1403

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

1404

# nodes are being upgraded at the same time).

1405

#

1406

# Note: upgrades inevitably introduce some disruption since workloads need to

1407

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

1408

# this holds true. (Disruption stays within the limits of

1409

# PodDisruptionBudget, if it is configured.)

1410

#

1411

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

1412

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

1413

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

1414

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

1415

# there are always at least 4 nodes available.

1416

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

1417

# of the node pool during the upgrade process.

1418

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

1419

# the upgrade process. A node is considered available if its status is

1420

# Ready.

1421

},

1422

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

1423

# service_account is specified, scopes should be empty.

1424

},

1425

"autoprovisioningLocations": [ # The list of Google Compute Engine

1426

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1427

# NodePool's nodes can be created by NAP.

1428

"A String",

1429

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1430

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1431

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

1432

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1433

# is sufficient for this number of instances. You must also have available

1434

# firewall and routes quota.

1435

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1436

# "node_pool" object, since this configuration (along with the

1437

# "node_config") will be used to create a "NodePool" object with an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1438

# auto-generated name. Do not use this and a node_pool at the same time.

1439

#

1440

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1441

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

1442

"A String",

1443

],

1444

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

1445

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

1446

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

1447

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

1448

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

1449

"enabled": True or False, # Whenever master is accessible globally or not.

1450

},

1451

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

1452

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

1453

# given only RFC 1918 private addresses and communicate with the master via

1454

# private networking.

1455

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

1456

# range will be used for assigning internal IP addresses to the master or

1457

# set of masters, as well as the ILB VIP. This range must not overlap with

1458

# any other ranges in use within the cluster's network.

1459

},

1460

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

1461

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

1462

},

1463

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

1464

# required by Vertical Pod Autoscaler to automatically adjust

1465

# the resources of pods controlled by it.

1466

"enabled": True or False, # Enables vertical pod autoscaling.

1467

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1468

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1469

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

1470

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1471

# cluster resides. This field has been deprecated and replaced by the parent

1472

# field.

1473

"parent": "A String", # The parent (project and location) where the cluster will be created.

1474

# Specified in the format `projects/*/locations/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1475

}

1476

1477

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1484

1485

{ # This operation resource represents operations that may have happened or are

1486

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1487

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1488

{ # StatusCondition describes why a cluster or a node pool has a certain status

1489

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1490

"code": "A String", # Machine-friendly representation of the condition

1491

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1492

},

1493

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1494

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1495

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1496

# or

1497

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1498

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1499

"endTime": "A String", # [Output only] The time the operation completed, in

1500

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1501

"startTime": "A String", # [Output only] The time the operation started, in

1502

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1503

"clusterConditions": [ # Which conditions caused the current cluster state.

1504

{ # StatusCondition describes why a cluster or a node pool has a certain status

1505

# (e.g., ERROR or DEGRADED).

1506

"code": "A String", # Machine-friendly representation of the condition

1507

"message": "A String", # Human-friendly representation of the condition

1508

},

1509

],

1510

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1511

"stages": [ # Substages of an operation or a stage.

1512

# Object with schema name: OperationProgress

1513

],

1514

"status": "A String", # Status of an operation stage.

1515

# Unset for single-stage operations.

1516

"metrics": [ # Progress metric bundle, for example:

1517

# metrics: [{name: "nodes done", int_value: 15},

1518

# {name: "nodes total", int_value: 32}]

1519

# or

1520

# metrics: [{name: "progress", double_value: 0.56},

1521

# {name: "progress scale", double_value: 1.0}]

1522

{ # Progress metric is (string, int|float|string) pair.

1523

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1524

"doubleValue": 3.14, # For metrics with floating point value.

1525

"intValue": "A String", # For metrics with integer value.

1526

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1527

},

1528

],

1529

"name": "A String", # A non-parameterized string describing an operation stage.

1530

# Unset for single-stage operations.

1531

},

1532

"zone": "A String", # The name of the Google Compute Engine

1533

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1534

# operation is taking place. This field is deprecated, use location instead.

1535

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1536

"selfLink": "A String", # Server-defined URL for the resource.

1537

"targetLink": "A String", # Server-defined URL for the target of the operation.

1538

"detail": "A String", # Detailed operation progress, if available.

1539

"operationType": "A String", # The operation type.

1540

"status": "A String", # The current status of the operation.

1541

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(projectId, zone, clusterId, name=None, x__xgafv=None)</code>

1547

<pre>Deletes the cluster, including the Kubernetes endpoint and all worker

1548

nodes.

1549

1550

Firewalls and routes that were configured during cluster creation

1551

are also deleted.

1552

1553

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^]

1554

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]

1555

when the cluster was initially created.

1556

1557

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1558

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1559

number](https://support.google.com/cloud/answer/6158840).

1560

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1561

zone: string, Required. Deprecated. The name of the Google Compute Engine

1562

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1563

cluster resides. This field has been deprecated and replaced by the name

1564

field. (required)

1565

clusterId: string, Required. Deprecated. The name of the cluster to delete.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1566

This field has been deprecated and replaced by the name field. (required)

1567

name: string, The name (project, location, cluster) of the cluster to delete.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1568

Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1569

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1576

1577

{ # This operation resource represents operations that may have happened or are

1578

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1579

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1580

{ # StatusCondition describes why a cluster or a node pool has a certain status

1581

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1582

"code": "A String", # Machine-friendly representation of the condition

1583

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1584

},

1585

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1586

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1587

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1588

# or

1589

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1590

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1591

"endTime": "A String", # [Output only] The time the operation completed, in

1592

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1593

"startTime": "A String", # [Output only] The time the operation started, in

1594

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1595

"clusterConditions": [ # Which conditions caused the current cluster state.

1596

{ # StatusCondition describes why a cluster or a node pool has a certain status

1597

# (e.g., ERROR or DEGRADED).

1598

"code": "A String", # Machine-friendly representation of the condition

1599

"message": "A String", # Human-friendly representation of the condition

1600

},

1601

],

1602

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1603

"stages": [ # Substages of an operation or a stage.

1604

# Object with schema name: OperationProgress

1605

],

1606

"status": "A String", # Status of an operation stage.

1607

# Unset for single-stage operations.

1608

"metrics": [ # Progress metric bundle, for example:

1609

# metrics: [{name: "nodes done", int_value: 15},

1610

# {name: "nodes total", int_value: 32}]

1611

# or

1612

# metrics: [{name: "progress", double_value: 0.56},

1613

# {name: "progress scale", double_value: 1.0}]

1614

{ # Progress metric is (string, int|float|string) pair.

1615

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1616

"doubleValue": 3.14, # For metrics with floating point value.

1617

"intValue": "A String", # For metrics with integer value.

1618

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1619

},

1620

],

1621

"name": "A String", # A non-parameterized string describing an operation stage.

1622

# Unset for single-stage operations.

1623

},

1624

"zone": "A String", # The name of the Google Compute Engine

1625

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1626

# operation is taking place. This field is deprecated, use location instead.

1627

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1628

"selfLink": "A String", # Server-defined URL for the resource.

1629

"targetLink": "A String", # Server-defined URL for the target of the operation.

1630

"detail": "A String", # Detailed operation progress, if available.

1631

"operationType": "A String", # The operation type.

1632

"status": "A String", # The current status of the operation.

1633

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(projectId, zone, clusterId, name=None, x__xgafv=None)</code>

1639

<pre>Gets the details for a specific cluster.

1640

1641

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1642

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1643

number](https://support.google.com/cloud/answer/6158840).

1644

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1645

zone: string, Required. Deprecated. The name of the Google Compute Engine

1646

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1647

cluster resides. This field has been deprecated and replaced by the name

1648

field. (required)

1649

clusterId: string, Required. Deprecated. The name of the cluster to retrieve.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1650

This field has been deprecated and replaced by the name field. (required)

1651

name: string, The name (project, location, cluster) of the cluster to retrieve.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1652

Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1653

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1660

1661

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1662

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

1663

# simultaneously on a node in the node pool of this cluster. Only honored

1664

# if cluster created with IP Alias support.

1665

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1666

},

1667

"network": "A String", # The name of the Google Compute Engine

1668

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1669

# to which the cluster is connected. If left unspecified, the `default`

1670

# network will be used. On output this shows the network ID instead of the

1671

# name.

1672

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

1673

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1674

# containers. This is provisioned from within the `container_ipv4_cidr`

1675

# range. This field will only be set when cluster is in route-based network

1676

# mode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1677

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

1678

# master authorized networks will disallow all external traffic to access

1679

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

1680

# Google Compute Engine Public IPs and Google Prod IPs.

1681

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

1682

# Kubernetes master through HTTPS.

1683

{ # CidrBlock contains an optional name and one CIDR block.

1684

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

1685

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

1686

},

1687

],

1688

"enabled": True or False, # Whether or not master authorized networks is enabled.

1689

},

1690

"statusMessage": "A String", # [Output only] Additional information about the current status of this

1691

# cluster, if available.

1692

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

1693

# If unspecified, the defaults are used:

1694

# For clusters before v1.12, if master_auth is unspecified, `username` will

1695

# be set to "admin", a random password will be generated, and a client

1696

# certificate will be issued.

1697

# Authentication can be done using HTTP basic auth or using client

1698

# certificates.

1699

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

1700

# Because the master endpoint is open to the Internet, you should create a

1701

# strong password. If a password is provided for cluster creation, username

1702

# must be non-empty.

1703

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

1704

# clusters before v1.12, if no configuration is specified, a client

1705

# certificate is issued.

1706

"issueClientCertificate": True or False, # Issue a client certificate.

1707

},

1708

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

1709

# to the cluster endpoint.

1710

"clusterCaCertificate": "A String",

1711

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

1712

# authenticate to the cluster endpoint.

1713

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

1714

# For clusters v1.6.0 and later, basic authentication can be disabled by

1715

# leaving username unspecified (or setting it to the empty string).

1716

},

1717

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

1718

"enabled": True or False, # Whether this cluster should return group membership lookups

1719

# during authentication using a group of security groups.

1720

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

1721

# if enabled = true.

1722

},

1723

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network.

1724

# This prefix will be used for assigning private IP addresses to the

1725

# master or set of masters, as well as the ILB VIP.

1726

# This field is deprecated, use

1727

# private_cluster_config.master_ipv4_cidr_block instead.

1728

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

1729

"type": "A String", # Type of the integration.

1730

},

1731

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

1732

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

1733

# cluster, enabling additional functionality.

1734

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

1735

# is enabled or not on the Master, it does not track whether network policy

1736

# is enabled for the nodes.

1737

# is enabled or not on the Master, it does not track whether network policy

1738

# is enabled for the nodes.

1739

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1740

},

1741

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

1742

# extension to manage hosted GCP services through the Kubernetes API

1743

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

1744

},

1745

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

1746

# enabled in order to enable Cloud Run addon. This option can only be enabled

1747

# at cluster creation time.

1748

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1749

},

1750

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

1751

# increases or decreases the number of replica pods a replication controller

1752

# has based on the resource usage of the existing pods.

1753

# increases or decreases the number of replica pods a replication controller

1754

# has based on the resource usage of the existing pods.

1755

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

1756

# When enabled, it ensures that metrics are collected into Stackdriver

1757

# Monitoring.

1758

},

1759

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

1760

# makes it easy to set up HTTP load balancers for services in a cluster.

1761

# which makes it easy to set up HTTP load balancers for services in a cluster.

1762

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

1763

# When enabled, it runs a small pod in the cluster that manages the load

1764

# balancers.

1765

},

1766

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

1767

# This addon is deprecated, and will be disabled in 1.15. It is recommended

1768

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

1769

# workloads and applications. For more information, see:

1770

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

1771

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

1772

},

1773

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

1774

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

1775

},

1776

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

1777

# applications.

1778

"enabled": True or False, # Whether KALM is enabled for this cluster.

1779

},

1780

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

1781

# enabled at cluster creation time.

1782

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

1783

},

1784

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

1785

# microservices.

1786

"disabled": True or False, # Whether Istio is enabled for this cluster.

1787

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

1788

},

1789

},

1790

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

1791

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

1792

# must be valid under a PodSecurityPolicy to be created.

1793

},

1794

"currentNodeVersion": "A String", # [Output only] Deprecated, use

1795

# [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools)

1796

# instead. The current version of the node software components.

1797

# If they are currently at multiple versions because they're in the process

1798

# of being upgraded, this reflects the minimum version of all nodes.

1799

"subnetwork": "A String", # The name of the Google Compute Engine

1800

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

1801

# the cluster is connected. On output this shows the subnetwork ID instead of

1802

# the name.

1803

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

1804

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

1805

# the policy won't accidentally undo intermediate changes (and so that users

1806

# of the API unaware of some fields won't accidentally remove other fields).

1807

# Make a <code>get()</code> request to the cluster to get the current

1808

# resource version and include it with requests to set the policy.

1809

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

1810

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1811

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

1812

# smallest possible in the given scenario.

1813

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

1814

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

1815

},

1816

"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]

1817

# maintenance to occur. The time windows may be overlapping. If no

1818

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1819

"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]

1820

# this window reccurs. They go on for the span of time between the start and

1821

# end time.

1822

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1823

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1824

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

1825

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

1826

# <code>FREQ=DAILY</code>

1827

# For the first weekend of every month:

1828

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

1829

# 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^]

1830

# 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]

1831

# <code>

1832

# start time = 2019-01-01T09:00:00-0400

1833

# end time = 2019-01-01T17:00:00-0400

1834

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

1835

# </code>

1836

# Windows can span multiple days. Eg, to make the window encompass every

1837

# weekend from midnight Saturday till the last minute of Sunday UTC:

1838

# <code>

1839

# start time = 2019-01-05T00:00:00Z

1840

# end time = 2019-01-07T23:59:00Z

1841

# recurrence = FREQ=WEEKLY;BYDAY=SA

1842

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1843

# 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]

1844

# to specify duration of the window and when it first starts.

1845

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1846

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

1847

"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]

1848

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1849

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1850

},

1851

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1852

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1853

# occur in these windows.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1854

"a_key": { # Represents an arbitrary window of time.

1855

"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]

1856

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1857

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1858

},

1859

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1860

},

1861

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1862

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

1863

# Google Compute Engine resources.

1864

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1865

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1866

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

1867

# found in validMasterVersions returned by getServerConfig. The version can

1868

# be upgraded over time; such upgrades are reflected in

1869

# currentMasterVersion and currentNodeVersion.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1870

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1871

# Users may specify either explicit versions offered by

1872

# Kubernetes Engine or version aliases, which have the following behavior:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1873

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1874

# - "latest": picks the highest valid Kubernetes version

1875

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

1876

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

1877

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

1878

# - "","-": picks the default Kubernetes version

1879

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

1880

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster.

1881

# This is used in conjunction with use_ip_aliases. It cannot be true if

1882

# use_ip_aliases is true. If both use_ip_aliases and use_routes are false,

1883

# then the server picks the default IP allocation mode

1884

"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]

1885

# will be automatically chosen with the default size.

1886

#

1887

# This field is only applicable when `use_ip_aliases` is true.

1888

#

1889

# Set to blank to have a range chosen with the default size.

1890

#

1891

# 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)

1896

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1897

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1898

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1899

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain

1900

# kinds of network routes. By default we do not allow cluster CIDR ranges to

1901

# intersect with any user declared routes. With allow_route_overlap == true,

1902

# we allow overlapping with CIDR ranges that are larger than the cluster CIDR

1903

# range.

1904

#

1905

# If this field is set to true, then cluster and services CIDRs must be

1906

# fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:

1907

# 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and

1908

# `services_ipv4_cidr_block` must be fully-specified.

1909

# 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be

1910

# fully-specified.

1911

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1912

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

1913

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1914

#

1915

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1916

#

1917

# Set to blank to have a range chosen with the default size.

1918

#

1919

# 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)

1924

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1925

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1926

# to use.

1927

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

1928

# block. The secondary range will be used for pod IP

1929

# addresses. This must be an existing secondary range associated

1930

# with the cluster subnetwork.

1931

#

1932

# This field is only applicable with use_ip_aliases and

1933

# create_subnetwork is false.

1934

"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]

1935

#

1936

# This is applicable only if `create_subnetwork` is true.

1937

#

1938

# Set to blank to have a range chosen with the default size.

1939

#

1940

# 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)

1945

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1946

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1947

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1948

"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]

1949

# range will be automatically chosen with the default size.

1950

#

1951

# This field is only applicable when `use_ip_aliases` is true.

1952

#

1953

# If unspecified, the range will use the default size.

1954

#

1955

# 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)

1960

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1961

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1962

# to use.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1963

# This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1964

"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]

1965

# CIDR block. The secondary range will be used for service

1966

# ClusterIPs. This must be an existing secondary range associated

1967

# with the cluster subnetwork.

1968

#

1969

# This field is only applicable with use_ip_aliases and

1970

# create_subnetwork is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1971

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

1972

# This is used in conjunction with use_routes. It cannot

1973

# be true if use_routes is true. If both use_ip_aliases and use_routes are

1974

# false, then the server picks the default IP allocation mode

1975

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

1976

#

1977

# This field is only applicable when `use_ip_aliases` is true.

1978

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

1979

# this field is empty, then an automatic name will be chosen for the new

1980

# subnetwork.

1981

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

1982

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1983

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1984

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

1985

# mode.

1986

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

1987

# identities in the system, including service accounts, nodes, and

1988

# controllers, will have statically granted permissions beyond those

1989

# provided by the RBAC configuration or IAM.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1990

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1991

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

1992

# This field is deprecated, use tpu_config.enabled instead.

1993

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

1994

# disabled when this config unspecified.

1995

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

1996

# daemonset will be created in the cluster to meter network egress traffic.

1997

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

1998

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

1999

# second BigQuery table will be created to hold resource consumption

2000

# records.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2001

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2002

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2003

"datasetId": "A String", # The ID of a BigQuery Dataset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2004

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2005

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2006

"locations": [ # The list of Google Compute Engine

2007

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2008

# cluster's nodes should be located.

2009

"A String",

2010

],

2011

"nodePools": [ # The node pools associated with this cluster.

2012

# This field should not be set if "node_config" or "initial_node_count" are

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2013

# specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2014

{ # NodePool contains the name and configuration for a cluster's node pool.

2015

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2016

# specification, under the control of the cluster master. They may have a set

2017

# of Kubernetes labels applied to them, which may be used to reference them

2018

# during pod scheduling. They may also be resized up or down, to accommodate

2019

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2020

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2021

# node pool instance, if available.

2022

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2023

# only if a valid configuration is present.

2024

# adjust the size of the node pool to the current cluster usage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2025

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2026

# max_node_count.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2027

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2028

"enabled": True or False, # Is autoscaling enabled for this node pool.

2029

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2030

# has to enough quota to scale up the cluster.

2031

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2032

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

2033

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

2034

# is sufficient for this number of instances. You must also have available

2035

# firewall and routes quota.

2036

"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]

2037

# disruption caused by an upgrade.

2038

#

2039

# maxUnavailable controls the number of nodes that can be simultaneously

2040

# unavailable.

2041

#

2042

# maxSurge controls the number of additional nodes that can be added to the

2043

# node pool temporarily for the time of the upgrade to increase the number of

2044

# available nodes.

2045

#

2046

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2047

# nodes are being upgraded at the same time).

2048

#

2049

# Note: upgrades inevitably introduce some disruption since workloads need to

2050

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2051

# this holds true. (Disruption stays within the limits of

2052

# PodDisruptionBudget, if it is configured.)

2053

#

2054

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2055

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2056

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2057

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2058

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2059

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2060

# of the node pool during the upgrade process.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2061

"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]

2062

# the upgrade process. A node is considered available if its status is

2063

# Ready.

2064

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2065

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2066

"locations": [ # The list of Google Compute Engine

2067

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2068

# NodePool's nodes should be located.

2069

"A String",

2070

],

2071

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2072

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

2073

# associated with this node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2074

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2075

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2076

"version": "A String", # The version of the Kubernetes of this node.

2077

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

2078

"conditions": [ # Which conditions caused the current node pool state.

2079

{ # StatusCondition describes why a cluster or a node pool has a certain status

2080

# (e.g., ERROR or DEGRADED).

2081

"code": "A String", # Machine-friendly representation of the condition

2082

"message": "A String", # Human-friendly representation of the condition

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2083

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2084

],

2085

"status": "A String", # [Output only] The status of the nodes in this pool instance.

2086

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

2087

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2088

# The smallest allowed disk size is 10GB.

2089

#

2090

# If unspecified, the default disk size is 100GB.

2091

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2092

# workloads on the node pool.

2093

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

2094

# workloads running on the node.

2095

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2096

# on the node pool.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2097

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2098

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2099

# See https://cloud.google.com/compute/docs/gpus for more information about

2100

# support for GPUs.

2101

{ # AcceleratorConfig represents a Hardware Accelerator request.

2102

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2103

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2104

# [here](https://cloud.google.com/compute/docs/gpus)

2105

},

2106

],

2107

"machineType": "A String", # The name of a Google Compute Engine [machine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2108

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2109

# `n1-standard-1`).

2110

#

2111

# If unspecified, the default machine type is

2112

# `n1-standard-1`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2113

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2114

#

2115

# If unspecified, the default disk type is 'pd-standard'

2116

"bootDiskKmsKey": "A String", #

2117

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2118

# to each node in the node pool. This should be of the form

2119

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2120

# For more information about protecting resources with Cloud KMS Keys please

2121

# see:

2122

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

2123

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2124

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2125

#

2126

# Secure Boot helps ensure that the system only runs authentic software by

2127

# verifying the digital signature of all boot components, and halting the

2128

# boot process if signature verification fails.

2129

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2130

#

2131

# Enables monitoring and attestation of the boot integrity of the instance.

2132

# The attestation is performed against the integrity policy baseline. This

2133

# baseline is initially derived from the implicitly trusted boot image when

2134

# the instance is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2135

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2136

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2137

# scheduled on the specified or newer CPU platform. Applicable values are the

2138

# friendly names of CPU platforms, such as

2139

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2140

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2141

# information, read [how to specify min CPU

2142

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2143

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2144

# https://cloud.google.com/compute/docs/instances/preemptible for more

2145

# inforamtion about preemptible VM instances.

2146

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2147

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2148

# The limit for this value is dependent upon the maximum number of

2149

# disks available on a machine per zone. See:

2150

# https://cloud.google.com/compute/docs/disks/local-ssd

2151

# for more information.

2152

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2153

"type": "A String", # Type of the sandbox to use for the node.

2154

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

2155

},

2156

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2157

#

2158

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2159

# in length. These are reflected as part of a URL in the metadata server.

2160

# Additionally, to avoid ambiguity, keys must not conflict with any other

2161

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2167

# "enable-oslogin"

2168

# "gci-ensure-gke-docker"

2169

# "gci-metrics-enabled"

2170

# "gci-update-strategy"

2171

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2176

# "windows-startup-script-ps1"

2177

# "common-psm1"

2178

# "k8s-node-setup-psm1"

2179

# "install-ssh-psm1"

2180

# "user-profile-psm1"

2181

# "serial-port-logging-enable"

2182

# Values are free-form strings, and only have meaning as interpreted by

2183

# the image running in the instance. The only restriction placed on them is

2184

# that each value's size must be less than or equal to 32 KB.

2185

#

2186

# The total size of all keys and values must be less than 512 KB.

2187

"a_key": "A String",

2188

},

2189

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2190

# the specified [Zonal Compute

2191

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2192

# to this node pool.

2193

# is the configuration of desired reservation which instances could take

2194

# capacity from.

2195

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2196

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2197

# the key and specify the name of your reservation as its value.

2198

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2199

"A String",

2200

],

2201

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2202

},

2203

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2204

# valid sources or targets for network firewalls and are specified by

2205

# the client during cluster or node pool creation. Each tag within the list

2206

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2207

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2208

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2209

"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]

2210

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2211

# Account is specified, the "default" service account is used.

2212

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2213

# the latest version of it will be used.

2214

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2215

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2216

#

2217

# The following scopes are recommended, but not required, and by default are

2218

# not included:

2219

#

2220

# * `https://www.googleapis.com/auth/compute` is required for mounting

2221

# persistent storage on your nodes.

2222

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2223

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2224

# (the [Google Container

2225

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2226

#

2227

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2228

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2229

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2230

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2231

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2232

#

2233

# For more information, including usage and the valid values, see:

2234

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2235

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2236

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2237

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2238

# See

2239

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2240

# for more information, including usage and the valid values.

2241

"key": "A String", # Key for taint.

2242

"value": "A String", # Value for taint.

2243

"effect": "A String", # Effect for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2244

},

2245

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2246

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2247

# These will added in addition to any default label(s) that

2248

# Kubernetes may apply to the node.

2249

# In case of conflict in label keys, the applied set may differ depending on

2250

# the Kubernetes version -- it's best to assume the behavior is undefined

2251

# and conflicts should be avoided.

2252

# For more information, including usage and the valid values, see:

2253

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2254

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2255

},

2256

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2257

"name": "A String", # The name of the node pool.

2258

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

2259

# simultaneously on a node in the node pool.

2260

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2261

},

2262

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

2263

# node pool.

2264

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

2265

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

2266

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2267

# the Auto Upgrades will proceed.

2268

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2269

# with the description of the upgrade.

2270

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2271

# with the approximate start time for the upgrades, in

2272

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2273

},

2274

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2275

},

2276

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2277

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2278

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

2279

# this cluster, in

2280

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2281

# notation (e.g. `1.2.3.4/29`). Service addresses are

2282

# typically put in the last `/16` from the container CIDR.

2283

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

2284

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

2285

"enabled": True or False, # Whether network policy is enabled on the cluster.

2286

"provider": "A String", # The selected network policy provider.

2287

},

2288

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

2289

# subscribed to. Release channels are arranged in order of risk and

2290

# frequency of updates.

2291

#

2292

# When a cluster is subscribed to a release channel, Google maintains

2293

# both the master version and the node version. Node auto-upgrade

2294

# defaults to true and cannot be disabled. Updates to version related

2295

# fields (e.g. current_master_version) return an error.

2296

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

2297

},

2298

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

2299

# API groups (e.g. v1beta1) and features that may not be production ready in

2300

# the kubernetes version of the master and nodes.

2301

# The cluster has no SLA for uptime and master/node upgrades are disabled.

2302

# Alpha enabled clusters are automatically deleted thirty days after

2303

# creation.

2304

"description": "A String", # An optional description of this cluster.

2305

"conditions": [ # Which conditions caused the current cluster state.

2306

{ # StatusCondition describes why a cluster or a node pool has a certain status

2307

# (e.g., ERROR or DEGRADED).

2308

"code": "A String", # Machine-friendly representation of the condition

2309

"message": "A String", # Human-friendly representation of the condition

2310

},

2311

],

2312

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by

2313

# default have no external IP addresses on the nodes and where nodes and the

2314

# master communicate over private IP addresses.

2315

# This field is deprecated, use private_cluster_config.enable_private_nodes

2316

# instead.

2317

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

2318

# Call Kubernetes API directly to retrieve node information.

2319

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2320

# Currently available options:

2321

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2322

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2323

# service with a Kubernetes-native resource model

2324

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

2325

# longer available as of GKE 1.15).

2326

# * `none` - No metrics will be exported from the cluster.

2327

#

2328

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

2329

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2330

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2331

"state": "A String", # Denotes the state of etcd encryption.

2332

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2333

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2334

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2335

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

2336

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

2337

# images will be validated by Google Binauthz.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2338

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2339

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

2340

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2341

# notation (e.g. `1.2.3.4/29`).

2342

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

2343

# policies.

2344

# policies.

2345

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

2346

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

2347

},

2348

"zone": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2349

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2350

# cluster resides. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2351

"loggingService": "A String", # The logging service the cluster should use to write logs.

2352

# Currently available options:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2353

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2354

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

2355

# service with a Kubernetes-native resource model

2356

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

2357

# available as of GKE 1.15).

2358

# * `none` - no logs will be exported from the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2359

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2360

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

2361

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

2362

"expireTime": "A String", # [Output only] The time the cluster will be automatically

2363

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2364

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2365

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2366

# "node_pool" object, since this configuration (along with the

2367

# "initial_node_count") will be used to create a "NodePool" object with an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2368

# auto-generated name. Do not use this and a node_pool at the same time.

2369

# For responses, this field will be populated with the node configuration of

2370

# the first node pool. (For configuration of each node pool, see

2371

# `node_pool.config`)

2372

#

2373

# If unspecified, the defaults are used.

2374

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2375

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2376

# The smallest allowed disk size is 10GB.

2377

#

2378

# If unspecified, the default disk size is 100GB.

2379

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2380

# workloads on the node pool.

2381

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

2382

# workloads running on the node.

2383

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2384

# on the node pool.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2385

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2386

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2387

# See https://cloud.google.com/compute/docs/gpus for more information about

2388

# support for GPUs.

2389

{ # AcceleratorConfig represents a Hardware Accelerator request.

2390

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2391

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2392

# [here](https://cloud.google.com/compute/docs/gpus)

2393

},

2394

],

2395

"machineType": "A String", # The name of a Google Compute Engine [machine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2396

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2397

# `n1-standard-1`).

2398

#

2399

# If unspecified, the default machine type is

2400

# `n1-standard-1`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2401

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2402

#

2403

# If unspecified, the default disk type is 'pd-standard'

2404

"bootDiskKmsKey": "A String", #

2405

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2406

# to each node in the node pool. This should be of the form

2407

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2408

# For more information about protecting resources with Cloud KMS Keys please

2409

# see:

2410

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

2411

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2412

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2413

#

2414

# Secure Boot helps ensure that the system only runs authentic software by

2415

# verifying the digital signature of all boot components, and halting the

2416

# boot process if signature verification fails.

2417

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2418

#

2419

# Enables monitoring and attestation of the boot integrity of the instance.

2420

# The attestation is performed against the integrity policy baseline. This

2421

# baseline is initially derived from the implicitly trusted boot image when

2422

# the instance is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2423

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2424

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2425

# scheduled on the specified or newer CPU platform. Applicable values are the

2426

# friendly names of CPU platforms, such as

2427

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2428

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2429

# information, read [how to specify min CPU

2430

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2431

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2432

# https://cloud.google.com/compute/docs/instances/preemptible for more

2433

# inforamtion about preemptible VM instances.

2434

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2435

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2436

# The limit for this value is dependent upon the maximum number of

2437

# disks available on a machine per zone. See:

2438

# https://cloud.google.com/compute/docs/disks/local-ssd

2439

# for more information.

2440

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2441

"type": "A String", # Type of the sandbox to use for the node.

2442

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

2443

},

2444

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2445

#

2446

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2447

# in length. These are reflected as part of a URL in the metadata server.

2448

# Additionally, to avoid ambiguity, keys must not conflict with any other

2449

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2455

# "enable-oslogin"

2456

# "gci-ensure-gke-docker"

2457

# "gci-metrics-enabled"

2458

# "gci-update-strategy"

2459

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2464

# "windows-startup-script-ps1"

2465

# "common-psm1"

2466

# "k8s-node-setup-psm1"

2467

# "install-ssh-psm1"

2468

# "user-profile-psm1"

2469

# "serial-port-logging-enable"

2470

# Values are free-form strings, and only have meaning as interpreted by

2471

# the image running in the instance. The only restriction placed on them is

2472

# that each value's size must be less than or equal to 32 KB.

2473

#

2474

# The total size of all keys and values must be less than 512 KB.

2475

"a_key": "A String",

2476

},

2477

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2478

# the specified [Zonal Compute

2479

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2480

# to this node pool.

2481

# is the configuration of desired reservation which instances could take

2482

# capacity from.

2483

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2484

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2485

# the key and specify the name of your reservation as its value.

2486

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2487

"A String",

2488

],

2489

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2490

},

2491

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2492

# valid sources or targets for network firewalls and are specified by

2493

# the client during cluster or node pool creation. Each tag within the list

2494

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2495

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2496

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2497

"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]

2498

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2499

# Account is specified, the "default" service account is used.

2500

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2501

# the latest version of it will be used.

2502

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2503

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2504

#

2505

# The following scopes are recommended, but not required, and by default are

2506

# not included:

2507

#

2508

# * `https://www.googleapis.com/auth/compute` is required for mounting

2509

# persistent storage on your nodes.

2510

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2511

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2512

# (the [Google Container

2513

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2514

#

2515

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2516

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2517

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2518

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2519

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2520

#

2521

# For more information, including usage and the valid values, see:

2522

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2523

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2524

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2525

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2526

# See

2527

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2528

# for more information, including usage and the valid values.

2529

"key": "A String", # Key for taint.

2530

"value": "A String", # Value for taint.

2531

"effect": "A String", # Effect for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2532

},

2533

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2534

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2535

# These will added in addition to any default label(s) that

2536

# Kubernetes may apply to the node.

2537

# In case of conflict in label keys, the applied set may differ depending on

2538

# the Kubernetes version -- it's best to assume the behavior is undefined

2539

# and conflicts should be avoided.

2540

# For more information, including usage and the valid values, see:

2541

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2542

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2543

},

2544

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2545

"status": "A String", # [Output only] The current status of this cluster.

2546

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

2547

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

2548

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

2549

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

2550

},

2551

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

2552

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

2553

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

2554

# cluster is connected. Example:

2555

# projects/my-project/regions/us-central1/subnetworks/my-subnet

2556

"network": "A String", # Output only. The relative name of the Google Compute Engine

2557

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2558

# to which the cluster is connected. Example:

2559

# projects/my-project/global/networks/my-network

2560

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

2561

# This makes same node pod to pod traffic visible for VPC network.

2562

},

2563

"name": "A String", # The name of this cluster. The name must be unique within this project

2564

# and location (e.g. zone or region), and can be up to 40 characters with

2565

# the following restrictions:

2566

#

2567

# * Lowercase letters, numbers, and hyphens only.

2568

# * Must start with a letter.

2569

# * Must end with a number or a letter.

2570

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

2571

# The endpoint can be accessed from the internet at

2572

# `https://username:password@endpoint/`.

2573

#

2574

# See the `masterAuth` property of this resource for username and

2575

# password information.

2576

"location": "A String", # [Output only] The name of the Google Compute Engine

2577

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2578

# or

2579

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2580

# in which the cluster resides.

2581

"createTime": "A String", # [Output only] The time the cluster was created, in

2582

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2583

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2584

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2585

# notation (e.g. `10.96.0.0/14`). Leave blank to have

2586

# 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^]

2587

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

2588

# required by Cluster Autoscaler to automatically adjust

2589

# the size of the cluster and create/delete

2590

# node pools based on the current needs.

2591

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

2592

# amount of resources in the cluster.

2593

{ # Contains information about amount of some resource in the cluster.

2594

# For memory, value should be in GB.

2595

"maximum": "A String", # Maximum amount of the resource in the cluster.

2596

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

2597

"minimum": "A String", # Minimum amount of the resource in the cluster.

2598

},

2599

],

2600

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

2601

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

2602

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

2603

# created by NAP.

2604

# by NAP.

2605

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

2606

# specified, service_account should be empty.

2607

"A String",

2608

],

2609

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

2610

# node pool.

2611

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

2612

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

2613

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2614

# the Auto Upgrades will proceed.

2615

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2616

# with the description of the upgrade.

2617

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2618

# with the approximate start time for the upgrades, in

2619

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2620

},

2621

},

2622

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

2623

# The instance may be scheduled on the specified or newer CPU platform.

2624

# Applicable values are the friendly names of CPU platforms, such as

2625

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2626

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2627

# information, read [how to specify min CPU

2628

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2629

# To unset the min cpu platform field pass "automatic" as field value.

2630

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

2631

# disruption caused by an upgrade.

2632

#

2633

# maxUnavailable controls the number of nodes that can be simultaneously

2634

# unavailable.

2635

#

2636

# maxSurge controls the number of additional nodes that can be added to the

2637

# node pool temporarily for the time of the upgrade to increase the number of

2638

# available nodes.

2639

#

2640

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2641

# nodes are being upgraded at the same time).

2642

#

2643

# Note: upgrades inevitably introduce some disruption since workloads need to

2644

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2645

# this holds true. (Disruption stays within the limits of

2646

# PodDisruptionBudget, if it is configured.)

2647

#

2648

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2649

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2650

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2651

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2652

# there are always at least 4 nodes available.

2653

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2654

# of the node pool during the upgrade process.

2655

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2656

# the upgrade process. A node is considered available if its status is

2657

# Ready.

2658

},

2659

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

2660

# service_account is specified, scopes should be empty.

2661

},

2662

"autoprovisioningLocations": [ # The list of Google Compute Engine

2663

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2664

# NodePool's nodes can be created by NAP.

2665

"A String",

2666

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2667

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2668

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

2669

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2670

# is sufficient for this number of instances. You must also have available

2671

# firewall and routes quota.

2672

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2673

# "node_pool" object, since this configuration (along with the

2674

# "node_config") will be used to create a "NodePool" object with an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2675

# auto-generated name. Do not use this and a node_pool at the same time.

2676

#

2677

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2678

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

2679

"A String",

2680

],

2681

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

2682

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

2683

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

2684

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

2685

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

2686

"enabled": True or False, # Whenever master is accessible globally or not.

2687

},

2688

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

2689

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

2690

# given only RFC 1918 private addresses and communicate with the master via

2691

# private networking.

2692

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

2693

# range will be used for assigning internal IP addresses to the master or

2694

# set of masters, as well as the ILB VIP. This range must not overlap with

2695

# any other ranges in use within the cluster's network.

2696

},

2697

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

2698

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

2699

},

2700

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

2701

# required by Vertical Pod Autoscaler to automatically adjust

2702

# the resources of pods controlled by it.

2703

"enabled": True or False, # Enables vertical pod autoscaling.

2704

},

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]

2709

<code class="details" id="legacyAbac">legacyAbac(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2710

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

2711

2712

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2713

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2714

number](https://support.google.com/cloud/answer/6158840).

2715

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2716

zone: string, Required. Deprecated. The name of the Google Compute Engine

2717

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

2718

cluster resides. This field has been deprecated and replaced by the name

2719

field. (required)

2720

clusterId: string, Required. Deprecated. The name of the cluster to update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2721

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2722

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2723

The object takes the form of:

2724

2725

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for

2726

# a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2727

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac.

2728

# Specified in the format `projects/*/locations/*/clusters/*`.

2729

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

2730

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2731

# number](https://support.google.com/cloud/answer/6158840).

2732

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2733

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2734

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2735

# cluster resides. This field has been deprecated and replaced by the name

2736

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2737

"clusterId": "A String", # Required. Deprecated. The name of the cluster to update.

2738

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2739

}

2740

2741

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2748

2749

{ # This operation resource represents operations that may have happened or are

2750

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2751

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2752

{ # StatusCondition describes why a cluster or a node pool has a certain status

2753

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2754

"code": "A String", # Machine-friendly representation of the condition

2755

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2756

},

2757

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2758

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2759

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2760

# or

2761

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2762

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2763

"endTime": "A String", # [Output only] The time the operation completed, in

2764

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2765

"startTime": "A String", # [Output only] The time the operation started, in

2766

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2767

"clusterConditions": [ # Which conditions caused the current cluster state.

2768

{ # StatusCondition describes why a cluster or a node pool has a certain status

2769

# (e.g., ERROR or DEGRADED).

2770

"code": "A String", # Machine-friendly representation of the condition

2771

"message": "A String", # Human-friendly representation of the condition

2772

},

2773

],

2774

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2775

"stages": [ # Substages of an operation or a stage.

2776

# Object with schema name: OperationProgress

2777

],

2778

"status": "A String", # Status of an operation stage.

2779

# Unset for single-stage operations.

2780

"metrics": [ # Progress metric bundle, for example:

2781

# metrics: [{name: "nodes done", int_value: 15},

2782

# {name: "nodes total", int_value: 32}]

2783

# or

2784

# metrics: [{name: "progress", double_value: 0.56},

2785

# {name: "progress scale", double_value: 1.0}]

2786

{ # Progress metric is (string, int|float|string) pair.

2787

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2788

"doubleValue": 3.14, # For metrics with floating point value.

2789

"intValue": "A String", # For metrics with integer value.

2790

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2791

},

2792

],

2793

"name": "A String", # A non-parameterized string describing an operation stage.

2794

# Unset for single-stage operations.

2795

},

2796

"zone": "A String", # The name of the Google Compute Engine

2797

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2798

# operation is taking place. This field is deprecated, use location instead.

2799

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

2800

"selfLink": "A String", # Server-defined URL for the resource.

2801

"targetLink": "A String", # Server-defined URL for the target of the operation.

2802

"detail": "A String", # Detailed operation progress, if available.

2803

"operationType": "A String", # The operation type.

2804

"status": "A String", # The current status of the operation.

2805

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code>

2811

<pre>Lists all clusters owned by a project in either the specified zone or all

2812

zones.

2813

2814

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2815

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2816

number](https://support.google.com/cloud/answer/6158840).

2817

This field has been deprecated and replaced by the parent field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2818

zone: string, Required. Deprecated. The name of the Google Compute Engine

2819

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2820

cluster resides, or "-" for all zones. This field has been deprecated and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2821

replaced by the parent field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2822

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^]

2823

Specified in the format `projects/*/locations/*`.

2824

Location "-" matches all zones and all regions.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2825

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2832

2833

{ # ListClustersResponse is the result of ListClustersRequest.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2834

"clusters": [ # A list of clusters in the project in the specified zone, or

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2835

# across all ones.

2836

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2837

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

2838

# simultaneously on a node in the node pool of this cluster. Only honored

2839

# if cluster created with IP Alias support.

2840

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2841

},

2842

"network": "A String", # The name of the Google Compute Engine

2843

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2844

# to which the cluster is connected. If left unspecified, the `default`

2845

# network will be used. On output this shows the network ID instead of the

2846

# name.

2847

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

2848

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2849

# containers. This is provisioned from within the `container_ipv4_cidr`

2850

# range. This field will only be set when cluster is in route-based network

2851

# mode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2852

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

2853

# master authorized networks will disallow all external traffic to access

2854

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

2855

# Google Compute Engine Public IPs and Google Prod IPs.

2856

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

2857

# Kubernetes master through HTTPS.

2858

{ # CidrBlock contains an optional name and one CIDR block.

2859

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

2860

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

2861

},

2862

],

2863

"enabled": True or False, # Whether or not master authorized networks is enabled.

2864

},

2865

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2866

# cluster, if available.

2867

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

2868

# If unspecified, the defaults are used:

2869

# For clusters before v1.12, if master_auth is unspecified, `username` will

2870

# be set to "admin", a random password will be generated, and a client

2871

# certificate will be issued.

2872

# Authentication can be done using HTTP basic auth or using client

2873

# certificates.

2874

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

2875

# Because the master endpoint is open to the Internet, you should create a

2876

# strong password. If a password is provided for cluster creation, username

2877

# must be non-empty.

2878

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

2879

# clusters before v1.12, if no configuration is specified, a client

2880

# certificate is issued.

2881

"issueClientCertificate": True or False, # Issue a client certificate.

2882

},

2883

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

2884

# to the cluster endpoint.

2885

"clusterCaCertificate": "A String",

2886

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

2887

# authenticate to the cluster endpoint.

2888

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

2889

# For clusters v1.6.0 and later, basic authentication can be disabled by

2890

# leaving username unspecified (or setting it to the empty string).

2891

},

2892

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

2893

"enabled": True or False, # Whether this cluster should return group membership lookups

2894

# during authentication using a group of security groups.

2895

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

2896

# if enabled = true.

2897

},

2898

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network.

2899

# This prefix will be used for assigning private IP addresses to the

2900

# master or set of masters, as well as the ILB VIP.

2901

# This field is deprecated, use

2902

# private_cluster_config.master_ipv4_cidr_block instead.

2903

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

2904

"type": "A String", # Type of the integration.

2905

},

2906

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

2907

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

2908

# cluster, enabling additional functionality.

2909

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

2910

# is enabled or not on the Master, it does not track whether network policy

2911

# is enabled for the nodes.

2912

# is enabled or not on the Master, it does not track whether network policy

2913

# is enabled for the nodes.

2914

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

2915

},

2916

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

2917

# extension to manage hosted GCP services through the Kubernetes API

2918

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

2919

},

2920

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

2921

# enabled in order to enable Cloud Run addon. This option can only be enabled

2922

# at cluster creation time.

2923

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2924

},

2925

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

2926

# increases or decreases the number of replica pods a replication controller

2927

# has based on the resource usage of the existing pods.

2928

# increases or decreases the number of replica pods a replication controller

2929

# has based on the resource usage of the existing pods.

2930

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

2931

# When enabled, it ensures that metrics are collected into Stackdriver

2932

# Monitoring.

2933

},

2934

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

2935

# makes it easy to set up HTTP load balancers for services in a cluster.

2936

# which makes it easy to set up HTTP load balancers for services in a cluster.

2937

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

2938

# When enabled, it runs a small pod in the cluster that manages the load

2939

# balancers.

2940

},

2941

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

2942

# This addon is deprecated, and will be disabled in 1.15. It is recommended

2943

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

2944

# workloads and applications. For more information, see:

2945

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

2946

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

2947

},

2948

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

2949

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

2950

},

2951

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

2952

# applications.

2953

"enabled": True or False, # Whether KALM is enabled for this cluster.

2954

},

2955

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

2956

# enabled at cluster creation time.

2957

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

2958

},

2959

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

2960

# microservices.

2961

"disabled": True or False, # Whether Istio is enabled for this cluster.

2962

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

2963

},

2964

},

2965

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

2966

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

2967

# must be valid under a PodSecurityPolicy to be created.

2968

},

2969

"currentNodeVersion": "A String", # [Output only] Deprecated, use

2970

# [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools)

2971

# instead. The current version of the node software components.

2972

# If they are currently at multiple versions because they're in the process

2973

# of being upgraded, this reflects the minimum version of all nodes.

2974

"subnetwork": "A String", # The name of the Google Compute Engine

2975

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

2976

# the cluster is connected. On output this shows the subnetwork ID instead of

2977

# the name.

2978

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

2979

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

2980

# the policy won't accidentally undo intermediate changes (and so that users

2981

# of the API unaware of some fields won't accidentally remove other fields).

2982

# Make a <code>get()</code> request to the cluster to get the current

2983

# resource version and include it with requests to set the policy.

2984

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

2985

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

2986

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

2987

# smallest possible in the given scenario.

2988

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

2989

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

2990

},

2991

"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]

2992

# maintenance to occur. The time windows may be overlapping. If no

2993

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2994

"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]

2995

# this window reccurs. They go on for the span of time between the start and

2996

# end time.

2997

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2998

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2999

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

3000

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

3001

# <code>FREQ=DAILY</code>

3002

# For the first weekend of every month:

3003

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

3004

# 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^]

3005

# 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]

3006

# <code>

3007

# start time = 2019-01-01T09:00:00-0400

3008

# end time = 2019-01-01T17:00:00-0400

3009

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

3010

# </code>

3011

# Windows can span multiple days. Eg, to make the window encompass every

3012

# weekend from midnight Saturday till the last minute of Sunday UTC:

3013

# <code>

3014

# start time = 2019-01-05T00:00:00Z

3015

# end time = 2019-01-07T23:59:00Z

3016

# recurrence = FREQ=WEEKLY;BYDAY=SA

3017

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3018

# 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]

3019

# to specify duration of the window and when it first starts.

3020

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3021

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

3022

"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]

3023

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3024

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3025

},

3026

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3027

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3028

# occur in these windows.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3029

"a_key": { # Represents an arbitrary window of time.

3030

"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]

3031

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3032

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3033

},

3034

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3035

},

3036

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3037

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

3038

# Google Compute Engine resources.

3039

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3040

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3041

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

3042

# found in validMasterVersions returned by getServerConfig. The version can

3043

# be upgraded over time; such upgrades are reflected in

3044

# currentMasterVersion and currentNodeVersion.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3045

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3046

# Users may specify either explicit versions offered by

3047

# Kubernetes Engine or version aliases, which have the following behavior:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3048

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3049

# - "latest": picks the highest valid Kubernetes version

3050

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

3051

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

3052

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

3053

# - "","-": picks the default Kubernetes version

3054

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

3055

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster.

3056

# This is used in conjunction with use_ip_aliases. It cannot be true if

3057

# use_ip_aliases is true. If both use_ip_aliases and use_routes are false,

3058

# then the server picks the default IP allocation mode

3059

"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]

3060

# will be automatically chosen with the default size.

3061

#

3062

# This field is only applicable when `use_ip_aliases` is true.

3063

#

3064

# Set to blank to have a range chosen with the default size.

3065

#

3066

# 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)

3071

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3072

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3073

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3074

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain

3075

# kinds of network routes. By default we do not allow cluster CIDR ranges to

3076

# intersect with any user declared routes. With allow_route_overlap == true,

3077

# we allow overlapping with CIDR ranges that are larger than the cluster CIDR

3078

# range.

3079

#

3080

# If this field is set to true, then cluster and services CIDRs must be

3081

# fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:

3082

# 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and

3083

# `services_ipv4_cidr_block` must be fully-specified.

3084

# 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be

3085

# fully-specified.

3086

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

3087

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

3088

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3089

#

3090

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3091

#

3092

# Set to blank to have a range chosen with the default size.

3093

#

3094

# 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)

3099

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3100

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3101

# to use.

3102

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

3103

# block. The secondary range will be used for pod IP

3104

# addresses. This must be an existing secondary range associated

3105

# with the cluster subnetwork.

3106

#

3107

# This field is only applicable with use_ip_aliases and

3108

# create_subnetwork is false.

3109

"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]

3110

#

3111

# This is applicable only if `create_subnetwork` is true.

3112

#

3113

# Set to blank to have a range chosen with the default size.

3114

#

3115

# 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)

3120

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3121

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3122

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3123

"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]

3124

# range will be automatically chosen with the default size.

3125

#

3126

# This field is only applicable when `use_ip_aliases` is true.

3127

#

3128

# If unspecified, the range will use the default size.

3129

#

3130

# 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)

3135

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3136

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3137

# to use.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3138

# This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3139

"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]

3140

# CIDR block. The secondary range will be used for service

3141

# ClusterIPs. This must be an existing secondary range associated

3142

# with the cluster subnetwork.

3143

#

3144

# This field is only applicable with use_ip_aliases and

3145

# create_subnetwork is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3146

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

3147

# This is used in conjunction with use_routes. It cannot

3148

# be true if use_routes is true. If both use_ip_aliases and use_routes are

3149

# false, then the server picks the default IP allocation mode

3150

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

3151

#

3152

# This field is only applicable when `use_ip_aliases` is true.

3153

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

3154

# this field is empty, then an automatic name will be chosen for the new

3155

# subnetwork.

3156

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

3157

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3158

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3159

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

3160

# mode.

3161

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

3162

# identities in the system, including service accounts, nodes, and

3163

# controllers, will have statically granted permissions beyond those

3164

# provided by the RBAC configuration or IAM.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3165

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3166

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

3167

# This field is deprecated, use tpu_config.enabled instead.

3168

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

3169

# disabled when this config unspecified.

3170

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

3171

# daemonset will be created in the cluster to meter network egress traffic.

3172

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

3173

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

3174

# second BigQuery table will be created to hold resource consumption

3175

# records.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3176

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3177

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

3178

"datasetId": "A String", # The ID of a BigQuery Dataset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3179

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3180

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3181

"locations": [ # The list of Google Compute Engine

3182

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3183

# cluster's nodes should be located.

3184

"A String",

3185

],

3186

"nodePools": [ # The node pools associated with this cluster.

3187

# This field should not be set if "node_config" or "initial_node_count" are

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3188

# specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3189

{ # NodePool contains the name and configuration for a cluster's node pool.

3190

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3191

# specification, under the control of the cluster master. They may have a set

3192

# of Kubernetes labels applied to them, which may be used to reference them

3193

# during pod scheduling. They may also be resized up or down, to accommodate

3194

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3195

"statusMessage": "A String", # [Output only] Additional information about the current status of this

3196

# node pool instance, if available.

3197

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3198

# only if a valid configuration is present.

3199

# adjust the size of the node pool to the current cluster usage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3200

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3201

# max_node_count.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3202

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

3203

"enabled": True or False, # Is autoscaling enabled for this node pool.

3204

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3205

# has to enough quota to scale up the cluster.

3206

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3207

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

3208

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

3209

# is sufficient for this number of instances. You must also have available

3210

# firewall and routes quota.

3211

"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]

3212

# disruption caused by an upgrade.

3213

#

3214

# maxUnavailable controls the number of nodes that can be simultaneously

3215

# unavailable.

3216

#

3217

# maxSurge controls the number of additional nodes that can be added to the

3218

# node pool temporarily for the time of the upgrade to increase the number of

3219

# available nodes.

3220

#

3221

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3222

# nodes are being upgraded at the same time).

3223

#

3224

# Note: upgrades inevitably introduce some disruption since workloads need to

3225

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3226

# this holds true. (Disruption stays within the limits of

3227

# PodDisruptionBudget, if it is configured.)

3228

#

3229

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3230

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3231

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3232

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3233

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3234

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3235

# of the node pool during the upgrade process.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3236

"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]

3237

# the upgrade process. A node is considered available if its status is

3238

# Ready.

3239

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3240

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

3241

"locations": [ # The list of Google Compute Engine

3242

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3243

# NodePool's nodes should be located.

3244

"A String",

3245

],

3246

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3247

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

3248

# associated with this node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3249

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3250

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3251

"version": "A String", # The version of the Kubernetes of this node.

3252

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

3253

"conditions": [ # Which conditions caused the current node pool state.

3254

{ # StatusCondition describes why a cluster or a node pool has a certain status

3255

# (e.g., ERROR or DEGRADED).

3256

"code": "A String", # Machine-friendly representation of the condition

3257

"message": "A String", # Human-friendly representation of the condition

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3258

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3259

],

3260

"status": "A String", # [Output only] The status of the nodes in this pool instance.

3261

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

3262

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3263

# The smallest allowed disk size is 10GB.

3264

#

3265

# If unspecified, the default disk size is 100GB.

3266

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3267

# workloads on the node pool.

3268

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

3269

# workloads running on the node.

3270

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3271

# on the node pool.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3272

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3273

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3274

# See https://cloud.google.com/compute/docs/gpus for more information about

3275

# support for GPUs.

3276

{ # AcceleratorConfig represents a Hardware Accelerator request.

3277

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3278

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3279

# [here](https://cloud.google.com/compute/docs/gpus)

3280

},

3281

],

3282

"machineType": "A String", # The name of a Google Compute Engine [machine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3283

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3284

# `n1-standard-1`).

3285

#

3286

# If unspecified, the default machine type is

3287

# `n1-standard-1`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3288

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3289

#

3290

# If unspecified, the default disk type is 'pd-standard'

3291

"bootDiskKmsKey": "A String", #

3292

# The Customer Managed Encryption Key used to encrypt the boot disk attached

3293

# to each node in the node pool. This should be of the form

3294

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

3295

# For more information about protecting resources with Cloud KMS Keys please

3296

# see:

3297

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

3298

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3299

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3300

#

3301

# Secure Boot helps ensure that the system only runs authentic software by

3302

# verifying the digital signature of all boot components, and halting the

3303

# boot process if signature verification fails.

3304

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3305

#

3306

# Enables monitoring and attestation of the boot integrity of the instance.

3307

# The attestation is performed against the integrity policy baseline. This

3308

# baseline is initially derived from the implicitly trusted boot image when

3309

# the instance is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3310

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3311

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3312

# scheduled on the specified or newer CPU platform. Applicable values are the

3313

# friendly names of CPU platforms, such as

3314

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3315

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3316

# information, read [how to specify min CPU

3317

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3318

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3319

# https://cloud.google.com/compute/docs/instances/preemptible for more

3320

# inforamtion about preemptible VM instances.

3321

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3322

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3323

# The limit for this value is dependent upon the maximum number of

3324

# disks available on a machine per zone. See:

3325

# https://cloud.google.com/compute/docs/disks/local-ssd

3326

# for more information.

3327

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3328

"type": "A String", # Type of the sandbox to use for the node.

3329

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

3330

},

3331

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3332

#

3333

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3334

# in length. These are reflected as part of a URL in the metadata server.

3335

# Additionally, to avoid ambiguity, keys must not conflict with any other

3336

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3342

# "enable-oslogin"

3343

# "gci-ensure-gke-docker"

3344

# "gci-metrics-enabled"

3345

# "gci-update-strategy"

3346

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3351

# "windows-startup-script-ps1"

3352

# "common-psm1"

3353

# "k8s-node-setup-psm1"

3354

# "install-ssh-psm1"

3355

# "user-profile-psm1"

3356

# "serial-port-logging-enable"

3357

# Values are free-form strings, and only have meaning as interpreted by

3358

# the image running in the instance. The only restriction placed on them is

3359

# that each value's size must be less than or equal to 32 KB.

3360

#

3361

# The total size of all keys and values must be less than 512 KB.

3362

"a_key": "A String",

3363

},

3364

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3365

# the specified [Zonal Compute

3366

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3367

# to this node pool.

3368

# is the configuration of desired reservation which instances could take

3369

# capacity from.

3370

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3371

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3372

# the key and specify the name of your reservation as its value.

3373

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3374

"A String",

3375

],

3376

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3377

},

3378

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3379

# valid sources or targets for network firewalls and are specified by

3380

# the client during cluster or node pool creation. Each tag within the list

3381

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3382

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3383

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3384

"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]

3385

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3386

# Account is specified, the "default" service account is used.

3387

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3388

# the latest version of it will be used.

3389

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3390

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3391

#

3392

# The following scopes are recommended, but not required, and by default are

3393

# not included:

3394

#

3395

# * `https://www.googleapis.com/auth/compute` is required for mounting

3396

# persistent storage on your nodes.

3397

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3398

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3399

# (the [Google Container

3400

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3401

#

3402

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3403

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3404

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3405

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3406

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3407

#

3408

# For more information, including usage and the valid values, see:

3409

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3410

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3411

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3412

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3413

# See

3414

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3415

# for more information, including usage and the valid values.

3416

"key": "A String", # Key for taint.

3417

"value": "A String", # Value for taint.

3418

"effect": "A String", # Effect for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3419

},

3420

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3421

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3422

# These will added in addition to any default label(s) that

3423

# Kubernetes may apply to the node.

3424

# In case of conflict in label keys, the applied set may differ depending on

3425

# the Kubernetes version -- it's best to assume the behavior is undefined

3426

# and conflicts should be avoided.

3427

# For more information, including usage and the valid values, see:

3428

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3429

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3430

},

3431

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3432

"name": "A String", # The name of the node pool.

3433

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

3434

# simultaneously on a node in the node pool.

3435

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

3436

},

3437

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

3438

# node pool.

3439

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

3440

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

3441

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3442

# the Auto Upgrades will proceed.

3443

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3444

# with the description of the upgrade.

3445

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3446

# with the approximate start time for the upgrades, in

3447

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3448

},

3449

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3450

},

3451

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3452

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

3453

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

3454

# this cluster, in

3455

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3456

# notation (e.g. `1.2.3.4/29`). Service addresses are

3457

# typically put in the last `/16` from the container CIDR.

3458

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

3459

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

3460

"enabled": True or False, # Whether network policy is enabled on the cluster.

3461

"provider": "A String", # The selected network policy provider.

3462

},

3463

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

3464

# subscribed to. Release channels are arranged in order of risk and

3465

# frequency of updates.

3466

#

3467

# When a cluster is subscribed to a release channel, Google maintains

3468

# both the master version and the node version. Node auto-upgrade

3469

# defaults to true and cannot be disabled. Updates to version related

3470

# fields (e.g. current_master_version) return an error.

3471

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

3472

},

3473

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

3474

# API groups (e.g. v1beta1) and features that may not be production ready in

3475

# the kubernetes version of the master and nodes.

3476

# The cluster has no SLA for uptime and master/node upgrades are disabled.

3477

# Alpha enabled clusters are automatically deleted thirty days after

3478

# creation.

3479

"description": "A String", # An optional description of this cluster.

3480

"conditions": [ # Which conditions caused the current cluster state.

3481

{ # StatusCondition describes why a cluster or a node pool has a certain status

3482

# (e.g., ERROR or DEGRADED).

3483

"code": "A String", # Machine-friendly representation of the condition

3484

"message": "A String", # Human-friendly representation of the condition

3485

},

3486

],

3487

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by

3488

# default have no external IP addresses on the nodes and where nodes and the

3489

# master communicate over private IP addresses.

3490

# This field is deprecated, use private_cluster_config.enable_private_nodes

3491

# instead.

3492

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

3493

# Call Kubernetes API directly to retrieve node information.

3494

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3495

# Currently available options:

3496

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3497

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3498

# service with a Kubernetes-native resource model

3499

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

3500

# longer available as of GKE 1.15).

3501

# * `none` - No metrics will be exported from the cluster.

3502

#

3503

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

3504

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3505

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

3506

"state": "A String", # Denotes the state of etcd encryption.

3507

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3508

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3509

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3510

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

3511

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

3512

# images will be validated by Google Binauthz.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3513

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3514

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

3515

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3516

# notation (e.g. `1.2.3.4/29`).

3517

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

3518

# policies.

3519

# policies.

3520

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

3521

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

3522

},

3523

"zone": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3524

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3525

# cluster resides. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3526

"loggingService": "A String", # The logging service the cluster should use to write logs.

3527

# Currently available options:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3528

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3529

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

3530

# service with a Kubernetes-native resource model

3531

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

3532

# available as of GKE 1.15).

3533

# * `none` - no logs will be exported from the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3534

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3535

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

3536

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

3537

"expireTime": "A String", # [Output only] The time the cluster will be automatically

3538

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3539

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3540

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3541

# "node_pool" object, since this configuration (along with the

3542

# "initial_node_count") will be used to create a "NodePool" object with an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3543

# auto-generated name. Do not use this and a node_pool at the same time.

3544

# For responses, this field will be populated with the node configuration of

3545

# the first node pool. (For configuration of each node pool, see

3546

# `node_pool.config`)

3547

#

3548

# If unspecified, the defaults are used.

3549

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3550

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3551

# The smallest allowed disk size is 10GB.

3552

#

3553

# If unspecified, the default disk size is 100GB.

3554

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3555

# workloads on the node pool.

3556

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

3557

# workloads running on the node.

3558

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3559

# on the node pool.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3560

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3561

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3562

# See https://cloud.google.com/compute/docs/gpus for more information about

3563

# support for GPUs.

3564

{ # AcceleratorConfig represents a Hardware Accelerator request.

3565

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3566

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3567

# [here](https://cloud.google.com/compute/docs/gpus)

3568

},

3569

],

3570

"machineType": "A String", # The name of a Google Compute Engine [machine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3571

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3572

# `n1-standard-1`).

3573

#

3574

# If unspecified, the default machine type is

3575

# `n1-standard-1`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3576

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3577

#

3578

# If unspecified, the default disk type is 'pd-standard'

3579

"bootDiskKmsKey": "A String", #

3580

# The Customer Managed Encryption Key used to encrypt the boot disk attached

3581

# to each node in the node pool. This should be of the form

3582

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

3583

# For more information about protecting resources with Cloud KMS Keys please

3584

# see:

3585

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

3586

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3587

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3588

#

3589

# Secure Boot helps ensure that the system only runs authentic software by

3590

# verifying the digital signature of all boot components, and halting the

3591

# boot process if signature verification fails.

3592

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3593

#

3594

# Enables monitoring and attestation of the boot integrity of the instance.

3595

# The attestation is performed against the integrity policy baseline. This

3596

# baseline is initially derived from the implicitly trusted boot image when

3597

# the instance is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3598

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3599

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3600

# scheduled on the specified or newer CPU platform. Applicable values are the

3601

# friendly names of CPU platforms, such as

3602

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3603

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3604

# information, read [how to specify min CPU

3605

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3606

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3607

# https://cloud.google.com/compute/docs/instances/preemptible for more

3608

# inforamtion about preemptible VM instances.

3609

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3610

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3611

# The limit for this value is dependent upon the maximum number of

3612

# disks available on a machine per zone. See:

3613

# https://cloud.google.com/compute/docs/disks/local-ssd

3614

# for more information.

3615

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3616

"type": "A String", # Type of the sandbox to use for the node.

3617

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

3618

},

3619

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3620

#

3621

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3622

# in length. These are reflected as part of a URL in the metadata server.

3623

# Additionally, to avoid ambiguity, keys must not conflict with any other

3624

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3630

# "enable-oslogin"

3631

# "gci-ensure-gke-docker"

3632

# "gci-metrics-enabled"

3633

# "gci-update-strategy"

3634

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3639

# "windows-startup-script-ps1"

3640

# "common-psm1"

3641

# "k8s-node-setup-psm1"

3642

# "install-ssh-psm1"

3643

# "user-profile-psm1"

3644

# "serial-port-logging-enable"

3645

# Values are free-form strings, and only have meaning as interpreted by

3646

# the image running in the instance. The only restriction placed on them is

3647

# that each value's size must be less than or equal to 32 KB.

3648

#

3649

# The total size of all keys and values must be less than 512 KB.

3650

"a_key": "A String",

3651

},

3652

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3653

# the specified [Zonal Compute

3654

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3655

# to this node pool.

3656

# is the configuration of desired reservation which instances could take

3657

# capacity from.

3658

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3659

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3660

# the key and specify the name of your reservation as its value.

3661

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3662

"A String",

3663

],

3664

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3665

},

3666

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3667

# valid sources or targets for network firewalls and are specified by

3668

# the client during cluster or node pool creation. Each tag within the list

3669

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3670

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3671

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3672

"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]

3673

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3674

# Account is specified, the "default" service account is used.

3675

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3676

# the latest version of it will be used.

3677

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3678

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3679

#

3680

# The following scopes are recommended, but not required, and by default are

3681

# not included:

3682

#

3683

# * `https://www.googleapis.com/auth/compute` is required for mounting

3684

# persistent storage on your nodes.

3685

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3686

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3687

# (the [Google Container

3688

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3689

#

3690

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3691

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3692

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3693

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3694

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3695

#

3696

# For more information, including usage and the valid values, see:

3697

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3698

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3699

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3700

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3701

# See

3702

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3703

# for more information, including usage and the valid values.

3704

"key": "A String", # Key for taint.

3705

"value": "A String", # Value for taint.

3706

"effect": "A String", # Effect for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3707

},

3708

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3709

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3710

# These will added in addition to any default label(s) that

3711

# Kubernetes may apply to the node.

3712

# In case of conflict in label keys, the applied set may differ depending on

3713

# the Kubernetes version -- it's best to assume the behavior is undefined

3714

# and conflicts should be avoided.

3715

# For more information, including usage and the valid values, see:

3716

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3717

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3718

},

3719

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3720

"status": "A String", # [Output only] The current status of this cluster.

3721

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

3722

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

3723

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

3724

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

3725

},

3726

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

3727

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

3728

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

3729

# cluster is connected. Example:

3730

# projects/my-project/regions/us-central1/subnetworks/my-subnet

3731

"network": "A String", # Output only. The relative name of the Google Compute Engine

3732

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

3733

# to which the cluster is connected. Example:

3734

# projects/my-project/global/networks/my-network

3735

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

3736

# This makes same node pod to pod traffic visible for VPC network.

3737

},

3738

"name": "A String", # The name of this cluster. The name must be unique within this project

3739

# and location (e.g. zone or region), and can be up to 40 characters with

3740

# the following restrictions:

3741

#

3742

# * Lowercase letters, numbers, and hyphens only.

3743

# * Must start with a letter.

3744

# * Must end with a number or a letter.

3745

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

3746

# The endpoint can be accessed from the internet at

3747

# `https://username:password@endpoint/`.

3748

#

3749

# See the `masterAuth` property of this resource for username and

3750

# password information.

3751

"location": "A String", # [Output only] The name of the Google Compute Engine

3752

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3753

# or

3754

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3755

# in which the cluster resides.

3756

"createTime": "A String", # [Output only] The time the cluster was created, in

3757

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3758

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3759

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3760

# notation (e.g. `10.96.0.0/14`). Leave blank to have

3761

# 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^]

3762

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

3763

# required by Cluster Autoscaler to automatically adjust

3764

# the size of the cluster and create/delete

3765

# node pools based on the current needs.

3766

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

3767

# amount of resources in the cluster.

3768

{ # Contains information about amount of some resource in the cluster.

3769

# For memory, value should be in GB.

3770

"maximum": "A String", # Maximum amount of the resource in the cluster.

3771

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

3772

"minimum": "A String", # Minimum amount of the resource in the cluster.

3773

},

3774

],

3775

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

3776

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

3777

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

3778

# created by NAP.

3779

# by NAP.

3780

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

3781

# specified, service_account should be empty.

3782

"A String",

3783

],

3784

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

3785

# node pool.

3786

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

3787

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

3788

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3789

# the Auto Upgrades will proceed.

3790

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3791

# with the description of the upgrade.

3792

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3793

# with the approximate start time for the upgrades, in

3794

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3795

},

3796

},

3797

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

3798

# The instance may be scheduled on the specified or newer CPU platform.

3799

# Applicable values are the friendly names of CPU platforms, such as

3800

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3801

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3802

# information, read [how to specify min CPU

3803

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3804

# To unset the min cpu platform field pass "automatic" as field value.

3805

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

3806

# disruption caused by an upgrade.

3807

#

3808

# maxUnavailable controls the number of nodes that can be simultaneously

3809

# unavailable.

3810

#

3811

# maxSurge controls the number of additional nodes that can be added to the

3812

# node pool temporarily for the time of the upgrade to increase the number of

3813

# available nodes.

3814

#

3815

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3816

# nodes are being upgraded at the same time).

3817

#

3818

# Note: upgrades inevitably introduce some disruption since workloads need to

3819

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3820

# this holds true. (Disruption stays within the limits of

3821

# PodDisruptionBudget, if it is configured.)

3822

#

3823

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3824

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3825

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3826

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3827

# there are always at least 4 nodes available.

3828

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3829

# of the node pool during the upgrade process.

3830

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3831

# the upgrade process. A node is considered available if its status is

3832

# Ready.

3833

},

3834

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

3835

# service_account is specified, scopes should be empty.

3836

},

3837

"autoprovisioningLocations": [ # The list of Google Compute Engine

3838

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3839

# NodePool's nodes can be created by NAP.

3840

"A String",

3841

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3842

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3843

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

3844

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3845

# is sufficient for this number of instances. You must also have available

3846

# firewall and routes quota.

3847

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3848

# "node_pool" object, since this configuration (along with the

3849

# "node_config") will be used to create a "NodePool" object with an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3850

# auto-generated name. Do not use this and a node_pool at the same time.

3851

#

3852

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3853

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

3854

"A String",

3855

],

3856

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

3857

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

3858

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

3859

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

3860

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

3861

"enabled": True or False, # Whenever master is accessible globally or not.

3862

},

3863

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

3864

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

3865

# given only RFC 1918 private addresses and communicate with the master via

3866

# private networking.

3867

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

3868

# range will be used for assigning internal IP addresses to the master or

3869

# set of masters, as well as the ILB VIP. This range must not overlap with

3870

# any other ranges in use within the cluster's network.

3871

},

3872

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

3873

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

3874

},

3875

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

3876

# required by Vertical Pod Autoscaler to automatically adjust

3877

# the resources of pods controlled by it.

3878

"enabled": True or False, # Enables vertical pod autoscaling.

3879

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3880

},

3881

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3882

"missingZones": [ # If any zones are listed here, the list of clusters returned

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3883

# may be missing those zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3884

"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]

3890

<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]

3891

<pre>Sets the locations for a specific cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3892

Deprecated. Use

3893

[projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update)

3894

instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3895

3896

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3897

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3898

number](https://support.google.com/cloud/answer/6158840).

3899

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3900

zone: string, Required. Deprecated. The name of the Google Compute Engine

3901

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

3902

cluster resides. This field has been deprecated and replaced by the name

3903

field. (required)

3904

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3905

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3906

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3907

The object takes the form of:

3908

3909

{ # SetLocationsRequest sets the locations of the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3910

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3911

# number](https://support.google.com/cloud/answer/6158840).

3912

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3913

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3914

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3915

# cluster resides. This field has been deprecated and replaced by the name

3916

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3917

"locations": [ # Required. The desired list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3918

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3919

# 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]

3920

# will result in nodes being either created or removed from the cluster,

3921

# depending on whether locations are being added or removed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3922

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3923

# This list must always include the cluster's primary zone.

3924

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3925

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3926

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

3927

# This field has been deprecated and replaced by the name field.

3928

"name": "A String", # The name (project, location, cluster) of the cluster to set locations.

3929

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3930

}

3931

3932

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3939

3940

{ # This operation resource represents operations that may have happened or are

3941

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3942

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3943

{ # StatusCondition describes why a cluster or a node pool has a certain status

3944

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3945

"code": "A String", # Machine-friendly representation of the condition

3946

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3947

},

3948

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3949

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3950

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3951

# or

3952

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3953

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3954

"endTime": "A String", # [Output only] The time the operation completed, in

3955

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3956

"startTime": "A String", # [Output only] The time the operation started, in

3957

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3958

"clusterConditions": [ # Which conditions caused the current cluster state.

3959

{ # StatusCondition describes why a cluster or a node pool has a certain status

3960

# (e.g., ERROR or DEGRADED).

3961

"code": "A String", # Machine-friendly representation of the condition

3962

"message": "A String", # Human-friendly representation of the condition

3963

},

3964

],

3965

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3966

"stages": [ # Substages of an operation or a stage.

3967

# Object with schema name: OperationProgress

3968

],

3969

"status": "A String", # Status of an operation stage.

3970

# Unset for single-stage operations.

3971

"metrics": [ # Progress metric bundle, for example:

3972

# metrics: [{name: "nodes done", int_value: 15},

3973

# {name: "nodes total", int_value: 32}]

3974

# or

3975

# metrics: [{name: "progress", double_value: 0.56},

3976

# {name: "progress scale", double_value: 1.0}]

3977

{ # Progress metric is (string, int|float|string) pair.

3978

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3979

"doubleValue": 3.14, # For metrics with floating point value.

3980

"intValue": "A String", # For metrics with integer value.

3981

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

3982

},

3983

],

3984

"name": "A String", # A non-parameterized string describing an operation stage.

3985

# Unset for single-stage operations.

3986

},

3987

"zone": "A String", # The name of the Google Compute Engine

3988

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3989

# operation is taking place. This field is deprecated, use location instead.

3990

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

3991

"selfLink": "A String", # Server-defined URL for the resource.

3992

"targetLink": "A String", # Server-defined URL for the target of the operation.

3993

"detail": "A String", # Detailed operation progress, if available.

3994

"operationType": "A String", # The operation type.

3995

"status": "A String", # The current status of the operation.

3996

"name": "A String", # The server-assigned ID for 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]

4001

<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]

4002

<pre>Sets the logging service for a specific cluster.

4003

4004

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4005

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4006

number](https://support.google.com/cloud/answer/6158840).

4007

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4008

zone: string, Required. Deprecated. The name of the Google Compute Engine

4009

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4010

cluster resides. This field has been deprecated and replaced by the name

4011

field. (required)

4012

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4013

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4014

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4015

The object takes the form of:

4016

4017

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4018

"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]

4019

# Currently available options:

4020

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4021

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

4022

# service with a Kubernetes-native resource model

4023

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

4024

# available as of GKE 1.15).

4025

# * `none` - no logs will be exported from the cluster.

4026

#

4027

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

4028

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4029

"name": "A String", # The name (project, location, cluster) of the cluster to set logging.

4030

# Specified in the format `projects/*/locations/*/clusters/*`.

4031

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

4032

# number](https://support.google.com/cloud/answer/6158840).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4033

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4034

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4035

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4036

# cluster resides. This field has been deprecated and replaced by the name

4037

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4038

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

4039

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4040

}

4041

4042

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4049

4050

{ # This operation resource represents operations that may have happened or are

4051

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4052

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4053

{ # StatusCondition describes why a cluster or a node pool has a certain status

4054

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4055

"code": "A String", # Machine-friendly representation of the condition

4056

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4057

},

4058

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4059

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4060

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4061

# or

4062

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4063

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4064

"endTime": "A String", # [Output only] The time the operation completed, in

4065

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4066

"startTime": "A String", # [Output only] The time the operation started, in

4067

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4068

"clusterConditions": [ # Which conditions caused the current cluster state.

4069

{ # StatusCondition describes why a cluster or a node pool has a certain status

4070

# (e.g., ERROR or DEGRADED).

4071

"code": "A String", # Machine-friendly representation of the condition

4072

"message": "A String", # Human-friendly representation of the condition

4073

},

4074

],

4075

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4076

"stages": [ # Substages of an operation or a stage.

4077

# Object with schema name: OperationProgress

4078

],

4079

"status": "A String", # Status of an operation stage.

4080

# Unset for single-stage operations.

4081

"metrics": [ # Progress metric bundle, for example:

4082

# metrics: [{name: "nodes done", int_value: 15},

4083

# {name: "nodes total", int_value: 32}]

4084

# or

4085

# metrics: [{name: "progress", double_value: 0.56},

4086

# {name: "progress scale", double_value: 1.0}]

4087

{ # Progress metric is (string, int|float|string) pair.

4088

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4089

"doubleValue": 3.14, # For metrics with floating point value.

4090

"intValue": "A String", # For metrics with integer value.

4091

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4092

},

4093

],

4094

"name": "A String", # A non-parameterized string describing an operation stage.

4095

# Unset for single-stage operations.

4096

},

4097

"zone": "A String", # The name of the Google Compute Engine

4098

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4099

# operation is taking place. This field is deprecated, use location instead.

4100

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4101

"selfLink": "A String", # Server-defined URL for the resource.

4102

"targetLink": "A String", # Server-defined URL for the target of the operation.

4103

"detail": "A String", # Detailed operation progress, if available.

4104

"operationType": "A String", # The operation type.

4105

"status": "A String", # The current status of the operation.

4106

"name": "A String", # The server-assigned ID for 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]

4111

<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]

4112

<pre>Updates the master for a specific cluster.

4113

4114

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4115

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4116

number](https://support.google.com/cloud/answer/6158840).

4117

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4118

zone: string, Required. Deprecated. The name of the Google Compute Engine

4119

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4120

cluster resides. This field has been deprecated and replaced by the name

4121

field. (required)

4122

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4123

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4124

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4125

The object takes the form of:

4126

4127

{ # UpdateMasterRequest updates the master of the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4128

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4129

# number](https://support.google.com/cloud/answer/6158840).

4130

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4131

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4132

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4133

# cluster resides. This field has been deprecated and replaced by the name

4134

# field.

4135

"masterVersion": "A String", # Required. The Kubernetes version to change the master to.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4136

#

4137

# Users may specify either explicit versions offered by

4138

# Kubernetes Engine or version aliases, which have the following behavior:

4139

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4140

# - "latest": picks the highest valid Kubernetes version

4141

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4142

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4143

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4144

# - "-": picks the default Kubernetes version

4145

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4146

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4147

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4148

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4149

}

4150

4151

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4158

4159

{ # This operation resource represents operations that may have happened or are

4160

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4161

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4162

{ # StatusCondition describes why a cluster or a node pool has a certain status

4163

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4164

"code": "A String", # Machine-friendly representation of the condition

4165

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4166

},

4167

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4168

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4169

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4170

# or

4171

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4172

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4173

"endTime": "A String", # [Output only] The time the operation completed, in

4174

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4175

"startTime": "A String", # [Output only] The time the operation started, in

4176

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4177

"clusterConditions": [ # Which conditions caused the current cluster state.

4178

{ # StatusCondition describes why a cluster or a node pool has a certain status

4179

# (e.g., ERROR or DEGRADED).

4180

"code": "A String", # Machine-friendly representation of the condition

4181

"message": "A String", # Human-friendly representation of the condition

4182

},

4183

],

4184

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4185

"stages": [ # Substages of an operation or a stage.

4186

# Object with schema name: OperationProgress

4187

],

4188

"status": "A String", # Status of an operation stage.

4189

# Unset for single-stage operations.

4190

"metrics": [ # Progress metric bundle, for example:

4191

# metrics: [{name: "nodes done", int_value: 15},

4192

# {name: "nodes total", int_value: 32}]

4193

# or

4194

# metrics: [{name: "progress", double_value: 0.56},

4195

# {name: "progress scale", double_value: 1.0}]

4196

{ # Progress metric is (string, int|float|string) pair.

4197

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4198

"doubleValue": 3.14, # For metrics with floating point value.

4199

"intValue": "A String", # For metrics with integer value.

4200

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4201

},

4202

],

4203

"name": "A String", # A non-parameterized string describing an operation stage.

4204

# Unset for single-stage operations.

4205

},

4206

"zone": "A String", # The name of the Google Compute Engine

4207

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4208

# operation is taking place. This field is deprecated, use location instead.

4209

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4210

"selfLink": "A String", # Server-defined URL for the resource.

4211

"targetLink": "A String", # Server-defined URL for the target of the operation.

4212

"detail": "A String", # Detailed operation progress, if available.

4213

"operationType": "A String", # The operation type.

4214

"status": "A String", # The current status of the operation.

4215

"name": "A String", # The server-assigned ID for 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]

4220

<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]

4221

<pre>Sets the monitoring service for a specific cluster.

4222

4223

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4224

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4225

number](https://support.google.com/cloud/answer/6158840).

4226

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4227

zone: string, Required. Deprecated. The name of the Google Compute Engine

4228

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4229

cluster resides. This field has been deprecated and replaced by the name

4230

field. (required)

4231

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4232

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4233

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4234

The object takes the form of:

4235

4236

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4237

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4238

# number](https://support.google.com/cloud/answer/6158840).

4239

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4240

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4241

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4242

# cluster resides. This field has been deprecated and replaced by the name

4243

# field.

4244

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

4245

# This field has been deprecated and replaced by the name field.

4246

"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]

4247

# Currently available options:

4248

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4249

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4250

# service with a Kubernetes-native resource model

4251

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4252

# longer available as of GKE 1.15).

4253

# * `none` - No metrics will be exported from the cluster.

4254

#

4255

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4256

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4257

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring.

4258

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4259

}

4260

4261

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4268

4269

{ # This operation resource represents operations that may have happened or are

4270

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4271

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4272

{ # StatusCondition describes why a cluster or a node pool has a certain status

4273

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4274

"code": "A String", # Machine-friendly representation of the condition

4275

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4276

},

4277

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4278

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4279

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4280

# or

4281

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4282

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4283

"endTime": "A String", # [Output only] The time the operation completed, in

4284

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4285

"startTime": "A String", # [Output only] The time the operation started, in

4286

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4287

"clusterConditions": [ # Which conditions caused the current cluster state.

4288

{ # StatusCondition describes why a cluster or a node pool has a certain status

4289

# (e.g., ERROR or DEGRADED).

4290

"code": "A String", # Machine-friendly representation of the condition

4291

"message": "A String", # Human-friendly representation of the condition

4292

},

4293

],

4294

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4295

"stages": [ # Substages of an operation or a stage.

4296

# Object with schema name: OperationProgress

4297

],

4298

"status": "A String", # Status of an operation stage.

4299

# Unset for single-stage operations.

4300

"metrics": [ # Progress metric bundle, for example:

4301

# metrics: [{name: "nodes done", int_value: 15},

4302

# {name: "nodes total", int_value: 32}]

4303

# or

4304

# metrics: [{name: "progress", double_value: 0.56},

4305

# {name: "progress scale", double_value: 1.0}]

4306

{ # Progress metric is (string, int|float|string) pair.

4307

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4308

"doubleValue": 3.14, # For metrics with floating point value.

4309

"intValue": "A String", # For metrics with integer value.

4310

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4311

},

4312

],

4313

"name": "A String", # A non-parameterized string describing an operation stage.

4314

# Unset for single-stage operations.

4315

},

4316

"zone": "A String", # The name of the Google Compute Engine

4317

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4318

# operation is taking place. This field is deprecated, use location instead.

4319

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4320

"selfLink": "A String", # Server-defined URL for the resource.

4321

"targetLink": "A String", # Server-defined URL for the target of the operation.

4322

"detail": "A String", # Detailed operation progress, if available.

4323

"operationType": "A String", # The operation type.

4324

"status": "A String", # The current status of the operation.

4325

"name": "A String", # The server-assigned ID for 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]

4330

<code class="details" id="resourceLabels">resourceLabels(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4331

<pre>Sets labels on a cluster.

4332

4333

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4334

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4335

number](https://developers.google.com/console/help/new/#projectnumber).

4336

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4337

zone: string, Required. Deprecated. The name of the Google Compute Engine

4338

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4339

cluster resides. This field has been deprecated and replaced by the name

4340

field. (required)

4341

clusterId: string, Required. Deprecated. The name of the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4342

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4343

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4344

The object takes the form of:

4345

4346

{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container

4347

# Engine cluster, which will in turn set them for Google Compute Engine

4348

# resources used by that cluster

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4349

"labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4350

# used to detect conflicts. The fingerprint is initially generated by

4351

# Kubernetes Engine and changes after every request to modify or update

4352

# labels. You must always provide an up-to-date fingerprint hash when

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4353

# updating or changing labels. Make a <code>get()</code> request to the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4354

# resource to get the latest fingerprint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4355

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4356

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4357

# cluster resides. This field has been deprecated and replaced by the name

4358

# field.

4359

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels.

4360

# Specified in the format `projects/*/locations/*/clusters/*`.

4361

"resourceLabels": { # Required. The labels to set for that cluster.

4362

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4363

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4364

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

4365

# number](https://developers.google.com/console/help/new/#projectnumber).

4366

# This field has been deprecated and replaced by the name field.

4367

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

4368

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4369

}

4370

4371

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4378

4379

{ # This operation resource represents operations that may have happened or are

4380

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4381

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4382

{ # StatusCondition describes why a cluster or a node pool has a certain status

4383

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4384

"code": "A String", # Machine-friendly representation of the condition

4385

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4386

},

4387

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4388

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4389

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4390

# or

4391

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4392

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4393

"endTime": "A String", # [Output only] The time the operation completed, in

4394

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4395

"startTime": "A String", # [Output only] The time the operation started, in

4396

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4397

"clusterConditions": [ # Which conditions caused the current cluster state.

4398

{ # StatusCondition describes why a cluster or a node pool has a certain status

4399

# (e.g., ERROR or DEGRADED).

4400

"code": "A String", # Machine-friendly representation of the condition

4401

"message": "A String", # Human-friendly representation of the condition

4402

},

4403

],

4404

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4405

"stages": [ # Substages of an operation or a stage.

4406

# Object with schema name: OperationProgress

4407

],

4408

"status": "A String", # Status of an operation stage.

4409

# Unset for single-stage operations.

4410

"metrics": [ # Progress metric bundle, for example:

4411

# metrics: [{name: "nodes done", int_value: 15},

4412

# {name: "nodes total", int_value: 32}]

4413

# or

4414

# metrics: [{name: "progress", double_value: 0.56},

4415

# {name: "progress scale", double_value: 1.0}]

4416

{ # Progress metric is (string, int|float|string) pair.

4417

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4418

"doubleValue": 3.14, # For metrics with floating point value.

4419

"intValue": "A String", # For metrics with integer value.

4420

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4421

},

4422

],

4423

"name": "A String", # A non-parameterized string describing an operation stage.

4424

# Unset for single-stage operations.

4425

},

4426

"zone": "A String", # The name of the Google Compute Engine

4427

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4428

# operation is taking place. This field is deprecated, use location instead.

4429

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4430

"selfLink": "A String", # Server-defined URL for the resource.

4431

"targetLink": "A String", # Server-defined URL for the target of the operation.

4432

"detail": "A String", # Detailed operation progress, if available.

4433

"operationType": "A String", # The operation type.

4434

"status": "A String", # The current status of the operation.

4435

"name": "A String", # The server-assigned ID for 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]

4440

<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]

4441

<pre>Sets the maintenance policy for a cluster.

4442

4443

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4444

projectId: string, Required. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4445

number](https://support.google.com/cloud/answer/6158840). (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4446

zone: string, Required. The name of the Google Compute Engine

4447

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4448

cluster resides. (required)

4449

clusterId: string, Required. The name of the cluster to update. (required)

4450

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4451

The object takes the form of:

4452

4453

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4454

"clusterId": "A String", # Required. The name of the cluster to update.

4455

"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]

4456

# clears the existing maintenance policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4457

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

4458

# the policy won't accidentally undo intermediate changes (and so that users

4459

# of the API unaware of some fields won't accidentally remove other fields).

4460

# Make a <code>get()</code> request to the cluster to get the current

4461

# resource version and include it with requests to set the policy.

4462

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

4463

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

4464

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

4465

# smallest possible in the given scenario.

4466

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

4467

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

4468

},

4469

"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]

4470

# maintenance to occur. The time windows may be overlapping. If no

4471

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4472

"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]

4473

# this window reccurs. They go on for the span of time between the start and

4474

# end time.

4475

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4476

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4477

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

4478

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

4479

# <code>FREQ=DAILY</code>

4480

# For the first weekend of every month:

4481

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

4482

# 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^]

4483

# 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]

4484

# <code>

4485

# start time = 2019-01-01T09:00:00-0400

4486

# end time = 2019-01-01T17:00:00-0400

4487

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

4488

# </code>

4489

# Windows can span multiple days. Eg, to make the window encompass every

4490

# weekend from midnight Saturday till the last minute of Sunday UTC:

4491

# <code>

4492

# start time = 2019-01-05T00:00:00Z

4493

# end time = 2019-01-07T23:59:00Z

4494

# recurrence = FREQ=WEEKLY;BYDAY=SA

4495

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4496

# 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]

4497

# to specify duration of the window and when it first starts.

4498

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4499

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

4500

"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]

4501

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4502

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4503

},

4504

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4505

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4506

# occur in these windows.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4507

"a_key": { # Represents an arbitrary window of time.

4508

"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]

4509

# start time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4510

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4511

},

4512

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4513

},

4514

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4515

"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]

4516

# policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4517

# Specified in the format `projects/*/locations/*/clusters/*`.

4518

"projectId": "A String", # Required. The Google Developers Console [project ID or project

4519

# number](https://support.google.com/cloud/answer/6158840).

4520

"zone": "A String", # Required. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4521

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4522

# cluster resides.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4523

}

4524

4525

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4532

4533

{ # This operation resource represents operations that may have happened or are

4534

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4535

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4536

{ # StatusCondition describes why a cluster or a node pool has a certain status

4537

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4538

"code": "A String", # Machine-friendly representation of the condition

4539

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4540

},

4541

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4542

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4543

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4544

# or

4545

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4546

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4547

"endTime": "A String", # [Output only] The time the operation completed, in

4548

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4549

"startTime": "A String", # [Output only] The time the operation started, in

4550

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4551

"clusterConditions": [ # Which conditions caused the current cluster state.

4552

{ # StatusCondition describes why a cluster or a node pool has a certain status

4553

# (e.g., ERROR or DEGRADED).

4554

"code": "A String", # Machine-friendly representation of the condition

4555

"message": "A String", # Human-friendly representation of the condition

4556

},

4557

],

4558

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4559

"stages": [ # Substages of an operation or a stage.

4560

# Object with schema name: OperationProgress

4561

],

4562

"status": "A String", # Status of an operation stage.

4563

# Unset for single-stage operations.

4564

"metrics": [ # Progress metric bundle, for example:

4565

# metrics: [{name: "nodes done", int_value: 15},

4566

# {name: "nodes total", int_value: 32}]

4567

# or

4568

# metrics: [{name: "progress", double_value: 0.56},

4569

# {name: "progress scale", double_value: 1.0}]

4570

{ # Progress metric is (string, int|float|string) pair.

4571

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4572

"doubleValue": 3.14, # For metrics with floating point value.

4573

"intValue": "A String", # For metrics with integer value.

4574

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4575

},

4576

],

4577

"name": "A String", # A non-parameterized string describing an operation stage.

4578

# Unset for single-stage operations.

4579

},

4580

"zone": "A String", # The name of the Google Compute Engine

4581

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4582

# operation is taking place. This field is deprecated, use location instead.

4583

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4584

"selfLink": "A String", # Server-defined URL for the resource.

4585

"targetLink": "A String", # Server-defined URL for the target of the operation.

4586

"detail": "A String", # Detailed operation progress, if available.

4587

"operationType": "A String", # The operation type.

4588

"status": "A String", # The current status of the operation.

4589

"name": "A String", # The server-assigned ID for 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]

4594

<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]

4595

<pre>Sets master auth materials. Currently supports changing the admin password

4596

or a specific cluster, either via password generation or explicitly setting

4597

the password.

4598

4599

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4600

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4601

number](https://support.google.com/cloud/answer/6158840).

4602

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4603

zone: string, Required. Deprecated. The name of the Google Compute Engine

4604

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4605

cluster resides. This field has been deprecated and replaced by the name

4606

field. (required)

4607

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4608

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4609

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4610

The object takes the form of:

4611

4612

{ # SetMasterAuthRequest updates the admin password of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4613

"name": "A String", # The name (project, location, cluster) of the cluster to set auth.

4614

# Specified in the format `projects/*/locations/*/clusters/*`.

4615

"action": "A String", # Required. The exact form of action to be taken on the master auth.

4616

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4617

# number](https://support.google.com/cloud/answer/6158840).

4618

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4619

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4620

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4621

"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]

4622

# Authentication can be done using HTTP basic auth or using client

4623

# certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4624

"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]

4625

# Because the master endpoint is open to the Internet, you should create a

4626

# strong password. If a password is provided for cluster creation, username

4627

# must be non-empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4628

"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]

4629

# clusters before v1.12, if no configuration is specified, a client

4630

# certificate is issued.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4631

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4632

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4633

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

4634

# to the cluster endpoint.

4635

"clusterCaCertificate": "A String",

4636

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

4637

# authenticate to the cluster endpoint.

4638

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

4639

# For clusters v1.6.0 and later, basic authentication can be disabled by

4640

# leaving username unspecified (or setting it to the empty string).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4641

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4642

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4643

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4644

# cluster resides. This field has been deprecated and replaced by the name

4645

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4646

}

4647

4648

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4655

4656

{ # This operation resource represents operations that may have happened or are

4657

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4658

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4659

{ # StatusCondition describes why a cluster or a node pool has a certain status

4660

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4661

"code": "A String", # Machine-friendly representation of the condition

4662

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4663

},

4664

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4665

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4666

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4667

# or

4668

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4669

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4670

"endTime": "A String", # [Output only] The time the operation completed, in

4671

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4672

"startTime": "A String", # [Output only] The time the operation started, in

4673

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4674

"clusterConditions": [ # Which conditions caused the current cluster state.

4675

{ # StatusCondition describes why a cluster or a node pool has a certain status

4676

# (e.g., ERROR or DEGRADED).

4677

"code": "A String", # Machine-friendly representation of the condition

4678

"message": "A String", # Human-friendly representation of the condition

4679

},

4680

],

4681

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4682

"stages": [ # Substages of an operation or a stage.

4683

# Object with schema name: OperationProgress

4684

],

4685

"status": "A String", # Status of an operation stage.

4686

# Unset for single-stage operations.

4687

"metrics": [ # Progress metric bundle, for example:

4688

# metrics: [{name: "nodes done", int_value: 15},

4689

# {name: "nodes total", int_value: 32}]

4690

# or

4691

# metrics: [{name: "progress", double_value: 0.56},

4692

# {name: "progress scale", double_value: 1.0}]

4693

{ # Progress metric is (string, int|float|string) pair.

4694

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4695

"doubleValue": 3.14, # For metrics with floating point value.

4696

"intValue": "A String", # For metrics with integer value.

4697

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4698

},

4699

],

4700

"name": "A String", # A non-parameterized string describing an operation stage.

4701

# Unset for single-stage operations.

4702

},

4703

"zone": "A String", # The name of the Google Compute Engine

4704

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4705

# operation is taking place. This field is deprecated, use location instead.

4706

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4707

"selfLink": "A String", # Server-defined URL for the resource.

4708

"targetLink": "A String", # Server-defined URL for the target of the operation.

4709

"detail": "A String", # Detailed operation progress, if available.

4710

"operationType": "A String", # The operation type.

4711

"status": "A String", # The current status of the operation.

4712

"name": "A String", # The server-assigned ID for 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]

4717

<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]

4718

<pre>Enables or disables Network Policy for a cluster.

4719

4720

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4721

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4722

number](https://developers.google.com/console/help/new/#projectnumber).

4723

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4724

zone: string, Required. Deprecated. The name of the Google Compute Engine

4725

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4726

cluster resides. This field has been deprecated and replaced by the name

4727

field. (required)

4728

clusterId: string, Required. Deprecated. The name of the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4729

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4730

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4731

The object takes the form of:

4732

4733

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4734

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4735

# number](https://developers.google.com/console/help/new/#projectnumber).

4736

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4737

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4738

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4739

# cluster resides. This field has been deprecated and replaced by the name

4740

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4741

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

4742

# This field has been deprecated and replaced by the name field.

4743

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature.

4744

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

4745

"enabled": True or False, # Whether network policy is enabled on the cluster.

4746

"provider": "A String", # The selected network policy provider.

4747

},

4748

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking

4749

# policy. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4750

}

4751

4752

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4759

4760

{ # This operation resource represents operations that may have happened or are

4761

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4762

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4763

{ # StatusCondition describes why a cluster or a node pool has a certain status

4764

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4765

"code": "A String", # Machine-friendly representation of the condition

4766

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4767

},

4768

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4769

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4770

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4771

# or

4772

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4773

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4774

"endTime": "A String", # [Output only] The time the operation completed, in

4775

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4776

"startTime": "A String", # [Output only] The time the operation started, in

4777

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4778

"clusterConditions": [ # Which conditions caused the current cluster state.

4779

{ # StatusCondition describes why a cluster or a node pool has a certain status

4780

# (e.g., ERROR or DEGRADED).

4781

"code": "A String", # Machine-friendly representation of the condition

4782

"message": "A String", # Human-friendly representation of the condition

4783

},

4784

],

4785

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4786

"stages": [ # Substages of an operation or a stage.

4787

# Object with schema name: OperationProgress

4788

],

4789

"status": "A String", # Status of an operation stage.

4790

# Unset for single-stage operations.

4791

"metrics": [ # Progress metric bundle, for example:

4792

# metrics: [{name: "nodes done", int_value: 15},

4793

# {name: "nodes total", int_value: 32}]

4794

# or

4795

# metrics: [{name: "progress", double_value: 0.56},

4796

# {name: "progress scale", double_value: 1.0}]

4797

{ # Progress metric is (string, int|float|string) pair.

4798

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4799

"doubleValue": 3.14, # For metrics with floating point value.

4800

"intValue": "A String", # For metrics with integer value.

4801

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4802

},

4803

],

4804

"name": "A String", # A non-parameterized string describing an operation stage.

4805

# Unset for single-stage operations.

4806

},

4807

"zone": "A String", # The name of the Google Compute Engine

4808

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4809

# operation is taking place. This field is deprecated, use location instead.

4810

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4811

"selfLink": "A String", # Server-defined URL for the resource.

4812

"targetLink": "A String", # Server-defined URL for the target of the operation.

4813

"detail": "A String", # Detailed operation progress, if available.

4814

"operationType": "A String", # The operation type.

4815

"status": "A String", # The current status of the operation.

4816

"name": "A String", # The server-assigned ID for 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]

4821

<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]

4822

<pre>Starts master IP rotation.

4823

4824

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4825

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4826

number](https://developers.google.com/console/help/new/#projectnumber).

4827

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4828

zone: string, Required. Deprecated. The name of the Google Compute Engine

4829

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4830

cluster resides. This field has been deprecated and replaced by the name

4831

field. (required)

4832

clusterId: string, Required. Deprecated. The name of the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4833

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4834

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4835

The object takes the form of:

4836

4837

{ # StartIPRotationRequest creates a new IP for the cluster and then performs

4838

# 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^]

4839

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP

4840

# rotation. Specified in the format `projects/*/locations/*/clusters/*`.

4841

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4842

# number](https://developers.google.com/console/help/new/#projectnumber).

4843

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4844

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4845

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4846

# cluster resides. This field has been deprecated and replaced by the name

4847

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4848

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

4849

# This field has been deprecated and replaced by the name field.

4850

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4851

}

4852

4853

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4860

4861

{ # This operation resource represents operations that may have happened or are

4862

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4863

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4864

{ # StatusCondition describes why a cluster or a node pool has a certain status

4865

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4866

"code": "A String", # Machine-friendly representation of the condition

4867

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4868

},

4869

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4870

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4871

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4872

# or

4873

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4874

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4875

"endTime": "A String", # [Output only] The time the operation completed, in

4876

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4877

"startTime": "A String", # [Output only] The time the operation started, in

4878

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4879

"clusterConditions": [ # Which conditions caused the current cluster state.

4880

{ # StatusCondition describes why a cluster or a node pool has a certain status

4881

# (e.g., ERROR or DEGRADED).

4882

"code": "A String", # Machine-friendly representation of the condition

4883

"message": "A String", # Human-friendly representation of the condition

4884

},

4885

],

4886

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4887

"stages": [ # Substages of an operation or a stage.

4888

# Object with schema name: OperationProgress

4889

],

4890

"status": "A String", # Status of an operation stage.

4891

# Unset for single-stage operations.

4892

"metrics": [ # Progress metric bundle, for example:

4893

# metrics: [{name: "nodes done", int_value: 15},

4894

# {name: "nodes total", int_value: 32}]

4895

# or

4896

# metrics: [{name: "progress", double_value: 0.56},

4897

# {name: "progress scale", double_value: 1.0}]

4898

{ # Progress metric is (string, int|float|string) pair.

4899

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4900

"doubleValue": 3.14, # For metrics with floating point value.

4901

"intValue": "A String", # For metrics with integer value.

4902

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4903

},

4904

],

4905

"name": "A String", # A non-parameterized string describing an operation stage.

4906

# Unset for single-stage operations.

4907

},

4908

"zone": "A String", # The name of the Google Compute Engine

4909

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4910

# operation is taking place. This field is deprecated, use location instead.

4911

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4912

"selfLink": "A String", # Server-defined URL for the resource.

4913

"targetLink": "A String", # Server-defined URL for the target of the operation.

4914

"detail": "A String", # Detailed operation progress, if available.

4915

"operationType": "A String", # The operation type.

4916

"status": "A String", # The current status of the operation.

4917

"name": "A String", # The server-assigned ID for 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]

4922

<code class="details" id="update">update(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4923

<pre>Updates the settings for a specific cluster.

4924

4925

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4926

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4927

number](https://support.google.com/cloud/answer/6158840).

4928

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4929

zone: string, Required. Deprecated. The name of the Google Compute Engine

4930

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4931

cluster resides. This field has been deprecated and replaced by the name

4932

field. (required)

4933

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4934

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4935

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4936

The object takes the form of:

4937

4938

{ # UpdateClusterRequest updates the settings of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4939

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4940

# number](https://support.google.com/cloud/answer/6158840).

4941

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4942

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4943

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4944

# cluster resides. This field has been deprecated and replaced by the name

4945

# field.

4946

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4947

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4948

"update": { # ClusterUpdate describes an update to the cluster. Exactly one update can # Required. A description of the update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4949

# be applied to a cluster with each request, so at most one field can be

4950

# provided.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4951

"desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration.

4952

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

4953

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

4954

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

4955

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

4956

"enabled": True or False, # Whenever master is accessible globally or not.

4957

},

4958

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

4959

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

4960

# given only RFC 1918 private addresses and communicate with the master via

4961

# private networking.

4962

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

4963

# range will be used for assigning internal IP addresses to the master or

4964

# set of masters, as well as the ILB VIP. This range must not overlap with

4965

# any other ranges in use within the cluster's network.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4966

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4967

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

4968

# required by Vertical Pod Autoscaler to automatically adjust

4969

# the resources of pods controlled by it.

4970

"enabled": True or False, # Enables vertical pod autoscaling.

4971

},

4972

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

4973

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

4974

# images will be validated by Google Binauthz.

4975

},

4976

"desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

4977

# cluster, enabling additional functionality.

4978

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

4979

# is enabled or not on the Master, it does not track whether network policy

4980

# is enabled for the nodes.

4981

# is enabled or not on the Master, it does not track whether network policy

4982

# is enabled for the nodes.

4983

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

4984

},

4985

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

4986

# extension to manage hosted GCP services through the Kubernetes API

4987

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

4988

},

4989

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

4990

# enabled in order to enable Cloud Run addon. This option can only be enabled

4991

# at cluster creation time.

4992

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

4993

},

4994

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

4995

# increases or decreases the number of replica pods a replication controller

4996

# has based on the resource usage of the existing pods.

4997

# increases or decreases the number of replica pods a replication controller

4998

# has based on the resource usage of the existing pods.

4999

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

5000

# When enabled, it ensures that metrics are collected into Stackdriver

5001

# Monitoring.

5002

},

5003

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

5004

# makes it easy to set up HTTP load balancers for services in a cluster.

5005

# which makes it easy to set up HTTP load balancers for services in a cluster.

5006

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

5007

# When enabled, it runs a small pod in the cluster that manages the load

5008

# balancers.

5009

},

5010

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

5011

# This addon is deprecated, and will be disabled in 1.15. It is recommended

5012

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

5013

# workloads and applications. For more information, see:

5014

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

5015

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

5016

},

5017

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

5018

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

5019

},

5020

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

5021

# applications.

5022

"enabled": True or False, # Whether KALM is enabled for this cluster.

5023

},

5024

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

5025

# enabled at cluster creation time.

5026

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

5027

},

5028

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

5029

# microservices.

5030

"disabled": True or False, # Whether Istio is enabled for this cluster.

5031

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

5032

},

5033

},

5034

"desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an

5035

# upgrade).

5036

#

5037

# Users may specify either explicit versions offered by

5038

# Kubernetes Engine or version aliases, which have the following behavior:

5039

#

5040

# - "latest": picks the highest valid Kubernetes version

5041

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

5042

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

5043

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

5044

# - "-": picks the Kubernetes master version

5045

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility.

5046

# visibility on this cluster.

5047

"enabled": True or False, # Enables intra node visibility for this cluster.

5048

},

5049

"desiredPodSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # The desired configuration options for the PodSecurityPolicy feature.

5050

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

5051

# must be valid under a PodSecurityPolicy to be created.

5052

},

5053

"desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5054

# required by Cluster Autoscaler to automatically adjust

5055

# the size of the cluster and create/delete

5056

# node pools based on the current needs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5057

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

5058

# amount of resources in the cluster.

5059

{ # Contains information about amount of some resource in the cluster.

5060

# For memory, value should be in GB.

5061

"maximum": "A String", # Maximum amount of the resource in the cluster.

5062

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

5063

"minimum": "A String", # Minimum amount of the resource in the cluster.

5064

},

5065

],

5066

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

5067

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

5068

"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]

5069

# created by NAP.

5070

# by NAP.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5071

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

5072

# specified, service_account should be empty.

5073

"A String",

5074

],

5075

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

5076

# node pool.

5077

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

5078

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

5079

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

5080

# the Auto Upgrades will proceed.

5081

"description": "A String", # [Output only] This field is set when upgrades are about to commence

5082

# with the description of the upgrade.

5083

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

5084

# with the approximate start time for the upgrades, in

5085

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5086

},

5087

},

5088

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5089

# The instance may be scheduled on the specified or newer CPU platform.

5090

# Applicable values are the friendly names of CPU platforms, such as

5091

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

5092

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

5093

# information, read [how to specify min CPU

5094

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5095

# To unset the min cpu platform field pass "automatic" as field value.

5096

"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]

5097

# disruption caused by an upgrade.

5098

#

5099

# maxUnavailable controls the number of nodes that can be simultaneously

5100

# unavailable.

5101

#

5102

# maxSurge controls the number of additional nodes that can be added to the

5103

# node pool temporarily for the time of the upgrade to increase the number of

5104

# available nodes.

5105

#

5106

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

5107

# nodes are being upgraded at the same time).

5108

#

5109

# Note: upgrades inevitably introduce some disruption since workloads need to

5110

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

5111

# this holds true. (Disruption stays within the limits of

5112

# PodDisruptionBudget, if it is configured.)

5113

#

5114

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

5115

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

5116

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

5117

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

5118

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5119

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5120

# of the node pool during the upgrade process.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5121

"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]

5122

# the upgrade process. A node is considered available if its status is

5123

# Ready.

5124

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5125

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

5126

# service_account is specified, scopes should be empty.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5127

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5128

"autoprovisioningLocations": [ # The list of Google Compute Engine

5129

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

5130

# NodePool's nodes can be created by NAP.

"A String",

],

},

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

5135

"state": "A String", # Denotes the state of etcd encryption.

5136

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

5137

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

5138

},

5139

"desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature.

5140

# master authorized networks will disallow all external traffic to access

5141

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

5142

# Google Compute Engine Public IPs and Google Prod IPs.

5143

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

5144

# Kubernetes master through HTTPS.

5145

{ # CidrBlock contains an optional name and one CIDR block.

5146

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

5147

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5148

},

5149

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5150

"enabled": True or False, # Whether or not master authorized networks is enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5151

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5152

"desiredTpuConfig": { # Configuration for Cloud TPU. # The desired Cloud TPU configuration.

5153

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

5154

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

5155

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

5156

},

5157

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

5158

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

5159

# daemonset will be created in the cluster to meter network egress traffic.

5160

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

5161

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

5162

# second BigQuery table will be created to hold resource consumption

5163

# records.

5164

},

5165

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

5166

"datasetId": "A String", # The ID of a BigQuery Dataset.

5167

},

5168

},

5169

"desiredLocations": [ # The desired list of Google Compute Engine

5170

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

5171

# cluster's nodes should be located. Changing the locations a cluster is in

5172

# will result in nodes being either created or removed from the cluster,

5173

# depending on whether locations are being added or removed.

5174

#

5175

# This list must always include the cluster's primary zone.

5176

"A String",

5177

],

5178

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5179

# desired_node_pool_id. If there is only one pool in the

5180

# cluster and desired_node_pool_id is not provided then

5181

# the change applies to that single node pool.

5182

# adjust the size of the node pool to the current cluster usage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5183

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5184

# max_node_count.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5185

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

5186

"enabled": True or False, # Is autoscaling enabled for this node pool.

5187

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5188

# has to enough quota to scale up the cluster.

5189

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5190

"desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5191

# Currently available options:

5192

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5193

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5194

# service with a Kubernetes-native resource model

5195

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

5196

# longer available as of GKE 1.15).

5197

# * `none` - No metrics will be exported from the cluster.

5198

#

5199

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

5200

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5201

"desiredImageType": "A String", # The desired image type for the node pool.

5202

# NOTE: Set the "desired_node_pool" field as well.

5203

"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster.

5204

"type": "A String", # Type of the integration.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5205

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5206

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity.

5207

# policies.

5208

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

5209

"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]

5210

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5211

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if

5212

# "desired_node_version", "desired_image_family",

5213

# "desired_node_pool_autoscaling", or "desired_workload_metadata_config"

5214

# is specified and there is more than one node pool on the cluster.

5215

"desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is # The desired release channel configuration.

5216

# subscribed to. Release channels are arranged in order of risk and

5217

# frequency of updates.

5218

#

5219

# When a cluster is subscribed to a release channel, Google maintains

5220

# both the master version and the node version. Node auto-upgrade

5221

# defaults to true and cannot be disabled. Updates to version related

5222

# fields (e.g. current_master_version) return an error.

5223

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5224

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5225

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the

5226

# latest supported version.

5227

#

5228

# Users may specify either explicit versions offered by

5229

# Kubernetes Engine or version aliases, which have the following behavior:

5230

#

5231

# - "latest": picks the highest valid Kubernetes version

5232

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

5233

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

5234

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

5235

# - "-": picks the default Kubernetes version

5236

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

5237

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5238

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5239

"desiredLoggingService": "A String", # The logging service the cluster should use to write logs.

5240

# Currently available options:

5241

#

5242

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

5243

# service with a Kubernetes-native resource model

5244

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

5245

# available as of GKE 1.15).

5246

# * `none` - no logs will be exported from the cluster.

5247

#

5248

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

5249

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5250

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5251

"name": "A String", # The name (project, location, cluster) of the cluster to update.

5252

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5253

}

5254

5255

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5262

5263

{ # This operation resource represents operations that may have happened or are

5264

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5265

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5266

{ # StatusCondition describes why a cluster or a node pool has a certain status

5267

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5268

"code": "A String", # Machine-friendly representation of the condition

5269

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5270

},

5271

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5272

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5273

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5274

# or

5275

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5276

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5277

"endTime": "A String", # [Output only] The time the operation completed, in

5278

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5279

"startTime": "A String", # [Output only] The time the operation started, in

5280

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5281

"clusterConditions": [ # Which conditions caused the current cluster state.

5282

{ # StatusCondition describes why a cluster or a node pool has a certain status

5283

# (e.g., ERROR or DEGRADED).

5284

"code": "A String", # Machine-friendly representation of the condition

5285

"message": "A String", # Human-friendly representation of the condition

5286

},

5287

],

5288

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

5289

"stages": [ # Substages of an operation or a stage.

5290

# Object with schema name: OperationProgress

5291

],

5292

"status": "A String", # Status of an operation stage.

5293

# Unset for single-stage operations.

5294

"metrics": [ # Progress metric bundle, for example:

5295

# metrics: [{name: "nodes done", int_value: 15},

5296

# {name: "nodes total", int_value: 32}]

5297

# or

5298

# metrics: [{name: "progress", double_value: 0.56},

5299

# {name: "progress scale", double_value: 1.0}]

5300

{ # Progress metric is (string, int|float|string) pair.

5301

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

5302

"doubleValue": 3.14, # For metrics with floating point value.

5303

"intValue": "A String", # For metrics with integer value.

5304

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

5305

},

5306

],

5307

"name": "A String", # A non-parameterized string describing an operation stage.

5308

# Unset for single-stage operations.

5309

},

5310

"zone": "A String", # The name of the Google Compute Engine

5311

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5312

# operation is taking place. This field is deprecated, use location instead.

5313

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

5314

"selfLink": "A String", # Server-defined URL for the resource.

5315

"targetLink": "A String", # Server-defined URL for the target of the operation.

5316

"detail": "A String", # Detailed operation progress, if available.

5317

"operationType": "A String", # The operation type.

5318

"status": "A String", # The current status of the operation.

5319

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim