Skip to content

Commit 433fe6b

Browse files
committed
fix: Reformatted using markdownfmt.sh
- Reran formatter after the tianon/markdownfmt issue was resolved.
1 parent e104323 commit 433fe6b

File tree

2 files changed

+17
-31
lines changed

2 files changed

+17
-31
lines changed

influxdb/content.md

Lines changed: 16 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
What is InfluxDB?
2-
=================
1+
# What is InfluxDB?
32

43
InfluxDB is the time series data platform designed to handle high write and query workloads. Using InfluxDB, you can collect, store, and process large amounts of timestamped data, including metrics and events for use cases such as DevOps monitoring, application metrics, IoT sensors, and event monitoring.
54

@@ -9,13 +8,11 @@ For more information, visit https://influxdata.com.
98

109
%%LOGO%%
1110

12-
How to use this image for InfluxDB v2
13-
=====================================
11+
# How to use this image for InfluxDB v2
1412

1513
**Quick start**: See the guide to [Install InfluxDB v2 for Docker](https://docs.influxdata.com/influxdb/v2/install/?t=Docker) and get started using InfluxDB v2.
1614

17-
Start InfluxDB v2 and set up with the UI, CLI, or API
18-
-----------------------------------------------------
15+
## Start InfluxDB v2 and set up with the UI, CLI, or API
1916

2017
To start an InfluxDB v2 container that you can then set up using the included UI, the `influx` CLI, or the HTTP API, enter the following command:
2118

@@ -51,8 +48,7 @@ See the [`influx setup` documentation](https://docs.influxdata.com/influxdb/v2/r
5148

5249
*If you run setup from within the container, InfluxDB stores `influx` CLI [connection configurations](/influxdb/v2/reference/cli/influx/#provide-required-authentication-credentials) in the container's `/etc/influxdb2/influx-configs` file.*
5350

54-
Start InfluxDB v2 with automated setup
55-
--------------------------------------
51+
## Start InfluxDB v2 with automated setup
5652

5753
To start and set up InfluxDB v2 with a single command, specify `-e DOCKER_INFLUXDB_INIT_MODE=setup` and `-e DOCKER_INFLUXDB_INIT_` environment variables for the initial user, password, bucket, and organization--for example:
5854

@@ -181,8 +177,7 @@ docker run -p 8086:8086 \
181177
>
182178
> This behavior allows for the InfluxDB container to reboot post-setup and avoid overwriting migrated data, `DB is already set up` errors, and errors from non-idempotent script commands.
183179
184-
Access InfluxDB v2 file system and ports
185-
----------------------------------------
180+
## Access InfluxDB v2 file system and ports
186181

187182
When starting an InfluxDB container, we recommend the following for easy access to your data, configurations, and InfluxDB v2 instance:
188183

@@ -261,8 +256,8 @@ The automated upgrade process creates the following in the InfluxDB v2 container
261256
- an initial admin user
262257
- an initial organization
263258
- an initial bucket
264-
- InfluxDB v2 data files (the default path is `/var/lib/influxdb2`\)
265-
- InfluxDB v2 configuration files (the default path is `/etc/influxdb2`\)
259+
- InfluxDB v2 data files (the default path is `/var/lib/influxdb2`)
260+
- InfluxDB v2 configuration files (the default path is `/etc/influxdb2`)
266261

267262
*Mount volumes at both paths to avoid losing data.*
268263

@@ -322,7 +317,7 @@ docker run -p 8086:8086 \
322317

323318
#### Upgrade InfluxDB 1.x: custom configuration
324319

325-
Assume you've been running an InfluxDB 1.x deployment with customized configuration (`/etc/influxdb/influxdb.conf`\):
320+
Assume you've been running an InfluxDB 1.x deployment with customized configuration (`/etc/influxdb/influxdb.conf`):
326321

327322
```console
328323
docker run -p 8086:8086 \
@@ -448,13 +443,11 @@ docker run -p 8086:8086 \
448443
%%IMAGE%%:2
449444
```
450445

451-
How to use this image for InfluxDB v1
452-
=====================================
446+
# How to use this image for InfluxDB v1
453447

454448
Use the InfluxDB Docker Hub image to run and set up an [InfluxDB 1.x](https://docs.influxdata.com/influxdb/v1/) container.
455449

456-
Running the container
457-
---------------------
450+
## Running the container
458451

459452
To start an InfluxDB 1.x container, enter the following command:
460453

@@ -473,8 +466,7 @@ Replace `$PWD` with the host directory where you want InfluxDB to store data.
473466

474467
*Use Docker [Volumes](https://docs.docker.com/storage/volumes/) or [Bind mounts](https://docs.docker.com/storage/bind-mounts/) to persist InfluxDB [data and configuration directories](https://docs.influxdata.com/influxdb/v1/concepts/file-system-layout/).*
475468

476-
Networking ports
477-
----------------
469+
## Networking ports
478470

479471
InfluxDB uses the following networking ports:
480472

@@ -483,8 +475,7 @@ InfluxDB uses the following networking ports:
483475

484476
Using the `docker run` [`-P, --publish-all` flag](https://docs.docker.com/reference/cli/docker/container/run/#publish-all) exposes the InfluxDB HTTP API to the host.
485477

486-
Configure InfluxDB v1 in a container
487-
------------------------------------
478+
## Configure InfluxDB v1 in a container
488479

489480
To configure InfluxDB v1 in a container, use a configuration file or environment variables.
490481

@@ -522,8 +513,7 @@ docker run -p 8086:8086 \
522513

523514
Learn more about [configuring InfluxDB v1](https://docs.influxdata.com/influxdb/v1.8/administration/config/).
524515

525-
Graphite
526-
--------
516+
## Graphite
527517

528518
InfluxDB supports the Graphite line protocol, but the service and ports are not exposed by default. To run InfluxDB with Graphite support enabled, you can either use a configuration file or set the appropriate environment variables. Run InfluxDB with the default Graphite configuration:
529519

@@ -535,8 +525,7 @@ docker run -p 8086:8086 -p 2003:2003 \
535525

536526
See the [README on GitHub](https://github.com/influxdata/influxdb/blob/master/services/graphite/README.md) for more detailed documentation to set up the Graphite service. In order to take advantage of graphite templates, you should use a configuration file by outputting a default configuration file using the steps above and modifying the `[[graphite]]` section.
537527

538-
InfluxDB v1 HTTP API
539-
--------------------
528+
## InfluxDB v1 HTTP API
540529

541530
Creating a DB named mydb:
542531

@@ -552,8 +541,7 @@ curl -i -XPOST 'http://localhost:8086/write?db=mydb' --data-binary 'cpu_load_sho
552541

553542
Read more about this in the [official documentation](https://docs.influxdata.com/influxdb/latest/guides/writing_data/).
554543

555-
CLI / SHELL
556-
-----------
544+
## CLI / SHELL
557545

558546
Start the container:
559547

@@ -573,8 +561,7 @@ Or run the influx client in a separate container:
573561
docker run --rm --link=influxdb -it %%IMAGE%%:1.8 influx -host influxdb
574562
```
575563

576-
InfluxDB v1 database initialization
577-
-----------------------------------
564+
## InfluxDB v1 database initialization
578565

579566
### Not recommended for production
580567

influxdb/variant-data.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
`%%IMAGE%%:data`
2-
----------------
1+
## `%%IMAGE%%:data`
32

43
*Using this image for [InfluxDB Enterprise](https://docs.influxdata.com/enterprise_influxdb/v1/introduction/installation/meta_node_installation/#license-key-or-file) requires a valid InfluxData [license key](https://docs.influxdata.com/enterprise_influxdb/v1/introduction/installation/meta_node_installation/#license-key-or-file).*
54

0 commit comments

Comments
 (0)