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

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

167

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

168

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

169

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

170

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

171

# balancers.

Dan O'Meara

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

[diff] [blame]

172

},

Bu Sun Kim

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

[diff] [blame]

173

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

Bu Sun Kim

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

[diff] [blame]

174

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

175

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

176

# workloads and applications. For more information, see:

177

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

Bu Sun Kim

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

[diff] [blame]

178

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

179

},

180

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

181

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

182

},

183

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

184

# applications.

185

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

186

},

187

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

188

# enabled at cluster creation time.

189

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

190

},

191

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

192

# microservices.

Bu Sun Kim

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

[diff] [blame]

193

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

Bu Sun Kim

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

[diff] [blame]

194

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

195

},

196

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

197

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

198

# is enabled for the nodes.

199

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

200

# is enabled for the nodes.

201

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

202

},

203

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

204

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

205

# at cluster creation time.

206

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

207

},

208

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

209

# extension to manage hosted GCP services through the Kubernetes API

210

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

211

},

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

# Monitoring.

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

[diff] [blame]

234

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

235

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

236

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

237

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

238

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

Bu Sun Kim

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

[diff] [blame]

239

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

Bu Sun Kim

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

[diff] [blame]

240

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

241

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

Bu Sun Kim

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

[diff] [blame]

242

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

243

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

Bu Sun Kim

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

[diff] [blame]

244

},

245

],

Bu Sun Kim

2020-05-27 12:20:54 -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.

Bu Sun Kim

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

[diff] [blame]

248

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

Dan O'Meara

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

[diff] [blame]

249

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

250

# or

251

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

252

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

},

261

],

262

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

Bu Sun Kim

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

[diff] [blame]

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

],

Bu Sun Kim

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

[diff] [blame]

276

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

277

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

278

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

279

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

280

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

281

# Object with schema name: OperationProgress

282

],

Bu Sun Kim

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

[diff] [blame]

283

},

284

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

285

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

286

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

287

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

288

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

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

[diff] [blame]

310

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

311

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

Bu Sun Kim

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

[diff] [blame]

312

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

313

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

314

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

315

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

316

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

Bu Sun Kim

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

[diff] [blame]

317

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

Dan O'Meara

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

[diff] [blame]

318

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

319

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

320

# field.

Bu Sun Kim

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

[diff] [blame]

321

}

322

323

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

330

331

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

332

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

Bu Sun Kim

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

[diff] [blame]

333

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

334

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

335

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

336

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

337

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

Bu Sun Kim

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

[diff] [blame]

338

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

Bu Sun Kim

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

[diff] [blame]

339

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

340

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

Bu Sun Kim

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

[diff] [blame]

341

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

342

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

Bu Sun Kim

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

[diff] [blame]

343

},

344

],

Bu Sun Kim

2020-05-27 12:20:54 -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.

Bu Sun Kim

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

[diff] [blame]

347

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

Dan O'Meara

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

[diff] [blame]

348

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

349

# or

350

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

351

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

},

360

],

361

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

Bu Sun Kim

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

[diff] [blame]

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

],

Bu Sun Kim

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

[diff] [blame]

375

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

376

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

377

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

378

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

379

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

380

# Object with schema name: OperationProgress

381

],

Bu Sun Kim

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

[diff] [blame]

382

},

383

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

384

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

385

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

386

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

387

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

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

[diff] [blame]

420

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

421

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

Bu Sun Kim

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

[diff] [blame]

422

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

Dan O'Meara

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

[diff] [blame]

423

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

Bu Sun Kim

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

[diff] [blame]

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

# private networking.

432

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

433

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

434

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

435

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

436

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

437

},

438

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

439

},

440

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

441

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

442

},

443

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

444

# required by Vertical Pod Autoscaler to automatically adjust

445

# the resources of pods controlled by it.

446

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

447

},

Bu Sun Kim

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

[diff] [blame]

448

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

449

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

450

# if cluster created with IP Alias support.

451

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

452

},

453

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

454

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

455

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

456

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

457

# name.

458

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

459

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

460

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

461

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

462

# mode.

Bu Sun Kim

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

[diff] [blame]

463

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

464

# master authorized networks will disallow all external traffic to access

465

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

466

# Google Compute Engine Public IPs and Google Prod IPs.

Bu Sun Kim

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

[diff] [blame]

467

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

Bu Sun Kim

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

[diff] [blame]

468

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

469

# Kubernetes master through HTTPS.

470

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

Bu Sun Kim

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

[diff] [blame]

471

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

Bu Sun Kim

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

[diff] [blame]

472

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

Bu Sun Kim

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

[diff] [blame]

473

},

474

],

Bu Sun Kim

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

[diff] [blame]

475

},

476

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

477

# cluster, if available.

478

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

479

# If unspecified, the defaults are used:

480

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

481

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

482

# certificate will be issued.

483

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

484

# certificates.

485

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

486

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

487

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

488

# must be non-empty.

489

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

490

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

491

# certificate is issued.

492

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

493

},

494

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

495

# to the cluster endpoint.

496

"clusterCaCertificate": "A String",

497

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

498

# authenticate to the cluster endpoint.

499

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

500

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

501

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

502

},

503

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

Bu Sun Kim

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

[diff] [blame]

504

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

505

# if enabled = true.

Bu Sun Kim

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

[diff] [blame]

506

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

507

# during authentication using a group of security groups.

Bu Sun Kim

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

[diff] [blame]

508

},

509

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

510

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

511

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

512

# This field is deprecated, use

513

# private_cluster_config.master_ipv4_cidr_block instead.

514

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

515

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

516

},

517

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

Bu Sun Kim

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

[diff] [blame]

518

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

519

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

520

# must be valid under a PodSecurityPolicy to be created.

521

},

Bu Sun Kim

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

[diff] [blame]

522

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

523

# cluster, enabling additional functionality.

Bu Sun Kim

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

[diff] [blame]

524

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

525

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

526

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

527

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

528

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

529

# balancers.

530

},

531

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

532

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

533

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

534

# workloads and applications. For more information, see:

535

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

536

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

537

},

538

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

539

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

540

},

541

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

542

# applications.

543

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

544

},

545

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

546

# enabled at cluster creation time.

547

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

548

},

549

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

550

# microservices.

Bu Sun Kim

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

[diff] [blame]

551

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

Bu Sun Kim

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

[diff] [blame]

552

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

553

},

554

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

555

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

556

# is enabled for the nodes.

557

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

558

# is enabled for the nodes.

559

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

560

},

561

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

562

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

563

# at cluster creation time.

564

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

565

},

566

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

567

# extension to manage hosted GCP services through the Kubernetes API

568

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

569

},

570

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

571

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

572

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

573

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

574

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

575

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

576

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

577

# Monitoring.

Bu Sun Kim

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

[diff] [blame]

578

},

579

},

Bu Sun Kim

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

[diff] [blame]

580

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

581

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

582

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

583

# the name.

Bu Sun Kim

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

[diff] [blame]

584

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

585

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

586

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

587

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

588

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

Bu Sun Kim

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

[diff] [blame]

589

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

Bu Sun Kim

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

[diff] [blame]

590

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

Bu Sun Kim

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

[diff] [blame]

591

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

592

# occur in these windows.

593

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

594

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

595

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

596

# start time.

597

},

Bu Sun Kim

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

[diff] [blame]

598

},

599

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

600

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

601

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

Bu Sun Kim

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

[diff] [blame]

602

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

603

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

604

# end time.

605

#

Bu Sun Kim

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

[diff] [blame]

606

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

Dan O'Meara

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

[diff] [blame]

607

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

608

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

609

# <code>FREQ=DAILY</code>

610

# For the first weekend of every month:

611

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

612

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

613

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

614

# <code>

615

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

616

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

617

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

618

# </code>

619

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

620

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

621

# <code>

622

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

623

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

624

# recurrence = FREQ=WEEKLY;BYDAY=SA

625

# </code>

Bu Sun Kim

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

[diff] [blame]

626

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

627

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

628

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

Bu Sun Kim

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

[diff] [blame]

629

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

Bu Sun Kim

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

[diff] [blame]

630

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

Bu Sun Kim

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

[diff] [blame]

631

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

632

# start time.

Dan O'Meara

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

[diff] [blame]

633

},

634

},

Bu Sun Kim

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

[diff] [blame]

635

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

636

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

637

# smallest possible in the given scenario.

638

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

639

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

Dan O'Meara

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

[diff] [blame]

640

},

Bu Sun Kim

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

[diff] [blame]

641

},

Bu Sun Kim

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

[diff] [blame]

642

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

643

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

644

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

645

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

646

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

Bu Sun Kim

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

[diff] [blame]

647

},

Bu Sun Kim

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

[diff] [blame]

648

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

649

# Google Compute Engine resources.

650

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

651

},

Bu Sun Kim

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

[diff] [blame]

652

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

653

# found in validMasterVersions returned by getServerConfig. The version can

654

# be upgraded over time; such upgrades are reflected in

655

# currentMasterVersion and currentNodeVersion.

Dan O'Meara

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

[diff] [blame]

656

#

Bu Sun Kim

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

[diff] [blame]

657

# Users may specify either explicit versions offered by

658

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

Dan O'Meara

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

[diff] [blame]

659

#

Bu Sun Kim

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

[diff] [blame]

660

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

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

# then the server picks the default IP allocation mode

670

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

671

# will be automatically chosen with the default size.

672

#

673

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

674

#

675

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

676

#

677

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

682

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

683

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

684

# to use.

Bu Sun Kim

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

[diff] [blame]

685

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

686

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

687

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

688

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

689

# range.

690

#

691

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

692

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

693

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

694

# `services_ipv4_cidr_block` must be fully-specified.

695

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

696

# fully-specified.

697

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

698

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

699

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

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

[diff] [blame]

700

#

701

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

Bu Sun Kim

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

[diff] [blame]

702

#

703

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

704

#

705

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

710

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

711

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

712

# to use.

713

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

714

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

715

# addresses. This must be an existing secondary range associated

716

# with the cluster subnetwork.

717

#

718

# This field is only applicable with use_ip_aliases and

719

# create_subnetwork is false.

720

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

721

#

722

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

723

#

724

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

725

#

726

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

731

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

732

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

733

# to use.

Bu Sun Kim

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

[diff] [blame]

734

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

735

# range will be automatically chosen with the default size.

736

#

737

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

738

#

739

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

740

#

741

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

746

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

747

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

748

# to use.

Dan O'Meara

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

[diff] [blame]

749

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

Bu Sun Kim

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

[diff] [blame]

750

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

751

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

752

# ClusterIPs. This must be an existing secondary range associated

753

# with the cluster subnetwork.

754

#

755

# This field is only applicable with use_ip_aliases and

756

# create_subnetwork is false.

Bu Sun Kim

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

[diff] [blame]

757

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

758

#

759

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

Bu Sun Kim

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

[diff] [blame]

760

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

761

# This is used in conjunction with use_routes. It cannot

762

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

763

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

Bu Sun Kim

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

[diff] [blame]

764

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

765

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

766

# subnetwork.

767

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

768

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

Bu Sun Kim

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

[diff] [blame]

769

},

Bu Sun Kim

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

[diff] [blame]

770

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

771

# mode.

772

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

773

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

774

# controllers, will have statically granted permissions beyond those

775

# provided by the RBAC configuration or IAM.

Bu Sun Kim

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

[diff] [blame]

776

},

Bu Sun Kim

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

[diff] [blame]

777

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

778

# disabled when this config unspecified.

779

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

780

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

781

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

782

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

783

# second BigQuery table will be created to hold resource consumption

784

# records.

Bu Sun Kim

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

[diff] [blame]

785

},

Bu Sun Kim

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

[diff] [blame]

786

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

787

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

Bu Sun Kim

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

[diff] [blame]

788

},

Bu Sun Kim

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

[diff] [blame]

789

},

Bu Sun Kim

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

[diff] [blame]

790

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

791

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

Bu Sun Kim

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

[diff] [blame]

792

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

793

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

794

# specified.

Bu Sun Kim

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

[diff] [blame]

795

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

796

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

797

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

798

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

799

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

800

# the workload.

Bu Sun Kim

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

[diff] [blame]

801

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

802

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

Bu Sun Kim

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

[diff] [blame]

803

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

804

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

805

# friendly names of CPU platforms, such as

806

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

807

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

808

# information, read [how to specify min CPU

809

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

Bu Sun Kim

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

[diff] [blame]

810

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

811

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

812

#

813

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

814

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

815

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

816

# the instance is created.

817

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

818

#

819

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

820

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

821

# boot process if signature verification fails.

822

},

Bu Sun Kim

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

[diff] [blame]

823

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

824

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

825

# inforamtion about preemptible VM instances.

826

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

827

#

Bu Sun Kim

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

[diff] [blame]

828

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

829

# disks available on a machine per zone. See:

830

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

831

# for more information.

832

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

833

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

834

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

835

},

836

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

837

#

838

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

839

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

840

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

841

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

847

# "enable-oslogin"

848

# "gci-ensure-gke-docker"

849

# "gci-metrics-enabled"

850

# "gci-update-strategy"

851

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

856

# "windows-startup-script-ps1"

857

# "common-psm1"

858

# "k8s-node-setup-psm1"

859

# "install-ssh-psm1"

860

# "user-profile-psm1"

861

# "serial-port-logging-enable"

862

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

863

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

864

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

865

#

866

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

867

"a_key": "A String",

868

},

869

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

870

# the specified [Zonal Compute

871

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

872

# to this node pool.

873

# is the configuration of desired reservation which instances could take

874

# capacity from.

875

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

876

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

877

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

878

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

879

"A String",

880

],

881

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

882

},

883

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

884

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

885

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

886

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame]

887

"A String",

Bu Sun Kim

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

[diff] [blame]

888

],

Bu Sun Kim

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

[diff] [blame]

889

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

890

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

Bu Sun Kim

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

[diff] [blame]

891

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

892

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

893

# the latest version of it will be used.

894

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

895

# node VMs under the "default" service account.

Bu Sun Kim

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

[diff] [blame]

896

#

897

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

898

# not included:

899

#

900

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

901

# persistent storage on your nodes.

902

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

903

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

904

# (the [Google Container

905

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

Bu Sun Kim

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

[diff] [blame]

906

#

907

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

908

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

Bu Sun Kim

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

[diff] [blame]

909

"A String",

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

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

Bu Sun Kim

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

[diff] [blame]

912

#

913

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

914

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

915

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

916

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

917

#

Bu Sun Kim

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

[diff] [blame]

918

# See

919

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

920

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

Bu Sun Kim

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

[diff] [blame]

921

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

Bu Sun Kim

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

[diff] [blame]

922

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

923

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

Bu Sun Kim

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

[diff] [blame]

924

},

925

],

Bu Sun Kim

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

[diff] [blame]

926

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

927

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

928

# Kubernetes may apply to the node.

929

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

930

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

931

# and conflicts should be avoided.

932

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

933

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

934

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

935

},

Bu Sun Kim

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

[diff] [blame]

936

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

937

# The smallest allowed disk size is 10GB.

938

#

939

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

940

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

941

# workloads on the node pool.

942

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

943

# workloads running on the node.

944

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

945

# on the node pool.

946

},

947

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

948

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

949

# support for GPUs.

950

{ # AcceleratorConfig represents a Hardware Accelerator request.

951

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

952

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

953

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

954

},

955

],

956

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

957

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

958

# `n1-standard-1`).

959

#

960

# If unspecified, the default machine type is

961

# `n1-standard-1`.

962

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

963

#

964

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

965

"bootDiskKmsKey": "A String", #

966

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

967

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

968

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

969

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

970

# see:

971

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

Bu Sun Kim

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

[diff] [blame]

972

},

Bu Sun Kim

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

[diff] [blame]

973

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

974

# simultaneously on a node in the node pool.

975

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

976

},

Bu Sun Kim

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

[diff] [blame]

977

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

Bu Sun Kim

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

[diff] [blame]

978

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

979

# node pool.

Bu Sun Kim

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

[diff] [blame]

980

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

Bu Sun Kim

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

[diff] [blame]

981

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

Bu Sun Kim

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

[diff] [blame]

982

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

983

# the Auto Upgrades will proceed.

984

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

985

# with the description of the upgrade.

986

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

987

# with the approximate start time for the upgrades, in

988

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

989

},

990

},

Bu Sun Kim

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

[diff] [blame]

991

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

992

# node pool instance, if available.

993

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

994

# only if a valid configuration is present.

995

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

996

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

997

# has to enough quota to scale up the cluster.

998

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

999

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

1000

# max_node_count.

1001

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

1002

},

1003

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

1004

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

1005

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

1006

# firewall and routes quota.

1007

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

1008

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

1009

# NodePool's nodes should be located.

1010

"A String",

1011

],

1012

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

1013

# disruption caused by an upgrade.

1014

#

1015

# maxUnavailable controls the number of nodes that can be simultaneously

1016

# unavailable.

1017

#

1018

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

1019

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

1020

# available nodes.

1021

#

1022

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

1023

# nodes are being upgraded at the same time).

1024

#

1025

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

1026

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

1027

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

1028

# PodDisruptionBudget, if it is configured.)

1029

#

1030

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

1031

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

1032

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

1033

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

1034

# there are always at least 4 nodes available.

1035

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

1036

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

1037

# Ready.

1038

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

1039

# of the node pool during the upgrade process.

1040

},

1041

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

1042

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

1043

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

1044

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

1045

# associated with this node pool.

1046

"A String",

1047

],

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

},

1055

],

Bu Sun Kim

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

[diff] [blame]

1056

},

1057

],

Bu Sun Kim

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

[diff] [blame]

1058

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

1059

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

1060

# cluster's nodes should be located.

1061

"A String",

