Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/kustomize-overlays-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,13 @@ jobs:
# convention (sources come from the base
# image, not the workspace).
# 5. upload-k8s-image -> loads the now-built kubernetes-variant
# image into every kind node, so kubelet
# image into the kind node, so kubelet
# can resolve the chart's image reference
# without hitting ghcr (which is private).
# 6. deploy-airflow
# 7. smoke-test-overlay -> renders the overlay, auto-preloads the
# overlay's own images into the kind
# nodes (no per-overlay images list
# node (no per-overlay images list
# needed - discovery walks the rendered
# manifest), applies, walks the
# STATUS.yaml verify: block with
Expand All @@ -124,7 +124,7 @@ jobs:
run: breeze k8s configure-cluster
- name: "Build kubernetes-variant image on top of the restored PROD image"
run: breeze k8s build-k8s-image --no-copy-local-sources
- name: "Upload kubernetes-variant image to kind nodes"
- name: "Upload kubernetes-variant image to the kind node"
run: breeze k8s upload-k8s-image
- name: "Deploy Airflow chart"
run: breeze k8s deploy-airflow --executor CeleryExecutor
Expand Down
7 changes: 1 addition & 6 deletions contributing-docs/testing/k8s_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,6 @@ The typical session for tests with Kubernetes looks like follows:
apiServerPort: 48366
nodes:
- role: control-plane
- role: worker
extraPortMappings:
- containerPort: 30007
hostPort: 18150
Expand All @@ -290,12 +289,11 @@ The typical session for tests with Kubernetes looks like follows:

Creating cluster "airflow-python-3.11-v1.24.2" ...
✓ Ensuring node image (kindest/node:v1.24.2) 🖼
✓ Preparing nodes 📦 📦
✓ Preparing nodes 📦
✓ Writing configuration 📜
✓ Starting control-plane 🕹️
✓ Installing CNI 🔌
✓ Installing StorageClass 💾
✓ Joining worker nodes 🚜
Set kubectl context to "kind-airflow-python-3.11-v1.24.2"
You can now use your cluster with:

Expand Down Expand Up @@ -377,11 +375,9 @@ The typical session for tests with Kubernetes looks like follows:
coredns-6d4b75cb6d-rwp9d 1/1 Running 0 71s
coredns-6d4b75cb6d-vqnrc 1/1 Running 0 71s
etcd-airflow-python-3.11-v1.24.2-control-plane 1/1 Running 0 84s
kindnet-ckc8l 1/1 Running 0 69s
kindnet-qqt8k 1/1 Running 0 71s
kube-apiserver-airflow-python-3.11-v1.24.2-control-plane 1/1 Running 0 84s
kube-controller-manager-airflow-python-3.11-v1.24.2-control-plane 1/1 Running 0 84s
kube-proxy-6g7hn 1/1 Running 0 69s
kube-proxy-dwfvp 1/1 Running 0 71s
kube-scheduler-airflow-python-3.11-v1.24.2-control-plane 1/1 Running 0 84s

Expand Down Expand Up @@ -446,7 +442,6 @@ The typical session for tests with Kubernetes looks like follows:
Good version of helm installed: 3.9.2 in /Users/jarek/IdeaProjects/airflow/kubernetes-tests/.venv/bin
Stable repo is already added
Uploading Airflow image ghcr.io/apache/airflow/main/prod/python3.11-kubernetes to cluster airflow-python-3.11-v1.24.2
Image: "ghcr.io/apache/airflow/main/prod/python3.11-kubernetes" with ID "sha256:fb6195f7c2c2ad97788a563a3fe9420bf3576c85575378d642cd7985aff97412" not yet present on node "airflow-python-3.11-v1.24.2-worker", loading...
Image: "ghcr.io/apache/airflow/main/prod/python3.11-kubernetes" with ID "sha256:fb6195f7c2c2ad97788a563a3fe9420bf3576c85575378d642cd7985aff97412" not yet present on node "airflow-python-3.11-v1.24.2-control-plane", loading...

