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

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

[diff] [blame]

83

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

Bu Sun Kim

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

[diff] [blame]

84

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

85

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>

Bu Sun Kim

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

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

Bu Sun Kim

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

[diff] [blame]

94

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>

Bu Sun Kim

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

[diff] [blame]

97

98

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

99

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

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>

Bu Sun Kim

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

[diff] [blame]

102

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

103

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>

Bu Sun Kim

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

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

Bu Sun Kim

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

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

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>

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>

Bu Sun Kim

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

[diff] [blame]

135

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

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.

140

141

Args:

Dmitry Frenkel

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

[diff] [blame]

142

projectId: string, Required. 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, Required. 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, Required. 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.

Bu Sun Kim

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

[diff] [blame]

146

The object takes the form of:

147

148

{ # SetAddonsRequest sets the addons associated with the cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

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

150

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.

151

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

152

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

Bu Sun Kim

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

[diff] [blame]

153

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

154

"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

155

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

156

},

157

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

158

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

159

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

160

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

161

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

162

},

163

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

164

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

165

},

166

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

167

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

168

},

169

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

170

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

171

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

172

},

173

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

174

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

175

},

176

"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

177

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

178

},

179

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

180

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

181

},

182

},

183

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

184

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

185

"projectId": "A String", # Required. 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.

186

"zone": "A String", # Required. 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.

187

}

Bu Sun Kim

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

[diff] [blame]

188

189

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

196

Dmitry Frenkel

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

[diff] [blame]

197

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

198

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

199

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

200

"canonicalCode": "A String", # Canonical code of the condition.

201

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

202

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

203

},

204

],

205

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

206

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

207

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

208

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

209

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

210

{

211

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

212

},

213

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

214

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

215

},

216

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

217

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

218

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

219

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

220

"canonicalCode": "A String", # Canonical code of the condition.

221

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

222

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

223

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

224

],

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

233

},

234

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

235

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

236

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

237

# Object with schema name: OperationProgress

238

],

239

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

240

},

241

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

242

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

243

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

244

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

245

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

246

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

247

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

251

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

252

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

256

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

257

<pre>Completes master IP rotation.

258

259

Args:

Dmitry Frenkel

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

[diff] [blame]

260

projectId: string, Required. 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)

261

zone: string, Required. 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)

262

clusterId: string, Required. 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]

263

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

264

The object takes the form of:

265

266

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

267

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

268

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

269

"projectId": "A String", # Required. 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.

270

"zone": "A String", # Required. 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.

271

}

Bu Sun Kim

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

[diff] [blame]

272

273

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

280

Dmitry Frenkel

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

[diff] [blame]

281

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

282

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

283

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

284

"canonicalCode": "A String", # Canonical code of the condition.

285

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

286

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

287

},

288

],

289

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

290

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

291

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

292

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

293

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

294

{

295

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

296

},

297

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

298

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

299

},

300

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

301

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

302

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

303

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

304

"canonicalCode": "A String", # Canonical code of the condition.

305

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

306

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

307

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

308

],

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

317

},

318

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

319

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

320

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

321

# Object with schema name: OperationProgress

322

],

323

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

324

},

325

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

326

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

327

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

328

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

329

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

330

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

331

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

335

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

336

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

Bu Sun Kim

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

[diff] [blame]

337

338

Args:

Dmitry Frenkel

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

[diff] [blame]

339

projectId: string, Required. 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)

340

zone: string, Required. 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]

341

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

342

The object takes the form of:

343

344

{ # CreateClusterRequest creates a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

345

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

346

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

347

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.

348

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

349

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

350

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

351

"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

352

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

353

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

354

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

355

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

356

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

357

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

358

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

359

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

360

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

361

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

362

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

363

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

364

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

365

},

366

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

367

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

368

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

369

},

370

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

371

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

372

},

373

"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

374

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

375

},

376

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

377

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

378

},

379

},

380

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

381

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

382

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

383

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

384

"autopilot": { # Autopilot is the configuration for Autopilot settings on the cluster. # Autopilot configuration for the cluster.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

385

"enabled": True or False, # Enable Autopilot

386

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

387

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

388

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

389

"A String",

390

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

391

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

392

"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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

393

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

394

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

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

395

"imageType": "A String", # The image type to use for NAP created node.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

396

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

397

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

398

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

399

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

400

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

401

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

402

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

403

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

404

"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) To unset the min cpu platform field pass "automatic" as field value.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

405

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

406

"A String",

407

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

408

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

409

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

410

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

411

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

412

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

413

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

414

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

415

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

416

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

417

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

418

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

419

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

420

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

421

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

422

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

423

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

424

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

425

},

426

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

427

},

428

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

429

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

430

},

431

"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`.

432

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

433

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

434

},

435

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

436

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

437

"canonicalCode": "A String", # Canonical code of the condition.

438

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

439

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

440

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

441

],

442

"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Configuration of Confidential Nodes

443

"enabled": True or False, # Whether Confidential Nodes feature is enabled for all nodes in this cluster.

444

},

445

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

446

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

447

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

448

"currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/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.

449

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

450

"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

451

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

452

},

453

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

454

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

455

},

456

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

457

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) 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.

458

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.

459

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

460

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

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

461

"id": "A String", # Output only. Unique id for the cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

462

"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

463

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

464

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

465

"A String",

466

],

467

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

468

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.

469

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

470

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

471

"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 and create_subnetwork is false.

472

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

473

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

474

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

475

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

476

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

477

"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 and create_subnetwork is false.

478

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

479

"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. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

480

"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

481

"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

482

},

483

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

484

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

485

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

486

},

487

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

488

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

489

"A String",

490

],

491

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

492

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

493

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

494

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

495

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

496

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

497

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

498

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

499

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

500

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

501

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

502

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

503

},

504

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

505

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

506

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

507

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

508

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

509

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

510

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

511

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

512

},

Bu Sun Kim

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

[diff] [blame]

513

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

514

"master": { # Master is the configuration for components on master. # Configuration for master components.

515

},

516

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

517

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

518

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

519

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

520

},

521

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

522

"clusterCaCertificate": "A String",

523

"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

524

"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

525

},

526

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

527

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

528

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

529

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

530

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

531

},

532

],

533

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

534

},

535

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.

536

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

537

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

538

"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. On output this shows the network ID instead of the name.

539

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

540

"datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.

541

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

542

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

543

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

544

"dnsConfig": { # DNSConfig contains the desired set of options for configuring clusterDNS. # DNSConfig contains clusterDNS config for this cluster.

545

"clusterDns": "A String", # cluster_dns indicates which in-cluster DNS provider should be used.

546

"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records.

547

"clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records.

548

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

549

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

550

"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

551

"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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

552

"privateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

553

"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

554

},

555

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

556

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

557

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

558

},

559

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

560

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

561

{ # AcceleratorConfig represents a Hardware Accelerator request.

562

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

563

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

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

564

"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

565

},

