paasta-tools 1.21.3__py3-none-any.whl

paasta_tools/paastaapi/models/__init__.py

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+# flake8: noqa
+
+# import all models into this package
+# if you have many models here with many references from one model to another this may
+# raise a RecursionError
+# to avoid this, import only the models that you directly need like:
+# from from paasta_tools.paastaapi.model.pet import Pet
+# or import this package, but before doing it, use:
+# import sys
+# sys.setrecursionlimit(n)
+
+from paasta_tools.paastaapi.model.adhoc_launch_history import AdhocLaunchHistory
+from paasta_tools.paastaapi.model.autoscaler_count_msg import AutoscalerCountMsg
+from paasta_tools.paastaapi.model.deploy_queue import DeployQueue
+from paasta_tools.paastaapi.model.deploy_queue_service_instance import DeployQueueServiceInstance
+from paasta_tools.paastaapi.model.envoy_backend import EnvoyBackend
+from paasta_tools.paastaapi.model.envoy_location import EnvoyLocation
+from paasta_tools.paastaapi.model.envoy_status import EnvoyStatus
+from paasta_tools.paastaapi.model.flink_cluster_overview import FlinkClusterOverview
+from paasta_tools.paastaapi.model.flink_config import FlinkConfig
+from paasta_tools.paastaapi.model.flink_job import FlinkJob
+from paasta_tools.paastaapi.model.flink_job_details import FlinkJobDetails
+from paasta_tools.paastaapi.model.flink_jobs import FlinkJobs
+from paasta_tools.paastaapi.model.float_and_error import FloatAndError
+from paasta_tools.paastaapi.model.hpa_metric import HPAMetric
+from paasta_tools.paastaapi.model.inline_object import InlineObject
+from paasta_tools.paastaapi.model.inline_response200 import InlineResponse200
+from paasta_tools.paastaapi.model.inline_response2001 import InlineResponse2001
+from paasta_tools.paastaapi.model.instance_bounce_status import InstanceBounceStatus
+from paasta_tools.paastaapi.model.instance_mesh_status import InstanceMeshStatus
+from paasta_tools.paastaapi.model.instance_status import InstanceStatus
+from paasta_tools.paastaapi.model.instance_status_adhoc import InstanceStatusAdhoc
+from paasta_tools.paastaapi.model.instance_status_cassandracluster import InstanceStatusCassandracluster
+from paasta_tools.paastaapi.model.instance_status_flink import InstanceStatusFlink
+from paasta_tools.paastaapi.model.instance_status_kafkacluster import InstanceStatusKafkacluster
+from paasta_tools.paastaapi.model.instance_status_kubernetes import InstanceStatusKubernetes
+from paasta_tools.paastaapi.model.instance_status_kubernetes_autoscaling_status import InstanceStatusKubernetesAutoscalingStatus
+from paasta_tools.paastaapi.model.instance_status_kubernetes_v2 import InstanceStatusKubernetesV2
+from paasta_tools.paastaapi.model.instance_status_tron import InstanceStatusTron
+from paasta_tools.paastaapi.model.instance_tasks import InstanceTasks
+from paasta_tools.paastaapi.model.integer_and_error import IntegerAndError
+from paasta_tools.paastaapi.model.kubernetes_container import KubernetesContainer
+from paasta_tools.paastaapi.model.kubernetes_container_v2 import KubernetesContainerV2
+from paasta_tools.paastaapi.model.kubernetes_healthcheck import KubernetesHealthcheck
+from paasta_tools.paastaapi.model.kubernetes_pod import KubernetesPod
+from paasta_tools.paastaapi.model.kubernetes_pod_event import KubernetesPodEvent
+from paasta_tools.paastaapi.model.kubernetes_pod_v2 import KubernetesPodV2
+from paasta_tools.paastaapi.model.kubernetes_replica_set import KubernetesReplicaSet
+from paasta_tools.paastaapi.model.kubernetes_version import KubernetesVersion
+from paasta_tools.paastaapi.model.remote_run_outcome import RemoteRunOutcome
+from paasta_tools.paastaapi.model.remote_run_start import RemoteRunStart
+from paasta_tools.paastaapi.model.remote_run_stop import RemoteRunStop
+from paasta_tools.paastaapi.model.remote_run_token import RemoteRunToken
+from paasta_tools.paastaapi.model.resource import Resource
+from paasta_tools.paastaapi.model.resource_item import ResourceItem
+from paasta_tools.paastaapi.model.resource_value import ResourceValue
+from paasta_tools.paastaapi.model.smartstack_backend import SmartstackBackend
+from paasta_tools.paastaapi.model.smartstack_location import SmartstackLocation
+from paasta_tools.paastaapi.model.smartstack_status import SmartstackStatus
+from paasta_tools.paastaapi.model.task_tail_lines import TaskTailLines

