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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Jon Wayne Parrott

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

[diff] [blame]

78

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

79

</p>

80

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

81

82

Dan O'Meara

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

[diff] [blame]

83

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

Bu Sun Kim

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

[diff] [blame]

84

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

85

Dan O'Meara

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

[diff] [blame]

86

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

Sai Cheemalapati

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

[diff] [blame]

87

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

88

Dan O'Meara

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

[diff] [blame]

89

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

Sai Cheemalapati

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

[diff] [blame]

90

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

Takashi Matsuo

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

[diff] [blame]

91

Bu Sun Kim

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

[diff] [blame]

92

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

Sai Cheemalapati

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

[diff] [blame]

93

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

Takashi Matsuo

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

[diff] [blame]

94

Bu Sun Kim

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

[diff] [blame]

95

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

Jon Wayne Parrott

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

[diff] [blame]

96

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

Takashi Matsuo

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

[diff] [blame]

97

Dan O'Meara

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

[diff] [blame]

98

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

Sai Cheemalapati

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

[diff] [blame]

99

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

100

Bu Sun Kim

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

[diff] [blame]

101

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

Sai Cheemalapati

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

[diff] [blame]

102

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

103

Dan O'Meara

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

[diff] [blame]

104

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

Bu Sun Kim

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

[diff] [blame]

105

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

106

Dan O'Meara

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

[diff] [blame]

107

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

Bu Sun Kim

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

[diff] [blame]

108

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

109

Dan O'Meara

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

[diff] [blame]

110

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

Bu Sun Kim

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

[diff] [blame]

111

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

112

Dan O'Meara

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

[diff] [blame]

113

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

Bu Sun Kim

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

[diff] [blame]

114

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

115

Dan O'Meara

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

[diff] [blame]

116

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

Sai Cheemalapati

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

[diff] [blame]

117

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

118

Dan O'Meara

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

[diff] [blame]

119

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

Bu Sun Kim

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

[diff] [blame]

120

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

121

Dan O'Meara

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

[diff] [blame]

122

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

Bu Sun Kim

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

[diff] [blame]

123

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

124

Dan O'Meara

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

Sai Cheemalapati

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

[diff] [blame]

127

Dan O'Meara

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

[diff] [blame]

128

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

Bu Sun Kim

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

[diff] [blame]

129

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

Takashi Matsuo

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

[diff] [blame]

130

Dan O'Meara

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

[diff] [blame]

131

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

Jon Wayne Parrott

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

[diff] [blame]

132

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

Takashi Matsuo

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

[diff] [blame]

133

<h3>Method Details</h3>

134

Dan O'Meara

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

[diff] [blame]

135

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

Bu Sun Kim

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

[diff] [blame]

136

<pre>Sets the addons for a specific cluster.

Takashi Matsuo

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

[diff] [blame]

137

138

Args:

Bu Sun Kim

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

[diff] [blame]

139

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

140

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

141

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

142

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

Dan O'Meara

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

[diff] [blame]

143

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

144

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

145

field. (required)

Bu Sun Kim

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

[diff] [blame]

146

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

147

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

Dan O'Meara

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

[diff] [blame]

148

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

149

The object takes the form of:

150

Bu Sun Kim

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

[diff] [blame]

151

{ # SetAddonsConfigRequest sets the addons associated with the cluster.

Bu Sun Kim

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

[diff] [blame]

152

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

153

# cluster.

154

# cluster, enabling additional functionality.

Bu Sun Kim

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

[diff] [blame]

155

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

156

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

157

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

158

# workloads and applications. For more information, see:

159

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

160

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

Bu Sun Kim

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

[diff] [blame]

161

},

162

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

163

# managed Knative service.

164

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

165

},

Bu Sun Kim

2020-07-22 17:02:09 -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.

172

},

Bu Sun Kim

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

[diff] [blame]

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

# Monitoring.

181

},

Bu Sun Kim

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

[diff] [blame]

182

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

183

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

Bu Sun Kim

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

[diff] [blame]

184

},

Bu Sun Kim

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

[diff] [blame]

185

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

186

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

187

# is enabled for the nodes.

188

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

189

# is enabled for the nodes.

190

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

Bu Sun Kim

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

[diff] [blame]

191

},

192

},

Bu Sun Kim

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

[diff] [blame]

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

# field.

Sai Cheemalapati

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

[diff] [blame]

204

}

205

206

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

213

214

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

215

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

Bu Sun Kim

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

[diff] [blame]

216

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

217

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

218

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

219

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

220

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

221

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

222

# or

223

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

224

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

225

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

Bu Sun Kim

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

[diff] [blame]

226

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

Bu Sun Kim

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

[diff] [blame]

227

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

228

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

Bu Sun Kim

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

[diff] [blame]

229

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

Bu Sun Kim

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

[diff] [blame]

230

},

231

],

232

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

233

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

234

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

235

# Object with schema name: OperationProgress

236

],

Bu Sun Kim

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

[diff] [blame]

237

},

Bu Sun Kim

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

[diff] [blame]

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

},

249

],

Bu Sun Kim

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

[diff] [blame]

250

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

251

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

252

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

Bu Sun Kim

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

[diff] [blame]

253

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

Bu Sun Kim

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

[diff] [blame]

254

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

Bu Sun Kim

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

[diff] [blame]

255

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

256

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

257

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

Bu Sun Kim

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

[diff] [blame]

258

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

Bu Sun Kim

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

[diff] [blame]

259

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

260

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

Bu Sun Kim

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

[diff] [blame]

261

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

Bu Sun Kim

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

[diff] [blame]

262

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

Bu Sun Kim

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

[diff] [blame]

263

},

264

],

Bu Sun Kim

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

[diff] [blame]

265

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

Dan O'Meara

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

[diff] [blame]

266

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

267

# or

268

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

269

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

270

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

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]

275

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

276

<pre>Completes master IP rotation.

277

278

Args:

279

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

280

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

281

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

282

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

Dan O'Meara

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

[diff] [blame]

283

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

284

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

285

field. (required)

Bu Sun Kim

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

[diff] [blame]

286

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

287

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

Dan O'Meara

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

[diff] [blame]

288

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

289

The object takes the form of:

290

291

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

Bu Sun Kim

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

[diff] [blame]

292

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

293

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

Bu Sun Kim

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

[diff] [blame]

294

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

295

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

Bu Sun Kim

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

[diff] [blame]

296

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

Bu Sun Kim

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

[diff] [blame]

297

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

298

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

Bu Sun Kim

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

[diff] [blame]

299

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

Dan O'Meara

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

[diff] [blame]

300

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

301

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

302

# field.

Bu Sun Kim

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

[diff] [blame]

303

}

304

305

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

312

313

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

314

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

Bu Sun Kim

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

[diff] [blame]

315

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

316

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

317

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

318

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

319

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

320

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

321

# or

322

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

323

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

324

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

Bu Sun Kim

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

[diff] [blame]

325

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

Bu Sun Kim

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

[diff] [blame]

326

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

327

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

Bu Sun Kim

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

[diff] [blame]

328

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

Bu Sun Kim

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

[diff] [blame]

329

},

330

],

331

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

332

# Unset for single-stage operations.

Bu Sun Kim

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

[diff] [blame]

333

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

334

# Object with schema name: OperationProgress

335

],

Bu Sun Kim

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

[diff] [blame]

336

},

Bu Sun Kim

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

[diff] [blame]

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

},

348

],

Bu Sun Kim

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

[diff] [blame]

349

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

350

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

351

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

Bu Sun Kim

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

[diff] [blame]

352

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

Bu Sun Kim

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

[diff] [blame]

353

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

Bu Sun Kim

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

[diff] [blame]

354

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

355

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

356

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

Bu Sun Kim

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

[diff] [blame]

357

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

Bu Sun Kim

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

[diff] [blame]

358

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

359

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

Bu Sun Kim

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

[diff] [blame]

360

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

Bu Sun Kim

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

[diff] [blame]

361

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

Bu Sun Kim

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

[diff] [blame]

362

},

363

],

Bu Sun Kim

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

[diff] [blame]

364

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

Dan O'Meara

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

[diff] [blame]

365

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

366

# or

367

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

368

# in which the cluster resides.

Bu Sun Kim

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

[diff] [blame]

369

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

374

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

Sai Cheemalapati

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

[diff] [blame]

375

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

376

Compute Engine instances.

377

Bu Sun Kim

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

[diff] [blame]

378

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

Dan O'Meara

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

[diff] [blame]

379

[default

380

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

Sai Cheemalapati

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

[diff] [blame]

381

382

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

Bu Sun Kim

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

[diff] [blame]

383

the Kubelet creates routes for each node to allow the containers

Sai Cheemalapati

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

[diff] [blame]

384

on that node to communicate with all other instances in the

385

cluster.

386

Bu Sun Kim

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

[diff] [blame]

387

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

Bu Sun Kim

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

[diff] [blame]

388

which CIDR range the cluster is using.

Sai Cheemalapati

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

[diff] [blame]

389

390

Args:

Bu Sun Kim

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

[diff] [blame]

391

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

392

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

393

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

394

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

Dan O'Meara

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

[diff] [blame]

395

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

396

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

397

field. (required)

398

body: object, The request body.

Takashi Matsuo

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

[diff] [blame]

399

The object takes the form of:

400

401

{ # CreateClusterRequest creates a cluster.

Bu Sun Kim

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

[diff] [blame]

402

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

403

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

404

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

405

# field.

Bu Sun Kim

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

[diff] [blame]

406

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

407

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

Bu Sun Kim

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

[diff] [blame]

408

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

Bu Sun Kim

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

[diff] [blame]

409

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

410

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

411

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

412

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

413

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

414

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

415

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

416

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

417

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

418

# if enabled = true.

419

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

420

# during authentication using a group of security groups.

Bu Sun Kim

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

[diff] [blame]

421

},

Bu Sun Kim

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

[diff] [blame]

422

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

423

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

424

# the kubernetes version of the master and nodes.

425

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

426

# Alpha enabled clusters are automatically deleted thirty days after

427

# creation.

428

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

429

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services

430

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

431

# ClusterIPs. This must be an existing secondary range associated

432

# with the cluster subnetwork.

433

#

434

# This field is only applicable with use_ip_aliases is true and

435

# create_subnetwork is false.

436

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

437

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

438

# subnetwork.

439

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

440

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range

441

# will be automatically chosen with the default size.

442

#

443

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

444

#

445

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

446

#

447

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

452

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

453

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

454

# to use.

455

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

456

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

457

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

458

# addresses. This must be an existing secondary range associated

459

# with the cluster subnetwork.

460

#

461

# This field is only applicable with use_ip_aliases is true and

462

# create_subnetwork is false.

463

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a

464

# range will be automatically chosen with the default size.

465

#

466

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

467

#

468

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

469

#

470

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

475

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

476

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

477

# to use.

478

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

479

#

480

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

481

#

482

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

483

#

484

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

489

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

490

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

491

# to use.

492

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

493

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

494

#

495

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

496

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

497

# `cluster.cluster_ipv4_cidr` must be left blank.

498

#

499

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

500

#

501

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

502

#

503

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

508

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

509

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

510

# to use.

511

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

512

},

513

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

514

# Currently available options:

Bu Sun Kim

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

[diff] [blame]

515

#

Bu Sun Kim

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

[diff] [blame]

516

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

517

# service with a Kubernetes-native resource model

518

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

519

# available as of GKE 1.15).

520

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

521

#

522

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

523

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

524

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

525

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

526

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

527

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

528

# mode.

529

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

530

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

531

# controllers, will have statically granted permissions beyond those

532

# provided by the RBAC configuration or IAM.

Bu Sun Kim

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

[diff] [blame]

533

},

Bu Sun Kim

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

[diff] [blame]

534

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

535

# Google Compute Engine resources.

536

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

537

},

Bu Sun Kim

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

[diff] [blame]

538

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

Sai Cheemalapati

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

[diff] [blame]

539

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

Bu Sun Kim

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

[diff] [blame]

540

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

541

# mode.

Bu Sun Kim

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

[diff] [blame]

542

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

543

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

544

#

545

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

546

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

547

# defaults to true and cannot be disabled.

548

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

Bu Sun Kim

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

[diff] [blame]

549

},

550

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

551

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

552

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

553

# occur in these windows.

554

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

555

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

556

# start time.

557

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

558

},

Bu Sun Kim

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

[diff] [blame]

559

},

Bu Sun Kim

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

[diff] [blame]

560

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

561

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

562

# smallest possible in the given scenario.

563

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

564

# format "PTnHnMnS".

565

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

566

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

567

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

568

},

Bu Sun Kim

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

[diff] [blame]

569

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

570

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

571

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

Bu Sun Kim

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

[diff] [blame]

572

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

573

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

574

# start time.

575

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

576

},

Bu Sun Kim

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

[diff] [blame]

577

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

578

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

579

# end time.

580

#

Bu Sun Kim

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

[diff] [blame]

581

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

Dan O'Meara

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

[diff] [blame]

582

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

583

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

584

# <code>FREQ=DAILY</code>

585

# For the first weekend of every month:

586

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

587

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

588

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

589

# <code>

590

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

591

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

592

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

593

# </code>

594

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

595

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

596

# <code>

597

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

598

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

599

# recurrence = FREQ=WEEKLY;BYDAY=SA

600

# </code>

Bu Sun Kim

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

[diff] [blame]

601

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

602

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

603

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

Dan O'Meara

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

[diff] [blame]

604

},

Bu Sun Kim

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

[diff] [blame]

605

},

Bu Sun Kim

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

[diff] [blame]

606

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

607

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

608

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

Dan O'Meara

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

[diff] [blame]

609

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

610

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

Bu Sun Kim

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

[diff] [blame]

611

},

Bu Sun Kim

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

[diff] [blame]

612

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

613

# Currently available options:

Bu Sun Kim

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

[diff] [blame]

614

#

Bu Sun Kim

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

[diff] [blame]

615

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

616

# service with a Kubernetes-native resource model

617

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

618

# longer available as of GKE 1.15).

619

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

Bu Sun Kim

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

[diff] [blame]

620

#

Bu Sun Kim

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

[diff] [blame]

621

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

622

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

623

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

624

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

625

# images will be validated by Binary Authorization.

Bu Sun Kim

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

[diff] [blame]

626

},

Bu Sun Kim

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

[diff] [blame]

627

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

628

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

629

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

Bu Sun Kim

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

[diff] [blame]

630

"A String",

Bu Sun Kim

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

[diff] [blame]

631

],

Bu Sun Kim

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

[diff] [blame]

632

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

633

# The endpoint can be accessed from the internet at

634

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

635

#

636

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

637

# password information.

638

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

639

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

640

},

641

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

642

# master authorized networks will disallow all external traffic to access

643

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

644

# Google Compute Engine Public IPs and Google Prod IPs.

645

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

646

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

647

# Kubernetes master through HTTPS.

648

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

649

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

650

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

Bu Sun Kim

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

[diff] [blame]

651

},

Bu Sun Kim

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

[diff] [blame]

652

],

653

},

654

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

655

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

656

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

657

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

658

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

659

},

660

],

661

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

662

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

663

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

664

# network will be used.

665

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

666

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

667

# required by Cluster Autoscaler to automatically adjust

668

# the size of the cluster and create/delete

669

# node pools based on the current needs.

670

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

671

# amount of resources in the cluster.

672

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

673

# For memory, value should be in GB.

674

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

675

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

676

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

677

},

678

],

679

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

680

# created by NAP.

681

# by NAP.

682

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

683

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

684

# node pool.

685

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

686

# the Auto Upgrades will proceed.

687

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

688

# with the description of the upgrade.

689

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

690

# with the approximate start time for the upgrades, in

691

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

692

},

693

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

694

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

695

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

696

# triggered.

697

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

698

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

699

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

700

},

701

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

Dan O'Meara

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

[diff] [blame]

702

# disruption caused by an upgrade.

703

#

704

# maxUnavailable controls the number of nodes that can be simultaneously

705

# unavailable.

706

#

707

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

708

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

709

# available nodes.

710

#

711

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

712

# nodes are being upgraded at the same time).

713

#

714

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

715

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

716

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

717

# PodDisruptionBudget, if it is configured.)

718

#

719

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

720

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

721

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

722

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

723

# there are always at least 4 nodes available.

Bu Sun Kim

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

[diff] [blame]

724

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

Dan O'Meara

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

[diff] [blame]

725

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

726

# Ready.

Bu Sun Kim

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

[diff] [blame]

727

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

728

# of the node pool during the upgrade process.

Dan O'Meara

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

[diff] [blame]

729

},

Bu Sun Kim

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

[diff] [blame]

730

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

Bu Sun Kim

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

[diff] [blame]

731

"A String",

732

],

Jon Wayne Parrott

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

[diff] [blame]

733

},

Bu Sun Kim

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

[diff] [blame]

734

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

735

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

736

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

737

# NodePool's nodes can be created by NAP.

"A String",

],

},

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

Bu Sun Kim

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

[diff] [blame]

742

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

743

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

Bu Sun Kim

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

[diff] [blame]

744

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

Bu Sun Kim

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

[diff] [blame]

745

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

Bu Sun Kim

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

[diff] [blame]

746

},

Bu Sun Kim

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

[diff] [blame]

747

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

Bu Sun Kim

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

[diff] [blame]

748

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

Bu Sun Kim

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

[diff] [blame]

749

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

750

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

751

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

752

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

753

# if cluster created with IP Alias support.

754

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

Takashi Matsuo

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

[diff] [blame]

755

},

Bu Sun Kim

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

[diff] [blame]

756

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

Sai Cheemalapati

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

[diff] [blame]

757

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

Bu Sun Kim

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

[diff] [blame]

758

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

759

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

Sai Cheemalapati

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

[diff] [blame]

760

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

761

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

Bu Sun Kim

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

[diff] [blame]

762

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

763

# `node_pool.config`)

Sai Cheemalapati

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

[diff] [blame]

764

#

765

# If unspecified, the defaults are used.

Bu Sun Kim

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

[diff] [blame]

766

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

Bu Sun Kim

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

[diff] [blame]

767

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

768

#

769

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

770

"bootDiskKmsKey": "A String", #

771

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

772

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

773

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

774

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

775

# see:

776

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

777

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

778

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

779

#

780

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