566

],

567

"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

568

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

569

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

570

"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

571

"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.

572

},

573

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

574

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

575

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.

576

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.

577

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.

578

},

579

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

580

"a_key": "A String",

581

},

582

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

583

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

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

588

"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`.

589

"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-oslogin" - "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.

590

"a_key": "A String",

591

},

592

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

593

"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).

594

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

595

"A String",

596

],

597

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

598

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

599

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

600

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

601

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

"A String",

],

},

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

606

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

607

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

608

},

609

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

610

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

611

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

612

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

613

},

614

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

615

"A String",

616

],

617

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

618

{ # 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.

619

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

620

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

621

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

622

},

623

],

624

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

625

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

626

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.

627

},

628

},

629

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

yoshi-code-bot

31fbcc0

2021-06-02 00:52:03 -0700

[diff] [blame]

630

"nodePoolDefaults": { # Subset of Nodepool message that has defaults. # Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

631

"nodeConfigDefaults": { # Subset of NodeConfig message that has defaults. # Subset of NodeConfig message that has defaults.

632

},

633

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

634

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

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

635

{ # 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. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

636

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

637

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

638

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

639

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

640

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

641

},

642

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

643

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

644

"canonicalCode": "A String", # Canonical code of the condition.

645

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

646

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

647

},

648

],

649

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

650

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

651

{ # AcceleratorConfig represents a Hardware Accelerator request.

652

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

653

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

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

654

"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

655

},

656

],

657

"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

658

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

659

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

660

"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

661

"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.

662

},

663

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

664

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

665

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.

666

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.

667

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.

668

},

669

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

670

"a_key": "A String",

671

},

672

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

673

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

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

678

"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`.

679

"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-oslogin" - "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.

680

"a_key": "A String",

681

},

682

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

683

"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).

684

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

685

"A String",

686

],

687

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

688

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

689

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

690

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

691

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

"A String",

],

},

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

696

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

697

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

698

},

699

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

700

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

701

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

702

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

703

},

704

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

705

"A String",

706

],

707

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

708

{ # 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.

709

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

710

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

711

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

712

},

713

],

714

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

715

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

716

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.

717

},

718

},

719

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

720

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

721

"A String",

722

],

723

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

724

"A String",

725

],

726

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

727

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

728

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

729

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

730

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

731

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

732

},

733

},

734

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

735

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

736

},

737

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

738

"networkConfig": { # Parameters for node pool-level network config. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

739

"createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used.

740

"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` 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](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use.

741

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID.

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

742

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

743

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

744

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

745

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

746

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

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

747

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

748

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

749

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

750

},

751

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

752

},

753

],

754

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.

755

"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.

756

"enabled": True or False, # Enable notifications for Pub/Sub.

757

"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.

758

},

759

},

760

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

761

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.

762

},

763

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.

764

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

765

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

766

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

767

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

768

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

769

},

770

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

771

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

772

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

773

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

774

},

775

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

776

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

777

},

778

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

779

"a_key": "A String",

780

},

781

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

782

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

783

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

784

},

785

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

786

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

787

},

788

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

789

},

790

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

791

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

792

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

793

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

794

},

795

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

796

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

797

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

798

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

799

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

800

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

801

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

802

},

803

"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`).

804

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

805

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

806

},

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

807

"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

808

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty).

809

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

810

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

811

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

812

"identityProvider": "A String", # identity provider is the third party identity provider.

813

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

814

},

815

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

816

},

817

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

818

"projectId": "A String", # Required. 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.

819

"zone": "A String", # Required. 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.

820

}

Bu Sun Kim

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

[diff] [blame]

821

822

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

829

Dmitry Frenkel

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

[diff] [blame]

830

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

831

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

832

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

833

"canonicalCode": "A String", # Canonical code of the condition.

834

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

835

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

836

},

837

],

838

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

839

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

840

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

841

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

842

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

843

{

844

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

845

},

846

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

847

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

848

},

849

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

850

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

851

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

852

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

853

"canonicalCode": "A String", # Canonical code of the condition.

854

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

855

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

856

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

857

],

858

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

859

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

860

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

861

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

862

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

863

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

864

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

865

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

866

},

867

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

868

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

869

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

870

# Object with schema name: OperationProgress

871

],

872

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

873

},

874

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

875

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

876

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

877

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

878

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

879

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

880

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

885

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

Bu Sun Kim

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

[diff] [blame]

886

887

Args:

Dmitry Frenkel

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

[diff] [blame]

888

projectId: string, Required. 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)

889

zone: string, Required. 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)

890

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

891

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

Bu Sun Kim

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

[diff] [blame]

892

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

899

Dmitry Frenkel

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

[diff] [blame]

900

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

901

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

902

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

903

"canonicalCode": "A String", # Canonical code of the condition.

904

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

905

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

906

},

907

],

908

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

909

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

910

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

911

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

912

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

913

{

914

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

915

},

916

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

917

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

918

},

919

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

920

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

921

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

922

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

923

"canonicalCode": "A String", # Canonical code of the condition.

924

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

925

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

926

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

927

],

928

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

929

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

930

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

931

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

932

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

933

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

934

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

935

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

936

},

937

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

938

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

939

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

940

# Object with schema name: OperationProgress

941

],

942

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

943

},

944

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

945

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

946

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

947

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

948

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

949

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

950

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

955

<pre>Gets the details for a specific cluster.

956

957

Args:

Dmitry Frenkel

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

[diff] [blame]

958

projectId: string, Required. 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)

959

zone: string, Required. 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)

960

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

961

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

Bu Sun Kim

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

[diff] [blame]

962

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

969

970

{ # A Google Kubernetes Engine cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

971

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

972

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.

973

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

974

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

975

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

976

"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

977

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

978

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

979

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

980

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

981

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

982

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

983

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

984

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

985

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

986

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

987

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

988

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

989

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

990

},

991

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

992

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

993

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

994

},

995

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

996

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

997

},

998

"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

999

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

1000

},

1001

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

1002

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

1003

},

1004

},

1005

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

1006

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

1007

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

1008

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1009

"autopilot": { # Autopilot is the configuration for Autopilot settings on the cluster. # Autopilot configuration for the cluster.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1010

"enabled": True or False, # Enable Autopilot

1011

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1012

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

1013

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1014

"A String",

1015

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1016

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

1017

"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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1018

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1019

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

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

1020

"imageType": "A String", # The image type to use for NAP created node.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1028

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1029

"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) To unset the min cpu platform field pass "automatic" as field value.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1030

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

1031

"A String",

1032

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1033

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

1034

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

1035

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

1036

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1037

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

1038

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1039

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

1040

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1041

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1042

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1043

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1050

},

1051

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1052

},

1053

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

1054

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

1055

},

1056

"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`.

1057

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

1058

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

1059

},

1060

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

1061

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

1062

"canonicalCode": "A String", # Canonical code of the condition.

