robusta-api 0.0.0__tar.gz

robusta_api-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2023 Robusta Dev Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

robusta_api-0.0.0/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.1
+Name: robusta-api
+Version: 0.0.0
+Summary: 
+Author: Arik Alon
+Author-email: arikalon1@users.noreply.github.com
+Requires-Python: >=3.8,<3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Provides-Extra: all
+Requires-Dist: CairoSVG (>=2.5.2,<3.0.0) ; extra == "all"
+Requires-Dist: Flask (>=3.0.0,<4.0.0) ; extra == "all"
+Requires-Dist: PyJWT (==2.4.0)
+Requires-Dist: apprise (>=1.5.0,<2.0.0)
+Requires-Dist: attrs (>=23.1.0,<24.0.0)
+Requires-Dist: better-exceptions (>=0.3.3,<0.4.0) ; extra == "all"
+Requires-Dist: bitmath (>=1.3.3.1,<2.0.0.0)
+Requires-Dist: boto3 (==1.28.72)
+Requires-Dist: botocore (==1.31.72)
+Requires-Dist: click-spinner (>=0.1.10,<0.2.0)
+Requires-Dist: colorlog (>=5.0.1,<6.0.0)
+Requires-Dist: croniter (>=1.3.15,<2.0.0)
+Requires-Dist: cryptography (>=42.0.5,<43.0.0)
+Requires-Dist: datadog-api-client (>=1.2.0,<2.0.0) ; extra == "all"
+Requires-Dist: docutils (==0.19)
+Requires-Dist: dpath (>=2.0.5,<3.0.0)
+Requires-Dist: dulwich (==0.20.28) ; extra == "all"
+Requires-Dist: fpdf2 (>=2.7.1,<3.0.0)
+Requires-Dist: grafana-api (>=1.0.3,<2.0.0) ; extra == "all"
+Requires-Dist: hikaru-model-26 (>=1.1.1,<2.0.0)
+Requires-Dist: humanize (>=3.13.1,<4.0.0)
+Requires-Dist: idna (>=3.7)
+Requires-Dist: jinja2 (>=3.1.4)
+Requires-Dist: kafka-python (>=2.0.2,<3.0.0) ; extra == "all"
+Requires-Dist: kubernetes (>=26.1.0,<27.0.0)
+Requires-Dist: markdown2 (>=2.4.2,<3.0.0)
+Requires-Dist: opsgenie-sdk (>=2.1.5,<3.0.0)
+Requires-Dist: poetry-core (==1.1.0a7) ; extra == "all"
+Requires-Dist: prometheus-client (>=0.12.0,<0.13.0)
+Requires-Dist: prometrix (==0.1.16)
+Requires-Dist: pydantic (>=1.8.1,<2.0.0)
+Requires-Dist: pydash (==8.0.0)
+Requires-Dist: pymsteams (>=0.1.16,<0.2.0)
+Requires-Dist: pytz (>=2021.3,<2022.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: rocketchat-api (>=1.30.0,<2.0.0)
+Requires-Dist: sentry-sdk (>=1.5.2,<2.0.0) ; extra == "all"
+Requires-Dist: setuptools (>=68.2.2,<69.0.0)
+Requires-Dist: slack-sdk (>=3.23.0,<4.0.0)
+Requires-Dist: supabase (>=2.4,<3.0) ; extra == "all"
+Requires-Dist: tabulate (>=0.8.10,<0.9.0) ; extra == "all"
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Requires-Dist: typer (>=0.4.1,<0.5.0)
+Requires-Dist: watchdog (>=2.1.0,<3.0.0) ; extra == "all"
+Requires-Dist: watchgod (>=0.7,<0.8)
+Requires-Dist: webexteamssdk (>=1.6.1,<2.0.0)
+Requires-Dist: websocket-client (==1.3.3)
+Requires-Dist: werkzeug (>=3.0.3)

robusta_api-0.0.0/pyproject.toml

@@ -0,0 +1,138 @@
+[tool.poetry]
+name = "robusta-api"
+version = "0.0.0"
+description = ""
+authors = ["Arik Alon <arikalon1@users.noreply.github.com>"]
+packages = [
+    { include = "robusta", from = "src" },
+]
+
+[tool.black]
+line-length = 120
+target-version = ['py37']
+
+[tool.isort]
+line_length = 120
+multi_line_output = 3
+include_trailing_comma = true
+
+
+[tool.poetry.dependencies]
+# Robusta CLI should work on 3.8, but the core code requires 3.9+. Both
+# are known not to work on 3.11. Unfortunately this spec is shared between
+# the CLI and core, so we have to specify 3.8+.
+python = "^3.8, <3.11"
+setuptools = "^68.2.2"
+typer = "^0.4.1"
+colorlog = "^5.0.1"
+pydantic = "^1.8.1"
+kubernetes = "^26.1.0"
+click-spinner = "^0.1.10"
+pymsteams = "^0.1.16"
+idna= { version = ">=3.7", optional = true }
+supabase = "^2.4"
+tabulate = { version = "^0.8.10" }
+slack-sdk = { version = "^3.23.0" }
+Flask = { version = "^3.0.0", optional = true }
+werkzeug = { version = ">=3.0.3", optional = true }
+jinja2 = { version = ">=3.1.4", optional = true }
+grafana-api = { version = "^1.0.3", optional = true }
+watchdog =  { version = "^2.1.0", optional = true }
+better-exceptions = { version =  "^0.3.3", optional = true }
+CairoSVG = { version = "^2.5.2", optional = true }
+kafka-python = { version = "^2.0.2", optional = true }
+datadog-api-client = { version = "^1.2.0", optional = true }
+dpath = "^2.0.5"
+websocket-client = "1.3.3"
+prometheus-client = "^0.12.0"
+pyyaml = "^6.0"
+pytz = "^2021.3"
+poetry-core = "1.1.0a7"
+docutils="0.19"
+sentry-sdk = { version = "^1.5.2", optional = true }
+opsgenie-sdk = "^2.1.5"
+markdown2 = "^2.4.2"
+toml = "^0.10.2"
+watchgod = "^0.7"
+webexteamssdk = "^1.6.1"
+bitmath = "^1.3.3.1"
+croniter = "^1.3.15"
+humanize = "^3.13.1"
+# we're freezing a specific version here because the latest version doesn't have prebuilt wheels on pypi
+# and therefore requires gcc to install which we'd like to avoid
+# this is similar to the issue at https://github.com/dulwich/dulwich/issues/839
+dulwich =  { version = "0.20.28", optional = true }
+cryptography = "^42.0.5"
+PyJWT = "2.4.0"
+fpdf2 = "^2.7.1"
+attrs = "^23.1.0"
+prometrix = "0.1.16"
+hikaru-model-26 = "^1.1.1"
+apprise = "^1.5.0"
+rocketchat-api = "^1.30.0"
+pydash = "8.0.0"
+# The following are added to speed up poetry dependency resolution
+botocore = "1.31.72"
+boto3 = "1.28.72"
+
+[tool.poetry.dev-dependencies]
+pre-commit = "^2.13.0"
+pytest = "^6.2.4"
+python-dotenv = "^0.18.0"
+Sphinx = "6.2.1"
+#furo = "^2021.11.12"
+sphinx-autobuild = "^2021.3.14"
+sphinx-copybutton = "^0.4.0"
+sphinx-design = "0.5.0"
+witchhazel = "^2018.8.23"
+sphinx-autodoc-typehints = "^1.12.0"
+sphinxcontrib-images = "^0.9.4"
+jsonref = "^0.2"
+Pillow = "^10.3.0"
+sphinxcontrib-mermaid = "^0.7.1"
+cssselect = "^1.1.0"
+pygal = "^3.0.0"
+tinycss = "^0.4"
+rsa = "^4.8"
+sphinxcontrib-details-directive = "^0.1.0"
+sphinx-immaterial = { git = "https://github.com/robusta-dev/robusta-immaterial.git" }
+# TODO: Attempt to have different groups (docs, lint, etc) and install them separately
+# Flake8 5.0.4 is the last version that supports Python 3.7
+# As it does not work witn sphynx-immaterial, we need to exclude it from the dev dependencies
+# Please, install it manually if you need to run flake8
+# flake8 = "5.0.4"
+black = "22.3.0"
+mypy = "0.991"
+isort = "5.10.1"
+absolufy-imports = "^0.3.1"
+types-pytz = "^2022.6.0.1"
+types-requests = "^2.28.11.5"
+types-cachetools = "^5.2.1"
+types-PyYAML = "^6.0.0"
+types-click-spinner = "^0.1.10"
+types-toml = "^0.10.2"
+types-tabulate = "^0.8.10"
+
+[tool.poetry.extras]
+all = ["Flask", "grafana-api", "watchdog", "dulwich", "better-exceptions", "CairoSVG", "tabulate", "kafka-python", "prometheus-api-client", "supabase", "datadog-api-client", "pygal", "tinycss", "cssselect", "rsa", "sentry-sdk", "poetry-core"]
+
+[tool.poetry.group.dev.dependencies]
+sphinx-jinja = { git = "https://github.com/robusta-dev/sphinx-jinja.git" }
+sphinx-reredirects = "^0.1.1"
+freezegun = "^1.4.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+# https://github.com/mtkennerly/poetry-dynamic-versioning
+# we can use this in github actions by running `poetry run poetry-dynamic-versioning`
+#[tool.poetry-dynamic-versioning]
+#vcs = "git"
+#pattern = "^(?P<base>\\d+\\.\\d+\\.\\d+)"
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "ignore::DeprecationWarning",
+    "ignore:::slack_sdk"
+]

robusta_api-0.0.0/src/robusta/_version.py

@@ -0,0 +1,2 @@
+# this is updated by .github/workflows/release.yaml
+__version__ = "0.0.0"

robusta_api-0.0.0/src/robusta/api/__init__.py

@@ -0,0 +1,330 @@
+from hikaru.model.rel_1_26 import Container, DaemonSet, Deployment, Pod, ReplicaSet, StatefulSet, Volume
+
+from robusta.core.discovery.discovery import (
+    extract_containers_k8,
+    extract_ready_pods,
+    extract_total_pods,
+    extract_volumes_k8,
+    is_pod_finished,
+    is_release_managed_by_helm,
+    should_report_pod,
+)
+from robusta.core.discovery.resource_names import ResourceNameLister
+from robusta.core.model.base_params import (
+    ActionParams,
+    AlertResourceGraphEnricherParams,
+    BashParams,
+    ChartValuesFormat,
+    CustomGraphEnricherParams,
+    EventEnricherParams,
+    FindingKeyParams,
+    GrafanaAnnotationParams,
+    GrafanaParams,
+    LogEnricherParams,
+    NamedRegexPattern,
+    PodResourceGraphEnricherParams,
+    PodRunningParams,
+    ProcessParams,
+    PrometheusDateRange,
+    PrometheusDuration,
+    PrometheusParams,
+    PrometheusQueryParams,
+    RateLimitParams,
+    ResourceChartItemType,
+    ResourceChartResourceType,
+    ResourceGraphEnricherParams,
+    OOMGraphEnricherParams,
+    OomKillParams,
+    TimedPrometheusParams,
+    VideoEnricherParams,
+)
+from robusta.core.model.env_vars import (
+    CLUSTER_DOMAIN,
+    CLUSTER_STATUS_PERIOD_SEC,
+    CUSTOM_PLAYBOOKS_ROOT,
+    DEFAULT_PLAYBOOKS_PIP_INSTALL,
+    DEFAULT_PLAYBOOKS_ROOT,
+    DEFAULT_TIMEZONE,
+    DISCORD_TABLE_COLUMNS_LIMIT,
+    DISCOVERY_PERIOD_SEC,
+    ENABLE_TELEMETRY,
+    FLOAT_PRECISION_LIMIT,
+    GIT_MAX_RETRIES,
+    GRAFANA_READ_TIMEOUT,
+    GRAFANA_RENDERER_URL,
+    IMAGE_REGISTRY,
+    INCOMING_EVENTS_QUEUE_MAX_SIZE,
+    INCOMING_REQUEST_TIME_WINDOW_SECONDS,
+    INSTALLATION_NAMESPACE,
+    INTERNAL_PLAYBOOKS_ROOT,
+    NUM_EVENT_THREADS,
+    PLAYBOOKS_CONFIG_FILE_PATH,
+    PLAYBOOKS_ROOT,
+    PORT,
+    PRINTED_TABLE_MAX_WIDTH,
+    PROMETHEUS_ENABLED,
+    PROMETHEUS_REQUEST_TIMEOUT_SECONDS,
+    RELAY_EXTERNAL_ACTIONS_URL,
+    RELEASE_NAME,
+    RESOURCE_UPDATES_CACHE_TTL_SEC,
+    ROBUSTA_LOGO_URL,
+    ROBUSTA_TELEMETRY_ENDPOINT,
+    ROBUSTA_UI_DOMAIN,
+    RUNNER_SERVICE_ACCOUNT,
+    RUNNER_VERSION,
+    SEND_ADDITIONAL_TELEMETRY,
+    SERVICE_CACHE_MAX_SIZE,
+    SERVICE_CACHE_TTL_SEC,
+    SLACK_TABLE_COLUMNS_LIMIT,
+    TEAMS_IMAGE_WIDTH,
+    TELEMETRY_PERIODIC_SEC,
+    TRACE_INCOMING_REQUESTS,
+    WEBSOCKET_PING_INTERVAL,
+    WEBSOCKET_PING_TIMEOUT,
+)
+from robusta.core.model.events import ExecutionBaseEvent
+from robusta.core.model.k8s_operation_type import K8sOperationType
+from robusta.core.model.pods import (
+    ContainerResources,
+    PodContainer,
+    PodResources,
+    ResourceAttributes,
+    find_most_recent_oom_killed_container,
+    format_unit,
+    get_oom_kill_time,
+    get_oom_killed_container,
+    is_state_in_oom_status,
+    k8s_memory_factors,
+    pod_limits,
+    pod_most_recent_oom_killed_container,
+    pod_other_requests,
+    pod_requests,
+    pod_resources,
+    pod_restarts,
+)
+from robusta.core.model.services import ContainerInfo, EnvVar, Resources, ServiceConfig, ServiceInfo, VolumeInfo
+from robusta.core.persistency.in_memory import get_persistent_data
+from robusta.core.playbooks.actions_registry import Action, action
+from robusta.core.playbooks.common import get_event_timestamp, get_resource_events, get_resource_events_table
+from robusta.core.playbooks.container_playbook_utils import create_container_graph
+from robusta.core.playbooks.job_utils import CONTROLLER_UID, get_job_all_pods, get_job_latest_pod, get_job_selector
+from robusta.core.playbooks.node_playbook_utils import create_node_graph_enrichment
+from robusta.core.playbooks.pod_utils.crashloop_utils import get_crash_report_enrichments
+from robusta.core.playbooks.pod_utils.imagepull_utils import (
+    get_image_pull_backoff_enrichment,
+    get_image_pull_backoff_container_statuses,
+)
+from robusta.core.playbooks.pod_utils.pending_pod_utils import get_pending_pod_enrichment
+from robusta.core.playbooks.crash_reporter import send_crash_report
+from robusta.core.playbooks.prometheus_enrichment_utils import (
+    XAxisLine,
+    create_chart_from_prometheus_query,
+    create_graph_enrichment,
+    create_resource_enrichment,
+    get_node_internal_ip,
+    run_prometheus_query,
+    run_prometheus_query_range,
+)
+from robusta.core.playbooks.trigger import (
+    BaseTrigger,
+    CustomTriggers,
+    K8sTriggers,
+    PrometheusAlertTriggers,
+    ScheduledTriggers,
+    Trigger,
+)
+from robusta.core.reporting import (
+    BaseBlock,
+    CallbackBlock,
+    CallbackChoice,
+    DividerBlock,
+    Emojis,
+    Enrichment,
+    FileBlock,
+    EmptyFileBlock,
+    Filterable,
+    Finding,
+    FindingSeverity,
+    FindingStatus,
+    FindingSubject,
+    HeaderBlock,
+    JsonBlock,
+    KubernetesDiffBlock,
+    KubernetesFieldsBlock,
+    ListBlock,
+    MarkdownBlock,
+    PrometheusBlock,
+    ScanReportBlock,
+    PopeyeScanReportBlock,
+    KRRScanReportBlock,
+    ScanReportRow,
+    TableBlock,
+    VideoLink,
+)
+
+from robusta.core.reporting.base import EnrichmentType
+from robusta.core.reporting.blocks import GraphBlock
+from robusta.core.reporting.action_requests import (
+    ActionRequestBody,
+    ExternalActionRequest,
+    OutgoingActionRequest,
+    PartialAuth,
+    sign_action_request,
+)
+from robusta.core.reporting.callbacks import ExternalActionRequestBuilder
+from robusta.core.reporting.consts import (
+    EnrichmentAnnotation,
+    FindingAggregationKey,
+    FindingSource,
+    FindingSubjectType,
+    FindingType,
+    ScanType,
+    SlackAnnotations,
+)
+from robusta.core.reporting.custom_rendering import RendererType, charts_style, render_value
+from robusta.core.reporting.finding_subjects import KubeObjFindingSubject, PodFindingSubject
+from robusta.core.schedule.model import (
+    DynamicDelayRepeat,
+    FixedDelayRepeat,
+    JobState,
+    JobStatus,
+    ScheduledJob,
+    SchedulingInfo,
+)
+from robusta.core.playbooks.node_playbook_utils import create_node_graph_enrichment
+from robusta.core.sinks import SinkBase, SinkBaseParams, SinkConfigBase
+from robusta.core.sinks.kafka import KafkaSink, KafkaSinkConfigWrapper, KafkaSinkParams
+from robusta.core.triggers.helm_releases_triggers import HelmReleasesEvent, HelmReleasesTriggerEvent
+from robusta.integrations.argocd.argocd_client import ArgoCDClient
+from robusta.integrations.git.git_repo import ClusterChanges, GitRepo, GitRepoManager, SingleChange
+from robusta.integrations.grafana import Grafana
+from robusta.integrations.kubernetes.api_client_utils import (
+    exec_commands,
+    exec_shell_command,
+    get_pod_logs,
+    list_available_services,
+    parse_kubernetes_datetime,
+    parse_kubernetes_datetime_to_ms,
+    parse_kubernetes_datetime_with_ms,
+    prepare_pod_command,
+    to_kubernetes_name,
+    upload_file,
+    wait_for_pod_status,
+    wait_until,
+    wait_until_job_complete,
+)
+from robusta.integrations.kubernetes.autogenerated.events import (
+    KIND_TO_EVENT_CLASS,
+    LOADERS_MAPPINGS,
+    ClusterRoleAttributes,
+    ClusterRoleBindingAttributes,
+    ClusterRoleBindingChangeEvent,
+    ClusterRoleBindingEvent,
+    ClusterRoleChangeEvent,
+    ClusterRoleEvent,
+    ConfigMapAttributes,
+    ConfigMapChangeEvent,
+    ConfigMapEvent,
+    DaemonSetAttributes,
+    DaemonSetChangeEvent,
+    DaemonSetEvent,
+    DeploymentAttributes,
+    DeploymentChangeEvent,
+    DeploymentEvent,
+    EventAttributes,
+    EventChangeEvent,
+    EventEvent,
+    HorizontalPodAutoscalerAttributes,
+    HorizontalPodAutoscalerChangeEvent,
+    HorizontalPodAutoscalerEvent,
+    JobAttributes,
+    JobChangeEvent,
+    JobEvent,
+    KubernetesAnyChangeEvent,
+    KubernetesResourceEvent,
+    NamespaceAttributes,
+    NamespaceChangeEvent,
+    NamespaceEvent,
+    NodeAttributes,
+    NodeChangeEvent,
+    NodeEvent,
+    PersistentVolumeAttributes,
+    PersistentVolumeChangeEvent,
+    PersistentVolumeEvent,
+    PodAttributes,
+    PodChangeEvent,
+    PodEvent,
+    ReplicaSetAttributes,
+    ReplicaSetChangeEvent,
+    ReplicaSetEvent,
+    ResourceAttributes,
+    ResourceLoader,
+    ServiceAccountAttributes,
+    ServiceAccountChangeEvent,
+    ServiceAccountEvent,
+    ServiceAttributes,
+    ServiceChangeEvent,
+    ServiceEvent,
+    StatefulSetAttributes,
+    StatefulSetChangeEvent,
+    StatefulSetEvent,
+)
+from robusta.integrations.kubernetes.autogenerated.models import VERSION_KIND_TO_MODEL_CLASS, get_api_version
+from robusta.integrations.kubernetes.custom_models import (
+    JobSecret,
+    Process,
+    ProcessList,
+    RegexReplacementStyle,
+    RobustaDeployment,
+    RobustaEvent,
+    RobustaJob,
+    RobustaPod,
+    build_selector_query,
+    does_daemonset_have_toleration,
+    does_node_have_taint,
+    extract_image_list,
+    extract_images,
+    get_images,
+    list_pods_using_selector,
+)
+from robusta.integrations.kubernetes.process_utils import ProcessFinder, ProcessType
+from robusta.integrations.prometheus.models import (
+    SEVERITY_MAP,
+    AlertManagerEvent,
+    PrometheusAlert,
+    PrometheusKubernetesAlert,
+)
+from robusta.integrations.prometheus.utils import (
+    AlertManagerDiscovery,
+    PrometheusDiscovery,
+    ServiceDiscovery,
+    get_prometheus_connect,
+)
+from robusta.integrations.resource_analysis.cpu_analyzer import CpuAnalyzer
+from robusta.integrations.resource_analysis.memory_analyzer import MemoryAnalyzer, pretty_size
+from robusta.integrations.resource_analysis.node_cpu_analyzer import NodeCpuAnalyzer
+from robusta.integrations.scheduled.event import ScheduledExecutionEvent
+from robusta.integrations.scheduled.playbook_scheduler_manager_impl import (
+    PlaybooksSchedulerManagerImpl,
+    ScheduledIntegrationParams,
+)
+from robusta.integrations.scheduled.trigger import DynamicDelayRepeatTrigger, FixedDelayRepeatTrigger
+from robusta.integrations.slack.sender import SlackSender
+from robusta.runner.object_updater import update_item_attr
+from robusta.utils.base64_utils import is_base64_encoded
+from robusta.utils.cluster_provider_discovery import cluster_provider
+from robusta.utils.common import duplicate_without_fields, is_matching_diff
+from robusta.utils.error_codes import ActionException, ErrorCodes
+from robusta.utils.function_hashes import action_hash
+from robusta.utils.parsing import load_json
+from robusta.utils.rate_limiter import RateLimiter
+from robusta.utils.silence_utils import (
+    AddSilenceParams,
+    AlertManagerParams,
+    DeleteSilenceParams,
+    Silence,
+    SilenceOperation,
+    gen_alertmanager_headers,
+    get_alertmanager_url,
+    get_alertmanager_url_path,
+)