kubernetes-client / python

Events

Events in Kubernetes are reports of changes or occurrences within the cluster. They are informative in nature, providing supplemental data about the state of the cluster.

Important Considerations:

  • Events have a limited retention time.
  • The triggers and messages associated with events may evolve over time.
  • Consumers should not rely on the timing of an event with a specific “Reason” to reflect a consistent underlying trigger.
  • The existence of events with a particular “Reason” is not guaranteed.

Types of Events:

Events are categorized by “Type”, which can be one of:

  • Normal: Indicates a routine event.
  • Warning: Indicates a potential issue or warning condition.
  • Other types: New event types may be added in the future.

Event Attributes:

  • Type: The type of event (Normal, Warning, etc.).
  • Reason: A short, machine-readable description of the event’s reason.
  • Message: A human-readable description of the event.
  • Source: Information about the source of the event (e.g., component, host).
  • FirstTimestamp: The time when the event was first observed.
  • LastTimestamp: The time of the last occurrence of the event.
  • Count: The number of times the event has occurred.
  • EventTime: The time when the event was recorded.
  • Series: Information about the series of events.

Example Event:

{
            "kind": "Event",
            "apiVersion": "v1",
            "metadata": {
              "name": "pod-scheduled",
              "namespace": "default"
            },
            "involvedObject": {
              "kind": "Pod",
              "name": "nginx-deployment-64785bd799-6h9h4",
              "uid": "91672478-b916-4774-a9c5-320110a993ff",
              "apiVersion": "v1",
              "resourceVersion": "117993",
              "fieldPath": "spec.nodeName"
            },
            "reason": "Scheduled",
            "message": "Successfully assigned nginx-deployment-64785bd799-6h9h4 to minikube",
            "source": {
              "component": "scheduler"
            },
            "firstTimestamp": "2023-08-01T17:00:00Z",
            "lastTimestamp": "2023-08-01T17:00:00Z",
            "count": 1,
            "eventTime": "2023-08-01T17:00:00Z",
            "type": "Normal",
            "regarding": {
              "kind": "Node",
              "name": "minikube",
              "uid": "b2800024-f80a-4364-ac92-53a4083a4b5a",
              "apiVersion": "v1",
              "resourceVersion": "40980",
              "fieldPath": "spec.nodeName"
            },
            "series": {
              "count": 1,
              "lastObservedTime": "2023-08-01T17:00:00Z"
            }
          }

Accessing Events with Python Client

The Kubernetes Python Client provides methods for working with events:

  • List Events: Retrieves a list of events in a namespace or across the entire cluster.
  • Get Event: Fetches a specific event by name and namespace.
  • Watch Events: Continuously monitors for events and triggers callbacks when events occur.

Code Example (Python Client):

from kubernetes import client, config
          
          # Load kubeconfig
          config.load_kube_config()
          
          # Create an instance of the Events API
          api = client.EventsV1Api()
          
          # List events in the 'default' namespace
          events = api.list_namespaced_event(namespace='default')
          
          # Print event details
          for event in events.items:
              print(f"Event Type: {event.type}")
              print(f"Reason: {event.reason}")
              print(f"Message: {event.message}")
              print("-" * 20)

References:

Top-Level Directory Explanations

doc/ - This directory contains documentation files for the project.

doc/source/ - This directory contains the source files for the documentation.

examples/ - This directory contains example usage of the Kubernetes client library.

examples/watch/ - This directory contains examples of using the watch function to monitor Kubernetes resources.

kubernetes/ - This directory contains the main Kubernetes client library.

kubernetes/base/ - This directory contains the base Kubernetes client library.

kubernetes/base/config/ - This directory contains configuration files for the base library.

kubernetes/base/dynamic/ - This directory contains the dynamic client implementation for the base library.

kubernetes/base/hack/ - This directory contains hack files for the base library.

kubernetes/base/leaderelection/ - This directory contains the leader election implementation for the base library.

kubernetes/base/stream/ - This directory contains the stream implementation for the base library.

kubernetes/base/watch/ - This directory contains the watch implementation for the base library.

kubernetes/client/ - This directory contains the top-level client for the Kubernetes client library.

kubernetes/client/api/ - This directory contains the API definitions for the client library.

kubernetes/client/models/ - This directory contains the data models used by the client library.

kubernetes/e2e_test/ - This directory contains end-to-end tests for the Kubernetes client library.

kubernetes/e2e_test/test_yaml/ - This directory contains YAML files used in the end-to-end tests.

kubernetes/utils/ - This directory contains utility functions for the Kubernetes client library.

scripts/ - This directory contains scripts used in the development and build process.

scripts/util/ - This directory contains utility scripts.