From 96ddca67bf0e23c9c8fb838ebdfb000bee7d1b02 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 13 Sep 2023 21:10:14 +0000 Subject: [PATCH] docs: Minor formatting (#411) - [ ] Regenerate this pull request now. chore: Update gapic-generator-python to v1.11.5 build: Update rules_python to 0.24.0 PiperOrigin-RevId: 563436317 Source-Link: https://togithub.com/googleapis/googleapis/commit/42fd37b18d706f6f51f52f209973b3b2c28f509a Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/280264ca02fb9316b4237a96d0af1a2343a81a56 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 --- google/cloud/container_v1/types/cluster_service.py | 8 +++++++- .../services/cluster_manager/async_client.py | 2 ++ .../container_v1beta1/services/cluster_manager/client.py | 2 ++ google/cloud/container_v1beta1/types/cluster_service.py | 9 ++++++++- 4 files changed, 19 insertions(+), 2 deletions(-) diff --git a/google/cloud/container_v1/types/cluster_service.py b/google/cloud/container_v1/types/cluster_service.py index e6335a46..2e9bb444 100644 --- a/google/cloud/container_v1/types/cluster_service.py +++ b/google/cloud/container_v1/types/cluster_service.py @@ -426,6 +426,7 @@ class NodeKubeletConfig(proto.Message): problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. + The default value is 'true' if unspecified. cpu_cfs_quota_period (str): Set the CPU CFS quota period value 'cpu.cfs_period_us'. @@ -437,6 +438,7 @@ class NodeKubeletConfig(proto.Message): pod_pids_limit (int): Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits + Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. @@ -491,6 +493,7 @@ class NodeConfig(proto.Message): 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. oauth_scopes (MutableSequence[str]): The set of Google API scopes to be made available on all of @@ -590,7 +593,6 @@ class NodeConfig(proto.Message): preemptible (bool): Whether the nodes are created as preemptible VM instances. See: - https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. @@ -1423,6 +1425,7 @@ class MasterAuth(proto.Message): 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 @@ -6593,6 +6596,7 @@ class AutoprovisioningNodePoolDefaults(proto.Message): 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. disk_type (str): Type of the disk attached to each node (e.g. @@ -7827,6 +7831,7 @@ class CheckAutopilotCompatibilityResponse(proto.Message): class ReleaseChannel(proto.Message): r"""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. @@ -7847,6 +7852,7 @@ class Channel(proto.Enum): RAPID channel is offered on an early access basis for customers who want to test new releases. + WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any diff --git a/google/cloud/container_v1beta1/services/cluster_manager/async_client.py b/google/cloud/container_v1beta1/services/cluster_manager/async_client.py index d1651b1f..5b94d4df 100644 --- a/google/cloud/container_v1beta1/services/cluster_manager/async_client.py +++ b/google/cloud/container_v1beta1/services/cluster_manager/async_client.py @@ -2841,6 +2841,7 @@ async def sample_get_node_pool(): (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 @@ -2848,6 +2849,7 @@ async def sample_get_node_pool(): 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 diff --git a/google/cloud/container_v1beta1/services/cluster_manager/client.py b/google/cloud/container_v1beta1/services/cluster_manager/client.py index a293d813..6657f0ab 100644 --- a/google/cloud/container_v1beta1/services/cluster_manager/client.py +++ b/google/cloud/container_v1beta1/services/cluster_manager/client.py @@ -2999,6 +2999,7 @@ def sample_get_node_pool(): (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 @@ -3006,6 +3007,7 @@ def sample_get_node_pool(): 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 diff --git a/google/cloud/container_v1beta1/types/cluster_service.py b/google/cloud/container_v1beta1/types/cluster_service.py index 504edb9d..64d3eafd 100644 --- a/google/cloud/container_v1beta1/types/cluster_service.py +++ b/google/cloud/container_v1beta1/types/cluster_service.py @@ -424,6 +424,7 @@ class NodeKubeletConfig(proto.Message): problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. + The default value is 'true' if unspecified. cpu_cfs_quota_period (str): Set the CPU CFS quota period value 'cpu.cfs_period_us'. @@ -435,6 +436,7 @@ class NodeKubeletConfig(proto.Message): pod_pids_limit (int): Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits + Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. @@ -489,6 +491,7 @@ class NodeConfig(proto.Message): 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. oauth_scopes (MutableSequence[str]): The set of Google API scopes to be made available on all of @@ -588,7 +591,6 @@ class NodeConfig(proto.Message): preemptible (bool): Whether the nodes are created as preemptible VM instances. See: - https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. @@ -1575,6 +1577,7 @@ class MasterAuth(proto.Message): 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 @@ -3829,6 +3832,7 @@ class ClusterUpdate(proto.Message): 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: @@ -7292,6 +7296,7 @@ class AutoprovisioningNodePoolDefaults(proto.Message): 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. disk_type (str): Type of the disk attached to each node (e.g. @@ -9272,6 +9277,7 @@ class CheckAutopilotCompatibilityResponse(proto.Message): class ReleaseChannel(proto.Message): r"""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. @@ -9292,6 +9298,7 @@ class Channel(proto.Enum): RAPID channel is offered on an early access basis for customers who want to test new releases. + WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any