781

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

782

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

783

# the instance is created.

784

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

785

#

786

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

787

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

788

# boot process if signature verification fails.

789

},

790

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

791

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

792

# Kubernetes may apply to the node.

793

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

794

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

795

# and conflicts should be avoided.

796

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

797

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

798

"a_key": "A String",

799

},

Bu Sun Kim

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

[diff] [blame]

800

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

801

# node VMs under the "default" service account.

Sai Cheemalapati

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

[diff] [blame]

802

#

803

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

804

# not included:

805

#

806

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

807

# persistent storage on your nodes.

808

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

809

# communicating with **gcr.io**

Dan O'Meara

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

[diff] [blame]

810

# (the [Google Container

811

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

Sai Cheemalapati

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

[diff] [blame]

812

#

813

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

814

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

Bu Sun Kim

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

[diff] [blame]

815

"A String",

Sai Cheemalapati

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

[diff] [blame]

816

],

Bu Sun Kim

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

[diff] [blame]

817

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

818

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

819

# friendly names of CPU platforms, such as

820

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

821

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

822

# information, read [how to specify min CPU

823

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

824

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

825

#

826

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

827

# disks available on a machine per zone. See:

828

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

829

# for more information.

Bu Sun Kim

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

[diff] [blame]

830

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

Dan O'Meara

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

[diff] [blame]

831

#

832

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

833

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

834

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

835

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

836

#

Bu Sun Kim

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

[diff] [blame]

837

# See

838

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

839

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

Bu Sun Kim

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

[diff] [blame]

840

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

841

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

Bu Sun Kim

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

[diff] [blame]

842

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

Dan O'Meara

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

[diff] [blame]

843

},

844

],

Bu Sun Kim

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

[diff] [blame]

845

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

846

# the latest version of it will be used.

847

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

848

# the specified [Zonal Compute

849

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

850

# to this node pool.

851

# is the configuration of desired reservation which instances could take

852

# capacity from.

853

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

854

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

855

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

856

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

857

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

858

"A String",

859

],

Bu Sun Kim

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

[diff] [blame]

860

},

Bu Sun Kim

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

[diff] [blame]

861

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

862

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

863

# `n1-standard-1`).

864

#

865

# If unspecified, the default machine type is

866

# `n1-standard-1`.

Bu Sun Kim

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

[diff] [blame]

867

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

868

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

869

# workloads on [sole tenant

870

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

Bu Sun Kim

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

[diff] [blame]

871

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

872

#

873

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

874

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

875

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

876

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

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

882

# "enable-os-login"

883

# "gci-ensure-gke-docker"

884

# "gci-metrics-enabled"

885

# "gci-update-strategy"

886

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

891

# "windows-startup-script-ps1"

892

# "common-psm1"

893

# "k8s-node-setup-psm1"

894

# "install-ssh-psm1"

895

# "user-profile-psm1"

896

# "serial-port-logging-enable"

897

#

898

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

899

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

900

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

901

#

902

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

903

"a_key": "A String",

904

},

Bu Sun Kim

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

[diff] [blame]

905

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

906

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

907

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

908

# must comply with RFC1035.

909

"A String",

910

],

Bu Sun Kim

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

[diff] [blame]

911

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

912

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

913

},

914

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

915

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

916

# information about preemptible VM instances.

917

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

918

# workloads on the node pool.

919

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

920

# on the node pool.

921

},

922

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

923

# The smallest allowed disk size is 10GB.

924

#

925

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

Bu Sun Kim

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

[diff] [blame]

926

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

927

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

928

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

Bu Sun Kim

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

[diff] [blame]

929

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

930

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

931

# support for GPUs.

932

{ # AcceleratorConfig represents a Hardware Accelerator request.

933

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

934

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

935

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

936

},

937

],

Sai Cheemalapati

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

[diff] [blame]

938

},

Bu Sun Kim

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

[diff] [blame]

939

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

940

# disabled when this config is unspecified.

941

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

942

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

943

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

944

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

945

},

946

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

947

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

948

# second BigQuery table will be created to hold resource consumption

949

# records.

950

},

Bu Sun Kim

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

[diff] [blame]

951

},

Bu Sun Kim

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

[diff] [blame]

952

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

953

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

954

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

955

# firewall and routes quota.

956

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

957

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

958

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

959

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

960

#

961

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

Bu Sun Kim

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

[diff] [blame]

962

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

963

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

964

# the following restrictions:

965

#

966

# * Lowercase letters, numbers, and hyphens only.

967

# * Must start with a letter.

968

# * Must end with a number or a letter.

Bu Sun Kim

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

[diff] [blame]

969

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

970

# policies.

971

# policies.

972

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

973

},

974

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

975

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

976

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

977

# to which the cluster is connected. Example:

978

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

979

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

980

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

981

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

982

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

983

# cluster is connected. Example:

984

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

985

},

986

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

987

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

988

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

989

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

990

},

991

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

992

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

993

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

994

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

995

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

996

# private networking.

997

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

998

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

999

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

1000

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

1001

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

1002

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

1003

},

1004

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

1005

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

1006

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

1007

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

1008

# specified.

1009

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

1010

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

1011

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

1012

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

1013

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

1014

# the workload.

1015

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

1016

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

1017

# node pool.

1018

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

1019

# the Auto Upgrades will proceed.

1020

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

1021

# with the description of the upgrade.

1022

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

1023

# with the approximate start time for the upgrades, in

1024

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

1025

},

1026

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

1027

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

1028

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

1029

# triggered.

1030

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

1031

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

1032

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

1033

},

1034

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

1035

# disruption caused by an upgrade.

1036

#

1037

# maxUnavailable controls the number of nodes that can be simultaneously

1038

# unavailable.

1039

#

1040

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

1041

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

1042

# available nodes.

1043

#

1044

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

1045

# nodes are being upgraded at the same time).

1046

#

1047

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

1048

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

1049

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

1050

# PodDisruptionBudget, if it is configured.)

1051

#

1052

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

1053

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

1054

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

1055

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

1056

# there are always at least 4 nodes available.

1057

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

1058

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

1059

# Ready.

1060

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

1061

# of the node pool during the upgrade process.

1062

},

1063

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

1064

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

1065

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

1066

# firewall and routes quota.

1067

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

1068

# node pool instance, if available.

1069

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

1070

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

1071

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

1072

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

1073

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

1074

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

1075

},

1076

],

1077

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

1078

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

1079

#

1080

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

1081

"bootDiskKmsKey": "A String", #

1082

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

1083

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

1084

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

1085

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

1086

# see:

1087

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

1088

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

1089

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1090

#

1091

# Enables monitoring and attestation of the boot integrity of the instance.

1092

# The attestation is performed against the integrity policy baseline. This

1093

# baseline is initially derived from the implicitly trusted boot image when

1094

# the instance is created.

1095

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1096

#

1097

# Secure Boot helps ensure that the system only runs authentic software by

1098

# verifying the digital signature of all boot components, and halting the

1099

# boot process if signature verification fails.

1100

},

1101

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

1102

# These will added in addition to any default label(s) that

1103

# Kubernetes may apply to the node.

1104

# In case of conflict in label keys, the applied set may differ depending on

1105

# the Kubernetes version -- it's best to assume the behavior is undefined

1106

# and conflicts should be avoided.

1107

# For more information, including usage and the valid values, see:

1108

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

1109

"a_key": "A String",

1110

},

1111

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

1112

# node VMs under the "default" service account.

1113

#

1114

# The following scopes are recommended, but not required, and by default are

1115

# not included:

1116

#

1117

# * `https://www.googleapis.com/auth/compute` is required for mounting

1118

# persistent storage on your nodes.

1119

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

1120

# communicating with **gcr.io**

1121

# (the [Google Container

1122

# Registry](https://cloud.google.com/container-registry/)).

1123

#

1124

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

1125

# Monitoring are enabled, in which case their required scopes will be added.

1126

"A String",

1127

],

1128

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

1129

# scheduled on the specified or newer CPU platform. Applicable values are the

1130

# friendly names of CPU platforms, such as

1131

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

1132

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

1133

# information, read [how to specify min CPU

1134

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1135

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

1136

#

1137

# The limit for this value is dependent upon the maximum number of

1138

# disks available on a machine per zone. See:

1139

# https://cloud.google.com/compute/docs/disks/local-ssd

1140

# for more information.

1141

"taints": [ # List of kubernetes taints to be applied to each node.

1142

#

1143

# For more information, including usage and the valid values, see:

1144

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1145

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

1146

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

1147

#

1148

# See

1149

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

1150

# for more information, including usage and the valid values.

1151

"value": "A String", # Value for taint.

1152

"key": "A String", # Key for taint.

1153

"effect": "A String", # Effect for taint.

1154

},

1155

],

1156

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

1157

# the latest version of it will be used.

1158

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

1159

# the specified [Zonal Compute

1160

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

1161

# to this node pool.

1162

# is the configuration of desired reservation which instances could take

1163

# capacity from.

1164

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1165

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

1166

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

1167

# the key and specify the name of your reservation as its value.

1168

"values": [ # Corresponds to the label value(s) of reservation resource(s).

"A String",

],

},

"machineType": "A String", # The name of a Google Compute Engine [machine

1173

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

1174

# `n1-standard-1`).

1175

#

1176

# If unspecified, the default machine type is

1177

# `n1-standard-1`.

1178

"nodeGroup": "A String", # Setting this field will assign instances of this

1179

# pool to run on the specified node group. This is useful for running

1180

# workloads on [sole tenant

1181

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

1182

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

1183

#

1184

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

1185

# in length. These are reflected as part of a URL in the metadata server.

1186

# Additionally, to avoid ambiguity, keys must not conflict with any other

1187

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

1193

# "enable-os-login"

1194

# "gci-ensure-gke-docker"

1195

# "gci-metrics-enabled"

1196

# "gci-update-strategy"

1197

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

1202

# "windows-startup-script-ps1"

1203

# "common-psm1"

1204

# "k8s-node-setup-psm1"

1205

# "install-ssh-psm1"

1206

# "user-profile-psm1"

1207

# "serial-port-logging-enable"

1208

#

1209

# Values are free-form strings, and only have meaning as interpreted by

1210

# the image running in the instance. The only restriction placed on them is

1211

# that each value's size must be less than or equal to 32 KB.

1212

#

1213

# The total size of all keys and values must be less than 512 KB.

1214

"a_key": "A String",

1215

},

1216

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

1217

# valid sources or targets for network firewalls and are specified by

1218

# the client during cluster or node pool creation. Each tag within the list

1219

# must comply with RFC1035.

1220

"A String",

1221

],

1222

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1223

"type": "A String", # Type of the sandbox to use for the node.

1224

},

1225

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

1226

# https://cloud.google.com/compute/docs/instances/preemptible for more

1227

# information about preemptible VM instances.

1228

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

1229

# workloads on the node pool.

1230

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

1231

# on the node pool.

1232

},

1233

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

1234

# The smallest allowed disk size is 10GB.

1235

#

1236

# If unspecified, the default disk size is 100GB.

1237

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

1238

# Specify the email address of the Service Account; otherwise, if no Service

1239

# Account is specified, the "default" service account is used.

1240

"accelerators": [ # A list of hardware accelerators to be attached to each node.

1241

# See https://cloud.google.com/compute/docs/gpus for more information about

1242

# support for GPUs.

1243

{ # AcceleratorConfig represents a Hardware Accelerator request.

1244

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

1245

# [here](https://cloud.google.com/compute/docs/gpus)

1246

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

},

],

},

"name": "A String", # The name of the node pool.

1251

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

1252

# simultaneously on a node in the node pool.

1253

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1254

},

1255

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

1256

# only if a valid configuration is present.

1257

# adjust the size of the node pool to the current cluster usage.

1258

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

1259

# max_node_count.

1260

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

1261

# has to enough quota to scale up the cluster.

1262

"enabled": True or False, # Is autoscaling enabled for this node pool.

1263

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

1264

},

1265

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

1266

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

1267

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

1268

# associated with this node pool.

1269

"A String",

1270

],

1271

"status": "A String", # [Output only] The status of the nodes in this pool instance.

1272

"locations": [ # The list of Google Compute Engine

1273

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1274

# NodePool's nodes should be located.

"A String",

],

},

],

"subnetwork": "A String", # The name of the Google Compute Engine

1280

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

1281

# the cluster is connected.

1282

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

1283

# cluster, enabling additional functionality.

1284

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

1285

# This addon is deprecated, and will be disabled in 1.15. It is recommended

1286

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

1287

# workloads and applications. For more information, see:

1288

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

1289

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

1290

},

1291

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

1292

# managed Knative service.

1293

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1294

},

1295

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

1296

# makes it easy to set up HTTP load balancers for services in a cluster.

1297

# which makes it easy to set up HTTP load balancers for services in a cluster.

1298

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

1299

# When enabled, it runs a small pod in the cluster that manages the load

1300

# balancers.

1301

},

1302

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

1303

# increases or decreases the number of replica pods a replication controller

1304

# has based on the resource usage of the existing pods.

1305

# increases or decreases the number of replica pods a replication controller

1306

# has based on the resource usage of the existing pods.

1307

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

1308

# When enabled, it ensures that metrics are collected into Stackdriver

1309

# Monitoring.

1310

},

1311

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

1312

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

1313

},

1314

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

1315

# is enabled or not on the Master, it does not track whether network policy

1316

# is enabled for the nodes.

1317

# is enabled or not on the Master, it does not track whether network policy

1318

# is enabled for the nodes.

1319

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1320

},

1321

},

1322

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

1323

# If unspecified, the defaults are used:

1324

# For clusters before v1.12, if master_auth is unspecified, `username` will

1325

# be set to "admin", a random password will be generated, and a client

1326

# certificate will be issued.

1327

# Authentication can be done using HTTP basic auth or using client

1328

# certificates.

1329

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

1330

# to the cluster endpoint.

1331

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

1332

# authenticate to the cluster endpoint.

1333

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

1334

# For clusters v1.6.0 and later, basic authentication can be disabled by

1335

# leaving username unspecified (or setting it to the empty string).

1336

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

1337

# Because the master endpoint is open to the Internet, you should create a

1338

# strong password. If a password is provided for cluster creation, username

1339

# must be non-empty.

1340

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

1341

# clusters before v1.12, if no configuration is specified, a client

1342

# certificate is issued.

1343

"issueClientCertificate": True or False, # Issue a client certificate.

1344

},

1345

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

1346

# trust for the cluster.

1347

},

1348

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

1349

# required by Vertical Pod Autoscaler to automatically adjust

1350

# the resources of pods controlled by it.

1351

"enabled": True or False, # Enables vertical pod autoscaling.

1352

},

1353

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

1354

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

1355

# found in validMasterVersions returned by getServerConfig. The version can

1356

# be upgraded over time; such upgrades are reflected in

1357

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1358

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1359

# Users may specify either explicit versions offered by

1360

# Kubernetes Engine or version aliases, which have the following behavior:

1361

#

1362

# - "latest": picks the highest valid Kubernetes version

1363

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

1364

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

1365

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

1366

# - "","-": picks the default Kubernetes version

1367

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

1368

# Call Kubernetes API directly to retrieve node information.

1369

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

1370

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1371

# notation (e.g. `1.2.3.4/29`).

1372

"locations": [ # The list of Google Compute Engine

1373

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1374

# cluster's nodes should be located.

1375

"A String",

1376

],

1377

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1378

"description": "A String", # An optional description of this cluster.

1379

"statusMessage": "A String", # [Output only] Additional information about the current status of this

1380

# cluster, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1381

"location": "A String", # [Output only] The name of the Google Compute Engine

1382

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1383

# or

1384

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1385

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1386

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

1387

# this cluster, in

1388

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1389

# notation (e.g. `1.2.3.4/29`). Service addresses are

1390

# typically put in the last `/16` from the container CIDR.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1391

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1392

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

1393

# number](https://support.google.com/cloud/answer/6158840).

1394

# This field has been deprecated and replaced by the parent field.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1395

}

1396

1397

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1398

Allowed values

1399

1 - v1 error format

1400

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1401

1402

Returns:

1403

An object of the form:

1404

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1405

{ # This operation resource represents operations that may have happened or are

1406

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1407

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1408

"name": "A String", # A non-parameterized string describing an operation stage.

1409

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1410

"metrics": [ # Progress metric bundle, for example:

1411

# metrics: [{name: "nodes done", int_value: 15},

1412

# {name: "nodes total", int_value: 32}]

1413

# or

1414

# metrics: [{name: "progress", double_value: 0.56},

1415

# {name: "progress scale", double_value: 1.0}]

1416

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1417

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1418

"doubleValue": 3.14, # For metrics with floating point value.

1419

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1420

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1421

},

1422

],

1423

"status": "A String", # Status of an operation stage.

1424

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1425

