Skip to content
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

Jump to bottom

Upgrading kubernetes client library to v24.2.0 #3632

Merged
merged 4 commits into from
Jul 7, 2023
Merged

Upgrading kubernetes client library to v24.2.0 #3632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
14aca82
Upgrading kubernetes client library to v24.2.0
wilmer05 Jun 27, 2023
0fc36f8
Fixing tests
wilmer05 Jul 5, 2023
fe92595
Updating the CRD
wilmer05 Jul 5, 2023
44086c3
Upgrading second CRD in internal script
wilmer05 Jul 6, 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
24 changes: 12 additions & 12 deletions paasta_tools/kubernetes_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@
from humanfriendly import parse_size
from kubernetes import client as kube_client
from kubernetes import config as kube_config
from kubernetes.client import CoreV1Event
from kubernetes.client import models
from kubernetes.client import V1Affinity
from kubernetes.client import V1AWSElasticBlockStoreVolumeSource
from kubernetes.client import V1beta1CustomResourceDefinition
from kubernetes.client import V1beta1PodDisruptionBudget
from kubernetes.client import V1beta1PodDisruptionBudgetSpec
from kubernetes.client import V1Capabilities
Expand All @@ -55,21 +55,21 @@
from kubernetes.client import V1ContainerPort
from kubernetes.client import V1ContainerStatus
from kubernetes.client import V1ControllerRevision
from kubernetes.client import V1CustomResourceDefinition
from kubernetes.client import V1CustomResourceDefinitionList
from kubernetes.client import V1DeleteOptions
from kubernetes.client import V1Deployment
from kubernetes.client import V1DeploymentSpec
from kubernetes.client import V1DeploymentStrategy
from kubernetes.client import V1EnvVar
from kubernetes.client import V1EnvVarSource
from kubernetes.client import V1Event
from kubernetes.client import V1ExecAction
from kubernetes.client import V1Handler
from kubernetes.client import V1HostPathVolumeSource
from kubernetes.client import V1HTTPGetAction
from kubernetes.client import V1KeyToPath
from kubernetes.client import V1LabelSelector
from kubernetes.client import V1Lifecycle
from kubernetes.client import V1LifecycleHandler
from kubernetes.client import V1Namespace
from kubernetes.client import V1Node
from kubernetes.client import V1NodeAffinity
Expand Down Expand Up @@ -524,7 +524,7 @@ def __init__(
self.deployments = kube_client.AppsV1Api(self.api_client)
self.core = kube_client.CoreV1Api(self.api_client)
self.policy = kube_client.PolicyV1beta1Api(self.api_client)
self.apiextensions = kube_client.ApiextensionsV1beta1Api(self.api_client)
self.apiextensions = kube_client.ApiextensionsV1Api(self.api_client)
self.custom = kube_client.CustomObjectsApi(self.api_client)
self.autoscaling = kube_client.AutoscalingV2beta2Api(self.api_client)
self.rbac = kube_client.RbacAuthorizationV1Api(self.api_client)
Expand Down Expand Up @@ -1024,7 +1024,7 @@ def get_hacheck_sidecar_container(
return V1Container(
image=system_paasta_config.get_hacheck_sidecar_image_url(),
lifecycle=V1Lifecycle(
pre_stop=V1Handler(
pre_stop=V1LifecycleHandler(
_exec=V1ExecAction(
command=[
"/bin/sh",
Expand Down Expand Up @@ -1066,7 +1066,7 @@ def get_uwsgi_exporter_sidecar_container(
env=self.get_kubernetes_environment() + [stats_port_env],
ports=[V1ContainerPort(container_port=9117)],
lifecycle=V1Lifecycle(
pre_stop=V1Handler(
pre_stop=V1LifecycleHandler(
_exec=V1ExecAction(
command=[
"/bin/sh",
Expand Down Expand Up @@ -1376,20 +1376,20 @@ def get_readiness_probe(
else:
return self.get_liveness_probe(service_namespace_config)

def get_kubernetes_container_termination_action(self) -> V1Handler:
def get_kubernetes_container_termination_action(self) -> V1LifecycleHandler:
command = self.config_dict.get("lifecycle", KubeLifecycleDict({})).get(
"pre_stop_command", []
)
# default pre stop hook for the container
if not command:
return V1Handler(
return V1LifecycleHandler(
_exec=V1ExecAction(
command=["/bin/sh", "-c", f"sleep {DEFAULT_PRESTOP_SLEEP_SECONDS}"]
)
)
if isinstance(command, str):
command = [command]
return V1Handler(_exec=V1ExecAction(command=command))
return V1LifecycleHandler(_exec=V1ExecAction(command=command))

def get_pod_volumes(
self,
Expand Down Expand Up @@ -3282,7 +3282,7 @@ def update_stateful_set(
)


def get_event_timestamp(event: V1Event) -> Optional[float]:
def get_event_timestamp(event: CoreV1Event) -> Optional[float]:
# Cycle through timestamp attributes in order of preference
for ts_attr in ["last_timestamp", "event_time", "first_timestamp"]:
ts = getattr(event, ts_attr)
Expand All @@ -3297,7 +3297,7 @@ async def get_events_for_object(
obj: Union[V1Pod, V1Deployment, V1StatefulSet, V1ReplicaSet],
kind: str, # for some reason, obj.kind isn't populated when this function is called so we pass it in by hand
max_age_in_seconds: Optional[int] = None,
) -> List[V1Event]:
) -> List[CoreV1Event]:

try:
# this is a blocking call since it does network I/O and can end up significantly blocking the
Expand Down Expand Up @@ -3751,7 +3751,7 @@ def mode_to_int(mode: Optional[Union[str, int]]) -> Optional[int]:

def update_crds(
kube_client: KubeClient,
desired_crds: Collection[V1beta1CustomResourceDefinition],
desired_crds: Collection[V1CustomResourceDefinition],
existing_crds: V1CustomResourceDefinitionList,
) -> bool:
success = True
Expand Down
4 changes: 2 additions & 2 deletions paasta_tools/setup_kubernetes_crd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
from typing import Sequence

import service_configuration_lib
from kubernetes.client import V1beta1CustomResourceDefinition
from kubernetes.client import V1CustomResourceDefinition

from paasta_tools.kubernetes_tools import KubeClient
from paasta_tools.kubernetes_tools import paasta_prefixed
Expand Down Expand Up @@ -118,7 +118,7 @@ def setup_kube_crd(
metadata["labels"] = {}
metadata["labels"]["yelp.com/paasta_service"] = service
metadata["labels"][paasta_prefixed("service")] = service
desired_crd = V1beta1CustomResourceDefinition(
desired_crd = V1CustomResourceDefinition(
api_version=crd_config.get("apiVersion"),
kind=crd_config.get("kind"),
metadata=metadata,
Expand Down
70 changes: 41 additions & 29 deletions paasta_tools/setup_kubernetes_internal_crd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import logging
import sys

from kubernetes.client import V1beta1CustomResourceDefinition
from kubernetes.client import V1CustomResourceDefinition

from paasta_tools.kubernetes_tools import KubeClient
from paasta_tools.kubernetes_tools import paasta_prefixed
Expand All @@ -33,8 +33,8 @@


INTERNAL_CRDS = [
V1beta1CustomResourceDefinition(
api_version="apiextensions.k8s.io/v1beta1",
V1CustomResourceDefinition(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need to update this CRD definition as well. there are few deprecated keys in V1
https://kubernetes.io/docs/reference/using-api/deprecation-guide/#customresourcedefinition-v122

i have an open PR which was sortof doing the same thing.
https://github.com/Yelp/paasta/pull/3611/files#diff-59d82c9819b7780a1257b5ef686a4f93d5b6626181b33637448ce656f3ce6650

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the catch, I will add the same in this PR

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is another CRD definition L85:L116 that we might need to update.

sorry, I didn't see that earlier

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated it, thanks for the catch

api_version="apiextensions.k8s.io/v1",
kind="CustomResourceDefinition",
metadata={
"name": "deploygroups.paasta.yelp.com",
Expand All @@ -44,29 +44,35 @@
},
spec={
"group": "paasta.yelp.com",
"versions": [{"name": "v1beta1", "served": True, "storage": True}],
"versions": [
{
"name": "v1beta1",
"served": True,
"storage": True,
"schema": {
"openAPIV3Schema": {
"type": "object",
"properties": {
"service": {"type": "string"},
"deploy_group": {"type": "string"},
"git_sha": {"type": "string"},
"image_version": {"type": "string"},
},
}
},
}
],
"scope": "Namespaced",
"names": {
"plural": "deploygroups",
"singular": "deploygroup",
"kind": "DeployGroup",
"shortNames": ["dg"],
},
"validation": {
"openAPIV3Schema": {
"type": "object",
"properties": {
"service": {"type": "string"},
"deploy_group": {"type": "string"},
"git_sha": {"type": "string"},
"image_version": {"type": "string"},
},
}
},
},
),
V1beta1CustomResourceDefinition(
api_version="apiextensions.k8s.io/v1beta1",
V1CustomResourceDefinition(
api_version="apiextensions.k8s.io/v1",
kind="CustomResourceDefinition",
metadata={
"name": "startstopcontrols.paasta.yelp.com",
Expand All @@ -76,24 +82,30 @@
},
spec={
"group": "paasta.yelp.com",
"versions": [{"name": "v1beta1", "served": True, "storage": True}],
"versions": [
{
"name": "v1beta1",
"served": True,
"storage": True,
"schema": {
"openAPIV3Schema": {
"type": "object",
"properties": {
"service": {"type": "string"},
"instance": {"type": "string"},
"desired_state": {"type": "string"},
"force_bounce": {"type": "string"},
},
}
},
}
],
"scope": "Namespaced",
"names": {
"plural": "startstopcontrols",
"singular": "startstopcontrol",
"kind": "StartStopControl",
},
"validation": {
"openAPIV3Schema": {
"type": "object",
"properties": {
"service": {"type": "string"},
"instance": {"type": "string"},
"desired_state": {"type": "string"},
"force_bounce": {"type": "string"},
},
}
},
},
),
]
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ jmespath==0.9.3
jsonref==0.1
jsonschema==2.5.1
kazoo==2.8.0
kubernetes==18.20.0
kubernetes==24.2.0
ldap3==2.6
manhole==1.5.0
marathon==0.12.0
Expand Down
14 changes: 7 additions & 7 deletions tests/test_kubernetes_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
from kubernetes.client import V1EnvVar
from kubernetes.client import V1EnvVarSource
from kubernetes.client import V1ExecAction
from kubernetes.client import V1Handler
from kubernetes.client import V1HostPathVolumeSource
from kubernetes.client import V1HTTPGetAction
from kubernetes.client import V1KeyToPath
from kubernetes.client import V1LabelSelector
from kubernetes.client import V1Lifecycle
from kubernetes.client import V1LifecycleHandler
from kubernetes.client import V1NodeAffinity
from kubernetes.client import V1NodeSelector
from kubernetes.client import V1NodeSelectorRequirement
Expand Down Expand Up @@ -558,7 +558,7 @@ def test_get_sidecar_containers(self):
],
image="some-docker-image",
lifecycle=V1Lifecycle(
pre_stop=V1Handler(
pre_stop=V1LifecycleHandler(
_exec=V1ExecAction(
command=[
"/bin/sh",
Expand Down Expand Up @@ -604,7 +604,7 @@ def test_get_sidecar_containers(self):
],
image="some-docker-image",
lifecycle=V1Lifecycle(
pre_stop=V1Handler(
pre_stop=V1LifecycleHandler(
_exec=V1ExecAction(
command=[
"/bin/sh",
Expand Down Expand Up @@ -1004,7 +1004,7 @@ def test_get_kubernetes_containers(self, prometheus_port, expected_ports):
resources=mock_get_resource_requirements.return_value,
image=mock_get_docker_url.return_value,
lifecycle=V1Lifecycle(
pre_stop=V1Handler(
pre_stop=V1LifecycleHandler(
_exec=V1ExecAction(command=["/bin/sh", "-c", "sleep 30"])
)
),
Expand Down Expand Up @@ -1892,7 +1892,7 @@ def test_kubernetes_container_termination_action(
self.deployment.config_dict["lifecycle"] = {
"pre_stop_command": termination_action
}
handler = V1Handler(_exec=V1ExecAction(command=expected))
handler = V1LifecycleHandler(_exec=V1ExecAction(command=expected))
assert self.deployment.get_kubernetes_container_termination_action() == handler

@pytest.mark.parametrize(
Expand Down Expand Up @@ -3908,7 +3908,7 @@ def test_warning_big_bounce():
job_config.format_kubernetes_app().spec.template.metadata.labels[
"paasta.yelp.com/config_sha"
]
== "configf6939dba"
== "configd6531f39"
), "If this fails, just change the constant in this test, but be aware that deploying this change will cause every service to bounce!"


Expand Down Expand Up @@ -3954,7 +3954,7 @@ def test_warning_big_bounce_routable_pod():
job_config.format_kubernetes_app().spec.template.metadata.labels[
"paasta.yelp.com/config_sha"
]
== "config0107126a"
== "configa5abd828"
), "If this fails, just change the constant in this test, but be aware that deploying this change will cause every smartstack-registered service to bounce!"


Expand Down