1063

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1064

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1065

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1066

],

1067

"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Configuration of Confidential Nodes

1068

"enabled": True or False, # Whether Confidential Nodes feature is enabled for all nodes in this cluster.

1069

},

1070

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

1071

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

1072

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

1073

"currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/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.

1074

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

1075

"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

1076

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

1077

},

1078

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

1079

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

1080

},

1081

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

1082

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) 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.

1083

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.

1084

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

1085

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

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

1086

"id": "A String", # Output only. Unique id for the cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1087

"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

1088

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

1089

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

1090

"A String",

1091

],

1092

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

1093

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.

1094

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

1095

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

1096

"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 and create_subnetwork is false.

1097

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

1098

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

1099

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

1100

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

1101

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

1102

"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 and create_subnetwork is false.

1103

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

1104

"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. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

1105

"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

1106

"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

1107

},

1108

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

1109

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

1110

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

1111

},

1112

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

1113

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

1114

"A String",

1115

],

1116

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

1117

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

1118

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

1119

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

1120

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

1121

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

1122

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1123

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1124

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

1125

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

1126

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

1127

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1128

},

1129

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1130

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

1131

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

1132

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

1133

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

1134

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

1135

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1136

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1137

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1138

},

1139

"master": { # Master is the configuration for components on master. # Configuration for master components.

1140

},

1141

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

1142

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

1143

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

1144

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1145

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1146

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

1147

"clusterCaCertificate": "A String",

1148

"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

1149

"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

1150

},

1151

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

1152

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

1153

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

1154

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

1155

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

1156

},

1157

],

1158

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

1159

},

1160

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.

1161

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

1162

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

1163

"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. On output this shows the network ID instead of the name.

1164

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

1165

"datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.

1166

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

1167

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

1168

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1169

"dnsConfig": { # DNSConfig contains the desired set of options for configuring clusterDNS. # DNSConfig contains clusterDNS config for this cluster.

1170

"clusterDns": "A String", # cluster_dns indicates which in-cluster DNS provider should be used.

1171

"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records.

1172

"clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records.

1173

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1174

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1175

"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1176

"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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1177

"privateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1178

"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

1179

},

1180

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

1181

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

1182

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

1183

},

1184

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

1185

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

1186

{ # AcceleratorConfig represents a Hardware Accelerator request.

1187

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

1188

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

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

1189

"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1190

},

1191

],

1192

"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

1193

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1194

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1195

"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

1196

"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.

1197

},

1198

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

1199

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1200

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.

1201

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.

1202

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.

1203

},

1204

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1205

"a_key": "A String",

1206

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1207

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1208

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

1209

"a_key": "A String",

1210

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1211

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1212

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

1213

"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`.

1214

"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-oslogin" - "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.

1215

"a_key": "A String",

1216

},

1217

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

1218

"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).

1219

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

1220

"A String",

1221

],

1222

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

1223

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

1224

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

1225

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

1226

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

"A String",

],

},

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

1231

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

1232

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

1233

},

1234

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

1235

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

1236

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

1237

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

1238

},

1239

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

1240

"A String",

1241

],

1242

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

1243

{ # 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.

1244

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

1245

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

1246

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1247

},

1248

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1249

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

1250

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

1251

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1252

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1253

},

1254

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

yoshi-code-bot

31fbcc0

2021-06-02 00:52:03 -0700

[diff] [blame]

1255

"nodePoolDefaults": { # Subset of Nodepool message that has defaults. # Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

1256

"nodeConfigDefaults": { # Subset of NodeConfig message that has defaults. # Subset of NodeConfig message that has defaults.

1257

},

1258

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1259

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

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

1260

{ # 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. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1261

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

1262

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

1263

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

1264

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

1265

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1266

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1267

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

1268

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

1269

"canonicalCode": "A String", # Canonical code of the condition.

1270

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1271

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

1272

},

1273

],

1274

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

1275

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

1276

{ # AcceleratorConfig represents a Hardware Accelerator request.

1277

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

1278

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

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

1279

"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1280

},

1281

],

1282

"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

1283

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1284

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1285

"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

1286

"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.

1287

},

1288

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

1289

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1290

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.

1291

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.

1292

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.

1293

},

1294

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

1295

"a_key": "A String",

1296

},

1297

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1298

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

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

1303

"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`.

1304

"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-oslogin" - "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.

1305

"a_key": "A String",

1306

},

1307

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

1308

"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).

1309

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

1310

"A String",

1311

],

1312

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

1313

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

1314

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

1315

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

1316

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

"A String",

],

},

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

1321

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

1322

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

1323

},

1324

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

1325

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

1326

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

1327

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

1328

},

1329

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

1330

"A String",

1331

],

1332

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

1333

{ # 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.

1334

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

1335

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

1336

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

1337

},

1338

],

1339

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

1340

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

1341

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.

1342

},

1343

},

1344

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

1345

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

1346

"A String",

1347

],

1348

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

1349

"A String",

1350

],

1351

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

1352

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

1353

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

1354

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

1355

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

1356

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

1357

},

1358

},

1359

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

1360

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

1361

},

1362

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

1363

"networkConfig": { # Parameters for node pool-level network config. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1364

"createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used.

1365

"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` 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](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use.

1366

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID.

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

1367

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1368

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

1369

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

1370

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1371

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

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

1372

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1373

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

1374

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

1375

},

1376

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1377

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1378

],

1379

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.

1380

"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.

1381

"enabled": True or False, # Enable notifications for Pub/Sub.

1382

"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1383

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1384

},

1385

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

1386

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.

1387

},

1388

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.

1389

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

1390

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

1391

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

1392

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

1393

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

1394

},

1395

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

1396

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

1397

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

1398

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

1399

},

1400

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

1401

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

1402

},

1403

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

1404

"a_key": "A String",

1405

},

1406

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

1407

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

1408

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

1409

},

1410

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

1411

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

1412

},

1413

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

1414

},

1415

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

1416

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

1417

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

1418

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

1419

},

1420

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1421

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1422

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

1423

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

1424

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

1425

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

1426

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

1427

},

1428

"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`).

1429

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

1430

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

1431

},

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

1432

"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

1433

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty).

1434

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1435

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

1436

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

1437

"identityProvider": "A String", # identity provider is the third party identity provider.

1438

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

1439

},

1440

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

1441

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

1446

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

1447

1448

Args:

Dmitry Frenkel

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

[diff] [blame]

1449

projectId: string, Required. 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)

1450

zone: string, Required. 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)

1451

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

Bu Sun Kim

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

[diff] [blame]

1452

body: object, The request body.

1453

The object takes the form of:

1454

Dmitry Frenkel

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

[diff] [blame]

1455

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1456

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

1457

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

1458

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

1459

"projectId": "A String", # Required. 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.

1460

"zone": "A String", # Required. 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.

1461

}

Bu Sun Kim

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

