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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Jon Wayne Parrott

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

[diff] [blame]

78

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

79

</p>

80

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

81

82

Dan O'Meara

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

[diff] [blame]

83

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

Bu Sun Kim

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

[diff] [blame]

84

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

85

Dmitry Frenkel

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

[diff] [blame]

86

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

87

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

88

Dan O'Meara

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

[diff] [blame]

89

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

Sai Cheemalapati

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

[diff] [blame]

90

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

91

Dan O'Meara

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

[diff] [blame]

92

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

Dmitry Frenkel

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

[diff] [blame]

93

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

Takashi Matsuo

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

[diff] [blame]

94

Bu Sun Kim

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

[diff] [blame]

95

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

Dmitry Frenkel

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

[diff] [blame]

96

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

Takashi Matsuo

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

[diff] [blame]

97

Bu Sun Kim

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

[diff] [blame]

98

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

Jon Wayne Parrott

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

[diff] [blame]

99

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

Takashi Matsuo

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

[diff] [blame]

100

Dan O'Meara

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

[diff] [blame]

101

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

Sai Cheemalapati

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

[diff] [blame]

102

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

103

Bu Sun Kim

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

[diff] [blame]

104

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

Dmitry Frenkel

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

[diff] [blame]

105

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

Sai Cheemalapati

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

[diff] [blame]

106

Dan O'Meara

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

[diff] [blame]

107

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

Dmitry Frenkel

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

Dan O'Meara

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

[diff] [blame]

110

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

Bu Sun Kim

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

[diff] [blame]

111

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

112

Dan O'Meara

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

[diff] [blame]

113

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

Bu Sun Kim

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

[diff] [blame]

114

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

115

Dan O'Meara

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

[diff] [blame]

116

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

Bu Sun Kim

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

[diff] [blame]

117

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

118

Dan O'Meara

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

[diff] [blame]

119

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

Sai Cheemalapati

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

[diff] [blame]

120

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

121

Dan O'Meara

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

[diff] [blame]

122

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

Bu Sun Kim

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

[diff] [blame]

123

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

124

Dan O'Meara

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

[diff] [blame]

125

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

Dmitry Frenkel

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

[diff] [blame]

126

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

Bu Sun Kim

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

[diff] [blame]

127

Dan O'Meara

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

[diff] [blame]

128

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

Bu Sun Kim

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

[diff] [blame]

129

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

Sai Cheemalapati

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

[diff] [blame]

130

Dan O'Meara

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

[diff] [blame]

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

Takashi Matsuo

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

[diff] [blame]

133

Dan O'Meara

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

[diff] [blame]

134

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

Jon Wayne Parrott

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

[diff] [blame]

135

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

Takashi Matsuo

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

[diff] [blame]

136

<h3>Method Details</h3>

137

Dan O'Meara

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

[diff] [blame]

138

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

Bu Sun Kim

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

[diff] [blame]

139

<pre>Sets the addons for a specific cluster.

Takashi Matsuo

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

[diff] [blame]

140

141

Args:

Dmitry Frenkel

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

[diff] [blame]

142

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

143

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

144

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

Dan O'Meara

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

[diff] [blame]

145

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

146

The object takes the form of:

147

Bu Sun Kim

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

[diff] [blame]

148

{ # SetAddonsConfigRequest sets the addons associated with the cluster.

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, which allows the user to use a managed Knative service.

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.

161

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

162

},

Yoshi Automation Bot

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

[diff] [blame]

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

"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

170

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

171

},

172

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

173

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

174

},

175

},

176

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

177

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

178

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

179

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

180

}

Sai Cheemalapati

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

[diff] [blame]

181

182

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

189

Dmitry Frenkel

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

[diff] [blame]

190

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

yoshi-code-bot

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

[diff] [blame]

191

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

Yoshi Automation Bot

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

[diff] [blame]

192

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

yoshi-code-bot

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

[diff] [blame]

193

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

194

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

Yoshi Automation Bot

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

[diff] [blame]

195

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

Yoshi Automation Bot

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

[diff] [blame]

196

},

Yoshi Automation Bot

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

[diff] [blame]

197

],

198

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

199

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

yoshi-code-bot

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

[diff] [blame]

200

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

201

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

202

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

203

{

204

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

205

},

206

],

207

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

208

},

Yoshi Automation Bot

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

[diff] [blame]

209

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

210

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

yoshi-code-bot

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

[diff] [blame]

211

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

Yoshi Automation Bot

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

[diff] [blame]

212

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

yoshi-code-bot

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

[diff] [blame]

213

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

214

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

Yoshi Automation Bot

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

[diff] [blame]

215

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

216

},

217

],

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

Yoshi Automation Bot

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

[diff] [blame]

226

},

227

],

Yoshi Automation Bot

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

[diff] [blame]

228

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

229

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

230

# Object with schema name: OperationProgress

231

],

232

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

233

},

234

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

235

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

236

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

yoshi-code-bot

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

[diff] [blame]

237

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

Yoshi Automation Bot

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

[diff] [blame]

238

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

239

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

240

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

244

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

245

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

249

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

250

<pre>Completes master IP rotation.

251

252

Args:

Dmitry Frenkel

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

[diff] [blame]

253

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

254

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

255

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

Dan O'Meara

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

[diff] [blame]

256

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

257

The object takes the form of:

258

259

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

Yoshi Automation Bot

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

[diff] [blame]

260

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

261

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

262

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

263

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

264

}

Bu Sun Kim

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

[diff] [blame]

265

266

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

273

Dmitry Frenkel

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

[diff] [blame]

274

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

yoshi-code-bot

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

[diff] [blame]

275

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

Yoshi Automation Bot

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

[diff] [blame]

276

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

yoshi-code-bot

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

[diff] [blame]

277

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

278

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

Yoshi Automation Bot

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

[diff] [blame]

279

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

Yoshi Automation Bot

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

[diff] [blame]

280

},

Yoshi Automation Bot

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

[diff] [blame]

281

],

282

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

283

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

yoshi-code-bot

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

[diff] [blame]

284

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

285

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

286

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

287

{

288

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

289

},

290

],

291

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

292

},

Yoshi Automation Bot

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

[diff] [blame]

293

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

294

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

yoshi-code-bot

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

[diff] [blame]

295

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

Yoshi Automation Bot

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

[diff] [blame]

296

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

yoshi-code-bot

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

[diff] [blame]

297

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

298

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

Yoshi Automation Bot

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

[diff] [blame]

299

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

300

},

301

],

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

Yoshi Automation Bot

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

[diff] [blame]

310

},

311

],

Yoshi Automation Bot

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

[diff] [blame]

312

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

313

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

314

# Object with schema name: OperationProgress

315

],

316

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

317

},

318

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

319

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

320

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

yoshi-code-bot

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

[diff] [blame]

321

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

Yoshi Automation Bot

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

[diff] [blame]

322

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

323

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

324

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

328

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

329

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

Sai Cheemalapati

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

[diff] [blame]

330

331

Args:

Dmitry Frenkel

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

[diff] [blame]

332

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

333

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

Dan O'Meara

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

[diff] [blame]

334

body: object, The request body.