"stages": [ # Substages of an operation or a stage.

1426

# Object with schema name: OperationProgress

1427

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1428

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1429

"targetLink": "A String", # Server-defined URL for the target of the operation.

1430

"status": "A String", # The current status of the operation.

1431

"operationType": "A String", # The operation type.

1432

"startTime": "A String", # [Output only] The time the operation started, in

1433

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1434

"clusterConditions": [ # Which conditions caused the current cluster state.

1435

{ # StatusCondition describes why a cluster or a node pool has a certain status

1436

# (e.g., ERROR or DEGRADED).

1437

"message": "A String", # Human-friendly representation of the condition

1438

"code": "A String", # Machine-friendly representation of the condition

1439

},

1440

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1441

"zone": "A String", # The name of the Google Compute Engine

1442

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1443

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1444

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1445

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1446

"detail": "A String", # Detailed operation progress, if available.

1447

"endTime": "A String", # [Output only] The time the operation completed, in

1448

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1449

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1450

{ # StatusCondition describes why a cluster or a node pool has a certain status

1451

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1452

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1453

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1454

},

1455

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1456

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1457

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1458

# or

1459

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1460

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1461

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1466

<code class="details" id="delete">delete(projectId, zone, clusterId, name=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1467

<pre>Deletes the cluster, including the Kubernetes endpoint and all worker

1468

nodes.

1469

1470

Firewalls and routes that were configured during cluster creation

1471

are also deleted.

1472

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1473

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]

1474

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]

1475

when the cluster was initially created.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1476

1477

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1478

projectId: string, Deprecated. The Google Developers Console [project ID or project

1479

number](https://support.google.com/cloud/answer/6158840).

1480

This field has been deprecated and replaced by the name field. (required)

1481

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1482

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1483

cluster resides. This field has been deprecated and replaced by the name

1484

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1485

clusterId: string, Deprecated. The name of the cluster to delete.

1486

This field has been deprecated and replaced by the name field. (required)

1487

name: string, The name (project, location, cluster) of the cluster to delete.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1488

Specified in the format `projects/*/locations/*/clusters/*`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1489

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1490

Allowed values

1491

1 - v1 error format

1492

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1493

1494

Returns:

1495

An object of the form:

1496

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1497

{ # This operation resource represents operations that may have happened or are

1498

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1499

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1500

"name": "A String", # A non-parameterized string describing an operation stage.

1501

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1502

"metrics": [ # Progress metric bundle, for example:

1503

# metrics: [{name: "nodes done", int_value: 15},

1504

# {name: "nodes total", int_value: 32}]

1505

# or

1506

# metrics: [{name: "progress", double_value: 0.56},

1507

# {name: "progress scale", double_value: 1.0}]

1508

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1509

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1510

"doubleValue": 3.14, # For metrics with floating point value.

1511

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1512

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1513

},

1514

],

1515

"status": "A String", # Status of an operation stage.

1516

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1517

"stages": [ # Substages of an operation or a stage.

1518

# Object with schema name: OperationProgress

1519

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1520

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1521

"targetLink": "A String", # Server-defined URL for the target of the operation.

1522

"status": "A String", # The current status of the operation.

1523

"operationType": "A String", # The operation type.

1524

"startTime": "A String", # [Output only] The time the operation started, in

1525

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1526

"clusterConditions": [ # Which conditions caused the current cluster state.

1527

{ # StatusCondition describes why a cluster or a node pool has a certain status

1528

# (e.g., ERROR or DEGRADED).

1529

"message": "A String", # Human-friendly representation of the condition

1530

"code": "A String", # Machine-friendly representation of the condition

1531

},

1532

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1533

"zone": "A String", # The name of the Google Compute Engine

1534

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1535

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1536

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1537

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1538

"detail": "A String", # Detailed operation progress, if available.

1539

"endTime": "A String", # [Output only] The time the operation completed, in

1540

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1541

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1542

{ # StatusCondition describes why a cluster or a node pool has a certain status

1543

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1544

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1545

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1546

},

1547

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1548

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1549

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1550

# or

1551

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

1552

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1553

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1558

<code class="details" id="get">get(projectId, zone, clusterId, name=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1559

<pre>Gets the details of a specific cluster.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1560

1561

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1562

projectId: string, Deprecated. The Google Developers Console [project ID or project

1563

number](https://support.google.com/cloud/answer/6158840).

1564

This field has been deprecated and replaced by the name field. (required)

1565

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1566

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

1567

cluster resides. This field has been deprecated and replaced by the name

1568

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1569

clusterId: string, Deprecated. The name of the cluster to retrieve.

1570

This field has been deprecated and replaced by the name field. (required)

1571

name: string, The name (project, location, cluster) of the cluster to retrieve.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1572

Specified in the format `projects/*/locations/*/clusters/*`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1573

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1574

Allowed values

1575

1 - v1 error format

1576

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1577

1578

Returns:

1579

An object of the form:

1580

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1581

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1582

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

1583

"currentNodeVersion": "A String", # [Output only] Deprecated, use

1584

# [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools)

1585

# instead. The current version of the node software components. If they are

1586

# currently at multiple versions because they're in the process of being

1587

# upgraded, this reflects the minimum version of all nodes.

1588

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

1589

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

1590

# if enabled = true.

1591

"enabled": True or False, # Whether this cluster should return group membership lookups

1592

# during authentication using a group of security groups.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1593

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1594

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

1595

# API groups (e.g. v1alpha1) and features that may not be production ready in

1596

# the kubernetes version of the master and nodes.

1597

# The cluster has no SLA for uptime and master/node upgrades are disabled.

1598

# Alpha enabled clusters are automatically deleted thirty days after

1599

# creation.

1600

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

1601

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services

1602

# CIDR block. The secondary range will be used for service

1603

# ClusterIPs. This must be an existing secondary range associated

1604

# with the cluster subnetwork.

1605

#

1606

# This field is only applicable with use_ip_aliases is true and

1607

# create_subnetwork is false.

1608

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

1609

# this field is empty, then an automatic name will be chosen for the new

1610

# subnetwork.

1611

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1612

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range

1613

# will be automatically chosen with the default size.

1614

#

1615

# This field is only applicable when `use_ip_aliases` is true.

1616

#

1617

# Set to blank to have a range chosen with the default size.

1618

#

1619

# 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)

1624

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1625

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1626

# to use.

1627

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

1628

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

1629

# block. The secondary range will be used for pod IP

1630

# addresses. This must be an existing secondary range associated

1631

# with the cluster subnetwork.

1632

#

1633

# This field is only applicable with use_ip_aliases is true and

1634

# create_subnetwork is false.

1635

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a

1636

# range will be automatically chosen with the default size.

1637

#

1638

# This field is only applicable when `use_ip_aliases` is true.

1639

#

1640

# If unspecified, the range will use the default size.

1641

#

1642

# 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)

1647

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1648

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1649

# to use.

1650

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

1651

#

1652

# This is applicable only if `create_subnetwork` is true.

1653

#

1654

# Set to blank to have a range chosen with the default size.

1655

#

1656

# 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)

1661

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1662

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1663

# to use.

1664

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

1665

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

1666

#

1667

# This field is only applicable when `use_ip_aliases` is true.

1668

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

1669

# `cluster.cluster_ipv4_cidr` must be left blank.

1670

#

1671

# This field is only applicable when `use_ip_aliases` is true.

1672

#

1673

# Set to blank to have a range chosen with the default size.

1674

#

1675

# 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)

1680

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1681

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1682

# to use.

1683

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

1684

},

1685

"loggingService": "A String", # The logging service the cluster should use to write logs.

1686

# Currently available options:

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1687

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1688

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

1689

# service with a Kubernetes-native resource model

1690

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

1691

# available as of GKE 1.15).

1692

# * `none` - no logs will be exported from the cluster.

1693

#

1694

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

1695

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

1696

"zone": "A String", # [Output only] The name of the Google Compute Engine

1697

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

1698

# cluster resides. This field is deprecated, use location instead.

1699

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

1700

# mode.

1701

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

1702

# identities in the system, including service accounts, nodes, and

1703

# controllers, will have statically granted permissions beyond those

1704

# provided by the RBAC configuration or IAM.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1705

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1706

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

1707

# Google Compute Engine resources.

1708

"a_key": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1709

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1710

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1711

# containers. This is provisioned from within the `container_ipv4_cidr`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1712

# range. This field will only be set when cluster is in route-based network

1713

# mode.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1714

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

1715

# subscribed to. Release channels are arranged in order of risk.

1716

#

1717

# When a cluster is subscribed to a release channel, Google maintains

1718

# both the master version and the node version. Node auto-upgrade

1719

# defaults to true and cannot be disabled.

1720

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1721

},

1722

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

1723

"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]

1724

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

1725

# occur in these windows.

1726

"a_key": { # Represents an arbitrary window of time.

1727

"endTime": "A String", # The time that the window ends. The end time should take place after the

1728

# start time.

1729

"startTime": "A String", # The time that the window first starts.

1730

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1731

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1732

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1733

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

1734

# smallest possible in the given scenario.

1735

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

1736

# format "PTnHnMnS".

1737

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

1738

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

1739

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

1740

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1741

"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]

1742

# maintenance to occur. The time windows may be overlapping. If no

1743

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1744

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

1745

"endTime": "A String", # The time that the window ends. The end time should take place after the

1746

# start time.

1747

"startTime": "A String", # The time that the window first starts.

1748

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1749

"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]

1750

# this window reccurs. They go on for the span of time between the start and

1751

# end time.

1752

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1753

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1754

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

1755

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

1756

# <code>FREQ=DAILY</code>

1757

# For the first weekend of every month:

1758

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

1759

# 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]

1760

# 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]

1761

# <code>

1762

# start time = 2019-01-01T09:00:00-0400

1763

# end time = 2019-01-01T17:00:00-0400

1764

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

1765

# </code>

1766

# Windows can span multiple days. Eg, to make the window encompass every

1767

# weekend from midnight Saturday till the last minute of Sunday UTC:

1768

# <code>

1769

# start time = 2019-01-05T00:00:00Z

1770

# end time = 2019-01-07T23:59:00Z

1771

# recurrence = FREQ=WEEKLY;BYDAY=SA

1772

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1773

# 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]

1774

# to specify duration of the window and when it first starts.

1775

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1776

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1777

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1778

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

1779

# the policy won't accidentally undo intermediate changes (and so that users

1780

# of the API unaware of some fields won't accidentally remove other fields).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1781

# Make a <code>get()</code> request to the cluster to get the current

1782

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1783

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1784

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

1785

# Currently available options:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1786

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1787

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

1788

# service with a Kubernetes-native resource model

1789

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

1790

# longer available as of GKE 1.15).

1791

# * `none` - No metrics will be exported from the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1792

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1793

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

1794

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

1795

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

1796

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

1797

# images will be validated by Binary Authorization.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1798

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1799

"expireTime": "A String", # [Output only] The time the cluster will be automatically

1800

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1801

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1802

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1803

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1804

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

1805

# The endpoint can be accessed from the internet at

1806

# `https://username:password@endpoint/`.

1807

#

1808

# See the `masterAuth` property of this resource for username and

1809

# password information.

1810

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

1811

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

1812

},

1813

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

1814

# master authorized networks will disallow all external traffic to access

1815

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

1816

# Google Compute Engine Public IPs and Google Prod IPs.

1817

"enabled": True or False, # Whether or not master authorized networks is enabled.

1818

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

1819

# Kubernetes master through HTTPS.

1820

{ # CidrBlock contains an optional name and one CIDR block.

1821

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

1822

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1823

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1824

],

1825

},

1826

"conditions": [ # Which conditions caused the current cluster state.

1827

{ # StatusCondition describes why a cluster or a node pool has a certain status

1828

# (e.g., ERROR or DEGRADED).

1829

"message": "A String", # Human-friendly representation of the condition

1830

"code": "A String", # Machine-friendly representation of the condition

1831

},

1832

],

1833

"network": "A String", # The name of the Google Compute Engine

1834

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

1835

# to which the cluster is connected. If left unspecified, the `default`

1836

# network will be used.

1837

"status": "A String", # [Output only] The current status of this cluster.

1838

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

1839

# required by Cluster Autoscaler to automatically adjust

1840

# the size of the cluster and create/delete

1841

# node pools based on the current needs.

1842

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

1843

# amount of resources in the cluster.

1844

{ # Contains information about amount of some resource in the cluster.

1845

# For memory, value should be in GB.

1846

"minimum": "A String", # Minimum amount of the resource in the cluster.

1847

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

1848

"maximum": "A String", # Maximum amount of the resource in the cluster.

1849

},

1850

],

1851

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

1852

# created by NAP.

1853

# by NAP.

1854

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

1855

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

1856

# node pool.

1857

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

1858

# the Auto Upgrades will proceed.

1859

"description": "A String", # [Output only] This field is set when upgrades are about to commence

1860

# with the description of the upgrade.

1861

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

1862

# with the approximate start time for the upgrades, in

1863

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1864

},

1865

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

1866

# pool. If enabled, the nodes in this node pool will be monitored and, if

1867

# they fail health checks too many times, an automatic repair action will be

1868

# triggered.

1869

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

1870

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

1871

# up to date with the latest release version of Kubernetes.

1872

},

1873

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1874

# disruption caused by an upgrade.

1875

#

1876

# maxUnavailable controls the number of nodes that can be simultaneously

1877

# unavailable.

1878

#

1879

# maxSurge controls the number of additional nodes that can be added to the

1880

# node pool temporarily for the time of the upgrade to increase the number of

1881

# available nodes.

1882

#

1883

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

1884

# nodes are being upgraded at the same time).

1885

#

1886

# Note: upgrades inevitably introduce some disruption since workloads need to

1887

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

1888

# this holds true. (Disruption stays within the limits of

1889

# PodDisruptionBudget, if it is configured.)

1890

#

1891

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

1892

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

1893

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

1894

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

1895

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1896

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1897

# the upgrade process. A node is considered available if its status is

1898

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1899

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

1900

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1901

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1902

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1903

"A String",

1904

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1905

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1906

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

1907

"autoprovisioningLocations": [ # The list of Google Compute Engine

1908

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

1909

# NodePool's nodes can be created by NAP.

"A String",

],

},

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1914

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

1915

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1916

"enabled": True or False, # Whether network policy is enabled on the cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1917

"provider": "A String", # The selected network policy provider.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1918

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1919

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1920

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1921

# notation (e.g. `10.96.0.0/14`). Leave blank to have

1922

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

1923

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

1924

# simultaneously on a node in the node pool of this cluster. Only honored

1925

# if cluster created with IP Alias support.

1926

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1927

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1928

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1929

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1930

# "node_pool" object, since this configuration (along with the

1931

# "initial_node_count") will be used to create a "NodePool" object with an

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1932

# auto-generated name. Do not use this and a node_pool at the same time.

1933

# For responses, this field will be populated with the node configuration of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1934

# the first node pool. (For configuration of each node pool, see

1935

# `node_pool.config`)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1936

#

1937

# If unspecified, the defaults are used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1938

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1939

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

1940

#

1941

# If unspecified, the default disk type is 'pd-standard'

1942

"bootDiskKmsKey": "A String", #

1943

# The Customer Managed Encryption Key used to encrypt the boot disk attached

1944

# to each node in the node pool. This should be of the form

1945

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

1946

# For more information about protecting resources with Cloud KMS Keys please

1947

# see:

1948

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

1949

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1950

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1951

#

1952

# Enables monitoring and attestation of the boot integrity of the instance.

1953

# The attestation is performed against the integrity policy baseline. This

1954

# baseline is initially derived from the implicitly trusted boot image when

1955

# the instance is created.

1956

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1957

#

1958

# Secure Boot helps ensure that the system only runs authentic software by

1959

# verifying the digital signature of all boot components, and halting the

1960

# boot process if signature verification fails.

1961

},

1962

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

1963

# These will added in addition to any default label(s) that

1964

# Kubernetes may apply to the node.

1965

# In case of conflict in label keys, the applied set may differ depending on

1966

# the Kubernetes version -- it's best to assume the behavior is undefined

1967

# and conflicts should be avoided.

1968

# For more information, including usage and the valid values, see:

1969

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

1970

"a_key": "A String",

1971

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1972

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

1973

# node VMs under the "default" service account.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1974

#

1975

# The following scopes are recommended, but not required, and by default are

1976

# not included:

1977

#

1978

# * `https://www.googleapis.com/auth/compute` is required for mounting

1979

# persistent storage on your nodes.

1980

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

1981

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1982

# (the [Google Container

1983

# Registry](https://cloud.google.com/container-registry/)).

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1984

#

1985

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

1986

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1987

"A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1988

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1989

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

1990

# scheduled on the specified or newer CPU platform. Applicable values are the

1991

# friendly names of CPU platforms, such as

1992

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

1993

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

1994

# information, read [how to specify min CPU

1995

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1996

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

1997

#

1998

# The limit for this value is dependent upon the maximum number of

1999

# disks available on a machine per zone. See:

2000

# https://cloud.google.com/compute/docs/disks/local-ssd

2001

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2002

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2003

#

2004

# For more information, including usage and the valid values, see:

2005

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2006

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2007

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2008

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2009

# See

2010

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2011

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2012

"value": "A String", # Value for taint.

2013

"key": "A String", # Key for taint.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2014

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2015

},

2016

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2017

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2018

# the latest version of it will be used.

2019

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2020

# the specified [Zonal Compute

2021

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2022

# to this node pool.

2023

# is the configuration of desired reservation which instances could take

2024

# capacity from.

2025

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2026

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2027

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2028

# the key and specify the name of your reservation as its value.

2029

"values": [ # Corresponds to the label value(s) of reservation resource(s).

2030

"A String",

2031

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2032

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2033

"machineType": "A String", # The name of a Google Compute Engine [machine

2034

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2035

# `n1-standard-1`).

2036

#

2037

# If unspecified, the default machine type is

2038

# `n1-standard-1`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2039

"nodeGroup": "A String", # Setting this field will assign instances of this

2040

# pool to run on the specified node group. This is useful for running

2041

# workloads on [sole tenant

2042

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2043

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2044

#

2045

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2046

# in length. These are reflected as part of a URL in the metadata server.

2047

# Additionally, to avoid ambiguity, keys must not conflict with any other

2048

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2054

# "enable-os-login"

2055

# "gci-ensure-gke-docker"

2056

# "gci-metrics-enabled"

2057

# "gci-update-strategy"

2058

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2063

# "windows-startup-script-ps1"

2064

# "common-psm1"

2065

# "k8s-node-setup-psm1"

2066

# "install-ssh-psm1"

2067

# "user-profile-psm1"

2068

# "serial-port-logging-enable"

2069

#

2070

# Values are free-form strings, and only have meaning as interpreted by

2071

# the image running in the instance. The only restriction placed on them is

2072

# that each value's size must be less than or equal to 32 KB.

2073

#

2074

# The total size of all keys and values must be less than 512 KB.

2075

"a_key": "A String",

2076

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2077

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

2078

# valid sources or targets for network firewalls and are specified by

2079

# the client during cluster or node pool creation. Each tag within the list

2080

# must comply with RFC1035.

2081

"A String",

2082

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2083

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2084

"type": "A String", # Type of the sandbox to use for the node.

2085

},

2086

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2087

# https://cloud.google.com/compute/docs/instances/preemptible for more

2088

# information about preemptible VM instances.

2089

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2090

# workloads on the node pool.

2091

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2092

# on the node pool.

2093

},

2094

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2095

# The smallest allowed disk size is 10GB.

2096

#

2097

# If unspecified, the default disk size is 100GB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2098

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

2099

# Specify the email address of the Service Account; otherwise, if no Service

2100

# Account is specified, the "default" service account is used.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2101

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2102