1062

],

Bu Sun Kim

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

[diff] [blame]

1063

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

Bu Sun Kim

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

[diff] [blame]

1064

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

1065

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

1066

# frequency of updates.

1067

#

1068

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

1069

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

1070

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

1071

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

1072

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

1073

},

Bu Sun Kim

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

[diff] [blame]

1074

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

1075

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

1076

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

1077

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

1078

},

1079

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

1080

# this cluster, in

1081

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

1082

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

1083

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

Bu Sun Kim

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

[diff] [blame]

1084

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

1085

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

1086

# the kubernetes version of the master and nodes.

1087

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

1088

# Alpha enabled clusters are automatically deleted thirty days after

1089

# creation.

1090

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

1091

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

1092

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

1093

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

1094

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

1095

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

1096

},

1097

],

1098

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

1099

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

1100

# master communicate over private IP addresses.

1101

# This field is deprecated, use private_cluster_config.enable_private_nodes

1102

# instead.

1103

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

1104

# Call Kubernetes API directly to retrieve node information.

1105

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

1106

# Currently available options:

1107

#

Bu Sun Kim

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

[diff] [blame]

1108

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

Dan O'Meara

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

[diff] [blame]

1109

# service with a Kubernetes-native resource model

1110

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

1111

# longer available as of GKE 1.15).

1112

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

1113

#

1114

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

1115

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

Bu Sun Kim

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

[diff] [blame]

1116

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

1117

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

1118

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

1119

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

Bu Sun Kim

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

[diff] [blame]

1120

},

Bu Sun Kim

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

[diff] [blame]

1121

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

1122

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

1123

# images will be validated by Google Binauthz.

Bu Sun Kim

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

[diff] [blame]

1124

},

Bu Sun Kim

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

[diff] [blame]

1125

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

1126

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

1127

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

1128

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

1129

# policies.

1130

# policies.

Bu Sun Kim

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

[diff] [blame]

1131

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

Bu Sun Kim

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

[diff] [blame]

1132

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

Bu Sun Kim

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

[diff] [blame]

1133

},

1134

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

Dan O'Meara

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

[diff] [blame]

1135

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

1136

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

Bu Sun Kim

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

[diff] [blame]

1137

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

1138

# Currently available options:

Bu Sun Kim

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

[diff] [blame]

1139

#

Bu Sun Kim

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

[diff] [blame]

1140

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

1141

# service with a Kubernetes-native resource model

1142

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

1143

# available as of GKE 1.15).

1144

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

Bu Sun Kim

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

[diff] [blame]

1145

#

Bu Sun Kim

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

[diff] [blame]

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

Bu Sun Kim

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

[diff] [blame]

1152

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

1153

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

1154

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

1155

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

1156

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

1157

# `node_pool.config`)

1158

#

1159

# If unspecified, the defaults are used.

1160

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

Bu Sun Kim

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

[diff] [blame]

1161

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

1162

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

1163

# friendly names of CPU platforms, such as

1164

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

1165

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

1166

# information, read [how to specify min CPU

1167

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

Bu Sun Kim

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

[diff] [blame]

1168

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

1169

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

1170

#

1171

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

1172

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

1173

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

1174

# the instance is created.

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

},

Bu Sun Kim

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

[diff] [blame]

1181

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

1182

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

1183

# inforamtion about preemptible VM instances.

1184

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

1185

#

Bu Sun Kim

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

[diff] [blame]

1186

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

1187

# disks available on a machine per zone. See:

1188

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

1189

# for more information.

1190

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

1191

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

1192

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

1193

},

1194

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

1195

#

1196

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

1197

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

1198

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

1199

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1205

# "enable-oslogin"

1206

# "gci-ensure-gke-docker"

1207

# "gci-metrics-enabled"

1208

# "gci-update-strategy"

1209

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1214

# "windows-startup-script-ps1"

1215

# "common-psm1"

1216

# "k8s-node-setup-psm1"

1217

# "install-ssh-psm1"

1218

# "user-profile-psm1"

1219

# "serial-port-logging-enable"

1220

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

1221

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

1222

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

1223

#

1224

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

1225

"a_key": "A String",

1226

},

1227

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

1228

# the specified [Zonal Compute

1229

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

1230

# to this node pool.

1231

# is the configuration of desired reservation which instances could take

1232

# capacity from.

1233

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

1234

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

1235

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

1236

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

1237

"A String",

1238

],

1239

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

1240

},

1241

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

1242

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

1243

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

1244

# must comply with RFC1035.

Bu Sun Kim

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

[diff] [blame]

1245

"A String",

Bu Sun Kim

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

[diff] [blame]

1246

],

Bu Sun Kim

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

[diff] [blame]

1247

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

1248

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

Bu Sun Kim

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

[diff] [blame]

1249

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

1250

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

1251

# the latest version of it will be used.

1252

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

1253

# node VMs under the "default" service account.

Bu Sun Kim

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

[diff] [blame]

1254

#

1255

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

1256

# not included:

1257

#

1258

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

1259

# persistent storage on your nodes.

1260

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

1261

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

1262

# (the [Google Container

1263

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

Bu Sun Kim

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

[diff] [blame]

1264

#

1265

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

1266

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

Bu Sun Kim

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

[diff] [blame]

1267

"A String",

Bu Sun Kim

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

[diff] [blame]

1268

],

Bu Sun Kim

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

[diff] [blame]

1269

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

Bu Sun Kim

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

[diff] [blame]

1270

#

1271

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

1272

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

1273

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

1274

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

1275

#

Bu Sun Kim

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

[diff] [blame]

1276

# See

1277

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

1278

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

Bu Sun Kim

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

[diff] [blame]

1279

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

Bu Sun Kim

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

[diff] [blame]

1280

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

1281

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

Bu Sun Kim

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

[diff] [blame]

1282

},

1283

],

Bu Sun Kim

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

[diff] [blame]

1284

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

1285

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

1286

# Kubernetes may apply to the node.

1287

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

1288

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

1289

# and conflicts should be avoided.

1290

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

1291

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

1292

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1293

},

Bu Sun Kim

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

[diff] [blame]

1294

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

1295

# The smallest allowed disk size is 10GB.

1296

#

1297

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

1298

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

1299

# workloads on the node pool.

1300

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

1301

# workloads running on the node.

1302

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

1303

# on the node pool.

1304

},

1305

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

1306

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

1307

# support for GPUs.

1308

{ # AcceleratorConfig represents a Hardware Accelerator request.

1309

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

1310

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

1311

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

1312

},

1313

],

1314

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

1315

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

1316

# `n1-standard-1`).

1317

#

1318

# If unspecified, the default machine type is

1319

# `n1-standard-1`.

1320

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

1321

#

1322

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

1323

"bootDiskKmsKey": "A String", #

1324

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

1325

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

1326

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

1327

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

1328

# see:

1329

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

1330

},

1331

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

1332

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

1333

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

1334

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1335

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1336

"status": "A String", # [Output only] The current status of this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1337

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1338

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

1339

# This makes same node pod to pod traffic visible for VPC network.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1340

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

1341

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

1342

# cluster is connected. Example:

1343

# projects/my-project/regions/us-central1/subnetworks/my-subnet

1344

"network": "A String", # Output only. The relative name of the Google Compute Engine

1345

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1346

# to which the cluster is connected. Example:

1347

# projects/my-project/global/networks/my-network

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1348

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules

1349

# will be disabled when default_snat_status is disabled. When disabled is set

1350

# to false, default IP masquerade rules will be applied to the nodes to

1351

# prevent sNAT on cluster internal traffic.

1352

# be disabled on the cluster.

1353

"disabled": True or False, # Disables cluster default sNAT rules.

1354

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1355

},

1356

"name": "A String", # The name of this cluster. The name must be unique within this project

1357

# and location (e.g. zone or region), and can be up to 40 characters with

1358

# the following restrictions:

1359

#

1360

# * Lowercase letters, numbers, and hyphens only.

1361

# * Must start with a letter.

1362

# * Must end with a number or a letter.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1363

"location": "A String", # [Output only] The name of the Google Compute Engine

1364

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1365

# or

1366

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1367

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1368

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

1369

# The endpoint can be accessed from the internet at

1370

# `https://username:password@endpoint/`.

1371

#

1372

# See the `masterAuth` property of this resource for username and

1373

# password information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1374

"createTime": "A String", # [Output only] The time the cluster was created, in

1375

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1376

"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]

1377

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1378

# notation (e.g. `10.96.0.0/14`). Leave blank to have

1379

# 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]

1380

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

1381

# required by Cluster Autoscaler to automatically adjust

1382

# the size of the cluster and create/delete

1383

# node pools based on the current needs.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1384

"autoprovisioningLocations": [ # The list of Google Compute Engine

1385

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1386

# NodePool's nodes can be created by NAP.

1387

"A String",

1388

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1389

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

1390

# amount of resources in the cluster.

1391

{ # Contains information about amount of some resource in the cluster.

1392

# For memory, value should be in GB.

1393

"maximum": "A String", # Maximum amount of the resource in the cluster.

1394

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

1395

"minimum": "A String", # Minimum amount of the resource in the cluster.

1396

},

1397

],

1398

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

1399

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

1400

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

1401

# created by NAP.

1402

# by NAP.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1403

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

1404

# service_account is specified, scopes should be empty.

1405

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

1406

# The instance may be scheduled on the specified or newer CPU platform.

1407

# Applicable values are the friendly names of CPU platforms, such as

1408

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

1409

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

1410

# information, read [how to specify min CPU

1411

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1412

# To unset the min cpu platform field pass "automatic" as field value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1413

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

1414

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1415

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1416

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1417

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

1418

# the Auto Upgrades will proceed.

1419

"description": "A String", # [Output only] This field is set when upgrades are about to commence

1420

# with the description of the upgrade.

1421

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

1422

# with the approximate start time for the upgrades, in

1423

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1424

},

1425

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1426

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

1427

# specified, service_account should be empty.

1428

"A String",

1429

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1430

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

1431

# disruption caused by an upgrade.

1432

#

1433

# maxUnavailable controls the number of nodes that can be simultaneously

1434

# unavailable.

1435

#

1436

# maxSurge controls the number of additional nodes that can be added to the

1437

# node pool temporarily for the time of the upgrade to increase the number of

1438

# available nodes.

1439

#

1440

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

1441

# nodes are being upgraded at the same time).

1442

#

1443

# Note: upgrades inevitably introduce some disruption since workloads need to

1444

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

1445

# this holds true. (Disruption stays within the limits of

1446

# PodDisruptionBudget, if it is configured.)

1447

#

1448

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

1449

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

1450

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

1451

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

1452

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1453

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

1454

# the upgrade process. A node is considered available if its status is

1455

# Ready.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1456

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

1457

# of the node pool during the upgrade process.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1458

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1459

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1460

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1461

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

1462

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1463

# is sufficient for this number of instances. You must also have available

1464

# firewall and routes quota.

1465

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1466

# "node_pool" object, since this configuration (along with the

1467

# "node_config") will be used to create a "NodePool" object with an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1468

# auto-generated name. Do not use this and a node_pool at the same time.

1469

#

1470

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1471

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

1472

"A String",

1473

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1474

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1475

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

1476

# number](https://support.google.com/cloud/answer/6158840).

1477

# This field has been deprecated and replaced by the parent field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1478

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

1479

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1480

# cluster resides. This field has been deprecated and replaced by the parent

1481

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1482

}

1483

1484

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1491

1492

{ # This operation resource represents operations that may have happened or are

1493

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1494

"targetLink": "A String", # Server-defined URL for the target of the operation.

1495

"detail": "A String", # Detailed operation progress, if available.

1496

"operationType": "A String", # The operation type.

1497

"status": "A String", # The current status of the operation.

1498

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1499

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1500

{ # StatusCondition describes why a cluster or a node pool has a certain status

1501

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1502

"code": "A String", # Machine-friendly representation of the condition

1503

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1504

},

1505

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1506

"endTime": "A String", # [Output only] The time the operation completed, in

1507

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1508

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1509

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1510

# or

1511

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1512

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1513

"startTime": "A String", # [Output only] The time the operation started, in

1514

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1515

"clusterConditions": [ # Which conditions caused the current cluster state.

1516

{ # StatusCondition describes why a cluster or a node pool has a certain status

1517

# (e.g., ERROR or DEGRADED).

1518

"code": "A String", # Machine-friendly representation of the condition

1519

"message": "A String", # Human-friendly representation of the condition

1520

},

1521

],

1522

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1523

"metrics": [ # Progress metric bundle, for example:

1524

# metrics: [{name: "nodes done", int_value: 15},

1525

# {name: "nodes total", int_value: 32}]

1526

# or

1527

# metrics: [{name: "progress", double_value: 0.56},

1528

# {name: "progress scale", double_value: 1.0}]

1529

{ # Progress metric is (string, int|float|string) pair.

1530

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1531

"doubleValue": 3.14, # For metrics with floating point value.

1532

"intValue": "A String", # For metrics with integer value.

1533

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1534

},

1535

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1536

"status": "A String", # Status of an operation stage.

1537

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1538

"name": "A String", # A non-parameterized string describing an operation stage.

1539

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1540

"stages": [ # Substages of an operation or a stage.

1541

# Object with schema name: OperationProgress

1542

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1543

},

1544

"zone": "A String", # The name of the Google Compute Engine

1545

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1546

# operation is taking place. This field is deprecated, use location instead.

1547

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1548

"selfLink": "A String", # Server-defined URL for the resource.

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>

1554

<pre>Deletes the cluster, including the Kubernetes endpoint and all worker

1555

nodes.

1556

1557

Firewalls and routes that were configured during cluster creation

1558

are also deleted.

1559

1560

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]

1561

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]

1562

when the cluster was initially created.

1563

1564

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1565

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1566

number](https://support.google.com/cloud/answer/6158840).

1567

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1568

zone: string, Required. Deprecated. The name of the Google Compute Engine

1569

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1570

cluster resides. This field has been deprecated and replaced by the name

1571

field. (required)

1572

clusterId: string, Required. Deprecated. The name of the cluster to delete.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1573

This field has been deprecated and replaced by the name field. (required)

1574

name: string, The name (project, location, cluster) of the cluster to delete.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1575

Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1576

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1583

1584

{ # This operation resource represents operations that may have happened or are

1585

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1586

"targetLink": "A String", # Server-defined URL for the target of the operation.

1587

"detail": "A String", # Detailed operation progress, if available.

1588

"operationType": "A String", # The operation type.

1589

"status": "A String", # The current status of the operation.

1590

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1591

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1592

{ # StatusCondition describes why a cluster or a node pool has a certain status

1593

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1594

"code": "A String", # Machine-friendly representation of the condition

1595

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1596

},

1597

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1598

"endTime": "A String", # [Output only] The time the operation completed, in

1599

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1600

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1601

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1602

# or

1603

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1604

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1605

"startTime": "A String", # [Output only] The time the operation started, in

1606

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1607

"clusterConditions": [ # Which conditions caused the current cluster state.

1608

{ # StatusCondition describes why a cluster or a node pool has a certain status

1609

# (e.g., ERROR or DEGRADED).

1610

"code": "A String", # Machine-friendly representation of the condition

1611

"message": "A String", # Human-friendly representation of the condition

1612

},

1613

],

1614

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1615

"metrics": [ # Progress metric bundle, for example:

1616

# metrics: [{name: "nodes done", int_value: 15},

1617

# {name: "nodes total", int_value: 32}]

1618

# or

1619

# metrics: [{name: "progress", double_value: 0.56},

1620

# {name: "progress scale", double_value: 1.0}]

1621

{ # Progress metric is (string, int|float|string) pair.

1622

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1623

"doubleValue": 3.14, # For metrics with floating point value.

1624

"intValue": "A String", # For metrics with integer value.

1625

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1626

},

1627

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1628

"status": "A String", # Status of an operation stage.

1629

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1630

"name": "A String", # A non-parameterized string describing an operation stage.

1631

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1632

"stages": [ # Substages of an operation or a stage.

1633

# Object with schema name: OperationProgress

1634

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1635

},

1636

"zone": "A String", # The name of the Google Compute Engine

1637

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1638

# operation is taking place. This field is deprecated, use location instead.

1639

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

1640

"selfLink": "A String", # Server-defined URL for the resource.

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>

1646

<pre>Gets the details for a specific cluster.

1647

1648

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1649

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1650

number](https://support.google.com/cloud/answer/6158840).

1651

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1652

zone: string, Required. Deprecated. The name of the Google Compute Engine

1653

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1654

cluster resides. This field has been deprecated and replaced by the name

1655

field. (required)

1656

clusterId: string, Required. Deprecated. The name of the cluster to retrieve.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1657

This field has been deprecated and replaced by the name field. (required)

1658

name: string, The name (project, location, cluster) of the cluster to retrieve.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1659

Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1660

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1667

1668

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1669

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

1670

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

1671

# range will be used for assigning internal IP addresses to the master or

1672

# set of masters, as well as the ILB VIP. This range must not overlap with

1673

# any other ranges in use within the cluster's network.

1674

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

1675

# given only RFC 1918 private addresses and communicate with the master via

1676

# private networking.

1677

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

1678

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

1679

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

1680

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

1681

"enabled": True or False, # Whenever master is accessible globally or not.

1682

},

1683

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

1684

},

1685

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

1686

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

1687

},

1688

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

1689

# required by Vertical Pod Autoscaler to automatically adjust

1690

# the resources of pods controlled by it.

1691

"enabled": True or False, # Enables vertical pod autoscaling.

1692

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1693

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

1694

# simultaneously on a node in the node pool of this cluster. Only honored

1695

# if cluster created with IP Alias support.

1696

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1697

},

1698

"network": "A String", # The name of the Google Compute Engine