Takashi Matsuo

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

[diff] [blame]

335

The object takes the form of:

336

337

{ # CreateClusterRequest creates a cluster.

Yoshi Automation Bot

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

[diff] [blame]

338

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

339

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

340

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

341

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

342

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

Yoshi Automation Bot

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

[diff] [blame]

343

},

Yoshi Automation Bot

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

[diff] [blame]

344

"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

345

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

Yoshi Automation Bot

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

[diff] [blame]

346

},

Yoshi Automation Bot

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

[diff] [blame]

347

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

348

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

Yoshi Automation Bot

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

[diff] [blame]

349

},

yoshi-code-bot

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

[diff] [blame]

350

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

351

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

352

},

Yoshi Automation Bot

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

[diff] [blame]

353

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

354

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

355

},

Yoshi Automation Bot

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

[diff] [blame]

356

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

357

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

358

},

Yoshi Automation Bot

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

[diff] [blame]

359

"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

360

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

361

},

362

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

363

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

364

},

365

},

366

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

367

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

368

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

369

},

yoshi-code-bot

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

[diff] [blame]

370

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

371

"enabled": True or False, # Enable Autopilot

372

},

Yoshi Automation Bot

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

[diff] [blame]

373

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

374

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

375

"A String",

376

],

Yoshi Automation Bot

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

[diff] [blame]

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

},

388

},

389

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

390

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

391

"A String",

392

],

393

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

394

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

395

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

396

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

397

},

398

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

399

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

400

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

401

},

Yoshi Automation Bot

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

[diff] [blame]

402

},

Yoshi Automation Bot

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

[diff] [blame]

403

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

404

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

405

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

406

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

407

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

408

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

},

],

},

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

413

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

414

},

415

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

416

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

417

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

yoshi-code-bot

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

[diff] [blame]

418

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

419

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

Yoshi Automation Bot

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

[diff] [blame]

420

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

421

},

422

],

Anthonios Partheniou

10f4b67

2021-04-13 14:47:53 -0400

[diff] [blame]

423

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

424

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

425

},

Yoshi Automation Bot

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

[diff] [blame]

426

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

427

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

428

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

429

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

430

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

431

"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

432

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

433

},

434

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

435

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

436

},

437

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

438

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

439

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

440

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

441

"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

3dd1527

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

[diff] [blame^]

442

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

Yoshi Automation Bot

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

[diff] [blame]

443

"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

444

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

445

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

446

"A String",

447

],

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

"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

461

"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

462

},

463

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

464

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

465

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

466

},

467

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

468

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

469

"A String",

470

],

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

},

479

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

480

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

481

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

482

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

483

},

484

},

485

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

486

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

487

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

488

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

489

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

},

},

},

},

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

495

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

496

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

497

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

498

},

499

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

500

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

501

"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

502

"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

503

},

504

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

505

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

506

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

507

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

508

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

509

},

510

],

511

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

512

},

513

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

514

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

515

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

516

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

517

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

518

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

519

},

520

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

521

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

522

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

523

"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

524

},

525

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

526

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

527

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

528

},

529

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

530

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

531

{ # AcceleratorConfig represents a Hardware Accelerator request.

532

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

533

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

534

},

535

],

536

"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

537

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

538

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

539

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

yoshi-code-bot

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

[diff] [blame]

540

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

541

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

542

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

543

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

544

},

Yoshi Automation Bot

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

[diff] [blame]

545

"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-11-26 17:16:03 -0800

[diff] [blame]

546

"a_key": "A String",

547

},

yoshi-code-bot

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

[diff] [blame]

548

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

549

"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

550

"a_key": "A String",

551

},

552

},

Yoshi Automation Bot

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

[diff] [blame]

553

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

554

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

555

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

556

"a_key": "A String",

Yoshi Automation Bot

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

[diff] [blame]

557

},

Yoshi Automation Bot

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

[diff] [blame]

558

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

559

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

560

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

561

"A String",

562

],

563

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

564

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

565

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

566

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

567

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

568

"A String",

569

],

Yoshi Automation Bot

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

[diff] [blame]

570

},

Yoshi Automation Bot

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

[diff] [blame]

571

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

572

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

Yoshi Automation Bot

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

[diff] [blame]

573

},

Yoshi Automation Bot

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

[diff] [blame]

574

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

575

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

576

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

577

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

578

},

Yoshi Automation Bot

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

[diff] [blame]

579

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

580

"A String",

581

],

582

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

583

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

584

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

585

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

586

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

Yoshi Automation Bot

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

[diff] [blame]

587

},

Yoshi Automation Bot

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

[diff] [blame]

588

],

589

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

590

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

Yoshi Automation Bot

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

[diff] [blame]

591

},

Takashi Matsuo

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

[diff] [blame]

592

},

Yoshi Automation Bot

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

[diff] [blame]

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

},

602

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

603

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

yoshi-code-bot

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

[diff] [blame]

604

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

605

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

Yoshi Automation Bot

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

[diff] [blame]

606

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

607

},

608

],

609

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

610

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

611

{ # AcceleratorConfig represents a Hardware Accelerator request.

612

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

613

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

614

},

615

],

616

"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

617

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

618

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

619

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

yoshi-code-bot

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

[diff] [blame]

620

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

621

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

622

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

623

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

624

},

Yoshi Automation Bot

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

[diff] [blame]

625

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

626

"a_key": "A String",

627

},

yoshi-code-bot

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

[diff] [blame]

628

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

629

"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

630

"a_key": "A String",

631

},

632

},

Yoshi Automation Bot

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

[diff] [blame]

633

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

634

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

635

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

636

"a_key": "A String",

637

},

638

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

639

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

640

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

641

"A String",

642

],

643

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

644

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

645

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

646

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

647

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

652

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

653

},

654

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

655

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

656

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

657

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

658

},

659

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

660

"A String",

661

],

662

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

663

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

664

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

665

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

666

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

667

},

668

],

669

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

670

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

671

},

672

},

673

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

674

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

675

"A String",

676

],

677

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

678

"A String",

679

],

680

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

681

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

682

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

683

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

684

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

685

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

686

},

687

},

688

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

689

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

690

},

691

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

692

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

693

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

694

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

695

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

Yoshi Automation Bot

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

[diff] [blame]

696

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

697

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

698

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

699

},

700

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

701

},

702

],

yoshi-code-bot

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

[diff] [blame]

703

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

704

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

705

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

706

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

707

},

708

},

Yoshi Automation Bot

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

[diff] [blame]

709

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

710

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

711

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

712

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

713

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

714

},

715

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

716

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

717

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

718

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

719

},

720

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

721

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

722

},

723

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

724

"a_key": "A String",

725

},

726

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

727

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

728

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

729

},

730

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

731

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

732

},

733

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

734

},

735

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

736

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

737

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

738

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

739

},

740

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

yoshi-code-bot

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

[diff] [blame]

741

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

742

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

743

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

744

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

745

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

746

},

747

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

748

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

749

},

750

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

751

},

752

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

753

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

754

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

755

}

Takashi Matsuo

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

[diff] [blame]

756

757

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

758

Allowed values

759

1 - v1 error format

760

2 - v2 error format

