--- title: "Clusters" slug: "cluster-wxcked-eye" updated: 2025-12-19T20:11:42Z published: 2025-12-19T20:11:42Z canonical: "docs.swxtch.io/cluster-wxcked-eye" stale: true --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.swxtch.io/llms.txt > Use this file to discover all available pages before exploring further. # Clusters > [!NOTE] > WHAT TO EXPECT > > **In this article**, users will learn what a Cluster is and how to view, add, edit, and remove Clusters. **Navigating to the Cluster tab** The Clusters tab is located in the System Management page on wXcked Eye. To learn how to navigate there, users should review the [wXcked Eye System Management](/v2/docs/wxcked-eye-system-management) article. ### General Clusters are collections of cloudSwXtches within a given topology, enabling higher throughput and scalability for the swXtch.io overlay network. A cluster can be segmented so that the user has control per segment within the cluster as to which cloudSwXtches belong to the segment, as well as what multicast traffic can flow within the segment. The cluster can be specified (static), or it can be dynamic, meaning any multicast can flow through that segment. Refer to the “[Configuration Examples for Cluster Segments](/v2/docs/cluster-wxcked-eye#configuration-examples-for-cluster-segments)” section for more information. - **Static clusters** are used to pair the number of cloudSwXtches in a static configuration one-to-one. For example, for High Availability, where the users want the traffic to go down both the Red and Blue paths in a mirrored fashion. - **Dynamic clusters** work redundantly; if one cloudSwXtch goes down, then traffic will be diverted to another cloudSwXtch within the cluster. The **Clusters** tab enables users to configure the network environment. A cluster can contain any number of segments, and each segment can contain any number of cloudSwXthes. For [High Availability](/v2/docs/high-availability-wxcked-eye) (2022-7), each cluster that makes up each path must have the same number of cloudSwXtches in the same arrangement. At least two clusters are required in order to configure High Availability, but more can be configured if you have more than two paths. Below is a simple example of two clusters consisting of only one cloudSwXtch each, one for the red path and one for the blue path, that is used in the HA configuration (see [High Availability](/v2/docs/high-availability)). ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/image-1764622459793.png) For more information on how these settings assist in the Topology Graph see: - [Topology Graph/View By/Filter By Bar/View by HA Cluster](/v2/docs/view-filter-by-bar-wxcked-eye#view-by-ha-cluster) to see how you can filter the Topology Graph for the created cluster. - [Topology Graph/Layers Toolbox/swXtch Connections](/v2/docs/wxcked-eye-topology-toolbox#swxtch-connections) to see the cloudSwXtches that are connected via clusters. The Cluster page is organized into 3 functions: - [Add Cluster](/v2/docs/cluster-wxcked-eye#add-cluster) - [Edit Cluster](/v2/docs/cluster-wxcked-eye#edit-cluster) - [Destroy Cluster](/v2/docs/cluster-wxcked-eye#destroy-cluster) - [Configuration Examples for Cluster Segments](/v2/docs/cluster-wxcked-eye#configuration-examples-for-cluster-segments) ## Add Cluster To Add a Cluster: 1. **Click** the "Add Cluster" button. A pop-up will open. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/image-1764622481114.png) 2. **Name** the Cluster configuration. In this example, the cluster is named **HA_Cluster**. Note: Segments are explained in the “[Configuration Examples for Cluster Segments](/v2/docs/cluster-wxcked-eye#configuration-examples-for-cluster-segments)” section. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/wE_System_Management_Cluster_add2.png) 3. Add any tags for the cluster. 4. Select the **Type**. - **Dynamic**means one will be designated as the main swXtch, others will be used under the main one. Should the main go down, another one will dynamically take its place as the main. - **Static**means to build a static tree; the flow will statically run through the designated path. For High Availability, it is important to use static. 5. **Enter** the swXtch addresses. Users can select the already added swXtches (see the [wXcked Eye swXtches](/v2/docs/wxcked-eye-network-page) page), or type the IP:port of any swxtch. > [!NOTE] > **PLEASE NOTE** > > If no port is given, it will automatically be configured as the default 80. 1. Segments allow dividing the multicast traffic into segments, sending some streams through specific clusters/cloudSwXtches. Several segments can be created by clicking on Group streams and configuring the values (either with dynamic streams that will distribute them automatically, doing load balancing, or manually). Segments are explained in [Configuration Examples for Cluster Segments](/v2/docs/cluster-wxcked-eye#configuration-examples-for-cluster-segments) 6. **Click** Save. ## Edit Cluster To edit a Cluster configuration, the user will need to go to the cluster page. 1. **Click** the "Edit cluster" icon. A pop-up will open. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/wE_System_Management_Cluster_Edit.png) 2. **Make** any necessary changes. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/wE_System_Management_Cluster_Edit2.png) 3. **Click** “Save”. The cluster will be saved. ## Destroy Cluster To destroy a Cluster configuration: 1. **Click** the "Destroy cluster" icon. A new prompt will appear, asking to confirm the action. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/wE_System_Management_Cluster_Delete.png) 2. **Confirm** the action. The Cluster is now destroyed. ## Configuration Examples for Cluster Segments ### Example 1: Split load based on IP ranges In this example, we will use two cloudSwXtches, each supporting different multicast addresses. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%201%20-%202swxtches%20each%20with%20different%20mc.png) When looking at the Topology Graph “Swxtch Connections” you can see the configuration graphically. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%201%20-%202swxtches%20each%20with%20different%20mc_graph%20swxtch%20connections.png) When looking at the Topology Graph “Stream Multicast Groups” you can see that, based on the configuration, the multicast data is segmented. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%201%20-%202swxtches%20each%20with%20different%20mc_graph%20streams%20MC%20groups.png) Note that any traffic out of the range will still be sent, but the cloudSwXtch it goes through will be dynamic, meaning it can go through either, as the system decides. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%201%20-%202swxtches%20each%20with%20different%20mc_graph%20more%20mc%20groups.png) Since the cloudSwXtch(s) are acting as one for enabling higher throughput and scalability, they can also be viewed as one by grouping them using the selected Nodes. You can select the Node and then select the group and cluster to combine them. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%201%20-%202swxtches%20each%20with%20different%20mc_graph%20group%20by%20cluster%201.png) Below is the result. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%201%20-%202swxtches%20each%20with%20different%20mc_graph%20group%20by%20cluster%201-result.png) ### Example 2: Split load based on IP ranges with High Availability Continuing from the example above, you can create a second cluster for a second path for High Availability as shown below: ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%202%20-%202%20swxtches%20each%20with%20different%20mc_.png) Then enable High Availability using the configured clusters as shown below: ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%202%20-%202%20swxtches%20each%20with%20different%20mc_HA%20config_.png) Result of creating HA below: ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%202%20-%202%20swxtches%20each%20with%20different%20mc_HA%20config_result.png) The result is shown below as now the traffic can hit cloudSwXtch(s) and their xNIC(s) due to Clusters and High Availability configurations. ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%202%20-%202%20swxtches%20each%20with%20different%20mc_HA%20-%20graph%20result.png) The blue cloudSwXtch(s) can also be clustered to be viewed as one, as shown below: ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%202%20-%202%20swxtches%20each%20with%20different%20mc_HA%20-%20graph%20result__group_Cluster.png) The result is below: ![](https://cdn.document360.io/84c5db44-f675-4f33-a980-5d3fc63073ca/Images/Documentation/Cluster%20Example%202%20-%202%20swxtches%20each%20with%20different%20mc_HA%20-%20graph%20result__group_Cluster_result.png)