add project & domain endpoint for FlyteRemote (flyteorg#3108)

* add domain model

Signed-off-by: Jan Fiedler <[email protected]>

* fix docstring domain models

Signed-off-by: Jan Fiedler <[email protected]>

* add get domains endpoint for raw client

Signed-off-by: Jan Fiedler <[email protected]>

* add get domains endpoint to friendly client

Signed-off-by: Jan Fiedler <[email protected]>

* add list_projects_paginated & get_domains to FlyteRemote

Signed-off-by: Jan Fiedler <[email protected]>

* put max_iters decrement in while loop

Signed-off-by: Jan Fiedler <[email protected]>

* rename list_projects_paginated to list_projects & adjust logic accordingly

Signed-off-by: Jan Fiedler <[email protected]>

---------

Signed-off-by: Jan Fiedler <[email protected]>
Signed-off-by: Atharva <[email protected]>

Author: fiedlerNr9

flytekit/clients/friendly.py

@@ -21,6 +21,7 @@
 
 from flytekit.clients.raw import RawSynchronousFlyteClient as _RawSynchronousFlyteClient
 from flytekit.models import common as _common
+from flytekit.models import domain as _domain
 from flytekit.models import execution as _execution
 from flytekit.models import filters as _filters
 from flytekit.models import launch_plan as _launch_plan
@@ -896,6 +897,21 @@ def list_projects_paginated(self, limit=100, token=None, filters=None, sort_by=N
             str(projects.token),
         )
 
+    ####################################################################################################################
+    #
+    #  Domain Endpoints
+    #
+    ####################################################################################################################
+
+    def get_domains(self):
+        """
+        This returns a list of domains.
+
+        :rtype: list[flytekit.models.Domain]
+        """
+        domains = super(SynchronousFlyteClient, self).get_domains()
+        return [_domain.Domain.from_flyte_idl(domain) for domain in domains.domains]
+
     ####################################################################################################################
     #
     #  Matching Attributes Endpoints

flytekit/clients/raw.py

@@ -3,7 +3,7 @@
 import typing
 
 import grpc
-from flyteidl.admin.project_pb2 import ProjectListRequest
+from flyteidl.admin.project_pb2 import GetDomainRequest, ProjectListRequest
 from flyteidl.admin.signal_pb2 import SignalList, SignalListRequest, SignalSetRequest, SignalSetResponse
 from flyteidl.service import admin_pb2_grpc as _admin_service
 from flyteidl.service import dataproxy_pb2 as _dataproxy_pb2
@@ -520,6 +520,21 @@ def update_project(self, project):
         """
         return self._stub.UpdateProject(project, metadata=self._metadata)
 
+    ####################################################################################################################
+    #
+    #  Domain Endpoints
+    #
+    ####################################################################################################################
+
+    def get_domains(self):
+        """
+        This will return a list of domains registered with the Flyte Admin Service
+        :param flyteidl.admin.project_pb2.GetDomainRequest get_domain_request:
+        :rtype: flyteidl.admin.project_pb2.GetDomainsResponse
+        """
+        get_domain_request = GetDomainRequest()
+        return self._stub.GetDomains(get_domain_request, metadata=self._metadata)
+
     ####################################################################################################################
     #
     #  Matching Attributes Endpoints

flytekit/models/domain.py

@@ -0,0 +1,46 @@
+from flyteidl.admin import project_pb2 as _project_pb2
+
+from flytekit.models import common as _common
+
+
+class Domain(_common.FlyteIdlEntity):
+    """
+    Domains are fixed and unique at the global level, and provide an abstraction to isolate resources and feature configuration for different deployment environments.
+
+    :param Text id: A globally unique identifier associated with this domain.
+    :param Text name: A human-readable name for this domain.
+    """
+
+    def __init__(self, id, name):
+        self._id = id
+        self._name = name
+
+    @property
+    def id(self):
+        """
+        A globally unique identifier associated with this domain.
+        :rtype: Text
+        """
+        return self._id
+
+    @property
+    def name(self):
+        """
+        A human-readable name for this domain.
+        :rtype: Text
+        """
+        return self._name
+
+    def to_flyte_idl(self):
+        """
+        :rtype: flyteidl.admin.project_pb2.Domain
+        """
+        return _project_pb2.Domain(id=self.id, name=self.name)
+
+    @classmethod
+    def from_flyte_idl(cls, pb2_object):
+        """
+        :param flyteidl.admin.project_pb2.Domain pb2_object:
+        :rtype: Domain
+        """
+        return cls(id=pb2_object.id, name=pb2_object.name)

flytekit/remote/remote.py

@@ -82,6 +82,7 @@
 from flytekit.models.core import workflow as workflow_model
 from flytekit.models.core.identifier import Identifier, ResourceType, SignalIdentifier, WorkflowExecutionIdentifier
 from flytekit.models.core.workflow import BranchNode, Node, NodeMetadata
+from flytekit.models.domain import Domain
 from flytekit.models.execution import (
     ClusterAssignment,
     ExecutionMetadata,
@@ -93,6 +94,7 @@
 from flytekit.models.launch_plan import LaunchPlanState
 from flytekit.models.literals import Literal, LiteralMap
 from flytekit.models.matchable_resource import ExecutionClusterLabel
+from flytekit.models.project import Project
 from flytekit.remote.backfill import create_backfill_workflow
 from flytekit.remote.data import download_literal
 from flytekit.remote.entities import FlyteLaunchPlan, FlyteNode, FlyteTask, FlyteTaskNode, FlyteWorkflow
@@ -2613,6 +2615,38 @@ def terminate(self, execution: FlyteWorkflowExecution, cause: str):
         """
         self.client.terminate_execution(execution.id, cause)
 
+    ############
+    # Projects #
+    ############
+
+    def list_projects(
+        self,
+        limit: typing.Optional[int] = 100,
+        filters: typing.Optional[typing.List[filter_models.Filter]] = None,
+        sort_by: typing.Optional[admin_common_models.Sort] = None,
+    ) -> typing.List[Project]:
+        """Lists registered projects from flyte admin.
+
+        :param limit: [Optional[int]] The maximum number of entries to return.
+        :param filters Optional[typing.List[filter_models.Filter]]: If specified, the filters will be applied to
+            the query. If the filter is not supported, an exception will be raised.
+        :param sort_by Optional[admin_common_models.Sort]: If provided, the results will be sorted.
+        :raises grpc.RpcError:
+        :returns: typing.List[flytekit.models.project.Project]
+        """
+        return self.client.list_projects_paginated(limit=limit, filters=filters, sort_by=sort_by)[0]
+
+    ############
+    # Domains #
+    ############
+
+    def get_domains(self) -> typing.List[Domain]:
+        """Lists registered domains from flyte admin.
+
+        :returns: typing.List[flytekit.models.domain.Domain]
+        """
+        return self.client.get_domains()
+
     ##################
     # Helper Methods #
     ##################