Takashi Matsuo

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

[diff] [blame]

761

762

Returns:

763

An object of the form:

764

Dmitry Frenkel

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

[diff] [blame]

765

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

yoshi-code-bot

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

[diff] [blame]

766

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

Yoshi Automation Bot

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

[diff] [blame]

767

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

yoshi-code-bot

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

[diff] [blame]

768

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

769

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

Yoshi Automation Bot

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

[diff] [blame]

770

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

Yoshi Automation Bot

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

[diff] [blame]

771

},

Yoshi Automation Bot

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

[diff] [blame]

772

],

773

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

774

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

yoshi-code-bot

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

[diff] [blame]

775

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

776

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

777

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

778

{

779

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

780

},

781

],

782

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

783

},

Yoshi Automation Bot

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

[diff] [blame]

784

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

785

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

yoshi-code-bot

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

[diff] [blame]

786

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

Yoshi Automation Bot

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

[diff] [blame]

787

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

yoshi-code-bot

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

[diff] [blame]

788

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

789

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

Yoshi Automation Bot

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

[diff] [blame]

790

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

791

},

792

],

793

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

794

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

795

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

796

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

797

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

798

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

799

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

800

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

Yoshi Automation Bot

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

[diff] [blame]

801

},

802

],

Yoshi Automation Bot

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

[diff] [blame]

803

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

804

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

805

# Object with schema name: OperationProgress

806

],

807

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

808

},

809

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

810

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

811

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

yoshi-code-bot

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

[diff] [blame]

812

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

Yoshi Automation Bot

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

[diff] [blame]

813

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

814

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

815

}</pre>

Takashi Matsuo

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

819

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

820

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

Takashi Matsuo

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

[diff] [blame]

821

822

Args:

Dmitry Frenkel

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

[diff] [blame]

823

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

824

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

825

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

826

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

Takashi Matsuo

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

[diff] [blame]

827

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

828

Allowed values

829

1 - v1 error format

830

2 - v2 error format

Takashi Matsuo

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

[diff] [blame]

831

832

Returns:

833

An object of the form:

834

Dmitry Frenkel

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

[diff] [blame]

835

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

yoshi-code-bot

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

[diff] [blame]

836

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

Yoshi Automation Bot

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

[diff] [blame]

837

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

yoshi-code-bot

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

[diff] [blame]

838

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

839

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

Yoshi Automation Bot

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

[diff] [blame]

840

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

Yoshi Automation Bot

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

[diff] [blame]

841

},

Yoshi Automation Bot

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

[diff] [blame]

842

],

843

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

844

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

yoshi-code-bot

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

[diff] [blame]

845

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

846

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

847

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

848

{

849

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

850

},

851

],

852

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

853

},

Yoshi Automation Bot

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

[diff] [blame]

854

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

855

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

yoshi-code-bot

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

[diff] [blame]

856

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

Yoshi Automation Bot

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

[diff] [blame]

857

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

yoshi-code-bot

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

[diff] [blame]

858

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

859

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

Yoshi Automation Bot

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

[diff] [blame]

860

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

861

},

862

],

863

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

864

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

865

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

866

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

867

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

868

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

869

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

870

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

Yoshi Automation Bot

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

[diff] [blame]

871

},

872

],

Yoshi Automation Bot

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

[diff] [blame]

873

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

874

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

875

# Object with schema name: OperationProgress

876

],

877

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

878

},

879

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

880

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

881

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

yoshi-code-bot

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

[diff] [blame]

882

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

Yoshi Automation Bot

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

[diff] [blame]

883

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

884

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

885

}</pre>

Takashi Matsuo

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

889

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

Jon Wayne Parrott

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

[diff] [blame]

890

<pre>Gets the details of a specific cluster.

Takashi Matsuo

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

[diff] [blame]

891

892

Args:

Dmitry Frenkel

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

[diff] [blame]

893

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

894

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

895

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

896

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

Takashi Matsuo

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

[diff] [blame]

897

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

898

Allowed values

899

1 - v1 error format

900

2 - v2 error format

Takashi Matsuo

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

[diff] [blame]

901

902

Returns:

903

An object of the form:

904

Bu Sun Kim

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

[diff] [blame]

905

{ # A Google Kubernetes Engine cluster.

Yoshi Automation Bot

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

[diff] [blame]

906

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

907

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

908

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

909

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

Yoshi Automation Bot

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

[diff] [blame]

910

},

Yoshi Automation Bot

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

[diff] [blame]

911

"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

912

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

Yoshi Automation Bot

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

[diff] [blame]

913

},

Yoshi Automation Bot

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

[diff] [blame]

914

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

915

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

Yoshi Automation Bot

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

[diff] [blame]

916

},

yoshi-code-bot

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

[diff] [blame]

917

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

918

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

919

},

Yoshi Automation Bot

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

[diff] [blame]

920

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

921

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

922

},

Yoshi Automation Bot

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

[diff] [blame]

923

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

924

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

925

},

Yoshi Automation Bot

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

[diff] [blame]

926

"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

927

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

928

},

929

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

930

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

931

},

932

},

933

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

934

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

935

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

936

},

yoshi-code-bot

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

[diff] [blame]

937

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

938

"enabled": True or False, # Enable Autopilot

939

},

Yoshi Automation Bot

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

[diff] [blame]

940

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

941

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

942

"A String",

943

],

Yoshi Automation Bot

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

[diff] [blame]

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

},

955

},

956

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

957

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

958

"A String",

959

],

960

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

961

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

962

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

963

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

964

},

965

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

966

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

967

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

968

},

Yoshi Automation Bot

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

[diff] [blame]

969

},

Yoshi Automation Bot

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

[diff] [blame]

970

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

971

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

972

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

973

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

974

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

975

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

},

],

},

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

980

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

981

},

982

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

983

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

984

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

yoshi-code-bot

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

[diff] [blame]

985

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

986

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

Yoshi Automation Bot

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

[diff] [blame]

987

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

988

},

989

],

Anthonios Partheniou

10f4b67

2021-04-13 14:47:53 -0400

[diff] [blame]

990

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

991

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

992

},

Yoshi Automation Bot

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

[diff] [blame]

993

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

994

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

995

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

996

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

997

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

998

"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

999

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

1000

},

1001

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

1002

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

1003

},

1004

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

1005

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

1006

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

1007

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

1008

"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

3dd1527

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

[diff] [blame^]

1009

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

Yoshi Automation Bot

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

[diff] [blame]

1010

"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

1011

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

1012

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

1013

"A String",

1014

],

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

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

1023

"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.

1024

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

1025

"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.

1026

"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.

1027

"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

1028

"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

1029

},

1030

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

1031

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.

1032

"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.

1033

},

1034

"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.

1035

"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.

1036

"A String",

1037

],

1038

"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.

1039

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

1040

"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.

1041

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

1042

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1043

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".

1044

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

1045

},

1046

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

1047

"a_key": { # Represents an arbitrary window of time.

1048

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

1049

"startTime": "A String", # The time that the window first starts.

1050

},

1051

},

1052

"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.

1053

"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.

1054

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

1055

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

1056

"startTime": "A String", # The time that the window first starts.

},

},

},

},