1699

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1700

# to which the cluster is connected. If left unspecified, the `default`

1701

# network will be used. On output this shows the network ID instead of the

1702

# name.

1703

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

1704

"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]

1705

# containers. This is provisioned from within the `container_ipv4_cidr`

1706

# range. This field will only be set when cluster is in route-based network

1707

# mode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1708

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

1709

# master authorized networks will disallow all external traffic to access

1710

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

1711

# Google Compute Engine Public IPs and Google Prod IPs.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1712

"enabled": True or False, # Whether or not master authorized networks is enabled.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1713

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

1714

# Kubernetes master through HTTPS.

1715

{ # CidrBlock contains an optional name and one CIDR block.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1716

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1717

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1718

},

1719

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1720

},

1721

"statusMessage": "A String", # [Output only] Additional information about the current status of this

1722

# cluster, if available.

1723

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

1724

# If unspecified, the defaults are used:

1725

# For clusters before v1.12, if master_auth is unspecified, `username` will

1726

# be set to "admin", a random password will be generated, and a client

1727

# certificate will be issued.

1728

# Authentication can be done using HTTP basic auth or using client

1729

# certificates.

1730

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

1731

# Because the master endpoint is open to the Internet, you should create a

1732

# strong password. If a password is provided for cluster creation, username

1733

# must be non-empty.

1734

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

1735

# clusters before v1.12, if no configuration is specified, a client

1736

# certificate is issued.

1737

"issueClientCertificate": True or False, # Issue a client certificate.

1738

},

1739

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

1740

# to the cluster endpoint.

1741

"clusterCaCertificate": "A String",

1742

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

1743

# authenticate to the cluster endpoint.

1744

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

1745

# For clusters v1.6.0 and later, basic authentication can be disabled by

1746

# leaving username unspecified (or setting it to the empty string).

1747

},

1748

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1749

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

1750

# if enabled = true.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1751

"enabled": True or False, # Whether this cluster should return group membership lookups

1752

# during authentication using a group of security groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1753

},

1754

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network.

1755

# This prefix will be used for assigning private IP addresses to the

1756

# master or set of masters, as well as the ILB VIP.

1757

# This field is deprecated, use

1758

# private_cluster_config.master_ipv4_cidr_block instead.

1759

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

1760

"type": "A String", # Type of the integration.

1761

},

1762

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1763

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

1764

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

1765

# must be valid under a PodSecurityPolicy to be created.

1766

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1767

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

1768

# cluster, enabling additional functionality.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1769

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

1770

# makes it easy to set up HTTP load balancers for services in a cluster.

1771

# which makes it easy to set up HTTP load balancers for services in a cluster.

1772

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

1773

# When enabled, it runs a small pod in the cluster that manages the load

1774

# balancers.

1775

},

1776

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

1777

# This addon is deprecated, and will be disabled in 1.15. It is recommended

1778

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

1779

# workloads and applications. For more information, see:

1780

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

1781

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

1782

},

1783

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

1784

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

1785

},

1786

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

1787

# applications.

1788

"enabled": True or False, # Whether KALM is enabled for this cluster.

1789

},

1790

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

1791

# enabled at cluster creation time.

1792

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

1793

},

1794

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

1795

# microservices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1796

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1797

"disabled": True or False, # Whether Istio is enabled for this cluster.

1798

},

1799

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

1800

# is enabled or not on the Master, it does not track whether network policy

1801

# is enabled for the nodes.

1802

# is enabled or not on the Master, it does not track whether network policy

1803

# is enabled for the nodes.

1804

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1805

},

1806

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

1807

# enabled in order to enable Cloud Run addon. This option can only be enabled

1808

# at cluster creation time.

1809

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1810

},

1811

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

1812

# extension to manage hosted GCP services through the Kubernetes API

1813

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

1814

},

1815

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

1816

# increases or decreases the number of replica pods a replication controller

1817

# has based on the resource usage of the existing pods.

1818

# increases or decreases the number of replica pods a replication controller

1819

# has based on the resource usage of the existing pods.

1820

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

1821

# When enabled, it ensures that metrics are collected into Stackdriver

1822

# Monitoring.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1823

},

1824

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1825

"subnetwork": "A String", # The name of the Google Compute Engine

1826

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

1827

# the cluster is connected. On output this shows the subnetwork ID instead of

1828

# the name.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1829

"currentNodeVersion": "A String", # [Output only] Deprecated, use

1830

# [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools)

1831

# instead. The current version of the node software components.

1832

# If they are currently at multiple versions because they're in the process

1833

# of being upgraded, this reflects the minimum version of all nodes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1834

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1835

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1836

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

1837

# occur in these windows.

1838

"a_key": { # Represents an arbitrary window of time.

1839

"startTime": "A String", # The time that the window first starts.

1840

"endTime": "A String", # The time that the window ends. The end time should take place after the

1841

# start time.

1842

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1843

},

1844

"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]

1845

# maintenance to occur. The time windows may be overlapping. If no

1846

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1847

"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]

1848

# this window reccurs. They go on for the span of time between the start and

1849

# end time.

1850

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1851

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1852

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

1853

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

1854

# <code>FREQ=DAILY</code>

1855

# For the first weekend of every month:

1856

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

1857

# 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]

1858

# 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]

1859

# <code>

1860

# start time = 2019-01-01T09:00:00-0400

1861

# end time = 2019-01-01T17:00:00-0400

1862

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

1863

# </code>

1864

# Windows can span multiple days. Eg, to make the window encompass every

1865

# weekend from midnight Saturday till the last minute of Sunday UTC:

1866

# <code>

1867

# start time = 2019-01-05T00:00:00Z

1868

# end time = 2019-01-07T23:59:00Z

1869

# recurrence = FREQ=WEEKLY;BYDAY=SA

1870

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1871

# 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]

1872

# to specify duration of the window and when it first starts.

1873

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1874

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1875

"startTime": "A String", # The time that the window first starts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1876

"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]

1877

# start time.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1878

},

1879

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1880

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1881

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

1882

# smallest possible in the given scenario.

1883

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

1884

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1885

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1886

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1887

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

1888

# the policy won't accidentally undo intermediate changes (and so that users

1889

# of the API unaware of some fields won't accidentally remove other fields).

1890

# Make a <code>get()</code> request to the cluster to get the current

1891

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1892

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1893

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

1894

# Google Compute Engine resources.

1895

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1896

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1897

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

1898

# found in validMasterVersions returned by getServerConfig. The version can

1899

# be upgraded over time; such upgrades are reflected in

1900

# currentMasterVersion and currentNodeVersion.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1901

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1902

# Users may specify either explicit versions offered by

1903

# Kubernetes Engine or version aliases, which have the following behavior:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1904

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1905

# - "latest": picks the highest valid Kubernetes version

1906

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

1907

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

1908

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

1909

# - "","-": picks the default Kubernetes version

1910

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

1911

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster.

1912

# This is used in conjunction with use_ip_aliases. It cannot be true if

1913

# use_ip_aliases is true. If both use_ip_aliases and use_routes are false,

1914

# then the server picks the default IP allocation mode

1915

"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]

1916

# will be automatically chosen with the default size.

1917

#

1918

# This field is only applicable when `use_ip_aliases` is true.

1919

#

1920

# Set to blank to have a range chosen with the default size.

1921

#

1922

# 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)

1927

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1928

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1929

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1930

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain

1931

# kinds of network routes. By default we do not allow cluster CIDR ranges to

1932

# intersect with any user declared routes. With allow_route_overlap == true,

1933

# we allow overlapping with CIDR ranges that are larger than the cluster CIDR

1934

# range.

1935

#

1936

# If this field is set to true, then cluster and services CIDRs must be

1937

# fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:

1938

# 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and

1939

# `services_ipv4_cidr_block` must be fully-specified.

1940

# 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be

1941

# fully-specified.

1942

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1943

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

1944

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1945

#

1946

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1947

#

1948

# Set to blank to have a range chosen with the default size.

1949

#

1950

# 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)

1955

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1956

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1957

# to use.

1958

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

1959

# block. The secondary range will be used for pod IP

1960

# addresses. This must be an existing secondary range associated

1961

# with the cluster subnetwork.

1962

#

1963

# This field is only applicable with use_ip_aliases and

1964

# create_subnetwork is false.

1965

"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]

1966

#

1967

# This is applicable only if `create_subnetwork` is true.

1968

#

1969

# Set to blank to have a range chosen with the default size.

1970

#

1971

# 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)

1976

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1977

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1978

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1979

"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]

1980

# range will be automatically chosen with the default size.

1981

#

1982

# This field is only applicable when `use_ip_aliases` is true.

1983

#

1984

# If unspecified, the range will use the default size.

1985

#

1986

# 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)

1991

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1992

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1993

# to use.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1994

# This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1995

"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]

1996

# CIDR block. The secondary range will be used for service

1997

# ClusterIPs. This must be an existing secondary range associated

1998

# with the cluster subnetwork.

1999

#

2000

# This field is only applicable with use_ip_aliases and

2001

# create_subnetwork is false.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2002

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

2003

#

2004

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2005

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

2006

# This is used in conjunction with use_routes. It cannot

2007

# be true if use_routes is true. If both use_ip_aliases and use_routes are

2008

# false, then the server picks the default IP allocation mode

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2009

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

2010

# this field is empty, then an automatic name will be chosen for the new

2011

# subnetwork.

2012

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

2013

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2014

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2015

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

2016

# mode.

2017

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

2018

# identities in the system, including service accounts, nodes, and

2019

# controllers, will have statically granted permissions beyond those

2020

# provided by the RBAC configuration or IAM.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2021

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2022

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

2023

# disabled when this config unspecified.

2024

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

2025

# daemonset will be created in the cluster to meter network egress traffic.

2026

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

2027

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

2028

# second BigQuery table will be created to hold resource consumption

2029

# records.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2030

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2031

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2032

"datasetId": "A String", # The ID of a BigQuery Dataset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2033

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2034

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2035

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

2036

# This field is deprecated, use tpu_config.enabled instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2037

"nodePools": [ # The node pools associated with this cluster.

2038

# 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]

2039

# specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2040

{ # NodePool contains the name and configuration for a cluster's node pool.

2041

# 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]

2042

# specification, under the control of the cluster master. They may have a set

2043

# of Kubernetes labels applied to them, which may be used to reference them

2044

# during pod scheduling. They may also be resized up or down, to accommodate

2045

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2046

"status": "A String", # [Output only] The status of the nodes in this pool instance.

2047

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2048

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2049

# scheduled on the specified or newer CPU platform. Applicable values are the

2050

# friendly names of CPU platforms, such as

2051

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2052

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2053

# information, read [how to specify min CPU

2054

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2055

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2056

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2057

#

2058

# Enables monitoring and attestation of the boot integrity of the instance.

2059

# The attestation is performed against the integrity policy baseline. This

2060

# baseline is initially derived from the implicitly trusted boot image when

2061

# the instance is created.

2062

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2063

#

2064

# Secure Boot helps ensure that the system only runs authentic software by

2065

# verifying the digital signature of all boot components, and halting the

2066

# boot process if signature verification fails.

2067

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2068

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2069

# https://cloud.google.com/compute/docs/instances/preemptible for more

2070

# inforamtion about preemptible VM instances.

2071

"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]

2072

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2073

# The limit for this value is dependent upon the maximum number of

2074

# disks available on a machine per zone. See:

2075

# https://cloud.google.com/compute/docs/disks/local-ssd

2076

# for more information.

2077

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2078

"type": "A String", # Type of the sandbox to use for the node.

2079

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

2080

},

2081

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2082

#

2083

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2084

# in length. These are reflected as part of a URL in the metadata server.

2085

# Additionally, to avoid ambiguity, keys must not conflict with any other

2086

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2092

# "enable-oslogin"

2093

# "gci-ensure-gke-docker"

2094

# "gci-metrics-enabled"

2095

# "gci-update-strategy"

2096

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2101

# "windows-startup-script-ps1"

2102

# "common-psm1"

2103

# "k8s-node-setup-psm1"

2104

# "install-ssh-psm1"

2105

# "user-profile-psm1"

2106

# "serial-port-logging-enable"

2107

# Values are free-form strings, and only have meaning as interpreted by

2108

# the image running in the instance. The only restriction placed on them is

2109

# that each value's size must be less than or equal to 32 KB.

2110

#

2111

# The total size of all keys and values must be less than 512 KB.

2112

"a_key": "A String",

2113

},

2114

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2115

# the specified [Zonal Compute

2116

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2117

# to this node pool.

2118

# is the configuration of desired reservation which instances could take

2119

# capacity from.

2120

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2121

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2122

# the key and specify the name of your reservation as its value.

2123

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2124

"A String",

2125

],

2126

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2127

},

2128

"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]

2129

# valid sources or targets for network firewalls and are specified by

2130

# the client during cluster or node pool creation. Each tag within the list

2131

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2132

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2133

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2134

"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]

2135

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2136

# Account is specified, the "default" service account is used.

2137

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2138

# the latest version of it will be used.

2139

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2140

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2141

#

2142

# The following scopes are recommended, but not required, and by default are

2143

# not included:

2144

#

2145

# * `https://www.googleapis.com/auth/compute` is required for mounting

2146

# persistent storage on your nodes.

2147

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2148

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2149

# (the [Google Container

2150

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2151

#

2152

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2153

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2154

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2155

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2156

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2157

#

2158

# For more information, including usage and the valid values, see:

2159

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2160

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2161

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2162

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2163

# See

2164

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2165

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2166

"effect": "A String", # Effect for taint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2167

"value": "A String", # Value for taint.

2168

"key": "A String", # Key for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2169

},

2170

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2171

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2172

# These will added in addition to any default label(s) that

2173

# Kubernetes may apply to the node.

2174

# In case of conflict in label keys, the applied set may differ depending on

2175

# the Kubernetes version -- it's best to assume the behavior is undefined

2176

# and conflicts should be avoided.

2177

# For more information, including usage and the valid values, see:

2178

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2179

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2180

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2181

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2182

# The smallest allowed disk size is 10GB.

2183

#

2184

# If unspecified, the default disk size is 100GB.

2185

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2186

# workloads on the node pool.

2187

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

2188

# workloads running on the node.

2189

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2190

# on the node pool.

2191

},

2192

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2193

# See https://cloud.google.com/compute/docs/gpus for more information about

2194

# support for GPUs.

2195

{ # AcceleratorConfig represents a Hardware Accelerator request.

2196

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2197

# [here](https://cloud.google.com/compute/docs/gpus)

2198

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2199

},

2200

],

2201

"machineType": "A String", # The name of a Google Compute Engine [machine

2202

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2203

# `n1-standard-1`).

2204

#

2205

# If unspecified, the default machine type is

2206

# `n1-standard-1`.

2207

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2208

#

2209

# If unspecified, the default disk type is 'pd-standard'

2210

"bootDiskKmsKey": "A String", #

2211

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2212

# to each node in the node pool. This should be of the form

2213

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2214

# For more information about protecting resources with Cloud KMS Keys please

2215

# see:

2216

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2217

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2218

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

2219

# simultaneously on a node in the node pool.

2220

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2221

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2222

"name": "A String", # The name of the node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2223

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

2224

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2225

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2226

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2227

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2228

# the Auto Upgrades will proceed.

2229

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2230

# with the description of the upgrade.

2231

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2232

# with the approximate start time for the upgrades, in

2233

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2234

},

2235

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2236

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2237

# node pool instance, if available.

2238

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

2239

# only if a valid configuration is present.

2240

# adjust the size of the node pool to the current cluster usage.

2241

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

2242

# has to enough quota to scale up the cluster.

2243

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2244

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

2245

# max_node_count.

2246

"enabled": True or False, # Is autoscaling enabled for this node pool.

2247

},

2248

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

2249

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

2250

# is sufficient for this number of instances. You must also have available

2251

# firewall and routes quota.

2252

"locations": [ # The list of Google Compute Engine

2253

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2254

# NodePool's nodes should be located.

2255

"A String",

2256

],

2257

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

2258

# disruption caused by an upgrade.

2259

#

2260

# maxUnavailable controls the number of nodes that can be simultaneously

2261

# unavailable.

2262

#

2263

# maxSurge controls the number of additional nodes that can be added to the

2264

# node pool temporarily for the time of the upgrade to increase the number of

2265

# available nodes.

2266

#

2267

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2268

# nodes are being upgraded at the same time).

2269

#

2270

# Note: upgrades inevitably introduce some disruption since workloads need to

2271

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2272

# this holds true. (Disruption stays within the limits of

2273

# PodDisruptionBudget, if it is configured.)

2274

#

2275

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2276

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2277

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2278

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2279

# there are always at least 4 nodes available.

2280

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2281

# the upgrade process. A node is considered available if its status is

2282

# Ready.

2283

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2284

# of the node pool during the upgrade process.

2285

},

2286

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2287

"version": "A String", # The version of the Kubernetes of this node.

2288

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

2289

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

2290

# associated with this node pool.

2291

"A String",

2292

],

2293

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

2294

"conditions": [ # Which conditions caused the current node pool state.

2295

{ # StatusCondition describes why a cluster or a node pool has a certain status

2296

# (e.g., ERROR or DEGRADED).

2297

"code": "A String", # Machine-friendly representation of the condition

2298

"message": "A String", # Human-friendly representation of the condition

2299

},

2300

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2301

},

2302

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2303

