aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release
AgeCommit message (Collapse)AuthorFilesLines
2021-08-30[dpdk] Remove dpdkstats and dpdkevents pluginsEmma Foley4-91/+39
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-30Merge "[ansible] Add unixsock to config_files role"Emma Foley2-3/+14
2021-08-30Merge changes from topic "update_docs"Emma Foley4-147/+134
* changes: [docs] Update config and post-installation guides [docs][userguide] Use literalinclude instead of duplicating the sample configs
2021-08-26[ansible] Add unixsock to config_files roleEmma Foley2-3/+14
The unixsock plugin is useful for debugging issues in collectd, and can be used to verify that metrics are being collected without having to create CSV files or log into the container. Typically, the unixsock plugin can be queried using the following syntax:: $ docker exec bar-collectd /opt/collectd/bin/collectdctl -s /var/run/collectd-socket listval Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: Id342fe7659c809f4eec71085ae6572f9d855684c
2021-08-26[ansible] Use collectd_config for default_read_pluginsEmma Foley1-1/+10
Update default_plugins to use the collectd_config role [1] [1] https://github.com/infrawatch/collectd-config-ansible-role JIRA: BAROMETER-180 Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: I9ff9bf642b641132771965346d65c95a3d66b996
2021-08-26[ansible] Use collectd_config for pluginsEmma Foley0-0/+0
* Update the following plugins to use collectd_config role * capabilities * csv * dpdk_telemetry * exec * hugepages * ipmi * logfile * network * ovs_events * ovs_stats * syslog * uuid * write_kafka * write_prometheus JIRA: BAROMETER-180 Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: I2ec9e3c2db2c1d907459b40550012834196f0c65
2021-08-26[docs] Update config and post-installation guidesEmma Foley4-6/+86
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 Foley4-55/+64
* 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-24Merge "[docs] Update/remove reference to OPNFV"Emma Foley4-21/+13
2021-08-12[docs][reno] Update reno to include templateEmma Foley6-10/+59
The template for release notes wasn't conforming to the expected headings. A template was added to the config. To generate a new note (from the base directory in the repo), use:: reno --rel-notes-dir docs/release/release-notes/ new slug-goes-here The release notes are also included as part of the docs build, and the existing releases notes have been renamed accordingly. Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: I05d1950b37f266bb6eb3515b3660665cfd5c1d8b
2021-08-12[docs] Update/remove reference to OPNFVEmma Foley4-21/+13
* Replace OPNFV with Anuket * Update comments where scenarios, installers, etc are mentioned Change-Id: I41d4f38e2f681914d3549fd7baca0e7d7d86a8a3 Signed-off-by: Emma Foley <efoley@redhat.com>
2021-07-14[docs] Add reno to help in creating release notesEmma Foley3-0/+21
Reno[1] is used to create release notes. It can be used in conjunction with sphinx to automatically create and publish release notes. In this case it is being added to help with release notes collation at the end of the release cycle. There is a possibility that it can be more fully integrated later, if there is need for it. For the moment, release notes can be outputted using tox:: tox -e docs-releasenotes Release notes can be added to features using:: reno new slug-goes-here where slug-goes-here is combined with a random suffic to create a unique name for the release note. [1] https://docs.openstack.org/reno/latest/ Change-Id: Id7f113fa4817585bb429503ff3491c633a4ce8e2 Signed-off-by: Emma Foley <efoley@redhat.com>
2021-06-24Add release note for KaliEmma Foley2-0/+41
Change-Id: I79907968e1e894fbe6f6373b87acce08d537c0ae Signed-off-by: Emma Foley <efoley@redhat.com>
2021-06-07Merge "[docs] Update docs"Matthias Runge7-26/+28
2021-06-04[docs] Update docsEmma Foley7-26/+28
Update references of OPNFV to Anuket Update redirected and invalud links Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: If5663398319c5a0a5c99cff414bc7b2a216218f0
2021-06-03[docker] Add collectd-6Emma Foley1-0/+38
* Add instruction to docs/ for using docker/barometer-collectd-experimental/Dockerfile to build collectd version 6 * Add a new COLLECTD_FLAVOR to src/collectd/Makefile to configure tags for a collectd 6 build. * Allow passing COLLECTD_CONFIG_CMD_ARGS to the collectd build For testing with new plugins for collectd-6, as un-ported plugins are disabled by default. This new option lets the ./configure command be run with extra args, e.g. --enable-cpu --enable-<my-newly-ported-plugin>, which means that plugin can be enabled for the PR that is being tested. * Update flavor_image_name selection to include collectd-6 Change-Id: I55ee0bbcb5d89357b1ef11ab17c5b029603ecdf7 Signed-off-by: Emma Foley <efoley@redhat.com>
2020-11-24[ansible][dpdk] Disable dpdkstats and dpdkevents by defaultEmma Foley1-2/+10
The dpdk_telemetry plugin superceeds the dpdk{stats,events} plugins, and these cannot be enabled together. Since the stable container on CentOS 8 uses DPDK 19.11, the dpdk_telemetry plugin should be used instead. Change-Id: I20e087b40ff90ba95741aaff641ef1a745d77dd8 Signed-off-by: Emma Foley <efoley@redhat.com>
2020-11-19[container][experimental] Update the collectd_apply_pull_request.shEmma Foley1-5/+12
Updated the script to take the PR list from the environment Updated the container to allow users to pass COLLECTD_PULL_REQUESTS as a build-arg when building the container so they don't have to hard code values to change the PRs that are applied Change-Id: Ie820709d5f57712dc246b6728c772e086e53ab5b Signed-off-by: Emma Foley <efoley@redhat.com>
2020-11-19[container][latest] Rename and update barometer-collectd-latestEmma Foley1-24/+25
Collectd changed the upstream default to main, and Barometer added a few changes to incorporate this. One change was renaming the `barometer-collectd-master` container to `barometer-collectd-latest`, since `barometer-collectd-main` didn't make sense semantically, as we use the stable container as the "main" reference. At the time, we didn't have the changes made in releng to build the new container, so container renaming was paused. Now that the change is merged in releng (and has been for a while), and the containers are being updated, this change should happen, so that the container gets published. Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: I4ee91c289b9e7477157bea148452be58343dc733
2020-10-19[docs] Remove refs to unsupported installersEmma Foley2-202/+0
For Jerma, a documentation restructure was proposed [1]. This change removes reference to unsupported installers in Barometer. [1] https://wiki.opnfv.org/display/meetings/OPNFV+TSC+Meeting+2020-10-13?preview=/63111416/63111451/OPNFV-docstructure.pdf Change-Id: Id55e55c3a4ea824c20fcadcfc4716ff8d23cc68f Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: Ic732d5f621d9a3e76cc76a97eacebbde7be139d7
2020-10-19[docs] Remove scenariosEmma Foley6-286/+0
For Jerma, a documentation restructure was proposed [1]. THis change removes reference to scenarios in Barometer. [1] https://wiki.opnfv.org/display/meetings/OPNFV+TSC+Meeting+2020-10-13?preview=/63111416/63111451/OPNFV-docstructure.pdf Change-Id: Id55e55c3a4ea824c20fcadcfc4716ff8d23cc68f Change-Id: I135226f7ecc72ee086effede68f92ade0c85d0a2 Signed-off-by: Emma Foley <efoley@redhat.com>
2020-10-06Enabling dpdk_telemetry pluginJabir Kanhira Kadavathu2-6/+26
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-08-25Upgrading dpdk version to 19.11Jabir Kanhira Kadavathu1-5/+10
Upgrading dpdk version from 18.11 to 19.11 Added notes regarding backward compatability. Signed-off-by: Jabir Kanhira Kadavathu <jabir.kanhira.kadavathu@intel.com> Change-Id: Id95598ca92efd8c39025ea295ddf3521b138c79c
2020-07-14Temperorily revert "Rename collectd container to barometer-collectd-latest"Emma Foley2-23/+22
This reverts commit 59338794c8ae8ff82c00dc14ea47a9279cc213d4. The reason for reverting is that there is not yet a container image available on Dockerhub for barometer-collectd-latest Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: Ia6e37af99787a6c02eb368fc7bfdd9d584716f2b
2020-06-30Rename collectd container to barometer-collectd-latestEmma Foley2-22/+23
Change-Id: I0dfff659b4e05e3e619ea62f1771db79f7a8f0df Signed-off-by: Emma Foley <efoley@redhat.com>
2020-06-30Update collectd tags to use main instead of masterEmma Foley3-32/+33
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>
2020-05-27Moving DPDK Verion From 16.11 to 18.11.jabirkkclt1-1/+5
Updated the related section in userguide. Also updated the change in kni location for 18.11. Signed-off-by: jabirkkclt <jabir.kanhira.kadavathu@intel.com> Change-Id: If5f71f1803c65031b2c759052f571ce55b9ed4b6
2020-05-27Merge changes from topic "container_update"Emma Foley1-13/+16
* changes: [docs] Update Docker install guide Update collectd container to use 5.11
2020-05-22[docs] update formatting on one click installEmma Foley1-55/+71
Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: If4a5bbe119ce0a0dd0bed950f793b747e234cd61
2020-05-22[docs] Update Docker install guideEmma Foley1-13/+16
Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: I03b89331fa45c542339fec9dfcd035649d930679
2020-05-22[docs] Fix docs to pass rtd jobsEmma Foley1-2/+3
Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: I8351e3defe15cd699a629bc3f78ecd074f0d9dd0
2020-01-20[docs][ves] Update path for ves configsEmma Foley1-1/+1
JIRA: Barometer-133 Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: I7f427089b6e9a7c81a0bbea36b6af46bf721a042
2019-12-16Revert "Updating the DPDK Version to 18.11 (Latest Stable Release) and ↵jabirkkclt1-1/+1
respective information in teh one click install userguide." This reverts commit 4fc25349916eca67d27dbf193fc69d1d0afecf3c. Signed-off-by: jabirkkclt <jabir.kanhira.kadavathu@intel.com> Change-Id: I5ec8ff8e90a6fa5bd5f7d0eda22e0e9d28427312
2019-12-13Merge "Fix the Makefile for intel-cmt-cat so it can be build without errors ↵Matthias Runge1-3/+24
on CentOS 7. Mount the /sys/fs/resctrl from host to container to avoid issues with intel_rdt plugin."
2019-12-11Merge "Provided the correct path for schema yaml & config files to avoid ↵Emma Foley1-1/+1
issues in starting VES Application."
2019-12-09Fix the Makefile for intel-cmt-cat so it can be build without errors onjabirkkclt1-3/+24
CentOS 7. Mount the /sys/fs/resctrl from host to container to avoid issues with intel_rdt plugin. Change-Id: I04d22fccb950aabbde774c1850a5b44ee57908f5 Signed-off-by: jabirkkclt <jabir.kanhira.kadavathu@intel.com> Signed-off-by: Kamil Wiatrowski <kamilx.wiatrowski@intel.com>
2019-12-05Merge "Updating the DPDK Version to 18.11 (Latest Stable Release) and ↵Emma Foley1-1/+1
respective information in teh one click install userguide."
2019-12-02Provided the correct path for schema yaml & config files to avoid issues in ↵jabirkkclt1-1/+1
starting VES Application. Signed-off-by: jabirkkclt <jabir.kanhira.kadavathu@intel.com> Change-Id: Id02a8a601a6e98fce5f887c80baae9f1c5cec6fd
2019-11-26Adding a comment under 'confiure ssh keys' to make the user aware about the ↵jabirkkclt1-0/+1
necessity of it. Signed-off-by: jabirkkclt <jabir.kanhira.kadavathu@intel.com> Change-Id: Ie474bab8fb3e6db6954769fc00a66d659ef66dfc
2019-11-22Updating the DPDK Version to 18.11 (Latest Stable Release) and respective ↵jabirkkclt1-1/+1
information in teh one click install userguide. Signed-off-by: jabirkkclt <jabir.kanhira.kadavathu@intel.com> Change-Id: Ib0b0892eed4f654068bf376d9f2b9da2e6043b74
2019-11-22Updated/corrected the path for ves application config filejabirkkclt1-1/+1
Signed-off-by: jabirkkclt <jabir.kanhira.kadavathu@intel.com> Change-Id: Ib4243f84aaba3d7920c51e0da3fad54c960e53eb
2019-11-081. Added one dependency step for installation in Ubuntu,to match with that ↵jabirkkclt1-2/+9
of in centos. 2. Updated default.inv documentation for the latest changes in the actual file in the Repository Signed-off-by: jabirkkclt <jabir.kanhira.kadavathu@intel.com> Change-Id: I2ab5b30bf2954cf247fdb56763e90a314db9c90f
2019-07-04[docs][install] Split the docker and ansible install guidesEmma Foley3-326/+348
docker.userguide.rst contained two methods of installation: * Manual installation of all the docker containers * one-click install using ansible A new user is potentially going to be confused about which document to use, and may not be aware that the two options exist. This change splits the install guide into two documents, one for docker, and one for ansible. It also renames the docker guide to make it more obvious to the user what is contained in the guide. Change-Id: I1ecdd7d15f8f53c80221916379982bca2673a06d JIRA: BAROMETER-128 Signed-off-by: Emma Foley <efoley@redhat.com>
2019-06-19Updated the typo in diagrams for 3 modes of VES Operations.jabirkkclt3-0/+0
Change-Id: If197bf24f8b834a81f21aa99b2d89b7b70ffad54 Signed-off-by: jabirkkclt <jabir.kanhira.kadavathu@intel.com>
2019-05-08docker.userguide: Add info about collectd master & experimental containersKamil Wiatrowski1-11/+129
Added chapters about different collectd container flavors that can be chosen in barometer project. Change-Id: If6383231580749c37d2ff0ecc43f62b67434e51c Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com> Signed-off-by: Kamil Wiatrowski <kamilx.wiatrowski@intel.com>
2019-04-10ansible: update docker userguide for collectd_vesKamil Wiatrowski1-17/+21
Change-Id: I54a2d46b8acecea6f6278f130d7567acc813c324 Signed-off-by: Kamil Wiatrowski <kamilx.wiatrowski@intel.com>
2019-01-24Merge "Add git installation to docker guide"Matthias Runge1-0/+1
2019-01-22Add git installation to docker guideopnfv-8.1.0stable/hunterMatthias Runge1-0/+1
Change-Id: I1e94ddaa7b877adacd874d3c2b02ea5939892dcc Signed-off-by: Matthias Runge <mrunge@redhat.com>
2018-12-12docker.userguide: Add note about 'python' dependency in multi node setupRadoslaw Jablonski1-0/+6
Ansible needs python2 to be able to finish discovery on remote host and on some distributions it may not be installed by default. Added note about this dependency - 'python' package has to be installed on each node in multi-node-setup. Change-Id: I2741325a7b4b1b38bdfb1af427c65eeb90408aa6 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>