paasta_tools/paastaapi/rest.py

@@ -0,0 +1,287 @@
+# coding: utf-8
+
+"""
+    Paasta API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 1.2.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import io
+import json
+import logging
+import re
+import ssl
+from urllib.parse import urlencode
+
+import certifi
+import urllib3
+
+from paasta_tools.paastaapi.exceptions import ApiException, ApiValueError
+
+
+logger = logging.getLogger(__name__)
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp):
+        self.urllib3_response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = resp.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.urllib3_response.getheaders()
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.urllib3_response.getheader(name, default)
+
+
+class RESTClientObject(object):
+
+    def __init__(self, configuration, pools_size=4, maxsize=None):
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # maxsize is the number of requests to host that are allowed in parallel  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        # ca_certs
+        if configuration.ssl_ca_cert:
+            ca_certs = configuration.ssl_ca_cert
+        else:
+            # if not set certificate file, use Mozilla's root certificates.
+            ca_certs = certifi.where()
+
+        addition_pool_args = {}
+        if configuration.assert_hostname is not None:
+            addition_pool_args['assert_hostname'] = configuration.assert_hostname  # noqa: E501
+
+        if configuration.retries is not None:
+            addition_pool_args['retries'] = configuration.retries
+
+        if maxsize is None:
+            if configuration.connection_pool_maxsize is not None:
+                maxsize = configuration.connection_pool_maxsize
+            else:
+                maxsize = 4
+
+        # https pool manager
+        if configuration.proxy:
+            self.pool_manager = urllib3.ProxyManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=ca_certs,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                proxy_url=configuration.proxy,
+                proxy_headers=configuration.proxy_headers,
+                **addition_pool_args
+            )
+        else:
+            self.pool_manager = urllib3.PoolManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=ca_certs,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                **addition_pool_args
+            )
+
+    def request(self, method, url, query_params=None, headers=None,
+                body=None, post_params=None, _preload_content=True,
+                _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param query_params: query parameters in the url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT',
+                          'PATCH', 'OPTIONS']
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):  # noqa: E501,F821
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (isinstance(_request_timeout, tuple) and
+                  len(_request_timeout) == 2):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0], read=_request_timeout[1])
+
+        if 'Content-Type' not in headers:
+            headers['Content-Type'] = 'application/json'
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+                if query_params:
+                    url += '?' + urlencode(query_params)
+                if re.search('json', headers['Content-Type'], re.IGNORECASE):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'application/x-www-form-urlencoded':  # noqa: E501
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                # Pass a `string` parameter directly in the body to support
+                # other content types than Json when `body` argument is
+                # provided in serialized form
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    request_body = body
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(method, url,
+                                              fields=query_params,
+                                              preload_content=_preload_content,
+                                              timeout=timeout,
+                                              headers=headers)
+        except urllib3.exceptions.SSLError as e:
+            msg = "{0}\n{1}".format(type(e).__name__, str(e))
+            raise ApiException(status=0, reason=msg)
+
+        if _preload_content:
+            r = RESTResponse(r)
+
+            # log response body
+            logger.debug("response body: %s", r.data)
+
+        if not 200 <= r.status <= 299:
+            raise ApiException(http_resp=r)
+
+        return r
+
+    def GET(self, url, headers=None, query_params=None, _preload_content=True,
+            _request_timeout=None):
+        return self.request("GET", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def HEAD(self, url, headers=None, query_params=None, _preload_content=True,
+             _request_timeout=None):
+        return self.request("HEAD", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def OPTIONS(self, url, headers=None, query_params=None, post_params=None,
+                body=None, _preload_content=True, _request_timeout=None):
+        return self.request("OPTIONS", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def DELETE(self, url, headers=None, query_params=None, body=None,
+               _preload_content=True, _request_timeout=None):
+        return self.request("DELETE", url,
+                            headers=headers,
+                            query_params=query_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def POST(self, url, headers=None, query_params=None, post_params=None,
+             body=None, _preload_content=True, _request_timeout=None):
+        return self.request("POST", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def PUT(self, url, headers=None, query_params=None, post_params=None,
+            body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PUT", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def PATCH(self, url, headers=None, query_params=None, post_params=None,
+              body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PATCH", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)

paasta_tools/prune_completed_pods.py

@@ -0,0 +1,220 @@
+import argparse
+import logging
+import sys
+from datetime import datetime
+from typing import Sequence
+
+from dateutil.tz import tzutc
+from kubernetes.client import V1Pod
+
+from paasta_tools.kubernetes_tools import get_all_pods
+from paasta_tools.kubernetes_tools import get_pod_condition
+from paasta_tools.kubernetes_tools import is_pod_completed
+from paasta_tools.kubernetes_tools import KubeClient
+
+log = logging.getLogger(__name__)
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(
+        description="Terminates completed pods based on namespace and minutes since completion"
+    )
+    parser.add_argument(
+        "-n",
+        "--namespace",
+        help="Namespace of the pods to terminate from",
+        required=True,
+    )
+    parser.add_argument(
+        "-m",
+        "--minutes",
+        help="Minutes since the pods' completion. Terminates pods based on time since completion.",
+        required=True,
+        type=int,
+    )
+    parser.add_argument(
+        "-e",
+        "--error-minutes",
+        help="Minutes since the pod encountered an error. Terminates pods based on time since failure.",
+        # this can't be required until we've rolled this out everywhere AND have updated all the callsites
+        required=False,
+        type=int,
+    )
+    parser.add_argument(
+        "-p",
+        "--pending-minutes",
+        help="Minutes since the pod was scheduled. Terminates pods whose phase is Pending based on time since scheduled. Including pod status Pending/ContainerCreating/Terminating.",
+        required=False,
+        type=int,
+    )
+    parser.add_argument(
+        "--dry-run",
+        dest="dry_run",
+        action="store_true",
+        help="Print pods to be terminated, instead of terminating them",
+    )
+    parser.add_argument(
+        "-v", "--verbose", dest="verbose", action="store_true", default=False
+    )
+    args = parser.parse_args()
+    return args
+
+
+def setup_logging(verbose):
+    level = logging.DEBUG if verbose else logging.WARNING
+    logging.basicConfig(level=level)
+    # Remove pod metadata logs
+    logging.getLogger("kubernetes.client.rest").setLevel(logging.ERROR)
+
+
+def __condition_transition_longer_than_threshold(
+    pod: V1Pod, condition: str, threshold: int
+) -> bool:
+    time_finished = get_pod_condition(pod, condition).last_transition_time
+    time_now = datetime.now(tzutc())
+
+    # convert total seconds since completion to minutes
+    since_minutes = (time_now - time_finished).total_seconds() / 60
+
+    return since_minutes > threshold
+
+
+def _completed_longer_than_threshold(pod: V1Pod, threshold: int) -> bool:
+    return __condition_transition_longer_than_threshold(
+        pod, "ContainersReady", threshold
+    )
+
+
+def _scheduled_longer_than_threshold(pod: V1Pod, threshold: int) -> bool:
+    return __condition_transition_longer_than_threshold(pod, "PodScheduled", threshold)
+
+
+def terminate_pods(pods: Sequence[V1Pod], kube_client) -> tuple:
+    successes = []
+    errors = []
+
+    for pod in pods:
+        try:
+            kube_client.core.delete_namespaced_pod(
+                name=pod.metadata.name,
+                namespace=pod.metadata.namespace,
+                grace_period_seconds=0,
+                propagation_policy="Background",
+            )
+            successes.append(pod.metadata.name)
+        except Exception as e:
+            errors.append((pod.metadata.name, e))
+
+    return (successes, errors)
+
+
+def main():
+    args = parse_args()
+    setup_logging(args.verbose)
+
+    kube_client = KubeClient()
+    pods = get_all_pods(kube_client, args.namespace)
+
+    allowed_uptime_minutes = args.minutes
+    allowed_error_minutes = args.error_minutes
+    allowed_pending_minues = args.pending_minutes
+
+    completed_pods = []
+    errored_pods = []
+    pending_pods = []
+
+    for pod in pods:
+        if is_pod_completed(pod) and _completed_longer_than_threshold(
+            pod, allowed_uptime_minutes
+        ):
+            completed_pods.append(pod)
+        elif (
+            # this is currently optional
+            allowed_error_minutes is not None
+            # there's no direct way to get what type of "bad" state these Pods ended up
+            # (kubectl looks at phase and then container statuses to give something descriptive)
+            # but, in the end, we really just care that a Pod is in a Failed phase
+            and pod.status.phase == "Failed"
+        ):
+            try:
+                # and that said Pod has been around for a while (generally longer than we'd leave
+                # Pods that exited sucessfully)
+                # NOTE: we do this in a try-except since we're intermittently seeing pods in an error
+                # state without a PodScheduled condition (even though that should be impossible)
+                # this is not ideal, but its fine to skip these since this isn't a critical process
+                if _scheduled_longer_than_threshold(pod, allowed_error_minutes):
+                    errored_pods.append(pod)
+            except AttributeError:
+                log.exception(
+                    f"Unable to check {pod.metadata.name}'s schedule time. Pod status: {pod.status}.'"
+                )
+        elif (
+            # this is currently optional
+            allowed_pending_minues is not None
+            and pod.status.phase == "Pending"
+        ):
+            try:
+                if _scheduled_longer_than_threshold(pod, allowed_pending_minues):
+                    pending_pods.append(pod)
+            except AttributeError:
+                log.exception(
+                    f"Unable to check {pod.metadata.name}'s schedule time. Pod status: {pod.status}.'"
+                )
+
+    if not (completed_pods or errored_pods or pending_pods):
+        log.debug("No pods to terminate.")
+        sys.exit(0)
+
+    if args.dry_run:
+        log.debug(
+            "Dry run would have terminated the following completed pods:\n "
+            + "\n ".join([pod.metadata.name for pod in completed_pods])
+        )
+        log.debug(
+            "Dry run would have terminated the following errored pods:\n "
+            + "\n ".join([pod.metadata.name for pod in errored_pods])
+        )
+        log.debug(
+            "Dry run would have terminated the following pending pods:\n "
+            + "\n ".join([pod.metadata.name for pod in pending_pods])
+        )
+        sys.exit(0)
+
+    completed_successes, completed_errors = terminate_pods(completed_pods, kube_client)
+    errored_successes, errored_errors = terminate_pods(errored_pods, kube_client)
+    pending_successes, pending_errors = terminate_pods(pending_pods, kube_client)
+
+    successes = {
+        "completed": completed_successes,
+        "errored": errored_successes,
+        "pending": pending_successes,
+    }
+    errors = {
+        "completed": completed_errors,
+        "errored": errored_errors,
+        "pending": pending_errors,
+    }
+
+    for typ, pod_names in successes.items():
+        if pod_names:
+            log.debug(
+                f"Successfully terminated the following {typ} pods:\n"
+                + "\n ".join(pod_names)
+            )
+
+    # we've only really seen this fail recently due to the k8s API being flaky and returning
+    # 404s for Pods that its returning to us when we get all Pods, so we just print the error
+    # here for now and don't exit with a non-zero exit code since, again, this isn't a critical
+    # process
+    for typ, pod_names_and_errors in errors.items():
+        if pod_names_and_errors:
+            log.error(
+                f"Failed to terminate the following {typ} pods:\n"
+                + "\n  ".join(
+                    f"{pod_name}: {error}" for pod_name, error in pod_names_and_errors
+                )
+            )
+
+
+if __name__ == "__main__":
+    main()

paasta_tools/puppet_service_tools.py

@@ -0,0 +1,59 @@
+import json
+import os
+from typing import Dict
+from typing import List
+from typing import Tuple
+
+import service_configuration_lib
+
+from paasta_tools.long_running_service_tools import load_service_namespace_config
+from paasta_tools.long_running_service_tools import ServiceNamespaceConfig
+from paasta_tools.utils import compose_job_id
+
+PUPPET_SERVICE_DIR = "/etc/nerve/puppet_services.d"
+
+
+def get_puppet_services_that_run_here() -> Dict[str, List[str]]:
+    # find all files in the PUPPET_SERVICE_DIR, but discard broken symlinks
+    # this allows us to (de)register services on a machine by
+    # breaking/healing a symlink placed by Puppet.
+    puppet_service_dir_services = {}
+    if os.path.exists(PUPPET_SERVICE_DIR):
+        for service_name in os.listdir(PUPPET_SERVICE_DIR):
+            if not os.path.exists(os.path.join(PUPPET_SERVICE_DIR, service_name)):
+                continue
+            with open(os.path.join(PUPPET_SERVICE_DIR, service_name)) as f:
+                puppet_service_data = json.load(f)
+                puppet_service_dir_services[service_name] = puppet_service_data[
+                    "namespaces"
+                ]
+
+    return puppet_service_dir_services
+
+
+def get_puppet_services_running_here_for_nerve(
+    soa_dir: str,
+) -> List[Tuple[str, ServiceNamespaceConfig]]:
+    puppet_services = []
+    for service, namespaces in sorted(get_puppet_services_that_run_here().items()):
+        for namespace in namespaces:
+            puppet_services.append(
+                _namespaced_get_classic_service_information_for_nerve(
+                    service, namespace, soa_dir
+                )
+            )
+    return puppet_services
+
+
+def _namespaced_get_classic_service_information_for_nerve(
+    name: str, namespace: str, soa_dir: str
+) -> Tuple[str, ServiceNamespaceConfig]:
+    nerve_dict = load_service_namespace_config(name, namespace, soa_dir)
+    port_file = os.path.join(soa_dir, name, "port")
+    # If the namespace defines a port, prefer that, otherwise use the
+    # service wide port file.
+    nerve_dict["port"] = nerve_dict.get(
+        "port", None
+    ) or service_configuration_lib.read_port(port_file)
+    nerve_name = compose_job_id(name, namespace)
+    return (nerve_name, nerve_dict)

paasta_tools/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561.  The paasta package uses inline types.