# See https://cloud.google.com/compute/docs/gpus for more information about

2103

# support for GPUs.

2104

{ # AcceleratorConfig represents a Hardware Accelerator request.

2105

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2106

# [here](https://cloud.google.com/compute/docs/gpus)

2107

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

2108

},

2109

],

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2110

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2111

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

2112

# disabled when this config is unspecified.

2113

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

2114

# daemonset will be created in the cluster to meter network egress traffic.

2115

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2116

"datasetId": "A String", # The ID of a BigQuery Dataset.

2117

},

2118

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

2119

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

2120

# second BigQuery table will be created to hold resource consumption

2121

# records.

2122

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2123

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2124

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

2125

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

2126

# is sufficient for this number of instances. You must also have available

2127

# firewall and routes quota.

2128

# For requests, this field should only be used in lieu of a

2129

# "node_pool" object, since this configuration (along with the

2130

# "node_config") will be used to create a "NodePool" object with an

2131

# auto-generated name. Do not use this and a node_pool at the same time.

2132

#

2133

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2134

"name": "A String", # The name of this cluster. The name must be unique within this project

2135

# and location (e.g. zone or region), and can be up to 40 characters with

2136

# the following restrictions:

2137

#

2138

# * Lowercase letters, numbers, and hyphens only.

2139

# * Must start with a letter.

2140

# * Must end with a number or a letter.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2141

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

2142

# policies.

2143

# policies.

2144

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

2145

},

2146

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

2147

"network": "A String", # Output only. The relative name of the Google Compute Engine

2148

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2149

# to which the cluster is connected. Example:

2150

# projects/my-project/global/networks/my-network

2151

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

2152

# This makes same node pod to pod traffic visible for VPC network.

2153

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

2154

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

2155

# cluster is connected. Example:

2156

# projects/my-project/regions/us-central1/subnetworks/my-subnet

2157

},

2158

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2159

"state": "A String", # Denotes the state of etcd encryption.

2160

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

2161

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

2162

},

2163

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

2164

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

2165

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

2166

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

2167

# given only RFC 1918 private addresses and communicate with the master via

2168

# private networking.

2169

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

2170

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

2171

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

2172

# range will be used for assigning internal IP addresses to the master or

2173

# set of masters, as well as the ILB VIP. This range must not overlap with

2174

# any other ranges in use within the cluster's network.

2175

},

2176

"createTime": "A String", # [Output only] The time the cluster was created, in

2177

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2178

"nodePools": [ # The node pools associated with this cluster.

2179

# This field should not be set if "node_config" or "initial_node_count" are

2180

# specified.

2181

{ # NodePool contains the name and configuration for a cluster's node pool.

2182

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

2183

# specification, under the control of the cluster master. They may have a set

2184

# of Kubernetes labels applied to them, which may be used to reference them

2185

# during pod scheduling. They may also be resized up or down, to accommodate

2186

# the workload.

2187

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2188

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

2189

# node pool.

2190

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2191

# the Auto Upgrades will proceed.

2192

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2193

# with the description of the upgrade.

2194

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2195

# with the approximate start time for the upgrades, in

2196

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2197

},

2198

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

2199

# pool. If enabled, the nodes in this node pool will be monitored and, if

2200

# they fail health checks too many times, an automatic repair action will be

2201

# triggered.

2202

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

2203

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

2204

# up to date with the latest release version of Kubernetes.

2205

},

2206

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

2207

# disruption caused by an upgrade.

2208

#

2209

# maxUnavailable controls the number of nodes that can be simultaneously

2210

# unavailable.

2211

#

2212

# maxSurge controls the number of additional nodes that can be added to the

2213

# node pool temporarily for the time of the upgrade to increase the number of

2214

# available nodes.

2215

#

2216

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2217

# nodes are being upgraded at the same time).

2218

#

2219

# Note: upgrades inevitably introduce some disruption since workloads need to

2220

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

2221

# this holds true. (Disruption stays within the limits of

2222

# PodDisruptionBudget, if it is configured.)

2223

#

2224

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

2225

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

2226

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

2227

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

2228

# there are always at least 4 nodes available.

2229

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

2230

# the upgrade process. A node is considered available if its status is

2231

# Ready.

2232

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

2233

# of the node pool during the upgrade process.

2234

},

2235

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

2236

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

2237

# is sufficient for this number of instances. You must also have available

2238

# firewall and routes quota.

2239

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2240

# node pool instance, if available.

2241

"version": "A String", # The version of the Kubernetes of this node.

2242

"conditions": [ # Which conditions caused the current node pool state.

2243

{ # StatusCondition describes why a cluster or a node pool has a certain status

2244

# (e.g., ERROR or DEGRADED).

2245

"message": "A String", # Human-friendly representation of the condition

2246

"code": "A String", # Machine-friendly representation of the condition

2247

},

2248

],

2249

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

2250

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

2251

#

2252

# If unspecified, the default disk type is 'pd-standard'

2253

"bootDiskKmsKey": "A String", #

2254

# The Customer Managed Encryption Key used to encrypt the boot disk attached

2255

# to each node in the node pool. This should be of the form

2256

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

2257

# For more information about protecting resources with Cloud KMS Keys please

2258

# see:

2259

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

2260

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2261

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2262

#

2263

# Enables monitoring and attestation of the boot integrity of the instance.

2264

# The attestation is performed against the integrity policy baseline. This

2265

# baseline is initially derived from the implicitly trusted boot image when

2266

# the instance is created.

2267

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2268

#

2269

# Secure Boot helps ensure that the system only runs authentic software by

2270

# verifying the digital signature of all boot components, and halting the

2271

# boot process if signature verification fails.

2272

},

2273

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

2274

# These will added in addition to any default label(s) that

2275

# Kubernetes may apply to the node.

2276

# In case of conflict in label keys, the applied set may differ depending on

2277

# the Kubernetes version -- it's best to assume the behavior is undefined

2278

# and conflicts should be avoided.

2279

# For more information, including usage and the valid values, see:

2280

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

2281

"a_key": "A String",

2282

},

2283

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

2284

# node VMs under the "default" service account.

2285

#

2286

# The following scopes are recommended, but not required, and by default are

2287

# not included:

2288

#

2289

# * `https://www.googleapis.com/auth/compute` is required for mounting

2290

# persistent storage on your nodes.

2291

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

2292

# communicating with **gcr.io**

2293

# (the [Google Container

2294

# Registry](https://cloud.google.com/container-registry/)).

2295

#

2296

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

2297

# Monitoring are enabled, in which case their required scopes will be added.

2298

"A String",

2299

],

2300

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

2301

# scheduled on the specified or newer CPU platform. Applicable values are the

2302

# friendly names of CPU platforms, such as

2303

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

2304

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

2305

# information, read [how to specify min CPU

2306

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

2307

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

2308

#

2309

# The limit for this value is dependent upon the maximum number of

2310

# disks available on a machine per zone. See:

2311

# https://cloud.google.com/compute/docs/disks/local-ssd

2312

# for more information.

2313

"taints": [ # List of kubernetes taints to be applied to each node.

2314

#

2315

# For more information, including usage and the valid values, see:

2316

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

2317

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

2318

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

2319

#

2320

# See

2321

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

2322

# for more information, including usage and the valid values.

2323

"value": "A String", # Value for taint.

2324

"key": "A String", # Key for taint.

2325

"effect": "A String", # Effect for taint.

2326

},

2327

],

2328

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

2329

# the latest version of it will be used.

2330

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

2331

# the specified [Zonal Compute

2332

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

2333

# to this node pool.

2334

# is the configuration of desired reservation which instances could take

2335

# capacity from.

2336

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

2337

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

2338

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

2339

# the key and specify the name of your reservation as its value.

2340

"values": [ # Corresponds to the label value(s) of reservation resource(s).

"A String",

],

},

"machineType": "A String", # The name of a Google Compute Engine [machine

2345

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

2346

# `n1-standard-1`).

2347

#

2348

# If unspecified, the default machine type is

2349

# `n1-standard-1`.

2350

"nodeGroup": "A String", # Setting this field will assign instances of this

2351

# pool to run on the specified node group. This is useful for running

2352

# workloads on [sole tenant

2353

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

2354

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

2355

#

2356

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

2357

# in length. These are reflected as part of a URL in the metadata server.

2358

# Additionally, to avoid ambiguity, keys must not conflict with any other

2359

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

2365

# "enable-os-login"

2366

# "gci-ensure-gke-docker"

2367

# "gci-metrics-enabled"

2368

# "gci-update-strategy"

2369

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

2374

# "windows-startup-script-ps1"

2375

# "common-psm1"

2376

# "k8s-node-setup-psm1"

2377

# "install-ssh-psm1"

2378

# "user-profile-psm1"

2379

# "serial-port-logging-enable"

2380

#

2381

# Values are free-form strings, and only have meaning as interpreted by

2382

# the image running in the instance. The only restriction placed on them is

2383

# that each value's size must be less than or equal to 32 KB.

2384

#

2385

# The total size of all keys and values must be less than 512 KB.

2386

"a_key": "A String",

2387

},

2388

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

2389

# valid sources or targets for network firewalls and are specified by

2390

# the client during cluster or node pool creation. Each tag within the list

2391

# must comply with RFC1035.

2392

"A String",

2393

],

2394

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

2395

"type": "A String", # Type of the sandbox to use for the node.

2396

},

2397

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

2398

# https://cloud.google.com/compute/docs/instances/preemptible for more

2399

# information about preemptible VM instances.

2400

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

2401

# workloads on the node pool.

2402

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

2403

# on the node pool.

2404

},

2405

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

2406

# The smallest allowed disk size is 10GB.

2407

#

2408

# If unspecified, the default disk size is 100GB.

2409

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

2410

# Specify the email address of the Service Account; otherwise, if no Service

2411

# Account is specified, the "default" service account is used.

2412

"accelerators": [ # A list of hardware accelerators to be attached to each node.

2413

# See https://cloud.google.com/compute/docs/gpus for more information about

2414

# support for GPUs.

2415

{ # AcceleratorConfig represents a Hardware Accelerator request.

2416

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

2417

# [here](https://cloud.google.com/compute/docs/gpus)

2418

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

},

],

},

"name": "A String", # The name of the node pool.

2423

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

2424

# simultaneously on a node in the node pool.

2425

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

2426

},

2427

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

2428

# only if a valid configuration is present.

2429

# adjust the size of the node pool to the current cluster usage.

2430

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

2431

# max_node_count.

2432

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

2433

# has to enough quota to scale up the cluster.

2434

"enabled": True or False, # Is autoscaling enabled for this node pool.

2435

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2436

},

2437

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

2438

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

2439

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

2440

# associated with this node pool.

2441

"A String",

2442

],

2443

"status": "A String", # [Output only] The status of the nodes in this pool instance.

2444

"locations": [ # The list of Google Compute Engine

2445

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2446

# NodePool's nodes should be located.

"A String",

],

},

],

"subnetwork": "A String", # The name of the Google Compute Engine

2452

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

2453

# the cluster is connected.

2454

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

2455

# cluster, enabling additional functionality.

2456

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

2457

# This addon is deprecated, and will be disabled in 1.15. It is recommended

2458

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

2459

# workloads and applications. For more information, see:

2460

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

2461

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

2462

},

2463

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

2464

# managed Knative service.

2465

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2466

},

2467

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

2468

# makes it easy to set up HTTP load balancers for services in a cluster.

2469

# which makes it easy to set up HTTP load balancers for services in a cluster.

2470

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

2471

# When enabled, it runs a small pod in the cluster that manages the load

2472

# balancers.

2473

},

2474

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

2475

# increases or decreases the number of replica pods a replication controller

2476

# has based on the resource usage of the existing pods.

2477

# increases or decreases the number of replica pods a replication controller

2478

# has based on the resource usage of the existing pods.

2479

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

2480

# When enabled, it ensures that metrics are collected into Stackdriver

2481

# Monitoring.

2482

},

2483

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

2484

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

2485

},

2486

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

2487

# is enabled or not on the Master, it does not track whether network policy

2488

# is enabled for the nodes.

2489

# is enabled or not on the Master, it does not track whether network policy

2490

# is enabled for the nodes.

2491

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

2492

},

2493

},

2494

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

2495

# If unspecified, the defaults are used:

2496

# For clusters before v1.12, if master_auth is unspecified, `username` will

2497

# be set to "admin", a random password will be generated, and a client

2498

# certificate will be issued.

2499

# Authentication can be done using HTTP basic auth or using client

2500

# certificates.

2501

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

2502

# to the cluster endpoint.

2503

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

2504

# authenticate to the cluster endpoint.

2505

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

2506

# For clusters v1.6.0 and later, basic authentication can be disabled by

2507

# leaving username unspecified (or setting it to the empty string).

2508

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

2509

# Because the master endpoint is open to the Internet, you should create a

2510

# strong password. If a password is provided for cluster creation, username

2511

# must be non-empty.

2512

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

2513

# clusters before v1.12, if no configuration is specified, a client

2514

# certificate is issued.

2515

"issueClientCertificate": True or False, # Issue a client certificate.

2516

},

2517

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

2518

# trust for the cluster.

2519

},

2520

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

2521

# required by Vertical Pod Autoscaler to automatically adjust

2522

# the resources of pods controlled by it.

2523

"enabled": True or False, # Enables vertical pod autoscaling.

2524

},

2525

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

2526

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

2527

# found in validMasterVersions returned by getServerConfig. The version can

2528

# be upgraded over time; such upgrades are reflected in

2529

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2530

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2531

# Users may specify either explicit versions offered by

2532

# Kubernetes Engine or version aliases, which have the following behavior:

2533

#

2534

# - "latest": picks the highest valid Kubernetes version

2535

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

2536

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

2537

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

2538

# - "","-": picks the default Kubernetes version

2539

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

2540

# Call Kubernetes API directly to retrieve node information.

2541

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

2542

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2543

# notation (e.g. `1.2.3.4/29`).

2544

"locations": [ # The list of Google Compute Engine

2545

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

2546

# cluster's nodes should be located.

2547

"A String",

2548

],

2549

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

2550

"description": "A String", # An optional description of this cluster.

2551

"statusMessage": "A String", # [Output only] Additional information about the current status of this

2552

# cluster, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2553

"location": "A String", # [Output only] The name of the Google Compute Engine

2554

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2555

# or

2556

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2557

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2558

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

2559

# this cluster, in

2560

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

2561

# notation (e.g. `1.2.3.4/29`). Service addresses are

2562

# typically put in the last `/16` from the container CIDR.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2567

