Skip to content

vService

vService

Bases: VirtualEntity, ABC

Source code in PyCloudSim\entity\v_service.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
class vService(VirtualEntity, ABC):
    def __init__(
        self,
        ms: vMicroservice,
        ports: List[int] = [],
        at: int | float | Callable[..., Any] = simulation.now,
        after: Entity | List[Entity] | None = None,
        label: str | None = None,
    ):
        """Base class for virtual services.

        Args:
            ms (vMicroservice): the associated vMicroservice.
            ports (List[int], optional): the exposed ports for vContainers. Defaults to [].
            at (int | float | Callable[..., Any], optional): same as entity. Defaults to simulation.now.
            after (Entity | List[Entity] | None, optional): same as entity. Defaults to None.
            label (str | None, optional): same as entity. Defaults to None.
        """        
        super().__init__(at, after, label)
        # assign the microservice
        self._ms_id = ms.id
        # assign the ip address
        self._ip_address = choice(simulation.virtual_network_ips)
        simulation.virtual_network_ips.remove(self.ip_address)
        # ports
        self._ports = ports

    def creation(self):
        """Creation process of a vService."""
        return super().creation()

    def termination(self):
        """Termination process of a vService."""
        return super().termination()

    @abstractmethod
    def loadbalancer(self) -> vContainer:
        """The loadbalancer of the vService. Can be implemented by the developer."""
        pass

    @property
    def ms_id(self):
        """The id of the associated vMicroservice."""
        return self._ms_id

    @property
    def ip_address(self):
        """The ip address of the vService."""
        return self._ip_address

    @property
    def ms(self):
        """The associated vMicroservice."""
        for ms in simulation.MICROSERVICES:
            if ms.id == self.ms_id:
                return ms
        raise Exception(
            f"Can not find associated vMicroservice for vService {self.id}."
        )

ip_address property

The ip address of the vService.

ms property

The associated vMicroservice.

ms_id property

The id of the associated vMicroservice.

__init__(ms, ports=[], at=simulation.now, after=None, label=None)

Base class for virtual services.

Parameters:

Name Type Description Default
ms vMicroservice

the associated vMicroservice.

 required
ports List[int]

the exposed ports for vContainers. Defaults to [].

 []
at int | float | Callable[..., Any]

same as entity. Defaults to simulation.now.

 now
after Entity | List[Entity] | None

same as entity. Defaults to None.

 None
label str | None

same as entity. Defaults to None.

 None
Source code in PyCloudSim\entity\v_service.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def __init__(
    self,
    ms: vMicroservice,
    ports: List[int] = [],
    at: int | float | Callable[..., Any] = simulation.now,
    after: Entity | List[Entity] | None = None,
    label: str | None = None,
):
    """Base class for virtual services.

    Args:
        ms (vMicroservice): the associated vMicroservice.
        ports (List[int], optional): the exposed ports for vContainers. Defaults to [].
        at (int | float | Callable[..., Any], optional): same as entity. Defaults to simulation.now.
        after (Entity | List[Entity] | None, optional): same as entity. Defaults to None.
        label (str | None, optional): same as entity. Defaults to None.
    """        
    super().__init__(at, after, label)
    # assign the microservice
    self._ms_id = ms.id
    # assign the ip address
    self._ip_address = choice(simulation.virtual_network_ips)
    simulation.virtual_network_ips.remove(self.ip_address)
    # ports
    self._ports = ports

creation()

Creation process of a vService.

Source code in PyCloudSim\entity\v_service.py 
52
53
54
def creation(self):
    """Creation process of a vService."""
    return super().creation()

loadbalancer() abstractmethod

The loadbalancer of the vService. Can be implemented by the developer.

Source code in PyCloudSim\entity\v_service.py 
60
61
62
63
@abstractmethod
def loadbalancer(self) -> vContainer:
    """The loadbalancer of the vService. Can be implemented by the developer."""
    pass

termination()

Termination process of a vService.

Source code in PyCloudSim\entity\v_service.py 
56
57
58
def termination(self):
    """Termination process of a vService."""
    return super().termination()

vServiceBestFit

Bases: vService

vService with best fit loadbalancer.

Source code in PyCloudSim\entity\v_service.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
class vServiceBestFit(vService):
    """vService with best fit loadbalancer."""
    def __init__(
        self,
        ms: vMicroservice,
        ports: List[int] = [],
        at: int | float | Callable[..., Any] = simulation.now,
        after: Entity | List[Entity] | None = None,
        label: str | None = None,
    ):
        super().__init__(ms, ports, at, after, label)

    def loadbalancer(self):
        self.ms.containers.sort(key=lambda x: x.ram.utilization)
        self.ms.containers.sort(key=lambda x: x.cpu.utilization)
        for container in self.ms.containers:
            if container.scheduled and not container.cordon and not container.terminated:
                return container
        return None

vServiceRandom

Bases: vService

vService with random loadbalancer.

Source code in PyCloudSim\entity\v_service.py 
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
class vServiceRandom(vService):
    """vService with random loadbalancer."""
    def __init__(
        self,
        ms: vMicroservice,
        ports: List[int] = [],
        at: int | float | Callable[..., Any] = simulation.now,
        after: Entity | List[Entity] | None = None,
        label: str | None = None,
    ):
        super().__init__(ms, ports, at, after, label)

    def loadbalancer(self):
        if all(container.scheduled == False for container in self.ms.containers):
            return None
        elif all(container.cordon == True for container in self.ms.containers):
            return None
        elif all(container.terminated == True for container in self.ms.containers):
            return None
        else:
            while True:
                container = choice(self.ms.containers)
                if container.scheduled:
                    return container

vServiceRoundRobin

Bases: vService

vService with round robin loadbalancer.

Source code in PyCloudSim\entity\v_service.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
class vServiceRoundRobin(vService):
    """vService with round robin loadbalancer."""
    def __init__(
        self,
        ms: vMicroservice,
        ports: List[int] = [],
        at: int | float | Callable[..., Any] = simulation.now,
        after: Entity | List[Entity] | None = None,
        label: str | None = None,
    ):
        super().__init__(ms, ports, at, after, label)
        self._container_pointer = 0

    def loadbalancer(self):
        if all(container.scheduled == False for container in self.ms.containers):
            return None
        elif all(container.cordon == True for container in self.ms.containers):
            return None
        elif all(container.terminated == True for container in self.ms.containers):
            return None
        else:
            while True:
                container = self.ms.containers[self.container_pointer]
                self._container_pointer = (self.container_pointer + 1) % len(
                    self.ms.containers
                )
                if container.scheduled:
                    return container

    @property
    def container_pointer(self):
        return self._container_pointer

vServiceWorstFit

Bases: vService

vService with worst fit loadbalancer.

Source code in PyCloudSim\entity\v_service.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
class vServiceWorstFit(vService):
    """vService with worst fit loadbalancer."""
    def __init__(
        self,
        ms: vMicroservice,
        ports: List[int] = [],
        at: int | float | Callable[..., Any] = simulation.now,
        after: Entity | List[Entity] | None = None,
        label: str | None = None,
    ):
        super().__init__(ms, ports, at, after, label)

    def loadbalancer(self):
        self.ms.containers.sort(key=lambda x: x.ram.utilization)
        self.ms.containers.sort(key=lambda x: x.cpu.utilization)

        for container in reversed(self.ms.containers):
            if container.scheduled and not container.cordon and not container.terminated:
                return container
        return None