Skip to content

Commit 975d27f

Browse files
committed
fix(influxdb-v1): formatting
1 parent afb0210 commit 975d27f

File tree

3 files changed

+20
-16
lines changed

3 files changed

+20
-16
lines changed

influxdb/content.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -576,12 +576,14 @@ docker run --rm --link=influxdb -it %%IMAGE%%:1.8 influx -host influxdb
576576
InfluxDB v1 database initialization
577577
-----------------------------------
578578

579+
### Not recommended for production
580+
581+
We **don't** recommend using initialization options for InfluxDB v1 production scenarios, but they're useful when running standalone instances for testing.
582+
579583
The InfluxDB Docker Hub image lets you set initialization options when creating an InfluxDB v1 container.
580584

581585
The database initialization script is only called when running `influxd`; it isn't executed by any other program.
582586

583-
**WARNING**: We **don't** recommend using these options for production scenarios, but they're useful when running standalone instances for testing.
584-
585587
### Environment variables
586588

587589
During the InfluxDB v1 set up process, the InfluxDB image uses environment variables to automatically configure some server options. You can override the following environment variables to customize set up options.

influxdb/variant-data.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
## `%%IMAGE%%:data`
1+
`%%IMAGE%%:data`
2+
----------------
23

34
*This image requires a valid license key from InfluxData.* Please visit our [products page](https://www.influxdata.com/products/) to learn more.
45

influxdb/variant-meta.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
## `%%IMAGE%%:meta`
1+
`%%IMAGE%%:meta`
2+
----------------
23

34
*This image requires a valid license key from InfluxData.* Please visit our [products page](https://www.influxdata.com/products/) to learn more.
45

@@ -11,7 +12,7 @@ This image contains the enterprise meta node package for clustering. It is meant
1112
The license key can be specified using either an environment variable or by overriding the configuration file. If you specify the license key directly, the container needs to be able to access the InfluxData portal.
1213

1314
```console
14-
$ docker run -p 8089:8089 -p 8091:8091 \
15+
docker run -p 8089:8089 -p 8091:8091 \
1516
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key>
1617
%%IMAGE%%:meta
1718
```
@@ -23,21 +24,21 @@ The examples below will use docker's built-in networking capability. If you use
2324
First, create a docker network:
2425

2526
```console
26-
$ docker network create influxdb
27+
docker network create influxdb
2728
```
2829

2930
Start three meta nodes. This is the suggested number of meta nodes. We do not recommend running more or less. If you choose to run more or less, be sure that the number of meta nodes is odd. The hostname must be set on each container to the address that will be used to access the meta node. When using docker networks, the hostname should be made the same as the name of the container.
3031

3132
```console
32-
$ docker run -d --name=influxdb-meta-0 --network=influxdb \
33+
docker run -d --name=influxdb-meta-0 --network=influxdb \
3334
-h influxdb-meta-0 \
3435
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
3536
%%IMAGE%%:meta
36-
$ docker run -d --name=influxdb-meta-1 --network=influxdb \
37+
docker run -d --name=influxdb-meta-1 --network=influxdb \
3738
-h influxdb-meta-1 \
3839
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
3940
%%IMAGE%%:meta
40-
$ docker run -d --name=influxdb-meta-2 --network=influxdb \
41+
docker run -d --name=influxdb-meta-2 --network=influxdb \
4142
-h influxdb-meta-2 \
4243
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
4344
%%IMAGE%%:meta
@@ -48,16 +49,16 @@ When setting the hostname, you can use `-h <hostname>` or you can directly set t
4849
After starting the meta nodes, you need to tell them about each other. Choose one of the meta nodes and run `influxd-ctl` in the container.
4950

5051
```console
51-
$ docker exec influxdb-meta-0 \
52+
docker exec influxdb-meta-0 \
5253
influxd-ctl add-meta influxdb-meta-1:8091
53-
$ docker exec influxdb-meta-0 \
54+
docker exec influxdb-meta-0 \
5455
influxd-ctl add-meta influxdb-meta-2:8091
5556
```
5657

5758
Or you can just start a single meta node. If you setup a single meta node, you do not need to use `influxd-ctl add-meta`.
5859

5960
```console
60-
$ docker run -d --name=influxdb-meta --network=influxdb \
61+
docker run -d --name=influxdb-meta --network=influxdb \
6162
-h influxdb-meta \
6263
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
6364
%%IMAGE%%:meta -single-server
@@ -68,7 +69,7 @@ $ docker run -d --name=influxdb-meta --network=influxdb \
6869
Start the data nodes using `%%IMAGE%%:data` with similar command line arguments to the meta nodes. You can start as many data nodes as are allowed by your license.
6970

7071
```console
71-
$ docker run -d --name=influxdb-data-0 --network=influxdb \
72+
docker run -d --name=influxdb-data-0 --network=influxdb \
7273
-h influxdb-data-0 \
7374
-e INFLUXDB_LICENSE_KEY=<license-key> \
7475
%%IMAGE%%:data
@@ -77,7 +78,7 @@ $ docker run -d --name=influxdb-data-0 --network=influxdb \
7778
You can add `-p 8086:8086` to expose the http port to the host machine. After starting the container, choose one of the meta nodes and add the data node to it.
7879

7980
```console
80-
$ docker exec influxdb-meta-0 \
81+
docker exec influxdb-meta-0 \
8182
influxd-ctl add-data influxdb-data-0:8088
8283
```
8384

@@ -94,13 +95,13 @@ InfluxDB Meta can be either configured from a config file or using environment v
9495
Generate the default configuration file:
9596

9697
```console
97-
$ docker run --rm %%IMAGE%%:meta influxd-meta config > influxdb-meta.conf
98+
docker run --rm %%IMAGE%%:meta influxd-meta config > influxdb-meta.conf
9899
```
99100

100101
Modify the default configuration, which will now be available under `$PWD`. Then start the InfluxDB Meta container.
101102

102103
```console
103-
$ docker run \
104+
docker run \
104105
-v $PWD/influxdb-meta.conf:/etc/influxdb/influxdb-meta.conf:ro \
105106
%%IMAGE%% -config /etc/influxdb/influxdb-meta.conf
106107
```

0 commit comments

Comments
 (0)