[diff] [blame]

1462

1463

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1470

Dmitry Frenkel

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

[diff] [blame]

1471

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1472

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

1473

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

1474

"canonicalCode": "A String", # Canonical code of the condition.

1475

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1476

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

1477

},

1478

],

1479

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

1480

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

1481

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

1482

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1483

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1484

{

1485

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1486

},

1487

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1488

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1489

},

1490

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

1491

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

1492

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

1493

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

1494

"canonicalCode": "A String", # Canonical code of the condition.

1495

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1496

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1497

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1498

],

1499

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

1500

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

1501

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

1502

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

1503

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

1504

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

1505

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

1506

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1507

},

1508

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1509

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

1510

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

1511

# Object with schema name: OperationProgress

1512

],

1513

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

1514

},

1515

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

1516

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

1517

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

1518

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

1519

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

1520

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

1521

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

1526

<pre>Lists all clusters owned by a project in either the specified zone or all zones.

Bu Sun Kim

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

[diff] [blame]

1527

1528

Args:

Dmitry Frenkel

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

[diff] [blame]

1529

projectId: string, Required. 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)

1530

zone: string, Required. 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)

1531

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.

Bu Sun Kim

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

[diff] [blame]

1532

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1539

1540

{ # ListClustersResponse is the result of ListClustersRequest.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1541

"clusters": [ # A list of clusters in the project in the specified zone, or across all ones.

1542

{ # A Google Kubernetes Engine cluster.

1543

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

1544

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.

1545

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

1546

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1547

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1548

"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

1549

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1550

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1551

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

1552

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1553

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1554

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1555

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1556

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1557

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

1558

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1559

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1560

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

1561

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

1562

},

1563

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

1564

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

1565

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

1566

},

1567

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

1568

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

1569

},

1570

"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

1571

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

1572

},

1573

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

1574

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

1575

},

1576

},

1577

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

1578

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

1579

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

1580

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1581

"autopilot": { # Autopilot is the configuration for Autopilot settings on the cluster. # Autopilot configuration for the cluster.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1582

"enabled": True or False, # Enable Autopilot

1583

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1584

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

1585

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1586

"A String",

1587

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1588

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

1589

"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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1590

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1591

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

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

1592

"imageType": "A String", # The image type to use for NAP created node.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1593

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

1594

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

1595

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

1596

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

1597

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

1598

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

1599

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1600

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1601

"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) To unset the min cpu platform field pass "automatic" as field value.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

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

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1605

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

1606

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

1607

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

1608

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1609

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

1610

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1611

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

1612

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1613

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1614

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1615

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

1616

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

1617

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

1618

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

1619

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

1620

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

1621

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1622

},

1623

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1624

},

1625

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

1626

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

1627

},

1628

"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`.

1629

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

1630

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

1631

},

1632

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

1633

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

1634

"canonicalCode": "A String", # Canonical code of the condition.

1635

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1636

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1637

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1638

],

1639

"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Configuration of Confidential Nodes

1640

"enabled": True or False, # Whether Confidential Nodes feature is enabled for all nodes in this cluster.

1641

},

1642

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

1643

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

1644

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

1645

"currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/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.

1646

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

1647

"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

1648

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

1649

},

1650

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

1651

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

1652

},

1653

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

1654

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) 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.

1655

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.

1656

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

1657

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

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

1658

"id": "A String", # Output only. Unique id for the cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1659

"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

1660

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

1661

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

1662

"A String",

1663

],

1664

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

1665

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.

1666

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

1667

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

1668

"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 and create_subnetwork is false.

1669

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

1670

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

1671

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

1672

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

1673

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

1674

"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 and create_subnetwork is false.

1675

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

1676

"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. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

1677

"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

1678

"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

1679

},

1680

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

1681

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

1682

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

1683

},

1684

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

1685

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

1686

"A String",

1687

],

1688

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

1689

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

1690

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

1691

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

1692

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

1693

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

1694

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1695

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1696

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

1697

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

1698

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

1699

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1700

},

1701

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1702

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

1703

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

1704

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

1705

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

1706

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

1707

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1708

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1709

},

Bu Sun Kim

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

[diff] [blame]

1710

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1711

"master": { # Master is the configuration for components on master. # Configuration for master components.

1712

},

1713

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

1714

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

1715

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

1716

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

1717

},

1718

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

1719

"clusterCaCertificate": "A String",

1720

"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

1721

"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

1722

},

1723

"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.

1724

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.

1725

{ # CidrBlock contains an optional name and one CIDR block.

1726

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

1727

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

1728

},

1729

],

1730

"enabled": True or False, # Whether or not master authorized networks is enabled.

1731

},

1732

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.

1733

"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.

1734

"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.

1735

"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. On output this shows the network ID instead of the name.

1736

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

1737

"datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.

1738

"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.

1739

"disabled": True or False, # Disables cluster default sNAT rules.

1740

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1741

"dnsConfig": { # DNSConfig contains the desired set of options for configuring clusterDNS. # DNSConfig contains clusterDNS config for this cluster.

1742

"clusterDns": "A String", # cluster_dns indicates which in-cluster DNS provider should be used.

1743

"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records.

1744

"clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records.

1745

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1746

"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.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1747

"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1748

"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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1749

"privateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1750

"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

1751

},

1752

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.

1753

"enabled": True or False, # Whether network policy is enabled on the cluster.

1754

"provider": "A String", # The selected network policy provider.

1755

},

1756

"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.

1757

"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.

1758

{ # AcceleratorConfig represents a Hardware Accelerator request.

1759

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1760

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

1761

"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1762

},

1763

],

1764

"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

1765

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1766

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1767

"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

1768

"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.

1769

},

1770

"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.

1771

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1772

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.

1773

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.

1774

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.

1775

},

1776

"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/

1777

"a_key": "A String",

1778

},

1779

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1780

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

"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.

1785

"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`.

1786

"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-oslogin" - "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.

1787

"a_key": "A String",

1788

},

1789

"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)

1790

"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).

1791

"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.

1792

"A String",

1793

],

1794

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.

1795

"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.

1796

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1797

"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.

1798

"values": [ # Corresponds to the label value(s) of reservation resource(s).

"A String",

],

},

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1803

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

1804

"type": "A String", # Type of the sandbox to use for the node.

1805

},

1806

"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.

1807

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1808

"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.

1809

"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.

1810

},

1811

"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.

1812

"A String",

1813

],

1814

"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/

1815

{ # 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.

1816

"effect": "A String", # Effect for taint.

1817

"key": "A String", # Key for taint.

1818

"value": "A String", # Value for taint.

1819

},

1820

],

1821

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.

1822

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.

1823

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.

1824

},

1825

},

1826

"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.

yoshi-code-bot

31fbcc0

2021-06-02 00:52:03 -0700

[diff] [blame]

1827

