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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

86

<code><a href="#close">close()</a></code></p>

87

<p class="firstline">Close httplib2 connections.</p>

88

Dan O'Meara

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

[diff] [blame]

89

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

90

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

91

Dan O'Meara

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

[diff] [blame]

92

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

93

<p class="firstline">Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.</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="#delete">delete(projectId, zone, clusterId, name=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

96

<p class="firstline">Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.</p>

Takashi Matsuo

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

[diff] [blame]

97

Bu Sun Kim

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

[diff] [blame]

98

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

99

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

Takashi Matsuo

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

[diff] [blame]

100

Dan O'Meara

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

[diff] [blame]

101

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

102

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

103

Bu Sun Kim

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

[diff] [blame]

104

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

105

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

Sai Cheemalapati

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

[diff] [blame]

106

Dan O'Meara

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

[diff] [blame]

107

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

108

<p class="firstline">Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.</p>

Bu Sun Kim

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

[diff] [blame]

109

Dan O'Meara

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

[diff] [blame]

110

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

111

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

112

Dan O'Meara

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

[diff] [blame]

113

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

114

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

115

Dan O'Meara

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

[diff] [blame]

116

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

117

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

118

Dan O'Meara

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

[diff] [blame]

119

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

120

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

121

Dan O'Meara

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

[diff] [blame]

122

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

123

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

124

Dan O'Meara

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

[diff] [blame]

125

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

126

<p class="firstline">Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.</p>

Bu Sun Kim

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

[diff] [blame]

127

Dan O'Meara

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

[diff] [blame]

128

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

129

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

Sai Cheemalapati

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

[diff] [blame]

130

Dan O'Meara

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

[diff] [blame]

131

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

132

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

Takashi Matsuo

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

[diff] [blame]

133

Dan O'Meara

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

[diff] [blame]

134

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

135

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

Takashi Matsuo

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

[diff] [blame]

136

<h3>Method Details</h3>

137

Dan O'Meara

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

[diff] [blame]

138

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

139

<pre>Sets the addons for a specific cluster.

Takashi Matsuo

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

[diff] [blame]

140

141

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

142

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

143

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

144

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

145

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

146

The object takes the form of:

147

Bu Sun Kim

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

[diff] [blame]

148

{ # SetAddonsConfigRequest sets the addons associated with the cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

149

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Required. The desired configurations for the various addons available to run in the cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

150

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

151

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

Bu Sun Kim

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

[diff] [blame]

152

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

153

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.

154

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.

155

},

156

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

157

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

158

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

159

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

160

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

161

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

162

},

163

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.

164

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

165

},

166

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.

167

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.

Bu Sun Kim

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

[diff] [blame]

168

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

169

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API

170

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

171

},

Bu Sun Kim

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

[diff] [blame]

172

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

173

"name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

174

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

175

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

176

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Sai Cheemalapati

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

[diff] [blame]

177

}

178

179

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

186

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

187

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

188

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

189

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

190

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

191

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

192

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

193

},

194

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

195

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

196

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

197

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

198

# Object with schema name: OperationProgress

199

],

200

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

201

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

202

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

203

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

204

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

205

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

206

},

207

],

208

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

209

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

210

},

211

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

212

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

213

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

214

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

215

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

216

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

217

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

218

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

219

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

220

},

221

],

222

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

223

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

224

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

225

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

230

<code class="details" id="close">close()</code>

231

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

235

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

236

<pre>Completes master IP rotation.

237

238

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

239

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. (required)

240

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

241

clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

242

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

243

The object takes the form of:

244

245

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

246

"name": "A String", # The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

247

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

248

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

249

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.

Bu Sun Kim

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

[diff] [blame]

250

}

251

252

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

259

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

260

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

261

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

262

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

263

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

264

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

265

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

266

},

267

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

268

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

269

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

270

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

271

# Object with schema name: OperationProgress

272

],

273

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

274

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

275

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

276

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

277

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

278

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

279

},

280

],

281

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

282

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

283

},

284

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

285

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

286

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

287

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

288

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

289

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

290

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

291

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

292

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

293

},

294

],

295

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

296

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

297

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

298

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

303

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

304

<pre>Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

Sai Cheemalapati

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

[diff] [blame]

305

306

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

307

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. (required)

308

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)

Dan O'Meara

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

[diff] [blame]

309

body: object, The request body.

Takashi Matsuo

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

[diff] [blame]

310

The object takes the form of:

311

312

{ # CreateClusterRequest creates a cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

313

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

314

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.

315

"parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

316

"cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

317

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

318

"currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

319

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

320

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

321

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

322

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

323

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

324

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

325

},

326

],

327

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.

328

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration.

329

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

330

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

331

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

332

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic.

333

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

334

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

335

"network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

336

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

337

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

338

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

339

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

340

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.

Bu Sun Kim

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

[diff] [blame]

341

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

342

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

343

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version

344

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

345

"A String",

346

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

347

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

348

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

349

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

Bu Sun Kim

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

[diff] [blame]

350

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

351

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

352

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

Bu Sun Kim

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

