summaryrefslogtreecommitdiffstats
path: root/docs/release/userguide
AgeCommit message (Collapse)AuthorFilesLines
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>
2018-12-11Update docker userguide: dpdk pluginsKamil Wiatrowski1-2/+5
Add dpdk plugins to description of ansible installation. Change-Id: I89e8ec6c0918455dd4df5d086fbc2475200054ce Signed-off-by: Kamil Wiatrowski <kamilx.wiatrowski@intel.com>
2018-12-11Merge "docker.userguide: Fix instruction for installing ansible"Matthias Runge1-2/+2
2018-12-10docker.userguide: Fix instruction for installing ansibleRadoslaw Jablonski1-2/+2
Previous version of instruction for installing ansible under pip was problematic when called as a regular user because pip was trying to use wrong(local home) directory for caching. It may cause problems when home directory is located on NFS. Change-Id: Ia9eb15d1be0db0cb5aa5f3fd04a7a166ff1046b2 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-12-07docker.userguide: Fix ansible-playbook instruction for non-root userRadoslaw Jablonski1-1/+1
Now using 'sudo -H' instead raw sudo - without that option ansible on some systems(e.g. Ubuntu 16.04) will try to use regular user home directory for caching (it may be not accessible when home is mounted using Network File System) Change-Id: I9d7e14613d7e27f86c43926c05b368972527e072 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-12-04docker.userguide: Add chapter about cleanup influxdb/grafanaRadoslaw Jablonski1-0/+24
Added chapter about cleaning influxdb and grafana configurations. Config files for both are stored in folders that are shared between container and Host machine - it is good to remove them when removing barometer docker containers in case of re-installation or changing active setup. Change-Id: If84c0f0ee91560275b4834bc98dbdff518a059a8 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-11-27docker.userguide: Add info about using influxdb in multi-node setupRadoslaw Jablonski1-0/+52
Added chapter about steps that have to be performed in order to run collect and influxdb on separate Hosts (manual setup) Change-Id: Ia4b1234aa1346afdc27ec5eabb795dfac06f0522 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-11-23Merge "docker.userguide: Add --network=host option for manual docker build ↵Matthias Runge1-2/+2
examples"
2018-11-21Merge "docker.userguide: Fix instruction for copying ssh keys"Matthias Runge1-1/+2
2018-11-16docker.userguide: Add --network=host option for manual docker build examplesRadoslaw Jablonski1-2/+2
On Ubuntu hosts (16.04 & 18.04) there might be problem to build docker collectd container if host is behind a proxy even if proxy variables are set correctly - when using "--network=host" option problem is resolved. This option has no negative impact on other host systems so adding it to default command line build example. Change-Id: I69ebd13f1e05658d8ad18e3ec379f515312e7b74 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-11-15docker.userguide: Fix instruction for copying ssh keysRadoslaw Jablonski1-1/+2
Previously 'ssh-copy-id' command tried to upload key from non-root user directory and next command was expecting that root key was copied (in that case ansible was unable to log into host machine) Change-Id: Iba25e6a8da0e5902883e5aa876f735e8f632d3b9 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-11-10Fix DMA docker image url in docker userguideYuki Kasuya1-13/+13
JIRA: BAROMETER-118 This fix DMA docker image url from opnfv/barometer-localagent to opnfv/barometer-dma Change-Id: Ia11f388f31129b0636407e1af5139c747a861b87 Signed-off-by: Yuki Kasuya <yu-kasuya@kddilabs.jp>
2018-11-09Merge "docker.userguide: Add a note about bar-collectd run without DPDK/RDT"Aaron Smith1-2/+19
2018-11-09Merge "docker.userguide: Fix manual grafana and influxdb run commands"Aaron Smith1-5/+8
2018-11-09Merge "docker.userguide: Remove 'docker-compose' chapter"Aaron Smith1-80/+3
2018-10-30docker.userguide: Remove 'docker-compose' chapterRadoslaw Jablonski1-80/+3
Removed 'docker-compose' and 'docker testing' chapters because they are not required for the release or as per the commitment(and ansible one-click-install is natural replacement for docker-compose functionality in barometer) Change-Id: If1db50954a290b27fa24f0285b4239891bb9ada8 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-10-25docker.userguide: Add link to VES collector setup instructionsRadoslaw Jablonski2-0/+8
Change-Id: I7633e98af0fb58baad08a3761742f5f1e2a0e917 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-10-19docker.userguide: Add a note about bar-collectd run without DPDK/RDTRadoslaw Jablonski1-2/+19
Added a note with information what happens if RDT/DPDK dependency will be missing on host during manual starting bar-collectd container(with info what should be done in such scenario to start bar-collectd anyway) Change-Id: I11ba595e8925027c772920876c4bf2967f33de88 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-10-18docker.userguide: Fix manual grafana and influxdb run commandsRadoslaw Jablonski1-5/+8
Previously ports were exported for grafana and influxdb but no network was mapped - no connection was possible between both containers (only connection from host to container was possible). Now container network is mapped to host - the same approach is used by ansible automatic installation for collectd, influxdb and grafana containers. Change-Id: I81af33d028bb8bc55590324694af93993f0f1d8c Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-10-09docker.userguide: Add chapter for ansible proxy configurationRadoslaw Jablonski1-2/+63
Change-Id: I0bb2f2af64001de5e029aa49a79f9627a5f405c2 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-10-05Merge "docker.userguide: Fix docker run commands examples"Aaron Smith1-7/+18
2018-10-05Merge "Add role to auto install docker on hosts - missing patch"Aaron Smith1-11/+42
2018-10-04Add role to auto install docker on hosts - missing patchKamil Wiatrowski1-11/+42
Small updates to ansible roles. Several minor updates in documentation. Change-Id: Id031cebc23301b6218f8ced0d261f844f270e37f Signed-off-by: Kamil Wiatrowski <kamilx.wiatrowski@intel.com>
2018-10-04docker.userguide: Fix docker run commands examplesRadoslaw Jablonski1-7/+18
Command example for running opnf-barometer-collectd and grafaana images were using incorrect locations for configuration files. Change-Id: I3f0648f810cc049ae1df4d742f2ed7b58b50b12a Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
2018-10-03Adding support for prometheus using ansibleJohn O Loughlin1-0/+3
To enable add the following with your ip address to your inventory file: [prometheus_hosts] 172.24.4.19 Change-Id: I85add815367bcbcf1240398db2c43c2130537969 Signed-off-by: John O Loughlin <john.oloughlin@intel.com>
2018-10-02Merge "WIP: Add role to auto install docker on hosts"Aaron Smith1-0/+209
2018-09-28WIP: Add role to auto install docker on hostsKamil Wiatrowski1-0/+209
Auto install docker with dependencies on hosts: apt install python apt install python-pip pip install docker-py apt install docker.io Set docker proxy using host proxy settings. Updated documentation. Change-Id: Ibec7e0a7e484d5a9a8656cd3598c3acc7c2e2184 Signed-off-by: Kamil Wiatrowski <kamilx.wiatrowski@intel.com>
2018-09-14Fix links to remove references to submodulesAric Gardner2-4/+5
All references to submodules must be removed for docs to work going forward. Can be tested once your project has a local tox file Change-Id: Ia3e70902fb23c3612372b01aa2f51512057af951 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2018-09-07docs: Add DMA procedure to Docker userguideToshiaki Takahashi1-0/+106
Change-Id: I61a6a9880f393e764222e508645a60b3f636e02a Signed-off-by: Toshiaki Takahashi <takahashi.tsc@ncos.nec.co.jp>
2018-07-10Merge "docs: update userguide with new option for intel_pmu plugin"Aaron Smith1-0/+10
2018-06-15Fix docsJohn O Loughlin1-3/+3
Remove --net=host as it should not be used when port mapping with the -p option Change-Id: I7d6d73fe176362fc74df99200a6d68d2a3ec0994 Signed-off-by: John O Loughlin <john.oloughlin@intel.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-04-03Merge "Update repo link for collectd-ceilometer-plugin"Aaron Smith1-6/+6
2018-03-27Fix docs for container deploymentJohn O Loughlin1-12/+12
Change-Id: I4a610d8686d758913d73ca684db41616daf391bd Signed-off-by: John O Loughlin <john.oloughlin@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-21docs: update userguide with zookeeper instance tags and fix typosGordon Kelly1-4/+4
Change-Id: I916f6e9388a7ac25ff0b5631ec49fa25157c909f Signed-off-by: Gordon Kelly <gordon.kelly@intel.com>
2018-02-10docs: update PMU documentationMaryam Tahhan1-0/+29
Change-Id: Ib6256df8a7911aa43d86026d6c40d99ba98c971a Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2018-01-26docs: update docker userguide with steps for VES and Kafka docker imagesGordon Kelly1-60/+239
Change-Id: I1b5a5112afe6771c5f31c56ffc856aef3450fec6 Signed-off-by: gordonkelly <gordon.kelly@intel.com>
2018-01-23docs: update docker userguide for running docker compose filesGordon Kelly1-6/+87
Change-Id: Ib41d6d475506ff3920bb914aeebf9dca4070fa8c Signed-off-by: gordonkelly <gordon.kelly@intel.com>
2018-01-23docker: updated grafana image to continue to send API request to grafanaGordon Kelly1-4/+37
Updated grafana image to continue to send API request to grafana server at 1 sec intervals at start time until grafana server is up and listening on port. Dashboards folder has been moved to /opt/grafana/dashboards. Documentation updated accordingly for all changes Change-Id: I748b05372f0aa0890d3befa5645834fb217db784 Signed-off-by: gordonkelly <gordon.kelly@intel.com>
2018-01-12docker: rename barometer image and update documentationGordon Kelly1-48/+65
Rename the barometer image from barometer to barometer-collectd to align with naming convention of other barometer images and move relevant files to new barometer-collectd directory.Docker userguide also updated accordingly Change-Id: Id866baf41bc38d3db8575ee00abfc64e97c7259b Signed-off-by: gordonkelly <gordon.kelly@intel.com>
2018-01-11Merge "docs: update ves documentation and add steps to run on baremetal nodes"Aaron Smith6-97/+182
2018-01-11docs: update ves documentation and add steps to run on baremetal nodesGordon Kelly6-97/+182
Change-Id: I0dad9b8eee5b9cfcce8999d6ffe66fb32e9a382c Signed-off-by: gordonkelly <gordon.kelly@intel.com>
2018-01-11docker: rename grafana directoryMaryam Tahhan1-63/+33
Rename the grafana directory to barometer-grafana and remove references to docker compose from the documentation till we have a new barometer docker compose file. Change-Id: I4f64a6c10a146a39549380bb33837ae7c39cac2a Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>