"locations": [ # The list of Google Compute Engine

2304

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2305

# cluster's nodes should be located.

2306

"A String",

2307

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2308

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2309

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

2310

# subscribed to. Release channels are arranged in order of risk and

2311

# frequency of updates.

2312

#

2313

# When a cluster is subscribed to a release channel, Google maintains

2314

# both the master version and the node version. Node auto-upgrade

2315

# defaults to true and cannot be disabled. Updates to version related

2316

# fields (e.g. current_master_version) return an error.

2317

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

2318

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2319

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

2320

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

2321

"provider": "A String", # The selected network policy provider.

2322

"enabled": True or False, # Whether network policy is enabled on the cluster.

2323

},

2324

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

2325

# this cluster, in

2326

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2327

# notation (e.g. `1.2.3.4/29`). Service addresses are

2328

# typically put in the last `/16` from the container CIDR.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2329

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

2330

# API groups (e.g. v1beta1) and features that may not be production ready in

2331

# the kubernetes version of the master and nodes.

2332

# The cluster has no SLA for uptime and master/node upgrades are disabled.

2333

# Alpha enabled clusters are automatically deleted thirty days after

2334

# creation.

2335

"description": "A String", # An optional description of this cluster.

2336

"conditions": [ # Which conditions caused the current cluster state.

2337

{ # StatusCondition describes why a cluster or a node pool has a certain status

2338

# (e.g., ERROR or DEGRADED).

2339

"code": "A String", # Machine-friendly representation of the condition

2340

"message": "A String", # Human-friendly representation of the condition

2341

},

2342

],

2343

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by

2344

# default have no external IP addresses on the nodes and where nodes and the

2345

# master communicate over private IP addresses.

2346

# This field is deprecated, use private_cluster_config.enable_private_nodes

2347

# instead.

2348

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

2349

# Call Kubernetes API directly to retrieve node information.

2350

"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]

2351

# Currently available options:

2352

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2353

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2354

# service with a Kubernetes-native resource model

2355

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

2356

# longer available as of GKE 1.15).

2357

# * `none` - No metrics will be exported from the cluster.

2358

#

2359

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

2360

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2361

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2362

"state": "A String", # Denotes the state of etcd encryption.

2363

"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]

2364

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2365

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2366

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

2367

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

2368

# images will be validated by Google Binauthz.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2369

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2370

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

2371

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2372

# notation (e.g. `1.2.3.4/29`).

2373

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

2374

# policies.

2375

# policies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2376

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2377

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2378

},

2379

"zone": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2380

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2381

# cluster resides. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2382

"loggingService": "A String", # The logging service the cluster should use to write logs.

2383

# Currently available options:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2384

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2385

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

2386

# service with a Kubernetes-native resource model

2387

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

2388

# available as of GKE 1.15).

2389

# * `none` - no logs will be exported from the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2390

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2391

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

2392

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

2393

"expireTime": "A String", # [Output only] The time the cluster will be automatically

2394

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2395

"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]

2396

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2397

# "node_pool" object, since this configuration (along with the

2398

# "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]

2399

# auto-generated name. Do not use this and a node_pool at the same time.

2400

# For responses, this field will be populated with the node configuration of

2401

# the first node pool. (For configuration of each node pool, see

2402

# `node_pool.config`)

2403

#

2404

# If unspecified, the defaults are used.

2405

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2406

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2407

# scheduled on the specified or newer CPU platform. Applicable values are the

2408

# friendly names of CPU platforms, such as

2409

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2410

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2411

# information, read [how to specify min CPU

2412

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2413

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2414

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2415

#

2416

# Enables monitoring and attestation of the boot integrity of the instance.

2417

# The attestation is performed against the integrity policy baseline. This

2418

# baseline is initially derived from the implicitly trusted boot image when

2419

# the instance is created.

2420

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2421

#

2422

# Secure Boot helps ensure that the system only runs authentic software by

2423

# verifying the digital signature of all boot components, and halting the

2424

# boot process if signature verification fails.

2425

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2426

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2427

# https://cloud.google.com/compute/docs/instances/preemptible for more

2428

# inforamtion about preemptible VM instances.

2429

"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]

2430

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2431

# The limit for this value is dependent upon the maximum number of

2432

# disks available on a machine per zone. See:

2433

# https://cloud.google.com/compute/docs/disks/local-ssd

2434

# for more information.

2435

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2436

"type": "A String", # Type of the sandbox to use for the node.

2437

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

2438

},

2439

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2440

#

2441

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2442

# in length. These are reflected as part of a URL in the metadata server.

2443

# Additionally, to avoid ambiguity, keys must not conflict with any other

2444

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2450

# "enable-oslogin"

2451

# "gci-ensure-gke-docker"

2452

# "gci-metrics-enabled"

2453

# "gci-update-strategy"

2454

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2459

# "windows-startup-script-ps1"

2460

# "common-psm1"

2461

# "k8s-node-setup-psm1"

2462

# "install-ssh-psm1"

2463

# "user-profile-psm1"

2464

# "serial-port-logging-enable"

2465

# Values are free-form strings, and only have meaning as interpreted by

2466

# the image running in the instance. The only restriction placed on them is

2467

# that each value's size must be less than or equal to 32 KB.

2468

#

2469

# The total size of all keys and values must be less than 512 KB.

2470

"a_key": "A String",

2471

},

2472

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2473

# the specified [Zonal Compute

2474

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2475

# to this node pool.

2476

# is the configuration of desired reservation which instances could take

2477

# capacity from.

2478

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2479

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2480

# the key and specify the name of your reservation as its value.

2481

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2482

"A String",

2483

],

2484

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2485

},

2486

"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]

2487

# valid sources or targets for network firewalls and are specified by

2488

# the client during cluster or node pool creation. Each tag within the list

2489

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2490

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2491

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2492

"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]

2493

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2494

# Account is specified, the "default" service account is used.

2495

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2496

# the latest version of it will be used.

2497

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2498

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2499

#

2500

# The following scopes are recommended, but not required, and by default are

2501

# not included:

2502

#

2503

# * `https://www.googleapis.com/auth/compute` is required for mounting

2504

# persistent storage on your nodes.

2505

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2506

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2507

# (the [Google Container

2508

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2509

#

2510

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2511

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2512

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2513

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2514

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2515

#

2516

# For more information, including usage and the valid values, see:

2517

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2518

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2519

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2520

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2521

# See

2522

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2523

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2524

"effect": "A String", # Effect for taint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2525

"value": "A String", # Value for taint.

2526

"key": "A String", # Key for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2527

},

2528

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2529

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2530

# These will added in addition to any default label(s) that

2531

# Kubernetes may apply to the node.

2532

# In case of conflict in label keys, the applied set may differ depending on

2533

# the Kubernetes version -- it's best to assume the behavior is undefined

2534

# and conflicts should be avoided.

2535

# For more information, including usage and the valid values, see:

2536

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2537

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2538

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2539

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2540

# The smallest allowed disk size is 10GB.

2541

#

2542

# If unspecified, the default disk size is 100GB.

2543

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2544

# workloads on the node pool.

2545

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

2546

# workloads running on the node.

2547

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2548

# on the node pool.

2549

},

2550

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2551

# See https://cloud.google.com/compute/docs/gpus for more information about

2552

# support for GPUs.

2553

{ # AcceleratorConfig represents a Hardware Accelerator request.

2554

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2555

# [here](https://cloud.google.com/compute/docs/gpus)

2556

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2557

},

2558

],

2559

"machineType": "A String", # The name of a Google Compute Engine [machine

2560

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2561

# `n1-standard-1`).

2562

#

2563

# If unspecified, the default machine type is

2564

# `n1-standard-1`.

2565

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2566

#

2567

# If unspecified, the default disk type is 'pd-standard'

2568

"bootDiskKmsKey": "A String", #

2569

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2570

# to each node in the node pool. This should be of the form

2571

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2572

# For more information about protecting resources with Cloud KMS Keys please

2573

# see:

2574

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

2575

},

2576

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

2577

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

2578

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

2579

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2580

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2581

"status": "A String", # [Output only] The current status of this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2582

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2583

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

2584

# This makes same node pod to pod traffic visible for VPC network.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2585

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

2586

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

2587

# cluster is connected. Example:

2588

# projects/my-project/regions/us-central1/subnetworks/my-subnet

2589

"network": "A String", # Output only. The relative name of the Google Compute Engine

2590

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2591

# to which the cluster is connected. Example:

2592

# projects/my-project/global/networks/my-network

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2593

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules

2594

# will be disabled when default_snat_status is disabled. When disabled is set

2595

# to false, default IP masquerade rules will be applied to the nodes to

2596

# prevent sNAT on cluster internal traffic.

2597

# be disabled on the cluster.

2598

"disabled": True or False, # Disables cluster default sNAT rules.

2599

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2600

},

2601

"name": "A String", # The name of this cluster. The name must be unique within this project

2602

# and location (e.g. zone or region), and can be up to 40 characters with

2603

# the following restrictions:

2604

#

2605

# * Lowercase letters, numbers, and hyphens only.

2606

# * Must start with a letter.

2607

# * Must end with a number or a letter.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2608

"location": "A String", # [Output only] The name of the Google Compute Engine

2609

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2610

# or

2611

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2612

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2613

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

2614

# The endpoint can be accessed from the internet at

2615

# `https://username:password@endpoint/`.

2616

#

2617

# See the `masterAuth` property of this resource for username and

2618

# password information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2619

"createTime": "A String", # [Output only] The time the cluster was created, in

2620

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2621

"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]

2622

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2623

# notation (e.g. `10.96.0.0/14`). Leave blank to have

2624

# 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]

2625

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

2626

# required by Cluster Autoscaler to automatically adjust

2627

# the size of the cluster and create/delete

2628

# node pools based on the current needs.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2629

"autoprovisioningLocations": [ # The list of Google Compute Engine

2630

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2631

# NodePool's nodes can be created by NAP.

2632

"A String",

2633

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2634

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

2635

# amount of resources in the cluster.

2636

{ # Contains information about amount of some resource in the cluster.

2637

# For memory, value should be in GB.

2638

"maximum": "A String", # Maximum amount of the resource in the cluster.

2639

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

2640

"minimum": "A String", # Minimum amount of the resource in the cluster.

2641

},

2642

],

2643

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

2644

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

2645

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

2646

# created by NAP.

2647

# by NAP.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2648

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

2649

# service_account is specified, scopes should be empty.

2650

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

2651

# The instance may be scheduled on the specified or newer CPU platform.

2652

# Applicable values are the friendly names of CPU platforms, such as

2653

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2654

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2655

# information, read [how to specify min CPU

2656

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2657

# To unset the min cpu platform field pass "automatic" as field value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2658

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

2659

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2660

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2661

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2662

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2663

# the Auto Upgrades will proceed.

2664

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2665

# with the description of the upgrade.

2666

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2667

# with the approximate start time for the upgrades, in

2668

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2669

},

2670

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2671

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

2672

# specified, service_account should be empty.

2673

"A String",

2674

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2675

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

2676

# disruption caused by an upgrade.

2677

#

2678

# maxUnavailable controls the number of nodes that can be simultaneously

2679

# unavailable.

2680

#

2681

# maxSurge controls the number of additional nodes that can be added to the

2682

# node pool temporarily for the time of the upgrade to increase the number of

2683

# available nodes.

2684

#

2685

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2686

# nodes are being upgraded at the same time).

2687

#

2688

# Note: upgrades inevitably introduce some disruption since workloads need to

2689

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2690

# this holds true. (Disruption stays within the limits of

2691

# PodDisruptionBudget, if it is configured.)

2692

#

2693

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2694

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2695

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2696

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2697

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2698

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2699

# the upgrade process. A node is considered available if its status is

2700

# Ready.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2701

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2702

# of the node pool during the upgrade process.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2703

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2704

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2705

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2706

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

2707

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2708

# is sufficient for this number of instances. You must also have available

2709

# firewall and routes quota.

2710

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2711

# "node_pool" object, since this configuration (along with the

2712

# "node_config") will be used to create a "NodePool" object with an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2713

# auto-generated name. Do not use this and a node_pool at the same time.

2714

#

2715

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2716

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

2717

"A String",

2718

],

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]

2723

<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]

2724

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

2725

2726

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2727

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2728

number](https://support.google.com/cloud/answer/6158840).

2729

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2730

zone: string, Required. Deprecated. The name of the Google Compute Engine

2731

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

2732

cluster resides. This field has been deprecated and replaced by the name

2733

field. (required)

2734

clusterId: string, Required. Deprecated. The name of the cluster to update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2735

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2736

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2737

The object takes the form of:

2738

2739

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for

2740

# a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2741

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac.

2742

# Specified in the format `projects/*/locations/*/clusters/*`.

2743

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

2744

"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]

2745

# number](https://support.google.com/cloud/answer/6158840).

2746

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2747

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2748

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2749

# cluster resides. This field has been deprecated and replaced by the name

2750

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2751

"clusterId": "A String", # Required. Deprecated. The name of the cluster to update.

2752

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2753

}

2754

2755

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2762

2763

{ # This operation resource represents operations that may have happened or are

2764

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2765

"targetLink": "A String", # Server-defined URL for the target of the operation.

2766

"detail": "A String", # Detailed operation progress, if available.

2767

"operationType": "A String", # The operation type.

2768

"status": "A String", # The current status of the operation.

2769

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2770

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2771

{ # StatusCondition describes why a cluster or a node pool has a certain status

2772

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2773

"code": "A String", # Machine-friendly representation of the condition

2774

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2775

},

2776

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2777

"endTime": "A String", # [Output only] The time the operation completed, in

2778

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2779

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2780

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2781

# or

2782

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2783

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2784

"startTime": "A String", # [Output only] The time the operation started, in

2785

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2786

"clusterConditions": [ # Which conditions caused the current cluster state.

2787

{ # StatusCondition describes why a cluster or a node pool has a certain status

2788

# (e.g., ERROR or DEGRADED).

2789

"code": "A String", # Machine-friendly representation of the condition

2790

"message": "A String", # Human-friendly representation of the condition

2791

},

2792

],

2793

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2794

"metrics": [ # Progress metric bundle, for example:

2795

# metrics: [{name: "nodes done", int_value: 15},

2796

# {name: "nodes total", int_value: 32}]

2797

# or

2798

# metrics: [{name: "progress", double_value: 0.56},

2799

# {name: "progress scale", double_value: 1.0}]

2800

{ # Progress metric is (string, int|float|string) pair.

2801

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2802

"doubleValue": 3.14, # For metrics with floating point value.

2803

"intValue": "A String", # For metrics with integer value.

2804

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2805

},

2806

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2807

"status": "A String", # Status of an operation stage.

2808

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2809

"name": "A String", # A non-parameterized string describing an operation stage.

2810

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2811

"stages": [ # Substages of an operation or a stage.

2812

# Object with schema name: OperationProgress

2813

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2814

},

2815

"zone": "A String", # The name of the Google Compute Engine

2816

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2817

# operation is taking place. This field is deprecated, use location instead.

2818

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

2819

"selfLink": "A String", # Server-defined URL for the resource.

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>

2825

<pre>Lists all clusters owned by a project in either the specified zone or all

2826

zones.

2827

2828

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2829

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2830

number](https://support.google.com/cloud/answer/6158840).

2831

This field has been deprecated and replaced by the parent field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2832

zone: string, Required. Deprecated. The name of the Google Compute Engine

2833

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2834

cluster resides, or "-" for all zones. This field has been deprecated and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2835

replaced by the parent field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2836

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]

2837

Specified in the format `projects/*/locations/*`.

2838

Location "-" matches all zones and all regions.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2839

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2846

2847

{ # ListClustersResponse is the result of ListClustersRequest.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2848

"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]

2849

# across all ones.

2850

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2851

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

2852

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

2853

# range will be used for assigning internal IP addresses to the master or

2854

# set of masters, as well as the ILB VIP. This range must not overlap with

2855

# any other ranges in use within the cluster's network.

2856

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

2857

# given only RFC 1918 private addresses and communicate with the master via

2858

# private networking.

2859

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

2860

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

2861

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

2862

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

2863

"enabled": True or False, # Whenever master is accessible globally or not.

2864

},

2865

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

2866

},

2867

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

2868

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

2869

},

2870

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

2871

# required by Vertical Pod Autoscaler to automatically adjust

2872

# the resources of pods controlled by it.

2873

"enabled": True or False, # Enables vertical pod autoscaling.

2874

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2875

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

2876

# simultaneously on a node in the node pool of this cluster. Only honored

2877

# if cluster created with IP Alias support.

2878

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2879

},

2880

"network": "A String", # The name of the Google Compute Engine

2881

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2882

# to which the cluster is connected. If left unspecified, the `default`

2883

# network will be used. On output this shows the network ID instead of the

2884

# name.

2885

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

2886

"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]

2887

# containers. This is provisioned from within the `container_ipv4_cidr`

2888

# range. This field will only be set when cluster is in route-based network

2889

# mode.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2890

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

2891

# master authorized networks will disallow all external traffic to access

2892

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

2893

# Google Compute Engine Public IPs and Google Prod IPs.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2894

"enabled": True or False, # Whether or not master authorized networks is enabled.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2895

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

2896

# Kubernetes master through HTTPS.

2897

{ # CidrBlock contains an optional name and one CIDR block.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2898

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2899

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2900

},

2901

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2902

},

2903

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2904

# cluster, if available.

2905

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

2906

# If unspecified, the defaults are used:

2907

# For clusters before v1.12, if master_auth is unspecified, `username` will

2908

# be set to "admin", a random password will be generated, and a client

2909

# certificate will be issued.

2910

# Authentication can be done using HTTP basic auth or using client

2911

# certificates.

2912

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

2913

# Because the master endpoint is open to the Internet, you should create a

2914

# strong password. If a password is provided for cluster creation, username

2915

# must be non-empty.

2916

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

2917

# clusters before v1.12, if no configuration is specified, a client

2918

# certificate is issued.

2919

"issueClientCertificate": True or False, # Issue a client certificate.

