From e52b0500ade4ee16fa40b7d3783dd0e5bfce8778 Mon Sep 17 00:00:00 2001 From: Dmitry Shmulevich Date: Thu, 26 Sep 2024 15:10:13 -0700 Subject: [PATCH] update README.md (#3) Signed-off-by: Dmitry Shmulevich --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8e1ac47..f0d1101 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # topograph -Topograph is a component designed to expose the underlying physical network topology of a cluster to enable a workload manager make network-topology aware scheduling decisions. It consists of three major components: +Topograph is a component designed to expose the underlying physical network topology of a cluster to enable a workload manager make network-topology aware scheduling decisions. It consists of four major components: 1. **CSP Connector** 2. **API Server** 3. **Topology Generator** -4. **Kubernetes State Observer** +4. **Node Observer** ## Components @@ -30,9 +30,9 @@ The Topology Generator is the central component that manages the overall network - **Topology Gathering:** Instructs the CSP Connector to fetch the current network topology from the CSP. - **User Cluster Update:** Translates network topology from the internal format into a format expected by the user cluster, such as SLURM or Kubernetes. -### 4. Kubernetes Node Observer +### 4. Node Observer The Node Observer is used when the Topology Generator is deployed in a Kubernetes cluster. It monitors changes in the cluster nodes. -If a node's status changes (e.g., a node goes down or comes up), the State Observer sends a request to the API Server to generate a new topology configuration. +If a node's status changes (e.g., a node goes down or comes up), the Node Observer sends a request to the API Server to generate a new topology configuration. ## Supported Environments