From 68abc5d1cb2578ca3a22819b8788457f83ab1034 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 11 Apr 2019 15:33:42 -0600 Subject: [PATCH 1/4] WIP config options --- content/v2.0/reference/cli/_index.md | 2 +- content/v2.0/reference/config-options.md | 84 ++++++++++++++++++++++++ content/v2.0/reference/flux/_index.md | 2 +- 3 files changed, 86 insertions(+), 2 deletions(-) create mode 100644 content/v2.0/reference/config-options.md diff --git a/content/v2.0/reference/cli/_index.md b/content/v2.0/reference/cli/_index.md index 55f6e4e45..e4021ac27 100644 --- a/content/v2.0/reference/cli/_index.md +++ b/content/v2.0/reference/cli/_index.md @@ -8,7 +8,7 @@ v2.0/tags: [cli] menu: v2_0_ref: name: Command line tools -weight: 2 +weight: 3 --- InfluxDB provides command line tools designed to aid in managing and working diff --git a/content/v2.0/reference/config-options.md b/content/v2.0/reference/config-options.md new file mode 100644 index 000000000..dcbcbca4b --- /dev/null +++ b/content/v2.0/reference/config-options.md @@ -0,0 +1,84 @@ +--- +title: InfluxDB configuration options +description: +menu: + v2_0_ref: + name: Configuration options + weight: 2 +--- + +Set InfluxDB configuration options when starting `influxd` by passing specific flags. + +```sh +influxd \ + --assets-path=/path/to/custom/assets-dir \ + --bolt-path=~/.influxdbv2/influxd.bolt \ + --e2e-testing \ + --engine-path=~/.influxdbv2/engine \ + --http-bind-address=:9999 \ + --log-level=info \ + --reporting-disabled \ + --secret-store=bolt \ + --store=bolt \ + --tracing-type=log +``` + +## assets-path +Override default user interface (UI) assets by serving assets from a specific directory. +_InfluxData use this when working on the InfluxDB UI._ + +**influxd flag:** `--assets-path` + +## bolt-path +Path to BoltDB database. + +**influxd flag:** `--bolt-path` +**Default:** `~/.influxdbv2/influxd.bolt` + +## e2e-testing +Add /debug/flush endpoint to clear stores; used for end-to-end tests. + +**influxd flag:** `--e2e-testing` +**Default:** false + +## engine-path +Path to persistent storage engine files where InfluxDB stores all Time-Structure Merge Tree (TSM) data. + +**influxd flag:** `--engine-path` +**Default:** `~/.influxdbv2/engine` + +## http-bind-address +Bind address for the REST HTTP API. + +**influxd flag:** `--http-bind-address` +**Default:** `:9999` + +## log-level +Supported log levels are debug, info, and error. + +**influxd flag:** `--log-level` +**Default:** `info` + +## reporting-disabled +Disable sending telemetry data to InfluxData. + +**influxd flag:** `--reporting-disabled` +**Default:** false + +## secret-store +Data store for secrets (bolt or vault). + +**influxd flag:** `--secret-store` +**Default:** `bolt` + +## store +Data store for REST resources (bolt or memory) (default `bolt`) + +**influxd flag:** `--store` +**Default:** `bolt` + +## tracing-type +Supported tracing types (log or jaeger). + +**influxd flag:** `--tracing-type` +**Default:** none diff --git a/content/v2.0/reference/flux/_index.md b/content/v2.0/reference/flux/_index.md index fcd7f4029..647a0407d 100644 --- a/content/v2.0/reference/flux/_index.md +++ b/content/v2.0/reference/flux/_index.md @@ -5,7 +5,7 @@ v2.0/tags: [flux] menu: v2_0_ref: name: Flux query language -weight: 3 +weight: 4 --- The following articles are meant as a reference for Flux functions and the From 2a8872f02d2d6a3c92a9b3157a1564dc8412fd3c Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 12 Apr 2019 10:15:35 -0600 Subject: [PATCH 2/4] added configuration options reference doc, resolves #142 --- config.toml | 1 + content/v2.0/reference/config-options.md | 160 +++++++++++++++++------ 2 files changed, 120 insertions(+), 41 deletions(-) diff --git a/config.toml b/config.toml index de4a12cae..94a88f33f 100644 --- a/config.toml +++ b/config.toml @@ -15,6 +15,7 @@ preserveTaxonomyNames = true # Markdown rendering options [blackfriday] hrefTargetBlank = true +smartDashes = false # Menu items without actual pages [menu] diff --git a/content/v2.0/reference/config-options.md b/content/v2.0/reference/config-options.md index dcbcbca4b..fe92ce2dd 100644 --- a/content/v2.0/reference/config-options.md +++ b/content/v2.0/reference/config-options.md @@ -7,7 +7,19 @@ menu: weight: 2 --- -Set InfluxDB configuration options when starting `influxd` by passing specific flags. +Configure InfluxDB using configuration flags available with the [`influxd` daemon](/v2.0/reference/cli/influxd). +The following configuration options are available: + +- [assets-path](#assets-path) +- [bolt-path](#bolt-path) +- [e2e-testing](#e2e-testing) +- [engine-path](#engine-path) +- [http-bind-address](#http-bind-address) +- [log-level](#log-level) +- [reporting-disabled](#reporting-disabled) +- [secret-store](#secret-store) +- [store](#store) +- [tracing-type](#tracing-type) ```sh influxd \ @@ -23,62 +35,128 @@ influxd \ --tracing-type=log ``` -## assets-path -Override default user interface (UI) assets by serving assets from a specific directory. -_InfluxData use this when working on the InfluxDB UI._ +--- -**influxd flag:** `--assets-path` +## --assets-path +Overrides the default InfluxDB user interface (UI) assets by serving assets from a specific directory. +_This is typically only used internally at InfluxData when working on the InfluxDB UI._ -## bolt-path -Path to BoltDB database. +```sh +influxd --assets-path=/path/to/custom/assets-dir +``` -**influxd flag:** `--bolt-path` -**Default:** `~/.influxdbv2/influxd.bolt` +--- -## e2e-testing -Add /debug/flush endpoint to clear stores; used for end-to-end tests. +## --bolt-path +Defines the path to the [BoltDB](https://github.com/boltdb/bolt) database. +BoltDB is a key value store written in Go. +InfluxDB uses BoltDB to store non-time-series data such as organization and +user information, UI data, REST resources, etc. -**influxd flag:** `--e2e-testing` -**Default:** false +**Default:** `~/.influxdbv2/influxd.bolt` -## engine-path -Path to persistent storage engine files where InfluxDB stores all Time-Structure Merge Tree (TSM) data. +```sh +influxd --bolt-path=~/.influxdbv2/influxd.bolt +``` -**influxd flag:** `--engine-path` -**Default:** `~/.influxdbv2/engine` +--- -## http-bind-address -Bind address for the REST HTTP API. +## --e2e-testing +Adds a `/debug/flush` endpoint to the InfluxDB HTTP API to clear stores. +InfluxData uses this for end-to-end testing. -**influxd flag:** `--http-bind-address` -**Default:** `:9999` +```sh +influxd --e2e-testing +``` -## log-level -Supported log levels are debug, info, and error. +--- -**influxd flag:** `--log-level` -**Default:** `info` +## --engine-path +Defines the path to persistent storage engine files where InfluxDB stores all +Time-Structure Merge Tree (TSM) data on disk. -## reporting-disabled -Disable sending telemetry data to InfluxData. +**Default:** `~/.influxdbv2/engine` -**influxd flag:** `--reporting-disabled` -**Default:** false +```sh +influxd --engine-path=~/.influxdbv2/engine +``` -## secret-store -Data store for secrets (bolt or vault). +--- -**influxd flag:** `--secret-store` -**Default:** `bolt` +## --http-bind-address +Defines the bind address for the InfluxDB HTTP API. +Customize the URL and port of the InfluxDB API and UI. -## store -Data store for REST resources (bolt or memory) (default `bolt`) +**Default:** `:9999` -**influxd flag:** `--store` -**Default:** `bolt` +```sh +influxd --http-bind-address=:9999 +``` -## tracing-type -Supported tracing types (log or jaeger). +--- -**influxd flag:** `--tracing-type` -**Default:** none +## --log-level +Defines the log output level. +InfluxDB emits log entries with severity levels greater than or equal to the level specified. + +**Options:** `debug`, `info`, `error` +**Default:** `info` + +```sh +influxd --log-level=info +``` + +--- + +## --reporting-disabled +Disables sending telemetry data to InfluxData. +The [InfluxData telemetry](https://www.influxdata.com/telemetry) page provides +information about what data is collected and how InfluxData uses it. + +```sh +influxd --reporting-disabled +``` + +--- + +## --secret-store +Specifies the data store for secrets such as passwords and tokens. +Store secrets in either the InfluxDB [internal BoltDB](#bolt-path) +or in [Vault](https://www.vaultproject.io/). + +**Options:** `bolt`, `vault` +**Default:** `bolt` + +```sh +influxd --secret-store=bolt +``` + +--- + +## --store +Specifies the data store for REST resources. + +{{% note %}} +Do not use `memory` in production environments. +It is meant only for transient environments, such as testing environments, where +data persistence does not matter. +{{% /note %}} + +**Options:** `bolt`, `memory` +**Default:** `bolt` + +```sh +influxd --store=bolt +``` + +--- + +## --tracing-type +Enables tracing in InfluxDB and specifies the tracing type. +Tracing is disabled by default. + +**Options:** `log`, `jaeger` + +```sh +influxd --tracing-type=log +``` From 6fc9e37080741fc0f992e2abc3a29ca2c0225f53 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 12 Apr 2019 14:58:07 -0600 Subject: [PATCH 3/4] updated configuration options doc to address PR feedback --- content/v2.0/reference/config-options.md | 48 ++++++++++++------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/content/v2.0/reference/config-options.md b/content/v2.0/reference/config-options.md index fe92ce2dd..f5e3845db 100644 --- a/content/v2.0/reference/config-options.md +++ b/content/v2.0/reference/config-options.md @@ -7,19 +7,19 @@ menu: weight: 2 --- -Configure InfluxDB using configuration flags available with the [`influxd` daemon](/v2.0/reference/cli/influxd). -The following configuration options are available: +To configure InfluxDB, use the following configuration flags when starting the +[`influxd` service](/v2.0/reference/cli/influxd): -- [assets-path](#assets-path) -- [bolt-path](#bolt-path) -- [e2e-testing](#e2e-testing) -- [engine-path](#engine-path) -- [http-bind-address](#http-bind-address) -- [log-level](#log-level) -- [reporting-disabled](#reporting-disabled) -- [secret-store](#secret-store) -- [store](#store) -- [tracing-type](#tracing-type) +- [--assets-path](#assets-path) +- [--bolt-path](#bolt-path) +- [--e2e-testing](#e2e-testing) +- [--engine-path](#engine-path) +- [--http-bind-address](#http-bind-address) +- [--log-level](#log-level) +- [--reporting-disabled](#reporting-disabled) +- [--secret-store](#secret-store) +- [--store](#store) +- [--tracing-type](#tracing-type) ```sh influxd \ @@ -39,7 +39,7 @@ influxd \ ## --assets-path Overrides the default InfluxDB user interface (UI) assets by serving assets from a specific directory. -_This is typically only used internally at InfluxData when working on the InfluxDB UI._ +_Typically, InfluxData internal use only._ ```sh influxd --assets-path=/path/to/custom/assets-dir @@ -50,8 +50,8 @@ influxd --assets-path=/path/to/custom/assets-dir ## --bolt-path Defines the path to the [BoltDB](https://github.com/boltdb/bolt) database. BoltDB is a key value store written in Go. -InfluxDB uses BoltDB to store non-time-series data such as organization and -user information, UI data, REST resources, etc. +InfluxDB uses BoltDB to store data including organization and +user information, UI data, REST resources, and other key value data. **Default:** `~/.influxdbv2/influxd.bolt` @@ -63,7 +63,7 @@ influxd --bolt-path=~/.influxdbv2/influxd.bolt ## --e2e-testing Adds a `/debug/flush` endpoint to the InfluxDB HTTP API to clear stores. -InfluxData uses this for end-to-end testing. +InfluxData uses this endpoint in end-to-end testing. ```sh influxd --e2e-testing @@ -85,7 +85,7 @@ influxd --engine-path=~/.influxdbv2/engine ## --http-bind-address Defines the bind address for the InfluxDB HTTP API. -Customize the URL and port of the InfluxDB API and UI. +Customize the URL and port for the InfluxDB API and UI. **Default:** `:9999` @@ -97,7 +97,7 @@ influxd --http-bind-address=:9999 ## --log-level Defines the log output level. -InfluxDB emits log entries with severity levels greater than or equal to the level specified. +InfluxDB outputs log entries with severity levels greater than or equal to the level specified. **Options:** `debug`, `info`, `error` **Default:** `info` @@ -136,15 +136,15 @@ influxd --secret-store=bolt ## --store Specifies the data store for REST resources. -{{% note %}} -Do not use `memory` in production environments. -It is meant only for transient environments, such as testing environments, where -data persistence does not matter. -{{% /note %}} - **Options:** `bolt`, `memory` **Default:** `bolt` +{{% note %}} +`memory` is meant for transient environments, such as testing environments, where +data persistence does not matter. +InfluxData does not recommend using `memory` in production. +{{% /note %}} + ```sh influxd --store=bolt ``` From 40d669fda08a669abcb7905053d920b15aa9dbe9 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 12 Apr 2019 15:01:12 -0600 Subject: [PATCH 4/4] more config options updates for PR feedback --- content/v2.0/reference/config-options.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/v2.0/reference/config-options.md b/content/v2.0/reference/config-options.md index f5e3845db..813eecae1 100644 --- a/content/v2.0/reference/config-options.md +++ b/content/v2.0/reference/config-options.md @@ -7,7 +7,7 @@ menu: weight: 2 --- -To configure InfluxDB, use the following configuration flags when starting the +To configure InfluxDB, use the following configuration options when starting the [`influxd` service](/v2.0/reference/cli/influxd): - [--assets-path](#assets-path) @@ -38,8 +38,8 @@ influxd \ --- ## --assets-path -Overrides the default InfluxDB user interface (UI) assets by serving assets from a specific directory. _Typically, InfluxData internal use only._ +Overrides the default InfluxDB user interface (UI) assets by serving assets from the specified directory. ```sh influxd --assets-path=/path/to/custom/assets-dir