"nodePoolDefaults": { # Subset of Nodepool message that has defaults. # Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

1828

"nodeConfigDefaults": { # Subset of NodeConfig message that has defaults. # Subset of NodeConfig message that has defaults.

1829

},

1830

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1831

"nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

1832

{ # 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. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1833

"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.

1834

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

1835

"enabled": True or False, # Is autoscaling enabled for this node pool.

1836

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

1837

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

1838

},

1839

"conditions": [ # Which conditions caused the current node pool state.

1840

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1841

"canonicalCode": "A String", # Canonical code of the condition.

1842

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1843

"message": "A String", # Human-friendly representation of the condition

1844

},

1845

],

1846

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

1847

"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.

1848

{ # AcceleratorConfig represents a Hardware Accelerator request.

1849

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1850

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

yoshi-code-bot

2021-04-27 05:08:04 -0700

[diff] [blame]

1851

"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1852

},

1853

],

1854

"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

1855

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1856

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1857

"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

1858

"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.

1859

},

1860

"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.

1861

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1862

"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.

1863

"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.

1864

"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.

1865

},

1866

"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/

1867

"a_key": "A String",

1868

},

1869

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1870

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

"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.

1875

"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`.

1876

"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-oslogin" - "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.

1877

"a_key": "A String",

1878

},

1879

"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)

1880

"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).

1881

"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.

1882

"A String",

1883

],

1884

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.

1885

"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.

1886

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1887

"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.

1888

"values": [ # Corresponds to the label value(s) of reservation resource(s).

"A String",

],

},

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1893

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

1894

"type": "A String", # Type of the sandbox to use for the node.

1895

},

1896

"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.

1897

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1898

"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.

1899

"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.

1900

},

1901

"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.

1902

"A String",

1903

],

1904

"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/

1905

{ # 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.

1906

"effect": "A String", # Effect for taint.

1907

"key": "A String", # Key for taint.

1908

"value": "A String", # Value for taint.

1909

},

1910

],

1911

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.

1912

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.

1913

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.

1914

},

1915

},

1916

"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.

1917

"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.

1918

"A String",

1919

],

1920

"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.

1921

"A String",

1922

],

1923

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.

1924

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

1925

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

1926

"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.

1927

"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.

1928

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

1929

},

1930

},

1931

"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.

1932

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1933

},

1934

"name": "A String", # The name of the node pool.

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

1935

"networkConfig": { # Parameters for node pool-level network config. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1936

"createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used.

1937

"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` 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](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use.

1938

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID.

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

1939

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1940

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

1941

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1942

"status": "A String", # [Output only] The status of the nodes in this pool instance.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1943

"statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

1944

"upgradeSettings": { # Upgrade settings control disruption and speed of the upgrade.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1945

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1946

"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.

1947

},

1948

"version": "A String", # The version of the Kubernetes of this node.

1949

},

1950

],

1951

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.

1952

"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.

1953

"enabled": True or False, # Enable notifications for Pub/Sub.

1954

"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.

1955

},

1956

},

1957

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

1958

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.

1959

},

1960

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.

1961

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

1962

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

1963

"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.

1964

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

1965

"enabled": True or False, # Whenever master is accessible globally or not.

1966

},

1967

"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.

1968

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

1969

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

1970

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

1971

},

1972

"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.

1973

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

1974

},

1975

"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

1976

"a_key": "A String",

1977

},

1978

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified.

1979

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

1980

"datasetId": "A String", # The ID of a BigQuery Dataset.

1981

},

1982

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

1983

"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.

1984

},

1985

"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.

1986

},

1987

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1988

"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.

1989

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

1990

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

1991

},

1992

"status": "A String", # [Output only] The current status of this cluster.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1993

"statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1994

"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.

1995

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

1996

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

1997

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

1998

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

1999

},

2000

"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`).

2001

"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.

2002

"enabled": True or False, # Enables vertical pod autoscaling.

2003

},

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

2004

"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

2005

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty).

2006

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2007

"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.

2008

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

2009

"identityProvider": "A String", # identity provider is the third party identity provider.

2010

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

2011

},

2012

"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.

2013

},

2014

],

2015

"missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.

2016

"A String",

2017

],

2018

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2022

<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]

2023

<pre>Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2024

2025

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2026

projectId: string, Required. 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)

2027

zone: string, Required. 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)

2028

clusterId: string, Required. 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]

2029

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2030

The object takes the form of:

2031

2032

{ # SetLocationsRequest sets the locations of the cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2033

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2034

"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.

2035

"A String",

2036

],

2037

"name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.

2038

"projectId": "A String", # Required. 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.

2039

"zone": "A String", # Required. 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.

2040

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2041

2042

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2049

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2050

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2051

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2052

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2053

"canonicalCode": "A String", # Canonical code of the condition.

2054

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2055

"message": "A String", # Human-friendly representation of the condition

2056

},

2057

],

2058

"detail": "A String", # Detailed operation progress, if available.

2059

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2060

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

2061

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2062

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2063

{

2064

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2065

},

2066

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2067

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2068

},

2069

"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.

2070

"name": "A String", # The server-assigned ID for the operation.

2071

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2072

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2073

"canonicalCode": "A String", # Canonical code of the condition.

2074

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2075

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2076

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2077

],

2078

"operationType": "A String", # The operation type.

2079

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2080

"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}]

2081

{ # Progress metric is (string, int|float|string) pair.

2082

"doubleValue": 3.14, # For metrics with floating point value.

2083

"intValue": "A String", # For metrics with integer value.

2084

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2085

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2086

},

2087

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2088

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2089

"stages": [ # Substages of an operation or a stage.

2090

# Object with schema name: OperationProgress

2091

],

2092

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2093

},

2094

"selfLink": "A String", # Server-defined URL for the resource.

2095

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2096

"status": "A String", # The current status of the operation.

2097

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2098

"targetLink": "A String", # Server-defined URL for the target of the operation.

2099

"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.

2100

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2104

<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]

2105

<pre>Sets the logging service for a specific cluster.

2106

2107

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2108

projectId: string, Required. 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)

2109

zone: string, Required. 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)

2110

clusterId: string, Required. 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]

2111

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2112

The object takes the form of:

2113

2114

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2115

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2116

"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.

2117

"name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.

2118

"projectId": "A String", # Required. 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.

2119

"zone": "A String", # Required. 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.

2120

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2121

2122

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2129

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2130

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2131

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2132

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2133

"canonicalCode": "A String", # Canonical code of the condition.

2134

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2135

"message": "A String", # Human-friendly representation of the condition

2136

},

2137

],

2138

"detail": "A String", # Detailed operation progress, if available.

2139

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2140

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

2141

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2142

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2143

{

2144

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2145

},

2146

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2147

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2148

},

2149

"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.

2150

"name": "A String", # The server-assigned ID for the operation.

2151

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2152

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2153

"canonicalCode": "A String", # Canonical code of the condition.

2154

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2155

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2156

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2157

],

2158