2920

},

2921

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

2922

# to the cluster endpoint.

2923

"clusterCaCertificate": "A String",

2924

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

2925

# authenticate to the cluster endpoint.

2926

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

2927

# For clusters v1.6.0 and later, basic authentication can be disabled by

2928

# leaving username unspecified (or setting it to the empty string).

2929

},

2930

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2931

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

2932

# if enabled = true.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2933

"enabled": True or False, # Whether this cluster should return group membership lookups

2934

# during authentication using a group of security groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2935

},

2936

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network.

2937

# This prefix will be used for assigning private IP addresses to the

2938

# master or set of masters, as well as the ILB VIP.

2939

# This field is deprecated, use

2940

# private_cluster_config.master_ipv4_cidr_block instead.

2941

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

2942

"type": "A String", # Type of the integration.

2943

},

2944

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2945

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

2946

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

2947

# must be valid under a PodSecurityPolicy to be created.

2948

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2949

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

2950

# cluster, enabling additional functionality.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2951

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

2952

# makes it easy to set up HTTP load balancers for services in a cluster.

2953

# which makes it easy to set up HTTP load balancers for services in a cluster.

2954

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

2955

# When enabled, it runs a small pod in the cluster that manages the load

2956

# balancers.

2957

},

2958

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

2959

# This addon is deprecated, and will be disabled in 1.15. It is recommended

2960

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

2961

# workloads and applications. For more information, see:

2962

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

2963

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

2964

},

2965

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

2966

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

2967

},

2968

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

2969

# applications.

2970

"enabled": True or False, # Whether KALM is enabled for this cluster.

2971

},

2972

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

2973

# enabled at cluster creation time.

2974

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

2975

},

2976

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

2977

# microservices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2978

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2979

"disabled": True or False, # Whether Istio is enabled for this cluster.

2980

},

2981

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

2982

# is enabled or not on the Master, it does not track whether network policy

2983

# is enabled for the nodes.

2984

# is enabled or not on the Master, it does not track whether network policy

2985

# is enabled for the nodes.

2986

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

2987

},

2988

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

2989

# enabled in order to enable Cloud Run addon. This option can only be enabled

2990

# at cluster creation time.

2991

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2992

},

2993

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

2994

# extension to manage hosted GCP services through the Kubernetes API

2995

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

2996

},

2997

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

2998

# increases or decreases the number of replica pods a replication controller

2999

# has based on the resource usage of the existing pods.

3000

# increases or decreases the number of replica pods a replication controller

3001

# has based on the resource usage of the existing pods.

3002

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

3003

# When enabled, it ensures that metrics are collected into Stackdriver

3004

# Monitoring.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3005

},

3006

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3007

"subnetwork": "A String", # The name of the Google Compute Engine

3008

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

3009

# the cluster is connected. On output this shows the subnetwork ID instead of

3010

# the name.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3011

"currentNodeVersion": "A String", # [Output only] Deprecated, use

3012

# [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools)

3013

# instead. The current version of the node software components.

3014

# If they are currently at multiple versions because they're in the process

3015

# of being upgraded, this reflects the minimum version of all nodes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3016

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3017

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3018

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

3019

# occur in these windows.

3020

"a_key": { # Represents an arbitrary window of time.

3021

"startTime": "A String", # The time that the window first starts.

3022

"endTime": "A String", # The time that the window ends. The end time should take place after the

3023

# start time.

3024

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3025

},

3026

"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]

3027

# maintenance to occur. The time windows may be overlapping. If no

3028

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3029

"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]

3030

# this window reccurs. They go on for the span of time between the start and

3031

# end time.

3032

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3033

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3034

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

3035

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

3036

# <code>FREQ=DAILY</code>

3037

# For the first weekend of every month:

3038

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

3039

# 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]

3040

# 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]

3041

# <code>

3042

# start time = 2019-01-01T09:00:00-0400

3043

# end time = 2019-01-01T17:00:00-0400

3044

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

3045

# </code>

3046

# Windows can span multiple days. Eg, to make the window encompass every

3047

# weekend from midnight Saturday till the last minute of Sunday UTC:

3048

# <code>

3049

# start time = 2019-01-05T00:00:00Z

3050

# end time = 2019-01-07T23:59:00Z

3051

# recurrence = FREQ=WEEKLY;BYDAY=SA

3052

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3053

# 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]

3054

# to specify duration of the window and when it first starts.

3055

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3056

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3057

"startTime": "A String", # The time that the window first starts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3058

"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]

3059

# start time.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3060

},

3061

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3062

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

3063

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

3064

# smallest possible in the given scenario.

3065

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

3066

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3067

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3068

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3069

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

3070

# the policy won't accidentally undo intermediate changes (and so that users

3071

# of the API unaware of some fields won't accidentally remove other fields).

3072

# Make a <code>get()</code> request to the cluster to get the current

3073

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3074

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3075

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

3076

# Google Compute Engine resources.

3077

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3078

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3079

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

3080

# found in validMasterVersions returned by getServerConfig. The version can

3081

# be upgraded over time; such upgrades are reflected in

3082

# currentMasterVersion and currentNodeVersion.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3083

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3084

# Users may specify either explicit versions offered by

3085

# Kubernetes Engine or version aliases, which have the following behavior:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3086

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3087

# - "latest": picks the highest valid Kubernetes version

3088

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

3089

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

3090

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

3091

# - "","-": picks the default Kubernetes version

3092

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

3093

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster.

3094

# This is used in conjunction with use_ip_aliases. It cannot be true if

3095

# use_ip_aliases is true. If both use_ip_aliases and use_routes are false,

3096

# then the server picks the default IP allocation mode

3097

"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]

3098

# will be automatically chosen with the default size.

3099

#

3100

# This field is only applicable when `use_ip_aliases` is true.

3101

#

3102

# Set to blank to have a range chosen with the default size.

3103

#

3104

# 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)

3109

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3110

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3111

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3112

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain

3113

# kinds of network routes. By default we do not allow cluster CIDR ranges to

3114

# intersect with any user declared routes. With allow_route_overlap == true,

3115

# we allow overlapping with CIDR ranges that are larger than the cluster CIDR

3116

# range.

3117

#

3118

# If this field is set to true, then cluster and services CIDRs must be

3119

# fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:

3120

# 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and

3121

# `services_ipv4_cidr_block` must be fully-specified.

3122

# 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be

3123

# fully-specified.

3124

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

3125

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

3126

# `cluster.cluster_ipv4_cidr` must be left blank.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3127

#

3128

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3129

#

3130

# Set to blank to have a range chosen with the default size.

3131

#

3132

# 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)

3137

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3138

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3139

# to use.

3140

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

3141

# block. The secondary range will be used for pod IP

3142

# addresses. This must be an existing secondary range associated

3143

# with the cluster subnetwork.

3144

#

3145

# This field is only applicable with use_ip_aliases and

3146

# create_subnetwork is false.

3147

"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]

3148

#

3149

# This is applicable only if `create_subnetwork` is true.

3150

#

3151

# Set to blank to have a range chosen with the default size.

3152

#

3153

# 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)

3158

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3159

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3160

# to use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3161

"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]

3162

# range will be automatically chosen with the default size.

3163

#

3164

# This field is only applicable when `use_ip_aliases` is true.

3165

#

3166

# If unspecified, the range will use the default size.

3167

#

3168

# 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)

3173

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

3174

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

3175

# to use.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3176

# This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3177

"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]

3178

# CIDR block. The secondary range will be used for service

3179

# ClusterIPs. This must be an existing secondary range associated

3180

# with the cluster subnetwork.

3181

#

3182

# This field is only applicable with use_ip_aliases and

3183

# create_subnetwork is false.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3184

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

3185

#

3186

# This field is only applicable when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3187

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

3188

# This is used in conjunction with use_routes. It cannot

3189

# be true if use_routes is true. If both use_ip_aliases and use_routes are

3190

# false, then the server picks the default IP allocation mode

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3191

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

3192

# this field is empty, then an automatic name will be chosen for the new

3193

# subnetwork.

3194

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

3195

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3196

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3197

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

3198

# mode.

3199

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

3200

# identities in the system, including service accounts, nodes, and

3201

# controllers, will have statically granted permissions beyond those

3202

# provided by the RBAC configuration or IAM.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3203

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3204

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

3205

# disabled when this config unspecified.

3206

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

3207

# daemonset will be created in the cluster to meter network egress traffic.

3208

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

3209

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

3210

# second BigQuery table will be created to hold resource consumption

3211

# records.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3212

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3213

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

3214

"datasetId": "A String", # The ID of a BigQuery Dataset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3215

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3216

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3217

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

3218

# This field is deprecated, use tpu_config.enabled instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3219

"nodePools": [ # The node pools associated with this cluster.

3220

# 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]

3221

# specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3222

{ # NodePool contains the name and configuration for a cluster's node pool.

3223

# 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]

3224

# specification, under the control of the cluster master. They may have a set

3225

# of Kubernetes labels applied to them, which may be used to reference them

3226

# during pod scheduling. They may also be resized up or down, to accommodate

3227

# the workload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3228

"status": "A String", # [Output only] The status of the nodes in this pool instance.

3229

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3230

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3231

# scheduled on the specified or newer CPU platform. Applicable values are the

3232

# friendly names of CPU platforms, such as

3233

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3234

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3235

# information, read [how to specify min CPU

3236

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3237

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3238

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3239

#

3240

# Enables monitoring and attestation of the boot integrity of the instance.

3241

# The attestation is performed against the integrity policy baseline. This

3242

# baseline is initially derived from the implicitly trusted boot image when

3243

# the instance is created.

3244

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3245

#

3246

# Secure Boot helps ensure that the system only runs authentic software by

3247

# verifying the digital signature of all boot components, and halting the

3248

# boot process if signature verification fails.

3249

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3250

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3251

# https://cloud.google.com/compute/docs/instances/preemptible for more

3252

# inforamtion about preemptible VM instances.

3253

"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]

3254

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3255

# The limit for this value is dependent upon the maximum number of

3256

# disks available on a machine per zone. See:

3257

# https://cloud.google.com/compute/docs/disks/local-ssd

3258

# for more information.

3259

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3260

"type": "A String", # Type of the sandbox to use for the node.

3261

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

3262

},

3263

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3264

#

3265

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3266

# in length. These are reflected as part of a URL in the metadata server.

3267

# Additionally, to avoid ambiguity, keys must not conflict with any other

3268

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3274

# "enable-oslogin"

3275

# "gci-ensure-gke-docker"

3276

# "gci-metrics-enabled"

3277

# "gci-update-strategy"

3278

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3283

# "windows-startup-script-ps1"

3284

# "common-psm1"

3285

# "k8s-node-setup-psm1"

3286

# "install-ssh-psm1"

3287

# "user-profile-psm1"

3288

# "serial-port-logging-enable"

3289

# Values are free-form strings, and only have meaning as interpreted by

3290

# the image running in the instance. The only restriction placed on them is

3291

# that each value's size must be less than or equal to 32 KB.

3292

#

3293

# The total size of all keys and values must be less than 512 KB.

3294

"a_key": "A String",

3295

},

3296

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3297

# the specified [Zonal Compute

3298

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3299

# to this node pool.

3300

# is the configuration of desired reservation which instances could take

3301

# capacity from.

3302

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3303

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3304

# the key and specify the name of your reservation as its value.

3305

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3306

"A String",

3307

],

3308

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3309

},

3310

"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]

3311

# valid sources or targets for network firewalls and are specified by

3312

# the client during cluster or node pool creation. Each tag within the list

3313

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3314

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3315

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3316

"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]

3317

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3318

# Account is specified, the "default" service account is used.

3319

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3320

# the latest version of it will be used.

3321

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3322

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3323

#

3324

# The following scopes are recommended, but not required, and by default are

3325

# not included:

3326

#

3327

# * `https://www.googleapis.com/auth/compute` is required for mounting

3328

# persistent storage on your nodes.

3329

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3330

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3331

# (the [Google Container

3332

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3333

#

3334

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3335

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3336

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3337

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3338

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3339

#

3340

# For more information, including usage and the valid values, see:

3341

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3342

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3343

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3344

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3345

# See

3346

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3347

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3348

"effect": "A String", # Effect for taint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3349

"value": "A String", # Value for taint.

3350

"key": "A String", # Key for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3351

},

3352

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3353

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3354

# These will added in addition to any default label(s) that

3355

# Kubernetes may apply to the node.

3356

# In case of conflict in label keys, the applied set may differ depending on

3357

# the Kubernetes version -- it's best to assume the behavior is undefined

3358

# and conflicts should be avoided.

3359

# For more information, including usage and the valid values, see:

3360

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3361

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3362

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3363

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3364

# The smallest allowed disk size is 10GB.

3365

#

3366

# If unspecified, the default disk size is 100GB.

3367

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3368

# workloads on the node pool.

3369

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

3370

# workloads running on the node.

3371

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3372

# on the node pool.

3373

},

3374

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3375

# See https://cloud.google.com/compute/docs/gpus for more information about

3376

# support for GPUs.

3377

{ # AcceleratorConfig represents a Hardware Accelerator request.

3378

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3379

# [here](https://cloud.google.com/compute/docs/gpus)

3380

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3381

},

3382

],

3383

"machineType": "A String", # The name of a Google Compute Engine [machine

3384

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3385

# `n1-standard-1`).

3386

#

3387

# If unspecified, the default machine type is

3388

# `n1-standard-1`.

3389

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3390

#

3391

# If unspecified, the default disk type is 'pd-standard'

3392

"bootDiskKmsKey": "A String", #

3393

# The Customer Managed Encryption Key used to encrypt the boot disk attached

3394

# to each node in the node pool. This should be of the form

3395

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

3396

# For more information about protecting resources with Cloud KMS Keys please

3397

# see:

3398

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3399

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3400

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

3401

# simultaneously on a node in the node pool.

3402

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

3403

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3404

"name": "A String", # The name of the node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3405

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

3406

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3407

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3408

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3409

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3410

# the Auto Upgrades will proceed.

3411

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3412

# with the description of the upgrade.

3413

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3414

# with the approximate start time for the upgrades, in

3415

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3416

},

3417

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3418

"statusMessage": "A String", # [Output only] Additional information about the current status of this

3419

# node pool instance, if available.

3420

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

3421

# only if a valid configuration is present.

3422

# adjust the size of the node pool to the current cluster usage.

3423

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

3424

# has to enough quota to scale up the cluster.

3425

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

3426

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

3427

# max_node_count.

3428

"enabled": True or False, # Is autoscaling enabled for this node pool.

3429

},

3430

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

3431

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

3432

# is sufficient for this number of instances. You must also have available

3433

# firewall and routes quota.

3434

"locations": [ # The list of Google Compute Engine

3435

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3436

# NodePool's nodes should be located.

3437

"A String",

3438

],

3439

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

3440

# disruption caused by an upgrade.

3441

#

3442

# maxUnavailable controls the number of nodes that can be simultaneously

3443

# unavailable.

3444

#

3445

# maxSurge controls the number of additional nodes that can be added to the

3446

# node pool temporarily for the time of the upgrade to increase the number of

3447

# available nodes.

3448

#

3449

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3450

# nodes are being upgraded at the same time).

3451

#

3452

# Note: upgrades inevitably introduce some disruption since workloads need to

3453

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3454

# this holds true. (Disruption stays within the limits of

3455

# PodDisruptionBudget, if it is configured.)

3456

#

3457

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3458

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3459

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3460

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3461

# there are always at least 4 nodes available.

3462

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3463

# the upgrade process. A node is considered available if its status is

3464

# Ready.

3465

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3466

# of the node pool during the upgrade process.

3467

},

3468

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

3469

"version": "A String", # The version of the Kubernetes of this node.

3470

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

3471

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

3472

# associated with this node pool.

3473

"A String",

3474

],

3475

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

3476

"conditions": [ # Which conditions caused the current node pool state.

3477

{ # StatusCondition describes why a cluster or a node pool has a certain status

3478

# (e.g., ERROR or DEGRADED).

3479

"code": "A String", # Machine-friendly representation of the condition

3480

"message": "A String", # Human-friendly representation of the condition

3481

},

3482

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3483

},

3484

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3485

"locations": [ # The list of Google Compute Engine

3486

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3487

# cluster's nodes should be located.

3488

"A String",

3489

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3490

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3491

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

3492

# subscribed to. Release channels are arranged in order of risk and

3493

# frequency of updates.

3494

#

3495

# When a cluster is subscribed to a release channel, Google maintains

3496

# both the master version and the node version. Node auto-upgrade

3497

# defaults to true and cannot be disabled. Updates to version related

3498

# fields (e.g. current_master_version) return an error.

3499

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

3500

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3501

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

3502

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

3503

"provider": "A String", # The selected network policy provider.

3504

"enabled": True or False, # Whether network policy is enabled on the cluster.

3505

},

3506

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

3507

# this cluster, in

3508

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3509

# notation (e.g. `1.2.3.4/29`). Service addresses are

3510

# typically put in the last `/16` from the container CIDR.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3511

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

3512

# API groups (e.g. v1beta1) and features that may not be production ready in

3513

# the kubernetes version of the master and nodes.

3514

# The cluster has no SLA for uptime and master/node upgrades are disabled.

3515

# Alpha enabled clusters are automatically deleted thirty days after

3516

# creation.

3517

"description": "A String", # An optional description of this cluster.

3518

"conditions": [ # Which conditions caused the current cluster state.

3519

{ # StatusCondition describes why a cluster or a node pool has a certain status

3520

# (e.g., ERROR or DEGRADED).

3521

"code": "A String", # Machine-friendly representation of the condition

3522

"message": "A String", # Human-friendly representation of the condition

3523

},

3524

],

