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

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

[diff] [blame]

83

<code><a href="container_v1beta1.projects.locations.clusters.well_known.html">well_known()</a></code>

Bu Sun Kim

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

[diff] [blame]

84

</p>

Dan O'Meara

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

[diff] [blame]

85

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

Bu Sun Kim

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

[diff] [blame]

86

87

Dmitry Frenkel

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

[diff] [blame]

88

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

89

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

90

Dan O'Meara

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

[diff] [blame]

91

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

Bu Sun Kim

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

[diff] [blame]

92

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

93

Dan O'Meara

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

[diff] [blame]

94

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

Dmitry Frenkel

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

[diff] [blame]

95

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

Bu Sun Kim

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

[diff] [blame]

96

Bu Sun Kim

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

[diff] [blame]

97

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

Dmitry Frenkel

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

[diff] [blame]

98

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

Bu Sun Kim

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

[diff] [blame]

99

Yoshi Automation Bot

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

[diff] [blame^]

100

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

Bu Sun Kim

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

[diff] [blame]

101

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

102

103

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

Dmitry Frenkel

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

[diff] [blame]

104

<p class="firstline">Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.</p>

Bu Sun Kim

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

[diff] [blame]

105

Bu Sun Kim

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

[diff] [blame]

106

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

Dmitry Frenkel

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

[diff] [blame]

107

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

Bu Sun Kim

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

[diff] [blame]

108

Dan O'Meara

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

[diff] [blame]

109

<code><a href="#setAddons">setAddons(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

110

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

111

Dan O'Meara

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

[diff] [blame]

112

<code><a href="#setLegacyAbac">setLegacyAbac(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

113

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

114

Dan O'Meara

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

[diff] [blame]

115

<code><a href="#setLocations">setLocations(name, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

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

[diff] [blame]

116

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

Bu Sun Kim

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

[diff] [blame]

117

Dan O'Meara

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

[diff] [blame]

118

<code><a href="#setLogging">setLogging(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

119

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

120

Dan O'Meara

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

[diff] [blame]

121

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

Bu Sun Kim

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

[diff] [blame]

122

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

123

Dan O'Meara

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

[diff] [blame]

124

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

Dmitry Frenkel

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

[diff] [blame]

125

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

126

Dan O'Meara

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

[diff] [blame]

127

<code><a href="#setMonitoring">setMonitoring(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

128

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

129

Dan O'Meara

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

[diff] [blame]

130

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

Bu Sun Kim

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

[diff] [blame]

131

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

132

Dan O'Meara

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

[diff] [blame]

133

<code><a href="#setResourceLabels">setResourceLabels(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

134

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

135

Dan O'Meara

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

[diff] [blame]

136

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

Bu Sun Kim

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

[diff] [blame]

137

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

138

Dan O'Meara

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

[diff] [blame]

139

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

Bu Sun Kim

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

[diff] [blame]

140

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

141

Dan O'Meara

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

[diff] [blame]

142

<code><a href="#updateMaster">updateMaster(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

143

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

144

<h3>Method Details</h3>

145

Dmitry Frenkel

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

[diff] [blame]

146

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

147

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

151

<code class="details" id="completeIpRotation">completeIpRotation(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

152

<pre>Completes master IP rotation.

153

154

Args:

Dmitry Frenkel

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

[diff] [blame]

155

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

Dan O'Meara

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

[diff] [blame]

156

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

157

The object takes the form of:

158

159

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

Dmitry Frenkel

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

[diff] [blame]

160

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

Bu Sun Kim

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

[diff] [blame]

161

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

Yoshi Automation Bot

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

[diff] [blame^]

162

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

163

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

Bu Sun Kim

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

[diff] [blame]

164

}

165

166

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

173

Dmitry Frenkel

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

[diff] [blame]

174

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

175

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

Yoshi Automation Bot

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

[diff] [blame^]

176

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

Bu Sun Kim

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

[diff] [blame]

177

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

Yoshi Automation Bot

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

[diff] [blame^]

178

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

179

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

Bu Sun Kim

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

[diff] [blame]

180

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

Bu Sun Kim

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

[diff] [blame]

181

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

182

# Object with schema name: OperationProgress

183

],

Yoshi Automation Bot

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

[diff] [blame^]

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

},

192

],

193

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

Bu Sun Kim

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

[diff] [blame]

194

},

Dmitry Frenkel

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

[diff] [blame]

195

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

196

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

Dmitry Frenkel

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

[diff] [blame]

197

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

Bu Sun Kim

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

[diff] [blame]

198

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

Yoshi Automation Bot

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

[diff] [blame^]

199

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

Bu Sun Kim

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

[diff] [blame]

200

},

201

],

Yoshi Automation Bot

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

[diff] [blame^]

202

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

203

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

Dmitry Frenkel

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

[diff] [blame]

204

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

Bu Sun Kim

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

[diff] [blame]

205

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

206

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

Dmitry Frenkel

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

[diff] [blame]

207

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

208

{

209

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

210

},

211

],

Dmitry Frenkel

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

[diff] [blame]

212

},

Yoshi Automation Bot

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

[diff] [blame^]

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

},

223

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

228

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

Dmitry Frenkel

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

[diff] [blame]

229

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

Bu Sun Kim

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

[diff] [blame]

230

231

Args:

Dmitry Frenkel

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

[diff] [blame]

232

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

Dan O'Meara

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

[diff] [blame]

233

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

234

The object takes the form of:

235

236

{ # CreateClusterRequest creates a cluster.

Bu Sun Kim

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

[diff] [blame]

237

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

Dmitry Frenkel

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

[diff] [blame]

238

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

Yoshi Automation Bot

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

[diff] [blame^]

239

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

Bu Sun Kim

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

[diff] [blame]

240

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

Yoshi Automation Bot

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

[diff] [blame^]

241

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

242

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

243

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

Bu Sun Kim

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

[diff] [blame]

244

},

Yoshi Automation Bot

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

[diff] [blame^]

245

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

246

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

247

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

248

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

249

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

250

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

Bu Sun Kim

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

[diff] [blame]

251

},

Yoshi Automation Bot

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

[diff] [blame^]

252

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

Bu Sun Kim

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

[diff] [blame]

253

},

Yoshi Automation Bot

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

[diff] [blame^]

254

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

255

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

256

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

257

},

258

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

259

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

260

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

Bu Sun Kim

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

[diff] [blame]

261

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

Bu Sun Kim

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

[diff] [blame]

262

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

263

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

264

},

265

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

266

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

267

},

Yoshi Automation Bot

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

[diff] [blame^]

268

"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

269

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

270

},

271

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

272

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

273

},

274

"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

275

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

276

},

277

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

278

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

279

},

280

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

281

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

282

},

Bu Sun Kim

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

[diff] [blame]

283

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

284

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

285

},

Yoshi Automation Bot

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

[diff] [blame^]

286

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

287

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

288

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

289

},

290

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

291

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

292

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

293

},

294

},

295

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

296

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

297

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

298

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

299

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

300

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

301

},

302

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

303

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

304

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

305

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

306

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

307

},

308

],

309

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

310

"A String",

311

],

312

"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

313

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

314

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

315

"a_key": "A String",

316

},

317

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

318

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

319

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

320

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

321

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

322

},

323

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

324

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

325

"A String",

326

],

327

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

328

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

329

},

330

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

331

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

332

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

333

},

334

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

335

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