"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.

1062

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

1063

"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.

1064

"issueClientCertificate": True or False, # Issue a client certificate.

1065

},

1066

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

1067

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.

1068

"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

1069

"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

1070

},

1071

"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.

1072

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.

1073

{ # CidrBlock contains an optional name and one CIDR block.

1074

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

1075

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

1076

},

1077

],

1078

"enabled": True or False, # Whether or not master authorized networks is enabled.

1079

},

1080

"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.

1081

"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.

1082

"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.

1083

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

1084

"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.

1085

"disabled": True or False, # Disables cluster default sNAT rules.

1086

},

1087

"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.

1088

"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]

1089

"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]

1090

"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

1091

},

1092

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.

1093

"enabled": True or False, # Whether network policy is enabled on the cluster.

1094

"provider": "A String", # The selected network policy provider.

1095

},

1096

"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.

1097

"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.

1098

{ # AcceleratorConfig represents a Hardware Accelerator request.

1099

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1100

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

1101

},

1102

],

1103

"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

1104

"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]

1105

"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]

1106

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1107

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1108

"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.

1109

"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.

1110

"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.

1111

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1112

"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-11-26 17:16:03 -0800

[diff] [blame]

1113

"a_key": "A String",

1114

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1115

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1116

"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

1117

"a_key": "A String",

1118

},

1119

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1120

"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.

1121

"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`.

1122

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

1123

"a_key": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1124

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1125

"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)

1126

"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).

1127

"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.

1128

"A String",

1129

],

1130

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

1131

"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.

1132

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1133

"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.

1134

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1135

"A String",

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

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1139

"type": "A String", # Type of the sandbox to use for the node.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1140

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1141

"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.

1142

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1143

"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.

1144

"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]

1145

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1146

"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.

1147

"A String",

1148

],

1149

"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/

1150

{ # 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.

1151

"effect": "A String", # Effect for taint.

1152

"key": "A String", # Key for taint.

1153

"value": "A String", # Value for taint.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1154

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1155

],

1156

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.

1157

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1158

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1159

},

1160

"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.

1161

"nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

1162

{ # 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.

1163

"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.

1164

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

1165

"enabled": True or False, # Is autoscaling enabled for this node pool.

1166

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

1167

"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]

1168

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1169

"conditions": [ # Which conditions caused the current node pool state.

1170

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1171

"canonicalCode": "A String", # Canonical code of the condition.

1172

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1173

"message": "A String", # Human-friendly representation of the condition

1174

},

1175

],

1176

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

1177

"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.

1178

{ # AcceleratorConfig represents a Hardware Accelerator request.

1179

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1180

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

1181

},

1182

],

1183

"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

1184

"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]

1185

"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]

1186

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1187

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1188

"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.

1189

"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.

1190

"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.

1191

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1192

"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/

1193

"a_key": "A String",

1194

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1195

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1196

"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

1197

"a_key": "A String",

1198

},

1199

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1200

"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.

1201

"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`.

1202

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

1203

"a_key": "A String",

1204

},

1205

"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)

1206

"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).

1207

"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.

1208

"A String",

1209

],

1210

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

1211

"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.

1212

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1213

"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.

1214

"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.

1219

"type": "A String", # Type of the sandbox to use for the node.

1220

},

1221

"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.

1222

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1223

"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.

1224

"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.

1225

},

1226

"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.

1227

"A String",

1228

],

1229

"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/

1230

{ # 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.

1231

"effect": "A String", # Effect for taint.

1232

"key": "A String", # Key for taint.

1233

"value": "A String", # Value for taint.

1234

},

1235

],

1236

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.

1237

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.

1238

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1239

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1240

"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.

1241

"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.

1242

"A String",

1243

],

1244

"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.

1245

"A String",

1246

],

1247

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.

1248

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

1249

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

1250

"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.

1251

"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.

1252

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

1253

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1254

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1255

"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.

1256

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1257

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1258

"name": "A String", # The name of the node pool.

1259

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

1260

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1261

"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]

1262

"statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1263

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.

1264

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1265

"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-11-26 17:16:03 -0800

[diff] [blame]

1266

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1267

"version": "A String", # The version of the Kubernetes of this node.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

1268

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1269

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1270

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.

1271

"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.

1272

"enabled": True or False, # Enable notifications for Pub/Sub.

1273

"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.

1274

},

1275

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1276

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

1277

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

1278

"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.

1279

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

1280

"enabled": True or False, # Whenever master is accessible globally or not.

1281

},

1282

"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.

1283

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

1284

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

1285

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

1286

},

1287

"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.

1288

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

1289

},

1290

"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

1291

"a_key": "A String",

1292

},

1293

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

1294

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

1295

"datasetId": "A String", # The ID of a BigQuery Dataset.

1296

},

1297

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

1298

"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.

1299

},

1300

"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.

1301

},

1302

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1303

"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.

1304

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

1305

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

1306

},

1307

"status": "A String", # [Output only] The current status of this cluster.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1308

"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]

1309

"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.

1310

"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`).

1311

"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.

1312

"enabled": True or False, # Enables vertical pod autoscaling.

1313

},

1314

"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.

1315

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

1316

},

1317

"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.

1318

}</pre>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1322

<code class="details" id="legacyAbac">legacyAbac(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1323

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1324

1325

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1326

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

1327

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

1328

clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1329

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1330

The object takes the form of:

1331

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1332

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1333

"clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

1334

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

1335

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.

1336

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

1337

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

1338

}

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1339

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1340

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1347

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1348

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1349

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1350

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1351

"canonicalCode": "A String", # Canonical code of the condition.

1352

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1353

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1354

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1355

],

1356

"detail": "A String", # Detailed operation progress, if available.

1357

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1358

"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.

1359

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1360

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1361

{

1362

"a_key": "", # Properties of the object. Contains field @type with type URL.

1363

},

1364

],

1365

"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.

1366

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1367

"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.

1368

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1369

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1370

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1371

"canonicalCode": "A String", # Canonical code of the condition.

1372

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1373

"message": "A String", # Human-friendly representation of the condition

1374

},

1375

],

1376

"operationType": "A String", # The operation type.

1377

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1378

"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}]

1379

{ # Progress metric is (string, int|float|string) pair.

1380

"doubleValue": 3.14, # For metrics with floating point value.

1381

"intValue": "A String", # For metrics with integer value.

1382

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1383

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1384

},

1385

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1386

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

1387

"stages": [ # Substages of an operation or a stage.

1388

# Object with schema name: OperationProgress

1389

],

1390

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

1391

},

1392

"selfLink": "A String", # Server-defined URL for the resource.

1393

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1394

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1395

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1396

"targetLink": "A String", # Server-defined URL for the target of the operation.

1397

"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.

1398

}</pre>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1402

<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]

1403

<pre>Lists all clusters owned by a project in either the specified zone or all zones.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1404

1405

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1406

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. (required)

1407

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)

1408

parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1409

x__xgafv: string, V1 error format.

1410

Allowed values

1411

1 - v1 error format

1412

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1413

1414

Returns:

1415

An object of the form:

1416

1417