NEXT STEP: You might now deploy Airflow by:
Expand Down
18 changes: 17 additions & 1 deletion dev/breeze/src/airflow_breeze/utils/kubernetes_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -402,12 +402,28 @@ def set_random_cluster_ports(python: str, kubernetes_version: str, output: Outpu
get_console(output=output).print("\n")


# Must match containerPort in scripts/ci/kubernetes/kind-cluster-conf.yaml and
# nodePort in scripts/ci/kubernetes/nodeport.yaml.
FORWARDED_NODE_PORT = 30007
Comment thread
aaron-y-chen marked this conversation as resolved.


def _extract_forwarded_host_port(conf: dict[str, Any]) -> int:
for node in conf["nodes"]:
for port_mapping in node.get("extraPortMappings", []):
if port_mapping["containerPort"] == FORWARDED_NODE_PORT:
return port_mapping["hostPort"]
raise ValueError(
f"No node in the kind cluster config has an extraPortMappings entry for "
f"containerPort {FORWARDED_NODE_PORT}. Delete and recreate the cluster."
)


def get_kubernetes_port_numbers(python: str, kubernetes_version: str) -> tuple[int, int]:
conf = _get_kind_cluster_config_content(python=python, kubernetes_version=kubernetes_version)
if not conf:
return 0, 0
k8s_api_server_port = conf["networking"]["apiServerPort"]
api_server_port = conf["nodes"][1]["extraPortMappings"][0]["hostPort"]
api_server_port = _extract_forwarded_host_port(conf)
return k8s_api_server_port, api_server_port


Expand Down
109 changes: 109 additions & 0 deletions dev/breeze/tests/test_kubernetes_utils.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

from __future__ import annotations

from unittest.mock import patch

import pytest
import yaml

from airflow_breeze.utils.kubernetes_utils import FORWARDED_NODE_PORT, get_kubernetes_port_numbers
from airflow_breeze.utils.path_utils import AIRFLOW_ROOT_PATH

KUBERNETES_CI_PATH = AIRFLOW_ROOT_PATH / "scripts" / "ci" / "kubernetes"

SINGLE_NODE_CONFIG = """\
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
networking:
ipFamily: ipv4
apiServerAddress: "127.0.0.1"
apiServerPort: 48366
nodes:
- role: control-plane
extraPortMappings:
- containerPort: 30007
hostPort: 18150
listenAddress: "127.0.0.1"
protocol: TCP
"""

# Rendered config of a cluster created before the switch to single-node clusters —
# port extraction must keep working for clusters that already exist on disk.
LEGACY_TWO_NODE_CONFIG = """\
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
networking:
ipFamily: ipv4
apiServerAddress: "127.0.0.1"
apiServerPort: 48366
nodes:
- role: control-plane
- role: worker
extraPortMappings:
- containerPort: 30007
hostPort: 18150
listenAddress: "127.0.0.1"
protocol: TCP
"""

NO_FORWARDED_PORT_CONFIG = """\
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
networking:
ipFamily: ipv4
apiServerAddress: "127.0.0.1"
apiServerPort: 48366
nodes:
- role: control-plane
"""


@pytest.mark.parametrize(
"config", [SINGLE_NODE_CONFIG, LEGACY_TWO_NODE_CONFIG], ids=["single-node", "legacy-two-node"]
)
@patch("airflow_breeze.utils.kubernetes_utils._get_kind_cluster_config_content", autospec=True)
def test_get_kubernetes_port_numbers_extracts_ports_from_any_node(mock_get_content, config):
mock_get_content.return_value = yaml.safe_load(config)
assert get_kubernetes_port_numbers(python="3.10", kubernetes_version="v1.30.13") == (48366, 18150)


@patch("airflow_breeze.utils.kubernetes_utils._get_kind_cluster_config_content", autospec=True)
def test_get_kubernetes_port_numbers_raises_when_forwarded_port_mapping_is_missing(mock_get_content):
mock_get_content.return_value = yaml.safe_load(NO_FORWARDED_PORT_CONFIG)
with pytest.raises(ValueError, match="extraPortMappings"):
get_kubernetes_port_numbers(python="3.10", kubernetes_version="v1.30.13")


def test_forwarded_node_port_matches_kind_config_and_nodeport_service():
# The template placeholders are not valid YAML scalars, so render them before parsing.
kind_conf = yaml.safe_load(
(KUBERNETES_CI_PATH / "kind-cluster-conf.yaml")
.read_text()
.replace("{{FORWARDED_PORT_NUMBER}}", "18150")
.replace("{{API_SERVER_PORT}}", "48366")
)
container_ports = [
port_mapping["containerPort"]
for node in kind_conf["nodes"]
for port_mapping in node.get("extraPortMappings", [])
]
node_port_service = yaml.safe_load((KUBERNETES_CI_PATH / "nodeport.yaml").read_text())

assert container_ports == [FORWARDED_NODE_PORT]
assert [port["nodePort"] for port in node_port_service["spec"]["ports"]] == [FORWARDED_NODE_PORT]
1 change: 0 additions & 1 deletion scripts/ci/kubernetes/kind-cluster-conf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ networking:
apiServerPort: {{API_SERVER_PORT}}
nodes:
- role: control-plane
- role: worker
extraPortMappings:
- containerPort: 30007
hostPort: {{FORWARDED_PORT_NUMBER}}
Expand Down
Loading