aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/userguide/feature.userguide.rst
AgeCommit message (Collapse)AuthorFilesLines
2021-08-30[dpdk] Remove dpdkstats and dpdkevents pluginsEmma Foley1-79/+29
Remove old dpdk plugins, since they are superceeded by dpdk_telemetry plugin. JIRA: https://jira.anuket.io/browse/BAROMETER-183 Change-Id: Ie4abf2b1fe37a2197d9d5dd01820ac8b0d01df6d Signed-off-by: Emma Foley <efoley@redhat.com>
2021-08-26[docs] Update config and post-installation guidesEmma Foley1-0/+2
The configguide was removed previously because it only contained information about using the OPNFV installers, however, now there appears to be no config information about the plugins. The config information for each plugin is included in the user guide in docs/release/userguide/feature.userguide.rst. This change adds in a note to the the config guide on where to look. Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: I7f71d51846c9116bed3882b96e762ab5d70fdfa4
2021-08-26[docs][userguide] Use literalinclude instead of duplicating the sample configsEmma Foley1-141/+48
This should reduce the inaccuracies, since the sample configs are easier to test, and changes don't have to be sychronised between documents. Change-Id: I92a1937ff0308df25ea3a345f2772027033f0302 Signed-off-by: Emma Foley <efoley@redhat.com>
2021-08-26[docs] Update formatting and linksEmma Foley1-24/+26
* Fix broken links * Update display text for links * Update formatting * Add hyperlink for barometer Change-Id: I472a896a51d2fb5a49a4eaac1aef2bdeeed8d692 Signed-off-by: Emma Foley <efoley@redhat.com>
2021-08-12[docs] Update/remove reference to OPNFVEmma Foley1-10/+5
* Replace OPNFV with Anuket * Update comments where scenarios, installers, etc are mentioned Change-Id: I41d4f38e2f681914d3549fd7baca0e7d7d86a8a3 Signed-off-by: Emma Foley <efoley@redhat.com>
2021-06-04[docs] Update docsEmma Foley1-12/+12
Update references of OPNFV to Anuket Update redirected and invalud links Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: If5663398319c5a0a5c99cff414bc7b2a216218f0
2020-10-06Enabling dpdk_telemetry pluginJabir Kanhira Kadavathu1-0/+19
Enabling dpdk_telemetry plugin with One Click Install. Added the config. templates and the related Documentation. Signed-off-by: Jabir Kanhira Kadavathu <jabir.kanhira.kadavathu@intel.com> Change-Id: Ibecd96d4102cd76a71d31613879ae57950f5108f
2020-06-30Update collectd tags to use main instead of masterEmma Foley1-27/+28
The branch names have been updated, and main has replaced master, which will no longer be updated. Change-Id: Idfce21554594f15a831c8b7ec769eb85d52068b1 Signed-off-by: Emma Foley <efoley@redhat.com>
2018-06-15docs: update userguide with new option for intel_pmu pluginKamil Wiatrowski1-0/+10
Update the userguide for intel_pmu with new "Cores" option available in plugin configuration. Added sample config with default configuration. Change-Id: Ibe4d451131dc2c9ae0282f018c7e23596f4bf2c1 Signed-off-by: Kamil Wiatrowski <kamilx.wiatrowski@intel.com>
2018-03-23Update repo link for collectd-ceilometer-pluginEmma Foley1-6/+6
Since Ceilometer support was removed from the collectd-ceilometer-plugin[1], the repo name is misleading. So the repo name needed to be updated [2] This change updates references to the collectd-ceilometer-plugin repo to point to collectd-openstack-plugins repo: * in deployment operations * in documentation i.e. links to docs Dependencies: [1] https://review.openstack.org/#/c/490823/ [2] https://review.openstack.org/#/c/500768/ This is dependant on the repo rename Change-Id: I43facbd53bca5df3f7e51d978ae2843c187282d4 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-02-10docs: update PMU documentationMaryam Tahhan1-0/+29
Change-Id: Ib6256df8a7911aa43d86026d6c40d99ba98c971a Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2017-12-07VES: Updated CentOS install steps (part 2)Mytnyk, Volodymyr1-6/+10
Change-Id: I3734518709d605e9480f0dca94db4ba7fea037f4 Signed-off-by: Mytnyk, Volodymyr <volodymyrx.mytnyk@intel.com>
2017-11-23docs: add security informationMaryam Tahhan1-0/+39
Change-Id: I014ee8bb762e1c2d9a94bc780816508133e2adf5 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2017-11-20Merge "docs: update userguide with merged plugins"Aaron Smith1-17/+18
2017-11-15docs: update userguide with merged pluginsMaryam Tahhan1-17/+18
Update the userguide to reflect plugins that were merged to collectd master. Change-Id: I8947084d3038dda6fc10dcd91cb3f906dbd2e805 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2017-10-25ves: update VES app user guideMytnyk, Volodymyr1-3/+8
- Updated VES application user guide according to latest changes of VES application. - Fixed sphinx user guide warnings Change-Id: I6e402f2ab5f05ace47d779f87fe650e305973128 Signed-off-by: Mytnyk, Volodymyr <volodymyrx.mytnyk@intel.com>
2017-10-13Removed Table of contentSofia Wallin1-4/+0
Readthedocs generate TOC so it's not needed to add within the documents. Change-Id: Ie4d14df711c89b214773c34294d6b7cd6ee13ad4 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-09-26doc: Update IPMI/Hugepages/SNMP instructionsMytnyk, Volodymyr1-31/+44
Change-Id: I2070aaa7fe20a0a486eb64700129935a80a37ae3 Signed-off-by: Mytnyk, Volodymyr <volodymyrx.mytnyk@intel.com>
2017-08-25docs: updated userguide for E release.Jain, Shobhi1-123/+130
* Updated fuel reference with Apex. * Updated instructions for Centos 7. * Updated configuration to match sample configuration. * Fixed typos. Change-Id: I40fc3eb423589e4643eefb31259937f8a6f96a15 Signed-off-by: Jain, Shobhi <shobhi.jain@intel.com>
2017-08-21docs: add PMU plugin configuration guidePshyk, SerhiyX1-0/+69
Change-Id: Id26dcc68c35b474b80e646a24275b94b5e7f3d9d Signed-off-by: Serhiy Pshyk <serhiyx.pshyk@intel.com>
2017-07-26docs: Cleanup userguide typos and update statusMaryam Tahhan1-33/+59
Change-Id: Id92fe1753c22598781830222deebde01ceddf82e Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2017-07-26Updates OVS PMD stats informationShobhi1-5/+47
Change-Id: I8d1ba578bdb3023ebe20893a818c596b9839c203 Signed-off-by: Shobhi <shobhi.jain@intel.com>
2017-07-14Updates OpenStack plugins informationEmma Foley1-9/+17
* Adds Aodh plugin description * Adds Gnocchi plugin description * Removes Ceilometer plugin * Makes reference to Ceilometer in a demo generic * Adds link to collectd-ceiloemter plugin GSG for configuration instructions Change-Id: I87a68f943c6e30a9fbabd6e3742978ca064e0c7a Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2017-05-23installation: update scripts to actually installMaryam Tahhan1-1/+1
Update the scripts to actually install collectd. Change-Id: I467e4fddbdd7c7b067586ddf24af8c5ec32b72a2 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2017-05-23src: build and install collectd on centos/rhelMaryam Tahhan1-1/+1
Modify build and dependency scripts for centos/rhel builds. Change-Id: I1fafaf3392d9f22837ce4ed3fa0f84c13ead0698 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2017-05-18userguide: update barometer build and installMaryam Tahhan1-7/+1
Update the userguide and the build scripts to only build on supported OSes and to check if collectd is already installed on the system. Change-Id: I87cab22a06f8c1104aae25027aedfa3e534c06b3 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2017-04-24docs: update userguide with SNMP Agent plugin known limitations section.Roman Korynkevych1-0/+8
Change-Id: Ie60f23b3f67fbc0c63c07e6f91644089d09d97de Signed-off-by: Roman Korynkevych <romanx.korynkevych@intel.com>
2017-04-19dpdk stats: add known issues/limitationsMytnyk, VolodymyrX1-0/+29
Change-Id: I8dbd43002f50e65df40cc8bfb516c40f995b9679 Signed-off-by: Mytnyk, Volodymyr <volodymyrx.mytnyk@intel.com>
2017-03-29docs: update userguide for DPDK pluginsPrzemyslaw Szczerbik1-49/+42
Change-Id: I275d1760b59a994c3c8cfd04bbb3c4d8adb67301 Signed-off-by: Przemyslaw Szczerbik <przemyslawx.szczerbik@intel.com>
2017-03-29docs: userguide virt plugin instructionsPrzemyslaw Szczerbik1-0/+139
Change-Id: Ide5acbcccbdf2a151499810d16205f76816601b7 Signed-off-by: Przemyslaw Szczerbik <przemyslawx.szczerbik@intel.com>
2017-03-28docs: update ovs plugins userguideTaras Chornyi1-14/+4
Change-Id: I7aa286bb8e3d38e3255b896351cf41e4c7d03a37 Signed-off-by: Taras Chornyi <tarasx.chornyi@intel.com>
2017-03-26Merge "ipmi doc: build OpenIPMI lib from sources"Maryam Tahhan1-2/+51
2017-03-26Merge "dpdkstat: userguide updated with dpdkstat init notice"Maryam Tahhan1-0/+6
2017-03-23dpdkevents: add example config and update makefilePrzemyslaw Szczerbik1-5/+5
Change-Id: I85edcbbf52dc3bd4d0e53c5076267b9f3f6c2284 Signed-off-by: Przemyslaw Szczerbik <przemyslawx.szczerbik@intel.com>
2017-03-23dpdkstat: userguide updated with dpdkstat init noticeKrzysztof Matczak1-0/+6
Change-Id: I408e16d20f9fa2cc9eae7dcfcfa35e1ce3320de6 Signed-off-by: Krzysztof Matczak <krzysztofx.matczak@intel.com>
2017-03-22docs: finalize userguide for DanubeMaryam Tahhan1-37/+46
Change-Id: Ie6ee71f079898eeb938db43b6542431cfda05875 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2017-03-21ipmi doc: build OpenIPMI lib from sourcesMytnyk, VolodymyrX1-2/+51
Add instatruction on how to build/install OpenIPMI library from sources. Change-Id: I04efc09e85829b23941e28e0e85b567c9a3cbdd7 Signed-off-by: Mytnyk, Volodymyr <volodymyrx.mytnyk@intel.com>
2017-03-14docs: update dpdk plugins userguideTaras Chornyi1-13/+70
Change-Id: I1b70864588f5fbace0d4eeb2098cbf00b1f63442 Signed-off-by: Taras Chornyi <tarasx.chornyi@intel.com>
2017-03-09config guide: Add MIBs location for OVS events pluginMytnyk, VolodymyrX1-1/+5
Change-Id: I14638386cdf7aee3f3e344a2c0e27a6edceaf874 Signed-off-by: Mytnyk, VolodymyrX <volodymyrx.mytnyk@intel.com>
2017-02-17docs: moving to new doc structureMaryam Tahhan1-0/+855
Change-Id: I91188deec2bd4e8aa405a9e023acde42b3fb31f7 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>