Deployment model¶
- class besser.BUML.metamodel.deployment.deployment.Hypervisor(*values)[source]¶
Bases:
EnumEnumeration to list various types of hypervisors.
Hypervisors are software, firmware, or hardware that creates and runs virtual machines (VMs). This enumeration lists some of the most common hypervisors used in virtualization technology.
- Attributes:¶
vm_ware (str) – Represents the VMWare hypervisor.
hyper_v (str) – Represents the Hyper-V hypervisor developed by Microsoft.
xen_server (str) – Represents the XenServer hypervisor.
rhev (str) – Represents the Red Hat Enterprise Virtualization (RHEV) hypervisor.
kvm (str) – Represents the Kernel-based Virtual Machine (KVM) hypervisor.
-
vm_ware =
'VMWare'¶
-
hyper_v =
'Hyper-V'¶
-
xen_server =
'XenServer'¶
-
rhev =
'RHEV'¶
-
kvm =
'KVM'¶
- class besser.BUML.metamodel.deployment.deployment.Processor(*values)[source]¶
Bases:
EnumEnumeration to list various types of processors.
Processors are the central units in computing that execute instructions.
- Attributes:¶
x64 (str) – Represents the x64 processor architecture.
x86 (str) – Represents the x86 processor architecture.
arm (str) – Represents the ARM processor architecture.
-
x64 =
'x64'¶
-
x86 =
'x86'¶
-
arm =
'ARM'¶
- class besser.BUML.metamodel.deployment.deployment.IPRangeType(*values)[source]¶
Bases:
EnumEnumeration to list different types of IP ranges.
IP ranges are used to define segments of IP addresses in networking.
- Attributes:¶
subnet (str) – Represents a subnetwork IP range.
pod (str) – Represents a pod IP range.
service (str) – Represents a service IP range.
-
subnet =
'Subnetwork'¶
-
pod =
'Pod'¶
-
service =
'Service'¶
- class besser.BUML.metamodel.deployment.deployment.ServiceType(*values)[source]¶
Bases:
EnumEnumeration to list different types of services in networking.
Services are abstractions that define a set of pods as a group and access policy for them.
- Attributes:¶
lb (str) – Represents a LoadBalancer service.
ingress (str) – Represents an Ingress service.
egress (str) – Represents an Egress service.
-
lb =
'LoadBalancer'¶
-
ingress =
'Ingress'¶
-
egress =
'Egress'¶
- class besser.BUML.metamodel.deployment.deployment.Provider(*values)[source]¶
Bases:
EnumEnumeration to list different cloud service providers.
Cloud service providers offer various services such as computing power, storage, and networking.
- Attributes:¶
google (str) – Represents Google Cloud Platform.
aws (str) – Represents Amazon Web Services.
azure (str) – Represents Microsoft Azure.
other (str) – Represents any other cloud service provider.
-
google =
'Google'¶
-
aws =
'AWS'¶
-
azure =
'Azure'¶
-
other =
'Other'¶
- class besser.BUML.metamodel.deployment.deployment.Protocol(*values)[source]¶
Bases:
EnumEnumeration to list various network protocols.
Network protocols define the rules for data communication over a network.
- Attributes:¶
http (str) – Represents the HTTP protocol.
https (str) – Represents the HTTPS protocol.
tcp (str) – Represents the TCP protocol.
udp (str) – Represents the UDP protocol.
all (str) – Represents all protocols.
-
http =
'HTTP'¶
-
https =
'HTTPS'¶
-
tcp =
'TCP'¶
-
udp =
'UDP'¶
-
all =
'ALL'¶
- class besser.BUML.metamodel.deployment.deployment.Resources(cpu: int, memory: int)[source]¶
Bases:
objectA class to represent the computational resources.
- class besser.BUML.metamodel.deployment.deployment.Application(name: str, image_repo: str, port: int, required_resources: Resources, domain_model: DomainModel)[source]¶
Bases:
NamedElementA class to represent an application.
- Parameters:¶
name (str) – The name of the application.
image_repo (str) – The image repository for the application.
port (int) – The port on which the application runs.
required_resources (Resources) – The resources required by the application.
domain_model (DomainModel) – The domain model of the application.
- Attributes:¶
image_repo (str) – The image repository for the application.
port (int) – The port on which the application runs.
required_resources (Resources) – The resources required by the application.
domain_model (DomainModel) – The domain model of the application.
- property domain_model : DomainModel¶
Get the domain model.
-
_abc_impl =
<_abc._abc_data object>¶
- class besser.BUML.metamodel.deployment.deployment.Volume(name: str, mount_path: str, sub_path: str)[source]¶
Bases:
NamedElementA class to represent a volume.
- Parameters:¶
name (str) – The name of the volume.
mount_path (str) – The mount path of the volume.
sub_path (str) – The sub-path within the volume.
- Attributes:¶
mount_path (str) – The mount path of the volume.
sub_path (str) – The sub-path within the volume.
-
_abc_impl =
<_abc._abc_data object>¶
-
class besser.BUML.metamodel.deployment.deployment.Container(name: str, application: Application, resources_limit: Resources =
None, volumes: set[Volume] =None)[source]¶ Bases:
NamedElementA class to represent a container.
- Parameters:¶
name (str) – The name of the container.
application (Application) – The application running in the container.
resources_limit (Resources, optional) – The resource limits for the container.
volumes (set[Volume], optional) – The set of volumes attached to the container.
- Attributes:¶
application (Application) – The application running in the container.
resources_limit (Resources) – The resource limits for the container.
volumes (set[Volume]) – The set of volumes attached to the container.
- property application : Application¶
Get the application.
- Type:¶
-
_abc_impl =
<_abc._abc_data object>¶
- class besser.BUML.metamodel.deployment.deployment.Deployment(name: str, replicas: int, containers: set[Container])[source]¶
Bases:
NamedElementA class to represent a deployment.
- Parameters:¶
name (str) – The name of the deployment.
replicas (int) – The number of replicas.
containers (set[Container]) – The set of containers in the deployment.
- Attributes:¶
replicas (int) – The number of replicas.
containers (set[Container]) – The set of containers in the deployment.
-
_abc_impl =
<_abc._abc_data object>¶
-
class besser.BUML.metamodel.deployment.deployment.Service(name: str, port: int, target_port: int, type: ServiceType, protocol: Protocol, application: Application =
None)[source]¶ Bases:
NamedElementA class to represent a service.
- Parameters:¶
name (str) – The name of the service.
port (int) – The port on which the service is exposed.
target_port (int) – The port on which the application is running.
type (ServiceType) – The type of service (e.g., LoadBalancer, Ingress, Egress).
protocol (Protocol) – The protocol used by the service (e.g., HTTP, HTTPS, TCP, UDP).
application (Application, optional) – The application associated with the service.
- Attributes:¶
port (int) – The port on which the service is exposed.
target_port (int) – The port on which the application is running.
type (ServiceType) – The type of service.
protocol (Protocol) – The protocol used by the service.
application (Application) – The application associated with the service.
- property type : ServiceType¶
Get the type of service.
- Type:¶
- property application : Application¶
Get the application associated with the service.
- Type:¶
-
_abc_impl =
<_abc._abc_data object>¶
- class besser.BUML.metamodel.deployment.deployment.IPRange(name: str, cidr_range: str, type: IPRangeType, public: bool)[source]¶
Bases:
NamedElementA class to represent an IP range.
- Parameters:¶
name (str) – The name of the IP range.
cidr_range (str) – The CIDR range of the IP addresses.
type (IPRangeType) – The type of IP range (e.g., Subnetwork, Pod, Service).
public (bool) – Whether the IP range is public or private.
- Attributes:¶
cidr_range (str) – The CIDR range of the IP addresses.
type (IPRangeType) – The type of IP range.
public (bool) – Whether the IP range is public or private.
- property type : IPRangeType¶
Get the type of IP range.
- Type:¶
-
_abc_impl =
<_abc._abc_data object>¶
- class besser.BUML.metamodel.deployment.deployment.SecurityGroup(name: str, rules: set[Service])[source]¶
Bases:
NamedElementA class to represent a security group.
- Parameters:¶
name (str) – The name of the security group.
rules (set[Service]) – The set of services that define the security rules.
- Attributes:¶
rules (set[Service]) – The set of services that define the security rules.
-
_abc_impl =
<_abc._abc_data object>¶
-
class besser.BUML.metamodel.deployment.deployment.Network(name: str, security_groups: set[SecurityGroup] =
None)[source]¶ Bases:
NamedElementA class to represent a network.
- Parameters:¶
name (str) – The name of the network.
security_groups (set[SecurityGroup], optional) – The set of security groups associated
with the network.
- Attributes:¶
security_groups (set[SecurityGroup]) – The set of security groups associated with the
network.
- property security_groups : set[SecurityGroup]¶
Get the set of security groups.
- Type:¶
-
_abc_impl =
<_abc._abc_data object>¶
- class besser.BUML.metamodel.deployment.deployment.Subnetwork(name: str, ip_ranges: set[IPRange], network: Network)[source]¶
Bases:
NamedElementA class to represent a subnetwork.
- Parameters:¶
name (str) – The name of the subnetwork.
ip_ranges (set[IPRange]) – The set of IP ranges within the subnetwork.
network (Network) – The network to which the subnetwork belongs.
- Attributes:¶
ip_ranges (set[IPRange]) – The set of IP ranges within the subnetwork.
network (Network) – The network to which the subnetwork belongs.
-
_abc_impl =
<_abc._abc_data object>¶
- class besser.BUML.metamodel.deployment.deployment.Zone(name: str)[source]¶
Bases:
NamedElementA class to represent a zone.
-
_abc_impl =
<_abc._abc_data object>¶
-
_abc_impl =
- class besser.BUML.metamodel.deployment.deployment.Region(name: str, zones: set[Zone])[source]¶
Bases:
NamedElementA class to represent a region.
- Parameters:¶
name (str) – The name of the region.
zones (set[Zone]) – The set of zones within the region.
- Attributes:¶
zones (set[Zone]) – The set of zones within the region.
-
_abc_impl =
<_abc._abc_data object>¶
- class besser.BUML.metamodel.deployment.deployment.Node(name: str, public_ip: str, private_ip, os: str, resources: Resources, storage: int, processor: Processor)[source]¶
Bases:
NamedElementA class to represent a node.
- Parameters:¶
name (str) – The name of the node.
public_ip (str) – The public IP address of the node.
private_ip (str) – The private IP address of the node.
os (str) – The operating system running on the node.
resources (Resources) – The computational resources of the node.
storage (int) – The storage capacity of the node in gigabytes.
processor (Processor) – The processor type of the node.
- Attributes:¶
public_ip (str) – The public IP address of the node.
private_ip (str) – The private IP address of the node.
os (str) – The operating system running on the node.
resources (Resources) – The computational resources of the node.
storage (int) – The storage capacity of the node in gigabytes.
processor (Processor) – The processor type of the node.
-
_abc_impl =
<_abc._abc_data object>¶
- class besser.BUML.metamodel.deployment.deployment.EdgeNode(name: str, public_ip: str, private_ip, os: str, resources: Resources, storage: int, processor: Processor)[source]¶
Bases:
NodeA class to represent an edge node.
-
_abc_impl =
<_abc._abc_data object>¶
-
_abc_impl =
- class besser.BUML.metamodel.deployment.deployment.CloudNode(name: str, public_ip: str, private_ip, os: str, resources: Resources, storage: int, processor: Processor)[source]¶
Bases:
NodeA class to represent a cloud node.
-
_abc_impl =
<_abc._abc_data object>¶
-
_abc_impl =
-
class besser.BUML.metamodel.deployment.deployment.Cluster(name: str, services: set[Service], deployments: set[Deployment], regions: set[Region], net_config: bool =
True, nodes: set[Node] =None, networks: set[Network] =None, subnets: set[Subnetwork] =None)[source]¶ Bases:
NamedElementA class to represent a cluster.
- Parameters:¶
name (str) – The name of the cluster.
services (set[Service]) – The set of services associated with the cluster.
deployments (set[Deployment]) – The set of deployments in the cluster.
regions (set[Region]) – The set of regions where the cluster is deployed.
net_config (bool, optional) – Indicates if network configuration is enabled. Defaults to True.
nodes (set[Node], optional) – The set of nodes in the cluster. Defaults to an empty set.
networks (set[Network], optional) – The set of networks in the cluster. Defaults to an empty set.
subnets (set[Subnetwork], optional) – The set of subnetworks in the cluster. Defaults to an empty set.
- Attributes:¶
services (set[Service]) – The set of services associated with the cluster.
deployments (set[Deployment]) – The set of deployments in the cluster.
regions (set[Region]) – The set of regions where the cluster is deployed.
net_config (bool) – Indicates if network configuration is enabled.
nodes (set[Node]) – The set of nodes in the cluster.
networks (set[Network]) – The set of networks in the cluster.
subnets (set[Subnetwork]) – The set of subnetworks in the cluster.
-
_abc_impl =
<_abc._abc_data object>¶
- property deployments : set[Deployment]¶
Get the set of deployments.
- Type:¶
- property subnets : set[Subnetwork]¶
Get the set of subnetworks.
- Type:¶
-
class besser.BUML.metamodel.deployment.deployment.PublicCluster(name: str, services: set[Service], deployments: set[Deployment], regions: Region, num_nodes: int, provider: Provider, config_file: str, networks: set[Network] =
None, subnets: set[Subnetwork] =None, net_config: bool =True)[source]¶ Bases:
ClusterA class to represent a public cluster.
- Parameters:¶
name (str) – The name of the public cluster.
services (set[Service]) – The set of services associated with the public cluster.
deployments (set[Deployment]) – The set of deployments in the public cluster.
regions (set[Region]) – The set of regions where the public cluster is deployed.
num_nodes (int) – The number of nodes in the public cluster.
provider (Provider) – The provider of the public cluster.
config_file (str) – The configuration file for the public cluster.
networks (set[Network], optional) – The set of networks in the public cluster. Defaults to an empty set.
subnets (set[Subnetwork], optional) – The set of subnetworks in the public cluster. Defaults to an empty set.
net_config (bool, optional) – Indicates if network configuration is enabled. Defaults to True.
- Attributes:¶
config_file (str) – The configuration file for the public cluster.
num_nodes (int) – The number of nodes in the public cluster.
provider (Provider) – The provider of the public cluster.
-
_abc_impl =
<_abc._abc_data object>¶
- class besser.BUML.metamodel.deployment.deployment.OnPremises(name: str, services: set[Service], deployments: set[Deployment], regions: Region, nodes: set[Node], hypervisor: Hypervisor, networks: set[Network], subnets: set[Subnetwork])[source]¶
Bases:
ClusterA class to represent an on-premises cluster.
- Parameters:¶
name (str) – The name of the on-premises cluster.
services (set[Service]) – The set of services associated with the on-premises cluster.
deployments (set[Deployment]) – The set of deployments in the on-premises cluster.
regions (set[Region]) – The set of regions where the on-premises cluster is deployed.
nodes (set[Node]) – The set of nodes in the on-premises cluster.
hypervisor (Hypervisor) – The hypervisor used in the on-premises cluster.
networks (set[Network]) – The set of networks in the on-premises cluster.
subnets (set[Subnetwork]) – The set of subnetworks in the on-premises cluster.
- Attributes:¶
hypervisor (Hypervisor) – The hypervisor used in the on-premises cluster.
-
_abc_impl =
<_abc._abc_data object>¶
- property hypervisor : Hypervisor¶
Get the hypervisor.
- Type:¶
- class besser.BUML.metamodel.deployment.deployment.DeploymentModel(name: str, clusters: set[Cluster])[source]¶
Bases:
ModelA class to represent a deployment model.
- Parameters:¶
name (str) – The name of the deployment model.
clusters (set[Cluster]) – The set of clusters in the deployment model.
- Attributes:¶
clusters (set[Cluster]) – The set of clusters in the deployment model.
-
_abc_impl =
<_abc._abc_data object>¶