Skip to content

Commit 446e983

Browse files
authored
[Cherry-Pick] enhance: add resource group declarative api (#2002) (#2054)
issue: milvus-io/milvus#32282 picked from pr: #2002 - Add param `config` for `create_resource_group` api. - Add `update_resource_groups` api to implement declarative resource group api. - Add new example for declarative resource group api. Signed-off-by: chyezh <[email protected]>
1 parent 66af344 commit 446e983

15 files changed

Lines changed: 441 additions & 112 deletions

‎examples/resource_group.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
from pymilvus import utility, connections, DEFAULT_RESOURCE_GROUP
1+
from pymilvus import utility, connections
2+
from pymilvus.client.constants import DEFAULT_RESOURCE_GROUP
23
from example import *
34

45
_HOST = '127.0.0.1'
@@ -52,7 +53,7 @@ def transfer_replica(source, target, collection_name, num_replica):
5253
f"transfer {num_replica} replicas in {collection_name} from {source} to {target}")
5354
utility.transfer_replica(
5455
source, target, collection_name, num_replica, using=_CONNECTION_NAME)
55-
56+
5657
def run():
5758
create_connection("root", "123456")
5859
coll = create_collection(_COLLECTION_NAME, _ID_FIELD_NAME, _VECTOR_FIELD_NAME)
Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
from pymilvus import utility, connections, Collection
2+
from pymilvus.client.constants import DEFAULT_RESOURCE_GROUP
3+
from pymilvus.client.types import ResourceGroupConfig
4+
from typing import List
5+
from example import create_connection, create_collection, insert, create_index
6+
7+
_PENDING_NODES_RESOURCE_GROUP="pending_nodes"
8+
# Vector parameters
9+
_DIM = 128
10+
_COLLECTION_NAME = 'rg_declarative_demo'
11+
_ID_FIELD_NAME = 'id_field'
12+
_VECTOR_FIELD_NAME = 'float_vector_field'
13+
14+
def create_example_collection_and_load(replica_number: int, resource_groups: List[str]):
15+
print(f"\nCreate collection and load...")
16+
coll = create_collection(_COLLECTION_NAME, _ID_FIELD_NAME, _VECTOR_FIELD_NAME)
17+
insert(coll, 10000, _DIM)
18+
coll.flush()
19+
create_index(coll, _VECTOR_FIELD_NAME)
20+
coll.load(replica_number=replica_number, _resource_groups=resource_groups)
21+
22+
def transfer_replica(src: str, dest: str, num_replica: int):
23+
utility.transfer_replica(source_group=src, target_group=dest, collection_name=_COLLECTION_NAME, num_replicas=num_replica)
24+
25+
def list_replica():
26+
coll = Collection(name=_COLLECTION_NAME)
27+
replicas = coll.get_replicas()
28+
print(replicas)
29+
30+
def init_cluster(node_num: int):
31+
print(f"Init cluster with {node_num} nodes, all nodes will be put in default resource group")
32+
# create a pending resource group, which can used to hold the pending nodes that do not hold any data.
33+
utility.create_resource_group(name=_PENDING_NODES_RESOURCE_GROUP, config=ResourceGroupConfig(
34+
requests={"node_num": 0}, # this resource group can hold 0 nodes, no data will be load on it.
35+
limits={"node_num": 10000}, # this resource group can hold at most 10000 nodes
36+
))
37+
38+
# create a default resource group, which can used to hold the nodes that all initial node in it.
39+
utility.update_resource_groups({
40+
DEFAULT_RESOURCE_GROUP: ResourceGroupConfig(
41+
requests={"node_num": node_num},
42+
limits={"node_num": node_num},
43+
transfer_from=[{"resource_group": _PENDING_NODES_RESOURCE_GROUP}], # recover missing node from pending resource group at high priority.
44+
transfer_to=[{"resource_group": _PENDING_NODES_RESOURCE_GROUP}], # recover redundant node to pending resource group at low priority.
45+
)})
46+
47+
def list_all_resource_groups():
48+
rg_names = utility.list_resource_groups()
49+
50+
for rg_name in rg_names:
51+
resource_group = utility.describe_resource_group(rg_name)
52+
print(resource_group)
53+
# print(f"Resource group {rg_name} has {resource_group.nodes} with config: {resource_group.config}")
54+
55+
def scale_resource_group_to(name :str, node_num: int):
56+
"""scale resource group to node_num nodes, new query node need to be added from outside orchestration system"""
57+
utility.update_resource_groups({
58+
name: ResourceGroupConfig(
59+
requests={"node_num": node_num},
60+
limits={"node_num": node_num},
61+
transfer_from=[{"resource_group": _PENDING_NODES_RESOURCE_GROUP}], # recover missing node from pending resource group at high priority.
62+
transfer_to=[{"resource_group": _PENDING_NODES_RESOURCE_GROUP}], # recover redundant node to pending resource group at low priority.
63+
)
64+
})
65+
66+
def create_resource_group(name: str, node_num: int):
67+
print(f"Create resource group {name} with {node_num} nodes")
68+
utility.create_resource_group(name, config=ResourceGroupConfig(
69+
requests={"node_num": node_num},
70+
limits={"node_num": node_num},
71+
transfer_from=[{"resource_group": _PENDING_NODES_RESOURCE_GROUP}], # recover missing node from pending resource group at high priority.
72+
transfer_to=[{"resource_group": _PENDING_NODES_RESOURCE_GROUP}], # recover redundant node to pending resource group at low priority.
73+
))
74+
75+
def resource_group_management():
76+
# cluster is initialized with 1 node in default resource group, and 0 node in pending resource group.
77+
init_cluster(1)
78+
list_all_resource_groups()
79+
# DEFAULT_RESOURCE_GROUP: 1
80+
# _PENDING_NODES_RESOURCE_GROUP: 0
81+
82+
# rg1 missing two query node.
83+
create_resource_group("rg1", 2)
84+
list_all_resource_groups()
85+
# DEFAULT_RESOURCE_GROUP: 1
86+
# _PENDING_NODES_RESOURCE_GROUP: 0
87+
# rg1: 0(missing 2)
88+
89+
# scale_out(2)
90+
# scale out two new query node into cluster by orchestration system, these node will be added to rg1 automatically.
91+
list_all_resource_groups()
92+
# DEFAULT_RESOURCE_GROUP: 1
93+
# _PENDING_NODES_RESOURCE_GROUP: 0
94+
# rg1: 2
95+
96+
97+
# rg1 missing one query node.
98+
scale_resource_group_to("rg1", 3)
99+
list_all_resource_groups()
100+
# DEFAULT_RESOURCE_GROUP: 1
101+
# _PENDING_NODES_RESOURCE_GROUP: 0
102+
# rg1: 2(missing 1)
103+
104+
# scale_out(2)
105+
# scale out two new query node into cluster by orchestration system, one node will be added to rg1 automatically
106+
# and one redundant node will be added to pending resource group.
107+
list_all_resource_groups()
108+
# DEFAULT_RESOURCE_GROUP: 1
109+
# _PENDING_NODES_RESOURCE_GROUP: 1
110+
# rg1: 3
111+
112+
scale_resource_group_to("rg1", 1)
113+
list_all_resource_groups()
114+
# DEFAULT_RESOURCE_GROUP: 1
115+
# _PENDING_NODES_RESOURCE_GROUP: 3
116+
# rg1: 1
117+
118+
# rg2 missing three query node, will be added from pending resource group.
119+
create_resource_group("rg2", 3)
120+
list_all_resource_groups()
121+
# DEFAULT_RESOURCE_GROUP: 1
122+
# _PENDING_NODES_RESOURCE_GROUP: 0
123+
# rg1: 1
124+
# rg2: 3
125+
126+
scale_resource_group_to(DEFAULT_RESOURCE_GROUP, 5)
127+
list_all_resource_groups()
128+
# DEFAULT_RESOURCE_GROUP: 1(missing 4)
129+
# _PENDING_NODES_RESOURCE_GROUP: 0
130+
# rg1: 1
131+
# rg2: 3
132+
133+
# scale_out(4)
134+
list_all_resource_groups()
135+
# DEFAULT_RESOURCE_GROUP: 5
136+
# _PENDING_NODES_RESOURCE_GROUP: 1
137+
# rg1: 1
138+
# rg2: 3
139+
140+
def replica_management():
141+
# load collection into default.
142+
# create_example_collection_and_load(4, ["rg1", "rg2", "rg2", "rg2"])
143+
# one replica per node in default resource group.
144+
list_replica()
145+
transfer_replica("rg1", DEFAULT_RESOURCE_GROUP, 1)
146+
list_replica()
147+
transfer_replica("rg2", DEFAULT_RESOURCE_GROUP, 1)
148+
list_replica()
149+
# DEFAULT_RESOURCE_GROUP: 2 replica on 5 nodes.
150+
# rg1: 0 replica.
151+
# rg2: 2 replica on 3 nodes.
152+
153+
if __name__ == "__main__":
154+
create_connection()
155+
resource_group_management()
156+
create_example_collection_and_load(4, ["rg1", "rg2", "rg2", "rg2"])
157+
replica_management()