3525

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by

3526

# default have no external IP addresses on the nodes and where nodes and the

3527

# master communicate over private IP addresses.

3528

# This field is deprecated, use private_cluster_config.enable_private_nodes

3529

# instead.

3530

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

3531

# Call Kubernetes API directly to retrieve node information.

3532

"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]

3533

# Currently available options:

3534

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3535

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3536

# service with a Kubernetes-native resource model

3537

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

3538

# longer available as of GKE 1.15).

3539

# * `none` - No metrics will be exported from the cluster.

3540

#

3541

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

3542

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3543

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

3544

"state": "A String", # Denotes the state of etcd encryption.

3545

"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]

3546

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3547

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3548

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

3549

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

3550

# images will be validated by Google Binauthz.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3551

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3552

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

3553

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3554

# notation (e.g. `1.2.3.4/29`).

3555

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

3556

# policies.

3557

# policies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3558

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3559

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3560

},

3561

"zone": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3562

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3563

# cluster resides. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3564

"loggingService": "A String", # The logging service the cluster should use to write logs.

3565

# Currently available options:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3566

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3567

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

3568

# service with a Kubernetes-native resource model

3569

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

3570

# available as of GKE 1.15).

3571

# * `none` - no logs will be exported from the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3572

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3573

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

3574

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

3575

"expireTime": "A String", # [Output only] The time the cluster will be automatically

3576

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3577

"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]

3578

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3579

# "node_pool" object, since this configuration (along with the

3580

# "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]

3581

# auto-generated name. Do not use this and a node_pool at the same time.

3582

# For responses, this field will be populated with the node configuration of

3583

# the first node pool. (For configuration of each node pool, see

3584

# `node_pool.config`)

3585

#

3586

# If unspecified, the defaults are used.

3587

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3588

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3589

# scheduled on the specified or newer CPU platform. Applicable values are the

3590

# friendly names of CPU platforms, such as

3591

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3592

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3593

# information, read [how to specify min CPU

3594

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3595

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3596

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3597

#

3598

# Enables monitoring and attestation of the boot integrity of the instance.

3599

# The attestation is performed against the integrity policy baseline. This

3600

# baseline is initially derived from the implicitly trusted boot image when

3601

# the instance is created.

3602

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3603

#

3604

# Secure Boot helps ensure that the system only runs authentic software by

3605

# verifying the digital signature of all boot components, and halting the

3606

# boot process if signature verification fails.

3607

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3608

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3609

# https://cloud.google.com/compute/docs/instances/preemptible for more

3610

# inforamtion about preemptible VM instances.

3611

"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]

3612

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3613

# The limit for this value is dependent upon the maximum number of

3614

# disks available on a machine per zone. See:

3615

# https://cloud.google.com/compute/docs/disks/local-ssd

3616

# for more information.

3617

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3618

"type": "A String", # Type of the sandbox to use for the node.

3619

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

3620

},

3621

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3622

#

3623

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3624

# in length. These are reflected as part of a URL in the metadata server.

3625

# Additionally, to avoid ambiguity, keys must not conflict with any other

3626

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3632

# "enable-oslogin"

3633

# "gci-ensure-gke-docker"

3634

# "gci-metrics-enabled"

3635

# "gci-update-strategy"

3636

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3641

# "windows-startup-script-ps1"

3642

# "common-psm1"

3643

# "k8s-node-setup-psm1"

3644

# "install-ssh-psm1"

3645

# "user-profile-psm1"

3646

# "serial-port-logging-enable"

3647

# Values are free-form strings, and only have meaning as interpreted by

3648

# the image running in the instance. The only restriction placed on them is

3649

# that each value's size must be less than or equal to 32 KB.

3650

#

3651

# The total size of all keys and values must be less than 512 KB.

3652

"a_key": "A String",

3653

},

3654

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3655

# the specified [Zonal Compute

3656

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3657

# to this node pool.

3658

# is the configuration of desired reservation which instances could take

3659

# capacity from.

3660

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3661

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3662

# the key and specify the name of your reservation as its value.

3663

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3664

"A String",

3665

],

3666

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3667

},

3668

"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]

3669

# valid sources or targets for network firewalls and are specified by

3670

# the client during cluster or node pool creation. Each tag within the list

3671

# must comply with RFC1035.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3672

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3673

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3674

"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]

3675

# Specify the email address of the Service Account; otherwise, if no Service

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3676

# Account is specified, the "default" service account is used.

3677

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3678

# the latest version of it will be used.

3679

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3680

# node VMs under the "default" service account.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3681

#

3682

# The following scopes are recommended, but not required, and by default are

3683

# not included:

3684

#

3685

# * `https://www.googleapis.com/auth/compute` is required for mounting

3686

# persistent storage on your nodes.

3687

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3688

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3689

# (the [Google Container

3690

# Registry](https://cloud.google.com/container-registry/)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3691

#

3692

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3693

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3694

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3695

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3696

"taints": [ # List of kubernetes taints to be applied to each node.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3697

#

3698

# For more information, including usage and the valid values, see:

3699

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3700

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3701

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3702

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3703

# See

3704

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3705

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3706

"effect": "A String", # Effect for taint.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3707

"value": "A String", # Value for taint.

3708

"key": "A String", # Key for taint.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3709

},

3710

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3711

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3712

# These will added in addition to any default label(s) that

3713

# Kubernetes may apply to the node.

3714

# In case of conflict in label keys, the applied set may differ depending on

3715

# the Kubernetes version -- it's best to assume the behavior is undefined

3716

# and conflicts should be avoided.

3717

# For more information, including usage and the valid values, see:

3718

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3719

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3720

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3721

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3722

# The smallest allowed disk size is 10GB.

3723

#

3724

# If unspecified, the default disk size is 100GB.

3725

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3726

# workloads on the node pool.

3727

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the

3728

# workloads running on the node.

3729

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3730

# on the node pool.

3731

},

3732

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3733

# See https://cloud.google.com/compute/docs/gpus for more information about

3734

# support for GPUs.

3735

{ # AcceleratorConfig represents a Hardware Accelerator request.

3736

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3737

# [here](https://cloud.google.com/compute/docs/gpus)

3738

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3739

},

3740

],

3741

"machineType": "A String", # The name of a Google Compute Engine [machine

3742

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3743

# `n1-standard-1`).

3744

#

3745

# If unspecified, the default machine type is

3746

# `n1-standard-1`.

3747

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3748

#

3749

# If unspecified, the default disk type is 'pd-standard'

3750

"bootDiskKmsKey": "A String", #

3751

# The Customer Managed Encryption Key used to encrypt the boot disk attached

3752

# to each node in the node pool. This should be of the form

3753

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

3754

# For more information about protecting resources with Cloud KMS Keys please

3755

# see:

3756

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

3757

},

3758

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

3759

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

3760

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

3761

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3762

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3763

"status": "A String", # [Output only] The current status of this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3764

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3765

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

3766

# This makes same node pod to pod traffic visible for VPC network.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3767

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

3768

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

3769

# cluster is connected. Example:

3770

# projects/my-project/regions/us-central1/subnetworks/my-subnet

3771

"network": "A String", # Output only. The relative name of the Google Compute Engine

3772

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

3773

# to which the cluster is connected. Example:

3774

# projects/my-project/global/networks/my-network

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3775

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules

3776

# will be disabled when default_snat_status is disabled. When disabled is set

3777

# to false, default IP masquerade rules will be applied to the nodes to

3778

# prevent sNAT on cluster internal traffic.

3779

# be disabled on the cluster.

3780

"disabled": True or False, # Disables cluster default sNAT rules.

3781

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3782

},

3783

"name": "A String", # The name of this cluster. The name must be unique within this project

3784

# and location (e.g. zone or region), and can be up to 40 characters with

3785

# the following restrictions:

3786

#

3787

# * Lowercase letters, numbers, and hyphens only.

3788

# * Must start with a letter.

3789

# * Must end with a number or a letter.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3790

"location": "A String", # [Output only] The name of the Google Compute Engine

3791

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3792

# or

3793

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3794

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3795

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

3796

# The endpoint can be accessed from the internet at

3797

# `https://username:password@endpoint/`.

3798

#

3799

# See the `masterAuth` property of this resource for username and

3800

# password information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3801

"createTime": "A String", # [Output only] The time the cluster was created, in

3802

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3803

"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]

3804

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3805

# notation (e.g. `10.96.0.0/14`). Leave blank to have

3806

# 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]

3807

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

3808

# required by Cluster Autoscaler to automatically adjust

3809

# the size of the cluster and create/delete

3810

# node pools based on the current needs.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3811

"autoprovisioningLocations": [ # The list of Google Compute Engine

3812

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3813

# NodePool's nodes can be created by NAP.

3814

"A String",

3815

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3816

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

3817

# amount of resources in the cluster.

3818

{ # Contains information about amount of some resource in the cluster.

3819

# For memory, value should be in GB.

3820

"maximum": "A String", # Maximum amount of the resource in the cluster.

3821

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

3822

"minimum": "A String", # Minimum amount of the resource in the cluster.

3823

},

3824

],

3825

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

3826

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

3827

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

3828

# created by NAP.

3829

# by NAP.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3830

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

3831

# service_account is specified, scopes should be empty.

3832

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

3833

# The instance may be scheduled on the specified or newer CPU platform.

3834

# Applicable values are the friendly names of CPU platforms, such as

3835

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3836

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3837

# information, read [how to specify min CPU

3838

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3839

# To unset the min cpu platform field pass "automatic" as field value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3840

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

3841

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3842

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3843

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3844

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3845

# the Auto Upgrades will proceed.

3846

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3847

# with the description of the upgrade.

3848

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3849

# with the approximate start time for the upgrades, in

3850

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3851

},

3852

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3853

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

3854

# specified, service_account should be empty.

3855

"A String",

3856

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3857

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

3858

# disruption caused by an upgrade.

3859

#

3860

# maxUnavailable controls the number of nodes that can be simultaneously

3861

# unavailable.

3862

#

3863

# maxSurge controls the number of additional nodes that can be added to the

3864

# node pool temporarily for the time of the upgrade to increase the number of

3865

# available nodes.

3866

#

3867

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3868

# nodes are being upgraded at the same time).

3869

#

3870

# Note: upgrades inevitably introduce some disruption since workloads need to

3871

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3872

# this holds true. (Disruption stays within the limits of

3873

# PodDisruptionBudget, if it is configured.)

3874

#

3875

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3876

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3877

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3878

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3879

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3880

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3881

# the upgrade process. A node is considered available if its status is

3882

# Ready.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3883

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3884

# of the node pool during the upgrade process.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3885

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3886

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3887

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3888

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

3889

# Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3890

# is sufficient for this number of instances. You must also have available

3891

# firewall and routes quota.

3892

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3893

# "node_pool" object, since this configuration (along with the

3894

# "node_config") will be used to create a "NodePool" object with an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3895

# auto-generated name. Do not use this and a node_pool at the same time.

3896

#

3897

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3898

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

3899

"A String",

3900

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3901

},

3902

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3903

"missingZones": [ # If any zones are listed here, the list of clusters returned

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3904

# may be missing those zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3905

"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]

3911

<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]

3912

<pre>Sets the locations for a specific cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3913

Deprecated. Use

3914

[projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update)

3915

instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3916

3917

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3918

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3919