336

"a_key": "A String",

337

},

338

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

339

{ # AcceleratorConfig represents a Hardware Accelerator request.

340

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

341

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

342

},

343

],

344

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

345

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

346

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

347

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

348

"A String",

349

],

350

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

351

},

352

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

353

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

354

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

355

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

356

},

357

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

358

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

"a_key": "A String",

},

},

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

363

},

364

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

365

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

366

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

367

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

368

},

369

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

370

"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

371

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

372

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

373

"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

374

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

375

},

376

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

377

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

378

},

379

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

380

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

381

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

382

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

383

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

384

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

385

},

386

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

387

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

388

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

389

"A String",

390

],

391

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

392

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

393

"clusterCaCertificate": "A String",

394

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

395

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

396

},

397

"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

398

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

399

"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

400

},

401

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

402

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

403

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

404

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

405

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

406

"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

407

"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

408

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

409

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

410

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

411

},

Bu Sun Kim

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

[diff] [blame]

412

},

413

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

414

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

415

},

Yoshi Automation Bot

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

[diff] [blame^]

416

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

417

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

418

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

Bu Sun Kim

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

[diff] [blame]

419

},

Yoshi Automation Bot

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

[diff] [blame^]

420

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

421

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

422

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

423

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

Bu Sun Kim

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

[diff] [blame]

424

},

Yoshi Automation Bot

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

[diff] [blame^]

425

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

426

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

427

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

428

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

429

},

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

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

439

},

440

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

441

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

442

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

443

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

444

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

445

},

446

],

447

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

448

"A String",

449

],

450

"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

451

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

452

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

453

"a_key": "A String",

454

},

455

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

456

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

457

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

458

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

459

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

460

},

461

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

462

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

463

"A String",

464

],

465

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

466

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

467

},

468

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

469

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

470

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

471

},

472

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

473

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

474

"a_key": "A String",

475

},

476

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

477

{ # AcceleratorConfig represents a Hardware Accelerator request.

478

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

479

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

480

},

481

],

482

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

483

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

484

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

485

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

486

"A String",

487

],

488

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

489

},

490

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

491

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

492

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

493

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

494

},

495

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

496

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

"a_key": "A String",

},

},

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

Bu Sun Kim

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

[diff] [blame]

501

},

Yoshi Automation Bot

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

[diff] [blame^]

502

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

503

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

504

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

505

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

506

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

507

},

508

],

509

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

510

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

511

"A String",

512

],

513

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

514

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

515

"A String",

516

],

517

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

518

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

519

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

520

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

521

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

522

},

523

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

524

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

525

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

526

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

527

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

528

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

529

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

530

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

531

},

532

},

533

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

534

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

535

},

536

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

537

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

538

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

539

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

540

},

541

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

542

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

543

},

544

],

545

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

546

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

547

},

548

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

549

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

550

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

551

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

552

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

553

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

554

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

555

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

556

},

557

],

558

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

559

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

560

"A String",

561

],

562

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

563

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

564

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

565

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

566

},

567

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

568

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

569

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

570

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

571

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

572

},

573

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

574

"A String",

575

],

576

"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

577

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

578

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

579

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

580

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

581

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

582

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

583

},

584

},

585

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

586

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

587

},

588

},

589

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

590

"a_key": "A String",

591

},

592

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

593

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

594

},

595

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

596

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

597

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

598

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

Bu Sun Kim

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

[diff] [blame]

599

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

600

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

601

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

602

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

603

},

604

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

605

},

606

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

607

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

608

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

609

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

610

},

611

},

Yoshi Automation Bot

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

[diff] [blame^]

612

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

613

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

614

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

615

},

616

},

617

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

618

},

619

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

620

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

621

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

622

},

623

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

624

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

625

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

626

},

627

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

628

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

629

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

630

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

Bu Sun Kim

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

[diff] [blame]

631

},

632

},

Yoshi Automation Bot

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

[diff] [blame^]

633

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

634

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

635

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

636

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

637

"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

638

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

639

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

640

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

641

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

642

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

643

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

644

"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

645

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

646

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

647

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

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

[diff] [blame]

648

},

Dmitry Frenkel

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

[diff] [blame]

649

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

650

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

Bu Sun Kim

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

[diff] [blame]

651

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

Dmitry Frenkel

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

[diff] [blame]

652

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

Yoshi Automation Bot

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

[diff] [blame^]

653

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

Bu Sun Kim

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

[diff] [blame]

654

},

655

],

656

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

657

},

Bu Sun Kim

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

[diff] [blame]

658

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

Bu Sun Kim

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

[diff] [blame]

659

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

660

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

661

},

Yoshi Automation Bot

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

[diff] [blame^]

662

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

663

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

664

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

665

},

Bu Sun Kim

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

[diff] [blame]

666

},

Yoshi Automation Bot

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

[diff] [blame^]

667

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

668

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

669

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

670

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

671

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

672

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

673

},

674

],

675

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

676

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

677

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

Dmitry Frenkel

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

[diff] [blame]

678

},

Yoshi Automation Bot

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

[diff] [blame^]

679

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

680

"A String",

681

],

682

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

Bu Sun Kim

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

[diff] [blame]

683

},

Yoshi Automation Bot

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

[diff] [blame^]

684

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

685

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

Bu Sun Kim

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

[diff] [blame]

686

}

687

688

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

695

Dmitry Frenkel

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

[diff] [blame]

696

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

697

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

Yoshi Automation Bot

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

[diff] [blame^]

698

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

Bu Sun Kim

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

[diff] [blame]

699

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

Yoshi Automation Bot

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

[diff] [blame^]

700

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

701

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

Bu Sun Kim

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

[diff] [blame]

702

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

Bu Sun Kim

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

[diff] [blame]

703

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

704

# Object with schema name: OperationProgress

705

],

Yoshi Automation Bot

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

[diff] [blame^]

706

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

707

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

708

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

709

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

710

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

711

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

712

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

713

},

714

],

715

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

Bu Sun Kim

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

[diff] [blame]

716

},

Dmitry Frenkel

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

[diff] [blame]

717

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

718

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

Dmitry Frenkel

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

[diff] [blame]

719

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

Bu Sun Kim

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

[diff] [blame]

720

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

Yoshi Automation Bot

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

[diff] [blame^]

721

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

Bu Sun Kim

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

[diff] [blame]

722

},

723

],

Yoshi Automation Bot

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

[diff] [blame^]

724

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

725

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

Dmitry Frenkel

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

[diff] [blame]

726

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

Bu Sun Kim

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

[diff] [blame]

727

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

728

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

Dmitry Frenkel

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

[diff] [blame]

729

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

730

{

731

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

732

},

733

],

Dmitry Frenkel

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

[diff] [blame]

734

},

Yoshi Automation Bot

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

[diff] [blame^]

735

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

736

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

737

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

738

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

739

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

740

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

741

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

742

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

743

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

744

},

745

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

750

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

Dmitry Frenkel

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

[diff] [blame]

751

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

Bu Sun Kim

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

[diff] [blame]

752

753

Args:

Dmitry Frenkel

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

[diff] [blame]

754

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

Dmitry Frenkel

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

[diff] [blame]

755

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

756

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

Bu Sun Kim

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

[diff] [blame]

757

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

Bu Sun Kim

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

[diff] [blame]

758

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

765

Dmitry Frenkel

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

[diff] [blame]

766

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

767

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