‎pymilvus/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@
7878
transfer_node,
7979
transfer_replica,
8080
update_password,
81+
update_resource_groups,
8182
wait_for_index_building_complete,
8283
wait_for_loading_complete,
8384
)
@@ -106,6 +107,7 @@
106107
"reset_password",
107108
"create_user",
108109
"update_password",
110+
"update_resource_groups",
109111
"delete_user",
110112
"list_usernames",
111113
"SearchResult",

‎pymilvus/client/grpc_handler.py‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import socket
55
import time
66
from pathlib import Path
7-
from typing import Any, Callable, Dict, List, Optional, Union
7+
from typing import Any, Callable, Dict, List, Mapping, Optional, Union
88
from urllib import parse
99

1010
import grpc
@@ -49,6 +49,7 @@
4949
LoadState,
5050
Plan,
5151
Replica,
52+
ResourceGroupConfig,
5253
ResourceGroupInfo,
5354
RoleInfo,
5455
Shard,
@@ -1838,10 +1839,18 @@ def get_server_version(self, timeout: Optional[float] = None, **kwargs) -> str:
18381839

18391840
@retry_on_rpc_failure()
18401841
def create_resource_group(self, name: str, timeout: Optional[float] = None, **kwargs):
1841-
req = Prepare.create_resource_group(name)
1842+
req = Prepare.create_resource_group(name, **kwargs)
18421843
resp = self._stub.CreateResourceGroup(req, wait_for_ready=True, timeout=timeout)
18431844
check_status(resp)
18441845

