Skip to content

Commit 9980ca3

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: [container] clarified wording around the NodePoolUpdateStrategy default behavior (#3909)
- [ ] Regenerate this pull request now. docs: add references for available node image types PiperOrigin-RevId: 505186848 Source-Link: https://togithub.com/googleapis/googleapis/commit/d6e9adbf6646748cb41ca6aa61a78a70a1d83ff5 Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/fa221b6a3c945ca7ec063b72ae9eca940ed3dfdd Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNvbnRhaW5lci8uT3dsQm90LnlhbWwiLCJoIjoiZmEyMjFiNmEzYzk0NWNhN2VjMDYzYjcyYWU5ZWNhOTQwZWQzZGZkZCJ9 BEGIN_NESTED_COMMIT docs: [container] clarified wording around the NodePoolUpdateStrategy default behavior docs: add references for available node image types PiperOrigin-RevId: 505182579 Source-Link: https://togithub.com/googleapis/googleapis/commit/c062caf559720759356214d6aa6b9504e91eef99 Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/ea6906f11af5243d6b4105af0af854e878b0a1e7 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNvbnRhaW5lci8uT3dsQm90LnlhbWwiLCJoIjoiZWE2OTA2ZjExYWY1MjQzZDZiNDEwNWFmMGFmODU0ZTg3OGIwYTFlNyJ9 END_NESTED_COMMIT
1 parent b6907b5 commit 9980ca3

8 files changed

Lines changed: 36 additions & 14 deletions

File tree

‎packages/google-container/protos/google/container/v1/cluster_service.proto‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -684,7 +684,9 @@ message NodeConfig {
684684
map<string, string> metadata = 4;
685685

686686
// The image type to use for this node. Note that for a given image type,
687-
// the latest version of it will be used.
687+
// the latest version of it will be used. Please see
688+
// https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
689+
// available image types.
688690
string image_type = 5;
689691

690692
// The map of Kubernetes labels (key/value pairs) to be applied to each node.
@@ -2299,7 +2301,9 @@ message UpdateNodePoolRequest {
22992301
// - "-": picks the Kubernetes master version
23002302
string node_version = 5 [(google.api.field_behavior) = REQUIRED];
23012303

2302-
// Required. The desired image type for the node pool.
2304+
// Required. The desired image type for the node pool. Please see
2305+
// https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
2306+
// available image types.
23032307
string image_type = 6 [(google.api.field_behavior) = REQUIRED];
23042308

23052309
// The name (project, location, cluster, node pool) of the node pool to
@@ -3527,7 +3531,9 @@ message AutoprovisioningNodePoolDefaults {
35273531
// https://cloud.google.com/compute/docs/disks/customer-managed-encryption
35283532
string boot_disk_kms_key = 9;
35293533

3530-
// The image type to use for NAP created node.
3534+
// The image type to use for NAP created node. Please see
3535+
// https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
3536+
// available image types.
35313537
string image_type = 10;
35323538
}
35333539

@@ -4596,7 +4602,8 @@ enum DatapathProvider {
45964602

45974603
// Strategy used for node pool update.
45984604
enum NodePoolUpdateStrategy {
4599-
// Default value.
4605+
// Default value if unset. GKE internally defaults the update strategy to
4606+
// SURGE for unspecified strategies.
46004607
NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED = 0;
46014608

46024609
// blue-green upgrade.

‎packages/google-container/protos/google/container/v1beta1/cluster_service.proto‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -676,7 +676,9 @@ message NodeConfig {
676676
map<string, string> metadata = 4;
677677

678678
// The image type to use for this node. Note that for a given image type,
679-
// the latest version of it will be used.
679+
// the latest version of it will be used. Please see
680+
// https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
681+
// available image types.
680682
string image_type = 5;
681683

682684
// The map of Kubernetes labels (key/value pairs) to be applied to each node.
@@ -2558,7 +2560,9 @@ message UpdateNodePoolRequest {
25582560
// - "-": picks the Kubernetes master version
25592561
string node_version = 5 [(google.api.field_behavior) = REQUIRED];
25602562

2561-
// Required. The desired image type for the node pool.
2563+
// Required. The desired image type for the node pool. Please see
2564+
// https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
2565+
// available image types.
25622566
string image_type = 6 [(google.api.field_behavior) = REQUIRED];
25632567

25642568
// The desired list of Google Compute Engine
@@ -3876,7 +3880,9 @@ message AutoprovisioningNodePoolDefaults {
38763880
// https://cloud.google.com/compute/docs/disks/customer-managed-encryption
38773881
string boot_disk_kms_key = 9;
38783882

3879-
// The image type to use for NAP created node.
3883+
// The image type to use for NAP created node. Please see
3884+
// https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
3885+
// available image types.
38803886
string image_type = 10;
38813887
}
38823888

@@ -4987,7 +4993,8 @@ message IdentityServiceConfig {
49874993

49884994
// Strategy used for node pool update.
49894995
enum NodePoolUpdateStrategy {
4990-
// Default value.
4996+
// Default value if unset. GKE internally defaults the update strategy to
4997+
// SURGE for unspecified strategies.
49914998
NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED = 0;
49924999

49935000
// blue-green upgrade.

‎packages/google-container/samples/generated/v1/cluster_manager.update_node_pool.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ function main(nodeVersion, imageType) {
4141
*/
4242
// const nodeVersion = 'abc123'
4343
/**
44-
* Required. The desired image type for the node pool.
44+
* Required. The desired image type for the node pool. Please see
45+
* https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
46+
* available image types.
4547
*/
4648
// const imageType = 'abc123'
4749
/**

‎packages/google-container/samples/generated/v1/snippet_metadata.google.container.v1.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@
230230
"segments": [
231231
{
232232
"start": 25,
233-
"end": 154,
233+
"end": 156,
234234
"type": "FULL"
235235
}
236236
],

‎packages/google-container/samples/generated/v1beta1/cluster_manager.update_node_pool.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ function main(projectId, zone, clusterId, nodePoolId, nodeVersion, imageType) {
4141
*/
4242
// const nodeVersion = 'abc123'
4343
/**
44-
* Required. The desired image type for the node pool.
44+
* Required. The desired image type for the node pool. Please see
45+
* https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
46+
* available image types.
4547
*/
4648
// const imageType = 'abc123'
4749
/**

‎packages/google-container/samples/generated/v1beta1/snippet_metadata.google.container.v1beta1.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@
230230
"segments": [
231231
{
232232
"start": 25,
233-
"end": 158,
233+
"end": 160,
234234
"type": "FULL"
235235
}
236236
],

‎packages/google-container/src/v1/cluster_manager_client.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -791,7 +791,9 @@ export class ClusterManagerClient {
791791
* - "1.X.Y-gke.N": picks an explicit Kubernetes version
792792
* - "-": picks the Kubernetes master version
793793
* @param {string} request.imageType
794-
* Required. The desired image type for the node pool.
794+
* Required. The desired image type for the node pool. Please see
795+
* https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
796+
* available image types.
795797
* @param {string} request.name
796798
* The name (project, location, cluster, node pool) of the node pool to
797799
* update. Specified in the format

‎packages/google-container/src/v1beta1/cluster_manager_client.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,9 @@ export class ClusterManagerClient {
798798
* - "1.X.Y-gke.N": picks an explicit Kubernetes version
799799
* - "-": picks the Kubernetes master version
800800
* @param {string} request.imageType
801-
* Required. The desired image type for the node pool.
801+
* Required. The desired image type for the node pool. Please see
802+
* https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
803+
* available image types.
802804
* @param {string[]} request.locations
803805
* The desired list of Google Compute Engine
804806
* [zones](https://cloud.google.com/compute/docs/zones#available) in which the

0 commit comments

Comments
 (0)
⚡