Yoshi Automation Bot

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

[diff] [blame^]

768

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

Bu Sun Kim

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

[diff] [blame]

769

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

Yoshi Automation Bot

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

[diff] [blame^]

770

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

771

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

Bu Sun Kim

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

[diff] [blame]

772

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

Bu Sun Kim

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

[diff] [blame]

773

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

774

# Object with schema name: OperationProgress

775

],

Yoshi Automation Bot

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

[diff] [blame^]

776

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

777

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

778

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

779

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

780

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

781

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

782

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

783

},

784

],

785

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

Bu Sun Kim

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

[diff] [blame]

786

},

Dmitry Frenkel

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

[diff] [blame]

787

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

788

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

Dmitry Frenkel

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

[diff] [blame]

789

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

Bu Sun Kim

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

[diff] [blame]

790

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

Yoshi Automation Bot

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

[diff] [blame^]

791

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

Bu Sun Kim

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

[diff] [blame]

792

},

793

],

Yoshi Automation Bot

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

[diff] [blame^]

794

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

795

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

Dmitry Frenkel

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

[diff] [blame]

796

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

Bu Sun Kim

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

[diff] [blame]

797

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

798

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

Dmitry Frenkel

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

[diff] [blame]

799

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

800

{

801

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

802

},

803

],

Dmitry Frenkel

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

[diff] [blame]

804

},

Yoshi Automation Bot

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

[diff] [blame^]

805

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

806

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

807

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

808

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

809

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

810

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

811

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

812

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

813

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

814

},

815

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

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

[diff] [blame^]

820

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

Bu Sun Kim

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

[diff] [blame]

821

<pre>Gets the details for a specific cluster.

822

823

Args:

Dmitry Frenkel

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

[diff] [blame]

824

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

825

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

Bu Sun Kim

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

[diff] [blame]

826

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

Yoshi Automation Bot

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

[diff] [blame^]

827

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

Bu Sun Kim

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

[diff] [blame]

828

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

835

836

{ # A Google Kubernetes Engine cluster.

Yoshi Automation Bot

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

[diff] [blame^]

837

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

Bu Sun Kim

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

[diff] [blame]

838

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

Yoshi Automation Bot

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

[diff] [blame^]

839

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

840

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

841

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

Bu Sun Kim

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

[diff] [blame]

842

},

Yoshi Automation Bot

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

[diff] [blame^]

843

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

844

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

845

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

846

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

847

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

848

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

Bu Sun Kim

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

[diff] [blame]

849

},

Yoshi Automation Bot

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

[diff] [blame^]

850

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

Bu Sun Kim

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

[diff] [blame]

851

},

Yoshi Automation Bot

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

[diff] [blame^]

852

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

853

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

854

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

855

},

856

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

857

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

858

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

Bu Sun Kim

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

[diff] [blame]

859

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

Bu Sun Kim

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

[diff] [blame]

860

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

861

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

862

},

863

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

864

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

865

},

Yoshi Automation Bot

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

[diff] [blame^]

866

"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

867

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

868

},

869

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

870

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

871

},

872

"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

873

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

874

},

875

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

876

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

877

},

878

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

879

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

880

},

Bu Sun Kim

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

[diff] [blame]

881

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

882

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

883

},

Yoshi Automation Bot

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

[diff] [blame^]

884

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

885

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

886

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

887

},

888

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

889

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

890

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

891

},

892

},

893

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

894

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

895

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

896

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

897

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

898

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

899

},

900

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

901

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

902

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

903

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

904

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

905

},

906

],

907

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

908

"A String",

909

],

910

"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

911

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

912

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

913

"a_key": "A String",

914

},

915

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

916

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

917

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

918

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

919

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

920

},

921

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

922

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

923

"A String",

924

],

925

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

926

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

927

},

928

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

929

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

930

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

931

},

932

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

933

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

934

"a_key": "A String",

935

},

936

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

937

{ # AcceleratorConfig represents a Hardware Accelerator request.

938

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

939

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

940

},

941

],

942

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

943

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

944

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

945

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

946

"A String",

947

],

948

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

949

},

950

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

951

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

952

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

953

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

954

},

955

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

956

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

"a_key": "A String",

},

},

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

961

},

962

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

963

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

964

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

965

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

966

},

967

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

968

"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

969

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

970

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

971

"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

972

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

973

},

974

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

975

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

976

},

977

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

978

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

979

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

980

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

981

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

982

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

983

},

984

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

985

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

986

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

987

"A String",

988

],

989

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

990

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

991

"clusterCaCertificate": "A String",

992

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

993

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

994

},

995

"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

996

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

997

"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

998

},

999

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

1000

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

1001

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

1002

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

1003

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

1004

"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

1005

"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

1006

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

1007

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

1008

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

1009

},

Bu Sun Kim

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

[diff] [blame]

1010

},

1011

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

1012

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

1013

},

Yoshi Automation Bot

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

[diff] [blame^]

1014

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

1015

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

1016

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

Bu Sun Kim

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

[diff] [blame]

1017

},

Yoshi Automation Bot

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

[diff] [blame^]

1018

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

1019

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

1020

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

1021

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

Bu Sun Kim

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

[diff] [blame]

1022

},

Yoshi Automation Bot

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

[diff] [blame^]

1023

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

1024

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

1025

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

1026

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

1027

},

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

},

1038

"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/

1039

{ # 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.

1040

"effect": "A String", # Effect for taint.

1041

"value": "A String", # Value for taint.

1042

"key": "A String", # Key for taint.

1043

},

1044

],

1045

"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.

1046

"A String",

1047

],

1048

"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

1049

"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`.

1050

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

1051

"a_key": "A String",

1052

},

1053

"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.

1054

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'

1055

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1056

"type": "A String", # Type of the sandbox to use for the node.

1057

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

1058

},

1059

"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)

1060

"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.

1061

"A String",

1062

],

1063

"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

1064

"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.

1065

},

1066

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.

1067

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.

1068

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.

1069

},

1070

"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.

1071

"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/

1072

"a_key": "A String",

1073

},

1074

"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.

1075

{ # AcceleratorConfig represents a Hardware Accelerator request.

1076

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

1077

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1078

},

1079

],

1080

"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.

1081

"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.

1082

"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.

1083

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1084

"A String",

1085

],

1086

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1087

},

1088

"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.

1089

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1090

"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.

1091

"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.

1092

},

1093

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1094

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

"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).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1099

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1100

"conditions": [ # Which conditions caused the current node pool state.

1101

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1102

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1103

"message": "A String", # Human-friendly representation of the condition

1104

"canonicalCode": "A String", # Canonical code of the condition.

1105

},

1106

],

1107

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

1108

"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.

1109

"A String",

1110

],

1111

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1112

"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.

1113

"A String",

1114

],

1115

"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.

1116

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

1117

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

1118

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

1119

"enabled": True or False, # Is autoscaling enabled for this node pool.

1120

},

1121

"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.

1122

"version": "A String", # The version of the Kubernetes of this node.

1123

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.

1124

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

1125

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

1126

"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.

1127

"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.

1128

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

1129

},

1130

},

1131

"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.

1132

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1133

},

1134

"name": "A String", # The name of the node pool.

1135

"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.

1136

"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.

1137

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1138

},

1139

"status": "A String", # [Output only] The status of the nodes in this pool instance.

1140

"statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.

1141

},

1142

],

1143

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

1144