<code class="details" id="legacyAbac">legacyAbac(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2568

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2569

2570

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2571

projectId: string, Deprecated. The Google Developers Console [project ID or project

2572

number](https://support.google.com/cloud/answer/6158840).

2573

This field has been deprecated and replaced by the name field. (required)

2574

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2575

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

2576

cluster resides. This field has been deprecated and replaced by the name

2577

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2578

clusterId: string, Deprecated. The name of the cluster to update.

2579

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2580

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2581

The object takes the form of:

2582

2583

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for

2584

# a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2585

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac.

2586

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2587

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2588

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2589

# cluster resides. This field has been deprecated and replaced by the name

2590

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2591

"clusterId": "A String", # Deprecated. The name of the cluster to update.

2592

# This field has been deprecated and replaced by the name field.

2593

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

2594

# number](https://support.google.com/cloud/answer/6158840).

2595

# This field has been deprecated and replaced by the name field.

2596

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2597

}

2598

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2599

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2606

2607

{ # This operation resource represents operations that may have happened or are

2608

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2609

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2610

"name": "A String", # A non-parameterized string describing an operation stage.

2611

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2612

"metrics": [ # Progress metric bundle, for example:

2613

# metrics: [{name: "nodes done", int_value: 15},

2614

# {name: "nodes total", int_value: 32}]

2615

# or

2616

# metrics: [{name: "progress", double_value: 0.56},

2617

# {name: "progress scale", double_value: 1.0}]

2618

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2619

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2620

"doubleValue": 3.14, # For metrics with floating point value.

2621

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2622

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2623

},

2624

],

2625

"status": "A String", # Status of an operation stage.

2626

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2627

"stages": [ # Substages of an operation or a stage.

2628

# Object with schema name: OperationProgress

2629

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2630

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2631

"targetLink": "A String", # Server-defined URL for the target of the operation.

2632

"status": "A String", # The current status of the operation.

2633

"operationType": "A String", # The operation type.

2634

"startTime": "A String", # [Output only] The time the operation started, in

2635

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2636

"clusterConditions": [ # Which conditions caused the current cluster state.

2637

{ # StatusCondition describes why a cluster or a node pool has a certain status

2638

# (e.g., ERROR or DEGRADED).

2639

"message": "A String", # Human-friendly representation of the condition

2640

"code": "A String", # Machine-friendly representation of the condition

2641

},

2642

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2643

"zone": "A String", # The name of the Google Compute Engine

2644

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2645

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2646

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2647

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2648

"detail": "A String", # Detailed operation progress, if available.

2649

"endTime": "A String", # [Output only] The time the operation completed, in

2650

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2651

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2652

{ # StatusCondition describes why a cluster or a node pool has a certain status

2653

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2654

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2655

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2656

},

2657

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2658

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2659

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2660

# or

2661

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

2662

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2663

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2668

<code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2669

<pre>Lists all clusters owned by a project in either the specified zone or all

2670

zones.

2671

2672

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2673

projectId: string, Deprecated. The Google Developers Console [project ID or project

2674

number](https://support.google.com/cloud/answer/6158840).

2675

This field has been deprecated and replaced by the parent field. (required)

2676

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2677

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2678

cluster resides, or "-" for all zones. This field has been deprecated and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2679

replaced by the parent field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2680

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]

2681

Specified in the format `projects/*/locations/*`.

2682

Location "-" matches all zones and all regions.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2683

x__xgafv: string, V1 error format.

2684

Allowed values

2685

1 - v1 error format

2686

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2687

2688

Returns:

2689

An object of the form:

2690

2691

{ # ListClustersResponse is the result of ListClustersRequest.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2692

"clusters": [ # A list of clusters in the project in the specified zone, or

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2693

# across all ones.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2694

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2695

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

2696

"currentNodeVersion": "A String", # [Output only] Deprecated, use

2697

# [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools)

2698

# instead. The current version of the node software components. If they are

2699

# currently at multiple versions because they're in the process of being

2700

# upgraded, this reflects the minimum version of all nodes.

2701

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

2702

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant

2703

# if enabled = true.

2704

"enabled": True or False, # Whether this cluster should return group membership lookups

2705

# during authentication using a group of security groups.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2706

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2707

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha

2708

# API groups (e.g. v1alpha1) and features that may not be production ready in

2709

# the kubernetes version of the master and nodes.

2710

# The cluster has no SLA for uptime and master/node upgrades are disabled.

2711

# Alpha enabled clusters are automatically deleted thirty days after

2712

# creation.

2713

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

2714

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services

2715

# CIDR block. The secondary range will be used for service

2716

# ClusterIPs. This must be an existing secondary range associated

2717

# with the cluster subnetwork.

2718

#

2719

# This field is only applicable with use_ip_aliases is true and

2720

# create_subnetwork is false.

2721

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If

2722

# this field is empty, then an automatic name will be chosen for the new

2723

# subnetwork.

2724

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

2725

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range

2726

# will be automatically chosen with the default size.

2727

#

2728

# This field is only applicable when `use_ip_aliases` is true.

2729

#

2730

# Set to blank to have a range chosen with the default size.

2731

#

2732

# 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)

2737

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2738

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2739

# to use.

2740

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

2741

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR

2742

# block. The secondary range will be used for pod IP

2743

# addresses. This must be an existing secondary range associated

2744

# with the cluster subnetwork.

2745

#

2746

# This field is only applicable with use_ip_aliases is true and

2747

# create_subnetwork is false.

2748

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a

2749

# range will be automatically chosen with the default size.

2750

#

2751

# This field is only applicable when `use_ip_aliases` is true.

2752

#

2753

# If unspecified, the range will use the default size.

2754

#

2755

# 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)

2760

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2761

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2762

# to use.

2763

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.

2764

#

2765

# This is applicable only if `create_subnetwork` is true.

2766

#

2767

# Set to blank to have a range chosen with the default size.

2768

#

2769

# 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)

2774

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2775

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2776

# to use.

2777

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.

2778

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.

2779

#

2780

# This field is only applicable when `use_ip_aliases` is true.

2781

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then

2782

# `cluster.cluster_ipv4_cidr` must be left blank.

2783

#

2784

# This field is only applicable when `use_ip_aliases` is true.

2785

#

2786

# Set to blank to have a range chosen with the default size.

2787

#

2788

# 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)

2793

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

2794

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

2795

# to use.

2796

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

2797

},

2798

"loggingService": "A String", # The logging service the cluster should use to write logs.

2799

# Currently available options:

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2800

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2801

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

2802

# service with a Kubernetes-native resource model

2803

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

2804

# available as of GKE 1.15).

2805

# * `none` - no logs will be exported from the cluster.

2806

#

2807

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

2808

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

2809

"zone": "A String", # [Output only] The name of the Google Compute Engine

2810

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

2811

# cluster resides. This field is deprecated, use location instead.

2812

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.

2813

# mode.

2814

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,

2815

# identities in the system, including service accounts, nodes, and

2816

# controllers, will have statically granted permissions beyond those

2817

# provided by the RBAC configuration or IAM.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2818

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2819

"resourceLabels": { # The resource labels for the cluster to use to annotate any related

2820

# Google Compute Engine resources.

2821

"a_key": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2822

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2823

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2824

# containers. This is provisioned from within the `container_ipv4_cidr`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2825

# range. This field will only be set when cluster is in route-based network

2826

# mode.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2827

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration.

2828

# subscribed to. Release channels are arranged in order of risk.

2829

#

2830

# When a cluster is subscribed to a release channel, Google maintains

2831

# both the master version and the node version. Node auto-upgrade

2832

# defaults to true and cannot be disabled.

2833

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2834

},

2835

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

2836

"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]

2837

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

2838

# occur in these windows.

2839

"a_key": { # Represents an arbitrary window of time.

2840

"endTime": "A String", # The time that the window ends. The end time should take place after the

2841

# start time.

2842

"startTime": "A String", # The time that the window first starts.

2843

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2844

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2845

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

2846

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

2847

# smallest possible in the given scenario.

2848

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

2849

# format "PTnHnMnS".

2850

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

2851

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

2852

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

2853

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2854

"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]

2855

# maintenance to occur. The time windows may be overlapping. If no

2856

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2857

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

2858

"endTime": "A String", # The time that the window ends. The end time should take place after the

2859

# start time.

2860

"startTime": "A String", # The time that the window first starts.

2861

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2862

"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]

2863

# this window reccurs. They go on for the span of time between the start and

2864

# end time.

2865

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2866

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2867

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

2868

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

2869

# <code>FREQ=DAILY</code>

2870

# For the first weekend of every month:

2871

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

2872

# 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]

2873

# 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]

2874

# <code>

2875

# start time = 2019-01-01T09:00:00-0400

2876

# end time = 2019-01-01T17:00:00-0400

2877

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

2878

# </code>

2879

# Windows can span multiple days. Eg, to make the window encompass every

2880

# weekend from midnight Saturday till the last minute of Sunday UTC:

2881

# <code>

2882

# start time = 2019-01-05T00:00:00Z

2883

# end time = 2019-01-07T23:59:00Z

2884

# recurrence = FREQ=WEEKLY;BYDAY=SA

2885

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2886

# 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]

2887

# to specify duration of the window and when it first starts.

2888

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2889

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2890

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2891

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

2892

# the policy won't accidentally undo intermediate changes (and so that users

2893

# of the API unaware of some fields won't accidentally remove other fields).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2894

# Make a <code>get()</code> request to the cluster to get the current

2895

# resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2896

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2897

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics.

2898

# Currently available options:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2899

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2900

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

2901

# service with a Kubernetes-native resource model

2902

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

2903

# longer available as of GKE 1.15).

2904

# * `none` - No metrics will be exported from the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2905

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2906

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

2907

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

2908

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

2909

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

2910

# images will be validated by Binary Authorization.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2911

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2912

"expireTime": "A String", # [Output only] The time the cluster will be automatically

2913

# deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2914

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2915

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2916

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2917

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.

2918

# The endpoint can be accessed from the internet at

2919

# `https://username:password@endpoint/`.

2920

#

2921

# See the `masterAuth` property of this resource for username and

2922

# password information.

2923

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

2924

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

2925

},

2926

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.

2927

# master authorized networks will disallow all external traffic to access

2928

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

2929

# Google Compute Engine Public IPs and Google Prod IPs.

2930

"enabled": True or False, # Whether or not master authorized networks is enabled.

2931

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

2932

# Kubernetes master through HTTPS.

2933

{ # CidrBlock contains an optional name and one CIDR block.

2934

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

2935

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2936

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2937

],

2938

},

2939

"conditions": [ # Which conditions caused the current cluster state.

2940

{ # StatusCondition describes why a cluster or a node pool has a certain status

2941

# (e.g., ERROR or DEGRADED).

2942

"message": "A String", # Human-friendly representation of the condition

2943

"code": "A String", # Machine-friendly representation of the condition

2944

},

2945

],

2946

"network": "A String", # The name of the Google Compute Engine

2947

# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

2948

# to which the cluster is connected. If left unspecified, the `default`

2949

# network will be used.

2950

"status": "A String", # [Output only] The current status of this cluster.

2951

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

2952

# required by Cluster Autoscaler to automatically adjust

2953

# the size of the cluster and create/delete

2954

# node pools based on the current needs.

2955

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

2956

# amount of resources in the cluster.

2957

{ # Contains information about amount of some resource in the cluster.

2958

# For memory, value should be in GB.

2959

"minimum": "A String", # Minimum amount of the resource in the cluster.

2960

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

2961

"maximum": "A String", # Maximum amount of the resource in the cluster.

2962

},

2963

],

2964

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

2965

# created by NAP.

2966

# by NAP.

2967

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

2968

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

2969

# node pool.

2970

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

2971

# the Auto Upgrades will proceed.

2972

"description": "A String", # [Output only] This field is set when upgrades are about to commence

2973

# with the description of the upgrade.

2974

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

2975

# with the approximate start time for the upgrades, in

2976

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2977

},

2978

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

2979

# pool. If enabled, the nodes in this node pool will be monitored and, if

2980

# they fail health checks too many times, an automatic repair action will be

2981

# triggered.

2982

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

2983

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

2984

# up to date with the latest release version of Kubernetes.

2985

},

2986

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2987

# disruption caused by an upgrade.

2988

#

2989

# maxUnavailable controls the number of nodes that can be simultaneously

2990

# unavailable.

2991

#

2992

# maxSurge controls the number of additional nodes that can be added to the

2993

# node pool temporarily for the time of the upgrade to increase the number of

2994

# available nodes.

2995

#

2996

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

2997

# nodes are being upgraded at the same time).

2998

#

2999

# Note: upgrades inevitably introduce some disruption since workloads need to

3000

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3001

# this holds true. (Disruption stays within the limits of

3002

# PodDisruptionBudget, if it is configured.)

3003

#

3004

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3005

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3006

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3007

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3008

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3009

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3010

# the upgrade process. A node is considered available if its status is

3011

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3012

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3013

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3014

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3015

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3016

"A String",

3017

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

3018

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3019

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

3020

"autoprovisioningLocations": [ # The list of Google Compute Engine

3021

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3022

# NodePool's nodes can be created by NAP.

"A String",

],

},

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3027

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.

3028

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3029

"enabled": True or False, # Whether network policy is enabled on the cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3030

"provider": "A String", # The selected network policy provider.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3031

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3032

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3033

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3034

# notation (e.g. `10.96.0.0/14`). Leave blank to have

3035

# one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

3036

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run

3037

# simultaneously on a node in the node pool of this cluster. Only honored

3038

# if cluster created with IP Alias support.

3039

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

3040

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3041

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3042

# For requests, this field should only be used in lieu of a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3043

# "node_pool" object, since this configuration (along with the

3044

# "initial_node_count") will be used to create a "NodePool" object with an

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3045

# auto-generated name. Do not use this and a node_pool at the same time.

3046

# For responses, this field will be populated with the node configuration of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3047

# the first node pool. (For configuration of each node pool, see

3048

# `node_pool.config`)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3049

#

3050

# If unspecified, the defaults are used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3051

# This field is deprecated, use node_pool.config instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3052

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3053

#

3054

# If unspecified, the default disk type is 'pd-standard'

3055

"bootDiskKmsKey": "A String", #

3056

# The Customer Managed Encryption Key used to encrypt the boot disk attached

3057

# to each node in the node pool. This should be of the form

3058

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

3059

# For more information about protecting resources with Cloud KMS Keys please

3060

# see:

3061

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

3062

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3063

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3064

#

3065

# Enables monitoring and attestation of the boot integrity of the instance.

3066

# The attestation is performed against the integrity policy baseline. This

3067

# baseline is initially derived from the implicitly trusted boot image when

3068

# the instance is created.

3069

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3070

#

3071

# Secure Boot helps ensure that the system only runs authentic software by

3072

# verifying the digital signature of all boot components, and halting the

3073

# boot process if signature verification fails.

3074

},

3075

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3076

# These will added in addition to any default label(s) that

3077

# Kubernetes may apply to the node.

3078

# In case of conflict in label keys, the applied set may differ depending on

3079

# the Kubernetes version -- it's best to assume the behavior is undefined

3080

# and conflicts should be avoided.

3081

# For more information, including usage and the valid values, see:

3082

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3083

"a_key": "A String",

3084

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3085

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3086

# node VMs under the "default" service account.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3087

#

3088

# The following scopes are recommended, but not required, and by default are

3089

# not included:

3090

#

3091

# * `https://www.googleapis.com/auth/compute` is required for mounting

3092

# persistent storage on your nodes.

3093

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3094

# communicating with **gcr.io**

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3095

# (the [Google Container

3096

# Registry](https://cloud.google.com/container-registry/)).

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3097

#

3098

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3099

# Monitoring are enabled, in which case their required scopes will be added.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3100

"A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3101

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3102

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3103

# scheduled on the specified or newer CPU platform. Applicable values are the

3104

# friendly names of CPU platforms, such as

3105

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3106

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3107

# information, read [how to specify min CPU

3108

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3109

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

3110

#

3111

# The limit for this value is dependent upon the maximum number of

3112

# disks available on a machine per zone. See:

3113

# https://cloud.google.com/compute/docs/disks/local-ssd

3114

# for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3115

"taints": [ # List of kubernetes taints to be applied to each node.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3116

#

3117

# For more information, including usage and the valid values, see:

3118

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3119

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3120

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3121

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3122

# See

3123

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3124

# for more information, including usage and the valid values.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3125

"value": "A String", # Value for taint.

3126

"key": "A String", # Key for taint.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3127

"effect": "A String", # Effect for taint.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3128

},

3129

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3130

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3131

# the latest version of it will be used.

3132

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3133

# the specified [Zonal Compute

3134

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3135

# to this node pool.

3136

# is the configuration of desired reservation which instances could take

3137

# capacity from.

3138

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3139

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3140

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3141

# the key and specify the name of your reservation as its value.

3142

"values": [ # Corresponds to the label value(s) of reservation resource(s).

3143

"A String",

3144

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3145

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3146

"machineType": "A String", # The name of a Google Compute Engine [machine

3147

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3148

# `n1-standard-1`).

3149

#

3150

# If unspecified, the default machine type is

3151

# `n1-standard-1`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3152

"nodeGroup": "A String", # Setting this field will assign instances of this

3153

# pool to run on the specified node group. This is useful for running

3154

# workloads on [sole tenant

3155

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3156

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3157

#

3158

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3159

# in length. These are reflected as part of a URL in the metadata server.

3160

# Additionally, to avoid ambiguity, keys must not conflict with any other

3161

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3167

# "enable-os-login"

3168

# "gci-ensure-gke-docker"

3169

# "gci-metrics-enabled"

3170

# "gci-update-strategy"

3171

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3176

# "windows-startup-script-ps1"

3177

# "common-psm1"

3178

# "k8s-node-setup-psm1"

3179

# "install-ssh-psm1"

3180

# "user-profile-psm1"

3181

# "serial-port-logging-enable"

3182

#

3183

# Values are free-form strings, and only have meaning as interpreted by

3184

# the image running in the instance. The only restriction placed on them is

3185

# that each value's size must be less than or equal to 32 KB.

3186

#

3187

# The total size of all keys and values must be less than 512 KB.

3188

"a_key": "A String",

3189

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3190

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

3191

# valid sources or targets for network firewalls and are specified by

3192

# the client during cluster or node pool creation. Each tag within the list

3193

# must comply with RFC1035.

3194

"A String",

3195

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3196

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3197

"type": "A String", # Type of the sandbox to use for the node.

3198

},

3199

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3200

# https://cloud.google.com/compute/docs/instances/preemptible for more

3201

# information about preemptible VM instances.

3202

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3203

# workloads on the node pool.

3204

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3205

# on the node pool.

3206

},

3207

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3208

# The smallest allowed disk size is 10GB.

3209

#

3210

# If unspecified, the default disk size is 100GB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3211

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

3212

# Specify the email address of the Service Account; otherwise, if no Service

3213

# Account is specified, the "default" service account is used.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3214

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3215

# See https://cloud.google.com/compute/docs/gpus for more information about

3216

# support for GPUs.

3217

{ # AcceleratorConfig represents a Hardware Accelerator request.

3218

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3219

# [here](https://cloud.google.com/compute/docs/gpus)

3220

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

3221

},

3222

],

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3223

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3224

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is

3225

# disabled when this config is unspecified.

3226

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

3227

# daemonset will be created in the cluster to meter network egress traffic.

3228

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

3229

"datasetId": "A String", # The ID of a BigQuery Dataset.

3230

},

3231

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

3232

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

3233

# second BigQuery table will be created to hold resource consumption

3234

# records.

3235

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3236

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3237

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your

3238

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

3239

# is sufficient for this number of instances. You must also have available

3240

# firewall and routes quota.

3241

# For requests, this field should only be used in lieu of a

3242

# "node_pool" object, since this configuration (along with the

3243

# "node_config") will be used to create a "NodePool" object with an

3244

# auto-generated name. Do not use this and a node_pool at the same time.

3245

#

3246

# This field is deprecated, use node_pool.initial_node_count instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3247

"name": "A String", # The name of this cluster. The name must be unique within this project

3248

# and location (e.g. zone or region), and can be up to 40 characters with

3249

# the following restrictions:

3250

#

3251

# * Lowercase letters, numbers, and hyphens only.

3252

# * Must start with a letter.

3253

# * Must end with a number or a letter.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3254

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM

3255

# policies.

3256

# policies.

3257

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

3258

},

3259

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

3260

"network": "A String", # Output only. The relative name of the Google Compute Engine

3261

# network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)

3262

# to which the cluster is connected. Example:

3263

# projects/my-project/global/networks/my-network

3264

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.

3265

# This makes same node pod to pod traffic visible for VPC network.

3266

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine

3267

# [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the

3268

# cluster is connected. Example:

3269

# projects/my-project/regions/us-central1/subnetworks/my-subnet

3270

},

3271

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

3272

"state": "A String", # Denotes the state of etcd encryption.

3273

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

3274

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

3275

},

3276

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

3277

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

3278

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

3279

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are

3280

# given only RFC 1918 private addresses and communicate with the master via

3281

# private networking.

3282

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

3283

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

3284

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This

3285

# range will be used for assigning internal IP addresses to the master or

3286

# set of masters, as well as the ILB VIP. This range must not overlap with

3287

# any other ranges in use within the cluster's network.

3288

},

3289

"createTime": "A String", # [Output only] The time the cluster was created, in

3290

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3291