1846+
@retry_on_rpc_failure()
1847+
def update_resource_groups(
1848+
self, configs: Mapping[str, ResourceGroupConfig], timeout: Optional[float] = None, **kwargs
1849+
):
1850+
req = Prepare.update_resource_groups(configs)
1851+
resp = self._stub.UpdateResourceGroups(req, wait_for_ready=True, timeout=timeout)
1852+
check_status(resp)
1853+
18451854
@retry_on_rpc_failure()
18461855
def drop_resource_group(self, name: str, timeout: Optional[float] = None, **kwargs):
18471856
req = Prepare.drop_resource_group(name)

‎pymilvus/client/prepare.py‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import base64
22
import datetime
3-
from typing import Any, Dict, Iterable, List, Optional, Union
3+
from typing import Any, Dict, Iterable, List, Mapping, Optional, Union
44

55
import numpy as np
66

@@ -19,7 +19,12 @@
1919
ITERATOR_FIELD,
2020
REDUCE_STOP_FOR_BEST,
2121
)
22-
from .types import DataType, PlaceholderType, get_consistency_level
22+
from .types import (
23+
DataType,
24+
PlaceholderType,
25+
ResourceGroupConfig,
26+
get_consistency_level,
27+
)
2328
from .utils import traverse_info, traverse_rows_info
2429

2530

@@ -1146,9 +1151,18 @@ def get_server_version(cls):
11461151
return milvus_types.GetVersionRequest()
11471152

11481153
@classmethod
1149-
def create_resource_group(cls, name: str):
1154+
def create_resource_group(cls, name: str, **kwargs):
11501155
check_pass_param(resource_group_name=name)
1151-
return milvus_types.CreateResourceGroupRequest(resource_group=name)
1156+
return milvus_types.CreateResourceGroupRequest(
1157+
resource_group=name,
1158+
config=kwargs.get("config"),
1159+
)
1160+
1161+
@classmethod
1162+
def update_resource_groups(cls, configs: Mapping[str, ResourceGroupConfig]):
1163+
return milvus_types.UpdateResourceGroupsRequest(
1164+
resource_groups=configs,
1165+
)
11521166

11531167
@classmethod
11541168
def drop_resource_group(cls, name: str):

‎pymilvus/client/stub.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
from pymilvus.decorators import deprecated
44
from pymilvus.exceptions import MilvusException, ParamError
55
from pymilvus.settings import Config
6+
from typing import Mapping
67

78
from .check import is_legal_host, is_legal_port
89
from .grpc_handler import GrpcHandler
@@ -12,6 +13,7 @@
1213
CompactionState,
1314
Replica,
1415
ResourceGroupInfo,
16+
ResourceGroupConfig,
1517
)
1618

1719

@@ -1381,6 +1383,17 @@ def create_resource_group(self, name, timeout=None, **kwargs):
13811383
with self._connection() as handler:
13821384
handler.create_resource_group(name, timeout=timeout, **kwargs)
13831385

1386+
def update_resource_groups(
1387+
self, configs: Mapping[str, ResourceGroupConfig], timeout=None, **kwargs
1388+
):
1389+
"""update resource groups with specific configs
1390+
1391+
:param configs: resource group configs
1392+
:type name: Mapping
1393+
"""
1394+
with self._connection() as handler:
1395+
handler.update_resource_groups(configs=configs, timeout=timeout, **kwargs)
1396+
13841397
def drop_resource_group(self, name, timeout=None, **kwargs):
13851398
"""drop resource group with specific name
13861399

0 commit comments

Comments
 (0)