"type": "A String", # Type of the integration.

1145

},

1146

"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.

1147

"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.

1148

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

1149

"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.

1150

{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.

1151

"minimum": "A String", # Minimum amount of the resource in the cluster.

1152

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

1153

"maximum": "A String", # Maximum amount of the resource in the cluster.

1154

},

1155

],

1156

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

1157

"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.

1158

"A String",

1159

],

1160

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

1161

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1162

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

1163

"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.

1164

},

1165

"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.

1166

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value.

1167

"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.

1168

"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.

1169

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1170

},

1171

"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.

1172

"A String",

1173

],

1174

"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

1175

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.

1176

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

1177

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

1178

"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.

1179

"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.

1180

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

1181

},

1182

},

1183

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'

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.

1185

},

1186

},

1187

"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

1188

"a_key": "A String",

1189

},

1190

"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.

1191

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1192

},

1193

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.

1194

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

1195

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

1196

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1197

"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.

1198

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

1199

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

1200

"startTime": "A String", # The time that the window first starts.

1201

},

1202

"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.

1203

},

1204

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

1205

"a_key": { # Represents an arbitrary window of time.

1206

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

1207

"startTime": "A String", # The time that the window first starts.

1208

},

1209

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1210

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1211

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

1212

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

1213

},

1214

},

1215

"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.

1216

},

1217

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

1218

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true.

1219

"enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.

1220

},

1221

"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.

1222

"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.

1223

"enabled": True or False, # Enables vertical pod autoscaling.

1224

},

1225

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.

1226

"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.

1227

"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.

1228

"enabled": True or False, # Enable notifications for Pub/Sub.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1229

},

1230

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1231

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

1232

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.

1233

"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.

1234

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false.

1235

"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

1236

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false.

1237

"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.

1238

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

1239

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1240

"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.

1241

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

1242

"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

1243

"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.

1244

"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.

1245

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1246

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1247

"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.

1248

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1249

{ # CidrBlock contains an optional name and one CIDR block.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1250

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1251

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1252

},

1253

],

1254

"enabled": True or False, # Whether or not master authorized networks is enabled.

1255

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1256

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1257

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

1258

"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.

1259

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1260

"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.

1261

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

1262

"datasetId": "A String", # The ID of a BigQuery Dataset.

1263

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1264

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1265

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.

1266

"conditions": [ # Which conditions caused the current cluster state.

1267

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1268

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1269

"message": "A String", # Human-friendly representation of the condition

1270

"canonicalCode": "A String", # Canonical code of the condition.

1271

},

1272

],

1273

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.

1274

"provider": "A String", # The selected network policy provider.

1275

"enabled": True or False, # Whether network policy is enabled on the cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1276

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1277

"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.

1278

"A String",

1279

],

1280

"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`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="getJwks">getJwks(parent, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1286

<pre>Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1287

1288

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1289

parent: string, The cluster (project, location, cluster id) to get keys for. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1290

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1297

1298

{ # GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1299

"cacheHeader": { # RFC-2616: cache control support # OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1300

"expires": "A String", # 14.21 response cache expires, in RFC 1123 date format

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1301

"directive": "A String", # 14.9 request and response directives

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1302

"age": "A String", # 14.6 response cache age, in seconds since the response is generated

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1303

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1304

"keys": [ # The public component of the keys used by the cluster to sign token requests.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1305

{ # Jwk is a JSON Web Key as specified in RFC 7517

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1306

"x": "A String", # Used for ECDSA keys.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1307

"y": "A String", # Used for ECDSA keys.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1308

"kty": "A String", # Key Type.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1309

"crv": "A String", # Used for ECDSA keys.

1310

"use": "A String", # Permitted uses for the public keys.

1311

"alg": "A String", # Algorithm.

1312

"n": "A String", # Used for RSA keys.

1313

"kid": "A String", # Key ID.

1314

"e": "A String", # Used for RSA keys.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

},

],

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1321

<code class="details" id="list">list(parent, zone=None, projectId=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1322

<pre>Lists all clusters owned by a project in either the specified zone or all zones.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1323

1324

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1325

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. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1326

zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1327

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1328

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1335

1336

{ # ListClustersResponse is the result of ListClustersRequest.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1337

"clusters": [ # A list of clusters in the project in the specified zone, or across all ones.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1338

{ # A Google Kubernetes Engine cluster.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1339

"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1340

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1341

"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.

1342

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

1343

"enabled": True or False, # Whenever master is accessible globally or not.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1344

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1345

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

1346

"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.

1347

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

1348

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

1349

"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.

1350

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1351

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1352

"master": { # Master is the configuration for components on master. # Configuration for master components.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1353

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1354

"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.

1355

"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.

1356

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binauthz.

1357

},

1358

"status": "A String", # [Output only] The current status of this cluster.

1359

"createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1360

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1361

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1362

"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.

1363

"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.

1364

},

1365

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

1366

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

1367

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1368

"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

1369

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

1370

},

1371

"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.

1372

"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.

1373

},

1374

"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

1375

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

1376

},

1377

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be enabled at cluster creation time. # Configuration for the Compute Engine Persistent Disk CSI driver.

1378

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

1379

},

1380

"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.

1381

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1382

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1383

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.

1384

"enabled": True or False, # Whether KALM is enabled for this cluster.

1385

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1386

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure microservices.

1387

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

1388

"disabled": True or False, # Whether Istio is enabled for this cluster.

1389

},

1390

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.

1391

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

1392

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1393

},

1394

},

1395

"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.

1396

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.

1397

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1398

"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.

1399

"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.

1400

"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.

1401

},

1402

"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/

1403

{ # 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.

1404

"effect": "A String", # Effect for taint.

1405

"value": "A String", # Value for taint.

1406

"key": "A String", # Key for taint.

1407

},

1408

],

1409

"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.

1410

"A String",

1411

],

1412

"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

1413

"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`.

1414

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

1415

"a_key": "A String",

1416

},

1417

"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.

1418

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'

1419

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1420

"type": "A String", # Type of the sandbox to use for the node.

1421

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

1422

},

1423

"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)

1424

"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.

1425

"A String",

1426

],

1427

"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

1428

"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.

1429

},

1430

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.

1431

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.

1432

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.

1433

},

1434

"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.

1435

"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/

1436

"a_key": "A String",

1437

},

1438

"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.

1439

{ # AcceleratorConfig represents a Hardware Accelerator request.

1440

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

1441

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1442

},

1443

],

1444

"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.

1445

"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.

1446

"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.

1447

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1448

"A String",

1449

],

1450

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1451

},

1452

"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.

1453

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1454

"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.

1455

"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.

1456

},

1457

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1458

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

"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).

1463

},

1464

"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.

1465

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

1466

"identityProvider": "A String", # identity provider is the third party identity provider.

1467

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

1468

},

1469

"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.

1470

"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

1471

"expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1472

"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

1473

"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

1474

"state": "A String", # Denotes the state of etcd encryption.

1475

},

1476

"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Configuration of Confidential Nodes

1477

"enabled": True or False, # Whether Confidential Nodes feature is enabled for all nodes in this cluster.

1478

},

1479

"statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.

1480

"currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

1481

"currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.

1482

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.

1483

"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.

1484

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

1485

},

1486

"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.

1487

"currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

1488

"instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.

1489

"A String",

1490

],

1491

"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.

1492

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

1493

