Skip to content

Commit

Permalink
fix(tgnms): clean up README.md
Browse files Browse the repository at this point in the history
Summary: Remove some content from top-level `README.md`.

Reviewed By: aclave1

Differential Revision: D35662680

fbshipit-source-id: 36900bd8ae22390f1e3f794b774a4cc7cef38389
  • Loading branch information
elludraon authored and facebook-github-bot committed Apr 15, 2022
1 parent 0d857d8 commit 95a6ddc
Showing 1 changed file with 0 additions and 30 deletions.
30 changes: 0 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@ nms install -f config.yml
# Developer Guide

## [Developer Guide for `tgnms`](https://github.com/terragraph/tgnms/blob/main/tgnms/fbcnms-projects/tgnms/README.md)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

## Overal Architecture
![image](readme_images/ArchitectureOverview.png)
Expand All @@ -95,35 +94,6 @@ nms upgrade -f config.yml -c <controller_name> -i <docker_image> -h my-e2e-contr
docker service update --with-registry-auth --image <image> <service_name>
```

## Clearing topology from controller
You may want to do this because your testing or playing around with the topology and you want to delete the nodes/links/sites afterwards:
1. Find the IP of the controller your network is on and login to it.
2. Determine how the controller was hosted.
1. **K8s**: has ~/.kube folder (TODO: log steps after you do them)

```yaml
cd /opt/terragraph/gfs/e2e/<e2e_controller_name>/data
mv topology.conf{,$(date "+%y%m%d")}
# then delete the controller pod and itll bring itself back up.
```

2. **Swarm**: has docker stuff

```yaml
cd /opt/terragraph/gfs/e2e/<e2e_controller_name>/data
mv topology.conf{,$(date "+%y%m%d")}
docker service ls # find the service ending in e2e_controller
docker service update --force <service_name>
```

3. **Sytemd**: has systemctl list-units | grep e2e ⇒ someone compiled e2e and ran it with systemd

```yaml
cd /root/data
mv topology.conf{,$(date "+%y%m%d")}
systemctl restart e2e_controller
```

## License

TGNMS has an MIT-style license as can be seen in the [LICENSE](LICENSE) file.

0 comments on commit 95a6ddc

Please sign in to comment.