[diff] [blame]

353

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

354

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

355

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

356

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).

357

"expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

358

"createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

359

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.

360

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

Bu Sun Kim

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

[diff] [blame]

361

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

362

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

363

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

364

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

365

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

366

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.

367

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

368

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.

369

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

370

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

371

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

372

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

373

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

374

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

375

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

Bu Sun Kim

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

[diff] [blame]

376

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

377

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

378

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

379

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

Bu Sun Kim

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

[diff] [blame]

380

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

381

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.

382

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.

383

},

384

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

385

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

386

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

387

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

388

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

389

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

390

},

391

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.

392

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

393

},

394

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.

395

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.

Bu Sun Kim

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

[diff] [blame]

396

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

397

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API

398

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

Bu Sun Kim

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

[diff] [blame]

399

},

Bu Sun Kim

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

[diff] [blame]

400

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

401

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

402

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

403

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.

404

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

405

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.

406

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

407

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

408

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

409

},

410

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

411

},

412

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

413

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

414

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

415

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

416

},

417

},

418

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

419

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".

420

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

},

},

},

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

425

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.

426

},

427

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

428

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

429

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

430

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

431

"enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.

432

},

433

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

434

"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

435

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

436

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

437

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

438

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

439

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

440

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

441

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.

442

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

443

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

444

},

445

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.

446

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

447

},

448

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

449

"nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

450

{ # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

451

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

452

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

453

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.

454

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

455

"A String",

456

],

457

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

458

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.

459

},

460

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

461

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

462

},

463

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

464

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

465

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

466

},

467

"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.

468

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.

469

"localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.

470

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

471

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

472

"A String",

473

],

474

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

475

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

476

"imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used.

477

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

478

"a_key": "A String",

479

},

480

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

481

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

482

},

483

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

484

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

485

"a_key": "A String",

486

},

487

"accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

488

{ # AcceleratorConfig represents a Hardware Accelerator request.

489

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

490

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

491

},

492

],

493

"taints": [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

494

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.

495

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

496

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

497

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

498

},

499

],

500

"oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

501

"A String",

502

],

503

"nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

504

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

505

"statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.

506

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

507

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

508

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.

509

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

510

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

511

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

512

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

513

"A String",

514

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

515

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

516

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

517

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

518

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

519

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

520

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

521

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

522

},

523

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

524

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

525

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool.

526

"A String",

527

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

528

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

529

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

530

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

531

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

532

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

533

},

534

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

535

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

536

},

537

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

538

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

539

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

540

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

541

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

542

},

543

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

544

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

545

},

546

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

547

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

548

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

549

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.

550

},

551

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.

552

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

553

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

554

},

555

},

556

"name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.

557

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

558

"zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.

559

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

560

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.

561

"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.

562

"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

563

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature.

564

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.

565

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

566

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

567

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

568

},

569

],

570

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

571

},

572

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.

573

"masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued.

574

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

575

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

576

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

577

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

578

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

579

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.

580

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

581

},

582

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

583

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

584

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

585

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

586

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

587

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

588

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.

589

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

590

"A String",

591

],

592

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

593

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.

594

},

595

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

596

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

597

},

598

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

599

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

600

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

601

},

602

"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.

603

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.

604

"localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.

605

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

606

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

607

"A String",

608

],

609

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

610

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

611

"imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used.

612

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

613

"a_key": "A String",

614

},

615

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

616

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

617

},

618

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

619

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

620

"a_key": "A String",

621

},

622

"accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

623

{ # AcceleratorConfig represents a Hardware Accelerator request.

624

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

625

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

626

},

627

],

628

"taints": [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

629

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.

630

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

631

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

632

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

633

},

634

],

635

"oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

636

"A String",

637

],

638

"nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

639

},

640

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.

641

"autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.

642

"A String",

643

],

644

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

645

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

646

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

647

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

648

"A String",

649

],

650

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

651

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Specifies the upgrade settings for NAP created node pools

652

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

653

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

654

},

655

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

656

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value.

657

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

658

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

659

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

660

},

661

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

662

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

663

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

664

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

665

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

666

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

667

},

668

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

669

},

670

},

671

"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.

672

{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.

673

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

674

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

675

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

},

],

},

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

680

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

681

},

682

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

683

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.

684

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

685

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

686

},

687

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.

Bu Sun Kim

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

[diff] [blame]

688

"A String",

689

],

Takashi Matsuo

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

694

Allowed values

695

1 - v1 error format

696

2 - v2 error format

Takashi Matsuo

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

[diff] [blame]

697

698

Returns:

699

An object of the form:

700

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

701

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

702

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

703

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

704

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

705

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

706

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

707

},

708

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

709

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

710

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

711

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

712

# Object with schema name: OperationProgress

713

],

714

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

715

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

716

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

717

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

718

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

719

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

720

},

721

],

722

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

723

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

724

},

725

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

726

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

727

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

728

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

729

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

730

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

731

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

732

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

733

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

734

},

735

],

736

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

737

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

738

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

739

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

744

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

745

<pre>Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