"nodePools": [ # The node pools associated with this cluster.

3292

# This field should not be set if "node_config" or "initial_node_count" are

3293

# specified.

3294

{ # NodePool contains the name and configuration for a cluster's node pool.

3295

# Node pools are a set of nodes (i.e. VM's), with a common configuration and

3296

# specification, under the control of the cluster master. They may have a set

3297

# of Kubernetes labels applied to them, which may be used to reference them

3298

# during pod scheduling. They may also be resized up or down, to accommodate

3299

# the workload.

3300

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

3301

"management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.

3302

# node pool.

3303

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

3304

# the Auto Upgrades will proceed.

3305

"description": "A String", # [Output only] This field is set when upgrades are about to commence

3306

# with the description of the upgrade.

3307

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

3308

# with the approximate start time for the upgrades, in

3309

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3310

},

3311

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

3312

# pool. If enabled, the nodes in this node pool will be monitored and, if

3313

# they fail health checks too many times, an automatic repair action will be

3314

# triggered.

3315

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

3316

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

3317

# up to date with the latest release version of Kubernetes.

3318

},

3319

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.

3320

# disruption caused by an upgrade.

3321

#

3322

# maxUnavailable controls the number of nodes that can be simultaneously

3323

# unavailable.

3324

#

3325

# maxSurge controls the number of additional nodes that can be added to the

3326

# node pool temporarily for the time of the upgrade to increase the number of

3327

# available nodes.

3328

#

3329

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

3330

# nodes are being upgraded at the same time).

3331

#

3332

# Note: upgrades inevitably introduce some disruption since workloads need to

3333

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

3334

# this holds true. (Disruption stays within the limits of

3335

# PodDisruptionBudget, if it is configured.)

3336

#

3337

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

3338

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

3339

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

3340

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

3341

# there are always at least 4 nodes available.

3342

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

3343

# the upgrade process. A node is considered available if its status is

3344

# Ready.

3345

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

3346

# of the node pool during the upgrade process.

3347

},

3348

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your

3349

# Compute Engine [resource quota](https://cloud.google.com/compute/quotas)

3350

# is sufficient for this number of instances. You must also have available

3351

# firewall and routes quota.

3352

"statusMessage": "A String", # [Output only] Additional information about the current status of this

3353

# node pool instance, if available.

3354

"version": "A String", # The version of the Kubernetes of this node.

3355

"conditions": [ # Which conditions caused the current node pool state.

3356

{ # StatusCondition describes why a cluster or a node pool has a certain status

3357

# (e.g., ERROR or DEGRADED).

3358

"message": "A String", # Human-friendly representation of the condition

3359

"code": "A String", # Machine-friendly representation of the condition

3360

},

3361

],

3362

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

3363

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

3364

#

3365

# If unspecified, the default disk type is 'pd-standard'

3366

"bootDiskKmsKey": "A String", #

3367

# The Customer Managed Encryption Key used to encrypt the boot disk attached

3368

# to each node in the node pool. This should be of the form

3369

# projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].

3370

# For more information about protecting resources with Cloud KMS Keys please

3371

# see:

3372

# https://cloud.google.com/compute/docs/disks/customer-managed-encryption

3373

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

3374

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3375

#

3376

# Enables monitoring and attestation of the boot integrity of the instance.

3377

# The attestation is performed against the integrity policy baseline. This

3378

# baseline is initially derived from the implicitly trusted boot image when

3379

# the instance is created.

3380

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3381

#

3382

# Secure Boot helps ensure that the system only runs authentic software by

3383

# verifying the digital signature of all boot components, and halting the

3384

# boot process if signature verification fails.

3385

},

3386

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.

3387

# These will added in addition to any default label(s) that

3388

# Kubernetes may apply to the node.

3389

# In case of conflict in label keys, the applied set may differ depending on

3390

# the Kubernetes version -- it's best to assume the behavior is undefined

3391

# and conflicts should be avoided.

3392

# For more information, including usage and the valid values, see:

3393

# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

3394

"a_key": "A String",

3395

},

3396

"oauthScopes": [ # The set of Google API scopes to be made available on all of the

3397

# node VMs under the "default" service account.

3398

#

3399

# The following scopes are recommended, but not required, and by default are

3400

# not included:

3401

#

3402

# * `https://www.googleapis.com/auth/compute` is required for mounting

3403

# persistent storage on your nodes.

3404

# * `https://www.googleapis.com/auth/devstorage.read_only` is required for

3405

# communicating with **gcr.io**

3406

# (the [Google Container

3407

# Registry](https://cloud.google.com/container-registry/)).

3408

#

3409

# If unspecified, no scopes are added, unless Cloud Logging or Cloud

3410

# Monitoring are enabled, in which case their required scopes will be added.

3411

"A String",

3412

],

3413

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be

3414

# scheduled on the specified or newer CPU platform. Applicable values are the

3415

# friendly names of CPU platforms, such as

3416

# <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or

3417

# <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more

3418

# information, read [how to specify min CPU

3419

# platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

3420

"localSsdCount": 42, # The number of local SSD disks to be attached to the node.

3421

#

3422

# The limit for this value is dependent upon the maximum number of

3423

# disks available on a machine per zone. See:

3424

# https://cloud.google.com/compute/docs/disks/local-ssd

3425

# for more information.

3426

"taints": [ # List of kubernetes taints to be applied to each node.

3427

#

3428

# For more information, including usage and the valid values, see:

3429

# https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

3430

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect

3431

# can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

3432

#

3433

# See

3434

# [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)

3435

# for more information, including usage and the valid values.

3436

"value": "A String", # Value for taint.

3437

"key": "A String", # Key for taint.

3438

"effect": "A String", # Effect for taint.

3439

},

3440

],

3441

"imageType": "A String", # The image type to use for this node. Note that for a given image type,

3442

# the latest version of it will be used.

3443

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply

3444

# the specified [Zonal Compute

3445

# Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)

3446

# to this node pool.

3447

# is the configuration of desired reservation which instances could take

3448

# capacity from.

3449

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

3450

"key": "A String", # Corresponds to the label key of a reservation resource. To target a

3451

# SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as

3452

# the key and specify the name of your reservation as its value.

3453

"values": [ # Corresponds to the label value(s) of reservation resource(s).

"A String",

],

},

"machineType": "A String", # The name of a Google Compute Engine [machine

3458

# type](https://cloud.google.com/compute/docs/machine-types) (e.g.

3459

# `n1-standard-1`).

3460

#

3461

# If unspecified, the default machine type is

3462

# `n1-standard-1`.

3463

"nodeGroup": "A String", # Setting this field will assign instances of this

3464

# pool to run on the specified node group. This is useful for running

3465

# workloads on [sole tenant

3466

# nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

3467

"metadata": { # The metadata key/value pairs assigned to instances in the cluster.

3468

#

3469

# Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes

3470

# in length. These are reflected as part of a URL in the metadata server.

3471

# Additionally, to avoid ambiguity, keys must not conflict with any other

3472

# metadata keys for the project or be one of the reserved keys:

# "cluster-location"

# "cluster-name"

# "cluster-uid"

# "configure-sh"

# "containerd-configure-sh"

3478

# "enable-os-login"

3479

# "gci-ensure-gke-docker"

3480

# "gci-metrics-enabled"

3481

# "gci-update-strategy"

3482

# "instance-template"

# "kube-env"

# "startup-script"

# "user-data"

# "disable-address-manager"

3487

# "windows-startup-script-ps1"

3488

# "common-psm1"

3489

# "k8s-node-setup-psm1"

3490

# "install-ssh-psm1"

3491

# "user-profile-psm1"

3492

# "serial-port-logging-enable"

3493

#

3494

# Values are free-form strings, and only have meaning as interpreted by

3495

# the image running in the instance. The only restriction placed on them is

3496

# that each value's size must be less than or equal to 32 KB.

3497

#

3498

# The total size of all keys and values must be less than 512 KB.

3499

"a_key": "A String",

3500

},

3501

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify

3502

# valid sources or targets for network firewalls and are specified by

3503

# the client during cluster or node pool creation. Each tag within the list

3504

# must comply with RFC1035.

3505

"A String",

3506

],

3507

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

3508

"type": "A String", # Type of the sandbox to use for the node.

3509

},

3510

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:

3511

# https://cloud.google.com/compute/docs/instances/preemptible for more

3512

# information about preemptible VM instances.

3513

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.

3514

# workloads on the node pool.

3515

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running

3516

# on the node pool.

3517

},

3518

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.

3519

# The smallest allowed disk size is 10GB.

3520

#

3521

# If unspecified, the default disk size is 100GB.

3522

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

3523

# Specify the email address of the Service Account; otherwise, if no Service

3524

# Account is specified, the "default" service account is used.

3525

"accelerators": [ # A list of hardware accelerators to be attached to each node.

3526

# See https://cloud.google.com/compute/docs/gpus for more information about

3527

# support for GPUs.

3528

{ # AcceleratorConfig represents a Hardware Accelerator request.

3529

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators

3530

# [here](https://cloud.google.com/compute/docs/gpus)

3531

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

},

],

},

"name": "A String", # The name of the node pool.

3536

"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run

3537

# simultaneously on a node in the node pool.

3538

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

3539

},

3540

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled

3541

# only if a valid configuration is present.

3542

# adjust the size of the node pool to the current cluster usage.

3543

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

3544

# max_node_count.

3545

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

3546

# has to enough quota to scale up the cluster.

3547

"enabled": True or False, # Is autoscaling enabled for this node pool.

3548

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

3549

},

3550

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

3551

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance

3552

# groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)

3553

# associated with this node pool.

3554

"A String",

3555

],

3556

"status": "A String", # [Output only] The status of the nodes in this pool instance.

3557

"locations": [ # The list of Google Compute Engine

3558

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3559

# NodePool's nodes should be located.

"A String",

],

},

],

"subnetwork": "A String", # The name of the Google Compute Engine

3565

# [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which

3566

# the cluster is connected.

3567

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

3568

# cluster, enabling additional functionality.

3569

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

3570

# This addon is deprecated, and will be disabled in 1.15. It is recommended

3571

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

3572

# workloads and applications. For more information, see:

3573

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

3574

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

3575

},

3576

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

3577

# managed Knative service.

3578

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

3579

},

3580

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

3581

# makes it easy to set up HTTP load balancers for services in a cluster.

3582

# which makes it easy to set up HTTP load balancers for services in a cluster.

3583

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

3584

# When enabled, it runs a small pod in the cluster that manages the load

3585

# balancers.

3586

},

3587

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

3588

# increases or decreases the number of replica pods a replication controller

3589

# has based on the resource usage of the existing pods.

3590

# increases or decreases the number of replica pods a replication controller

3591

# has based on the resource usage of the existing pods.

3592

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

3593

# When enabled, it ensures that metrics are collected into Stackdriver

3594

# Monitoring.

3595

},

3596

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

3597

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

3598

},

3599

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

3600

# is enabled or not on the Master, it does not track whether network policy

3601

# is enabled for the nodes.

3602

# is enabled or not on the Master, it does not track whether network policy

3603

# is enabled for the nodes.

3604

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

3605

},

3606

},

3607

"masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.

3608

# If unspecified, the defaults are used:

3609

# For clusters before v1.12, if master_auth is unspecified, `username` will

3610

# be set to "admin", a random password will be generated, and a client

3611

# certificate will be issued.

3612

# Authentication can be done using HTTP basic auth or using client

3613

# certificates.

3614

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

3615

# to the cluster endpoint.

3616

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

3617

# authenticate to the cluster endpoint.

3618

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

3619

# For clusters v1.6.0 and later, basic authentication can be disabled by

3620

# leaving username unspecified (or setting it to the empty string).

3621

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint.

3622

# Because the master endpoint is open to the Internet, you should create a

3623

# strong password. If a password is provided for cluster creation, username

3624

# must be non-empty.

3625

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For

3626

# clusters before v1.12, if no configuration is specified, a client

3627

# certificate is issued.

3628

"issueClientCertificate": True or False, # Issue a client certificate.

3629

},

3630

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

3631

# trust for the cluster.

3632

},

3633

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

3634

# required by Vertical Pod Autoscaler to automatically adjust

3635

# the resources of pods controlled by it.

3636

"enabled": True or False, # Enables vertical pod autoscaling.

3637

},

3638

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

3639

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those

3640

# found in validMasterVersions returned by getServerConfig. The version can

3641

# be upgraded over time; such upgrades are reflected in

3642

# currentMasterVersion and currentNodeVersion.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3643

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3644

# Users may specify either explicit versions offered by

3645

# Kubernetes Engine or version aliases, which have the following behavior:

3646

#

3647

# - "latest": picks the highest valid Kubernetes version

3648

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

3649

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

3650

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

3651

# - "","-": picks the default Kubernetes version

3652

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.

3653

# Call Kubernetes API directly to retrieve node information.

3654

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in

3655

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3656

# notation (e.g. `1.2.3.4/29`).

3657

"locations": [ # The list of Google Compute Engine

3658

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

3659

# cluster's nodes should be located.

3660

"A String",

3661

],

3662

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

3663

"description": "A String", # An optional description of this cluster.

3664

"statusMessage": "A String", # [Output only] Additional information about the current status of this

3665

# cluster, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3666

"location": "A String", # [Output only] The name of the Google Compute Engine

3667

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3668

# or

3669

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3670

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3671

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in

3672

# this cluster, in

3673

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

3674

# notation (e.g. `1.2.3.4/29`). Service addresses are

3675

# typically put in the last `/16` from the container CIDR.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3676

},

3677

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3678

"missingZones": [ # If any zones are listed here, the list of clusters returned

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3679

# may be missing those zones.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3680

"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]

3686

<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]

3687

<pre>Sets the locations for a specific cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3688

Deprecated. Use

3689

[projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update)

3690

instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3691

3692

Args:

3693

