diff --git a/.ci/vale/styles/InfluxDBv2/ServerConfig.yml b/.ci/vale/styles/InfluxDBv2/ServerConfig.yml new file mode 100644 index 0000000000..aae5fa4107 --- /dev/null +++ b/.ci/vale/styles/InfluxDBv2/ServerConfig.yml @@ -0,0 +1,10 @@ +extends: spelling +message: "Did you really mean '%s'?" +level: warning +ignore: +# Ignore the following words. All words are case-insensitive. +# To use case-sensitive matching, use the filters section or vocabulary Terms. + - InfluxDBv2/Terms/query-functions.txt + - InfluxDBv2/Terms/server-config-options.txt +filters: + - '(\[|`)ui-disabled(`|\])' \ No newline at end of file diff --git a/.ci/vale/styles/InfluxDBv2/Terms/query-functions.txt b/.ci/vale/styles/InfluxDBv2/Terms/query-functions.txt new file mode 100644 index 0000000000..60ceb5b7e9 --- /dev/null +++ b/.ci/vale/styles/InfluxDBv2/Terms/query-functions.txt @@ -0,0 +1,76 @@ + + +# InfluxQL +# is_scalar_math_function +# Source: https://github.com/influxdata/influxdb_iox/blob/4f9c901dcfece5fcc4d17cfecb6ec45a0dccda5a/influxdb_influxql_parser/src/functions.rs +abs +sin +cos +tan +asin +acos +acosh +asinh +atan +atanh +atan2 +cbrt +exp +gcd +isnan +iszero +lcm +log +ln +log2 +log10 +nanvl +sqrt +pow +floor +ceil +round + +# InfluxQL operators +bitfield + +# is_aggregate_function +# Source: https://github.com/influxdata/influxdb_iox/blob/4f9c901dcfece5fcc4d17cfecb6ec45a0dccda5a/influxdb_influxql_parser/src/functions.rs +approx_distinct +approx_median +approx_percentile_cont +approx_percentile_cont_with_weight +covar +cumulative_sum +derivative +difference +elapsed +moving_average +non_negative_derivative +non_negative_difference +bottom +first +last +max +min +percentile +sample +top +count +integral +mean +median +mode +spread +stddev +sum +holt_winters +holt_winters_with_fit +chande_momentum_oscillator +exponential_moving_average +double_exponential_moving_average +kaufmans_efficiency_ratio +kaufmans_adaptive_moving_average +triple_exponential_moving_average +triple_exponential_derivative +relative_strength_index \ No newline at end of file diff --git a/.ci/vale/styles/InfluxDBv2/Terms/server-config-options.txt b/.ci/vale/styles/InfluxDBv2/Terms/server-config-options.txt new file mode 100644 index 0000000000..587ca980f4 --- /dev/null +++ b/.ci/vale/styles/InfluxDBv2/Terms/server-config-options.txt @@ -0,0 +1,70 @@ +assets-path +bolt-path +e2e-testing +engine-path +feature-flags +flux-log-enabled +hardening-enabled +http-bind-address +http-idle-timeout +http-read-header-timeout +http-read-timeout +http-write-timeout +influxql-max-select-buckets +influxql-max-select-point +influxql-max-select-series +instance-id +log-level +metrics-disabled +nats-max-payload-bytes +nats-port +no-tasks +pprof-disabled +query-concurrency +query-initial-memory-bytes +query-max-memory-bytes +query-memory-bytes +query-queue-size +reporting-disabled +secret-store +session-length +session-renew-disabled +sqlite-path +storage-cache-max-memory-size +storage-cache-snapshot-memory-size +storage-cache-snapshot-write-cold-duration +storage-compact-full-write-cold-duration +storage-compact-throughput-burst +storage-max-concurrent-compactions +storage-max-index-log-file-size +storage-no-validate-field-size +storage-retention-check-interval +storage-series-file-max-concurrent-snapshot-compactions +storage-series-id-set-cache-size +storage-shard-precreator-advance-period +storage-shard-precreator-check-interval +storage-tsm-use-madv-willneed +storage-validate-keys +storage-wal-fsync-delay +storage-wal-max-concurrent-writes +storage-wal-max-write-delay +storage-write-timeout +store +strong-passwords +testing-always-allow-setup +tls-cert +tls-key +tls-min-version +tls-strict-ciphers +tracing-type +ui-disabled +vault-addr +vault-cacert +vault-capath +vault-client-cert +vault-client-key +vault-client-timeout +vault-max-retries +vault-skip-verify +vault-tls-server-name +vault-token \ No newline at end of file diff --git a/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt index 83be41c7b2..dae2608d14 100644 --- a/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt +++ b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt @@ -38,7 +38,7 @@ SQLAlchemy Splunk [Ss]uperset TBs? -UI +\bUI\b URL US (East|West|Central|North|South|Northeast|Northwest|Southeast|Southwest) Unix diff --git a/Dockerfile.pytest b/Dockerfile.pytest index 293676a70c..b47718c82b 100644 --- a/Dockerfile.pytest +++ b/Dockerfile.pytest @@ -15,6 +15,7 @@ RUN apt-get update && apt-get upgrade -y && apt-get install -y \ curl \ git \ gpg \ + influxdb2 \ influxdb2-cli \ influxctl \ jq \ @@ -41,6 +42,9 @@ ENV PYTHONUNBUFFERED=1 WORKDIR /app +RUN mkdir -p /app/log && chmod +w /app/log +RUN mkdir -p /app/assets && chmod +w /app/assets + # Some Python test dependencies (pytest-dotenv and pytest-codeblocks) aren't # available as packages in apt-cache, so use pip to download dependencies in a # separate step and use Docker's caching. # Pytest configuration file. @@ -62,6 +66,8 @@ RUN echo '#!/bin/bash' > /usr/local/bin/xdg-open \ && echo 'echo "$1" > /shared/urls.txt' >> /usr/local/bin/xdg-open \ && chmod +x /usr/local/bin/xdg-open +RUN service influxdb start + # Copy test scripts and make them executable. COPY --chmod=755 ./test/scripts/parse_yaml.sh /usr/local/bin/parse_yaml diff --git a/content/influxdb/v2/.vale.ini b/content/influxdb/v2/.vale.ini new file mode 100644 index 0000000000..06147959c9 --- /dev/null +++ b/content/influxdb/v2/.vale.ini @@ -0,0 +1,17 @@ +StylesPath = "../../../.ci/vale/styles" + +Vocab = InfluxDataDocs + +MinAlertLevel = warning + +Packages = Google, write-good, Hugo + +[*.md] +BasedOnStyles = Vale, InfluxDBv2, InfluxDataDocs, Google, write-good + +Google.Acronyms = NO +Google.DateFormat = NO +Google.Ellipses = NO +Google.Headings = NO +Google.WordList = NO +Vale.Spelling = NO \ No newline at end of file diff --git a/content/influxdb/v2/reference/config-options.md b/content/influxdb/v2/reference/config-options.md index bd500d2ca0..71ce2fafed 100644 --- a/content/influxdb/v2/reference/config-options.md +++ b/content/influxdb/v2/reference/config-options.md @@ -34,6 +34,23 @@ Server configuration commands require an [Operator token](/influxdb/v2/admin/tok Use the [`influx server-config` command](/influxdb/v2/reference/cli/influx/server-config/) to retrieve your runtime server configuration. + + + + ```sh influx server-config ``` @@ -202,10 +219,24 @@ _Typically, InfluxData internal use only._ | `--assets-path` | `INFLUXD_ASSETS_PATH` | `assets-path` | ###### influxd flag + + + ```sh influxd --assets-path=/path/to/custom/assets-dir ``` + + ###### Environment variable ```sh export INFLUXD_ASSETS_PATH=/path/to/custom/assets-dir @@ -252,6 +283,8 @@ user information, UI data, REST resources, and other key value data. | `--bolt-path` | `INFLUXD_BOLT_PATH` | `bolt-path` | ###### influxd flag + + ```sh influxd --bolt-path=~/.influxdbv2/influxd.bolt ``` @@ -298,6 +331,8 @@ InfluxData uses this endpoint in end-to-end testing. | `--e2e-testing` | `INFLUXD_E2E_TESTING` | `e2e-testing` | ###### influxd flag + + ```sh influxd --e2e-testing ``` @@ -346,6 +381,8 @@ Time-Structure Merge Tree (TSM) data on disk. | `--engine-path` | `INFLUXD_ENGINE_PATH` | `engine-path` | ###### influxd flag + + ```sh influxd --engine-path=~/.influxdbv2/engine ``` @@ -396,6 +433,8 @@ intended for internal use only. | `--feature-flags` | `INFLUXD_FEATURE_FLAGS` | `feature-flags` | ###### influxd flag + + ```sh influxd --feature-flags flag1=value2,flag2=value2 ``` @@ -461,6 +500,8 @@ Include option to show detailed logs for Flux queries, including the following l | `--flux-log-enabled` | `INFLUXD_FLUX_LOG_ENABLED` | `flux-log-enabled` | ###### influxd flag + + ```sh influxd --flux-log-enabled ``` @@ -508,6 +549,8 @@ in InfluxDB. | `--hardening-enabled` | `INFLUXD_HARDENING_ENABLED` | `hardening-enabled` | ###### influxd flag + + ```sh influxd --hardening-enabled ``` @@ -556,6 +599,8 @@ Customize the URL and port for the InfluxDB API and UI. | `--http-bind-address` | `INFLUXD_HTTP_BIND_ADDRESS` | `http-bind-address` | ###### influxd flag + + ```sh influxd --http-bind-address=:8086 ``` @@ -604,6 +649,8 @@ Set to `0` for no timeout. | `--http-idle-timeout` | `INFLUXD_HTTP_IDLE_TIMEOUT` | `http-idle-timeout` | ###### influxd flag + + ```sh influxd --http-idle-timeout=3m0s ``` @@ -652,6 +699,8 @@ Set to `0` for no timeout. | `--http-read-header-timeout` | `INFLUXD_HTTP_READ_HEADER_TIMEOUT` | `http-read-header-timeout` | ###### influxd flag + + ```sh influxd --http-read-header-timeout=10s ``` @@ -708,6 +757,8 @@ potentially hurt performance. | `--http-read-timeout` | `INFLUXD_HTTP_READ_TIMEOUT` | `http-read-timeout` | ###### influxd flag + + ```sh influxd --http-read-timeout=10s ``` @@ -746,7 +797,11 @@ http-read-timeout = "10s" --- ### http-write-timeout -Maximum duration the server should spend processing and responding to write requests. +Maximum duration to wait before timing out writes of the response. +It doesn't let Handlers decide the duration on a per-request basis. + +The timeout is reset when a new request's header is read. + Set to `0` for no timeout. **Default:** `0` @@ -764,10 +819,23 @@ potentially hurt performance. | `--http-write-timeout` | `INFLUXD_HTTP_WRITE_TIMEOUT` | `http-write-timeout` | ###### influxd flag + + ```sh influxd --http-write-timeout=10s ``` + + ###### Environment variable ```sh export INFLUXD_HTTP_WRITE_TIMEOUT=10s @@ -812,6 +880,10 @@ Maximum number of group by time buckets a `SELECT` statement can create. | `--influxql-max-select-buckets` | `INFLUXD_INFLUXQL_MAX_SELECT_BUCKETS` | `influxql-max-select-buckets` | ###### influxd flag + + + + ```sh influxd --influxql-max-select-buckets=0 ``` @@ -861,6 +933,8 @@ InfluxDB checks the point count every second (so queries exceeding the maximum a | `--influxql-max-select-point` | `INFLUXD_INFLUXQL_MAX_SELECT_POINT` | `influxql-max-select-point` | ###### influxd flag + + ```sh influxd --influxql-max-select-point=0 ``` @@ -909,6 +983,10 @@ Maximum number of series a `SELECT` statement can return. | `--influxql-max-select-series` | `INFLUXD_INFLUXQL_MAX_SELECT_SERIES` | `influxql-max-select-series` | ###### influxd flag + + + + ```sh influxd --influxql-max-select-series=0 ``` @@ -955,11 +1033,15 @@ Identifies edge nodes during replication, and prevents collisions if two edge no | `--instance-id` | `INFLUXD_INSTANCE_ID` | `instance-id` | ###### influxd flag + + ```sh influxd --instance-id=:8086 ``` ###### Environment variable + + ```sh export INFLUXD_INSTANCE_ID=:8086 ``` @@ -1004,6 +1086,10 @@ InfluxDB outputs log entries with severity levels greater than or equal to the l | `--log-level` | `INFLUXD_LOG_LEVEL` | `log-level` | ###### influxd flag + + + + ```sh influxd --log-level=info ``` @@ -1051,6 +1137,10 @@ Disable the HTTP `/metrics` endpoint which exposes [internal InfluxDB metrics](/ | `--metrics-disabled` | `INFLUXD_METRICS_DISABLED` | `metrics-disabled` | ###### influxd flag + + + + ```sh influxd --metrics-disabled ``` @@ -1103,6 +1193,8 @@ Maximum number of bytes allowed in a NATS message payload. | `--nats-max-payload-bytes` | `INFLUXD_NATS_MAX_PAYLOAD_BYTES` | `nats-max-payload-bytes` | ###### influxd flag + + ```sh influxd --nats-max-payload-bytes=1048576 ``` @@ -1155,6 +1247,8 @@ Port for the NATS streaming server. `-1` selects a random port. | `--nats-port` | `INFLUXD_NATS_PORT` | `nats-port` | ###### influxd flag + + ```sh influxd --nats-port=-1 ``` @@ -1204,6 +1298,8 @@ InfluxDB without scheduling or executing tasks. | `--no-tasks` | `INFLUXD_NO_TASKS` | `no-tasks` | ###### influxd flag + + ```sh influxd --no-tasks ``` @@ -1252,6 +1348,8 @@ This endpoint provides runtime profiling data and can be helpful when debugging. | `--pprof-disabled` | `INFLUXD_PPROF_DISABLED` | `pprof-disabled` | ###### influxd flag + + ```sh influxd --pprof-disabled ``` @@ -1300,6 +1398,8 @@ Setting to `0` allows an unlimited number of concurrent queries. | `--query-concurrency` | `INFLUXD_QUERY_CONCURRENCY` | `query-concurrency` | ###### influxd flag + + ```sh influxd --query-concurrency=10 ``` @@ -1347,6 +1447,8 @@ Initial bytes of memory allocated for a query. | `--query-initial-memory-bytes` | `INFLUXD_QUERY_INITIAL_MEMORY_BYTES` | `query-initial-memory-bytes` | ###### influxd flag + + ```sh influxd --query-initial-memory-bytes=10485760 ``` @@ -1394,6 +1496,8 @@ Maximum total bytes of memory allowed for queries. | `--query-max-memory-bytes` | `INFLUXD_QUERY_MAX_MEMORY_BYTES` | `query-max-memory-bytes` | ###### influxd flag + + ```sh influxd --query-max-memory-bytes=104857600 ``` @@ -1445,6 +1549,8 @@ Must be greater than or equal to [query-initial-memory-bytes](#query-initial-mem | `--query-memory-bytes` | `INFLUXD_QUERY_MEMORY_BYTES` | `query-memory-bytes` | ###### influxd flag + + ```sh influxd --query-memory-bytes=10485760 ``` @@ -1494,6 +1600,8 @@ Setting to `0` allows an unlimited number of queries in the queue. | `--query-queue-size` | `INFLUXD_QUERY_QUEUE_SIZE` | `query-queue-size` | ###### influxd flag + + ```sh influxd --query-queue-size=10 ``` @@ -1543,6 +1651,8 @@ information about what data is collected and how InfluxData uses it. | `--reporting-disabled` | `INFLUXD_REPORTING_DISABLED` | `reporting-disabled` | ###### influxd flag + + ```sh influxd --reporting-disabled ``` @@ -1593,6 +1703,8 @@ or in [Vault](https://www.vaultproject.io/). | `--secret-store` | `INFLUXD_SECRET_STORE` | `secret-store` | ###### influxd flag + + ```sh influxd --secret-store=bolt ``` @@ -1640,6 +1752,8 @@ Specifies the Time to Live (TTL) **in minutes** for newly created user sessions. | `--session-length` | `INFLUXD_SESSION_LENGTH` | `session-length` | ###### influxd flag + + ```sh influxd --session-length=60 ``` @@ -1690,6 +1804,8 @@ and the user is redirected to the login page, even if recently active. | `--session-renew-disabled` | `INFLUXD_SESSION_RENEW_DISABLED` | `session-renew-disabled` | ###### influxd flag + + ```sh influxd --session-renew-disabled ``` @@ -1739,6 +1855,8 @@ The SQLite database is used to store metadata for notebooks and annotations. | `--sqlite-path` | `INFLUXD_SQLITE_PATH` | `sqlite-path` | ###### influxd flag + + ```sh influxd --sqlite-path ~/.influxdbv2/influxd.sqlite ``` @@ -1786,6 +1904,8 @@ Maximum size (in bytes) a shard's cache can reach before it starts rejecting wri | `--storage-cache-max-memory-size` | `INFLUXD_STORAGE_CACHE_MAX_MEMORY_SIZE` | `storage-cache-max-memory-size` | ###### influxd flag + + ```sh influxd --storage-cache-max-memory-size=1073741824 ``` @@ -1834,6 +1954,8 @@ and write it to a TSM file to make more memory available. | `--storage-cache-snapshot-memory-size` | `INFLUXD_STORAGE_CACHE_SNAPSHOT_MEMORY_SIZE` | `storage-cache-snapshot-memory-size` | ###### influxd flag + + ```sh influxd --storage-cache-snapshot-memory-size=26214400 ``` @@ -1882,6 +2004,8 @@ write it to a new TSM file if the shard hasn't received writes or deletes. | `--storage-cache-snapshot-write-cold-duration` | `INFLUXD_STORAGE_CACHE_SNAPSHOT_WRITE_COLD_DURATION` | `storage-cache-snapshot-write-cold-duration` | ###### influxd flag + + ```sh influxd --storage-cache-snapshot-write-cold-duration=10m0s ``` @@ -1930,6 +2054,8 @@ shard if it hasn't received writes or deletes. | `--storage-compact-full-write-cold-duration` | `INFLUXD_STORAGE_COMPACT_FULL_WRITE_COLD_DURATION` | `storage-compact-full-write-cold-duration` | ###### influxd flag + + ```sh influxd --storage-compact-full-write-cold-duration=4h0m0s ``` @@ -1977,6 +2103,8 @@ Rate limit (in bytes per second) that TSM compactions can write to disk. | `--storage-compact-throughput-burst` | `INFLUXD_STORAGE_COMPACT_THROUGHPUT_BURST` | `storage-compact-throughput-burst` | ###### influxd flag + + ```sh influxd --storage-compact-throughput-burst=50331648 ``` @@ -2027,6 +2155,8 @@ _This setting does not apply to cache snapshotting._ | `--storage-max-concurrent-compactions` | `INFLUXD_STORAGE_MAX_CONCURRENT_COMPACTIONS` | `storage-max-concurrent-compactions` | ###### influxd flag + + ```sh influxd --storage-max-concurrent-compactions=0 ``` @@ -2076,6 +2206,8 @@ heap usage at the expense of write throughput. | `--storage-max-index-log-file-size` | `INFLUXD_STORAGE_MAX_INDEX_LOG_FILE_SIZE` | `storage-max-index-log-file-size` | ###### influxd flag + + ```sh influxd --storage-max-index-log-file-size=1048576 ``` @@ -2123,6 +2255,8 @@ Skip field size validation on incoming write requests. | `--storage-no-validate-field-size` | `INFLUXD_STORAGE_NO_VALIDATE_FIELD_SIZE` | `storage-no-validate-field-size` | ###### influxd flag + + ```sh influxd --storage-no-validate-field-size ``` @@ -2170,6 +2304,8 @@ Interval of retention policy enforcement checks. | `--storage-retention-check-interval` | `INFLUXD_STORAGE_RETENTION_CHECK_INTERVAL` | `storage-retention-check-interval` | ###### influxd flag + + ```sh influxd --storage-retention-check-interval=30m0s ``` @@ -2218,6 +2354,8 @@ all series partitions in a database. | `--storage-series-file-max-concurrent-snapshot-compactions` | `INFLUXD_STORAGE_SERIES_FILE_MAX_CONCURRENT_SNAPSHOT_COMPACTIONS` | `storage-series-file-max-concurrent-snapshot-compactions` | ###### influxd flag + + ```sh influxd --storage-series-file-max-concurrent-snapshot-compactions=0 ``` @@ -2275,6 +2413,8 @@ An increase in cache size may lead to an increase in heap usage. | `--storage-series-id-set-cache-size` | `INFLUXD_STORAGE_SERIES_ID_SET_CACHE_SIZE` | `storage-series-id-set-cache-size` | ###### influxd flag + + ```sh influxd --storage-series-id-set-cache-size=100 ``` @@ -2322,6 +2462,8 @@ The time before a shard group's end-time that the successor shard group is creat | `--storage-shard-precreator-advance-period` | `INFLUXD_STORAGE_SHARD_PRECREATOR_ADVANCE_PERIOD` | `storage-shard-precreator-advance-period` | ###### influxd flag + + ```sh influxd --storage-shard-precreator-advance-period=30m0s ``` @@ -2369,6 +2511,8 @@ Interval of pre-create new shards check. | `--storage-shard-precreator-check-interval` | `INFLUXD_STORAGE_SHARD_PRECREATOR_CHECK_INTERVAL` | `storage-shard-precreator-check-interval` | ###### influxd flag + + ```sh influxd --storage-shard-precreator-check-interval=10m0s ``` @@ -2416,6 +2560,8 @@ Inform the kernel that InfluxDB intends to page in mmap'd sections of TSM files. | `--storage-tsm-use-madv-willneed` | `INFLUXD_STORAGE_TSM_USE_MADV_WILLNEED` | `storage-tsm-use-madv-willneed` | ###### influxd flag + + ```sh influxd --storage-tsm-use-madv-willneed ``` @@ -2463,6 +2609,8 @@ Validate incoming writes to ensure keys have only valid unicode characters. | `--storage-validate-keys` | `INFLUXD_STORAGE_VALIDATE_KEYS` | `storage-validate-keys` | ###### influxd flag + + ```sh influxd --storage-validate-keys ``` @@ -2512,6 +2660,8 @@ This is useful for slower disks or when WAL write contention is present. | `--storage-wal-fsync-delay` | `INFLUXD_STORAGE_WAL_FSYNC_DELAY` | `storage-wal-fsync-delay` | ###### influxd flag + + ```sh influxd --storage-wal-fsync-delay=0s ``` @@ -2559,6 +2709,8 @@ Maximum number writes to the WAL directory to attempt at the same time. | `--storage-wal-max-concurrent-writes` | `INFLUXD_STORAGE_WAL_MAX_CONCURRENT_WRITES` | `storage-wal-max-concurrent-writes` | ###### influxd flag + + ```sh influxd --storage-wal-max-concurrent-writes=0 ``` @@ -2608,6 +2760,8 @@ has been met. Set to `0` to disable the timeout. | `--storage-wal-max-write-delay` | `INFLUXD_STORAGE_WAL_MAX_WRITE_DELAY` | `storage-wal-max-write-delay` | ###### influxd flag + + ```sh influxd --storage-wal-max-write-delay=10m ``` @@ -2655,6 +2809,8 @@ Maximum amount of time the storage engine will process a write request before ti | `--storage-write-timeout` | `INFLUXD_STORAGE_WRITE_TIMEOUT` | `storage-write-timeout` | ###### influxd flag + + ```sh influxd --storage-write-timeout=10s ``` @@ -2714,6 +2870,8 @@ InfluxData does not recommend using `memory` in production. | `--store` | `INFLUXD_STORE` | `store` | ###### influxd flag + + ```sh influxd --store=bolt ``` @@ -2766,6 +2924,8 @@ at least three of the following four character classes: | `--strong-passwords` | `INFLUXD_STRONG_PASSWORDS` | `strong-passwords` | ###### influxd flag + + ```sh influxd --strong-passwords ``` @@ -2814,6 +2974,8 @@ This configuration option is primarily used in continuous integration tests. | `--testing-always-allow-setup` | `INFLUXD_TESTING_ALWAYS_ALLOW_SETUP` | `testing-always-allow-setup` | ###### influxd flag + + ```sh influxd --testing-always-allow-setup ``` @@ -2862,6 +3024,8 @@ _For more information, see [Enable TLS encryption](/influxdb/v2/admin/security/e | `--tls-cert` | `INFLUXD_TLS_CERT` | `tls-cert` | ###### influxd flag + + ```sh influxd --tls-cert=/path/to/influxdb.crt ``` @@ -2910,6 +3074,8 @@ _For more information, see [Enable TLS encryption](/influxdb/v2/admin/security/e | `--tls-key` | `INFLUXD_TLS_KEY` | `tls-key` | ###### influxd flag + + ```sh influxd --tls-key=/path/to/influxdb.key ``` @@ -2957,6 +3123,8 @@ Minimum accepted TLS version. | `--tls-min-version` | `INFLUXD_TLS_MIN_VERSION` | `tls-min-version` | ###### influxd flag + + ```sh influxd --tls-min-version=1.2 ``` @@ -3012,6 +3180,8 @@ Restrict accepted TLS ciphers to: | `--tls-strict-ciphers` | `INFLUXD_TLS_STRICT_CIPHERS` | `tls-strict-ciphers` | ###### influxd flag + + ```sh influxd --tls-strict-ciphers ``` @@ -3060,6 +3230,8 @@ Tracing is disabled by default. | `--tracing-type` | `INFLUXD_TRACING_TYPE` | `tracing-type` | ###### influxd flag + + ```sh influxd --tracing-type=log ``` @@ -3108,6 +3280,8 @@ The UI is enabled by default. | `--ui-disabled` | `INFLUXD_UI_DISABLED` | `ui-disabled` | ###### influxd flag + + ```sh influxd --ui-disabled ``` @@ -3154,6 +3328,8 @@ For example: `https://127.0.0.1:8200/`. | `--vault-addr` | `VAULT_ADDR` | `vault-addr` | ###### influxd flag + + ```sh influxd --vault-addr=https://127.0.0.1:8200/ ``` @@ -3201,6 +3377,8 @@ This file is used to verify the Vault server's SSL certificate. | `--vault-cacert` | `VAULT_CACERT` | `vault-cacert` | ###### influxd flag + + ```sh influxd --vault-cacert=/path/to/ca.pem ``` @@ -3247,6 +3425,8 @@ These certificates are used to verify the Vault server's SSL certificate. | `--vault-capath` | `VAULT_CAPATH` | `vault-capath` | ###### influxd flag + + ```sh influxd --vault-capath=/path/to/certs/ ``` @@ -3293,6 +3473,8 @@ This file is used for TLS communication with the Vault server. | `--vault-client-cert` | `VAULT_CLIENT_CERT` | `vault-client-cert` | ###### influxd flag + + ```sh influxd --vault-client-cert=/path/to/client_cert.pem ``` @@ -3339,6 +3521,8 @@ corresponds to the matching client certificate. | `--vault-client-key` | `VAULT_CLIENT_KEY` | `vault-client-key` | ###### influxd flag + + ```sh influxd --vault-client-key=/path/to/private_key.pem ``` @@ -3387,6 +3571,8 @@ The default is 2 (for three attempts in total). Set this to 0 or less to disable | `--vault-max-retries` | `VAULT_MAX_RETRIES` | `vault-max-retries` | ###### influxd flag + + ```sh influxd --vault-max-retries=2 ``` @@ -3434,6 +3620,8 @@ Specifies the Vault client timeout. | `--vault-client-timeout` | `VAULT_CLIENT_TIMEOUT` | `vault-client-timeout` | ###### influxd flag + + ```sh influxd --vault-client-timeout=60s ``` @@ -3483,6 +3671,8 @@ and is **not recommended**._ | `--vault-skip-verify` | `VAULT_SKIP_VERIFY` | `vault-skip-verify` | ###### influxd flag + + ```sh influxd --vault-skip-verify ``` @@ -3528,6 +3718,8 @@ Specifies the name to use as the Server Name Indication (SNI) host when connecti | `--vault-tls-server-name` | `VAULT_TLS_SERVER_NAME` | `vault-tls-server-name` | ###### influxd flag + + ```sh influxd --vault-tls-server-name=secure.example.com ``` @@ -3573,6 +3765,8 @@ Specifies the Vault token use when authenticating with Vault. | `--vault-token` | `VAULT_TOKEN` | `vault-token` | ###### influxd flag + + ```sh influxd --vault-token=exAmple-t0ken-958a-f490-c7fd0eda5e9e ``` diff --git a/lefthook.yml b/lefthook.yml index bcf27775fc..24349243ea 100644 --- a/lefthook.yml +++ b/lefthook.yml @@ -43,7 +43,7 @@ pre-commit: tags: lint v2 glob: "content/influxdb/v2/**/*.md" run: '.ci/vale/vale.sh - --config=.vale.ini + --config=content/influxdb/v2/.vale.ini --minAlertLevel=error {staged_files}' cloud-pytest: glob: content/influxdb/cloud/**/*.md @@ -86,7 +86,7 @@ pre-commit: glob: content/influxdb/v2/**/*.md env: - SERVICE: v2-pytest - run: docker compose run $SERVICE '{staged_files}' + run: docker compose run --rm $SERVICE '{staged_files}' prettier: tags: frontend style glob: "*.{css,js,ts,jsx,tsx}" diff --git a/test/scripts/prepare-content.sh b/test/scripts/prepare-content.sh index 8047ef6df8..c37e0280ff 100644 --- a/test/scripts/prepare-content.sh +++ b/test/scripts/prepare-content.sh @@ -87,7 +87,8 @@ function substitute_placeholders { /os.getenv("ORG_ID")/! s/ORG_ID/$INFLUX_ORG/g; /os.getenv("RETENTION_POLICY")/! s/RETENTION_POLICY_NAME\|RETENTION_POLICY/$INFLUX_RETENTION_POLICY/g; s/CONFIG_NAME/CONFIG_$(shuf -i 0-100 -n1)/g; - s/TEST_RUN/TEST_RUN_$(date +%s)/g' \ + s/TEST_RUN/TEST_RUN_$(date +%s)/g; + s|/path/to/custom/assets-dir|/app/custom-assets|g;' \ $file # v2-specific replacements.