Takashi Matsuo

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

[diff] [blame]

746

747

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

748

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

749

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

750

clusterId: string, Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. (required)

751

name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`.

Takashi Matsuo

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

[diff] [blame]

752

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

753

Allowed values

754

1 - v1 error format

755

2 - v2 error format

Takashi Matsuo

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

[diff] [blame]

756

757

Returns:

758

An object of the form:

759

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

760

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

761

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

762

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

763

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

764

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

765

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

766

},

767

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

768

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

769

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

770

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

771

# Object with schema name: OperationProgress

772

],

773

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

774

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

775

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

776

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

777

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

778

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

779

},

780

],

781

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

782

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

783

},

784

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

785

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

786

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

787

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

788

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

789

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

790

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

791

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

792

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

793

},

794

],

795

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

796

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

797

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

798

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

803

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

804

<pre>Gets the details of a specific cluster.

Takashi Matsuo

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

[diff] [blame]

805

806

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

807

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

808

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

809

clusterId: string, Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. (required)

810

name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`.

Takashi Matsuo

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

[diff] [blame]

811

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

812

Allowed values

813

1 - v1 error format

814

2 - v2 error format

Takashi Matsuo

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

[diff] [blame]

815

816

Returns:

817

An object of the form:

818

Bu Sun Kim

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

[diff] [blame]

819

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

820

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

821

"currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

822

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

823

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

824

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

825

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

826

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

827

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

828

},

829

],

830

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.

831

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration.

832

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

833

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

834

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

835

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic.

836

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

837

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

838

"network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

839

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

840

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

841

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

842

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

843

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.

Bu Sun Kim

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

[diff] [blame]

844

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

845

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

846

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version

847

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

848

"A String",

849

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

850

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

851

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

852

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

Bu Sun Kim

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

[diff] [blame]

853

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

854

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

855

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

Bu Sun Kim

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

[diff] [blame]

856

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

857

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

858

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

859

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).

860

"expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

861

"createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

862

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.

863

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

Bu Sun Kim

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

[diff] [blame]

864

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

865

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

866

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

867

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

868

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

869

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.

870

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

871

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.

872

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

873

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

874

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

875

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

876

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

877

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

878

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

Bu Sun Kim

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

[diff] [blame]

879

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

880

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

881

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

882

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

Bu Sun Kim

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

[diff] [blame]

883

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

884

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.

885

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.

886

},

887

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

888

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

889

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

890

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

891

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

892

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

893

},

894

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.

895

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

896

},

897

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.

898

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.

Bu Sun Kim

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

[diff] [blame]

899

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

900

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API

901

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

Bu Sun Kim

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

[diff] [blame]

902

},

Bu Sun Kim

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

[diff] [blame]

903

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

904

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

905

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

906

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.

907

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

908

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.

909

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

910

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

911

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

912

},

913

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

914

},

915

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

916

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

917

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

918

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

919

},

920

},

921

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

922

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".

923

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

},

},

},

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

928

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.

929

},

930

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

931

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

932

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

933

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

934

"enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.

935

},

936

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

937

"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

938

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

939

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

940

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

941

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

942

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

943

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

944

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.

945

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

946

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

947

},

948

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.

949

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

950

},

951

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

952

"nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

953

{ # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

954

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

955

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

956

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.

957

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

958

"A String",

959

],

960

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

961

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.

962

},

963

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

964

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

965

},

966

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

967

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

968

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

969

},

970

"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.

971

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.

972

"localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.

973

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

974

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

975

"A String",

976

],

977

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

978

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

979

"imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used.

980

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

981

"a_key": "A String",

982

},

983

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

984

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

985

},

986

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

987

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

988

"a_key": "A String",

989

},

990

"accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

991

{ # AcceleratorConfig represents a Hardware Accelerator request.

992

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

993

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

994

},

995

],

996

"taints": [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

997

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.

998

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

999

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

1000

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

1001

},

1002

],

1003

"oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

1004

"A String",

1005

],

1006

"nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1007

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1008

"statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.

1009

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

1010

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1011

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.

1012

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

1013

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1014

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1015

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1016

"A String",

1017

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1018

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

1019

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

1020

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1021

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

1022

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1023

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

1024

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

1025

},

1026

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1027

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1028

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool.

1029

"A String",

1030

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1031

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

1032

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

1033

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

1034

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

1035

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

1036

},

1037

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

1038

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

1039

},

1040

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

1041

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

1042

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

1043

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

1044

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1045

},

1046

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

1047

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1048

},

1049

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1050

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

1051

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

1052

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.

1053

},

1054

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.

1055

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

1056

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

1057

},

1058

},

1059

"name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.

1060

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

1061

"zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.

1062

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

1063

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.

1064

"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.

1065

"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

1066

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature.

1067

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.

1068

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

1069

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

1070

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

1071

},

1072

],

1073

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

1074

},

1075

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.

1076

"masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued.

1077

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

1078

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

1079

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

1080

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

1081

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

1082

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.

1083

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

1084

},

1085

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1086

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

1087

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

1088

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1089

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

