Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(api-server): Enable charm configuration of launcher and driver images #455

Merged
merged 6 commits into from
May 22, 2024
Merged

feat(api-server): Enable charm configuration of launcher and driver images #455

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eed6cde
feat: Enable charm configuration of launcher and driver images
orfeas-k May 9, 2024
3dce09d
tests: Add unit tests for config
orfeas-k May 9, 2024
1ab2b33
fix lint
orfeas-k May 9, 2024
22dddb4
Add default value in config.yaml and update get-images.sh script
orfeas-k May 10, 2024
f9bc4c1
update unit tests
orfeas-k May 10, 2024
cc9980b
Merge branch 'main' into kf-5637-kfp-api-images-configuration
orfeas-k May 22, 2024
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
8 changes: 8 additions & 0 deletions charms/kfp-api/config.yaml
View file
Open in desktop
orfeas-k marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,11 @@ options:
type: string
default: "mlpipeline"
description: Default name of object storage bucket.
launcher-image:
type: string
default: ""
description: Launcher image used during a pipeline's steps.
driver-image:
type: string
default: ""
description: Driver image used during a pipeline's steps.
2 changes: 2 additions & 0 deletions charms/kfp-api/src/charm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,8 @@ def _generate_environment(self) -> dict:
"OBJECTSTORECONFIG_HOST": f"{object_storage['service']}.{object_storage['namespace']}",
"OBJECTSTORECONFIG_PORT": str(object_storage["port"]),
"OBJECTSTORECONFIG_REGION": "",
"V2_LAUNCHER_IMAGE": self.model.config["launcher-image"],
"V2_DRIVER_IMAGE": self.model.config["driver-image"],
orfeas-k marked this conversation as resolved.
Show resolved Hide resolved
}

return env_vars
Expand Down
141 changes: 92 additions & 49 deletions charms/kfp-api/tests/unit/test_operator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,61 +352,18 @@ def test_install_with_all_inputs_and_pebble(
):
"""Test complete installation with all required relations and verify pebble layer."""
harness.set_leader(True)
kfpapi_relation_name = "kfp-api"
model_name = "kubeflow"
service_port = "8888"
harness.set_model_name(model_name)
harness.update_config({"http-port": service_port})

# Set up required relations

# mysql relation
mysql_data = {
"database": "database",
"host": "host",
"root_password": "root_password",
"port": "port",
}
mysql_rel_id = harness.add_relation("mysql", "mysql-provider")
harness.add_relation_unit(mysql_rel_id, "mysql-provider/0")
harness.update_relation_data(mysql_rel_id, "mysql-provider/0", mysql_data)

# object storage relation
objectstorage_data = {
"access-key": "access-key",
"namespace": "namespace",
"port": 1234,
"secret-key": "secret-key",
"secure": True,
"service": "service",
}
objectstorage_data_dict = {
"_supported_versions": "- v1",
"data": yaml.dump(objectstorage_data),
}
objectstorage_rel_id = harness.add_relation("object-storage", "storage-provider")
harness.add_relation_unit(objectstorage_rel_id, "storage-provider/0")
harness.update_relation_data(
objectstorage_rel_id, "storage-provider", objectstorage_data_dict
)

# kfp-viz relation
kfp_viz_data = {
"service-name": "viz-service",
"service-port": "1234",
}
kfp_viz_data_dict = {"_supported_versions": "- v1", "data": yaml.dump(kfp_viz_data)}
kfp_viz_id = harness.add_relation("kfp-viz", "kfp-viz")
harness.add_relation_unit(kfp_viz_id, "kfp-viz/0")
harness.update_relation_data(kfp_viz_id, "kfp-viz", kfp_viz_data_dict)

# example kfp-api provider relation
kfpapi_data = {
"_supported_versions": "- v1",
}
kfpapi_rel_id = harness.add_relation(kfpapi_relation_name, "kfp-api-subscriber")
harness.add_relation_unit(kfpapi_rel_id, "kfp-api-subscriber/0")
harness.update_relation_data(kfpapi_rel_id, "kfp-api-subscriber", kfpapi_data)
(
mysql_data,
objectstorage_data,
kfp_viz_data,
kfpapi_rel_id,
) = self.setup_required_relations(harness)