"operationType": "A String", # The operation type.

2159

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2160

"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}]

2161

{ # Progress metric is (string, int|float|string) pair.

2162

"doubleValue": 3.14, # For metrics with floating point value.

2163

"intValue": "A String", # For metrics with integer value.

2164

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2165

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2166

},

2167

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2168

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2169

"stages": [ # Substages of an operation or a stage.

2170

# Object with schema name: OperationProgress

2171

],

2172

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2173

},

2174

"selfLink": "A String", # Server-defined URL for the resource.

2175

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2176

"status": "A String", # The current status of the operation.

2177

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2178

"targetLink": "A String", # Server-defined URL for the target of the operation.

2179

"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.

2180

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2184

<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]

2185

<pre>Updates the master for a specific cluster.

2186

2187

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2188

projectId: string, Required. 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)

2189

zone: string, Required. 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)

2190

clusterId: string, Required. 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]

2191

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2192

The object takes the form of:

2193

2194

{ # UpdateMasterRequest updates the master of the cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2195

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2196

"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

2197

"name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.

2198

"projectId": "A String", # Required. 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.

2199

"zone": "A String", # Required. 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.

2200

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2201

2202

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2209

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2210

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2211

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2212

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2213

"canonicalCode": "A String", # Canonical code of the condition.

2214

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2215

"message": "A String", # Human-friendly representation of the condition

2216

},

2217

],

2218

"detail": "A String", # Detailed operation progress, if available.

2219

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2220

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

2221

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2222

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2223

{

2224

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2225

},

2226

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2227

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2228

},

2229

"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.

2230

"name": "A String", # The server-assigned ID for the operation.

2231

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2232

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2233

"canonicalCode": "A String", # Canonical code of the condition.

2234

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2235

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2236

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2237

],

2238

"operationType": "A String", # The operation type.

2239

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2240

"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}]

2241

{ # Progress metric is (string, int|float|string) pair.

2242

"doubleValue": 3.14, # For metrics with floating point value.

2243

"intValue": "A String", # For metrics with integer value.

2244

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2245

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2246

},

2247

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2248

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2249

"stages": [ # Substages of an operation or a stage.

2250

# Object with schema name: OperationProgress

2251

],

2252

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2253

},

2254

"selfLink": "A String", # Server-defined URL for the resource.

2255

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2256

"status": "A String", # The current status of the operation.

2257

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2258

"targetLink": "A String", # Server-defined URL for the target of the operation.

2259

"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.

2260

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2264

<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]

2265

<pre>Sets the monitoring service for a specific cluster.

2266

2267

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2268

projectId: string, Required. 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)

2269

zone: string, Required. 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)

2270

clusterId: string, Required. 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]

2271

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2272

The object takes the form of:

2273

2274

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2275

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2276

"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.

2277

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.

2278

"projectId": "A String", # Required. 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.

2279

"zone": "A String", # Required. 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.

2280

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2281

2282

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2289

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2290

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2291

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2292

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2293

"canonicalCode": "A String", # Canonical code of the condition.

2294

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2295

"message": "A String", # Human-friendly representation of the condition

2296

},

2297

],

2298

"detail": "A String", # Detailed operation progress, if available.

2299

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2300

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

2301

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2302

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2303

{

2304

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2305

},

2306

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2307

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2308

},

2309

"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.

2310

"name": "A String", # The server-assigned ID for the operation.

2311

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2312

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2313

"canonicalCode": "A String", # Canonical code of the condition.

2314

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2315

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2316

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2317

],

2318

"operationType": "A String", # The operation type.

2319

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2320

"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}]

2321

{ # Progress metric is (string, int|float|string) pair.

2322

"doubleValue": 3.14, # For metrics with floating point value.

2323

"intValue": "A String", # For metrics with integer value.

2324

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2325

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2326

},

2327

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2328

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2329

"stages": [ # Substages of an operation or a stage.

2330

# Object with schema name: OperationProgress

2331

],

2332

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2333

},

2334

"selfLink": "A String", # Server-defined URL for the resource.

2335

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2336

"status": "A String", # The current status of the operation.

2337

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2338

"targetLink": "A String", # Server-defined URL for the target of the operation.

2339

"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.

2340

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2344

<code class="details" id="resourceLabels">resourceLabels(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2345

<pre>Sets labels on a cluster.

2346

2347

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2348

projectId: string, Required. 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)

2349

zone: string, Required. 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)

2350

clusterId: string, Required. 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]

2351

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2352

The object takes the form of:

2353

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2354

{ # 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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2355

"clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

2356

"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.

2357

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.

2358

"projectId": "A String", # Required. 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.

2359

"resourceLabels": { # Required. The labels to set for that cluster.

2360

"a_key": "A String",

2361

},

2362

"zone": "A String", # Required. 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.

2363

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2364

2365

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2372

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2373

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2374

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2375

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2376

"canonicalCode": "A String", # Canonical code of the condition.

2377

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2378

"message": "A String", # Human-friendly representation of the condition

2379

},

2380

],

2381

"detail": "A String", # Detailed operation progress, if available.

2382

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2383

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

2384

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2385

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2386

{

2387

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2388

},

2389

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2390

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2391

},

2392

"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.

2393

"name": "A String", # The server-assigned ID for the operation.

2394

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2395

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2396

"canonicalCode": "A String", # Canonical code of the condition.

2397

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2398

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2399

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2400

],

2401

"operationType": "A String", # The operation type.

2402

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2403

"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}]

2404

{ # Progress metric is (string, int|float|string) pair.

2405

"doubleValue": 3.14, # For metrics with floating point value.

2406

"intValue": "A String", # For metrics with integer value.

2407

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2408

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2409

},

2410

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2411

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2412

"stages": [ # Substages of an operation or a stage.

2413

# Object with schema name: OperationProgress

2414

],

2415

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2416

},

2417

"selfLink": "A String", # Server-defined URL for the resource.

2418

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2419

"status": "A String", # The current status of the operation.

2420

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2421

"targetLink": "A String", # Server-defined URL for the target of the operation.

2422

"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.

2423

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2427

<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]

2428

<pre>Sets the maintenance policy for a cluster.

2429

2430

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2431

projectId: string, Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)

2432

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]

2433

clusterId: string, Required. The name of the cluster to update. (required)

2434

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2435

The object takes the form of:

2436

2437

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2438

"clusterId": "A String", # Required. The name of the cluster to update.

2439

"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.

2440

"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.

2441

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

2442

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

2443

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

2444

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

2445

},

2446

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

2447

"a_key": { # Represents an arbitrary window of time.

2448

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

2449

"startTime": "A String", # The time that the window first starts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2450

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2451

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2452

"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.

2453

"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.

2454

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

2455

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

2456

"startTime": "A String", # The time that the window first starts.

2457

},

2458

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2459

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2460

},

2461

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.

2462

"projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).

2463

"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.

2464

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2465

