Skip to content

Commit

Permalink
update README.md (#3)
Browse files Browse the repository at this point in the history
Signed-off-by: Dmitry Shmulevich <[email protected]>
dmitsh authored Sep 26, 2024
1 parent 3094731 commit e52b050
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit e52b050

Please sign in to comment.