graph LR
Kubernetes_YAML_Resource_Creation["Kubernetes YAML Resource Creation"]
Kubernetes_Quantity_Parsing_and_Formatting["Kubernetes Quantity Parsing and Formatting"]
Kubernetes_Duration_Handling["Kubernetes Duration Handling"]
Kubernetes_Dynamic_Client["Kubernetes Dynamic Client"]
Kubernetes_Utility_Test_Suite["Kubernetes Utility Test Suite"]
Kubernetes_YAML_Resource_Creation -- "uses" --> Kubernetes_Dynamic_Client
Kubernetes_Utility_Test_Suite -- "tests" --> Kubernetes_YAML_Resource_Creation
Kubernetes_Utility_Test_Suite -- "tests" --> Kubernetes_Quantity_Parsing_and_Formatting
The Utilities component within the Kubernetes client library provides essential helper functions for common tasks. It encompasses functionalities for parsing and formatting Kubernetes resource quantities, handling time durations according to specific Kubernetes formats, and offering robust methods for creating Kubernetes objects from various input sources like YAML files, directories, or Python dictionaries. This component aims to simplify interactions with the Kubernetes API by abstracting complex data transformations and resource deployment mechanisms.
This component provides high-level functions to create Kubernetes resources from YAML files or Python dictionaries, handling multiple documents and aggregating potential API exceptions during resource creation. It serves as a convenient interface for deploying resources.
Related Classes/Methods:
kubernetes.utils.create_from_yaml.create_from_yaml(99:181)kubernetes.utils.create_from_yaml.create_from_directory(27:96)kubernetes.utils.create_from_yaml.create_from_dict(184:250)kubernetes.utils.create_from_yaml.FailToCreateError(309:324)kubernetes.utils.create_from_yaml.create_from_yaml_single_item(253:306)
This component offers utility functions for parsing and formatting Kubernetes resource quantities (e.g., '100m', '1Gi') into numerical equivalents and vice-versa, ensuring correct interpretation and representation of resource values.
Related Classes/Methods:
kubernetes.utils.quantity(full file reference)kubernetes.utils.quantity.parse_quantity(30:85)kubernetes.utils.quantity.format_quantity(88:142)
This component provides utility functions for handling and converting time durations, which are essential for various time-based operations and configurations within the Kubernetes ecosystem.
Related Classes/Methods:
kubernetes.utils.duration(full file reference)kubernetes.utils.duration.parse_duration(31:80)kubernetes.utils.duration.format_duration(83:174)
This core client component enables dynamic interaction with the Kubernetes API server. It allows for the creation, retrieval, and management of Kubernetes resources based on their kind and API version, including support for advanced features like server-side apply.
Related Classes/Methods:
kubernetes.base.dynamic.client.DynamicClient(72:327)kubernetes.base.dynamic.discovery.Discoverer.get(198:217)kubernetes.client(full file reference)
This component comprises a collection of end-to-end and unit tests specifically designed to validate the functionality of the Kubernetes utility modules, ensuring the correctness of resource creation from various configurations and the accuracy of quantity conversions.
Related Classes/Methods: