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

[Client][API] get control plane version #2874

Merged
merged 4 commits into from
Nov 5, 2024
Merged

[Client][API] get control plane version #2874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5645e31
Gate feature by checking backend version
Future-Outlier Oct 29, 2024
de6eea3
put context in comments or in serialization settings
Future-Outlier Oct 30, 2024
5f112c9
get control plane version and add integration tests
Future-Outlier Oct 30, 2024
5d67ee9
Update Kevin's advice
Future-Outlier Oct 31, 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
14 changes: 14 additions & 0 deletions flytekit/clients/friendly.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
from flyteidl.admin import project_pb2 as _project_pb2
from flyteidl.admin import task_execution_pb2 as _task_execution_pb2
from flyteidl.admin import task_pb2 as _task_pb2
from flyteidl.admin import version_pb2 as _version_pb2
from flyteidl.admin import workflow_attributes_pb2 as _workflow_attributes_pb2
from flyteidl.admin import workflow_pb2 as _workflow_pb2
from flyteidl.core import identifier_pb2 as _identifier_pb2
Expand Down Expand Up @@ -1087,3 +1088,16 @@ def get_download_artifact_signed_url(
expires_in=expires_in_pb,
)
)

def get_control_plane_version(self) -> str:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could we add some comments for it

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes of course thank you!

"""
Retrieve the Control Plane version from Flyteadmin.

This method calls Flyteadmin's GetVersion API to obtain the current version information of the control plane.
The retrieved version can be used to enable or disable specific features based on the Flyteadmin version.

Returns:
str: The version string of the control plane.
"""
version_response = self._stub.GetVersion(_version_pb2.GetVersionRequest(), metadata=self._metadata)
return version_response.control_plane_version.Version
5 changes: 5 additions & 0 deletions tests/flytekit/integration/remote/test_remote.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -762,3 +762,8 @@ def test_register_wf_fast(register):
def test_fetch_active_launchplan_not_found(register):
remote = FlyteRemote(Config.auto(config_file=CONFIG), PROJECT, DOMAIN)
assert remote.fetch_active_launchplan(name="basic.list_float_wf.fake_wf") is None

def test_get_control_plane_version():
client = _SynchronousFlyteClient(PlatformConfig.for_endpoint("localhost:30080", True))
version = client.get_control_plane_version()
assert version == "unknown" or version.startswith("v")
Loading