"clusterCaCertificate": "A String",

1494

"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.

1495

"issueClientCertificate": True or False, # Issue a client certificate.

1496

},

1497

"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

1498

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

1499

"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

1500

},

1501

"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.

1502

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1503

"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.

1504

"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.

1505

"datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.

1506

"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

1507

"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

1508

"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.

1509

"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.

1510

"disabled": True or False, # Disables cluster default sNAT rules.

1511

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1512

},

1513

"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.

1514

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

1515

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1516

"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`).

1517

"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.

1518

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1519

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1520

"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;

1521

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

1522

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

1523

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1524

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1525

"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.

1526

"description": "A String", # An optional description of this cluster.

1527

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.

1528

"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.

1529

},

1530

"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.

1531

"nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

1532

{ # 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.

1533

"config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.

1534

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.

1535

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.

1536

"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.

1537

"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.

1538

"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.

1539

},

1540

"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/

1541

{ # 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.

1542

"effect": "A String", # Effect for taint.

1543

"value": "A String", # Value for taint.

1544

"key": "A String", # Key for taint.

1545

},

1546

],

1547

"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.

1548

"A String",

1549

],

1550

"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

1551

"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`.

1552

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are reserved for Windows nodes: - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

1553

"a_key": "A String",

1554

},

1555

"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.

1556

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'

1557

"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.

1558

"type": "A String", # Type of the sandbox to use for the node.

1559

"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')

1560

},

1561

"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)

1562

"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.

1563

"A String",

1564

],

1565

"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

1566

"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.

1567

},

1568

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.

1569

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.

1570

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.

1571

},

1572

"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

1573

"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/

1574

"a_key": "A String",

1575

},

1576

"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.

1577

{ # AcceleratorConfig represents a Hardware Accelerator request.

1578

"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)

1579

"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.

1580

},

1581

],

1582

"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.

1583

"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.

1584

"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.

1585

"values": [ # Corresponds to the label value(s) of reservation resource(s).

1586

"A String",

1587

],

1588

"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.

1589

},

1590

"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.

1591

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1592

"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.

1593

"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.

1594

},

1595

"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.

1596

"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

"a_key": "A String",

},

},

"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).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1601

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1602

"conditions": [ # Which conditions caused the current node pool state.

1603

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1604

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1605

"message": "A String", # Human-friendly representation of the condition

1606

"canonicalCode": "A String", # Canonical code of the condition.

1607

},

1608

],

1609

"podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.

1610

"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.

1611

"A String",

1612

],

1613

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

1614

"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.

1615

"A String",

1616

],

1617

"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.

1618

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

1619

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

1620

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

1621

"enabled": True or False, # Is autoscaling enabled for this node pool.

1622

},

1623

"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.

1624

"version": "A String", # The version of the Kubernetes of this node.

1625

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.

1626

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

1627

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

1628

"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.

1629

"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.

1630

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

1631

},

1632

},

1633

"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.

1634

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1635

},

1636

"name": "A String", # The name of the node pool.

1637

"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.

1638

"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.

1639

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1640

},

1641

"status": "A String", # [Output only] The status of the nodes in this pool instance.

1642

"statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.

1643

},

1644

],

1645

"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.

1646

"type": "A String", # Type of the integration.

1647

},

1648

"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.

1649

"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.

1650

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

1651

"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.

1652

{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.

1653

"minimum": "A String", # Minimum amount of the resource in the cluster.

1654

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

1655

"maximum": "A String", # Maximum amount of the resource in the cluster.

1656

},

1657

],

1658

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

1659

"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.

1660

"A String",

1661

],

1662

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

1663

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

1664

"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.

1665

"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.

1666

},

1667

"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.

1668

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value.

1669

"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.

1670

"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.

1671

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

1672

},

1673

"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.

1674

"A String",

1675

],

1676

"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

1677

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.

1678

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

1679

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

1680

"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.

1681

"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.

1682

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

1683

},

1684

},

1685

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'

1686

"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.

1687

},

1688

},

1689

"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

1690

"a_key": "A String",

1691

},

1692

"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.

1693

"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.

1694

},

1695

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.

1696

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

1697

"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.

1698

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1699

"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.

1700

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

1701

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

1702

"startTime": "A String", # The time that the window first starts.

1703

},

1704

"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.

1705

},

1706

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

1707

"a_key": { # Represents an arbitrary window of time.

1708

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

1709

"startTime": "A String", # The time that the window first starts.

1710

},

1711

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1712

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

1713

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

1714

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

1715

},

1716

},

1717

"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.

1718

},

1719

"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.

1720

"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true.

1721

"enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.

1722

},

1723

"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.

1724

"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.

1725

"enabled": True or False, # Enables vertical pod autoscaling.

1726

},

1727

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.

1728

"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.

1729

"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.

1730

"enabled": True or False, # Enable notifications for Pub/Sub.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1731

},

1732

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1733

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.

1734

"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.

1735

"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.

1736

"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false.

1737

"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

1738

"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false.

1739

"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.

1740

"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.

1741

"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.

1742

"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.

1743

"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.

1744

"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

1745

"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.

1746

"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.

1747

"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1748

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1749

"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.

1750

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1751

{ # CidrBlock contains an optional name and one CIDR block.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1752

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1753

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1754

},

1755

],

1756

"enabled": True or False, # Whether or not master authorized networks is enabled.

1757

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1758

"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1759

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

1760

"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.

1761

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1762

"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.

1763

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

1764

"datasetId": "A String", # The ID of a BigQuery Dataset.

1765

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1766

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1767

"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.

1768

"conditions": [ # Which conditions caused the current cluster state.

1769

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1770

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1771

"message": "A String", # Human-friendly representation of the condition

1772

"canonicalCode": "A String", # Canonical code of the condition.

1773

},

1774

],

1775

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.

1776

"provider": "A String", # The selected network policy provider.

1777

"enabled": True or False, # Whether network policy is enabled on the cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1778

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1779

"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.

1780

"A String",

1781

],

1782

"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`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1783

},

1784

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1785

"missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.

1786

"A String",

1787

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1792

<code class="details" id="setAddons">setAddons(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1793

<pre>Sets the addons for a specific cluster.

1794

1795

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1796

name: string, The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1797

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1798

The object takes the form of:

1799

1800

{ # SetAddonsRequest sets the addons associated with the cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1801

"addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Required. The desired configurations for the various addons available to run in the cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1802

"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.

1803

"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.

1804

},

1805

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

1806

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

1807

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1808

"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

1809

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

1810

},

1811

"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.

1812

"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.

1813

},

1814

"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

1815

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

1816

},

1817

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be enabled at cluster creation time. # Configuration for the Compute Engine Persistent Disk CSI driver.

1818

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

1819

},

1820

"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.

1821

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

1822

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1823

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.

1824

"enabled": True or False, # Whether KALM is enabled for this cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1825

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1826

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure microservices.

1827

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

1828

"disabled": True or False, # Whether Istio is enabled for this cluster.

1829

},

1830

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.

1831

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

1832

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

1833

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1834

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1835

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1836

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

1837

"name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`.

1838

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1839

}

1840

1841

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1848

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1849

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

1850

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1851

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1852

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1853

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1854

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1855

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1856