number](https://support.google.com/cloud/answer/6158840).

3920

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3921

zone: string, Required. Deprecated. The name of the Google Compute Engine

3922

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

3923

cluster resides. This field has been deprecated and replaced by the name

3924

field. (required)

3925

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3926

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3927

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3928

The object takes the form of:

3929

3930

{ # SetLocationsRequest sets the locations of the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3931

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

3932

# This field has been deprecated and replaced by the name field.

3933

"name": "A String", # The name (project, location, cluster) of the cluster to set locations.

3934

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3935

"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]

3936

# number](https://support.google.com/cloud/answer/6158840).

3937

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3938

"locations": [ # Required. The desired list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3939

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3940

# 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]

3941

# will result in nodes being either created or removed from the cluster,

3942

# depending on whether locations are being added or removed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3943

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3944

# This list must always include the cluster's primary zone.

3945

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3946

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3947

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

3948

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3949

# cluster resides. This field has been deprecated and replaced by the name

3950

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3951

}

3952

3953

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3960

3961

{ # This operation resource represents operations that may have happened or are

3962

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3963

"targetLink": "A String", # Server-defined URL for the target of the operation.

3964

"detail": "A String", # Detailed operation progress, if available.

3965

"operationType": "A String", # The operation type.

3966

"status": "A String", # The current status of the operation.

3967

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3968

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3969

{ # StatusCondition describes why a cluster or a node pool has a certain status

3970

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3971

"code": "A String", # Machine-friendly representation of the condition

3972

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3973

},

3974

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3975

"endTime": "A String", # [Output only] The time the operation completed, in

3976

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3977

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3978

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3979

# or

3980

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3981

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3982

"startTime": "A String", # [Output only] The time the operation started, in

3983

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3984

"clusterConditions": [ # Which conditions caused the current cluster state.

3985

{ # StatusCondition describes why a cluster or a node pool has a certain status

3986

# (e.g., ERROR or DEGRADED).

3987

"code": "A String", # Machine-friendly representation of the condition

3988

"message": "A String", # Human-friendly representation of the condition

3989

},

3990

],

3991

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3992

"metrics": [ # Progress metric bundle, for example:

3993

# metrics: [{name: "nodes done", int_value: 15},

3994

# {name: "nodes total", int_value: 32}]

3995

# or

3996

# metrics: [{name: "progress", double_value: 0.56},

3997

# {name: "progress scale", double_value: 1.0}]

3998

{ # Progress metric is (string, int|float|string) pair.

3999

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4000

"doubleValue": 3.14, # For metrics with floating point value.

4001

"intValue": "A String", # For metrics with integer value.

4002

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4003

},

4004

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4005

"status": "A String", # Status of an operation stage.

4006

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4007

"name": "A String", # A non-parameterized string describing an operation stage.

4008

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4009

"stages": [ # Substages of an operation or a stage.

4010

# Object with schema name: OperationProgress

4011

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4012

},

4013

"zone": "A String", # The name of the Google Compute Engine

4014

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4015

# operation is taking place. This field is deprecated, use location instead.

4016

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4017

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4022

<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]

4023

<pre>Sets the logging service for a specific cluster.

4024

4025

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4026

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4027

number](https://support.google.com/cloud/answer/6158840).

4028

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4029

zone: string, Required. Deprecated. The name of the Google Compute Engine

4030

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4031

cluster resides. This field has been deprecated and replaced by the name

4032

field. (required)

4033

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4034

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4035

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4036

The object takes the form of:

4037

4038

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4039

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

4040

# number](https://support.google.com/cloud/answer/6158840).

4041

# This field has been deprecated and replaced by the name field.

4042

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4043

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4044

# cluster resides. This field has been deprecated and replaced by the name

4045

# field.

4046

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

4047

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4048

"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]

4049

# Currently available options:

4050

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4051

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

4052

# service with a Kubernetes-native resource model

4053

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

4054

# available as of GKE 1.15).

4055

# * `none` - no logs will be exported from the cluster.

4056

#

4057

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

4058

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4059

"name": "A String", # The name (project, location, cluster) of the cluster to set logging.

4060

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4061

}

4062

4063

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4070

4071

{ # This operation resource represents operations that may have happened or are

4072

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4073

"targetLink": "A String", # Server-defined URL for the target of the operation.

4074

"detail": "A String", # Detailed operation progress, if available.

4075

"operationType": "A String", # The operation type.

4076

"status": "A String", # The current status of the operation.

4077

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4078

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4079

{ # StatusCondition describes why a cluster or a node pool has a certain status

4080

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4081

"code": "A String", # Machine-friendly representation of the condition

4082

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4083

},

4084

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4085

"endTime": "A String", # [Output only] The time the operation completed, in

4086

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4087

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4088

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4089

# or

4090

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4091

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4092

"startTime": "A String", # [Output only] The time the operation started, in

4093

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4094

"clusterConditions": [ # Which conditions caused the current cluster state.

4095

{ # StatusCondition describes why a cluster or a node pool has a certain status

4096

# (e.g., ERROR or DEGRADED).

4097

"code": "A String", # Machine-friendly representation of the condition

4098

"message": "A String", # Human-friendly representation of the condition

4099

},

4100

],

4101

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4102

"metrics": [ # Progress metric bundle, for example:

4103

# metrics: [{name: "nodes done", int_value: 15},

4104

# {name: "nodes total", int_value: 32}]

4105

# or

4106

# metrics: [{name: "progress", double_value: 0.56},

4107

# {name: "progress scale", double_value: 1.0}]

4108

{ # Progress metric is (string, int|float|string) pair.

4109

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4110

"doubleValue": 3.14, # For metrics with floating point value.

4111

"intValue": "A String", # For metrics with integer value.

4112

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4113

},

4114

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4115

"status": "A String", # Status of an operation stage.

4116

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4117

"name": "A String", # A non-parameterized string describing an operation stage.

4118

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4119

"stages": [ # Substages of an operation or a stage.

4120

# Object with schema name: OperationProgress

4121

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4122

},

4123

"zone": "A String", # The name of the Google Compute Engine

4124

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4125

# operation is taking place. This field is deprecated, use location instead.

4126

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4127

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4132

<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]

4133

<pre>Updates the master for a specific cluster.

4134

4135

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4136

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4137

number](https://support.google.com/cloud/answer/6158840).

4138

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4139

zone: string, Required. Deprecated. The name of the Google Compute Engine

4140

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4141

cluster resides. This field has been deprecated and replaced by the name

4142

field. (required)

4143

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4144

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4145

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4146

The object takes the form of:

4147

4148

{ # UpdateMasterRequest updates the master of the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4149

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4150

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4151

"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]

4152

# number](https://support.google.com/cloud/answer/6158840).

4153

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4154

"masterVersion": "A String", # Required. The Kubernetes version to change the master to.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4155

#

4156

# Users may specify either explicit versions offered by

4157

# Kubernetes Engine or version aliases, which have the following behavior:

4158

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4159

# - "latest": picks the highest valid Kubernetes version

4160

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4161

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4162

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4163

# - "-": picks the default Kubernetes version

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4164

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4165

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4166

# cluster resides. This field has been deprecated and replaced by the name

4167

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4168

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4169

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4170

}

4171

4172

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4179

4180

{ # This operation resource represents operations that may have happened or are

4181

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4182

"targetLink": "A String", # Server-defined URL for the target of the operation.

4183

"detail": "A String", # Detailed operation progress, if available.

4184

"operationType": "A String", # The operation type.

4185

"status": "A String", # The current status of the operation.

4186

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4187

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4188

{ # StatusCondition describes why a cluster or a node pool has a certain status

4189

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4190

"code": "A String", # Machine-friendly representation of the condition

4191

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4192

},

4193

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4194

"endTime": "A String", # [Output only] The time the operation completed, in

4195

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4196

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4197

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4198

# or

4199

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4200

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4201

"startTime": "A String", # [Output only] The time the operation started, in

4202

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4203

"clusterConditions": [ # Which conditions caused the current cluster state.

4204

{ # StatusCondition describes why a cluster or a node pool has a certain status

4205

# (e.g., ERROR or DEGRADED).

4206

"code": "A String", # Machine-friendly representation of the condition

4207

"message": "A String", # Human-friendly representation of the condition

4208

},

4209

],

4210

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4211

"metrics": [ # Progress metric bundle, for example:

4212

# metrics: [{name: "nodes done", int_value: 15},

4213

# {name: "nodes total", int_value: 32}]

4214

# or

4215

# metrics: [{name: "progress", double_value: 0.56},

4216

# {name: "progress scale", double_value: 1.0}]

4217

{ # Progress metric is (string, int|float|string) pair.

4218

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4219

"doubleValue": 3.14, # For metrics with floating point value.

4220

"intValue": "A String", # For metrics with integer value.

4221

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4222

},

4223

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4224

"status": "A String", # Status of an operation stage.

4225

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4226

"name": "A String", # A non-parameterized string describing an operation stage.

4227

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4228

"stages": [ # Substages of an operation or a stage.

4229

# Object with schema name: OperationProgress

4230

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4231

},

4232

"zone": "A String", # The name of the Google Compute Engine

4233

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4234

# operation is taking place. This field is deprecated, use location instead.

4235

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4236

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4241

<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]

4242

<pre>Sets the monitoring service for a specific cluster.

4243

4244

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4245

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4246

number](https://support.google.com/cloud/answer/6158840).

4247

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4248

zone: string, Required. Deprecated. The name of the Google Compute Engine

4249

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4250

cluster resides. This field has been deprecated and replaced by the name

4251

field. (required)

4252

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4253

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4254

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4255

The object takes the form of:

4256

4257

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4258

"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]

4259

# number](https://support.google.com/cloud/answer/6158840).

4260

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4261

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4262

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4263

# cluster resides. This field has been deprecated and replaced by the name

4264

# field.

4265

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

4266

# This field has been deprecated and replaced by the name field.

4267

"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]

4268

# Currently available options:

4269

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4270

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4271

# service with a Kubernetes-native resource model

4272

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4273

# longer available as of GKE 1.15).

4274

# * `none` - No metrics will be exported from the cluster.

4275

#

4276

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4277

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4278

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring.

4279

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4280

}

4281

4282

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4289

4290

{ # This operation resource represents operations that may have happened or are

4291

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4292

"targetLink": "A String", # Server-defined URL for the target of the operation.

4293

"detail": "A String", # Detailed operation progress, if available.

4294

"operationType": "A String", # The operation type.

4295

"status": "A String", # The current status of the operation.

4296

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4297

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4298

{ # StatusCondition describes why a cluster or a node pool has a certain status

4299

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4300

"code": "A String", # Machine-friendly representation of the condition

4301

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4302

},

4303

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4304

"endTime": "A String", # [Output only] The time the operation completed, in

4305

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4306

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4307

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4308

# or

4309

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4310

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4311

"startTime": "A String", # [Output only] The time the operation started, in

4312

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4313

"clusterConditions": [ # Which conditions caused the current cluster state.

4314

{ # StatusCondition describes why a cluster or a node pool has a certain status

4315

# (e.g., ERROR or DEGRADED).

4316

"code": "A String", # Machine-friendly representation of the condition

4317

"message": "A String", # Human-friendly representation of the condition

4318

},

4319

],

4320

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4321

"metrics": [ # Progress metric bundle, for example:

4322

# metrics: [{name: "nodes done", int_value: 15},

4323

# {name: "nodes total", int_value: 32}]

4324

# or

4325

# metrics: [{name: "progress", double_value: 0.56},

4326

# {name: "progress scale", double_value: 1.0}]

4327

{ # Progress metric is (string, int|float|string) pair.

4328

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4329

"doubleValue": 3.14, # For metrics with floating point value.

4330

"intValue": "A String", # For metrics with integer value.

4331

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4332

},

4333

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4334

"status": "A String", # Status of an operation stage.

4335

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4336

"name": "A String", # A non-parameterized string describing an operation stage.

4337

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4338

"stages": [ # Substages of an operation or a stage.

4339

# Object with schema name: OperationProgress

4340

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4341

},

4342

"zone": "A String", # The name of the Google Compute Engine

4343

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4344

# operation is taking place. This field is deprecated, use location instead.

4345

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4346

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4351

<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]

4352

<pre>Sets labels on a cluster.

4353

4354

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4355

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4356

number](https://developers.google.com/console/help/new/#projectnumber).

4357

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4358

zone: string, Required. Deprecated. The name of the Google Compute Engine

4359

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4360

cluster resides. This field has been deprecated and replaced by the name

4361

field. (required)

4362

clusterId: string, Required. Deprecated. The name of the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4363

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4364

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4365

The object takes the form of:

4366

4367

{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container

4368

# Engine cluster, which will in turn set them for Google Compute Engine

4369

# resources used by that cluster

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4370

"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]

4371

# used to detect conflicts. The fingerprint is initially generated by

4372

# Kubernetes Engine and changes after every request to modify or update

4373

# labels. You must always provide an up-to-date fingerprint hash when

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4374

# updating or changing labels. Make a <code>get()</code> request to the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4375

# resource to get the latest fingerprint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4376

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4377

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4378

# cluster resides. This field has been deprecated and replaced by the name

4379

# field.

4380

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels.

4381

# Specified in the format `projects/*/locations/*/clusters/*`.

4382

"resourceLabels": { # Required. The labels to set for that cluster.

4383

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4384

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4385

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project

4386

# number](https://developers.google.com/console/help/new/#projectnumber).

4387

# This field has been deprecated and replaced by the name field.

4388

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

4389

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4390

}

4391

4392

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4399

4400

{ # This operation resource represents operations that may have happened or are

4401

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4402

"targetLink": "A String", # Server-defined URL for the target of the operation.

4403

"detail": "A String", # Detailed operation progress, if available.

4404

"operationType": "A String", # The operation type.

4405

"status": "A String", # The current status of the operation.

4406

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4407

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4408

{ # StatusCondition describes why a cluster or a node pool has a certain status

4409

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4410

"code": "A String", # Machine-friendly representation of the condition

4411

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4412

},

4413

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4414

"endTime": "A String", # [Output only] The time the operation completed, in

4415

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4416

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4417

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4418

# or

4419

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4420

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4421

"startTime": "A String", # [Output only] The time the operation started, in

4422

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4423

"clusterConditions": [ # Which conditions caused the current cluster state.

4424

{ # StatusCondition describes why a cluster or a node pool has a certain status

4425

# (e.g., ERROR or DEGRADED).

4426

"code": "A String", # Machine-friendly representation of the condition

4427

"message": "A String", # Human-friendly representation of the condition

4428

},

4429

],

4430

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4431

"metrics": [ # Progress metric bundle, for example:

4432

# metrics: [{name: "nodes done", int_value: 15},

4433

# {name: "nodes total", int_value: 32}]

4434

# or

4435

# metrics: [{name: "progress", double_value: 0.56},

4436

# {name: "progress scale", double_value: 1.0}]

4437

{ # Progress metric is (string, int|float|string) pair.

4438

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4439

"doubleValue": 3.14, # For metrics with floating point value.

4440

"intValue": "A String", # For metrics with integer value.

4441

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4442

},

4443

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4444

"status": "A String", # Status of an operation stage.

4445

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4446

"name": "A String", # A non-parameterized string describing an operation stage.

4447

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4448

"stages": [ # Substages of an operation or a stage.

4449

# Object with schema name: OperationProgress

4450

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4451

},

4452

"zone": "A String", # The name of the Google Compute Engine

4453

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4454

# operation is taking place. This field is deprecated, use location instead.

4455

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4456

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4461

<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]

4462

<pre>Sets the maintenance policy for a cluster.

4463

4464

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4465

projectId: string, Required. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4466

number](https://support.google.com/cloud/answer/6158840). (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4467

zone: string, Required. The name of the Google Compute Engine

4468

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4469

cluster resides. (required)

4470

clusterId: string, Required. The name of the cluster to update. (required)

4471

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4472

The object takes the form of:

4473

4474

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4475

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance

4476

# policy.

4477

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4478

"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]

4479

# clears the existing maintenance policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4480

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4481

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

4482

# occur in these windows.

4483

"a_key": { # Represents an arbitrary window of time.

4484

"startTime": "A String", # The time that the window first starts.

4485

"endTime": "A String", # The time that the window ends. The end time should take place after the

4486

# start time.

4487

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4488

},

4489

"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]

4490

# maintenance to occur. The time windows may be overlapping. If no

4491

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4492

"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]

4493

# this window reccurs. They go on for the span of time between the start and

4494

# end time.

4495

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4496

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4497

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

4498

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

4499

# <code>FREQ=DAILY</code>

4500

# For the first weekend of every month:

4501

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

4502

# 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]

4503

# 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]

4504

# <code>

4505

# start time = 2019-01-01T09:00:00-0400

4506

# end time = 2019-01-01T17:00:00-0400

4507

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

4508

# </code>

4509

# Windows can span multiple days. Eg, to make the window encompass every

4510

# weekend from midnight Saturday till the last minute of Sunday UTC:

4511

# <code>

4512

# start time = 2019-01-05T00:00:00Z

4513

# end time = 2019-01-07T23:59:00Z

4514

# recurrence = FREQ=WEEKLY;BYDAY=SA

4515

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4516

# 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]

4517

# to specify duration of the window and when it first starts.

4518

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4519

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4520

"startTime": "A String", # The time that the window first starts.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4521

"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]

4522

# start time.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4523

},

4524

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4525

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

4526

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

4527

# smallest possible in the given scenario.

4528

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

4529

# It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4530

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4531

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4532

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

4533

# the policy won't accidentally undo intermediate changes (and so that users

4534

# of the API unaware of some fields won't accidentally remove other fields).

4535

# Make a <code>get()</code> request to the cluster to get the current

4536

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4537

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4538

"projectId": "A String", # Required. The Google Developers Console [project ID or project

4539

# number](https://support.google.com/cloud/answer/6158840).

4540

"zone": "A String", # Required. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4541

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4542

# cluster resides.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4543

"clusterId": "A String", # Required. The name of the cluster to update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4544

}

4545

4546

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4553

4554

{ # This operation resource represents operations that may have happened or are

4555

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4556

"targetLink": "A String", # Server-defined URL for the target of the operation.

4557

"detail": "A String", # Detailed operation progress, if available.

4558

"operationType": "A String", # The operation type.

4559

"status": "A String", # The current status of the operation.

4560

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4561

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4562

{ # StatusCondition describes why a cluster or a node pool has a certain status

4563

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4564

"code": "A String", # Machine-friendly representation of the condition

4565

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4566

},

4567

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4568

"endTime": "A String", # [Output only] The time the operation completed, in

4569

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4570

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4571

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4572

# or

4573

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4574

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4575

"startTime": "A String", # [Output only] The time the operation started, in

4576

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4577

"clusterConditions": [ # Which conditions caused the current cluster state.

4578

{ # StatusCondition describes why a cluster or a node pool has a certain status

4579

# (e.g., ERROR or DEGRADED).

4580

"code": "A String", # Machine-friendly representation of the condition

4581

"message": "A String", # Human-friendly representation of the condition

4582

},

4583

],

4584

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4585

"metrics": [ # Progress metric bundle, for example:

4586

# metrics: [{name: "nodes done", int_value: 15},

4587

# {name: "nodes total", int_value: 32}]

4588

# or

4589

# metrics: [{name: "progress", double_value: 0.56},

4590

# {name: "progress scale", double_value: 1.0}]

4591

{ # Progress metric is (string, int|float|string) pair.

4592

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4593

"doubleValue": 3.14, # For metrics with floating point value.

4594

"intValue": "A String", # For metrics with integer value.

4595

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4596

},

4597

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4598

"status": "A String", # Status of an operation stage.

4599

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4600

"name": "A String", # A non-parameterized string describing an operation stage.

4601

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4602

"stages": [ # Substages of an operation or a stage.

4603

# Object with schema name: OperationProgress

4604

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4605

},

4606

"zone": "A String", # The name of the Google Compute Engine

4607

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4608

# operation is taking place. This field is deprecated, use location instead.

4609

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4610

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4615

<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]

4616

<pre>Sets master auth materials. Currently supports changing the admin password

4617

or a specific cluster, either via password generation or explicitly setting

4618

the password.

4619

4620

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4621

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4622

number](https://support.google.com/cloud/answer/6158840).

4623

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4624

zone: string, Required. Deprecated. The name of the Google Compute Engine

4625

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4626

cluster resides. This field has been deprecated and replaced by the name

4627

field. (required)

4628

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4629

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4630

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4631

The object takes the form of:

4632

4633

{ # SetMasterAuthRequest updates the admin password of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4634

"name": "A String", # The name (project, location, cluster) of the cluster to set auth.

4635

# Specified in the format `projects/*/locations/*/clusters/*`.

4636

"action": "A String", # Required. The exact form of action to be taken on the master auth.

4637

"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]

4638

# number](https://support.google.com/cloud/answer/6158840).

4639

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4640

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4641

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4642

"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]

4643

# Authentication can be done using HTTP basic auth or using client

4644

# certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4645

"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]

4646

# Because the master endpoint is open to the Internet, you should create a

4647

# strong password. If a password is provided for cluster creation, username

4648

# must be non-empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4649

"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]

4650

# clusters before v1.12, if no configuration is specified, a client

4651

# certificate is issued.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4652

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4653

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4654

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

4655

# to the cluster endpoint.

4656

"clusterCaCertificate": "A String",

4657

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

4658

# authenticate to the cluster endpoint.

4659

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

4660

# For clusters v1.6.0 and later, basic authentication can be disabled by

4661

# leaving username unspecified (or setting it to the empty string).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4662

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4663

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4664

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4665

# cluster resides. This field has been deprecated and replaced by the name

4666

# field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4667

}

4668

4669

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4676

4677

{ # This operation resource represents operations that may have happened or are

4678

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4679

"targetLink": "A String", # Server-defined URL for the target of the operation.

4680

"detail": "A String", # Detailed operation progress, if available.

4681

"operationType": "A String", # The operation type.

4682

"status": "A String", # The current status of the operation.

4683

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4684

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4685

{ # StatusCondition describes why a cluster or a node pool has a certain status

4686

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4687

"code": "A String", # Machine-friendly representation of the condition

4688

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4689

},

4690

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4691

"endTime": "A String", # [Output only] The time the operation completed, in

4692

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4693

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4694

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4695

# or

4696

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4697

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4698

"startTime": "A String", # [Output only] The time the operation started, in

4699

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4700

"clusterConditions": [ # Which conditions caused the current cluster state.

4701

{ # StatusCondition describes why a cluster or a node pool has a certain status

4702

# (e.g., ERROR or DEGRADED).

4703

"code": "A String", # Machine-friendly representation of the condition

4704

"message": "A String", # Human-friendly representation of the condition

4705

},

4706

],

4707

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4708

"metrics": [ # Progress metric bundle, for example:

4709

# metrics: [{name: "nodes done", int_value: 15},

4710

# {name: "nodes total", int_value: 32}]

4711

# or

4712

# metrics: [{name: "progress", double_value: 0.56},

4713

# {name: "progress scale", double_value: 1.0}]

4714

{ # Progress metric is (string, int|float|string) pair.

4715

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4716

"doubleValue": 3.14, # For metrics with floating point value.

4717

"intValue": "A String", # For metrics with integer value.

4718

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4719

},

4720

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4721

"status": "A String", # Status of an operation stage.

4722

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4723

"name": "A String", # A non-parameterized string describing an operation stage.

4724

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4725

"stages": [ # Substages of an operation or a stage.

4726

# Object with schema name: OperationProgress

4727

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4728

},

4729

"zone": "A String", # The name of the Google Compute Engine

4730

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4731

# operation is taking place. This field is deprecated, use location instead.

4732

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4733

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4738

<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]

4739

<pre>Enables or disables Network Policy for a cluster.

4740

4741

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4742

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4743

number](https://developers.google.com/console/help/new/#projectnumber).

4744

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4745

zone: string, Required. Deprecated. The name of the Google Compute Engine

4746

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4747

cluster resides. This field has been deprecated and replaced by the name

4748

field. (required)

4749

clusterId: string, Required. Deprecated. The name of the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4750

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4751

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4752

The object takes the form of:

4753

4754

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4755

"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]

4756

# number](https://developers.google.com/console/help/new/#projectnumber).

4757

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4758

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4759

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4760

# cluster resides. This field has been deprecated and replaced by the name

4761

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4762

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

4763

# This field has been deprecated and replaced by the name field.

4764

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature.

4765

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4766

"provider": "A String", # The selected network policy provider.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4767

"enabled": True or False, # Whether network policy is enabled on the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4768

},

4769

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking

4770

# policy. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4771

}

4772

4773

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4780

4781

{ # This operation resource represents operations that may have happened or are

4782

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4783

"targetLink": "A String", # Server-defined URL for the target of the operation.

4784

"detail": "A String", # Detailed operation progress, if available.

4785

"operationType": "A String", # The operation type.

4786

"status": "A String", # The current status of the operation.

4787

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4788

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4789

{ # StatusCondition describes why a cluster or a node pool has a certain status

4790

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4791

"code": "A String", # Machine-friendly representation of the condition

4792

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4793

},

4794

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4795

"endTime": "A String", # [Output only] The time the operation completed, in

4796

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4797

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4798

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4799

# or

4800

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4801

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4802

"startTime": "A String", # [Output only] The time the operation started, in

4803

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4804

"clusterConditions": [ # Which conditions caused the current cluster state.

4805

{ # StatusCondition describes why a cluster or a node pool has a certain status

4806

# (e.g., ERROR or DEGRADED).

4807

"code": "A String", # Machine-friendly representation of the condition

4808

"message": "A String", # Human-friendly representation of the condition

4809

},

4810

],

4811

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4812

"metrics": [ # Progress metric bundle, for example:

4813

# metrics: [{name: "nodes done", int_value: 15},

4814

# {name: "nodes total", int_value: 32}]

4815

# or

4816

# metrics: [{name: "progress", double_value: 0.56},

4817

# {name: "progress scale", double_value: 1.0}]

4818

{ # Progress metric is (string, int|float|string) pair.

4819

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4820

"doubleValue": 3.14, # For metrics with floating point value.

4821

"intValue": "A String", # For metrics with integer value.

4822

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4823

},

4824

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4825

"status": "A String", # Status of an operation stage.

4826

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4827

"name": "A String", # A non-parameterized string describing an operation stage.

4828

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4829

"stages": [ # Substages of an operation or a stage.

4830

# Object with schema name: OperationProgress

4831

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4832

},

4833

"zone": "A String", # The name of the Google Compute Engine

4834

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4835

# operation is taking place. This field is deprecated, use location instead.

4836

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4837

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4842

<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]

4843

<pre>Starts master IP rotation.

4844

4845

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4846

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4847

number](https://developers.google.com/console/help/new/#projectnumber).

4848

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4849

zone: string, Required. Deprecated. The name of the Google Compute Engine

4850

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4851

cluster resides. This field has been deprecated and replaced by the name

4852

field. (required)

4853

clusterId: string, Required. Deprecated. The name of the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4854

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4855

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4856

The object takes the form of:

4857

4858

{ # StartIPRotationRequest creates a new IP for the cluster and then performs

4859

# 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]

4860

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP

4861

# rotation. Specified in the format `projects/*/locations/*/clusters/*`.

4862

"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]

4863

# number](https://developers.google.com/console/help/new/#projectnumber).

4864

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4865

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4866

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4867

# cluster resides. This field has been deprecated and replaced by the name

4868

# field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4869

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4870

"clusterId": "A String", # Required. Deprecated. The name of the cluster.

4871

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4872

}

4873

4874

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4881

4882

{ # This operation resource represents operations that may have happened or are

4883

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4884

"targetLink": "A String", # Server-defined URL for the target of the operation.

4885

"detail": "A String", # Detailed operation progress, if available.

4886

"operationType": "A String", # The operation type.

4887

"status": "A String", # The current status of the operation.

4888

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4889

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4890

{ # StatusCondition describes why a cluster or a node pool has a certain status

4891

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4892

"code": "A String", # Machine-friendly representation of the condition

4893

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4894

},

4895

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4896

"endTime": "A String", # [Output only] The time the operation completed, in

4897

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4898

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4899

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4900

# or

4901

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4902

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4903

"startTime": "A String", # [Output only] The time the operation started, in

4904

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4905

"clusterConditions": [ # Which conditions caused the current cluster state.

4906

{ # StatusCondition describes why a cluster or a node pool has a certain status

4907

# (e.g., ERROR or DEGRADED).

4908

"code": "A String", # Machine-friendly representation of the condition

4909

"message": "A String", # Human-friendly representation of the condition

4910

},

4911

],

4912

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4913

"metrics": [ # Progress metric bundle, for example:

4914

# metrics: [{name: "nodes done", int_value: 15},

4915

# {name: "nodes total", int_value: 32}]

4916

# or

4917

# metrics: [{name: "progress", double_value: 0.56},

4918

# {name: "progress scale", double_value: 1.0}]

4919

{ # Progress metric is (string, int|float|string) pair.

4920

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

4921

"doubleValue": 3.14, # For metrics with floating point value.

4922

"intValue": "A String", # For metrics with integer value.

4923

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

4924

},

4925

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4926

"status": "A String", # Status of an operation stage.

4927

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4928

"name": "A String", # A non-parameterized string describing an operation stage.

4929

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4930

"stages": [ # Substages of an operation or a stage.

4931

# Object with schema name: OperationProgress

4932

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4933

},

4934

"zone": "A String", # The name of the Google Compute Engine

4935

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4936

# operation is taking place. This field is deprecated, use location instead.

4937

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

4938

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4943

<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]

4944

<pre>Updates the settings for a specific cluster.

4945

4946

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4947

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4948

number](https://support.google.com/cloud/answer/6158840).

4949

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4950

zone: string, Required. Deprecated. The name of the Google Compute Engine

4951

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4952

cluster resides. This field has been deprecated and replaced by the name

4953

field. (required)

4954

clusterId: string, Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4955

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4956

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4957

The object takes the form of:

4958

4959

{ # UpdateClusterRequest updates the settings of a cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4960

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4961

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4962

"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]

4963

# number](https://support.google.com/cloud/answer/6158840).

4964

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4965

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine

4966

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4967

# cluster resides. This field has been deprecated and replaced by the name

4968

# field.

4969

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4970

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4971

"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]

4972

# be applied to a cluster with each request, so at most one field can be

4973

# provided.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4974

"desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an

4975

# upgrade).

4976

#

4977

# Users may specify either explicit versions offered by

4978

# Kubernetes Engine or version aliases, which have the following behavior:

4979

#

4980

# - "latest": picks the highest valid Kubernetes version

4981

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4982

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4983

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4984

# - "-": picks the Kubernetes master version

4985

"desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

4986

# required by Cluster Autoscaler to automatically adjust

4987

# the size of the cluster and create/delete

4988

# node pools based on the current needs.

4989

"autoprovisioningLocations": [ # The list of Google Compute Engine

4990

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4991

# NodePool's nodes can be created by NAP.

4992

"A String",

4993

],

4994

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

4995

# amount of resources in the cluster.

4996

{ # Contains information about amount of some resource in the cluster.

4997

# For memory, value should be in GB.

4998

"maximum": "A String", # Maximum amount of the resource in the cluster.

4999

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

5000

"minimum": "A String", # Minimum amount of the resource in the cluster.

5001

},

5002

],

5003

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

5004

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

5005

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

5006

# created by NAP.

5007

# by NAP.

5008

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If

5009

# service_account is specified, scopes should be empty.

5010

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools.

5011

# The instance may be scheduled on the specified or newer CPU platform.

5012

# Applicable values are the friendly names of CPU platforms, such as

5013

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

5014

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

5015

# information, read [how to specify min CPU

5016

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

5017

# To unset the min cpu platform field pass "automatic" as field value.

5018

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

5019

# node pool.

5020

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

5021

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

5022

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

5023

# the Auto Upgrades will proceed.

5024

"description": "A String", # [Output only] This field is set when upgrades are about to commence

5025

# with the description of the upgrade.

5026

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

5027

# with the approximate start time for the upgrades, in

5028

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5029

},

5030

},

5031

"oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are

5032

# specified, service_account should be empty.

5033

"A String",

5034

],

5035

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

5036

# disruption caused by an upgrade.

5037

#

5038

# maxUnavailable controls the number of nodes that can be simultaneously

5039

# unavailable.

5040

#

5041

# maxSurge controls the number of additional nodes that can be added to the

5042

# node pool temporarily for the time of the upgrade to increase the number of

5043

# available nodes.

5044

#

5045

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

5046

# nodes are being upgraded at the same time).

5047

#

5048

# Note: upgrades inevitably introduce some disruption since workloads need to

5049

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

5050

# this holds true. (Disruption stays within the limits of

5051

# PodDisruptionBudget, if it is configured.)

5052

#

5053

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

5054

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

5055

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

5056

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

5057

# there are always at least 4 nodes available.

5058

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

5059

# the upgrade process. A node is considered available if its status is

5060

# Ready.

5061

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

5062

# of the node pool during the upgrade process.

},

},

},

"desiredPodSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # The desired configuration options for the PodSecurityPolicy feature.

5067

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods

5068

# must be valid under a PodSecurityPolicy to be created.

5069

},

5070

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility.

5071

# visibility on this cluster.

5072

"enabled": True or False, # Enables intra node visibility for this cluster.

5073

},

5074

"desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature.

5075

# master authorized networks will disallow all external traffic to access

5076

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

5077

# Google Compute Engine Public IPs and Google Prod IPs.

5078

"enabled": True or False, # Whether or not master authorized networks is enabled.

5079

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access

5080

# Kubernetes master through HTTPS.

5081

{ # CidrBlock contains an optional name and one CIDR block.

5082

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

5083

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

},

],

},

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

5088

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

5089

# daemonset will be created in the cluster to meter network egress traffic.

5090

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

5091

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

5092

# second BigQuery table will be created to hold resource consumption

5093

# records.

5094

},

5095

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

5096

"datasetId": "A String", # The ID of a BigQuery Dataset.

5097

},

5098

},

5099

"desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics.

5100

# Currently available options:

5101

#

5102

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

5103

# service with a Kubernetes-native resource model

5104

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

5105

# longer available as of GKE 1.15).

5106

# * `none` - No metrics will be exported from the cluster.

5107

#

5108

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

5109

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

5110

"desiredImageType": "A String", # The desired image type for the node pool.

5111

# NOTE: Set the "desired_node_pool" field as well.

5112

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity.

5113

# policies.

5114

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

5115

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

5116

},

5117

"desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is # The desired release channel configuration.

5118

# subscribed to. Release channels are arranged in order of risk and

5119

# frequency of updates.

5120

#

5121

# When a cluster is subscribed to a release channel, Google maintains

5122

# both the master version and the node version. Node auto-upgrade

5123

# defaults to true and cannot be disabled. Updates to version related

5124

# fields (e.g. current_master_version) return an error.

5125

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

5126

},

5127

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

5128

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

5129

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5130

"desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5131

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

5132

# range will be used for assigning internal IP addresses to the master or

5133

# set of masters, as well as the ILB VIP. This range must not overlap with

5134

# any other ranges in use within the cluster's network.

5135

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

5136

# given only RFC 1918 private addresses and communicate with the master via

5137

# private networking.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5138

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

5139

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

5140

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

5141

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

5142

"enabled": True or False, # Whenever master is accessible globally or not.

5143

},

5144

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5145

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5146

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

5147

# required by Vertical Pod Autoscaler to automatically adjust

5148

# the resources of pods controlled by it.

5149

"enabled": True or False, # Enables vertical pod autoscaling.

5150

},

5151

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

5152

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

5153

# images will be validated by Google Binauthz.

5154

},

5155

"desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

5156

# cluster, enabling additional functionality.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5157

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

5158

# makes it easy to set up HTTP load balancers for services in a cluster.

5159

# which makes it easy to set up HTTP load balancers for services in a cluster.

5160

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

5161

# When enabled, it runs a small pod in the cluster that manages the load

5162

# balancers.

5163

},

5164

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

5165

# This addon is deprecated, and will be disabled in 1.15. It is recommended

5166

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

5167

# workloads and applications. For more information, see:

5168

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

5169

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

5170

},

5171

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

5172

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

5173

},

5174

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s

5175

# applications.

5176

"enabled": True or False, # Whether KALM is enabled for this cluster.

5177

},

5178

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver.

5179

# enabled at cluster creation time.

5180

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

5181

},

5182

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure

5183

# microservices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5184

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5185

"disabled": True or False, # Whether Istio is enabled for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5186

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5187

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

5188

# is enabled or not on the Master, it does not track whether network policy

5189

# is enabled for the nodes.

5190

# is enabled or not on the Master, it does not track whether network policy

5191

# is enabled for the nodes.

5192

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5193

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5194

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be

5195

# enabled in order to enable Cloud Run addon. This option can only be enabled

5196

# at cluster creation time.

5197

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

5198

},

5199

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes

5200

# extension to manage hosted GCP services through the Kubernetes API

5201

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

5202

},

5203

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

5204

# increases or decreases the number of replica pods a replication controller

5205

# has based on the resource usage of the existing pods.

5206

# increases or decreases the number of replica pods a replication controller

5207

# has based on the resource usage of the existing pods.

5208

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

5209

# When enabled, it ensures that metrics are collected into Stackdriver

5210

# Monitoring.

5211

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5212

},

5213

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

5214

"state": "A String", # Denotes the state of etcd encryption.

5215

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

5216

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

5217

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5218

"desiredDefaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # The desired status of whether to disable default sNAT for this cluster.

5219

# be disabled on the cluster.

5220

"disabled": True or False, # Disables cluster default sNAT rules.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5221

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5222

"desiredTpuConfig": { # Configuration for Cloud TPU. # The desired Cloud TPU configuration.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5223

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5224

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

5225

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5226

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5227

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in

5228

# desired_node_pool_id. If there is only one pool in the

5229

# cluster and desired_node_pool_id is not provided then

5230

# the change applies to that single node pool.

5231

# adjust the size of the node pool to the current cluster usage.

5232

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

5233

# has to enough quota to scale up the cluster.

5234

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

5235

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

5236

# max_node_count.

5237

"enabled": True or False, # Is autoscaling enabled for this node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5238

},

5239

"desiredLocations": [ # The desired list of Google Compute Engine

5240

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

5241

# cluster's nodes should be located. Changing the locations a cluster is in

5242

# will result in nodes being either created or removed from the cluster,

5243

# depending on whether locations are being added or removed.

5244

#

5245

# This list must always include the cluster's primary zone.

5246

"A String",

5247

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5248

"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster.

5249

"type": "A String", # Type of the integration.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5250

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5251

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if

5252

# "desired_node_version", "desired_image_family",

5253

# "desired_node_pool_autoscaling", or "desired_workload_metadata_config"

5254

# is specified and there is more than one node pool on the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5255

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the

5256

# latest supported version.

5257

#

5258

# Users may specify either explicit versions offered by

5259

# Kubernetes Engine or version aliases, which have the following behavior:

5260

#

5261

# - "latest": picks the highest valid Kubernetes version

5262

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

5263

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

5264

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

5265

# - "-": picks the default Kubernetes version

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5266

"desiredLoggingService": "A String", # The logging service the cluster should use to write logs.

5267

# Currently available options:

5268

#

5269

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

5270

# service with a Kubernetes-native resource model

5271

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

5272

# available as of GKE 1.15).

5273

# * `none` - no logs will be exported from the cluster.

5274

#

5275

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

5276

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5277

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5278

}

5279

5280

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5287

5288

{ # This operation resource represents operations that may have happened or are

5289

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5290

"targetLink": "A String", # Server-defined URL for the target of the operation.

5291

"detail": "A String", # Detailed operation progress, if available.

5292

"operationType": "A String", # The operation type.

5293

"status": "A String", # The current status of the operation.

5294

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5295

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5296

{ # StatusCondition describes why a cluster or a node pool has a certain status

5297

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5298

"code": "A String", # Machine-friendly representation of the condition

5299

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5300

},

5301

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5302

"endTime": "A String", # [Output only] The time the operation completed, in

5303

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5304

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5305

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5306

# or

5307

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5308

# in which the cluster resides.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5309

"startTime": "A String", # [Output only] The time the operation started, in

5310

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5311

"clusterConditions": [ # Which conditions caused the current cluster state.

5312

{ # StatusCondition describes why a cluster or a node pool has a certain status

5313

# (e.g., ERROR or DEGRADED).

5314

"code": "A String", # Machine-friendly representation of the condition

5315

"message": "A String", # Human-friendly representation of the condition

5316

},

5317

],

5318

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5319

"metrics": [ # Progress metric bundle, for example:

5320

# metrics: [{name: "nodes done", int_value: 15},

5321

# {name: "nodes total", int_value: 32}]

5322

# or

5323

# metrics: [{name: "progress", double_value: 0.56},

5324

# {name: "progress scale", double_value: 1.0}]

5325

{ # Progress metric is (string, int|float|string) pair.

5326

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

5327

"doubleValue": 3.14, # For metrics with floating point value.

5328

"intValue": "A String", # For metrics with integer value.

5329

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

5330

},

5331

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5332

"status": "A String", # Status of an operation stage.

5333

# Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5334

"name": "A String", # A non-parameterized string describing an operation stage.

5335

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5336

"stages": [ # Substages of an operation or a stage.

5337

# Object with schema name: OperationProgress

5338

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5339

},

5340

"zone": "A String", # The name of the Google Compute Engine

5341

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5342

# operation is taking place. This field is deprecated, use location instead.

5343

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

5344

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim