diff --git a/README.md b/README.md index 2b54333..17d3593 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,22 @@ * Service Platform infrastucture (sp_mon) * VNFs (vm_mon) * VIMs (op_mon) + * Containers (cnf_mon) More detailed information about installation, dependencies etc are available in README files of each probe. -## Development -To contribute to the development of the monitoring probes you have to fork the repository, commit new code and create pull requests. +## Licensing -## License -Monitoring probes are published under Apache 2.0 license. Please see the LICENSE file for more details. +Monitoring framework is published under Apache 2.0 license. Please see the LICENSE file for more details. #### Lead Developers -The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests. - * Panos Trakadas (trakadasp) - * Panos Karkazis (pkarkazis) +The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests. + + * Panos Karkazis (pkarkazis) + * Panos Trakadas (trakadasp) -#### Feedback-Chanel +#### Feedback-Chanel -* Please use the GitHub issues to report bugs. \ No newline at end of file +* You may use the mailing list [sonata-dev-list](mailto:sonata-dev@lists.atosresearch.eu) +* You may use the GitHub issues to report bugs \ No newline at end of file diff --git a/cnf_mon/README.md b/cnf_mon/README.md index 7a586d0..280f7ff 100644 --- a/cnf_mon/README.md +++ b/cnf_mon/README.md @@ -2,17 +2,7 @@ [5GTango](http://5gtango.eu)/[Sonata](http://sonata-nfv.eu) - -## Development -To contribute to the development of the monitoring probes you have to fork the repository, commit new code and create pull requests. - -### Dependencies - * python 3 - * prometheus-client - * requests - - -## Installation +## Installing / Getting started Build container ``` @@ -24,7 +14,24 @@ Run monitoring probe as container sudo docker run -d -e "VNF_STATS_URL=http://:" -e "PW_URL=:" -e "INTERVAL=2" --name tng-stats-coll tng-stats-collector ``` -## License + +## Developing +To contribute to the development of the monitoring probes you have to fork the repository, commit new code and create pull requests. + +### Built With + * python 3 + * prometheus-client + * requests + +### Submiting changes + +To contribute to the development of the 5GTango/SONATA monitoring framwork you have to fork the repository, commit new code and create pull requests. + +## Versioning + +The most up-to-date version is v5.0. + +## Licensing This implemantation is published under Apache 2.0 license. Please see the LICENSE file for more details. @@ -32,10 +39,11 @@ This implemantation is published under Apache 2.0 license. Please see the LICENS #### Lead Developers The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests. - - * Panos Trakadas (trakadasp) - * Panos Karkazis (pkarkazis) + + * Panos Karkazis (pkarkazis) + * Panos Trakadas (trakadasp) #### Feedback-Chanel -* Please use the GitHub issues to report bugs. +* You may use the mailing list [sonata-dev-list](mailto:sonata-dev@lists.atosresearch.eu) +* You may use the GitHub issues to report bugs diff --git a/op_mon/README.md b/op_mon/README.md index 12f6356..94c2c60 100644 --- a/op_mon/README.md +++ b/op_mon/README.md @@ -8,14 +8,8 @@ Among the monitoring metrics supported by the probe are: * Total/used RAM size * Total/used Floating IPs -## Development -To contribute to the development of the monitoring probes you have to fork the repository, commit new code and create pull requests. - -### Dependencies - * python 2.7 +## Installing / Getting started - -## Installation From code a. Set configuration file (odc.conf) @@ -34,18 +28,30 @@ b. Execute the probe sudo pyhton opensdatacollector.py ``` -## License +## Developing +To contribute to the development of the monitoring probes you have to fork the repository, commit new code and create pull requests. + +### Built With + * python 2.7 + -This son-vim-probe is published under Apache 2.0 license. Please see the LICENSE file for more details. +### Submiting changes +To contribute to the development of the 5GTango/SONATA monitoring framwork you have to fork the repository, commit new code and create pull requests. +## Versioning +The most up-to-date version is v5.0. + +## Licensing +Monitoring framework is published under Apache 2.0 license. Please see the LICENSE file for more details. #### Lead Developers The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests. - - * Panos Trakadas (trakadasp) - * Panos Karkazis (pkarkazis) + + * Panos Karkazis (pkarkazis) + * Panos Trakadas (trakadasp) #### Feedback-Chanel -* Please use the GitHub issues to report bugs. +* You may use the mailing list [sonata-dev-list](mailto:sonata-dev@lists.atosresearch.eu) +* You may use the GitHub issues to report bugs diff --git a/sp_mon/README.md b/sp_mon/README.md index 03767dd..ebd4e7a 100644 --- a/sp_mon/README.md +++ b/sp_mon/README.md @@ -7,14 +7,7 @@ Among the monitoring metrics supported by the probe are: * disk usage * network traffic -## Development -To contribute to the development of the monitoring probes you have to fork the repository, commit new code and create pull requests. - -### Dependencies - * python 2.7 - * docker-engine 1.10.2 - -## Installation +## Installing / Getting started Build container ``` @@ -26,16 +19,36 @@ Run monitoring probe as container sudo docker run --net="host" -e "NODE_NAME=INT-SRV-1" -e "PROM_SRV=http://sp.int2.sonata-nfv.eu:9091/metrics" --privileged=true -d -v /var/run/docker.sock:/var/run/docker.sock -v /proc:/myhost/proc -v /:/rootfs:ro son-sp-mon ``` -## License -This son-sp-probe is published under Apache 2.0 license. Please see the LICENSE file for more details. +## Developing +To contribute to the development of the monitoring probes you have to fork the repository, commit new code and create pull requests. + +### Built With + + * python 2.7 + * docker-engine 1.10.2 + + +### Submiting changes + +To contribute to the development of the 5GTango/SONATA monitoring framwork you have to fork the repository, commit new code and create pull requests. + +## Versioning + +The most up-to-date version is v5.0. + +## Licensing + +Monitoring framework is published under Apache 2.0 license. Please see the LICENSE file for more details. #### Lead Developers -The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests. - * Panos Karkazis (pkarkazis) - * Panos Trakadas (trakadasp) +The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests. + + * Panos Karkazis (pkarkazis) + * Panos Trakadas (trakadasp) #### Feedback-Chanel -* Please use the GitHub issues to report bugs. +* You may use the mailing list [sonata-dev-list](mailto:sonata-dev@lists.atosresearch.eu) +* You may use the GitHub issues to report bugs diff --git a/vm_mon/README.md b/vm_mon/README.md index b298789..418f98c 100644 --- a/vm_mon/README.md +++ b/vm_mon/README.md @@ -8,15 +8,8 @@ Among the monitoring metrics supported by the probe are: * disk usage * network traffic (transmitted bytes, received bytes, packets per second, bytes per second) -### Dependencies - * python 2.7 - - -### Development -To contribute to the development of the monitoring probes you have to fork the repository, commit new code and create pull requests. - -### Installation +### Installing / Getting started a. From code ``` export PROM_SRV=http://:/metrics @@ -31,15 +24,35 @@ sudo docker run -d --name son-vm-probe -e NODE_NAME=VNF_1 -e PROM_SRV=http://