{ # ListClustersResponse is the result of ListClustersRequest.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1418

"clusters": [ # A list of clusters in the project in the specified zone, or across all ones.

1419

{ # A Google Kubernetes Engine cluster.

1420

"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.

1421

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.

1422

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1423

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1424

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1425

"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

1426

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1427

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1428

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

1429

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1430

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1431

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.

1432

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

1433

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1434

"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.

1435

"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]

1436

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1437

"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.

1438

"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]

1439

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1440

"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

1441

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

1442

},

1443

"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.

1444

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1445

},

1446

},

1447

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

1448

"enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.

1449

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true.

1450

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1451

"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]

1452

"enabled": True or False, # Enable Autopilot

1453

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1454

"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.

1455

"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]

1456

"A String",

1457

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1458

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

1459

"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]

1460

"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]

1461

"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]

1462

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.

1463

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

1464

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

1465

"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.

1466

"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.

1467

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

1468

},

1469

},

1470

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value.

1471

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

1472

"A String",

1473

],

1474

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

1475

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1476

"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.

1477

"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.

1478

},

1479

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Specifies the upgrade settings for NAP created node pools

1480

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1481

"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.

1482

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1483

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1484

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

1485

"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.

1486

{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.

1487

"maximum": "A String", # Maximum amount of the resource in the cluster.

1488

"minimum": "A String", # Minimum amount of the resource in the cluster.

1489

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

},

],

},

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

1494

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.

1495

},

1496

"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`.

1497

"conditions": [ # Which conditions caused the current cluster state.

1498

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1499

"canonicalCode": "A String", # Canonical code of the condition.

1500

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1501

"message": "A String", # Human-friendly representation of the condition

1502

},

1503

],

Anthonios Partheniou

10f4b67

2021-04-13 14:47:53 -0400

[diff] [blame]

1504

"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Configuration of Confidential Nodes

1505

"enabled": True or False, # Whether Confidential Nodes feature is enabled for all nodes in this cluster.

1506

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1507

"createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1508

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

1509

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

1510

"currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

1511

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

1512

"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

1513

"state": "A String", # Denotes the state of etcd encryption.

1514

},

1515

"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.

1516

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1517

},

1518

"description": "A String", # An optional description of this cluster.

1519

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

1520

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.

1521

"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.

1522

"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

3dd1527

2021-04-21 15:07:48 -0700

[diff] [blame^]

1523

"id": "A String", # Output only. Unique id for the cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1524

"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

1525

"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.

1526

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

1527

"A String",

1528

],

1529

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

1530

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

1531

"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.

1532

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

1533

"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.

1534

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1535

"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.

1536

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

1537

"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.

1538

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

1539

"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.

1540

"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.

1541

"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

1542

"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

1543

},

1544

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

1545

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.

1546

"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.

1547

},

1548

"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.

1549

"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.

1550

"A String",

1551

],

1552

"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.

1553

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

1554

"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.

1555

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

1556

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1557

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".

1558

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

1559

},

1560

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

1561

"a_key": { # Represents an arbitrary window of time.

1562

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

1563

"startTime": "A String", # The time that the window first starts.

1564

},

1565

},

1566

"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.

1567

"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.

1568

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

1569

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

1570

"startTime": "A String", # The time that the window first starts.

},

},

},

},

"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.

1576

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

1577

"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.

1578

"issueClientCertificate": True or False, # Issue a client certificate.

1579

},

1580

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

1581

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.

1582

"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

1583

"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

1584

},

1585

"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.

1586

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.

1587

{ # CidrBlock contains an optional name and one CIDR block.

1588

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

1589

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

1590

},

1591

],

1592

"enabled": True or False, # Whether or not master authorized networks is enabled.

1593

},

1594

"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.

1595

"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.

1596

"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.

1597

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

1598

"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.

1599

"disabled": True or False, # Disables cluster default sNAT rules.

1600

},

1601

"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.

1602

"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]

1603

"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]

1604

"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

1605

},

1606

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.

1607

"enabled": True or False, # Whether network policy is enabled on the cluster.

1608

"provider": "A String", # The selected network policy provider.

1609

},

1610

"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.

1611

"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.

1612

{ # AcceleratorConfig represents a Hardware Accelerator request.

1613

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1614

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

1615

},

1616

],

1617

"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

1618

"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]

1619

"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]

1620

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1621

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1622

"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.

1623

"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.

1624

"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.

1625

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1626

"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-11-26 17:16:03 -0800

[diff] [blame]

1627

"a_key": "A String",

1628

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1629

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1630

"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

1631

"a_key": "A String",

1632

},

1633

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1634

"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.

1635

"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`.

1636

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

1637

"a_key": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1638

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1639

"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)

1640

"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).

1641

"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.

1642

"A String",

1643

],

1644

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

1645

"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.

1646

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1647

"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.

1648

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1649

"A String",

1650

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1651

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1652

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1653

"type": "A String", # Type of the sandbox to use for the node.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1654

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1655

"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.

1656

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1657

"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.

1658

"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]

1659

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1660

"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.

1661

"A String",

1662

],

1663

"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/

1664

{ # 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.

1665

"effect": "A String", # Effect for taint.

1666

"key": "A String", # Key for taint.

1667

"value": "A String", # Value for taint.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1668

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1669

],

1670

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.

1671

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1672

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1673

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1674

"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.

1675

"nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

1676

{ # 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.

1677

"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.

1678

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

1679

"enabled": True or False, # Is autoscaling enabled for this node pool.

1680

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

1681

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

1682

},

1683

"conditions": [ # Which conditions caused the current node pool state.

1684

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1685

"canonicalCode": "A String", # Canonical code of the condition.

1686

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1687

"message": "A String", # Human-friendly representation of the condition

1688

},

1689

],

1690

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

1691

"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.

1692

{ # AcceleratorConfig represents a Hardware Accelerator request.

1693

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1694

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

1695

},

1696

],

1697

"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

1698

"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]

1699

"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]

1700

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1701

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1702

"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.

1703

"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.

1704

"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.

1705

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1706

"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/

1707

"a_key": "A String",

1708

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1709

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1710

"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

1711

"a_key": "A String",

1712

},

1713

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1714

"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.

1715

"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`.

1716

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

1717

"a_key": "A String",

1718

},

1719

"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)

1720

"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).

1721

"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.

1722

"A String",

1723

],

1724

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

1725

"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.

1726

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1727

"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.

1728

"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.

1733

"type": "A String", # Type of the sandbox to use for the node.

1734

},

1735

"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.

1736

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1737

"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.

1738

"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.

1739

},

1740

"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.

1741

"A String",

1742

],

1743

"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/

1744

{ # 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.

1745

"effect": "A String", # Effect for taint.

1746

"key": "A String", # Key for taint.

1747

"value": "A String", # Value for taint.

1748

},

1749

],

1750

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.

1751

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.

1752

},

1753

},

1754

"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.

1755

"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.

1756

"A String",

1757

],

1758

"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.

1759

"A String",

1760

],

1761

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.

1762

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

1763

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

1764

"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.

1765

"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.

1766

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

1767

},

1768

},

1769

"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.

1770

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1771

},

1772

"name": "A String", # The name of the node pool.

