Skip to content

docs: [container] clarified wording around the NodePoolUpdateStrategy default behavior #3909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gcf-merge-on-green merged 5 commits into from
Jan 28, 2023
Merged

docs: [container] clarified wording around the NodePoolUpdateStrategy default behavior #3909

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c184608
docs: clarified wording around the NodePoolUpdateStrategy default beh…
gcf-owl-bot[bot] Jan 27, 2023
12b6eff
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jan 27, 2023
74a920c
docs: clarified wording around the NodePoolUpdateStrategy default beh…
gcf-owl-bot[bot] Jan 27, 2023
a23aabf
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jan 27, 2023
09c6445
Merge branch 'main' into owl-bot-copy-packages-google-container
sofisl Jan 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions packages/google-container/protos/google/container/v1/cluster_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,7 +684,9 @@ message NodeConfig {
map<string, string> metadata = 4;

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

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

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

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

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

Expand Down Expand Up @@ -4596,7 +4602,8 @@ enum DatapathProvider {

// Strategy used for node pool update.
enum NodePoolUpdateStrategy {
// Default value.
// Default value if unset. GKE internally defaults the update strategy to
// SURGE for unspecified strategies.
NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED = 0;

// blue-green upgrade.
Expand Down
15 changes: 11 additions & 4 deletions packages/google-container/protos/google/container/v1beta1/cluster_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,9 @@ message NodeConfig {
map<string, string> metadata = 4;

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

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

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

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

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

Expand Down Expand Up @@ -4987,7 +4993,8 @@ message IdentityServiceConfig {

// Strategy used for node pool update.
enum NodePoolUpdateStrategy {
// Default value.
// Default value if unset. GKE internally defaults the update strategy to
// SURGE for unspecified strategies.
NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED = 0;

// blue-green upgrade.
Expand Down
4 changes: 3 additions & 1 deletion packages/google-container/samples/generated/v1/cluster_manager.update_node_pool.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ function main(nodeVersion, imageType) {
*/
// const nodeVersion = 'abc123'
/**
* Required. The desired image type for the node pool.
* Required. The desired image type for the node pool. Please see
* https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
* available image types.
*/
// const imageType = 'abc123'
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/google-container/samples/generated/v1/snippet_metadata.google.container.v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@
"segments": [
{
"start": 25,
"end": 154,
"end": 156,
"type": "FULL"
}
],
Expand Down
4 changes: 3 additions & 1 deletion packages/google-container/samples/generated/v1beta1/cluster_manager.update_node_pool.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ function main(projectId, zone, clusterId, nodePoolId, nodeVersion, imageType) {
*/
// const nodeVersion = 'abc123'
/**
* Required. The desired image type for the node pool.
* Required. The desired image type for the node pool. Please see
* https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
* available image types.
*/
// const imageType = 'abc123'
/**
Expand Down
2 changes: 1 addition & 1 deletion ...google-container/samples/generated/v1beta1/snippet_metadata.google.container.v1beta1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@
"segments": [
{
"start": 25,
"end": 158,
"end": 160,
"type": "FULL"
}
],
Expand Down
4 changes: 3 additions & 1 deletion packages/google-container/src/v1/cluster_manager_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,7 +791,9 @@ export class ClusterManagerClient {
* - "1.X.Y-gke.N": picks an explicit Kubernetes version
* - "-": picks the Kubernetes master version
* @param {string} request.imageType
* Required. The desired image type for the node pool.
* Required. The desired image type for the node pool. Please see
* https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
* available image types.
* @param {string} request.name
* The name (project, location, cluster, node pool) of the node pool to
* update. Specified in the format
Expand Down
4 changes: 3 additions & 1 deletion packages/google-container/src/v1beta1/cluster_manager_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -798,7 +798,9 @@ export class ClusterManagerClient {
* - "1.X.Y-gke.N": picks an explicit Kubernetes version
* - "-": picks the Kubernetes master version
* @param {string} request.imageType
* Required. The desired image type for the node pool.
* Required. The desired image type for the node pool. Please see
* https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for
* available image types.
* @param {string[]} request.locations
* The desired list of Google Compute Engine
* [zones](https://cloud.google.com/compute/docs/zones#available) in which the
Expand Down
⚡