From 855712d68d2ea18dd76204d702ffb68128d00ccc Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 20 Jan 2021 13:12:27 -0700 Subject: [PATCH] Document InfluxDB Enterprise startup process (#2069) * document influxdb enterprise startup process, closes influxdata/DAR#114 * minor adjustments to influxdb enterprise startup doc * minor typo fixes in influxdb enterprise startup doc --- .../v1.8/about-the-project/_index.md | 2 +- .../release-notes-changelog.md | 2 +- .../_index.md} | 4 +- .../{ => anti-entropy}/anti-entropy-api.md | 6 +- .../v1.8/concepts/_index.md | 2 +- .../v1.8/concepts/clustering.md | 2 +- .../v1.8/concepts/glossary.md | 2 +- .../concepts/influxdb-enterprise-startup.md | 85 +++++++++++++++++++ .../v1.8/install-and-deploy/_index.md | 2 +- .../production_installation/_index.md | 2 +- 10 files changed, 98 insertions(+), 11 deletions(-) rename content/enterprise_influxdb/v1.8/administration/{anti-entropy.md => anti-entropy/_index.md} (99%) rename content/enterprise_influxdb/v1.8/administration/{ => anti-entropy}/anti-entropy-api.md (97%) create mode 100644 content/enterprise_influxdb/v1.8/concepts/influxdb-enterprise-startup.md diff --git a/content/enterprise_influxdb/v1.8/about-the-project/_index.md b/content/enterprise_influxdb/v1.8/about-the-project/_index.md index a92f9ce3f..f7ea165e6 100644 --- a/content/enterprise_influxdb/v1.8/about-the-project/_index.md +++ b/content/enterprise_influxdb/v1.8/about-the-project/_index.md @@ -3,7 +3,7 @@ title: About the project description: > Release notes, licenses, and third-party software details for InfluxDB Enterprise. menu: - enterprise_influxdb_1_8: + enterprise_influxdb_1_8_ref: weight: 10 --- diff --git a/content/enterprise_influxdb/v1.8/about-the-project/release-notes-changelog.md b/content/enterprise_influxdb/v1.8/about-the-project/release-notes-changelog.md index 296b77646..13d3d6564 100644 --- a/content/enterprise_influxdb/v1.8/about-the-project/release-notes-changelog.md +++ b/content/enterprise_influxdb/v1.8/about-the-project/release-notes-changelog.md @@ -3,7 +3,7 @@ title: InfluxDB Enterprise 1.8 release notes description: > Important changes and and what's new in each version InfluxDB Enterprise. menu: - enterprise_influxdb_1_8: + enterprise_influxdb_1_8_ref: name: Release notes weight: 10 parent: About the project diff --git a/content/enterprise_influxdb/v1.8/administration/anti-entropy.md b/content/enterprise_influxdb/v1.8/administration/anti-entropy/_index.md similarity index 99% rename from content/enterprise_influxdb/v1.8/administration/anti-entropy.md rename to content/enterprise_influxdb/v1.8/administration/anti-entropy/_index.md index 910b9ceb9..db5986809 100644 --- a/content/enterprise_influxdb/v1.8/administration/anti-entropy.md +++ b/content/enterprise_influxdb/v1.8/administration/anti-entropy/_index.md @@ -5,7 +5,7 @@ aliases: - /enterprise_influxdb/v1.8/guides/Anti-Entropy/ menu: enterprise_influxdb_1_8: - name: Use Anti-Entropy service + name: Use Anti-entropy service weight: 60 parent: Administration --- @@ -92,7 +92,7 @@ A "flapping" dashboard means data visualizations change when data is refreshed and pulled from a node with entropy (inconsistent data). It is the visual manifestation of getting [different results from the same query](#different-results-for-the-same-query). -Flapping dashboard +Flapping dashboard ## Technical details diff --git a/content/enterprise_influxdb/v1.8/administration/anti-entropy-api.md b/content/enterprise_influxdb/v1.8/administration/anti-entropy/anti-entropy-api.md similarity index 97% rename from content/enterprise_influxdb/v1.8/administration/anti-entropy-api.md rename to content/enterprise_influxdb/v1.8/administration/anti-entropy/anti-entropy-api.md index 9945805dd..e424ac3c6 100644 --- a/content/enterprise_influxdb/v1.8/administration/anti-entropy-api.md +++ b/content/enterprise_influxdb/v1.8/administration/anti-entropy/anti-entropy-api.md @@ -4,9 +4,11 @@ description: > Monitor and repair shards on InfluxDB Enterprise data nodes the InfluxDB Anti-Entropy API. menu: enterprise_influxdb_1_8: - name: Anti-Entropy API + name: Anti-entropy API weight: 70 - parent: Administration + parent: Use Anti-entropy service +aliases: + - /enterprise_influxdb/v1.8/administration/anti-entropy-api/ --- >**Note:** The Anti-Entropy API is available from the meta nodes and is only available when the Anti-Entropy service is enabled in the data node configuration settings. For information on the configuration settings, see diff --git a/content/enterprise_influxdb/v1.8/concepts/_index.md b/content/enterprise_influxdb/v1.8/concepts/_index.md index 046e5e350..cc9115e5c 100644 --- a/content/enterprise_influxdb/v1.8/concepts/_index.md +++ b/content/enterprise_influxdb/v1.8/concepts/_index.md @@ -4,7 +4,7 @@ description: Clustering and other key concepts in InfluxDB Enterprise. aliases: - /enterprise/v1.8/concepts/ menu: - enterprise_influxdb_1_8: + enterprise_influxdb_1_8_ref: name: Concepts weight: 50 --- diff --git a/content/enterprise_influxdb/v1.8/concepts/clustering.md b/content/enterprise_influxdb/v1.8/concepts/clustering.md index 0bee38e31..0ec26ef8d 100644 --- a/content/enterprise_influxdb/v1.8/concepts/clustering.md +++ b/content/enterprise_influxdb/v1.8/concepts/clustering.md @@ -5,7 +5,7 @@ description: > aliases: - /enterprise/v1.8/concepts/clustering/ menu: - enterprise_influxdb_1_8: + enterprise_influxdb_1_8_ref: name: Clustering weight: 10 parent: Concepts diff --git a/content/enterprise_influxdb/v1.8/concepts/glossary.md b/content/enterprise_influxdb/v1.8/concepts/glossary.md index c5f9a1741..a07727ae6 100644 --- a/content/enterprise_influxdb/v1.8/concepts/glossary.md +++ b/content/enterprise_influxdb/v1.8/concepts/glossary.md @@ -4,7 +4,7 @@ description: Terms related to InfluxDB Enterprise. aliases: - /enterprise/v1.8/concepts/glossary/ menu: - enterprise_influxdb_1_8: + enterprise_influxdb_1_8_ref: weight: 20 parent: Concepts --- diff --git a/content/enterprise_influxdb/v1.8/concepts/influxdb-enterprise-startup.md b/content/enterprise_influxdb/v1.8/concepts/influxdb-enterprise-startup.md new file mode 100644 index 000000000..fcb55ed99 --- /dev/null +++ b/content/enterprise_influxdb/v1.8/concepts/influxdb-enterprise-startup.md @@ -0,0 +1,85 @@ +--- +title: InfluxDB Enterprise startup process +description: > + On startup, InfluxDB Enterprise starts all subsystems and services in a deterministic order. +menu: + enterprise_influxdb_1_8_ref: + weight: 10 + name: Startup process + parent: Concepts +--- + +On startup, InfluxDB Enterprise starts all subsystems and services in the following order: + +1. [TSDBStore](#tsdbstore) +2. [Monitor](#monitor) +3. [Cluster](#cluster) +4. [Precreator](#precreator) +5. [Snapshotter](#snapshotter) +6. [Continuous Query](#continuous-query) +7. [Announcer](#announcer) +8. [Retention](#retention) +9. [Stats](#stats) +10. [Anti-entropy](#anti-entropy) +11. [HTTP API](#http-api) + +A **subsystem** is a collection of related services managed together as part of a greater whole. +A **service** is a process that provides specific functionality. + +## Subsystems and services + +### TSDBStore +The TSDBStore subsystem starts and manages the TSM storage engine. +This includes services such as the points writer (write), reads (query), +and [hinted handoff (HH)](/enterprise_influxdb/v1.8/concepts/clustering/#hinted-handoff). +TSDBSTore first opens all the shards and loads write-ahead log (WAL) data into the in-memory write cache. +If `influxd` was cleanly shutdown previously, there will not be any WAL data. +It then loads a portion of each shard's index. + +{{% note %}} +#### Index versions and startup times +If using `inmem` indexing, InfluxDB loads all shard indexes into memory, which, +depending on the number of series in the database, can take time. +If using `tsi1` indexing, InfluxDB only loads hot shard indexes +(the most recent shards or shards currently being written to) into memory and +stores cold shard indexes on disk. +Use `tsi1` indexing to see shorter startup times. +{{% /note %}} + +### Monitor +The Monitor service provides statistical and diagnostic information to InfluxDB about InfluxDB itself. +This information helps with database troubleshooting and performance analysis. + +### Cluster +The Cluster service provides implementations of InfluxDB OSS v1.8 interfaces +that operate on an InfluxDB Enterprise v1.8 cluster. + +### Precreator +The Precreator service creates shards before they are needed. +This ensures necessary shards exist before new time series data arrives and that +write-throughput is not affected the creation of a new shard. + +### Snapshotter +The Snapshotter service routinely creates snapshots of InfluxDB Enterprise metadata. + +### Continuous Query +The Continuous Query (CQ) subsystem manages all InfluxDB CQs. + +### Announcer +The Announcer service announces a data node's status to meta nodes. + +### Retention +The Retention service enforces [retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) +and drops data as it expires. + +### Stats +The Stats service monitors cluster-level statistics. + +### Anti-entropy +The Anti-entropy (AE) subsystem is responsible for reconciling differences between shards. +For more information, see [Use anti-entropy](/enterprise_influxdb/v1.8/administration/anti-entropy/). + +### HTTP API +The InfluxDB HTTP API service provides a public facing interface to interact with +InfluxDB Enterprise and internal interfaces used within the InfluxDB Enterprise cluster. + diff --git a/content/enterprise_influxdb/v1.8/install-and-deploy/_index.md b/content/enterprise_influxdb/v1.8/install-and-deploy/_index.md index ae921efcf..c1fee177a 100644 --- a/content/enterprise_influxdb/v1.8/install-and-deploy/_index.md +++ b/content/enterprise_influxdb/v1.8/install-and-deploy/_index.md @@ -6,7 +6,7 @@ aliases: menu: enterprise_influxdb_1_8: name: Install and deploy - weight: 70 + weight: 30 --- Install or deploy your InfluxDB Enterprise cluster in the environment of your choice: diff --git a/content/enterprise_influxdb/v1.8/install-and-deploy/production_installation/_index.md b/content/enterprise_influxdb/v1.8/install-and-deploy/production_installation/_index.md index c6cc98aeb..d10d3461f 100644 --- a/content/enterprise_influxdb/v1.8/install-and-deploy/production_installation/_index.md +++ b/content/enterprise_influxdb/v1.8/install-and-deploy/production_installation/_index.md @@ -6,7 +6,7 @@ aliases: menu: enterprise_influxdb_1_8: name: Install in your environment - weight: 40 + weight: 10 parent: Install and deploy ---