1773

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

1774

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1775

"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]

1776

"statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1777

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.

1778

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1779

"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.

1780

},

1781

"version": "A String", # The version of the Kubernetes of this node.

1782

},

1783

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1784

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.

1785

"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.

1786

"enabled": True or False, # Enable notifications for Pub/Sub.

1787

"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.

1788

},

1789

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1790

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

1791

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

1792

"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.

1793

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

1794

"enabled": True or False, # Whenever master is accessible globally or not.

1795

},

1796

"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.

1797

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

1798

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

1799

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

1800

},

1801

"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.

1802

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

1803

},

1804

"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

1805

"a_key": "A String",

1806

},

1807

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

1808

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

1809

"datasetId": "A String", # The ID of a BigQuery Dataset.

1810

},

1811

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

1812

"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.

1813

},

1814

"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.

1815

},

1816

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1817

"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.

1818

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

1819

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

1820

},

1821

"status": "A String", # [Output only] The current status of this cluster.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1822

"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]

1823

"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.

1824

"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`).

1825

"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.

1826

"enabled": True or False, # Enables vertical pod autoscaling.

1827

},

1828

"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.

1829

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

1830

},

1831

"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.

1832

},

1833

],

1834

"missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.

1835

"A String",

1836

],

1837

}</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]

1841

<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]

1842

<pre>Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1843

1844

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1845

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

1846

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

1847

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1848

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1849

The object takes the form of:

1850

1851

{ # SetLocationsRequest sets the locations of the cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1852

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

1853

"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.

1854

"A String",

1855

],

1856

"name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.

1857

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

1858

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

1859

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1860

1861

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1868

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1869

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1870

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1871

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1872

"canonicalCode": "A String", # Canonical code of the condition.

1873

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1874

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1875

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1876

],

1877

"detail": "A String", # Detailed operation progress, if available.

1878

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1879

"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.

1880

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1881

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1882

{

1883

"a_key": "", # Properties of the object. Contains field @type with type URL.

1884

},

1885

],

1886

"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.

1887

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1888

"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.

1889

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1890

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1891

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1892

"canonicalCode": "A String", # Canonical code of the condition.

1893

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1894

"message": "A String", # Human-friendly representation of the condition

1895

},

1896

],

1897

"operationType": "A String", # The operation type.

1898

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1899

"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}]

1900

{ # Progress metric is (string, int|float|string) pair.

1901

"doubleValue": 3.14, # For metrics with floating point value.

1902

"intValue": "A String", # For metrics with integer value.

1903

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1904

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1905

},

1906

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1907

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

1908

"stages": [ # Substages of an operation or a stage.

1909

# Object with schema name: OperationProgress

1910

],

1911

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

1912

},

1913

"selfLink": "A String", # Server-defined URL for the resource.

1914

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1915

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1916

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1917

"targetLink": "A String", # Server-defined URL for the target of the operation.

1918

"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.

1919

}</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]

1923

<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]

1924

<pre>Sets the logging service for a specific cluster.

1925

1926

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1927

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

1928

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

1929

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1930

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1931

The object takes the form of:

1932

1933

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1934

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

1935

"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.

1936

"name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.

1937

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

1938

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

1939

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1940

1941

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1948

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1949

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1950

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1951

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1952

"canonicalCode": "A String", # Canonical code of the condition.

1953

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1954

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1955

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1956

],

1957

"detail": "A String", # Detailed operation progress, if available.

1958

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1959

"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.

1960

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1961

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1962

{

1963

"a_key": "", # Properties of the object. Contains field @type with type URL.

1964

},

1965

],

1966

"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.

1967

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1968

"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.

1969

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1970

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1971

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1972

"canonicalCode": "A String", # Canonical code of the condition.

1973

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1974

"message": "A String", # Human-friendly representation of the condition

1975

},

1976

],

1977

"operationType": "A String", # The operation type.

1978

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

1979

"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}]

1980

{ # Progress metric is (string, int|float|string) pair.

1981

"doubleValue": 3.14, # For metrics with floating point value.

1982

"intValue": "A String", # For metrics with integer value.

1983

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1984

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1985

},

1986

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1987

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

1988

"stages": [ # Substages of an operation or a stage.

1989

# Object with schema name: OperationProgress

1990

],

1991

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

1992

},

1993

"selfLink": "A String", # Server-defined URL for the resource.

1994

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1995

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1996

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1997

"targetLink": "A String", # Server-defined URL for the target of the operation.

1998

"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.

1999

}</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]

2003

<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]

2004

<pre>Updates the master for a specific cluster.

2005

2006

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2007

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

2008

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2009

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2010

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2011

The object takes the form of:

2012

2013

{ # UpdateMasterRequest updates the master of the cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2014

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2015

"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

2016

"name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.

2017

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

2018

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

2019

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2020

2021

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2028

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2029

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2030

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2031

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2032

"canonicalCode": "A String", # Canonical code of the condition.

2033

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2034

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2035

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2036

],

2037

"detail": "A String", # Detailed operation progress, if available.

2038

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2039

"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.

2040

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2041

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2042

{

2043

"a_key": "", # Properties of the object. Contains field @type with type URL.

2044

},

2045

],

2046

"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.

2047

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2048

"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.

2049

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2050

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2051

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2052

"canonicalCode": "A String", # Canonical code of the condition.

2053

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2054

"message": "A String", # Human-friendly representation of the condition

2055

},

2056

],

2057

"operationType": "A String", # The operation type.

2058

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2059

"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}]

2060

{ # Progress metric is (string, int|float|string) pair.

2061

"doubleValue": 3.14, # For metrics with floating point value.

2062

"intValue": "A String", # For metrics with integer value.

2063

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2064

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

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

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2068

"stages": [ # Substages of an operation or a stage.

2069

# Object with schema name: OperationProgress

2070

],

2071

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2072

},

2073

"selfLink": "A String", # Server-defined URL for the resource.

2074

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2075

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2076

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2077

"targetLink": "A String", # Server-defined URL for the target of the operation.

2078

"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.

2079

}</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]

2083

<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]

2084

<pre>Sets the monitoring service for a specific cluster.

2085

2086

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2087

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

2088

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2089

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2090

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2091

The object takes the form of:

2092

2093

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2094

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2095

"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.

2096

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.

2097

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

2098

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

2099

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2100

2101

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2108

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2109

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2110

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2111

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2112

"canonicalCode": "A String", # Canonical code of the condition.

2113

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2114

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2115

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2116

],

2117

"detail": "A String", # Detailed operation progress, if available.

2118

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2119

"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.

2120

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2121

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2122

{

2123

"a_key": "", # Properties of the object. Contains field @type with type URL.

2124

},

2125

],

2126

"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.

2127

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2128

"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.

2129

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2130

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2131

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2132

"canonicalCode": "A String", # Canonical code of the condition.

2133

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2134

"message": "A String", # Human-friendly representation of the condition

2135

},

2136

],

2137

"operationType": "A String", # The operation type.

2138

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2139

"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}]

2140