harness.begin_with_initial_hooks()
harness.container_pebble_ready(KFP_API_CONTAINER_NAME)
Expand Down Expand Up @@ -483,12 +440,45 @@ def test_install_with_all_inputs_and_pebble(
),
"OBJECTSTORECONFIG_PORT": str(objectstorage_data["port"]),
"OBJECTSTORECONFIG_REGION": "",
"V2_LAUNCHER_IMAGE": "",
"V2_DRIVER_IMAGE": "",
}
test_env = pebble_plan_info["services"][KFP_API_SERVICE_NAME]["environment"]

assert test_env == expected_env
assert model_name == test_env["POD_NAMESPACE"]

@patch("charm.KubernetesServicePatch", lambda x, y: None)
@patch("charm.KfpApiOperator.k8s_resource_handler")
def test_launcher_driver_images_config(
self,
k8s_resource_handler: MagicMock,
harness: Harness,
):
"""Test complete installation with all required relations and verify pebble layer."""
harness.set_leader(True)
model_name = "kubeflow"
service_port = "8888"
harness.set_model_name(model_name)
harness.update_config({"http-port": service_port})
harness.update_config({"launcher-image": "fake-launcher-image"})
harness.update_config({"driver-image": "fake-driver-image"})

# Set up required relations
self.setup_required_relations(harness)

harness.begin_with_initial_hooks()
harness.container_pebble_ready(KFP_API_CONTAINER_NAME)

# test Pebble
pebble_plan = harness.get_container_pebble_plan(KFP_API_CONTAINER_NAME)
pebble_plan_info = pebble_plan.to_dict()
test_env = pebble_plan_info["services"][KFP_API_SERVICE_NAME]["environment"]

assert test_env["V2_LAUNCHER_IMAGE"] == "fake-launcher-image"
assert test_env["V2_DRIVER_IMAGE"] == "fake-driver-image"
assert model_name == test_env["POD_NAMESPACE"]

@patch("charm.KubernetesServicePatch", lambda x, y: None)
@patch("charm.KfpApiOperator._apply_k8s_resources")
@patch("charm.KfpApiOperator._check_status")
Expand Down Expand Up @@ -728,3 +718,56 @@ def return_krh_with_mocked_lightkube(*args, **kwargs):
)
assert len(minio_service.spec.ports) == 1
assert minio_service.spec.ports[0].targetPort == objectstorage_data["port"]

def setup_required_relations(self, harness: Harness):
kfpapi_relation_name = "kfp-api"

# mysql relation
mysql_data = {
"database": "database",
"host": "host",
"root_password": "root_password",
"port": "port",
}
mysql_rel_id = harness.add_relation("mysql", "mysql-provider")
harness.add_relation_unit(mysql_rel_id, "mysql-provider/0")
harness.update_relation_data(mysql_rel_id, "mysql-provider/0", mysql_data)

# object storage relation
objectstorage_data = {
"access-key": "access-key",
"namespace": "namespace",
"port": 1234,
"secret-key": "secret-key",
"secure": True,
"service": "service",
}
objectstorage_data_dict = {
"_supported_versions": "- v1",
"data": yaml.dump(objectstorage_data),
}
objectstorage_rel_id = harness.add_relation("object-storage", "storage-provider")
harness.add_relation_unit(objectstorage_rel_id, "storage-provider/0")
harness.update_relation_data(
objectstorage_rel_id, "storage-provider", objectstorage_data_dict
)

# kfp-viz relation
kfp_viz_data = {
"service-name": "viz-service",
"service-port": "1234",
}
kfp_viz_data_dict = {"_supported_versions": "- v1", "data": yaml.dump(kfp_viz_data)}
kfp_viz_id = harness.add_relation("kfp-viz", "kfp-viz")
harness.add_relation_unit(kfp_viz_id, "kfp-viz/0")
harness.update_relation_data(kfp_viz_id, "kfp-viz", kfp_viz_data_dict)

# example kfp-api provider relation
kfpapi_data = {
"_supported_versions": "- v1",
}
kfpapi_rel_id = harness.add_relation(kfpapi_relation_name, "kfp-api-subscriber")
harness.add_relation_unit(kfpapi_rel_id, "kfp-api-subscriber/0")
harness.update_relation_data(kfpapi_rel_id, "kfp-api-subscriber", kfpapi_data)

return mysql_data, objectstorage_data, kfp_viz_data, kfpapi_rel_id
Loading