Add proxy support to Kubernetes client configuration in get_client

README.md

@@ -93,6 +93,24 @@ export OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL=<LOG_LEVEL> # can be: "DEBUG", "INFO",
   export OPENSHIFT_PYTHON_WRAPPER_HASH_LOG_DATA="false"
   ```
 
+## Proxy Enablement
+
+This configuration allows the client to route traffic through a specified proxy server.
+It can be enabled via the `use_proxy` argument or environment variable `OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY`.
+
+To enable proxy configuration for the client:
+
+1. Set the `use_proxy` argument to `True` when creating the client or set the environment variable `OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY=<any value>`
+This enables the proxy without requiring the `use_proxy` argument when creating the client.
+
+2. Define either `HTTPS_PROXY` or `HTTP_PROXY` environment variable with your proxy URL:
+```bash
+export HTTPS_PROXY="http://proxy.example.com:8080"
+# or
+export HTTP_PROXY="http://proxy.example.com:8080"
+```
+If neither variable is set when proxy is enabled, a `ValueError` will be raised.
+
 ## Code check
 
 We use pre-commit for code check.

ocp_resources/resource.py

@@ -76,7 +76,11 @@ def _get_api_version(dyn_client: DynamicClient, api_group: str, kind: str) -> st
 
 
 def get_client(
-    config_file: str = "", config_dict: dict[str, Any] | None = None, context: str = "", **kwargs: Any
+    config_file: str = "",
+    config_dict: dict[str, Any] | None = None,
+    use_proxy: bool | None = None,
+    context: str = "",
+    **kwargs: Any,
 ) -> DynamicClient:
     """
     Get a kubernetes client.
@@ -92,6 +96,11 @@ def get_client(
     Args:
         config_file (str): path to a kubeconfig file.
         config_dict (dict): dict with kubeconfig configuration.
+        use_proxy (bool, default=None):
+            - `True`: retrieves HTTPS_PROXY or HTTP_PROXY from OS environment and use it.
+            - `False`: Disables proxy.
+            - `None`: (default): Proxy is determined by the `OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY` environment
+                  variable. non-empty value enables proxy.
         context (str): name of the context to use.
 
     Returns:
@@ -104,6 +113,7 @@ def get_client(
                 config_dict=config_dict, context=context or None, **kwargs
             )
         )
+    client_configuration = kwargs.get("client_configuration", kubernetes.client.Configuration())
     try:
         # Ref: https://github.com/kubernetes-client/python/blob/v26.1.0/kubernetes/base/config/__init__.py
         LOGGER.info("Trying to get client via new_client_from_config")
@@ -112,15 +122,30 @@ def get_client(
         # If `KUBECONFIG` environment variable is set via code, the `KUBE_CONFIG_DEFAULT_LOCATION` will be None since
         # is populated during import which comes before setting the variable in code.
         config_file = config_file or os.environ.get("KUBECONFIG", "~/.kube/config")
+
+        if use_proxy or (use_proxy is None and os.environ.get("OPENSHIFT_PYTHON_WRAPPER_CLIENT_USE_PROXY")):
+            proxy = os.environ.get("HTTPS_PROXY") or os.environ.get("HTTP_PROXY")
+            if not proxy:
+                raise ValueError(
+                    "Proxy configuration is enabled but neither HTTPS_PROXY nor HTTP_PROXY environment variables are set."
+                )
+            if not kwargs.get("client_configuration"):
+                client_configuration.proxy = proxy
+
         return kubernetes.dynamic.DynamicClient(
-            client=kubernetes.config.new_client_from_config(config_file=config_file, context=context or None, **kwargs)
+            client=kubernetes.config.new_client_from_config(
+                config_file=config_file,
+                client_configuration=client_configuration,
+                context=context or None,
+                **kwargs,
+            )
         )
     except MaxRetryError:
         # Ref: https://github.com/kubernetes-client/python/blob/v26.1.0/kubernetes/base/config/incluster_config.py
         LOGGER.info("Trying to get client via incluster_config")
         return kubernetes.dynamic.DynamicClient(
             client=kubernetes.config.incluster_config.load_incluster_config(
-                client_configuration=kwargs.get("client_configuration"),
+                client_configuration=client_configuration,
                 try_refresh_token=kwargs.get("try_refresh_token", True),
             )
         )