1090

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

1091

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.

1092

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

1093

"A String",

1094

],

1095

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

1096

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.

1097

},

1098

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

1099

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

1100

},

1101

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

1102

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

1103

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

1104

},

1105

"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.

1106

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.

1107

"localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.

1108

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

1109

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

1110

"A String",

1111

],

1112

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1113

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

1114

"imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used.

1115

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

1116

"a_key": "A String",

1117

},

1118

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

1119

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

1120

},

1121

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

1122

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

1123

"a_key": "A String",

1124

},

1125

"accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

1126

{ # AcceleratorConfig represents a Hardware Accelerator request.

1127

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

1128

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

1129

},

1130

],

1131

"taints": [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1132

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.

1133

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

1134

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

1135

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

1136

},

1137

],

1138

"oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

1139

"A String",

1140

],

1141

"nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

1142

},

1143

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.

1144

"autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.

1145

"A String",

1146

],

1147

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

1148

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

1149

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

1150

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

1151

"A String",

1152

],

1153

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

1154

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Specifies the upgrade settings for NAP created node pools

1155

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

1156

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1157

},

1158

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

1159

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value.

1160

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

1161

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

1162

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

1163

},

1164

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

1165

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

1166

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

1167

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

1168

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

1169

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1170

},

1171

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

1172

},

1173

},

1174

"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.

1175

{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.

1176

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

1177

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

1178

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

},

],

},

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

1183

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

1184

},

1185

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

1186

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.

1187

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

1188

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

1189

},

1190

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.

Bu Sun Kim

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

[diff] [blame]

1191

"A String",

1192

],

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]

1197

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

1198

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

Takashi Matsuo

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

[diff] [blame]

1199

1200

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1201

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

1202

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

1203

clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

1204

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1205

The object takes the form of:

1206

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1207

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1208

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1209

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1210

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1211

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

1212

"clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

Sai Cheemalapati

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

[diff] [blame]

1213

}

1214

Takashi Matsuo

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

[diff] [blame]

1215

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:

1222

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1223

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

1224

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1225

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

1226

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1227

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

1228

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

1229

},

1230

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1231

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

1232

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

1233

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

1234

# Object with schema name: OperationProgress

1235

],

1236

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

1237

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

1238

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

1239

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

1240

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

1241

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

1242

},

1243

],

1244

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

1245

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

1246

},

1247

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1248

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

1249

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

1250

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

1251

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

1252

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

1253

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1254

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

1255

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

1256

},

1257

],

1258

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1259

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

1260

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

1261

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

1266

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1267

<pre>Lists all clusters owned by a project in either the specified zone or all zones.

Sai Cheemalapati

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

[diff] [blame]

1268

1269

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1270

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. (required)

1271

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)

1272

parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.

Sai Cheemalapati

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

[diff] [blame]

1273

x__xgafv: string, V1 error format.

1274

Allowed values

1275

1 - v1 error format

1276

2 - v2 error format

Takashi Matsuo

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

[diff] [blame]

1277

1278

Returns:

1279

An object of the form:

1280

1281

{ # ListClustersResponse is the result of ListClustersRequest.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1282

"clusters": [ # A list of clusters in the project in the specified zone, or across all ones.

Bu Sun Kim

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

[diff] [blame]

1283

{ # A Google Kubernetes Engine cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1284

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

1285

"currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

1286

"monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1287

"endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1288

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

1289

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1290

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

1291

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

1292

},

1293

],

1294

"servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.

1295

"releaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration.

1296

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

1297

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1298

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1299

"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic.

1300

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

1301

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1302

"network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1303

"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1304

"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1305

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1306

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

1307

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.

Bu Sun Kim

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

[diff] [blame]

1308

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1309

"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.

1310

"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version

1311

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

1312

"A String",

1313

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1314

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

1315

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

1316

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

Bu Sun Kim

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

[diff] [blame]

1317

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1318

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

1319

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

Bu Sun Kim

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

[diff] [blame]

1320

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1321

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

1322

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

1323

"tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).

1324

"expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1325

"createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1326

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.

1327

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

Bu Sun Kim

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

[diff] [blame]

1328

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1329

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

1330

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

1331

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

1332

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

1333

"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.

1334

"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

1335

"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.

1336

"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

1337

"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

1338

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

1339

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

1340

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

1341

"useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

1342

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. 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) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.

Bu Sun Kim

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

[diff] [blame]

1343

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1344

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1345

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

1346

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

Bu Sun Kim

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

[diff] [blame]

1347

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1348

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.

1349

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.

1350

},

1351

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

1352

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

1353

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

1354

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1355

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

1356

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

1357

},

1358

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.

1359

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1360

},

1361

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.

1362

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.

Bu Sun Kim

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

[diff] [blame]

1363

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1364

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API

1365

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

Bu Sun Kim

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

[diff] [blame]

1366

},

Bu Sun Kim

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

[diff] [blame]

1367

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1368

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

1369

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

1370

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.

1371

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

1372

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.

1373

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

1374

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

1375

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

1376

},

1377

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

1378

},

1379

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

1380

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

1381

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

1382

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

1383

},

1384

},

1385

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

1386

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".

1387

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

},

},

},

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

1392

"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.

1393

},

1394

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

1395

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

1396

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

1397

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

1398

"enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.

1399

},

1400

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1401

"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

1402

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1403

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1404

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

1405

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

1406

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

1407

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

1408

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.

1409

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

1410

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

1411

},

1412

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.

1413

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

1414

},

1415

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1416

"nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

1417

{ # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1418

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

1419

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

1420

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.

1421

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

1422

"A String",

1423

],

1424

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

1425

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.

1426

},

1427

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

1428

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

1429

},

1430

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

1431

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

1432

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

1433

},

1434

"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.

1435

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.

1436

"localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.

1437

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

1438

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

1439

"A String",

1440

],

1441

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1442

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

1443

"imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used.

1444

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

1445

"a_key": "A String",

1446

},

1447

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

1448

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

1449

},

1450

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

1451

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

1452

"a_key": "A String",

1453

},

1454

"accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

1455

{ # AcceleratorConfig represents a Hardware Accelerator request.

1456

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

1457

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

1458

},

1459

],

1460

"taints": [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1461

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.

1462

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

1463

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

1464

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

1465

},

1466

],

1467

"oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

1468

"A String",

1469

],

1470

"nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1471

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1472

"statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.

1473

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

1474

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1475

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.

1476

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

1477

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1478

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1479

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1480

"A String",

1481

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1482

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

1483

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

1484

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1485

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

1486

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1487

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

1488

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

1489

},

1490

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1491

"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1492

"instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool.

1493

"A String",

1494

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1495

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

1496

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

1497

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

1498

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

1499

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

1500

},

1501

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

1502

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

1503

},

1504

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

1505

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

1506

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

1507

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

1508

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1509

},

1510

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

1511

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1512

},

1513

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1514

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

1515

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

1516

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.

1517

},

1518

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.

1519

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

1520

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

1521

},

1522

},

1523

"name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.

1524

"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

1525

"zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.

1526

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

1527

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.

1528

"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.

1529

"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

1530

"masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature.

1531

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.

1532

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

1533

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

1534

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

1535

},

1536

],

1537

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

1538

},

1539

"nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.

1540

"masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued.

1541

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

1542

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

1543

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

1544

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

1545

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

1546

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.

1547

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

1548

},

1549

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1550

"defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

1551

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

1552

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1553

"nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

1554

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

1555

"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.

1556

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

1557

"A String",

1558

],

1559

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

1560

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.

1561

},

1562

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

1563

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

1564

},

1565

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

1566

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

1567

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

1568

},

1569

"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.

1570

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.

1571

"localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.

1572

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

1573

"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

1574

"A String",

1575

],

1576

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)

1577

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

1578

"imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used.

1579

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

1580

"a_key": "A String",

1581

},

1582

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

1583

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

1584

},

1585

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

1586

"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

1587

"a_key": "A String",

1588

},

1589

"accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

1590

{ # AcceleratorConfig represents a Hardware Accelerator request.

1591

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

1592

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

1593

},

1594

],

1595

"taints": [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

1596

{ # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.

1597

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

1598

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

1599

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

1600

},

1601

],

1602

"oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

1603

"A String",

1604

],

1605

"nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).

1606

},

1607

"autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.

1608

"autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.

1609

"A String",

1610

],

1611

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

1612

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

1613

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

1614

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

1615

"A String",

1616

],

1617

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

1618

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Specifies the upgrade settings for NAP created node pools

1619

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

1620

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1621

},

1622

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

1623

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value.

1624

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

1625

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

1626

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

1627

},

1628

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

1629

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

1630

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

1631

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

1632

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

1633

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1634

},

1635

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

1636

},

1637

},

1638

"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.

1639

{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.

1640

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

1641

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

1642

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

},

],

},

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

1647

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

1648

},

1649

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

1650

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.

1651

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

1652

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

1653

},

1654

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.

Bu Sun Kim

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

[diff] [blame]

1655

"A String",

1656

],

Bu Sun Kim

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

[diff] [blame]

1657

},

1658

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1659

"missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.

Bu Sun Kim

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

[diff] [blame]

1660

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

1666

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1667

<pre>Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

Bu Sun Kim

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

[diff] [blame]

1668

1669

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1670

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

1671

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

1672

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

1673

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1674

The object takes the form of:

1675

1676

{ # SetLocationsRequest sets the locations of the cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1677

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1678

"locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.

Bu Sun Kim

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

[diff] [blame]

1679

"A String",

Bu Sun Kim

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

[diff] [blame]

1680

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1681

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1682

"name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1683

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

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

[diff] [blame]

1684

}

1685

1686

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1693

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1694

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

1695

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1696

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

1697

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1698

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

1699

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

1700

},

1701

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1702

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

1703

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

1704

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

1705

# Object with schema name: OperationProgress

1706

],

1707

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

1708

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

1709

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

1710

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

1711

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