{ # Progress metric is (string, int|float|string) pair.

2141

"doubleValue": 3.14, # For metrics with floating point value.

2142

"intValue": "A String", # For metrics with integer value.

2143

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2144

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

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

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2148

"stages": [ # Substages of an operation or a stage.

2149

# Object with schema name: OperationProgress

2150

],

2151

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2152

},

2153

"selfLink": "A String", # Server-defined URL for the resource.

2154

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2155

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2156

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2157

"targetLink": "A String", # Server-defined URL for the target of the operation.

2158

"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.

2159

}</pre>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2163

<code class="details" id="resourceLabels">resourceLabels(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2164

<pre>Sets labels on a cluster.

2165

2166

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2167

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. (required)

2168

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2169

clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2170

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2171

The object takes the form of:

2172

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2173

{ # 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]

2174

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

2175

"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.

2176

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.

2177

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.

2178

"resourceLabels": { # Required. The labels to set for that cluster.

2179

"a_key": "A String",

2180

},

2181

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

2182

}

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2183

2184

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2191

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2192

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2193

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2194

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2195

"canonicalCode": "A String", # Canonical code of the condition.

2196

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2197

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2198

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2199

],

2200

"detail": "A String", # Detailed operation progress, if available.

2201

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2202

"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.

2203

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2204

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2205

{

2206

"a_key": "", # Properties of the object. Contains field @type with type URL.

2207

},

2208

],

2209

"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.

2210

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2211

"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.

2212

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2213

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2214

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2215

"canonicalCode": "A String", # Canonical code of the condition.

2216

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2217

"message": "A String", # Human-friendly representation of the condition

2218

},

2219

],

2220

"operationType": "A String", # The operation type.

2221

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2222

"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}]

2223

{ # Progress metric is (string, int|float|string) pair.

2224

"doubleValue": 3.14, # For metrics with floating point value.

2225

"intValue": "A String", # For metrics with integer value.

2226

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2227

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2228

},

2229

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2230

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2231

"stages": [ # Substages of an operation or a stage.

2232

# Object with schema name: OperationProgress

2233

],

2234

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2235

},

2236

"selfLink": "A String", # Server-defined URL for the resource.

2237

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2238

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2239

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2240

"targetLink": "A String", # Server-defined URL for the target of the operation.

2241

"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.

2242

}</pre>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2246

<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]

2247

<pre>Sets the maintenance policy for a cluster.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2248

2249

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2250

projectId: string, Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)

2251

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]

2252

clusterId: string, Required. The name of the cluster to update. (required)

2253

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2254

The object takes the form of:

2255

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2256

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2257

"clusterId": "A String", # Required. The name of the cluster to update.

2258

"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.

2259

"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.

2260

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

2261

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

2262

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".

2263

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

2264

},

2265

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

2266

"a_key": { # Represents an arbitrary window of time.

2267

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

2268

"startTime": "A String", # The time that the window first starts.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2269

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2270

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2271

"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.

2272

"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.

2273

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

2274

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

2275

"startTime": "A String", # The time that the window first starts.

2276

},

2277

},

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2278

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2279

},

2280

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.

2281

"projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).

2282

"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.

2283

}

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2284

2285

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2292

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2293

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2294

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2295

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2296

"canonicalCode": "A String", # Canonical code of the condition.

2297

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2298

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2299

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2300

],

2301

"detail": "A String", # Detailed operation progress, if available.

2302

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2303

"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.

2304

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2305

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2306

{

2307

"a_key": "", # Properties of the object. Contains field @type with type URL.

2308

},

2309

],

2310

"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.

2311

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2312

"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.

2313

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2314

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2315

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2316

"canonicalCode": "A String", # Canonical code of the condition.

2317

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2318

"message": "A String", # Human-friendly representation of the condition

2319

},

2320

],

2321

"operationType": "A String", # The operation type.

2322

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2323

"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}]

2324

{ # Progress metric is (string, int|float|string) pair.

2325

"doubleValue": 3.14, # For metrics with floating point value.

2326

"intValue": "A String", # For metrics with integer value.

2327

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2328

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2329

},

2330

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2331

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2332

"stages": [ # Substages of an operation or a stage.

2333

# Object with schema name: OperationProgress

2334

],

2335

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2336

},

2337

"selfLink": "A String", # Server-defined URL for the resource.

2338

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2339

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2340

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2341

"targetLink": "A String", # Server-defined URL for the target of the operation.

2342

"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.

2343

}</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]

2347

<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]

2348

<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]

2349

2350

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2351

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

2352

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2353

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2354

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2355

The object takes the form of:

2356

2357

{ # SetMasterAuthRequest updates the admin password of a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2358

"action": "A String", # Required. The exact form of action to be taken on the master auth.

2359

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2360

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.

2361

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

2362

"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.

2363

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

2364

"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.

2365

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2366

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2367

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

2368

"clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.

2369

"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

2370

"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

2371

},

2372

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

2373

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2374

2375

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2382

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2383

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2384

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2385

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2386

"canonicalCode": "A String", # Canonical code of the condition.

2387

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2388

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2389

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2390

],

2391

"detail": "A String", # Detailed operation progress, if available.

2392

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2393

"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.

2394

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2395

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2396

{

2397

"a_key": "", # Properties of the object. Contains field @type with type URL.

2398

},

2399

],

2400

"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.

2401

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2402

"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.

2403

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2404

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2405

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2406

"canonicalCode": "A String", # Canonical code of the condition.

2407

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2408

"message": "A String", # Human-friendly representation of the condition

2409

},

2410

],

2411

"operationType": "A String", # The operation type.

2412

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2413

"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}]

2414

{ # Progress metric is (string, int|float|string) pair.

2415

"doubleValue": 3.14, # For metrics with floating point value.

2416

"intValue": "A String", # For metrics with integer value.

2417

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2418

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2419

},

2420

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2421

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2422

"stages": [ # Substages of an operation or a stage.

2423

# Object with schema name: OperationProgress

2424

],

2425

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2426

},

2427

"selfLink": "A String", # Server-defined URL for the resource.

2428

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2429

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2430

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2431

"targetLink": "A String", # Server-defined URL for the target of the operation.

2432

"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.

2433

}</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]

2437

<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]

2438

<pre>Enables or disables Network Policy for a cluster.

2439

2440

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2441

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. (required)

2442

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2443

clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2444

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2445

The object takes the form of:

2446

2447

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2448

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

2449

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.

2450

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Required. Configuration options for the NetworkPolicy feature.

2451

"enabled": True or False, # Whether network policy is enabled on the cluster.

2452

"provider": "A String", # The selected network policy provider.

2453

},

2454

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.

2455

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

2456

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2457

2458

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2465

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2466

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2467

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2468

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2469

"canonicalCode": "A String", # Canonical code of the condition.

2470

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2471

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2472

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2473

],

2474

"detail": "A String", # Detailed operation progress, if available.

2475

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2476

"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.

2477

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2478

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2479

{

2480

"a_key": "", # Properties of the object. Contains field @type with type URL.

2481

},

2482

],

2483

"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.

2484

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2485

"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.

2486

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2487

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2488

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2489

"canonicalCode": "A String", # Canonical code of the condition.

2490

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2491

"message": "A String", # Human-friendly representation of the condition

2492

},

2493

],

2494