projectId: string, Deprecated. The Google Developers Console [project ID or project

3694

number](https://support.google.com/cloud/answer/6158840).

3695

This field has been deprecated and replaced by the name field. (required)

3696

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3697

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

3698

cluster resides. This field has been deprecated and replaced by the name

3699

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3700

clusterId: string, Deprecated. The name of the cluster to upgrade.

3701

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3702

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3703

The object takes the form of:

3704

3705

{ # SetLocationsRequest sets the locations of the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3706

"name": "A String", # The name (project, location, cluster) of the cluster to set locations.

3707

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3708

"zone": "A String", # Deprecated. The name of the Google Compute Engine

3709

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3710

# cluster resides. This field has been deprecated and replaced by the name

3711

# field.

3712

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3713

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3714

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3715

# number](https://support.google.com/cloud/answer/6158840).

3716

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3717

"locations": [ # Required. The desired list of Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3718

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3719

# 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]

3720

# will result in nodes being either created or removed from the cluster,

3721

# depending on whether locations are being added or removed.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3722

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3723

# This list must always include the cluster's primary zone.

3724

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3725

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3726

}

3727

3728

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3735

3736

{ # This operation resource represents operations that may have happened or are

3737

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3738

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3739

"name": "A String", # A non-parameterized string describing an operation stage.

3740

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3741

"metrics": [ # Progress metric bundle, for example:

3742

# metrics: [{name: "nodes done", int_value: 15},

3743

# {name: "nodes total", int_value: 32}]

3744

# or

3745

# metrics: [{name: "progress", double_value: 0.56},

3746

# {name: "progress scale", double_value: 1.0}]

3747

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3748

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3749

"doubleValue": 3.14, # For metrics with floating point value.

3750

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3751

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3752

},

3753

],

3754

"status": "A String", # Status of an operation stage.

3755

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3756

"stages": [ # Substages of an operation or a stage.

3757

# Object with schema name: OperationProgress

3758

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3759

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3760

"targetLink": "A String", # Server-defined URL for the target of the operation.

3761

"status": "A String", # The current status of the operation.

3762

"operationType": "A String", # The operation type.

3763

"startTime": "A String", # [Output only] The time the operation started, in

3764

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3765

"clusterConditions": [ # Which conditions caused the current cluster state.

3766

{ # StatusCondition describes why a cluster or a node pool has a certain status

3767

# (e.g., ERROR or DEGRADED).

3768

"message": "A String", # Human-friendly representation of the condition

3769

"code": "A String", # Machine-friendly representation of the condition

3770

},

3771

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3772

"zone": "A String", # The name of the Google Compute Engine

3773

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3774

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3775

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3776

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3777

"detail": "A String", # Detailed operation progress, if available.

3778

"endTime": "A String", # [Output only] The time the operation completed, in

3779

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3780

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3781

{ # StatusCondition describes why a cluster or a node pool has a certain status

3782

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3783

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3784

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3785

},

3786

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3787

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3788

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3789

# or

3790

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3791

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3792

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

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]

3797

<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]

3798

<pre>Sets the logging service for a specific cluster.

3799

3800

Args:

3801

projectId: string, Deprecated. The Google Developers Console [project ID or project

3802

number](https://support.google.com/cloud/answer/6158840).

3803

This field has been deprecated and replaced by the name field. (required)

3804

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3805

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

3806

cluster resides. This field has been deprecated and replaced by the name

3807

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3808

clusterId: string, Deprecated. The name of the cluster to upgrade.

3809

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3810

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3811

The object takes the form of:

3812

3813

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3814

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

3815

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3816

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3817

# number](https://support.google.com/cloud/answer/6158840).

3818

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3819

"name": "A String", # The name (project, location, cluster) of the cluster to set logging.

3820

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3821

"zone": "A String", # Deprecated. The name of the Google Compute Engine

3822

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3823

# cluster resides. This field has been deprecated and replaced by the name

3824

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3825

"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]

3826

# Currently available options:

3827

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3828

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

3829

# service with a Kubernetes-native resource model

3830

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

3831

# available as of GKE 1.15).

3832

# * `none` - no logs will be exported from the cluster.

3833

#

3834

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

3835

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3836

}

3837

3838

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3845

3846

{ # This operation resource represents operations that may have happened or are

3847

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3848

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3849

"name": "A String", # A non-parameterized string describing an operation stage.

3850

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3851

"metrics": [ # Progress metric bundle, for example:

3852

# metrics: [{name: "nodes done", int_value: 15},

3853

# {name: "nodes total", int_value: 32}]

3854

# or

3855

# metrics: [{name: "progress", double_value: 0.56},

3856

# {name: "progress scale", double_value: 1.0}]

3857

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3858

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3859

"doubleValue": 3.14, # For metrics with floating point value.

3860

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3861

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3862

},

3863

],

3864

"status": "A String", # Status of an operation stage.

3865

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3866

"stages": [ # Substages of an operation or a stage.

3867

# Object with schema name: OperationProgress

3868

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3869

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3870

"targetLink": "A String", # Server-defined URL for the target of the operation.

3871

"status": "A String", # The current status of the operation.

3872

"operationType": "A String", # The operation type.

3873

"startTime": "A String", # [Output only] The time the operation started, in

3874

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3875

"clusterConditions": [ # Which conditions caused the current cluster state.

3876

{ # StatusCondition describes why a cluster or a node pool has a certain status

3877

# (e.g., ERROR or DEGRADED).

3878

"message": "A String", # Human-friendly representation of the condition

3879

"code": "A String", # Machine-friendly representation of the condition

3880

},

3881

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3882

"zone": "A String", # The name of the Google Compute Engine

3883

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3884

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3885

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3886

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3887

"detail": "A String", # Detailed operation progress, if available.

3888

"endTime": "A String", # [Output only] The time the operation completed, in

3889

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3890

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3891

{ # StatusCondition describes why a cluster or a node pool has a certain status

3892

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3893

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3894

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3895

},

3896

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3897

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3898

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3899

# or

3900

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

3901

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3902

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

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]

3907

<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]

3908

<pre>Updates the master for a specific cluster.

3909

3910

Args:

3911

projectId: string, Deprecated. The Google Developers Console [project ID or project

3912

number](https://support.google.com/cloud/answer/6158840).

3913

This field has been deprecated and replaced by the name field. (required)

3914

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3915

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

3916

cluster resides. This field has been deprecated and replaced by the name

3917

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3918

clusterId: string, Deprecated. The name of the cluster to upgrade.

3919

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3920

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3921

The object takes the form of:

3922

3923

{ # UpdateMasterRequest updates the master of the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3924

"masterVersion": "A String", # Required. The Kubernetes version to change the master to.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3925

#

3926

# Users may specify either explicit versions offered by Kubernetes Engine or

3927

# version aliases, which have the following behavior:

3928

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3929

# - "latest": picks the highest valid Kubernetes version

3930

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

3931

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

3932

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

3933

# - "-": picks the default Kubernetes version

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3934

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

3935

# number](https://support.google.com/cloud/answer/6158840).

3936

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3937

"zone": "A String", # Deprecated. The name of the Google Compute Engine

3938

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3939

# cluster resides. This field has been deprecated and replaced by the name

3940

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3941

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3942

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3943

"name": "A String", # The name (project, location, cluster) of the cluster to update.

3944

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3945

}

3946

3947

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3954

3955

{ # This operation resource represents operations that may have happened or are

3956

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3957

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3958

"name": "A String", # A non-parameterized string describing an operation stage.

3959

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3960

"metrics": [ # Progress metric bundle, for example:

3961

# metrics: [{name: "nodes done", int_value: 15},

3962

# {name: "nodes total", int_value: 32}]

3963

# or

3964

# metrics: [{name: "progress", double_value: 0.56},

3965

# {name: "progress scale", double_value: 1.0}]

3966

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3967

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3968

"doubleValue": 3.14, # For metrics with floating point value.

3969

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3970

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3971

},

3972

],

3973

"status": "A String", # Status of an operation stage.

3974

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3975

"stages": [ # Substages of an operation or a stage.

3976

# Object with schema name: OperationProgress

3977

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3978

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3979

"targetLink": "A String", # Server-defined URL for the target of the operation.

3980

"status": "A String", # The current status of the operation.

3981

"operationType": "A String", # The operation type.

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

"message": "A String", # Human-friendly representation of the condition

3988

"code": "A String", # Machine-friendly representation of the condition

3989

},

3990

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3991

"zone": "A String", # The name of the Google Compute Engine

3992

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

3993

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3994

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3995

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3996

"detail": "A String", # Detailed operation progress, if available.

3997

"endTime": "A String", # [Output only] The time the operation completed, in

3998

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3999

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4000

{ # StatusCondition describes why a cluster or a node pool has a certain status

4001

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4002

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4003

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4004

},

4005

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4006

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4007

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4008

# or

4009

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4010

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4011

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

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]

4016

<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]

4017

<pre>Sets the monitoring service for a specific cluster.

4018

4019

Args:

4020

projectId: string, Deprecated. The Google Developers Console [project ID or project

4021

number](https://support.google.com/cloud/answer/6158840).

4022

This field has been deprecated and replaced by the name field. (required)

4023

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4024

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4025

cluster resides. This field has been deprecated and replaced by the name

4026

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4027

clusterId: string, Deprecated. The name of the cluster to upgrade.

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

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4030

The object takes the form of:

4031

4032

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4033

"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]

4034

# Currently available options:

4035

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4036

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4037

# service with a Kubernetes-native resource model

4038

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4039

# longer available as of GKE 1.15).

4040

# * `none` - No metrics will be exported from the cluster.

4041

#

4042

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4043

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4044

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4045

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4046

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4047

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4048

# cluster resides. This field has been deprecated and replaced by the name

4049

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4050

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4051

# number](https://support.google.com/cloud/answer/6158840).

4052

# This field has been deprecated and replaced by the name field.

4053

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring.

4054

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4055

}

4056

4057

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4064

4065

{ # This operation resource represents operations that may have happened or are

4066

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4067

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4068

"name": "A String", # A non-parameterized string describing an operation stage.

4069

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4070

"metrics": [ # Progress metric bundle, for example:

4071

# metrics: [{name: "nodes done", int_value: 15},

4072

# {name: "nodes total", int_value: 32}]

4073

# or

4074

# metrics: [{name: "progress", double_value: 0.56},

4075

# {name: "progress scale", double_value: 1.0}]

4076

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4077

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4078

"doubleValue": 3.14, # For metrics with floating point value.

4079

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4080

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4081

},

4082

],

4083

"status": "A String", # Status of an operation stage.

4084

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4085

"stages": [ # Substages of an operation or a stage.

4086

# Object with schema name: OperationProgress

4087

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4088

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4089

"targetLink": "A String", # Server-defined URL for the target of the operation.

4090

"status": "A String", # The current status of the operation.

4091

"operationType": "A String", # The operation type.

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

"message": "A String", # Human-friendly representation of the condition

4098

"code": "A String", # Machine-friendly representation of the condition

4099

},

4100

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4101

"zone": "A String", # The name of the Google Compute Engine

4102

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4103

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4104

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4105

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4106

"detail": "A String", # Detailed operation progress, if available.

4107

"endTime": "A String", # [Output only] The time the operation completed, in

4108

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4109

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4110

{ # StatusCondition describes why a cluster or a node pool has a certain status

4111

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4112

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4113

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4114

},

4115

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4116

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4117

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4118

# or

4119

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4120

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4121

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4126

<code class="details" id="resourceLabels">resourceLabels(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4127

<pre>Sets labels on a cluster.

4128

4129

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4130

projectId: string, Deprecated. The Google Developers Console [project ID or project

4131

number](https://developers.google.com/console/help/new/#projectnumber).

4132

This field has been deprecated and replaced by the name field. (required)

4133

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4134

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4135

cluster resides. This field has been deprecated and replaced by the name

4136

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4137

clusterId: string, Deprecated. The name of the cluster.

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

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4140

The object takes the form of:

4141

4142

{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container

4143

# Engine cluster, which will in turn set them for Google Compute Engine

4144

# resources used by that cluster

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4145

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels.

4146

# Specified in the format `projects/*/locations/*/clusters/*`.

4147

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4148

# number](https://developers.google.com/console/help/new/#projectnumber).

4149

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4150

"clusterId": "A String", # Deprecated. The name of the cluster.

4151

# This field has been deprecated and replaced by the name field.

4152

"labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource,

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4153

# used to detect conflicts. The fingerprint is initially generated by

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4154

# Kubernetes Engine and changes after every request to modify or update

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4155

# labels. You must always provide an up-to-date fingerprint hash when

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4156

# updating or changing labels. Make a <code>get()</code> request to the

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4157

# resource to get the latest fingerprint.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4158

"zone": "A String", # Deprecated. The name of the Google Compute Engine

4159

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4160

# cluster resides. This field has been deprecated and replaced by the name

4161

# field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4162

"resourceLabels": { # Required. The labels to set for that cluster.

4163

"a_key": "A String",

4164

},

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4165

}

4166

4167

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4174

4175

{ # This operation resource represents operations that may have happened or are

4176

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4177

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4178

"name": "A String", # A non-parameterized string describing an operation stage.

4179

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4180

"metrics": [ # Progress metric bundle, for example:

4181

# metrics: [{name: "nodes done", int_value: 15},

4182

# {name: "nodes total", int_value: 32}]

4183

# or

4184

# metrics: [{name: "progress", double_value: 0.56},

4185

# {name: "progress scale", double_value: 1.0}]

4186

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4187

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4188

"doubleValue": 3.14, # For metrics with floating point value.

4189

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4190

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4191

},

4192

],

4193

"status": "A String", # Status of an operation stage.

4194

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4195

"stages": [ # Substages of an operation or a stage.

4196

# Object with schema name: OperationProgress

4197

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4198

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4199

"targetLink": "A String", # Server-defined URL for the target of the operation.

4200

"status": "A String", # The current status of the operation.

4201

"operationType": "A String", # The operation type.

4202

"startTime": "A String", # [Output only] The time the operation started, in

4203

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4204

"clusterConditions": [ # Which conditions caused the current cluster state.

4205

{ # StatusCondition describes why a cluster or a node pool has a certain status

4206

# (e.g., ERROR or DEGRADED).

4207

"message": "A String", # Human-friendly representation of the condition

4208

"code": "A String", # Machine-friendly representation of the condition

4209

},

4210

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4211

"zone": "A String", # The name of the Google Compute Engine

4212

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4213

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4214

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4215

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4216

"detail": "A String", # Detailed operation progress, if available.

4217

"endTime": "A String", # [Output only] The time the operation completed, in

4218

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4219

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4220

{ # StatusCondition describes why a cluster or a node pool has a certain status

4221

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4222

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4223

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4224

},

4225

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4226

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4227

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4228

# or

4229

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4230

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4231

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4236

<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]

4237

<pre>Sets the maintenance policy for a cluster.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4238

4239

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4240

projectId: string, Required. The Google Developers Console [project ID or project

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4241

number](https://support.google.com/cloud/answer/6158840). (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4242

zone: string, Required. The name of the Google Compute Engine

4243

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4244

cluster resides. (required)

4245

clusterId: string, Required. The name of the cluster to update. (required)

4246

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4247

The object takes the form of:

4248

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4249

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4250

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance

4251

# policy.

4252

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4253

"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]

4254

# clears the existing maintenance policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4255

"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]

4256

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not

4257

# occur in these windows.

4258

"a_key": { # Represents an arbitrary window of time.

4259

"endTime": "A String", # The time that the window ends. The end time should take place after the

4260

# start time.

4261

"startTime": "A String", # The time that the window first starts.

4262

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4263

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4264

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

4265

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be

4266

# smallest possible in the given scenario.

4267

# Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

4268

# format "PTnHnMnS".

4269

"startTime": "A String", # Time within the maintenance window to start the maintenance operations.

4270

# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)

4271

# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

4272

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4273

"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]

4274

# maintenance to occur. The time windows may be overlapping. If no

4275

# maintenance windows are set, maintenance can occur at any time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4276

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

4277

"endTime": "A String", # The time that the window ends. The end time should take place after the

4278

# start time.

4279

"startTime": "A String", # The time that the window first starts.

4280

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4281

"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]

4282

# this window reccurs. They go on for the span of time between the start and

4283

# end time.

4284

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4285

# For example, to have something repeat every weekday, you'd use:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4286

# <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code>

4287

# To repeat some window daily (equivalent to the DailyMaintenanceWindow):

4288

# <code>FREQ=DAILY</code>

4289

# For the first weekend of every month:

4290

# <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code>

4291

# 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]

4292

# 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]

4293

# <code>

4294

# start time = 2019-01-01T09:00:00-0400

4295

# end time = 2019-01-01T17:00:00-0400

4296

# recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

4297

# </code>

4298

# Windows can span multiple days. Eg, to make the window encompass every

4299

# weekend from midnight Saturday till the last minute of Sunday UTC:

4300

# <code>

4301

# start time = 2019-01-05T00:00:00Z

4302

# end time = 2019-01-07T23:59:00Z

4303

# recurrence = FREQ=WEEKLY;BYDAY=SA

4304

# </code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4305

# 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]

4306

# to specify duration of the window and when it first starts.

4307

# The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4308

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4309

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4310

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of

4311

# the policy won't accidentally undo intermediate changes (and so that users

4312

# of the API unaware of some fields won't accidentally remove other fields).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4313

# Make a <code>get()</code> request to the cluster to get the current

4314

# resource version and include it with requests to set the policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4315

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4316

"projectId": "A String", # Required. The Google Developers Console [project ID or project

4317

# number](https://support.google.com/cloud/answer/6158840).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4318

"clusterId": "A String", # Required. The name of the cluster to update.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4319

"zone": "A String", # Required. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4320

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4321

# cluster resides.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4322

}

4323

4324

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4331

4332

{ # This operation resource represents operations that may have happened or are

4333

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4334

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4335

"name": "A String", # A non-parameterized string describing an operation stage.

4336

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4337

"metrics": [ # Progress metric bundle, for example:

4338

# metrics: [{name: "nodes done", int_value: 15},

4339

# {name: "nodes total", int_value: 32}]

4340

# or

4341

# metrics: [{name: "progress", double_value: 0.56},

4342

# {name: "progress scale", double_value: 1.0}]

4343

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4344

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4345

"doubleValue": 3.14, # For metrics with floating point value.

4346

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4347

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4348

},

4349

],

4350

"status": "A String", # Status of an operation stage.

4351

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4352

"stages": [ # Substages of an operation or a stage.

4353

# Object with schema name: OperationProgress

4354

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4355

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4356

"targetLink": "A String", # Server-defined URL for the target of the operation.

4357

"status": "A String", # The current status of the operation.

4358

"operationType": "A String", # The operation type.

4359

"startTime": "A String", # [Output only] The time the operation started, in

4360

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4361

"clusterConditions": [ # Which conditions caused the current cluster state.

4362

{ # StatusCondition describes why a cluster or a node pool has a certain status

4363

# (e.g., ERROR or DEGRADED).

4364

"message": "A String", # Human-friendly representation of the condition

4365

"code": "A String", # Machine-friendly representation of the condition

4366

},

4367

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4368

"zone": "A String", # The name of the Google Compute Engine

4369

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4370

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4371

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4372

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4373

"detail": "A String", # Detailed operation progress, if available.

4374

"endTime": "A String", # [Output only] The time the operation completed, in

4375

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4376

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4377

{ # StatusCondition describes why a cluster or a node pool has a certain status

4378

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4379

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4380

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4381

},

4382

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4383

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4384

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4385

# or

4386

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4387

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4388

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

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]

4393

<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]

4394

<pre>Sets master auth materials. Currently supports changing the admin password

4395

or a specific cluster, either via password generation or explicitly setting

the password.

Args:

projectId: string, Deprecated. The Google Developers Console [project ID or project

4400

number](https://support.google.com/cloud/answer/6158840).

4401

This field has been deprecated and replaced by the name field. (required)

4402

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4403

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4404

cluster resides. This field has been deprecated and replaced by the name

4405

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4406

clusterId: string, Deprecated. The name of the cluster to upgrade.

4407

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4408

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4409

The object takes the form of:

4410

4411

{ # SetMasterAuthRequest updates the admin password of a cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4412

"zone": "A String", # Deprecated. The name of the Google Compute Engine

4413

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4414

# cluster resides. This field has been deprecated and replaced by the name

4415

# field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4416

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4417

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4418

"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]

4419

# Authentication can be done using HTTP basic auth or using client

4420

# certificates.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4421

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate

4422

# to the cluster endpoint.

4423

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to

4424

# authenticate to the cluster endpoint.

4425

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint.

4426

# For clusters v1.6.0 and later, basic authentication can be disabled by

4427

# leaving username unspecified (or setting it to the empty string).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4428

"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]

4429

# Because the master endpoint is open to the Internet, you should create a

4430

# strong password. If a password is provided for cluster creation, username

4431

# must be non-empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4432

"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]

4433

# clusters before v1.12, if no configuration is specified, a client

4434

# certificate is issued.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4435

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4436

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4437

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of

4438

# trust for the cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4439

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4440

"name": "A String", # The name (project, location, cluster) of the cluster to set auth.

4441

# Specified in the format `projects/*/locations/*/clusters/*`.

4442

"action": "A String", # Required. The exact form of action to be taken on the master auth.

4443

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4444

# number](https://support.google.com/cloud/answer/6158840).

4445

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4446

}

4447

4448

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4455

4456

{ # This operation resource represents operations that may have happened or are

4457

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4458

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4459

"name": "A String", # A non-parameterized string describing an operation stage.

4460

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4461

"metrics": [ # Progress metric bundle, for example:

4462

# metrics: [{name: "nodes done", int_value: 15},

4463

# {name: "nodes total", int_value: 32}]

4464

# or

4465

# metrics: [{name: "progress", double_value: 0.56},

4466

# {name: "progress scale", double_value: 1.0}]

4467

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4468

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4469

"doubleValue": 3.14, # For metrics with floating point value.

4470

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4471

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4472

},

4473

],

4474

"status": "A String", # Status of an operation stage.

4475

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4476

"stages": [ # Substages of an operation or a stage.

4477

# Object with schema name: OperationProgress

4478

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4479

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4480

"targetLink": "A String", # Server-defined URL for the target of the operation.

4481

"status": "A String", # The current status of the operation.

4482

"operationType": "A String", # The operation type.

4483

"startTime": "A String", # [Output only] The time the operation started, in

4484

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4485

"clusterConditions": [ # Which conditions caused the current cluster state.

4486

{ # StatusCondition describes why a cluster or a node pool has a certain status

4487

# (e.g., ERROR or DEGRADED).

4488

"message": "A String", # Human-friendly representation of the condition

4489

"code": "A String", # Machine-friendly representation of the condition

4490

},

4491

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4492

"zone": "A String", # The name of the Google Compute Engine

4493

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4494

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4495

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4496

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4497

"detail": "A String", # Detailed operation progress, if available.

4498

"endTime": "A String", # [Output only] The time the operation completed, in

4499

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4500

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4501

{ # StatusCondition describes why a cluster or a node pool has a certain status

4502

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4503

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4504

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4505

},

4506

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4507

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4508

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4509

# or

4510

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4511

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4512

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

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]

4517

<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]

4518

<pre>Enables or disables Network Policy for a cluster.

4519

4520

Args:

4521

projectId: string, Deprecated. The Google Developers Console [project ID or project

4522

number](https://developers.google.com/console/help/new/#projectnumber).

4523

This field has been deprecated and replaced by the name field. (required)

4524

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4525

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4526

cluster resides. This field has been deprecated and replaced by the name

4527

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4528

clusterId: string, Deprecated. The name of the cluster.

4529

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4530

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4531

The object takes the form of:

4532

4533

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4534

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking

4535

# policy. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4536

"clusterId": "A String", # Deprecated. The name of the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4537

# This field has been deprecated and replaced by the name field.

4538

"zone": "A String", # Deprecated. The name of the Google Compute Engine

4539

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4540

# cluster resides. This field has been deprecated and replaced by the name

4541

# field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4542

"networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature.

4543

# https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

4544

"enabled": True or False, # Whether network policy is enabled on the cluster.

4545

"provider": "A String", # The selected network policy provider.

4546

},

4547

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4548

# number](https://developers.google.com/console/help/new/#projectnumber).

4549

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4550

}

4551

4552

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4559

4560

{ # This operation resource represents operations that may have happened or are

4561

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4562

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4563

"name": "A String", # A non-parameterized string describing an operation stage.

4564

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4565

"metrics": [ # Progress metric bundle, for example:

4566

# metrics: [{name: "nodes done", int_value: 15},

4567

# {name: "nodes total", int_value: 32}]

4568

# or

4569

# metrics: [{name: "progress", double_value: 0.56},

4570

# {name: "progress scale", double_value: 1.0}]

4571

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4572

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4573

"doubleValue": 3.14, # For metrics with floating point value.

4574

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4575

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4576

},

4577

],

4578

"status": "A String", # Status of an operation stage.

4579

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4580

"stages": [ # Substages of an operation or a stage.

4581

# Object with schema name: OperationProgress

4582

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4583

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4584

"targetLink": "A String", # Server-defined URL for the target of the operation.

4585

"status": "A String", # The current status of the operation.

4586

"operationType": "A String", # The operation type.

4587

"startTime": "A String", # [Output only] The time the operation started, in

4588

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4589

"clusterConditions": [ # Which conditions caused the current cluster state.

4590

{ # StatusCondition describes why a cluster or a node pool has a certain status

4591

# (e.g., ERROR or DEGRADED).

4592

"message": "A String", # Human-friendly representation of the condition

4593

"code": "A String", # Machine-friendly representation of the condition

4594

},

4595

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4596

"zone": "A String", # The name of the Google Compute Engine

4597

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4598

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4599

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4600

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4601

"detail": "A String", # Detailed operation progress, if available.

4602

"endTime": "A String", # [Output only] The time the operation completed, in

4603

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4604

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4605

{ # StatusCondition describes why a cluster or a node pool has a certain status

4606

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4607

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4608

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4609

},

4610

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4611

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4612

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4613

# or

4614

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4615

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4616

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4621

<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]

4622

<pre>Starts master IP rotation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4623

4624

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4625

projectId: string, Deprecated. The Google Developers Console [project ID or project

4626

number](https://developers.google.com/console/help/new/#projectnumber).

4627

This field has been deprecated and replaced by the name field. (required)

4628

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4629

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4630

cluster resides. This field has been deprecated and replaced by the name

4631

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4632

clusterId: string, Deprecated. The name of the cluster.

4633

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4634

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4635

The object takes the form of:

4636

4637

{ # StartIPRotationRequest creates a new IP for the cluster and then performs

4638

# a node upgrade on each node pool to point to the new IP.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4639

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP

4640

# rotation. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4641

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4642

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4643

# cluster resides. This field has been deprecated and replaced by the name

4644

# field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4645

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4646

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4647

# number](https://developers.google.com/console/help/new/#projectnumber).

4648

# This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4649

"clusterId": "A String", # Deprecated. The name of the cluster.

4650

# This field has been deprecated and replaced by the name field.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4651

}

4652

4653

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4660

4661

{ # This operation resource represents operations that may have happened or are

4662

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4663

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

4664

"name": "A String", # A non-parameterized string describing an operation stage.

4665

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4666

"metrics": [ # Progress metric bundle, for example:

4667

# metrics: [{name: "nodes done", int_value: 15},

4668

# {name: "nodes total", int_value: 32}]

4669

# or

4670

# metrics: [{name: "progress", double_value: 0.56},

4671

# {name: "progress scale", double_value: 1.0}]

4672

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4673

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4674

"doubleValue": 3.14, # For metrics with floating point value.

4675

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4676

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4677

},

4678

],

4679

"status": "A String", # Status of an operation stage.

4680

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4681

"stages": [ # Substages of an operation or a stage.

4682

# Object with schema name: OperationProgress

4683

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4684

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4685

"targetLink": "A String", # Server-defined URL for the target of the operation.

4686

"status": "A String", # The current status of the operation.

4687

"operationType": "A String", # The operation type.

4688

"startTime": "A String", # [Output only] The time the operation started, in

4689

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4690

"clusterConditions": [ # Which conditions caused the current cluster state.

4691

{ # StatusCondition describes why a cluster or a node pool has a certain status

4692

# (e.g., ERROR or DEGRADED).

4693

"message": "A String", # Human-friendly representation of the condition

4694

"code": "A String", # Machine-friendly representation of the condition

4695

},

4696

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4697

"zone": "A String", # The name of the Google Compute Engine

4698

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4699

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4700

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4701

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4702

"detail": "A String", # Detailed operation progress, if available.

4703

"endTime": "A String", # [Output only] The time the operation completed, in

4704

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4705

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4706

{ # StatusCondition describes why a cluster or a node pool has a certain status

4707

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4708

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4709

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4710

},

4711

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4712

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4713

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4714

# or

4715

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

4716

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4717

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4722

<code class="details" id="update">update(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4723

<pre>Updates the settings of a specific cluster.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4724

4725

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4726

projectId: string, Deprecated. The Google Developers Console [project ID or project

4727

number](https://support.google.com/cloud/answer/6158840).

4728

This field has been deprecated and replaced by the name field. (required)

4729

zone: string, Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4730

[zone](https://cloud.google.com/compute/docs/zones#available) in which the

4731

cluster resides. This field has been deprecated and replaced by the name

4732

field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4733

clusterId: string, Deprecated. The name of the cluster to upgrade.

4734

This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4735

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4736

The object takes the form of:

4737

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4738

{ # UpdateClusterRequest updates the settings of a cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4739

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade.

4740

# This field has been deprecated and replaced by the name field.

4741

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project

4742

# number](https://support.google.com/cloud/answer/6158840).

4743

# This field has been deprecated and replaced by the name field.

4744

"name": "A String", # The name (project, location, cluster) of the cluster to update.

4745

# Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4746

"update": { # ClusterUpdate describes an update to the cluster. Exactly one update can # Required. A description of the update.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4747

# be applied to a cluster with each request, so at most one field can be

4748

# provided.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4749

"desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an

4750

# upgrade).

4751

#

4752

# Users may specify either explicit versions offered by

4753

# Kubernetes Engine or version aliases, which have the following behavior:

4754

#

4755

# - "latest": picks the highest valid Kubernetes version

4756

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4757

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4758

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4759

# - "-": picks the Kubernetes master version

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4760

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity.

4761

# policies.

4762

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

4763

},

4764

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.

4765

# required by Vertical Pod Autoscaler to automatically adjust

4766

# the resources of pods controlled by it.

4767

"enabled": True or False, # Enables vertical pod autoscaling.

4768

},

4769

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

4770

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a

4771

# daemonset will be created in the cluster to meter network egress traffic.

4772

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

4773

"datasetId": "A String", # The ID of a BigQuery Dataset.

4774

},

4775

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

4776

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a

4777

# second BigQuery table will be created to hold resource consumption

# records.

},

},

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to.

4782

#

4783

# Users may specify either explicit versions offered by

4784

# Kubernetes Engine or version aliases, which have the following behavior:

4785

#

4786

# - "latest": picks the highest valid Kubernetes version

4787

# - "1.X": picks the highest valid patch+gke.N patch in the 1.X version

4788

# - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version

4789

# - "1.X.Y-gke.N": picks an explicit Kubernetes version

4790

# - "-": picks the default Kubernetes version

4791

"desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics.

4792

# Currently available options:

4793

#

4794

# * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring

4795

# service with a Kubernetes-native resource model

4796

# * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no

4797

# longer available as of GKE 1.15).

4798

# * `none` - No metrics will be exported from the cluster.

4799

#

4800

# If left as an empty string,`monitoring.googleapis.com/kubernetes` will be

4801

# used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

4802

"desiredLoggingService": "A String", # The logging service the cluster should use to write logs.

4803

# Currently available options:

4804

#

4805

# * `logging.googleapis.com/kubernetes` - The Cloud Logging

4806

# service with a Kubernetes-native resource model

4807

# * `logging.googleapis.com` - The legacy Cloud Logging service (no longer

4808

# available as of GKE 1.15).

4809

# * `none` - no logs will be exported from the cluster.

4810

#

4811

# If left as an empty string,`logging.googleapis.com/kubernetes` will be

4812

# used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

4813

"desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.

4814

# cluster, enabling additional functionality.

4815

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.

4816

# This addon is deprecated, and will be disabled in 1.15. It is recommended

4817

# to use the Cloud Console to manage and monitor your Kubernetes clusters,

4818

# workloads and applications. For more information, see:

4819

# https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

4820

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

4821

},

4822

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a

4823

# managed Knative service.

4824

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

4825

},

4826

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which

4827

# makes it easy to set up HTTP load balancers for services in a cluster.

4828

# which makes it easy to set up HTTP load balancers for services in a cluster.

4829

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.

4830

# When enabled, it runs a small pod in the cluster that manages the load

4831

# balancers.

4832

},

4833

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which

4834

# increases or decreases the number of replica pods a replication controller

4835

# has based on the resource usage of the existing pods.

4836

# increases or decreases the number of replica pods a replication controller

4837

# has based on the resource usage of the existing pods.

4838

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.

4839

# When enabled, it ensures that metrics are collected into Stackdriver

4840

# Monitoring.

4841

},

4842

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

4843

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

4844

},

4845

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon

4846

# is enabled or not on the Master, it does not track whether network policy

4847

# is enabled for the nodes.

4848

# is enabled or not on the Master, it does not track whether network policy

4849

# is enabled for the nodes.

4850

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

4851

},

4852

},

4853

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in

4854

# desired_node_pool_id. If there is only one pool in the

4855

# cluster and desired_node_pool_id is not provided then

4856

# the change applies to that single node pool.

4857

# adjust the size of the node pool to the current cluster usage.

4858

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=

4859

# max_node_count.

4860

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There

4861

# has to enough quota to scale up the cluster.

4862

"enabled": True or False, # Is autoscaling enabled for this node pool.

4863

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

4864

},

4865

"desiredLocations": [ # The desired list of Google Compute Engine

4866

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4867

# cluster's nodes should be located. Changing the locations a cluster is in

4868

# will result in nodes being either created or removed from the cluster,

4869

# depending on whether locations are being added or removed.

4870

#

4871

# This list must always include the cluster's primary zone.

4872

"A String",

4873

],

4874

"desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature.

4875

# master authorized networks will disallow all external traffic to access

4876

# Kubernetes master through HTTPS except traffic from the given CIDR blocks,

4877

# Google Compute Engine Public IPs and Google Prod IPs.

4878

"enabled": True or False, # Whether or not master authorized networks is enabled.

4879

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access

4880

# Kubernetes master through HTTPS.

4881

{ # CidrBlock contains an optional name and one CIDR block.

4882

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

4883

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

4884

},

4885

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4886

},