2466

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2473

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2474

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2475

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2476

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2477

"canonicalCode": "A String", # Canonical code of the condition.

2478

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2479

"message": "A String", # Human-friendly representation of the condition

2480

},

2481

],

2482

"detail": "A String", # Detailed operation progress, if available.

2483

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2484

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

2485

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2486

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2487

{

2488

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2489

},

2490

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2491

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2492

},

2493

"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.

2494

"name": "A String", # The server-assigned ID for the operation.

2495

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2496

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2497

"canonicalCode": "A String", # Canonical code of the condition.

2498

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2499

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2500

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2501

],

2502

"operationType": "A String", # The operation type.

2503

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2504

"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}]

2505

{ # Progress metric is (string, int|float|string) pair.

2506

"doubleValue": 3.14, # For metrics with floating point value.

2507

"intValue": "A String", # For metrics with integer value.

2508

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2509

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2510

},

2511

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2512

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2513

"stages": [ # Substages of an operation or a stage.

2514

# Object with schema name: OperationProgress

2515

],

2516

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2517

},

2518

"selfLink": "A String", # Server-defined URL for the resource.

2519

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2520

"status": "A String", # The current status of the operation.

2521

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2522

"targetLink": "A String", # Server-defined URL for the target of the operation.

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.

2524

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2528

<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]

2529

<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]

2530

2531

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2532

projectId: string, Required. 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)

2533

zone: string, Required. 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)

2534

clusterId: string, Required. 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]

2535

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2536

The object takes the form of:

2537

2538

{ # SetMasterAuthRequest updates the admin password of a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2539

"action": "A String", # Required. The exact form of action to be taken on the master auth.

2540

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2541

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.

2542

"projectId": "A String", # Required. 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.

2543

"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.

2544

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

2545

"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.

2546

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2547

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2548

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

2549

"clusterCaCertificate": "A String",

2550

"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

2551

"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

2552

},

2553

"zone": "A String", # Required. 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.

2554

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2555

2556

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2563

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2564

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2565

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2566

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2567

"canonicalCode": "A String", # Canonical code of the condition.

2568

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2569

"message": "A String", # Human-friendly representation of the condition

2570

},

2571

],

2572

"detail": "A String", # Detailed operation progress, if available.

2573

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2574

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

2575

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2576

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2577

{

2578

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2579

},

2580

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2581

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2582

},

2583

"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.

2584

"name": "A String", # The server-assigned ID for the operation.

2585

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2586

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2587

"canonicalCode": "A String", # Canonical code of the condition.

2588

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2589

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2590

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2591

],

2592

"operationType": "A String", # The operation type.

2593

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2594

"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}]

2595

{ # Progress metric is (string, int|float|string) pair.

2596

"doubleValue": 3.14, # For metrics with floating point value.

2597

"intValue": "A String", # For metrics with integer value.

2598

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2599

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2600

},

2601

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2602

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2603

"stages": [ # Substages of an operation or a stage.

2604

# Object with schema name: OperationProgress

2605

],

2606

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2607

},

2608

"selfLink": "A String", # Server-defined URL for the resource.

2609

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2610

"status": "A String", # The current status of the operation.

2611

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2612

"targetLink": "A String", # Server-defined URL for the target of the operation.

2613

"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.

2614

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2618

<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]

2619

<pre>Enables or disables Network Policy for a cluster.

2620

2621

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2622

projectId: string, Required. 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)

2623

zone: string, Required. 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)

2624

clusterId: string, Required. 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]

2625

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2626

The object takes the form of:

2627

2628

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2629

"clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

2630

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.

2631

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Required. Configuration options for the NetworkPolicy feature.

2632

"enabled": True or False, # Whether network policy is enabled on the cluster.

2633

"provider": "A String", # The selected network policy provider.

2634

},

2635

"projectId": "A String", # Required. 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.

2636

"zone": "A String", # Required. 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.

2637

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2638

2639

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2646

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2647

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2648

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2649

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2650

"canonicalCode": "A String", # Canonical code of the condition.

2651

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2652

"message": "A String", # Human-friendly representation of the condition

2653

},

2654

],

2655

"detail": "A String", # Detailed operation progress, if available.

2656

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2657

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

2658

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2659

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2660

{

2661

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2662

},

2663

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2664

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2665

},

2666

"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.

2667

"name": "A String", # The server-assigned ID for the operation.

2668

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2669

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2670

"canonicalCode": "A String", # Canonical code of the condition.

2671

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2672

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2673

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2674

],

2675

"operationType": "A String", # The operation type.

2676

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2677

"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}]

2678

{ # Progress metric is (string, int|float|string) pair.

2679

"doubleValue": 3.14, # For metrics with floating point value.

2680

"intValue": "A String", # For metrics with integer value.

2681

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2682

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2683

},

2684

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2685

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2686

"stages": [ # Substages of an operation or a stage.

2687

# Object with schema name: OperationProgress

2688

],

2689

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2690

},

2691

"selfLink": "A String", # Server-defined URL for the resource.

2692

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2693

"status": "A String", # The current status of the operation.

2694

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2695

"targetLink": "A String", # Server-defined URL for the target of the operation.

2696

"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.

2697

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2701

<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]

2702

<pre>Starts master IP rotation.

2703

2704

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2705

projectId: string, Required. 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)

2706

zone: string, Required. 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)

2707

clusterId: string, Required. 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]

2708

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2709

The object takes the form of:

2710

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2711

{ # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2712

"clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

2713

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.

2714

"projectId": "A String", # Required. 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.

2715

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

2716

"zone": "A String", # Required. 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.

2717

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2718

2719

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2726

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2727

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2728

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2729

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2730

"canonicalCode": "A String", # Canonical code of the condition.

2731

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2732

"message": "A String", # Human-friendly representation of the condition

2733

},

2734

],

2735

"detail": "A String", # Detailed operation progress, if available.

2736

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2737

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

2738

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2739

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2740

{

2741

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2742

},

2743

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2744

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2745

},

2746

"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.

2747

"name": "A String", # The server-assigned ID for the operation.

2748

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2749

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2750

"canonicalCode": "A String", # Canonical code of the condition.

2751

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2752

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2753

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2754

],

2755

"operationType": "A String", # The operation type.

2756

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2757

"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}]

2758

{ # Progress metric is (string, int|float|string) pair.

2759

"doubleValue": 3.14, # For metrics with floating point value.

2760

"intValue": "A String", # For metrics with integer value.

2761

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2762

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2763

},

2764

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2765

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2766

"stages": [ # Substages of an operation or a stage.

2767

# Object with schema name: OperationProgress

2768

],

2769

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2770

},

2771

"selfLink": "A String", # Server-defined URL for the resource.

2772

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2773

"status": "A String", # The current status of the operation.

2774

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2775

"targetLink": "A String", # Server-defined URL for the target of the operation.

2776

"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.

2777

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2781