"stages": [ # Substages of an operation or a stage.

1857

# Object with schema name: OperationProgress

1858

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1859

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

1860

"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}]

1861

{ # Progress metric is (string, int|float|string) pair.

1862

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1863

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1864

"intValue": "A String", # For metrics with integer value.

1865

"doubleValue": 3.14, # For metrics with floating point value.

1866

},

1867

],

1868

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1869

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1870

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

1871

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1872

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1873

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1874

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1875

},

1876

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1877

"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.

1878

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1880

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1881

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1882

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1883

{

1884

"a_key": "", # Properties of the object. Contains field @type with type URL.

1885

},

1886

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1887

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1888

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

1889

"name": "A String", # The server-assigned ID for the operation.

1890

"detail": "A String", # Detailed operation progress, if available.

1891

"targetLink": "A String", # Server-defined URL for the target of the operation.

1892

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

1893

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1894

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1895

"message": "A String", # Human-friendly representation of the condition

1896

"canonicalCode": "A String", # Canonical code of the condition.

1897

},

1898

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1903

<code class="details" id="setLegacyAbac">setLegacyAbac(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1904

<pre>Enables or disables the ABAC authorization mechanism on a cluster.

1905

1906

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1907

name: string, The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1908

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1909

The object takes the form of:

1910

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1911

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1912

"clusterId": "A String", # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1913

"name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1914

"enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1915

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1916

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1917

}

1918

1919

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1926

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1927

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

1928

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1929

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1930

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1931

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

1932

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1933

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1934

"stages": [ # Substages of an operation or a stage.

1935

# Object with schema name: OperationProgress

1936

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1937

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

1938

"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}]

1939

{ # Progress metric is (string, int|float|string) pair.

1940

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

1941

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

1942

"intValue": "A String", # For metrics with integer value.

1943

"doubleValue": 3.14, # For metrics with floating point value.

1944

},

1945

],

1946

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1947

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1948

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

1949

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1950

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1951

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1952

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1953

},

1954

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1955

"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.

1956

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1957

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1958

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1959

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1960

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1961

{

1962

"a_key": "", # Properties of the object. Contains field @type with type URL.

1963

},

1964

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1965

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1966

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

1967

"name": "A String", # The server-assigned ID for the operation.

1968

"detail": "A String", # Detailed operation progress, if available.

1969

"targetLink": "A String", # Server-defined URL for the target of the operation.

1970

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

1971

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

1972

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

1973

"message": "A String", # Human-friendly representation of the condition

1974

"canonicalCode": "A String", # Canonical code of the condition.

1975

},

1976

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1981

<code class="details" id="setLocations">setLocations(name, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1982

<pre>Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1983

1984

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1985

name: string, The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1986

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1987

The object takes the form of:

1988

1989

{ # SetLocationsRequest sets the locations of the cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1990

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1991

"name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1992

"locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1993

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1994

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1995

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

1996

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1997

}

1998

1999

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2006

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2007

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2008

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2009

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2010

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2011

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2012

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2013

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2014

"stages": [ # Substages of an operation or a stage.

2015

# Object with schema name: OperationProgress

2016

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2017

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2018

"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}]

2019

{ # Progress metric is (string, int|float|string) pair.

2020

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2021

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2022

"intValue": "A String", # For metrics with integer value.

2023

"doubleValue": 3.14, # For metrics with floating point value.

2024

},

2025

],

2026

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2027

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2028

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2029

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2030

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2031

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2032

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2033

},

2034

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2035

"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.

2036

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2037

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2038

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2039

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2040

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2041

{

2042

"a_key": "", # Properties of the object. Contains field @type with type URL.

2043

},

2044

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2045

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2046

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2047

"name": "A String", # The server-assigned ID for the operation.

2048

"detail": "A String", # Detailed operation progress, if available.

2049

"targetLink": "A String", # Server-defined URL for the target of the operation.

2050

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2051

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2052

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2053

"message": "A String", # Human-friendly representation of the condition

2054

"canonicalCode": "A String", # Canonical code of the condition.

2055

},

2056

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2061

<code class="details" id="setLogging">setLogging(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2062

<pre>Sets the logging service for a specific cluster.

2063

2064

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2065

name: string, The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2066

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2067

The object takes the form of:

2068

2069

{ # SetLoggingServiceRequest sets the logging service of a cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2070

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2071

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2072

"name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2073

"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.

2074

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2075

}

2076

2077

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2084

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2085

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2086

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2087

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2088

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2089

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2090

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2091

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2092

"stages": [ # Substages of an operation or a stage.

2093

# Object with schema name: OperationProgress

2094

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2095

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2096

"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}]

2097

{ # Progress metric is (string, int|float|string) pair.

2098

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2099

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2100

"intValue": "A String", # For metrics with integer value.

2101

"doubleValue": 3.14, # For metrics with floating point value.

2102

},

2103

],

2104

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2105

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2106

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2107

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2108

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2109

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2110

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2111

},

2112

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2113

"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.

2114

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2115

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2116

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2117

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2118

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2119

{

2120

"a_key": "", # Properties of the object. Contains field @type with type URL.

2121

},

2122

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2123

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2124

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2125

"name": "A String", # The server-assigned ID for the operation.

2126

"detail": "A String", # Detailed operation progress, if available.

2127

"targetLink": "A String", # Server-defined URL for the target of the operation.

2128

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2129

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2130

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2131

"message": "A String", # Human-friendly representation of the condition

2132

"canonicalCode": "A String", # Canonical code of the condition.

2133

},

2134

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2139

<code class="details" id="setMaintenancePolicy">setMaintenancePolicy(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2140

<pre>Sets the maintenance policy for a cluster.

2141

2142

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2143

name: string, The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2144

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2145

The object takes the form of:

2146

2147

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2148

"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.

2149

"name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2150

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2151

"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2152

"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.

2153

"window": { # Represents an arbitrary window of time. # The window of the first recurrence.

2154

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

2155

"startTime": "A String", # The time that the window first starts.

2156

},

2157

"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.

2158

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2159

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2160

"a_key": { # Represents an arbitrary window of time.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2161

"endTime": "A String", # The time that the window ends. The end time should take place after the start time.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2162

"startTime": "A String", # The time that the window first starts.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2163

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2164

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2165

"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.

2166

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

2167

"startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

2168

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2169

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2170

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2171

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2172

"projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2173

"clusterId": "A String", # Required. The name of the cluster to update.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2174

}

2175

2176

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2183

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2184

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2185

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2186

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2187

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2188

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2189

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2190

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2191

"stages": [ # Substages of an operation or a stage.

2192

# Object with schema name: OperationProgress

2193

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2194

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2195

"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}]

2196

{ # Progress metric is (string, int|float|string) pair.

2197

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2198

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2199

"intValue": "A String", # For metrics with integer value.

2200

"doubleValue": 3.14, # For metrics with floating point value.

2201

},

2202

],

2203

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2204

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2205

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2206

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2207

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2208

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2209

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2210

},

2211

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2212

"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.

2213

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2214

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2215

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2216

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2217

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2218

{

2219

"a_key": "", # Properties of the object. Contains field @type with type URL.

2220

},

2221

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2222

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2223

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2224

"name": "A String", # The server-assigned ID for the operation.

2225

"detail": "A String", # Detailed operation progress, if available.

2226

"targetLink": "A String", # Server-defined URL for the target of the operation.

2227

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2228

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2229

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2230

"message": "A String", # Human-friendly representation of the condition

2231

"canonicalCode": "A String", # Canonical code of the condition.

2232

},

2233

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2238