1712

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

1713

},

1714

],

1715

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

1716

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

1717

},

1718

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1719

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

1720

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

1721

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

1722

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

1723

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

1724

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1725

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

1726

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

1727

},

1728

],

1729

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1730

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

1731

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

1732

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

1737

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

1738

<pre>Sets the logging service for a specific cluster.

1739

1740

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1741

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

1742

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

1743

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

1744

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1745

The object takes the form of:

1746

1747

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1748

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1749

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1750

"name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1751

"loggingService": "A String", # Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1752

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

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

[diff] [blame]

1753

}

1754

1755

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1762

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1763

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

1764

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1765

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

1766

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1767

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

1768

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

1769

},

1770

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1771

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

1772

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

1773

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

1774

# Object with schema name: OperationProgress

1775

],

1776

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

1777

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

1778

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

1779

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

1780

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

1781

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

1782

},

1783

],

1784

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

1785

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

1786

},

1787

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1788

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

1789

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

1790

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

1791

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

1792

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

1793

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1794

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

1795

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

1796

},

1797

],

1798

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1799

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

1800

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

1801

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

1806

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

1807

<pre>Updates the master for a specific cluster.

1808

1809

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1810

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

1811

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

1812

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

1813

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1814

The object takes the form of:

1815

1816

{ # UpdateMasterRequest updates the master of the cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1817

"masterVersion": "A String", # Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1818

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1819

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1820

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1821

"name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

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

[diff] [blame]

1822

}

1823

1824

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1831

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1832

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

1833

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1834

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

1835

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1836

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

1837

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

1838

},

1839

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1840

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

1841

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

1842

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

1843

# Object with schema name: OperationProgress

1844

],

1845

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

1846

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

1847

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

1848

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

1849

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

1850

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

1851

},

1852

],

1853

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

1854

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

1855

},

1856

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1857

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

1858

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

1859

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

1860

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

1861

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

1862

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1863

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

1864

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

1865

},

1866

],

1867

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1868

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

1869

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

1870

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

1875

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

1876

<pre>Sets the monitoring service for a specific cluster.

1877

1878

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1879

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

1880

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

1881

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

1882

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1883

The object takes the form of:

1884

1885

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1886

"monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

1887

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

1888

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1889

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1890

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Bu Sun Kim

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

[diff] [blame]

1891

}

1892

1893

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1900

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1901

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

1902

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1903

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

1904

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1905

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

1906

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

1907

},

1908

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1909

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

1910

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

1911

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

1912

# Object with schema name: OperationProgress

1913

],

1914

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

1915

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

1916

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

1917

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

1918

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

1919

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

1920

},

1921

],

1922

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

1923

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

1924

},

1925

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1926

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

1927

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

1928

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

1929

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

1930

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

1931

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1932

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

1933

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

1934

},

1935

],

1936

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1937

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

1938

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

1939

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

1944

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

1945

<pre>Sets labels on a cluster.

1946

1947

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1948

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. (required)

1949

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

1950

clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

1951

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1952

The object takes the form of:

1953

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1954

{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1955

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1956

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1957

"resourceLabels": { # Required. The labels to set for that cluster.

1958

"a_key": "A String",

1959

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1960

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.

1961

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.

1962

"labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint.

Sai Cheemalapati

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

[diff] [blame]

1963

}

1964

1965

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1972

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1973

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

1974

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1975

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

1976

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1977

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

1978

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

1979

},

1980

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1981

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

1982

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

1983

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

1984

# Object with schema name: OperationProgress

1985

],

1986

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

1987

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

1988

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

1989

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

1990

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

1991

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

1992

},

1993

],

1994

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

1995

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

1996

},

1997

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1998

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

1999

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

2000

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

2001

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

2002

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

2003

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2004

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

2005

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

2006

},

2007

],

2008

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2009

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

2010

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

2011

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

2016

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

2017

<pre>Sets the maintenance policy for a cluster.

Sai Cheemalapati

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

[diff] [blame]

2018

2019

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2020

projectId: string, Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)

2021

zone: string, Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. (required)

Dan O'Meara

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

[diff] [blame]

2022

clusterId: string, Required. The name of the cluster to update. (required)

2023

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

2024

The object takes the form of:

2025

Bu Sun Kim

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

[diff] [blame]

2026

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2027

"zone": "A String", # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.

2028

"projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).

2029

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2030

"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 clears the existing maintenance policy.

2031

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.

Bu Sun Kim

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

[diff] [blame]

2032

"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-11-16 11:05:03 -0700

[diff] [blame]

2033

"recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.

2034

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

2035

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

2036

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

2037

},

2038

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

2039

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2040

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

2041

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2042

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2043

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

2044

},

Bu Sun Kim

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

[diff] [blame]

2045

},

Bu Sun Kim

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

[diff] [blame]

2046

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2047

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".

2048

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Dan O'Meara

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

[diff] [blame]

2049

},

Bu Sun Kim

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

[diff] [blame]

2050

},

Sai Cheemalapati

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

[diff] [blame]

2051

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2052

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.

