removed influxd print-config from 2.3, 2.4, alias (#4376)
lwandzura
GitHub
parent
9f43cd41c4
commit
7b9c3b63df
|
|
@ -12,6 +12,8 @@ cascade:
|
|||
- /influxdb/v2.3/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.3/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
metadata: [influx CLI 2.3.0+, InfluxDB 2.0.0+]
|
||||
aliases:
|
||||
- /influxdb/v2.2/reference/cli/influxd/print-config/
|
||||
---
|
||||
|
||||
The `influx server-config` command displays the InfluxDB runtime [server configuration](/influxdb/v2.3/reference/config-options/).
|
||||
|
|
|
|||
|
|
@ -1,93 +0,0 @@
|
|||
---
|
||||
title: influxd print-config
|
||||
description: >
|
||||
The `influxd print-config` command prints a full InfluxDB configuration resolved
|
||||
from the current `influxd` environment.
|
||||
influxdb/v2.3/tags: [influxd, cli]
|
||||
menu:
|
||||
influxdb_2_3_ref:
|
||||
parent: influxd
|
||||
weight: 201
|
||||
related:
|
||||
- /influxdb/v2.3/reference/config-options/
|
||||
- /influxdb/v2.3/reference/cli/influx/server-config/
|
||||
---
|
||||
|
||||
The `influxd print-config` command prints a full InfluxDB configuration resolved
|
||||
from the current `influxd` environment.
|
||||
The command formats output as YAML.
|
||||
|
||||
{{% warn %}}
|
||||
|
||||
#### Use influx CLI server-config
|
||||
|
||||
`influxd print-config` is deprecated in InfluxDB v2.3.
|
||||
|
||||
To display the runtime server configuration, use the [`influx server-config` command](/influxdb/v2.3/reference/cli/influx/server-config/)
|
||||
or the [`/api/v2/config`](/influxdb/v2.3/api/#operation/GetConfig) InfluxDB API endpoint.
|
||||
For more information, see [how to view your server configuration](/influxdb/v2.3/reference/config-options/#view-your-runtime-server-configuration).
|
||||
{{% /warn %}}
|
||||
|
||||
`influxd print-config` does not output the configuration of the running server. Rather, it evaluates the current environment, config file, and _flags passed to the `influxd print-config` command_. It is unaware of configuration options passed to the `influxd` command at runtime.
|
||||
|
||||
For example, with the following configuration value:
|
||||
```sh
|
||||
# Configuration file
|
||||
...
|
||||
log-level: info
|
||||
...
|
||||
```
|
||||
|
||||
and `--log-level` provided at startup:
|
||||
|
||||
```
|
||||
influxd --log-level warn
|
||||
```
|
||||
|
||||
`influxd print-config` displays
|
||||
|
||||
```sh
|
||||
...
|
||||
log-level: info
|
||||
...
|
||||
```
|
||||
|
||||
`influxd print-config log-level warn` displays
|
||||
|
||||
```sh
|
||||
...
|
||||
log-level: warn
|
||||
...
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
influxd print-config [flags]
|
||||
```
|
||||
|
||||
|
||||
{{% note %}}
|
||||
For information about available InfluxDB configuration methods, see
|
||||
[InfluxDB configuration options](/influxdb/v2.3/reference/config-options/).
|
||||
{{% /note %}}
|
||||
|
||||
## Flags
|
||||
|
||||
| Flag | | Description | Input type |
|
||||
|:---- | --- |:----------- |:----------:|
|
||||
| `-h` | `--help` | Help for `print-config` | |
|
||||
| | `--key-name` | Print the value of a specific configuration key | string |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
##### Print full influxd configuration
|
||||
```sh
|
||||
influxd print-config
|
||||
```
|
||||
|
||||
##### Print the value of a specific influxd configuration setting
|
||||
```sh
|
||||
influxd print-config --key-name=http-bind-address
|
||||
```
|
||||
|
|
@ -12,6 +12,8 @@ cascade:
|
|||
- /influxdb/v2.4/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
|
||||
- /influxdb/v2.4/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
|
||||
metadata: [influx CLI 2.3.0+, InfluxDB 2.0.0+]
|
||||
aliases:
|
||||
- /influxdb/v2.2/reference/cli/influxd/print-config/
|
||||
---
|
||||
|
||||
The `influx server-config` command displays the InfluxDB runtime [server configuration](/influxdb/v2.4/reference/config-options/).
|
||||
|
|
|
|||
|
|
@ -1,93 +0,0 @@
|
|||
---
|
||||
title: influxd print-config
|
||||
description: >
|
||||
The `influxd print-config` command prints a full InfluxDB configuration resolved
|
||||
from the current `influxd` environment.
|
||||
influxdb/v2.4/tags: [influxd, cli]
|
||||
menu:
|
||||
influxdb_2_4_ref:
|
||||
parent: influxd
|
||||
weight: 201
|
||||
related:
|
||||
- /influxdb/v2.4/reference/config-options/
|
||||
- /influxdb/v2.4/reference/cli/influx/server-config/
|
||||
---
|
||||
|
||||
The `influxd print-config` command prints a full InfluxDB configuration resolved
|
||||
from the current `influxd` environment.
|
||||
The command formats output as YAML.
|
||||
|
||||
{{% warn %}}
|
||||
|
||||
#### Use influx CLI server-config
|
||||
|
||||
`influxd print-config` is deprecated in InfluxDB v2.3.
|
||||
|
||||
To display the runtime server configuration, use the [`influx server-config` command](/influxdb/v2.4/reference/cli/influx/server-config/)
|
||||
or the [`/api/v2/config`](/influxdb/v2.4/api/#operation/GetConfig) InfluxDB API endpoint.
|
||||
For more information, see [how to view your server configuration](/influxdb/v2.4/reference/config-options/#view-your-runtime-server-configuration).
|
||||
{{% /warn %}}
|
||||
|
||||
`influxd print-config` does not output the configuration of the running server. Rather, it evaluates the current environment, config file, and _flags passed to the `influxd print-config` command_. It is unaware of configuration options passed to the `influxd` command at runtime.
|
||||
|
||||
For example, with the following configuration value:
|
||||
```sh
|
||||
# Configuration file
|
||||
...
|
||||
log-level: info
|
||||
...
|
||||
```
|
||||
|
||||
and `--log-level` provided at startup:
|
||||
|
||||
```
|
||||
influxd --log-level warn
|
||||
```
|
||||
|
||||
`influxd print-config` displays
|
||||
|
||||
```sh
|
||||
...
|
||||
log-level: info
|
||||
...
|
||||
```
|
||||
|
||||
`influxd print-config log-level warn` displays
|
||||
|
||||
```sh
|
||||
...
|
||||
log-level: warn
|
||||
...
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
influxd print-config [flags]
|
||||
```
|
||||
|
||||
|
||||
{{% note %}}
|
||||
For information about available InfluxDB configuration methods, see
|
||||
[InfluxDB configuration options](/influxdb/v2.4/reference/config-options/).
|
||||
{{% /note %}}
|
||||
|
||||
## Flags
|
||||
|
||||
| Flag | | Description | Input type |
|
||||
|:---- | --- |:----------- |:----------:|
|
||||
| `-h` | `--help` | Help for `print-config` | |
|
||||
| | `--key-name` | Print the value of a specific configuration key | string |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
##### Print full influxd configuration
|
||||
```sh
|
||||
influxd print-config
|
||||
```
|
||||
|
||||
##### Print the value of a specific influxd configuration setting
|
||||
```sh
|
||||
influxd print-config --key-name=http-bind-address
|
||||
```
|
||||
Loading…
Reference in New Issue