OpenHands/openhands/core/config/kubernetes_config.py
brettstewart 54af9ff3fe
feat(runtime): add kubernetes support (#8814)
Co-authored-by: Corey White <corey.white@ziffdavis.com>
Co-authored-by: luke_schulz <luke.schulz@ziffmedia.com>
2025-06-18 21:25:50 +00:00

87 lines
3.4 KiB
Python

from pydantic import BaseModel, Field, ValidationError
class KubernetesConfig(BaseModel):
"""Configuration for Kubernetes runtime.
Attributes:
namespace: The Kubernetes namespace to use for OpenHands resources
ingress_domain: Domain for ingress resources
pvc_storage_size: Size of the persistent volume claim (e.g. "2Gi")
pvc_storage_class: Storage class for persistent volume claims
resource_cpu_request: CPU request for runtime pods
resource_memory_request: Memory request for runtime pods
resource_memory_limit: Memory limit for runtime pods
image_pull_secret: Optional name of image pull secret for private registries
ingress_tls_secret: Optional name of TLS secret for ingress
node_selector_key: Optional node selector key for pod scheduling
node_selector_val: Optional node selector value for pod scheduling
tolerations_yaml: Optional YAML string defining pod tolerations
"""
namespace: str = Field(
default='default',
description='The Kubernetes namespace to use for OpenHands resources',
)
ingress_domain: str = Field(
default='localhost', description='Domain for ingress resources'
)
pvc_storage_size: str = Field(
default='2Gi', description='Size of the persistent volume claim'
)
pvc_storage_class: str | None = Field(
default=None, description='Storage class for persistent volume claims'
)
resource_cpu_request: str = Field(
default='1', description='CPU request for runtime pods'
)
resource_memory_request: str = Field(
default='1Gi', description='Memory request for runtime pods'
)
resource_memory_limit: str = Field(
default='2Gi', description='Memory limit for runtime pods'
)
image_pull_secret: str | None = Field(
default=None,
description='Optional name of image pull secret for private registries',
)
ingress_tls_secret: str | None = Field(
default=None, description='Optional name of TLS secret for ingress'
)
node_selector_key: str | None = Field(
default=None, description='Optional node selector key for pod scheduling'
)
node_selector_val: str | None = Field(
default=None, description='Optional node selector value for pod scheduling'
)
tolerations_yaml: str | None = Field(
default=None, description='Optional YAML string defining pod tolerations'
)
privileged: bool = Field(
default=False,
description='Run the runtime sandbox container in privileged mode for use with docker-in-docker',
)
model_config = {'extra': 'forbid'}
@classmethod
def from_toml_section(cls, data: dict) -> dict[str, 'KubernetesConfig']:
"""
Create a mapping of KubernetesConfig instances from a toml dictionary representing the [kubernetes] section.
The configuration is built from all keys in data.
Returns:
dict[str, KubernetesConfig]: A mapping where the key "kubernetes" corresponds to the [kubernetes] configuration
"""
# Initialize the result mapping
kubernetes_mapping: dict[str, KubernetesConfig] = {}
# Try to create the configuration instance
try:
kubernetes_mapping['kubernetes'] = cls.model_validate(data)
except ValidationError as e:
raise ValueError(f'Invalid kubernetes configuration: {e}')
return kubernetes_mapping