Opened 3 years ago

Closed 3 years ago

#20670 closed enhancement (fixed)

provide Operator's guide for Onionoo

Reported by: iwakeh Owned by: iwakeh
Priority: Medium Milestone: Onionoo 3.1-1.0.0
Component: Metrics/Onionoo Version:
Severity: Normal Keywords:
Cc: hiro Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

This document should be based on CollecTor's guide's structure and the contents of the existing docs for Onionoo.

Child Tickets

Attachments (2)

operating.tex (28.2 KB) - added by karsten 3 years ago.
Updated LaTeX sources for "Operating Java-based metrics services"
install_docs.patch (9.1 KB) - added by hiro 3 years ago.
Install documentation

Download all attachments as: .zip

Change History (14)

Changed 3 years ago by karsten

Attachment: operating.tex added

Updated LaTeX sources for "Operating Java-based metrics services"

comment:1 Changed 3 years ago by karsten

I just attached the LaTeX sources where we started writing operator's guides using a common template. The CollecTor part is updated with what we have in the most recent INSTALL.md.

comment:2 Changed 3 years ago by iwakeh

Cc: hiro added

comment:3 Changed 3 years ago by iwakeh

Owner: changed from metrics-team to hiro
Status: newassigned

comment:4 Changed 3 years ago by hiro

Adding patch for install.md. This can then be added to the latex file.

Changed 3 years ago by hiro

Attachment: install_docs.patch added

Install documentation

comment:5 Changed 3 years ago by iwakeh

Status: assignedneeds_review

comment:6 Changed 3 years ago by iwakeh

Owner: changed from hiro to iwakeh
Status: needs_reviewassigned

comment:7 Changed 3 years ago by iwakeh

Please review the guide doc.

@karsten: there are some XXXXX in there where you might know what to fill in from the main onionoo instance, e.g. backup.

@hiro: It would be great if you could just set up a local Onionoo instance following the steps in the guide. (The things that are to be filled in by karsten are minor and shouldn't halt the test.)

Thanks!

comment:8 Changed 3 years ago by karsten

The guide looks good to me! Please find my branch task-20670 with a few tweaks and with another commit that renames the file to INSTALL.md.

comment:9 in reply to:  8 Changed 3 years ago by iwakeh

Replying to karsten:

The guide looks good to me! Please find my branch task-20670 with a few tweaks and with another commit that renames the file to INSTALL.md.

Looks fine. Ready for merge.
Does geoip really need a monthly update?

comment:10 Changed 3 years ago by hiro

Looks fine to me.

comment:11 Changed 3 years ago by iwakeh

Status: assignedmerge_ready

comment:12 Changed 3 years ago by karsten

Resolution: fixed
Status: merge_readyclosed

Yes, geoip needs a monthly update. Except that recent files have issues and we're not updating anymore. But yes, in theory, monthly update. Same as little-t-tor updates that happen once per month.

Squashed and pushed! Thanks, everyone involved! Closing.

Note: See TracTickets for help on using tickets.