<code class="details" id="update">update(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2782

<pre>Updates the settings for a specific cluster.

2783

2784

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2785

projectId: string, Required. 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)

2786

zone: string, Required. 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)

2787

clusterId: string, Required. 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]

2788

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2789

The object takes the form of:

2790

2791

{ # UpdateClusterRequest updates the settings of a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2792

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2793

"name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.

2794

"projectId": "A String", # Required. 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.

2795

"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.

2796

"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.

2797

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.

2798

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2799

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2800

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2801

"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

2802

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2803

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2804

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

2805

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

2806

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2807

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2808

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2809

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2810

"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.

2811

"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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2812

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2813

"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.

2814

"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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2815

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2816

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure microservices.

2817

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

2818

"disabled": True or False, # Whether Istio is enabled for this cluster.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2819

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2820

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.

2821

"enabled": True or False, # Whether KALM is enabled for this cluster.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2822

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2823

"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

2824

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2825

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2826

"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.

2827

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2828

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2829

},

yoshi-code-bot

9e2cde2

2021-04-29 03:48:05 -0700

[diff] [blame]

2830

"desiredAutopilot": { # Autopilot is the configuration for Autopilot settings on the cluster. # The desired Autopilot configuration for the cluster.

2831

"enabled": True or False, # Enable Autopilot

2832

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2833

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

2834

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binauthz.

2835

},

2836

"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.

2837

"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.

2838

"A String",

2839

],

2840

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

2841

"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

2842

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2843

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

2844

"imageType": "A String", # The image type to use for NAP created node.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2845

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.

2846

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

2847

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

2848

"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.

2849

"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.

2850

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

2851

},

2852

},

2853

"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) To unset the min cpu platform field pass "automatic" as field value.

2854

"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.

2855

"A String",

2856

],

2857

"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.

2858

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2859

"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.

2860

"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.

2861

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

2862

"upgradeSettings": { # Upgrade settings control disruption and speed of the upgrade.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2863

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

2864

"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.

2865

},

2866

},

2867

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

2868

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

2869

"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.

2870

{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.

2871

"maximum": "A String", # Maximum amount of the resource in the cluster.

2872

"minimum": "A String", # Minimum amount of the resource in the cluster.

2873

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

},

],

},

"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster.

2878

"type": "A String", # Type of the integration.

2879

},

2880

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2881

"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

2882

"state": "A String", # Denotes the state of etcd encryption.

2883

},

2884

"desiredDatapathProvider": "A String", # The desired datapath provider for the cluster.

2885

"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.

2886

"disabled": True or False, # Disables cluster default sNAT rules.

2887

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2888

"desiredDnsConfig": { # DNSConfig contains the desired set of options for configuring clusterDNS. # DNSConfig contains clusterDNS config for this cluster.

2889

"clusterDns": "A String", # cluster_dns indicates which in-cluster DNS provider should be used.

2890

"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records.

2891

"clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records.

2892

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2893

"desiredImageType": "A String", # The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

2894

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. # The desired config of Intra-node visibility.

2895

"enabled": True or False, # Enables intra node visibility for this cluster.

2896

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2897

"desiredL4ilbSubsettingConfig": { # ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. # The desired L4 Internal Load Balancer Subsetting configuration.

2898

"enabled": True or False, # Enables l4 ILB subsetting for this cluster

2899

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2900

"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.

2901

"A String",

2902

],

2903

"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.

2904

"desiredMaster": { # Master is the configuration for components on master. # Configuration for master components.

2905

},

2906

"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.

2907

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.

2908

{ # CidrBlock contains an optional name and one CIDR block.

2909

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

2910

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

2911

},

2912

],

2913

"enabled": True or False, # Whether or not master authorized networks is enabled.

2914

},

2915

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the latest supported version. 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

2916

"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.

2917

"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.

2918

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2919

"enabled": True or False, # Is autoscaling enabled for this node pool.

2920

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

2921

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

2922

},

2923

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family", "desired_node_pool_autoscaling", or "desired_workload_metadata_config" is specified and there is more than one node pool on the cluster.

2924

"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

2925

"desiredNotificationConfig": { # NotificationConfig is the configuration of notifications. # The desired notification configuration.

2926

"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.

2927

"enabled": True or False, # Enable notifications for Pub/Sub.

2928

"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.

2929

},

2930

},

2931

"desiredPodSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # The desired configuration options for the PodSecurityPolicy feature.

2932

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.

2933

},

2934

"desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration.

2935

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

2936

"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.

2937

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

2938

"enabled": True or False, # Whenever master is accessible globally or not.

2939

},

2940

"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.

2941

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

2942

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

2943

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

2944

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2945

"desiredPrivateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2946

"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.

2947

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

2948

},

2949

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

2950

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2951

"datasetId": "A String", # The ID of a BigQuery Dataset.

2952

},

2953

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

2954

"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.

2955

},

2956

"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.

2957

},

2958

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

2959

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

2960

},

2961

"desiredTpuConfig": { # Configuration for Cloud TPU. # The desired Cloud TPU configuration.

2962

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

2963

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

2964

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

2965

},

2966

"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.

2967

"enabled": True or False, # Enables vertical pod autoscaling.

2968

},

yoshi-code-bot

2021-04-21 15:07:48 -0700

[diff] [blame]

2969

"desiredWorkloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

2970

"enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty).

2971

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2972

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity.

2973

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

2974

"identityProvider": "A String", # identity provider is the third party identity provider.

2975

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

2976

},

2977

},

2978

"zone": "A String", # Required. 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.

2979

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2980

2981

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2988

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2989

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2990

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2991

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2992

"canonicalCode": "A String", # Canonical code of the condition.

2993

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2994

"message": "A String", # Human-friendly representation of the condition

2995

},

2996

],

2997

"detail": "A String", # Detailed operation progress, if available.

2998

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2999

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

3000

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

3001

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

3002

{

3003

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3004

},

3005

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3006

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

3007

},

3008

"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.

3009

"name": "A String", # The server-assigned ID for the operation.

3010

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

3011

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

3012

"canonicalCode": "A String", # Canonical code of the condition.

3013

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

3014

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3015

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3016

],

3017

"operationType": "A String", # The operation type.

3018

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

3019

"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}]

3020

{ # Progress metric is (string, int|float|string) pair.

3021

"doubleValue": 3.14, # For metrics with floating point value.

3022

"intValue": "A String", # For metrics with integer value.

3023

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

3024

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3025

},

3026

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3027

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

3028

"stages": [ # Substages of an operation or a stage.

3029

# Object with schema name: OperationProgress

3030

],

3031

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

3032

},

3033

"selfLink": "A String", # Server-defined URL for the resource.

3034

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

3035

"status": "A String", # The current status of the operation.

3036

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

3037

"targetLink": "A String", # Server-defined URL for the target of the operation.

3038

"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.

3039

}</pre>

Bu Sun Kim