"operationType": "A String", # The operation type.

2495

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2496

"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}]

2497

{ # Progress metric is (string, int|float|string) pair.

2498

"doubleValue": 3.14, # For metrics with floating point value.

2499

"intValue": "A String", # For metrics with integer value.

2500

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2501

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2502

},

2503

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2504

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2505

"stages": [ # Substages of an operation or a stage.

2506

# Object with schema name: OperationProgress

2507

],

2508

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2509

},

2510

"selfLink": "A String", # Server-defined URL for the resource.

2511

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2512

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2513

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2514

"targetLink": "A String", # Server-defined URL for the target of the operation.

2515

"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.

2516

}</pre>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2520

<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]

2521

<pre>Starts master IP rotation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2522

2523

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2524

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. (required)

2525

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2526

clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2527

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2528

The object takes the form of:

2529

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2530

{ # 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]

2531

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

2532

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.

2533

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.

2534

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

2535

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

2536

}

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2537

2538

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2545

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2546

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2547

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2548

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2549

"canonicalCode": "A String", # Canonical code of the condition.

2550

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2551

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2552

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2553

],

2554

"detail": "A String", # Detailed operation progress, if available.

2555

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2556

"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.

2557

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2558

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2559

{

2560

"a_key": "", # Properties of the object. Contains field @type with type URL.

2561

},

2562

],

2563

"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.

2564

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2565

"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.

2566

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2567

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2568

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2569

"canonicalCode": "A String", # Canonical code of the condition.

2570

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2571

"message": "A String", # Human-friendly representation of the condition

2572

},

2573

],

2574

"operationType": "A String", # The operation type.

2575

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2576

"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}]

2577

{ # Progress metric is (string, int|float|string) pair.

2578

"doubleValue": 3.14, # For metrics with floating point value.

2579

"intValue": "A String", # For metrics with integer value.

2580

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2581

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2582

},

2583

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2584

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2585

"stages": [ # Substages of an operation or a stage.

2586

# Object with schema name: OperationProgress

2587

],

2588

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2589

},

2590

"selfLink": "A String", # Server-defined URL for the resource.

2591

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2592

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2593

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2594

"targetLink": "A String", # Server-defined URL for the target of the operation.

2595

"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.

2596

}</pre>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2600

<code class="details" id="update">update(projectId, zone, clusterId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2601

<pre>Updates the settings of a specific cluster.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2602

2603

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2604

projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. (required)

2605

zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)

2606

clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2607

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2608

The object takes the form of:

2609

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2610

{ # UpdateClusterRequest updates the settings of a cluster.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2611

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2612

"name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.

2613

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

2614

"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.

2615

"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.

2616

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.

2617

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2618

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

2619

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2620

"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

2621

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

2622

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2623

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

2624

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2625

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2626

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.

2627

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

2628

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2629

"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.

2630

"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]

2631

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2632

"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.

2633

"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]

2634

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2635

"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

2636

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2637

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2638

"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.

2639

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2640

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2641

},

2642

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

2643

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.

2644

},

2645

"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.

2646

"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]

2647

"A String",

2648

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2649

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

2650

"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

2651

"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]

2652

"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]

2653

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.

2654

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

2655

"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

2656

"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.

2657

"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.

2658

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

2659

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2660

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2661

"minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value.

2662

"oauthScopes": [ # Scopes that are used by NAP when creating node pools.

2663

"A String",

2664

],

2665

"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.

2666

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2667

"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.

2668

"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.

2669

},

2670

"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Specifies the upgrade settings for NAP created node pools

2671

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

2672

"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]

2673

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2674

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2675

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

2676

"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.

2677

{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.

2678

"maximum": "A String", # Maximum amount of the resource in the cluster.

2679

"minimum": "A String", # Minimum amount of the resource in the cluster.

2680

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2681

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2682

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2683

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2684

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2685

"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

2686

"state": "A String", # Denotes the state of etcd encryption.

2687

},

2688

"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.

2689

"disabled": True or False, # Disables cluster default sNAT rules.

2690

},

2691

"desiredImageType": "A String", # The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

2692

"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. # The desired config of Intra-node visibility.

2693

"enabled": True or False, # Enables intra node visibility for this cluster.

2694

},

2695

"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.

2696

"A String",

2697

],

2698

"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.

2699

"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.

2700

"cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.

2701

{ # CidrBlock contains an optional name and one CIDR block.

2702

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

2703

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

2704

},

2705

],

2706

"enabled": True or False, # Whether or not master authorized networks is enabled.

2707

},

2708

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version

2709

"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.

2710

"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.

2711

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2712

"enabled": True or False, # Is autoscaling enabled for this node pool.

2713

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

2714

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

2715

},

2716

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.

2717

"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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2718

"desiredNotificationConfig": { # NotificationConfig is the configuration of notifications. # The desired notification configuration.

2719

"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.

2720

"enabled": True or False, # Enable notifications for Pub/Sub.

2721

"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.

2722

},

2723

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2724

"desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration.

2725

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

2726

"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.

2727

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

2728

"enabled": True or False, # Whenever master is accessible globally or not.

2729

},

2730

"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.

2731

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

2732

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

2733

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

2734

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2735

"desiredPrivateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2736

"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.

2737

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

2738

},

2739

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

2740

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2741

"datasetId": "A String", # The ID of a BigQuery Dataset.

2742

},

2743

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

2744

"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.

2745

},

2746

"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.

2747

},

2748

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

2749

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

2750

},

2751

"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.

2752

"enabled": True or False, # Enables vertical pod autoscaling.

2753

},

2754

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity.

2755

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

2756

},

2757

},

2758

"zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

2759

}

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2760

2761

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2762

Allowed values

2763

1 - v1 error format

2764

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2765

2766

Returns:

2767

An object of the form:

2768

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2769

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2770

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2771

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2772

"canonicalCode": "A String", # Canonical code of the condition.

2773

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2774

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2775

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2776

],

2777

"detail": "A String", # Detailed operation progress, if available.

2778

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2779

"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.

2780

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2781

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2782

{

2783

"a_key": "", # Properties of the object. Contains field @type with type URL.

2784

},

2785

],

2786

"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.

2787

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2788

"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.

2789

"name": "A String", # The server-assigned ID for the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2790

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2791

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2792

"canonicalCode": "A String", # Canonical code of the condition.

2793

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2794

"message": "A String", # Human-friendly representation of the condition

2795

},

2796

],

2797

"operationType": "A String", # The operation type.

2798

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

2799

"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}]

2800

{ # Progress metric is (string, int|float|string) pair.

2801

"doubleValue": 3.14, # For metrics with floating point value.

2802

"intValue": "A String", # For metrics with integer value.

2803

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2804

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2805

},

2806

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2807

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2808

"stages": [ # Substages of an operation or a stage.

2809

# Object with schema name: OperationProgress

2810

],

2811

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

2812

},

2813

"selfLink": "A String", # Server-defined URL for the resource.

2814

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2815

"status": "A String", # The current status of the operation.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2816

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2817

"targetLink": "A String", # Server-defined URL for the target of the operation.

2818

"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.

2819

}</pre>

Takashi Matsuo