perfsonar / docs Goto Github PK
View Code? Open in Web Editor NEWDocumentation of the perfSONAR project
Documentation of the perfSONAR project
Work with Devs to populate a list of error messages from the various logs with next step suggestions.
It would be nice to add an example of a fully redundant, load balanced measurement archive to the clustering page. Right now it does a survey of the various options, but a single example would be good. The example should include:
From @arlake228 on March 14, 2015 12:44
Original issue 1025 created by arlake228 on 2014-12-22T15:10:28.000Z:
A user writes:
=-=-=-=-
I have some things that are not working correctly on my mesh (traceroute and pingER tests are not working, owamp tests do work tho). Since this is broken on every single one of my mesh hosts (all running toolkit 3.4.1), I'm assuming there is something wrong with my mesh config.
Question: Where can I find a valid example mesh config file?
Per the perfSonar Mesh Config Instructions found here:
https://code.google.com/p/perfsonar-ps/wiki/MeshConfigurationInstallation
There is an example mesh config located at /opt/perfsonar_ps/mesh_config/doc/example.conf and also at:
http://perfsonar-ps.googlecode.com/git/perfSONAR_PS-MeshConfig/doc/example.conf
However the read_url and write_url values in these example files look wrong to me (they look like pre-esmond URLs) so I'm assuming (perhaps incorrectly) that these examples are out of date.
Can someone clarify if the above example mesh config files are valid or not, and if they are not, is there updated documentation somewhere on the recommended way to create a mesh config file in the correct format?
=-=-=-=-
They were pointed to this location, the wiki and RPM should be updated (or removed) so that we are consistent:
http://docs.perfsonar.net/multi_server_config.html#generating-the-configuration
The user goes on to say that in this example:
http://docs.perfsonar.net/multi_server_config.html#generating-the-configuration
does not have any "measurement_archive" sections included (where the read_url and write_url configs normally live). Is the "measurement_archive" config optional in the latest version, or is this example config incomplete?
Copied from original issue: perfsonar/project#1023
Trying to install NetInstall rc2 and selecting the first initial menu item which should lead to graphical installer it goes to text mode for a few screens first. It may be confusing so add some clarification.
subject says it all
Fill in the following files:
@bltierney commented on Mon Jan 23 2017
Need to verify that all information at:
http://docs.perfsonar.net/release_candidates/4.0rc2/manage_dual_xface.html
Is accurate for new OSes (CentOS7 and Debian)
Also update the docs if needed.
http://docs.perfsonar.net/release_candidates/4.0rc1/install_centos.html
Under Step 7, starting services there is no mention of what services should be running on a central management server
From: [email protected] [mailto:[email protected]] On Behalf Of Daniel Spisak
Sent: Mittwoch, 15. Februar 2017 04:39
To: [email protected]
Subject: [perfsonar-user] Questions about perfsonar 4
Ubuntu 12.04 LTS reaches End of Life on April 28th 2017. It is probably better not to release perfSONAR packages for this distro nor support it with our 4.0 release.
If we decide this, we should remove all mention of Ubuntu 12.04 LTS from the documentation and the website.
From Soichi:
Lastly, the documentation doesn't explain if numeric fields can be integer or decimal (and if decimal, number of acceptable precision). For example, it looks like bucket_width/packet_interval can be decimal, but sample_count is an integer? If you could add more specific numeric specification, I can add appropriate validations on the UI to prevent user from entering invalid numbers.
Mark:
I added pscheduler.log to this file, but I'm not sure if the description is accurate, or what other pscheduler logs should be worth mentioned. Tho maybe the logs should be made to match the description, and that info is typically quite useful.
Also, others should confirm that the components they are responsible for are accurate too.
Assigning this issue to everyone I think probably should take a look. Please add a comment when you confirm that your stuff is accurate.
This page is very out of date for 4.0, and needs to be updated before the release:
http://www.perfsonar.net/deploy/hardware-selection/hardware-advice/
Delete http://www.perfsonar.net/deploy/security-considerations/ . Review if there are parts to be moved to docs. Keep all firewall details in docs.perfsonar.net.
I need to come up with a mechanism for building and linking to previous versions of the documentation.
the file manage_security.rst needs to be updated to include info on firewalld.
This a placeholder issue to collect any items for addition to a Troubleshooting document for all things installation, meshconfig, and MaDDash
Example:
This is important if you are running a mutli-homed host. Tracepath simply doesn't provide an option for this and we should document this better.
http://www.perfsonar.net/deploy/bwctl-protection/ - add similar (sub-)section about pscheduler. Remove details and refer for them to docs.perfsonar.net instead of providing code here. See also #26
The simplestreamer
tool uses incoming TCP ports 10000-10010. This needs to be added to the docs.
Finish this page, including added a summary of NTP requirements, and ntpd vs chrony explaination.
http://docs.perfsonar.net/release_candidates/4.0rc3/using_tools.html
Currently this section http://docs.perfsonar.net/release_candidates/4.0rc1/manage_logs.html#determining-who-is-testing-to-your-host describes the process which is using some old references. It's not sure the script is still working as expected and how it should present data in 4.0. It needs verification of the script usage by developers and then section update. It may be related to perfsonar/toolkit#14
This page is out of date.
Port usage section should be a link to docs.perfsonar.net/manage_security.html, which now includes this information.
Add the following to meshconfig docs:
reference
parametercreated_by
parameterconfigure_archives
at test levelOur documentation should answer these:
What happens if the central MA goes down for a while, or the network to
the central MA? Are the measurements lost, or are they buffered to be
delivered later? Does this have any effect on the timing of subsequent
measurements?
What if there are multiple MAs selected, but only one is down or
unreachable?
User requested:
http://docs.perfsonar.net/install_options.html the section that lists the five alternative installation options would be significantly clearer with a simple block diagram showing the inter relations of the packages as well as the relationship to a "Full Installation" from the downloaded iso.
A few places we have steps like the following:
source /opt/rh/python27/enable
/opt/rh/python27/root/usr/bin/virtualenv --prompt="(esmond)" .
. bin/activate
Those are only needed on CentOS 6 (not CentOS 7), we should indicate as much.
Based on user request:
"I plan to migrate my perfsonarservers on a new hardware,
after the 3.5 version is installed and works on my old servers.
Is ther a list of what needs to be copied on the new servers?"
There probably just need to be a migration page added under "Managing the perfSONAR Toolkit” that highlights the important stuff.
Add/fix Google widget to allow for searches to properly resolve using the onpage search box.
Dan pointed out that the autoconfig page doesn't indicate that when you use configure_archive you also need to configure IP authentication on your MA. Should add a note on this and a pointer to http://docs.perfsonar.net/3.5rc2/multi_ma_install.html#authenticating-by-ip-address
It would be good to extend current documentation to provide some common test profiles/templates i.e. toolkit settings (test duration, intervals, parameters, etc) for different measurement purposes to better reflect specific test traffic.
https://www.perfsonar.net/about/faq/#Q121
It points to: /usr/lib/perfsonar/web/root/gui/services/etc/web_admin.conf
Current file location: /usr/lib/perfsonar/web-ng/etc/web_admin.conf
Some changes happened in perfsonar/toolkit#157 that needs to be reflected in the documentation.
Sections:
http://www.perfsonar.net/deploy/installation-and-configuration/ - the same flow chart as in http://www.perfsonar.net/about/where-can-it-be-downloaded/.
Remove flow charts from web site. Refer to docs instead.
Remove install options details from "Installation & Configuration" and refer to docs.
Most of the CLI related documentation we have needs to be reviewed in light of a Debian or Ubuntu installation. Let's track all the needed changes here.
Installation:
File locations:
Updates:
Central Server management:
Puppet for Debian?
We should double check the config files list:
Example of changes needed:
/sbin/service
is /usr/sbin/service
on Debian, but maybe we can refer to the command as service
only.http://docs.perfsonar.net/release_candidates/4.0rc1/install_centos.html
You should reference epel-release-7-9.noarch.rpm as 7-8 no longer exists it seems
From: [email protected] [mailto:[email protected]] On Behalf Of Daniel Spisak
Sent: Mittwoch, 15. Februar 2017 04:39
To: [email protected]
Subject: [perfsonar-user] Questions about perfsonar 4
From @arlake228 on March 14, 2015 12:52
Original issue 1071 created by arlake228 on 2015-02-03T15:10:01.000Z:
Describe the enhancement:
A user requested to add what exactly is the list of services that should be chkconfig'd on for a Latency box & for a Bandwidth box. Or maybe add a special note in 2.7.4 Special Upgrade Notes.
Example from user:
Not as in sec 2.4 via the web interface, but from cli:
chkconfig --list | sort | grep :on
List the perfsonar services for both Latency & Bandwidth please!
So if we find some obvious perfsonar ones list NOT on that list, we know there is some config problem.
Also there's only 1 perfsonar-installed crontab mentioned in doc (http://docs.perfsonar.net/multi_agent_config.html):
/etc/cron.d/cron-mesh_config_agent
But 4 others are installed (all had to be disabled while trying to clean up this poor troubled Latency box)
/etc/cron.hourly/logscraper.cron
/etc/cron.d/cron-clean_esmond_db
/etc/cron.d/cron-owamp_cleaner
/etc/cron.d/cron-service_watcher
Copied from original issue: perfsonar/project#1069
should reflect the current status and knowledge including GEANT small nodes deployment
During the GEANT project review it was clear that some of the reviewers had difficulties in uderstanding (or missing knowledge) about main differences between perfSONAR and other performance monitoring tools like RIPE Atlas or SamKnows. It's proposed to add some kind of comparison table in FAQ in order to try highlighting main points in key areas.
These pages have now been migrated to docs, and should be removed and just linked from www.perfsonar.net:
http://docs.perfsonar.net/using_graphs.html needs to be updated for new graphs.
Many pages need a quick update pass remove outdated material.
A few example of pages that need updates are:
and probably much more.
Should do other issues related to www.perfsonar.net first, as that will reduce the number of pages to check.
http://docs.perfsonar.net/release_candidates/4.0rc1/install_centos.html
Also under Step 2, its "perfsonar-toolkit-servicewatcher" not "perfsonar-toolkit-service-watcher" and the optional packages python install script simply doesnt exist at all as best as I can tell.
From: [email protected] [mailto:[email protected]] On Behalf Of Daniel Spisak
Sent: Mittwoch, 15. Februar 2017 04:39
To: [email protected]
Subject: [perfsonar-user] Questions about perfsonar 4
The old GUI still lives at /toolkit-old on 3.5 of the toolkit. I should note this a few places and point at the 3.4 version of the docs once #7 is done.
Should probably refactor this page too, and put list of ports needed at the top.
Both the full install and netinstall support a graphical installation method. We should document this with screenshots and text as the main Step-by-Step guide since it is the new default. The current content can be moved to a separate section in the same document on the text install.
GO over some usual and unusual issues to perfSONAR installation; 4.0 specific and persistent issues from earlier versions:
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.