From 519c8348952bbc1ed56a8c84ac302532463ff8a6 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 10 Feb 2019 13:18:21 +0100 Subject: Moving files not directly interpreted by debhelper to subdirectories within the debian packaging. Signed-off-by: Daniel Baumann --- debian/TODO | 29 ----------- debian/local/netdata.conf | 19 +++++++ debian/manpages/netdata.1 | 119 +++++++++++++++++++++++++++++++++++++++++++ debian/netdata-core.manpages | 2 +- debian/netdata.1 | 119 ------------------------------------------- debian/netdata.TODO | 29 +++++++++++ debian/netdata.conf | 19 ------- debian/rules | 4 +- 8 files changed, 170 insertions(+), 170 deletions(-) delete mode 100644 debian/TODO create mode 100644 debian/local/netdata.conf create mode 100644 debian/manpages/netdata.1 delete mode 100644 debian/netdata.1 create mode 100644 debian/netdata.TODO delete mode 100644 debian/netdata.conf diff --git a/debian/TODO b/debian/TODO deleted file mode 100644 index de58db0b5..000000000 --- a/debian/TODO +++ /dev/null @@ -1,29 +0,0 @@ -* package splitting: - - think about a workaround for not having the dh_missing for debian/tmp-no-sse - (e.g. diff the core and core-no-sse file lists?) - - add alternative depends on core and core-no-sse via substvars on affected - archtectures only - - split out arch-all stuff from core/core-no-sse to netdata-common or so - (check if worthwile; micropackaging vs. lazy) - - add netdata-doc if htmldoc is buildable again - -* migrate from user 'netdata' to '_netdata'. - -* add multiselect preseeding for netdata-web (as if it's netdata-apache2, - containing apache2 conf snipped to enable netdata via reverse proxy - and (optional) basic auth) - -* finish ucf handling for netdata.conf - -* keep depends minimal and put everything to recommends/suggests - -* check netdata.conf, netdata.init, netdata.service etc. with upstream - -* check if freeipmi plugin can be run with caps instead setuid - -* netdata.conf: preseeding of ip, port, registry, and history. - -* upstream: - - 'netdata -W set' seems broken - - update to bootstrap 4 - - switch to fonts-fork-awesome diff --git a/debian/local/netdata.conf b/debian/local/netdata.conf new file mode 100644 index 000000000..e15f9b89b --- /dev/null +++ b/debian/local/netdata.conf @@ -0,0 +1,19 @@ +# NetData Configuration + +# The current full configuration can be retrieved from the running +# server at the URL +# +# http://localhost:19999/netdata.conf +# +# for example: +# +# wget -O /etc/netdata/netdata.conf http://localhost:19999/netdata.conf +# + +[global] + run as user = netdata + web files owner = root + web files group = root + # Netdata is not designed to be exposed to potentially hostile + # networks. See https://github.com/netdata/netdata/issues/164 + bind socket to IP = 127.0.0.1 diff --git a/debian/manpages/netdata.1 b/debian/manpages/netdata.1 new file mode 100644 index 000000000..35d166684 --- /dev/null +++ b/debian/manpages/netdata.1 @@ -0,0 +1,119 @@ +.TH NETDATA 1 2019\-01\-20 1.12.0 "real\-time performance monitoring" + +.SH NAME +\fBnetdata\fR \- real\-time performance monitoring + +.SH SYNOPSIS +\fBnetdata\fR [\-c \fIOPTIONS\fR] [\-D|\-d] [\-P \fIFILENAME\fR] [\-i \fIIP\fR] [\-p \fIPORT\fR] [\-s \fIPATH\fR] [\-t \fISECONDS\fR] [\-u \fIUSERNAME\fR] +.PP +\fBnetdata\fR \-h +\fBnetdata\fR \-v|\-V + +.SH DESCRIPTION +\fBnetdata\fR is distributed, real\-time, performance and health monitoring for +systems and applications. It provides insights of everything happening on the +systems it runs using interactive web dashboards. +.PP +It can run autonomously without any third party components or it can be +integrated to existing monitoring tool chains (Prometheus, Graphite, +OpenTSDB, Kafka, Grafana, etc). + +.SH OPTIONS +The \fBnetdata\fR daemon is usually started by an initscript or a systemd +service, the following options are available: + +.IP "\-c \fIFILENAME\fR" 4 +Configuration file to load. +.br +Default: /etc/netdata/netdata.conf. + +.IP "\-D" 4 +Do not fork. Run in the foreground. +.br +Default: run in the background + +.IP "\-d" 4 +Fork. Run in the background. +.br +Default: run in the background + +.IP "\-h" 4 +Display this help message. + +.IP "\-P \fIFILENAME\fR" 4 +File to save a pid while running. +.br +Default: do not save pid to a file + +.IP "\-i \fIIP\fR" 4 +The IP address to listen to. +.br +Default: all IP addresses IPv4 and IPv6 + +.IP "\-p \fIPORT\fR" 4 +API/Web port to use. +.br +Default: 19999 + +.IP "\-s \fIPATH\fR" 4 +Prefix for /proc and /sys (for containers). +.br +Default: no prefix + +.IP "\-t \fISECONDS\fR" 4 +The internal clock of netdata. +.br +Default: 1 + +.IP "\-u \fIUSERNAME\fR" 4 +Run as user. +.br +Default: netdata + +.IP "\-v, \-V" 4 +Print netdata version and exit. + +.IP "\-W \fIOPTIONS\fR" 4 +See Advanced options below. + +.SS ADVANCED OPTIONS + +.IP "\-W stacksize=\fIN\fR" 4 +Set the stacksize (in bytes). + +.IP "\-W debug_flags=\fIN\fR" 4 +Set runtime tracing to debug.log. + +.IP "\-W unittest" 4 +Run internal unittests and exit. + +.IP "\-W set \fISECTION\fR \fIOPTION\fR \fIVALUE\fR" 4 +set netdata.conf option from the command line. + +.IP "\-W simple\-pattern \fIPATTERN\fR \fISTRING\fR" 4 +Check if string matches pattern and exit. + +.SH SIGNALS + +.IP "HUP" 4 +Close and reopen log files. + +.IP "USR1" 4 +Save internal DB to disk. + +.IP "USR2" 4 +Reload health configuration. + +.SH FILES +.IP "\fB/etc/netdata\fR" 4 +Configuration file. +.IP "\fB/usr/share/doc/netdata" 4 +Upstream documentation. + +.SH HOMEPAGE +More information about netdata can be found on the homepage at <\fIhttps://my-netdata.io\fR> and in the manual at <\fIhttps://docs.netdata.cloud\fR>. + +.SH AUTHOR +netdata was written by Costa Tsaousis <\fIcosta@tsaousis.gr\fR>. +.PP +This manual page was written by Federico Ceratto <\fIfederico@debian.org\fR> for the Debian project and may be used by others. diff --git a/debian/netdata-core.manpages b/debian/netdata-core.manpages index 421a3ab88..2fb19fbd8 100644 --- a/debian/netdata-core.manpages +++ b/debian/netdata-core.manpages @@ -1 +1 @@ -debian/netdata.1 +debian/manpages/* diff --git a/debian/netdata.1 b/debian/netdata.1 deleted file mode 100644 index 35d166684..000000000 --- a/debian/netdata.1 +++ /dev/null @@ -1,119 +0,0 @@ -.TH NETDATA 1 2019\-01\-20 1.12.0 "real\-time performance monitoring" - -.SH NAME -\fBnetdata\fR \- real\-time performance monitoring - -.SH SYNOPSIS -\fBnetdata\fR [\-c \fIOPTIONS\fR] [\-D|\-d] [\-P \fIFILENAME\fR] [\-i \fIIP\fR] [\-p \fIPORT\fR] [\-s \fIPATH\fR] [\-t \fISECONDS\fR] [\-u \fIUSERNAME\fR] -.PP -\fBnetdata\fR \-h -\fBnetdata\fR \-v|\-V - -.SH DESCRIPTION -\fBnetdata\fR is distributed, real\-time, performance and health monitoring for -systems and applications. It provides insights of everything happening on the -systems it runs using interactive web dashboards. -.PP -It can run autonomously without any third party components or it can be -integrated to existing monitoring tool chains (Prometheus, Graphite, -OpenTSDB, Kafka, Grafana, etc). - -.SH OPTIONS -The \fBnetdata\fR daemon is usually started by an initscript or a systemd -service, the following options are available: - -.IP "\-c \fIFILENAME\fR" 4 -Configuration file to load. -.br -Default: /etc/netdata/netdata.conf. - -.IP "\-D" 4 -Do not fork. Run in the foreground. -.br -Default: run in the background - -.IP "\-d" 4 -Fork. Run in the background. -.br -Default: run in the background - -.IP "\-h" 4 -Display this help message. - -.IP "\-P \fIFILENAME\fR" 4 -File to save a pid while running. -.br -Default: do not save pid to a file - -.IP "\-i \fIIP\fR" 4 -The IP address to listen to. -.br -Default: all IP addresses IPv4 and IPv6 - -.IP "\-p \fIPORT\fR" 4 -API/Web port to use. -.br -Default: 19999 - -.IP "\-s \fIPATH\fR" 4 -Prefix for /proc and /sys (for containers). -.br -Default: no prefix - -.IP "\-t \fISECONDS\fR" 4 -The internal clock of netdata. -.br -Default: 1 - -.IP "\-u \fIUSERNAME\fR" 4 -Run as user. -.br -Default: netdata - -.IP "\-v, \-V" 4 -Print netdata version and exit. - -.IP "\-W \fIOPTIONS\fR" 4 -See Advanced options below. - -.SS ADVANCED OPTIONS - -.IP "\-W stacksize=\fIN\fR" 4 -Set the stacksize (in bytes). - -.IP "\-W debug_flags=\fIN\fR" 4 -Set runtime tracing to debug.log. - -.IP "\-W unittest" 4 -Run internal unittests and exit. - -.IP "\-W set \fISECTION\fR \fIOPTION\fR \fIVALUE\fR" 4 -set netdata.conf option from the command line. - -.IP "\-W simple\-pattern \fIPATTERN\fR \fISTRING\fR" 4 -Check if string matches pattern and exit. - -.SH SIGNALS - -.IP "HUP" 4 -Close and reopen log files. - -.IP "USR1" 4 -Save internal DB to disk. - -.IP "USR2" 4 -Reload health configuration. - -.SH FILES -.IP "\fB/etc/netdata\fR" 4 -Configuration file. -.IP "\fB/usr/share/doc/netdata" 4 -Upstream documentation. - -.SH HOMEPAGE -More information about netdata can be found on the homepage at <\fIhttps://my-netdata.io\fR> and in the manual at <\fIhttps://docs.netdata.cloud\fR>. - -.SH AUTHOR -netdata was written by Costa Tsaousis <\fIcosta@tsaousis.gr\fR>. -.PP -This manual page was written by Federico Ceratto <\fIfederico@debian.org\fR> for the Debian project and may be used by others. diff --git a/debian/netdata.TODO b/debian/netdata.TODO new file mode 100644 index 000000000..de58db0b5 --- /dev/null +++ b/debian/netdata.TODO @@ -0,0 +1,29 @@ +* package splitting: + - think about a workaround for not having the dh_missing for debian/tmp-no-sse + (e.g. diff the core and core-no-sse file lists?) + - add alternative depends on core and core-no-sse via substvars on affected + archtectures only + - split out arch-all stuff from core/core-no-sse to netdata-common or so + (check if worthwile; micropackaging vs. lazy) + - add netdata-doc if htmldoc is buildable again + +* migrate from user 'netdata' to '_netdata'. + +* add multiselect preseeding for netdata-web (as if it's netdata-apache2, + containing apache2 conf snipped to enable netdata via reverse proxy + and (optional) basic auth) + +* finish ucf handling for netdata.conf + +* keep depends minimal and put everything to recommends/suggests + +* check netdata.conf, netdata.init, netdata.service etc. with upstream + +* check if freeipmi plugin can be run with caps instead setuid + +* netdata.conf: preseeding of ip, port, registry, and history. + +* upstream: + - 'netdata -W set' seems broken + - update to bootstrap 4 + - switch to fonts-fork-awesome diff --git a/debian/netdata.conf b/debian/netdata.conf deleted file mode 100644 index e15f9b89b..000000000 --- a/debian/netdata.conf +++ /dev/null @@ -1,19 +0,0 @@ -# NetData Configuration - -# The current full configuration can be retrieved from the running -# server at the URL -# -# http://localhost:19999/netdata.conf -# -# for example: -# -# wget -O /etc/netdata/netdata.conf http://localhost:19999/netdata.conf -# - -[global] - run as user = netdata - web files owner = root - web files group = root - # Netdata is not designed to be exposed to potentially hostile - # networks. See https://github.com/netdata/netdata/issues/164 - bind socket to IP = 127.0.0.1 diff --git a/debian/rules b/debian/rules index 6cf279fd3..8a3ba0dbd 100755 --- a/debian/rules +++ b/debian/rules @@ -76,7 +76,7 @@ override_dh_install-arch: # Copy architecture dependent plugins mkdir -p $(TOP)-core/etc/netdata - cp debian/netdata.conf $(TOP)-core/etc/netdata + cp debian/local/netdata.conf $(TOP)-core/etc/netdata mkdir -p $(TOP)-core/usr/lib/netdata/plugins.d for plugin in cgroup-network apps.plugin freeipmi.plugin; \ @@ -90,7 +90,7 @@ ifeq (netdata-core-no-sse,$(findstring netdata-core-no-sse,$(PACKAGES))) dh_install -p netdata-core-no-sse --sourcedir=debian/tmp-core-no-sse mkdir -p $(TOP)-core-no-sse/etc/netdata - cp debian/netdata.conf $(TOP)-core-no-sse/etc/netdata + cp debian/local/netdata.conf $(TOP)-core-no-sse/etc/netdata mkdir -p $(TOP)-core-no-sse/usr/lib/netdata/plugins.d for plugin in cgroup-network apps.plugin freeipmi.plugin; \ -- cgit v1.2.3