Sai Cheemalapati

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

[diff] [blame]

2053

}

2054

2055

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2062

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2063

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2064

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2065

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

2066

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2067

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

2068

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

2069

},

2070

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2071

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

2072

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

2073

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

2074

# Object with schema name: OperationProgress

2075

],

2076

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

2077

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

2078

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

2079

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

2080

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

2081

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

2082

},

2083

],

2084

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2085

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

2086

},

2087

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2088

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

2089

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

2090

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

2091

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

2092

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

2093

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2094

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

2095

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

2096

},

2097

],

2098

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2099

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

2100

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

2101

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

2106

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2107

<pre>Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Bu Sun Kim

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

[diff] [blame]

2108

2109

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2110

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

2111

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2112

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

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

[diff] [blame]

2113

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

2114

The object takes the form of:

2115

2116

{ # SetMasterAuthRequest updates the admin password of a cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2117

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2118

"action": "A String", # Required. The exact form of action to be taken on the master auth.

2119

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2120

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.

2121

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2122

"update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2123

"password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

2124

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

2125

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

2126

"username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

2127

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2128

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.

Bu Sun Kim

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

[diff] [blame]

2129

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

Bu Sun Kim

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

[diff] [blame]

2130

},

Bu Sun Kim

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

[diff] [blame]

2131

},

Bu Sun Kim

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

[diff] [blame]

2132

}

2133

2134

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2141

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2142

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2143

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2144

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

2145

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2146

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

2147

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

2148

},

2149

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2150

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

2151

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

2152

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

2153

# Object with schema name: OperationProgress

2154

],

2155

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

2156

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

2157

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

2158

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

2159

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

2160

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

2161

},

2162

],

2163

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2164

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

2165

},

2166

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2167

"operationType": "A String", # The operation type.

2168

"selfLink": "A String", # Server-defined URL for the resource.

2169

"targetLink": "A String", # Server-defined URL for the target of the operation.

2170

"status": "A String", # The current status of the operation.

2171

"nodepoolConditions": [ # Which conditions caused the current node pool state.

2172

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2173

"message": "A String", # Human-friendly representation of the condition

2174

"code": "A String", # Machine-friendly representation of the condition

2175

},

2176

],

2177

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2178

"name": "A String", # The server-assigned ID for the operation.

2179

"detail": "A String", # Detailed operation progress, if available.

2180

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

2185

<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]

2186

<pre>Enables or disables Network Policy for a cluster.

2187

2188

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2189

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. (required)

2190

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2191

clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2192

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2193

The object takes the form of:

2194

2195

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2196

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2197

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Required. Configuration options for the NetworkPolicy feature.

2198

"enabled": True or False, # Whether network policy is enabled on the cluster.

2199

"provider": "A String", # The selected network policy provider.

2200

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2201

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

2202

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2203

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2204

}

2205

2206

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2213

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2214

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2215

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2216

"clusterConditions": [ # Which conditions caused the current cluster state.

2217

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2218

"message": "A String", # Human-friendly representation of the condition

2219

"code": "A String", # Machine-friendly representation of the condition

2220

},

2221

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2222

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

2223

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2224

"stages": [ # Substages of an operation or a stage.

2225

# Object with schema name: OperationProgress

2226

],

2227

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

2228

{ # Progress metric is (string, int|float|string) pair.

2229

"intValue": "A String", # For metrics with integer value.

2230

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2231

"doubleValue": 3.14, # For metrics with floating point value.

2232

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2233

},

2234

],

2235

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2236

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2237

},

2238

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2239

"operationType": "A String", # The operation type.

2240

"selfLink": "A String", # Server-defined URL for the resource.

2241

"targetLink": "A String", # Server-defined URL for the target of the operation.

2242

"status": "A String", # The current status of the operation.

2243

"nodepoolConditions": [ # Which conditions caused the current node pool state.

2244

{ # StatusCondition describes why a cluster or a node pool has a certain status (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

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2250

"name": "A String", # The server-assigned ID for the operation.

2251

"detail": "A String", # Detailed operation progress, if available.

2252

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

2257

<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]

2258

<pre>Starts master IP rotation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2259

2260

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2261

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. (required)

2262

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2263

clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2264

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2265

The object takes the form of:

2266

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2267

{ # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2268

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.

2269

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2270

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2271

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2272

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2273

}

2274

2275

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2282

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2283

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2284

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2285

"clusterConditions": [ # Which conditions caused the current cluster state.

2286

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2287

"message": "A String", # Human-friendly representation of the condition

2288

"code": "A String", # Machine-friendly representation of the condition

2289

},

2290

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2291

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

2292

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2293

"stages": [ # Substages of an operation or a stage.

2294

# Object with schema name: OperationProgress

2295

],

2296

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

2297

{ # Progress metric is (string, int|float|string) pair.

2298

"intValue": "A String", # For metrics with integer value.

2299

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2300

"doubleValue": 3.14, # For metrics with floating point value.

2301

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2302

},

2303

],

2304

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2305

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2306

},

2307

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2308

"operationType": "A String", # The operation type.

2309