<code class="details" id="setMasterAuth">setMasterAuth(name, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2239

<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]

2240

2241

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2242

name: string, The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2243

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2244

The object takes the form of:

2245

2246

{ # SetMasterAuthRequest updates the admin password of a cluster.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2247

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2248

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2249

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2250

"action": "A String", # Required. The exact form of action to be taken on the master auth.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2251

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2252

"clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2253

"clusterCaCertificate": "A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2254

"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2255

"issueClientCertificate": True or False, # Issue a client certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2256

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2257

"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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2258

"clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

2259

"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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2260

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2261

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2262

}

2263

2264

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2271

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2272

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2273

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2274

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2275

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2276

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2277

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2278

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2279

"stages": [ # Substages of an operation or a stage.

2280

# Object with schema name: OperationProgress

2281

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2282

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2283

"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}]

2284

{ # Progress metric is (string, int|float|string) pair.

2285

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2286

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2287

"intValue": "A String", # For metrics with integer value.

2288

"doubleValue": 3.14, # For metrics with floating point value.

2289

},

2290

],

2291

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2292

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2293

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2294

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2295

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2296

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2297

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2298

},

2299

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2300

"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.

2301

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2302

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2303

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2304

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

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

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2310

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2311

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2312

"name": "A String", # The server-assigned ID for the operation.

2313

"detail": "A String", # Detailed operation progress, if available.

2314

"targetLink": "A String", # Server-defined URL for the target of the operation.

2315

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2316

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2317

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2318

"message": "A String", # Human-friendly representation of the condition

2319

"canonicalCode": "A String", # Canonical code of the condition.

2320

},

2321

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2326

<code class="details" id="setMonitoring">setMonitoring(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2327

<pre>Sets the monitoring service for a specific cluster.

2328

2329

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2330

name: string, The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2331

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2332

The object takes the form of:

2333

2334

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2335

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2336

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

2337

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

2338

"name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.

2339

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2340

}

2341

2342

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2349

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2350

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2351

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2352

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2353

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2354

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2355

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2356

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2357

"stages": [ # Substages of an operation or a stage.

2358

# Object with schema name: OperationProgress

2359

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2360

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2361

"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}]

2362

{ # Progress metric is (string, int|float|string) pair.

2363

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2364

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2365

"intValue": "A String", # For metrics with integer value.

2366

"doubleValue": 3.14, # For metrics with floating point value.

2367

},

2368

],

2369

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2370

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2371

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2372

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2373

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2374

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2375

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2376

},

2377

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2378

"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.

2379

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2380

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2381

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2382

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2383

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2384

{

2385

"a_key": "", # Properties of the object. Contains field @type with type URL.

2386

},

2387

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2388

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2389

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2390

"name": "A String", # The server-assigned ID for the operation.

2391

"detail": "A String", # Detailed operation progress, if available.

2392

"targetLink": "A String", # Server-defined URL for the target of the operation.

2393

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2394

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2395

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2396

"message": "A String", # Human-friendly representation of the condition

2397

"canonicalCode": "A String", # Canonical code of the condition.

2398

},

2399

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2404

<code class="details" id="setNetworkPolicy">setNetworkPolicy(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2405

<pre>Enables or disables Network Policy for a cluster.

2406

2407

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2408

name: string, The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2409

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2410

The object takes the form of:

2411

2412

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2413

"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Required. Configuration options for the NetworkPolicy feature.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2414

"provider": "A String", # The selected network policy provider.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2415

"enabled": True or False, # Whether network policy is enabled on the cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2416

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2417

"name": "A String", # The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.

2418

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

2419

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.

2420

"clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2421

}

2422

2423

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2430

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2431

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2432

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2433

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2434

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2435

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2436

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2437

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2438

"stages": [ # Substages of an operation or a stage.

2439

# Object with schema name: OperationProgress

2440

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2441

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2442

"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}]

2443

{ # Progress metric is (string, int|float|string) pair.

2444

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2445

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2446

"intValue": "A String", # For metrics with integer value.

2447

"doubleValue": 3.14, # For metrics with floating point value.

2448

},

2449

],

2450

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2451

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2452

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2453

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2454

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2455

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2456

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2457

},

2458

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2459

"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.

2460

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2461

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2462

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2463

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2464

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2465

{

2466

"a_key": "", # Properties of the object. Contains field @type with type URL.

2467

},

2468

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2469

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2470

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2471

"name": "A String", # The server-assigned ID for the operation.

2472

"detail": "A String", # Detailed operation progress, if available.

2473

"targetLink": "A String", # Server-defined URL for the target of the operation.

2474

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2475

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2476

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2477

"message": "A String", # Human-friendly representation of the condition

2478

"canonicalCode": "A String", # Canonical code of the condition.

2479

},

2480

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2485

<code class="details" id="setResourceLabels">setResourceLabels(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2486

<pre>Sets labels on a cluster.

2487

2488

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2489

name: string, The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2490

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2491

The object takes the form of:

2492

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2493

{ # 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

2020-11-24 15:48:03 -0800

[diff] [blame^]

2494

"clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

2495

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2496

"resourceLabels": { # Required. The labels to set for that cluster.

2497

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2498

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2499

"name": "A String", # The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2500

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2501

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2502

}

2503

2504

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2511

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2512

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2513

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2514

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2515

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2516

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2517

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2518

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2519

"stages": [ # Substages of an operation or a stage.

2520

# Object with schema name: OperationProgress

2521

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2522

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2523

"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}]

2524

{ # Progress metric is (string, int|float|string) pair.

2525

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2526

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2527

"intValue": "A String", # For metrics with integer value.

2528

"doubleValue": 3.14, # For metrics with floating point value.

2529

},

2530

],

2531

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2532

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2533

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2534

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2535

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2536

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2537

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2538

},

2539

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2540

"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.

2541

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2542

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2543

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2544

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2545

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2546

{

2547

"a_key": "", # Properties of the object. Contains field @type with type URL.

2548

},

2549

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2550

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2551

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2552

"name": "A String", # The server-assigned ID for the operation.

2553

"detail": "A String", # Detailed operation progress, if available.

2554

"targetLink": "A String", # Server-defined URL for the target of the operation.

2555

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2556

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2557

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2558

"message": "A String", # Human-friendly representation of the condition

2559

"canonicalCode": "A String", # Canonical code of the condition.

2560

},

2561

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2566

<code class="details" id="startIpRotation">startIpRotation(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2567

<pre>Starts master IP rotation.

2568

2569

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2570

name: string, The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2571

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2572

The object takes the form of:

2573

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2574

{ # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2575

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2576

"name": "A String", # The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2577

"rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2578

"clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2579

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2580

}

2581

2582

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2589

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2590

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2591

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2592

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2593

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2594

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2595

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2596

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2597

"stages": [ # Substages of an operation or a stage.

2598

# Object with schema name: OperationProgress

2599

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2600

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2601

"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}]

2602

{ # Progress metric is (string, int|float|string) pair.

2603

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2604

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2605

"intValue": "A String", # For metrics with integer value.

2606

"doubleValue": 3.14, # For metrics with floating point value.

2607

},

2608

],

2609

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2610

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2611

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2612

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2613

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2614

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2615

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2616

},

2617

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2618

"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.

2619

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2620

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2621

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2622

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2623

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2624

{

2625

"a_key": "", # Properties of the object. Contains field @type with type URL.

2626

},

