The Kubernetes API from inside a cluster (Effect's K8sHttpClient).
layer builds a K8sHttpClient on the shared HttpClient: requests
go to https://kubernetes.default.svc/api with the mounted
service-account token (re-read at most once a minute, so a rotated token
is picked up), non-2xx statuses fail and transient failures retry every
five seconds. make_get_pods lists running pods by IP; make_create_pod
creates a pod for the life of a scope and waits until it is ready.
Values#
| Attribute | Type | Description |
|---|---|---|
API_URL | Literal['https://kubernetes.default.svc/api'] = 'https://kubernetes.default.svc/api' | |
TOKEN_PATH | Literal['/var/run/secrets/kubernetes.io/serviceaccount/tokeā¦'] = '/var/run/secrets/kubernetes.io/serviceaccount/token' | |
POD_CONDITION | Bottom[PodCondition, Mapping[str, object], Never, Never] | |
POD_STATUS | Bottom[PodStatus, Mapping[str, object], Never, Never] | |
POD | Bottom[Pod, Mapping[str, object], Never, Never] | |
layer | layer_.Layer[K8sHttpClient, Never, HttpClient | FileSystem] | A |
make_create_pod | Effect[CreatePod, Never, K8sHttpClient] | A function creating a pod (in |
Types#
| Type | Definition | Description |
|---|---|---|
CreatePod | type CreatePod = Callable[[K8sPod], Effect[PodStatus, Never, Scope]] |
Classes#
Functions#
make_get_pods#
make_get_pods(*, namespace=None, label_selector=None) -> Effect[Effect[dict[str, Pod], HttpClientError | SchemaError], Never, K8sHttpClient]A cached (ten seconds) read of the running pods, keyed by pod IP.
| Parameter | Type | Description |
|---|---|---|
namespace | str | None = None | |
label_selector | str | None = None |
Returns Effect[Effect[dict[str, Pod], HttpClientError | SchemaError], Never, K8sHttpClient]
def make_get_pods(
*, namespace: str | None = None, label_selector: str | None = None
) -> Effect[Effect[dict[str, Pod], HttpClientError | SchemaError], Never, K8sHttpClient]:
"""A cached (ten seconds) read of the running pods, keyed by pod IP."""
def body() -> Generator[Effect[Any, Any, Any], Any, Any]:
client = yield from K8sHttpClient()
request = request_.get(
f"/v1/namespaces/{namespace}/pods" if namespace else "/v1/pods"
).set_url_param("fieldSelector", "status.phase=Running")
if label_selector:
request = request.set_url_param("labelSelector", label_selector)
def by_ip(pods: _PodList) -> dict[str, Pod]:
return {pod.status.pod_ip: pod for pod in pods.items}
return (
yield from client.execute(request)
.flat_map(response_.schema_body_json(_PodList))
.map(by_ip)
.tap_cause(lambda cause: log_warning("Failed to fetch pods from Kubernetes API", cause))
.cached_with_ttl("10 seconds")
)
return gen(body)