"selfLink": "A String", # Server-defined URL for the resource.

2310

"targetLink": "A String", # Server-defined URL for the target of the operation.

2311

"status": "A String", # The current status of the operation.

2312

"nodepoolConditions": [ # Which conditions caused the current node pool state.

2313

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2314

"message": "A String", # Human-friendly representation of the condition

2315

"code": "A String", # Machine-friendly representation of the condition

2316

},

2317

],

2318

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2319

"name": "A String", # The server-assigned ID for the operation.

2320

"detail": "A String", # Detailed operation progress, if available.

2321

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

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]

2326

<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]

2327

<pre>Updates the settings of a specific cluster.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2328

2329

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2330

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

2331

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2332

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2333

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2334

The object takes the form of:

2335

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2336

{ # UpdateClusterRequest updates the settings of a cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2337

"update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2338

"desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The desired configuration options for master authorized networks feature.

2339

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.

2340

{ # CidrBlock contains an optional name and one CIDR block.

2341

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

2342

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

2343

},

2344

],

2345

"enabled": True or False, # Whether or not master authorized networks is enabled.

2346

},

2347

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.

2348

"enabled": True or False, # Enables vertical pod autoscaling.

2349

},

2350

"desiredLocations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.

2351

"A String",

2352

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2353

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. # The desired config of Intra-node visibility.

2354

"enabled": True or False, # Enables intra node visibility for this cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2355

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2356

"desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2357

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2358

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2359

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2360

"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.

2361

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

2362

"enabled": True or False, # Whenever master is accessible globally or not.

2363

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2364

"masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.

2365

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2366

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2367

"desiredLoggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2368

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2369

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

2370

"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.

2371

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2372

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2373

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2374

"datasetId": "A String", # The ID of a BigQuery Dataset.

2375

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2376

},

2377

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.

2378

"enabled": True or False, # Is autoscaling enabled for this node pool.

2379

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

2380

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2381

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2382

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2383

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

2384

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2385

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2386

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2387

"desiredDefaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # The desired status of whether to disable default sNAT for this cluster.

2388

"disabled": True or False, # Disables cluster default sNAT rules.

2389

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2390

"desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2391

"desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2392

"autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.

2393

"A String",

2394

],

2395

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2396

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

2397

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

2398

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

2399

"A String",

2400

],

2401

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

2402

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Specifies the upgrade settings for NAP created node pools

2403

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

2404

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

2405

},

2406

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

2407

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value.

2408

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2409

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

2410

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

2411

},

2412

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'

2413

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.

2414

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

2415

"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.

2416

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

2417

"autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2418

},

2419

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

2420

},

2421

},

2422

"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.

2423

{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.

2424

"minimum": "A String", # Minimum amount of the resource in the cluster.

2425

"maximum": "A String", # Maximum amount of the resource in the cluster.

2426

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2427

},

2428

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2429

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2430

"desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2431

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version

2432

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

2433

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.

2434

},

2435

"desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # The desired release channel configuration.

2436

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

2437

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2438

"desiredImageType": "A String", # The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2439

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity.

2440

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

2441

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2442

"desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2443

"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

2444

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2445

},

2446

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.

2447

"disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.

2448

},

2449

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.

2450

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2451

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

2452

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2453

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

2454

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

2455

},

2456

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.

2457

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2458

},

2459

"horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.

2460

"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.

2461

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2462

"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API

2463

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

2464

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2465

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2466

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2467

"keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

2468

"state": "A String", # Denotes the state of etcd encryption.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2469

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2470

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2471

"name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2472

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2473

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

2474

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2475

}

2476

2477

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2478

Allowed values

2479

1 - v1 error format

2480

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2481

2482

Returns:

2483

An object of the form:

2484

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2485

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2486

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2487

"clusterConditions": [ # Which conditions caused the current cluster state.

2488

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2489

"message": "A String", # Human-friendly representation of the condition

2490

"code": "A String", # Machine-friendly representation of the condition

2491

},

2492

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2493

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.

2494

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2495

"stages": [ # Substages of an operation or a stage.

2496

# Object with schema name: OperationProgress

2497

],

2498

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

2499

{ # Progress metric is (string, int|float|string) pair.

2500

"intValue": "A String", # For metrics with integer value.

2501

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2502

"doubleValue": 3.14, # For metrics with floating point value.

2503

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2504

},

2505

],

2506

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2507

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2508

},

2509

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2510

"operationType": "A String", # The operation type.

2511

"selfLink": "A String", # Server-defined URL for the resource.

2512

"targetLink": "A String", # Server-defined URL for the target of the operation.

2513

"status": "A String", # The current status of the operation.

2514

"nodepoolConditions": [ # Which conditions caused the current node pool state.

2515

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2516

"message": "A String", # Human-friendly representation of the condition

2517

"code": "A String", # Machine-friendly representation of the condition

2518

},

2519

],

2520

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2521

"name": "A String", # The server-assigned ID for the operation.

2522

"detail": "A String", # Detailed operation progress, if available.

2523

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

Takashi Matsuo