2627

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2628

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2629

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2630

"name": "A String", # The server-assigned ID for the operation.

2631

"detail": "A String", # Detailed operation progress, if available.

2632

"targetLink": "A String", # Server-defined URL for the target of the operation.

2633

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2634

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2635

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2636

"message": "A String", # Human-friendly representation of the condition

2637

"canonicalCode": "A String", # Canonical code of the condition.

2638

},

2639

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2644

<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2645

<pre>Updates the settings for a specific cluster.

2646

2647

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2648

name: string, The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2649

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2650

The object takes the form of:

2651

2652

{ # UpdateClusterRequest updates the settings of a cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2653

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2654

"name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2655

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2656

"desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration.

2657

"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings.

2658

"enabled": True or False, # Whenever master is accessible globally or not.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

2659

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2660

"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.

2661

"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.

2662

"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.

2663

"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.

2664

"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.

2665

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2666

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2667

"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.

2668

"enabled": True or False, # Enables vertical pod autoscaling.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2669

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2670

"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.

2671

"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.

2672

{ # CidrBlock contains an optional name and one CIDR block.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2673

"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2674

"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2675

},

2676

],

2677

"enabled": True or False, # Whether or not master authorized networks is enabled.

2678

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2679

"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.

2680

"enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binauthz.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2681

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2682

"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster.

2683

"type": "A String", # Type of the integration.

2684

},

2685

"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.

2686

"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.

2687

"A String",

2688

],

2689

"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.

2690

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.

2691

},

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

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2695

"desiredNotificationConfig": { # NotificationConfig is the configuration of notifications. # The desired notification configuration.

2696

"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.

2697

"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.

2698

"enabled": True or False, # Enable notifications for Pub/Sub.

2699

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2700

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2701

"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.

2702

"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

2703

"state": "A String", # Denotes the state of etcd encryption.

2704

},

2705

"desiredDatapathProvider": "A String", # The desired datapath provider for the cluster.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2706

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2707

"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2708

"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.

2709

{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.

2710

"minimum": "A String", # Minimum amount of the resource in the cluster.

2711

"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.

2712

"maximum": "A String", # Maximum amount of the resource in the cluster.

2713

},

2714

],

2715

"autoscalingProfile": "A String", # Defines autoscaling behaviour.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2716

"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.

2717

"A String",

2718

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2719

"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2720

"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.

2721

"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.

2722

"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.

2723

},

2724

"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.

2725

"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value.

2726

"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.

2727

"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.

2728

"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

2729

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2730

"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.

2731

"A String",

2732

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2733

"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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2734

"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.

2735

"autoRepair": True or False, # Whether the nodes will be automatically repaired.

2736

"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.

2737

"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.

2738

"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.

2739

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

2740

},

2741

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2742

"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'

2743

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2744

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2745

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2746

"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.

2747

"disabled": True or False, # Disables cluster default sNAT rules.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2748

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2749

"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.

2750

"minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

2751

"maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

2752

"autoprovisioned": True or False, # Can this node pool be deleted automatically.

2753

"enabled": True or False, # Is autoscaling enabled for this node pool.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2754

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2755

"desiredPodSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # The desired configuration options for the PodSecurityPolicy feature.

2756

"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2757

},

2758

"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2759

"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.

2760

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2761

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2762

"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.

2763

"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.

2764

"datasetId": "A String", # The ID of a BigQuery Dataset.

2765

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2766

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2767

"desiredTpuConfig": { # Configuration for Cloud TPU. # The desired Cloud TPU configuration.

2768

"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.

2769

"enabled": True or False, # Whether Cloud TPU integration is enabled or not.

2770

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.

2771

},

2772

"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

2773

"desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the latest supported version. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2774

"desiredImageType": "A String", # The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2775

"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family", "desired_node_pool_autoscaling", or "desired_workload_metadata_config" is specified and there is more than one node pool on the cluster.

2776

"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.

2777

"channel": "A String", # channel specifies which release channel the cluster is subscribed to.

2778

},

2779

"desiredMaster": { # Master is the configuration for components on master. # Configuration for master components.

2780

},

2781

"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.

2782

"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.

2783

"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.

2784

},

2785

"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes

2786

"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.

2787

},

2788

"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

2789

"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.

2790

},

2791

"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.

2792

"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.

2793

},

2794

"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

2795

"disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.

2796

},

2797

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be enabled at cluster creation time. # Configuration for the Compute Engine Persistent Disk CSI driver.

2798

"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.

2799

},

2800

"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.

2801

"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.

2802

},

2803

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.

2804

"enabled": True or False, # Whether KALM is enabled for this cluster.

2805

},

2806

"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure microservices.

2807

"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.

2808

"disabled": True or False, # Whether Istio is enabled for this cluster.

2809

},

2810

"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.

2811

"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.

2812

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.

2813

},

2814

},

2815

"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity.

2816

"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.

2817

"identityProvider": "A String", # identity provider is the third party identity provider.

2818

"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.

2819

},

2820

"desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2821

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2822

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

2823

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2824

}

2825

2826

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2833

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2834

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2835

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2836

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2837

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2838

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2839

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2840

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2841

"stages": [ # Substages of an operation or a stage.

2842

# Object with schema name: OperationProgress

2843

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2844

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2845

"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}]

2846

{ # Progress metric is (string, int|float|string) pair.

2847

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2848

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2849

"intValue": "A String", # For metrics with integer value.

2850

"doubleValue": 3.14, # For metrics with floating point value.

2851

},

2852

],

2853

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2854

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2855

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2856

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2857

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2858

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2859

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2860

},

2861

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2862

"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.

2863

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2864

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2865

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2866

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2867

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2868

{

2869

"a_key": "", # Properties of the object. Contains field @type with type URL.

2870

},

2871

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2872

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2873

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

2874

"name": "A String", # The server-assigned ID for the operation.

2875

"detail": "A String", # Detailed operation progress, if available.

2876

"targetLink": "A String", # Server-defined URL for the target of the operation.

2877

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

2878

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

2879

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

2880

"message": "A String", # Human-friendly representation of the condition

2881

"canonicalCode": "A String", # Canonical code of the condition.

2882

},

2883

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2888

<code class="details" id="updateMaster">updateMaster(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2889

<pre>Updates the master for a specific cluster.

2890

2891

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2892

name: string, The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2893

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2894

The object takes the form of:

2895

2896

{ # UpdateMasterRequest updates the master of the cluster.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2897

"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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2898

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2899

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2900

"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2901

"name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2902

}

2903

2904

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2911

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2912

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

2913

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2914

"status": "A String", # The current status of the operation.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2915

"selfLink": "A String", # Server-defined URL for the resource.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2916

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

2917

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2918

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2919

"stages": [ # Substages of an operation or a stage.

2920

# Object with schema name: OperationProgress

2921

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2922

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

2923

"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}]

2924

{ # Progress metric is (string, int|float|string) pair.

2925

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

2926

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

2927

"intValue": "A String", # For metrics with integer value.

2928

"doubleValue": 3.14, # For metrics with floating point value.

2929

},

2930

],

2931

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2932

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2933

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

2934

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2935

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2936

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2937

"canonicalCode": "A String", # Canonical code of the condition.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2938

},

2939

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2940

"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.

2941

"operationType": "A String", # The operation type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2942

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2943

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2944

"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.

Dmitry Frenkel