[tor-bugs] #20380 [Metrics/CollecTor]: Expand INSTALL.md to a more complete operator's guide

[Tor Bug Tracker & Wiki]

#20380: Expand INSTALL.md to a more complete operator's guide
-------------------------------+---------------------------------
 Reporter:  karsten            |          Owner:
     Type:  enhancement        |         Status:  needs_review
 Priority:  Medium             |      Milestone:  CollecTor 1.1.0
Component:  Metrics/CollecTor  |        Version:
 Severity:  Normal             |     Resolution:
 Keywords:                     |  Actual Points:
Parent ID:                     |         Points:
 Reviewer:                     |        Sponsor:
-------------------------------+---------------------------------

Comment (by karsten):

 Replying to [comment:8 iwakeh]:
 > Thanks for the start here!

 Thanks for looking! :)

 > Please see some suggestions
 [https://gitweb.torproject.org/user/iwakeh/collector.git/commit/?h=task-20380-install&id=87e81a64517986571e5f47c99c9bbb52d3ced749
 here] based on your file.

 A few thoughts:

  - When you say that closer monitoring will be needed when disk space
 drops below a given number, do you mean 200G or 20G or a different number?

  - We shouldn't add new section headers easily.  The chosen section
 headers and even paragraphs in this document (will) have equivalents in
 the other operator's guides for other metrics tools.  If we want to add
 new sections, we'll also have to add those sections to the other manuals.
 The current sections are:

 {{{
 $ grep "^#" INSTALL.md
 # CollecTor Operator's Guide
 ## Setting up the host
 ## Setting up the service
 ## Maintaining the service
 }}}

  - (continued) What other sections or even subsections should we include,
 and what instructions would go into those vs. the existing sections?

 > The idea behind my changes is that I think the service shouldn't be run
 from the unpacked tar
 > folder.  The tar contains a development environment, so the jar would
 disappear after 'ant clean' or changed etc.
 > The runtime directory should only contain files that are really
 necessary for the application or which were created by the application.
 > Hope this doesn't make the description too complicated.

 Yes, makes sense, let's change that.  There are still a few paths left
 where we refer to files in `collector-<version>/` and where we should tell
 the user to copy those files to the working directory and run them from
 there.  I can update those places.

 > I also would like have even less description of tools from the OS,
 because such things should be decided by the operator.

 Which parts would that include?  The crontab, `@reboot`, `screen`, etc.?
 Can you make a list?

 Again, thanks for the review!

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/20380#comment:9>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online