docs: clarified wording around the NodePoolUpdateStrategy default behavior (googleapis#340)

gcf-owl-bot[bot] · web-flow · commit 76cfff85542a · 2023-01-28T06:25:58.000-05:00
* docs: clarified wording around the NodePoolUpdateStrategy default behavior docs: add references for available node image types PiperOrigin-RevId: 505182579 Source-Link: googleapis/googleapis@c062caf Source-Link: https://github.com/googleapis/googleapis-gen/commit/ea6906f11af5243d6b4105af0af854e878b0a1e7 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWE2OTA2ZjExYWY1MjQzZDZiNDEwNWFmMGFmODU0ZTg3OGIwYTFlNyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: clarified wording around the NodePoolUpdateStrategy default behavior docs: add references for available node image types PiperOrigin-RevId: 505186848 Source-Link: googleapis/googleapis@d6e9adb Source-Link: https://github.com/googleapis/googleapis-gen/commit/fa221b6a3c945ca7ec063b72ae9eca940ed3dfdd Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZmEyMjFiNmEzYzk0NWNhN2VjMDYzYjcyYWU5ZWNhOTQwZWQzZGZkZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/google/cloud/container_v1/types/cluster_service.py b/google/cloud/container_v1/types/cluster_service.py
@@ -240,7 +240,9 @@ class NodePoolUpdateStrategy(proto.Enum):
 
     Values:
         NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED (0):
-            Default value.
+            Default value if unset. GKE internally
+            defaults the update strategy to SURGE for
+            unspecified strategies.
         BLUE_GREEN (2):
             blue-green upgrade.
         SURGE (3):
@@ -523,7 +525,9 @@ class NodeConfig(proto.Message):
         image_type (str):
             The image type to use for this node. Note
             that for a given image type, the latest version
-            of it will be used.
+            of it will be used. Please see
+            https://cloud.google.com/kubernetes-engine/docs/concepts/node-images
+            for available image types.
         labels (MutableMapping[str, str]):
             The map of Kubernetes labels (key/value
             pairs) to be applied to each node. These will
@@ -3584,7 +3588,9 @@ class UpdateNodePoolRequest(proto.Message):
             master version
         image_type (str):
             Required. The desired image type for the node
-            pool.
+            pool. Please see
+            https://cloud.google.com/kubernetes-engine/docs/concepts/node-images
+            for available image types.
         name (str):
             The name (project, location, cluster, node pool) of the node
             pool to update. Specified in the format
@@ -5885,6 +5891,9 @@ class AutoprovisioningNodePoolDefaults(proto.Message):
             https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         image_type (str):
             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.
     """
 
     oauth_scopes: MutableSequence[str] = proto.RepeatedField(
diff --git a/google/cloud/container_v1beta1/types/cluster_service.py b/google/cloud/container_v1beta1/types/cluster_service.py
@@ -233,7 +233,9 @@ class NodePoolUpdateStrategy(proto.Enum):
 
     Values:
         NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED (0):
-            Default value.
+            Default value if unset. GKE internally
+            defaults the update strategy to SURGE for
+            unspecified strategies.
         BLUE_GREEN (2):
             blue-green upgrade.
         SURGE (3):
@@ -520,7 +522,9 @@ class NodeConfig(proto.Message):
         image_type (str):
             The image type to use for this node. Note
             that for a given image type, the latest version
-            of it will be used.
+            of it will be used. Please see
+            https://cloud.google.com/kubernetes-engine/docs/concepts/node-images
+            for available image types.
         labels (MutableMapping[str, str]):
             The map of Kubernetes labels (key/value
             pairs) to be applied to each node. These will
@@ -4083,7 +4087,9 @@ class UpdateNodePoolRequest(proto.Message):
             master version
         image_type (str):
             Required. The desired image type for the node
-            pool.
+            pool. Please see
+            https://cloud.google.com/kubernetes-engine/docs/concepts/node-images
+            for available image types.
         locations (MutableSequence[str]):
             The desired list of Google Compute Engine
             `zones <https://cloud.google.com/compute/docs/zones#available>`__
@@ -6468,6 +6474,9 @@ class AutoprovisioningNodePoolDefaults(proto.Message):
             https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         image_type (str):
             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.
     """
 
     oauth_scopes: MutableSequence[str] = proto.RepeatedField(