4887

"desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4888

# required by Cluster Autoscaler to automatically adjust

4889

# the size of the cluster and create/delete

4890

# node pools based on the current needs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4891

"resourceLimits": [ # Contains global constraints regarding minimum and maximum

4892

# amount of resources in the cluster.

4893

{ # Contains information about amount of some resource in the cluster.

4894

# For memory, value should be in GB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4895

"minimum": "A String", # Minimum amount of the resource in the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4896

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4897

"maximum": "A String", # Maximum amount of the resource in the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4898

},

4899

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4900

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4901

# created by NAP.

4902

# by NAP.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4903

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4904

"management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4905

# node pool.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4906

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4907

# the Auto Upgrades will proceed.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4908

"description": "A String", # [Output only] This field is set when upgrades are about to commence

4909

# with the description of the upgrade.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4910

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4911

# with the approximate start time for the upgrades, in

4912

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

4913

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4914

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node

4915

# pool. If enabled, the nodes in this node pool will be monitored and, if

4916

# they fail health checks too many times, an automatic repair action will be

4917

# triggered.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4918

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node

4919

# pool. If enabled, node auto-upgrade helps keep the nodes in your node pool

4920

# up to date with the latest release version of Kubernetes.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4921

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4922

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4923

# disruption caused by an upgrade.

4924

#

4925

# maxUnavailable controls the number of nodes that can be simultaneously

4926

# unavailable.

4927

#

4928

# maxSurge controls the number of additional nodes that can be added to the

4929

# node pool temporarily for the time of the upgrade to increase the number of

4930

# available nodes.

4931

#

4932

# (maxUnavailable + maxSurge) determines the level of parallelism (how many

4933

# nodes are being upgraded at the same time).

4934

#

4935

# Note: upgrades inevitably introduce some disruption since workloads need to

4936

# be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,

4937

# this holds true. (Disruption stays within the limits of

4938

# PodDisruptionBudget, if it is configured.)

4939

#

4940

# Consider a hypothetical node pool with 5 nodes having maxSurge=2,

4941

# maxUnavailable=1. This means the upgrade process upgrades 3 nodes

4942

# simultaneously. It creates 2 additional (upgraded) nodes, then it brings

4943

# down 3 old (not yet upgraded) nodes at the same time. This ensures that

4944

# there are always at least 4 nodes available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4945

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4946

# the upgrade process. A node is considered available if its status is

4947

# Ready.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4948

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size

4949

# of the node pool during the upgrade process.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4950

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4951

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

4952

"A String",

4953

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4954

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4955

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

4956

"autoprovisioningLocations": [ # The list of Google Compute Engine

4957

# [zones](https://cloud.google.com/compute/docs/zones#available) in which the

4958

# NodePool's nodes can be created by NAP.

"A String",

],

},

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if

4963

# "desired_node_version", "desired_image_family" or

4964

# "desired_node_pool_autoscaling" is specified and there is more than one

4965

# node pool on the cluster.

4966

"desiredImageType": "A String", # The desired image type for the node pool.

4967

# NOTE: Set the "desired_node_pool" field as well.

4968

"desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is # The desired release channel configuration.

4969

# subscribed to. Release channels are arranged in order of risk.

4970

#

4971

# When a cluster is subscribed to a release channel, Google maintains

4972

# both the master version and the node version. Node auto-upgrade

4973

# defaults to true and cannot be disabled.

4974

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

4975

},

4976

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility.

4977

# visibility on this cluster.

4978

"enabled": True or False, # Enables intra node visibility for this cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4979

},

4980

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4981

"state": "A String", # Denotes the state of etcd encryption.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4982

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.

4983

# Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4984

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4985

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

4986

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4987

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4988

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

4989

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container

4990

# images will be validated by Binary Authorization.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4991

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4992

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4993

"zone": "A String", # Deprecated. The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4994

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

4995

# cluster resides. This field has been deprecated and replaced by the name

4996

# field.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4997

}

4998

4999

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5000

Allowed values

5001

1 - v1 error format

5002

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

5003

5004

Returns:

5005

An object of the form:

5006

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5007

{ # This operation resource represents operations that may have happened or are

5008

# happening on the cluster. All fields are output only.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5009

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

5010

"name": "A String", # A non-parameterized string describing an operation stage.

5011

# Unset for single-stage operations.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5012

"metrics": [ # Progress metric bundle, for example:

5013

# metrics: [{name: "nodes done", int_value: 15},

5014

# {name: "nodes total", int_value: 32}]

5015

# or

5016

# metrics: [{name: "progress", double_value: 0.56},

5017

# {name: "progress scale", double_value: 1.0}]

5018

{ # Progress metric is (string, int|float|string) pair.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5019

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5020

"doubleValue": 3.14, # For metrics with floating point value.

5021

"intValue": "A String", # For metrics with integer value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5022

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5023

},

5024

],

5025

"status": "A String", # Status of an operation stage.

5026

# Unset for single-stage operations.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5027

"stages": [ # Substages of an operation or a stage.

5028

# Object with schema name: OperationProgress

5029

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5030

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5031

"targetLink": "A String", # Server-defined URL for the target of the operation.

5032

"status": "A String", # The current status of the operation.

5033

"operationType": "A String", # The operation type.

5034

"startTime": "A String", # [Output only] The time the operation started, in

5035

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

5036

"clusterConditions": [ # Which conditions caused the current cluster state.

5037

{ # StatusCondition describes why a cluster or a node pool has a certain status

5038

# (e.g., ERROR or DEGRADED).

5039

"message": "A String", # Human-friendly representation of the condition

5040

"code": "A String", # Machine-friendly representation of the condition

5041

},

5042

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5043

"zone": "A String", # The name of the Google Compute Engine

5044

# [zone](https://cloud.google.com/compute/docs/zones#available) in which the

5045

# operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5046

"selfLink": "A String", # Server-defined URL for the resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5047

"name": "A String", # The server-assigned ID for the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5048

"detail": "A String", # Detailed operation progress, if available.

5049

"endTime": "A String", # [Output only] The time the operation completed, in

5050

# [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5051

"nodepoolConditions": [ # Which conditions caused the current node pool state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5052

{ # StatusCondition describes why a cluster or a node pool has a certain status

5053

# (e.g., ERROR or DEGRADED).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5054

"message": "A String", # Human-friendly representation of the condition

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5055

"code": "A String", # Machine-friendly representation of the condition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5056

},

5057

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5058

"location": "A String", # [Output only] The name of the Google Compute Engine

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5059

# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5060

# or

5061

# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)

5062

# in which the cluster resides.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5063

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

Takashi Matsuo