From 922e48182a2bec531c662929c133ad1719a81340 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 25 Jun 2024 18:25:55 -0500 Subject: [PATCH 01/96] chore(ci): Improve Vale style linting: - Run Vale in a Docker container by running ./.ci/vale/vale.sh - Define vale lint scripts in package.json. Lint added and changed files for products. - Define error-level vale linting in the lint-staged configuration for staged files. - Improve product-specific nomenclature checks (e.g. database vs bucket) - Simplify vocab terms and allowed words lists. - Fixes content errors revealed by vale. --- .ci/vale/styles/Cloud-Dedicated/Branding.yml | 11 +++ .ci/vale/styles/Cloud-Dedicated/v3Schema.yml | 10 ++ .ci/vale/styles/Cloud-Serverless/Branding.yml | 14 +++ .ci/vale/styles/Clustered/Branding.yml | 11 +++ .ci/vale/styles/Clustered/v3Schema.yml | 10 ++ .ci/vale/styles/InfluxDataDocs/Branding.yml | 55 +++-------- .ci/vale/styles/InfluxDataDocs/Spelling.yml | 34 ++----- .../Terms/configuration-terms.txt | 12 --- .../Terms/{influxdb.txt => ignore.txt} | 91 +++++++------------ .../styles/InfluxDataDocs/Terms/telegraf.txt | 1 - .ci/vale/styles/InfluxDataDocs/WordList.yml | 1 + .../vocabularies/Cloud-Dedicated/accept.txt | 2 - .../vocabularies/Cloud-Dedicated/reject.txt | 6 -- .../vocabularies/Cloud-Serverless/accept.txt | 2 - .../vocabularies/Cloud-Serverless/reject.txt | 7 -- .../config/vocabularies/Clustered/accept.txt | 1 - .../config/vocabularies/Clustered/reject.txt | 6 -- .../vocabularies/InfluxDataDocs/accept.txt | 77 ++++++++++++++++ .../vocabularies/InfluxDataDocs/reject.txt | 0 .ci/vale/vale.sh | 28 +++--- .lintstagedrc.mjs | 62 ++++++++++--- .vale.ini | 9 +- compose.yaml | 32 ------- content/influxdb/cloud-dedicated/.vale.ini | 9 +- .../cloud-dedicated/get-started/_index.md | 4 +- content/influxdb/cloud-serverless/.vale.ini | 9 +- content/influxdb/clustered/.vale.ini | 9 +- .../influxdb/clustered/get-started/_index.md | 4 +- package.json | 10 +- 29 files changed, 280 insertions(+), 247 deletions(-) create mode 100644 .ci/vale/styles/Cloud-Dedicated/Branding.yml create mode 100644 .ci/vale/styles/Cloud-Dedicated/v3Schema.yml create mode 100644 .ci/vale/styles/Cloud-Serverless/Branding.yml create mode 100644 .ci/vale/styles/Clustered/Branding.yml create mode 100644 .ci/vale/styles/Clustered/v3Schema.yml delete mode 100644 .ci/vale/styles/InfluxDataDocs/Terms/configuration-terms.txt rename .ci/vale/styles/InfluxDataDocs/Terms/{influxdb.txt => ignore.txt} (65%) delete mode 100644 .ci/vale/styles/InfluxDataDocs/Terms/telegraf.txt delete mode 100644 .ci/vale/styles/config/vocabularies/Cloud-Dedicated/accept.txt delete mode 100644 .ci/vale/styles/config/vocabularies/Cloud-Dedicated/reject.txt delete mode 100644 .ci/vale/styles/config/vocabularies/Cloud-Serverless/accept.txt delete mode 100644 .ci/vale/styles/config/vocabularies/Cloud-Serverless/reject.txt delete mode 100644 .ci/vale/styles/config/vocabularies/Clustered/accept.txt delete mode 100644 .ci/vale/styles/config/vocabularies/Clustered/reject.txt create mode 100644 .ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt create mode 100644 .ci/vale/styles/config/vocabularies/InfluxDataDocs/reject.txt mode change 100644 => 100755 .ci/vale/vale.sh diff --git a/.ci/vale/styles/Cloud-Dedicated/Branding.yml b/.ci/vale/styles/Cloud-Dedicated/Branding.yml new file mode 100644 index 000000000..b22437fa7 --- /dev/null +++ b/.ci/vale/styles/Cloud-Dedicated/Branding.yml @@ -0,0 +1,11 @@ +extends: substitution +message: Did you mean '%s' instead of '%s' +level: warning +ignorecase: false +# swap maps tokens in form of bad: good + # NOTE: The left-hand (bad) side can match the right-hand (good) side; + # Vale ignores alerts that match the intended form. +swap: + 'cloud-serverless|clustered': cloud-dedicated + 'Cloud Serverless|Clustered': Cloud Dedicated + 'API token': database token diff --git a/.ci/vale/styles/Cloud-Dedicated/v3Schema.yml b/.ci/vale/styles/Cloud-Dedicated/v3Schema.yml new file mode 100644 index 000000000..a95342af8 --- /dev/null +++ b/.ci/vale/styles/Cloud-Dedicated/v3Schema.yml @@ -0,0 +1,10 @@ +extends: substitution +message: Did you mean '%s' instead of '%s' +level: warning +ignorecase: false +# swap maps tokens in form of bad: good + # NOTE: The left-hand (bad) side can match the right-hand (good) side; + # Vale ignores alerts that match the intended form. +swap: + '(?i)bucket': database + '(?i)measurement': table \ No newline at end of file diff --git a/.ci/vale/styles/Cloud-Serverless/Branding.yml b/.ci/vale/styles/Cloud-Serverless/Branding.yml new file mode 100644 index 000000000..6834da4e2 --- /dev/null +++ b/.ci/vale/styles/Cloud-Serverless/Branding.yml @@ -0,0 +1,14 @@ +extends: substitution +message: Did you mean '%s' instead of '%s' +level: warning +ignorecase: false +# swap maps tokens in form of bad: good + # NOTE: The left-hand (bad) side can match the right-hand (good) side; + # Vale ignores alerts that match the intended form. +swap: + 'cloud-dedicated|clustered': cloud-serverless + 'Cloud Dedicated|Clustered': Cloud Serverless + '(?i)database token': API token + '(?i)management token': API token + '(?i)database': bucket + '(?i)table': measurement \ No newline at end of file diff --git a/.ci/vale/styles/Clustered/Branding.yml b/.ci/vale/styles/Clustered/Branding.yml new file mode 100644 index 000000000..83439dad9 --- /dev/null +++ b/.ci/vale/styles/Clustered/Branding.yml @@ -0,0 +1,11 @@ +extends: substitution +message: Did you mean '%s' instead of '%s' +level: warning +ignorecase: false +# swap maps tokens in form of bad: good + # NOTE: The left-hand (bad) side can match the right-hand (good) side; + # Vale ignores alerts that match the intended form. +swap: + 'cloud-serverless|cloud-dedicated': clustered + 'Cloud Serverless|Cloud Dedicated': Clustered + 'API token': database token diff --git a/.ci/vale/styles/Clustered/v3Schema.yml b/.ci/vale/styles/Clustered/v3Schema.yml new file mode 100644 index 000000000..a95342af8 --- /dev/null +++ b/.ci/vale/styles/Clustered/v3Schema.yml @@ -0,0 +1,10 @@ +extends: substitution +message: Did you mean '%s' instead of '%s' +level: warning +ignorecase: false +# swap maps tokens in form of bad: good + # NOTE: The left-hand (bad) side can match the right-hand (good) side; + # Vale ignores alerts that match the intended form. +swap: + '(?i)bucket': database + '(?i)measurement': table \ No newline at end of file diff --git a/.ci/vale/styles/InfluxDataDocs/Branding.yml b/.ci/vale/styles/InfluxDataDocs/Branding.yml index a63117119..1ecd398b0 100644 --- a/.ci/vale/styles/InfluxDataDocs/Branding.yml +++ b/.ci/vale/styles/InfluxDataDocs/Branding.yml @@ -1,45 +1,20 @@ extends: substitution message: Use '%s' instead of '%s' level: warning -ignorecase: true +ignorecase: false # swap maps tokens in form of bad: good + # NOTE: The left-hand (bad) side can match the right-hand (good) side; + # Vale ignores alerts that match the intended form. swap: - # NOTE: The left-hand (bad) side can match the right-hand (good) side; Vale - # will ignore any alerts that match the intended form. - "anaconda": Anaconda - "(?i)api": API - "arrow": Arrow - "authtoken": authToken - "Authtoken": AuthToken - "chronograf": Chronograf - "cli": CLI - "(?i)clockface": Clockface - "the compactor": the Compactor - "data explorer": Data Explorer - "datetime": dateTime - "dedupe": deduplicate - "(?i)executionplan": ExecutionPlan - "fieldkey": fieldKey - "fieldtype": fieldType - "flight": Flight - "(?i)flightquery": FlightQuery - "(?i)FlightSQL": Flight SQL - "/b(?i)influxdata/b": InfluxData - "/w*/b(?i)influxdb": InfluxDB - "(?i)influxql": InfluxQL - "influxer": Influxer - "the ingester": the Ingester - "(?i)iox": v3 - "java[ -]?scripts?": JavaScript - "kapa": Kapacitor - "logicalplan": LogicalPlan - "the object store": the Object store - "a {{% product-name %}}": an {{% product-name %}} - "Pandas": pandas - " parquet": Parquet - "the querier": the Querier - "SQL Alchemy": SQLAlchemy - "superset": Superset - "tagkey": tagKey - "telegraf": Telegraf - "telegraph": Telegraf + 'the compactor': the Compactor + 'dedupe': deduplicate + '/b(?i)influxdata/b': InfluxData + '/w*/b(?i)influxdb': InfluxDB + 'the ingester': the Ingester + '(?i)iox': v3 + 'the object store': the Object store + 'a {{% product-name %}}': an {{% product-name %}} + 'the querier': the Querier + 'SQL Alchemy': SQLAlchemy + 'telegraph': Telegraf + '(?i)vscode': VSCode diff --git a/.ci/vale/styles/InfluxDataDocs/Spelling.yml b/.ci/vale/styles/InfluxDataDocs/Spelling.yml index d7bb17a89..bdce7da2a 100644 --- a/.ci/vale/styles/InfluxDataDocs/Spelling.yml +++ b/.ci/vale/styles/InfluxDataDocs/Spelling.yml @@ -1,36 +1,14 @@ extends: spelling message: "Did you really mean '%s'?" -level: error +level: warning scope: - ~table.header - ~table.cell ignore: - # Located at StylesPath/ignore1.txt - - InfluxDataDocs/Terms/influxdb.txt - - InfluxDataDocs/Terms/configuration-terms.txt +# Ignore the following words. All words are case-insensitive. +# To use case-sensitive matching, use the filters section or vocabulary Terms. + - InfluxDataDocs/Terms/ignore.txt - InfluxDataDocs/Terms/query-functions.txt - - InfluxDataDocs/Terms/telegraf.txt filters: - # Ignore Hugo, layout, and design words. - - 'Flexbox' - - '(?i)frontmatter' - - '(?i)shortcode(s?)' - - '(?i)tooltip(s?)' - # Ignore all words starting with 'py'. - # e.g., 'PyYAML'. - - '[pP]y.*\b' - # Ignore underscore-delimited words. - # e.g., avg_temp - - '\b\w+_\w+\b' - - '\b_\w+\b' - # Ignore SQL variables. - - '(?i)AS \w+' - # Ignore custom words - - '(?i)deduplicat(ion|e|ed|es|ing)' - - '(?i)downsampl(e|ing|ed|es)' - - 'InfluxDB-specific' - - '(?i)repartition(ed|s|ing)' - - '(?i)subcommand(s?)' - - '(?i)union(ing|ed|s)?' - - 'unsignedLong' - - 'US (East|West|Central|North|South|Northeast|Northwest|Southeast|Southwest)' +# Allow product-specific Branding.yml configurations to handle [Ss]erverless while also allowing serverless as a valid dictionary word. + - '[Ss]erverless' diff --git a/.ci/vale/styles/InfluxDataDocs/Terms/configuration-terms.txt b/.ci/vale/styles/InfluxDataDocs/Terms/configuration-terms.txt deleted file mode 100644 index b443d3739..000000000 --- a/.ci/vale/styles/InfluxDataDocs/Terms/configuration-terms.txt +++ /dev/null @@ -1,12 +0,0 @@ -autogen -batchBucket -batchInterval -commentPrefix -destinationBucket -destinationHost -destinationOrg -destinationToken -quoteChar -retentionRules -sourceBucket -src \ No newline at end of file diff --git a/.ci/vale/styles/InfluxDataDocs/Terms/influxdb.txt b/.ci/vale/styles/InfluxDataDocs/Terms/ignore.txt similarity index 65% rename from .ci/vale/styles/InfluxDataDocs/Terms/influxdb.txt rename to .ci/vale/styles/InfluxDataDocs/Terms/ignore.txt index feaac0799..ad13fb4af 100644 --- a/.ci/vale/styles/InfluxDataDocs/Terms/influxdb.txt +++ b/.ci/vale/styles/InfluxDataDocs/Terms/ignore.txt @@ -1,126 +1,97 @@ -api -apis +autogen +boolean +bundler +chronograf +clockface +flexbox +flight +frontmatter +kapacitor +telegraf +unix args authtoken authz -boolean -booleans -bundler -bundlers -chronograf -cli -clockface -cloud +callout codeblock compactor -conda -csv +config +crypto dashboarding datagram datasource -datetime +deduplicate deserialize -downsample dotenv +downsample enum -executionplan -fieldkey -fieldtype file_groups -flighquery -Grafana -groupId +fullscreen gzip gzipped homogenous hostname -hostUrl -hostURL -HostURL implementor -implementors -influxctl influxd -influxdata.com -influx3 ingester ingesters -iox -kapacitor -lat -locf -logicalplan logstash lon lookahead lookbehind -metaquery metaqueries +metaquery middleware namespace -noaa -npm -oauth output_ordering -pandas param performant projection protofiles pushdown querier +queryable +quoteChar rearchitect -rearchitected -redoc remediations repartition +retentionRules retention_policy retryable rp serializable serializer -serverless shortcode signout -Splunk -SQLAlchemy +src stderr +stdin stdout subcommand -subcommands subnet subnets subprocessor -subprocessors -subquery subqueries +subquery substring -substrings -superset svg syntaxes -tagkey +tagKey tagset -telegraf -telegraf's tombstoned -tsm +tooltip uint uinteger unescaped ungroup ungrouped -unprocessable -unix +unioned +unioning +unions unmarshal unmarshalled unpackage +unprocessable +unsignedLong upsample upsert -urls -venv -VSCode -WALs -Webpack -xpath -XPath diff --git a/.ci/vale/styles/InfluxDataDocs/Terms/telegraf.txt b/.ci/vale/styles/InfluxDataDocs/Terms/telegraf.txt deleted file mode 100644 index 00140d688..000000000 --- a/.ci/vale/styles/InfluxDataDocs/Terms/telegraf.txt +++ /dev/null @@ -1 +0,0 @@ -[Tt]elegraf diff --git a/.ci/vale/styles/InfluxDataDocs/WordList.yml b/.ci/vale/styles/InfluxDataDocs/WordList.yml index 5d1402467..59ab8922c 100644 --- a/.ci/vale/styles/InfluxDataDocs/WordList.yml +++ b/.ci/vale/styles/InfluxDataDocs/WordList.yml @@ -55,6 +55,7 @@ swap: fewer data: less data file name: filename firewalls: firewall rules + fully qualified: fully-qualified functionality: capability|feature Google account: Google Account Google accounts: Google Accounts diff --git a/.ci/vale/styles/config/vocabularies/Cloud-Dedicated/accept.txt b/.ci/vale/styles/config/vocabularies/Cloud-Dedicated/accept.txt deleted file mode 100644 index d0ad5ad23..000000000 --- a/.ci/vale/styles/config/vocabularies/Cloud-Dedicated/accept.txt +++ /dev/null @@ -1,2 +0,0 @@ -cloud-dedicated -Cloud Dedicated \ No newline at end of file diff --git a/.ci/vale/styles/config/vocabularies/Cloud-Dedicated/reject.txt b/.ci/vale/styles/config/vocabularies/Cloud-Dedicated/reject.txt deleted file mode 100644 index 07bbc77dd..000000000 --- a/.ci/vale/styles/config/vocabularies/Cloud-Dedicated/reject.txt +++ /dev/null @@ -1,6 +0,0 @@ -API token -bucket name -Cloud Serverless -cloud-serverless -Clustered -clustered diff --git a/.ci/vale/styles/config/vocabularies/Cloud-Serverless/accept.txt b/.ci/vale/styles/config/vocabularies/Cloud-Serverless/accept.txt deleted file mode 100644 index ca293d0e2..000000000 --- a/.ci/vale/styles/config/vocabularies/Cloud-Serverless/accept.txt +++ /dev/null @@ -1,2 +0,0 @@ -cloud-serverless -Cloud Serverless \ No newline at end of file diff --git a/.ci/vale/styles/config/vocabularies/Cloud-Serverless/reject.txt b/.ci/vale/styles/config/vocabularies/Cloud-Serverless/reject.txt deleted file mode 100644 index e90ca8162..000000000 --- a/.ci/vale/styles/config/vocabularies/Cloud-Serverless/reject.txt +++ /dev/null @@ -1,7 +0,0 @@ -Cloud Dedicated -cloud-dedicated -Clustered -clustered -database name -database token -management token \ No newline at end of file diff --git a/.ci/vale/styles/config/vocabularies/Clustered/accept.txt b/.ci/vale/styles/config/vocabularies/Clustered/accept.txt deleted file mode 100644 index 0a3224ec9..000000000 --- a/.ci/vale/styles/config/vocabularies/Clustered/accept.txt +++ /dev/null @@ -1 +0,0 @@ -clustered diff --git a/.ci/vale/styles/config/vocabularies/Clustered/reject.txt b/.ci/vale/styles/config/vocabularies/Clustered/reject.txt deleted file mode 100644 index 5bbfb6575..000000000 --- a/.ci/vale/styles/config/vocabularies/Clustered/reject.txt +++ /dev/null @@ -1,6 +0,0 @@ -API token -bucket name -Cloud Dedicated -cloud-dedicated -Cloud Serverless -cloud-serverless diff --git a/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt new file mode 100644 index 000000000..2d7ef17b4 --- /dev/null +++ b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt @@ -0,0 +1,77 @@ +(?i)AS \w+ +(InfluxQL|influxql) +(tsm|TSM) +(xpath|XPath) +APIs? +Anaconda +Apache Superset +Arrow +AuthToken +CLI +CSV +Data Explorer +Dedup +Execd +ExecutionPlan +Flight SQL +FlightQuery +GBs? +Grafana +HostURL +InfluxDB Cloud +InfluxDB OSS +InfluxDB-specific +Influxer +JavaScript +KBs? +LogicalPlan +MBs? +PBs? +Parquet +Redoc +SQLAlchemy +SQLAlchemy +Splunk +[Ss]uperset +TBs? +UI +URLs +US (East|West|Central|North|South|Northeast|Northwest|Southeast|Southwest) +Unix +WALs? +Webpack +[pP]y.*\b +\b\w+_\w+\b +\b_\w+\b +batchBucket +batchInterval +commentPrefix +destinationBucket +destinationHost +destinationOrg +destinationToken +docs-v2 +fieldKey +fieldType +groupId +hostURL +hostUrl +influx3 +influxctl +influxd +influxdata.com +iox +lat +locf +logicalplan +noaa|NOAA +npm|NPM +oauth|OAuth +pandas +quoteChar +retentionRules +sourceBucket +tagKey +v2 +v3 +venv diff --git a/.ci/vale/styles/config/vocabularies/InfluxDataDocs/reject.txt b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/reject.txt new file mode 100644 index 000000000..e69de29bb diff --git a/.ci/vale/vale.sh b/.ci/vale/vale.sh old mode 100644 new mode 100755 index 2bf5b71c1..cc3ff3799 --- a/.ci/vale/vale.sh +++ b/.ci/vale/vale.sh @@ -1,16 +1,20 @@ -# Lint cloud-dedicated -docspath=. -contentpath=$docspath/content +#!/bin/bash -# Vale searches for a configuration file (.vale.ini) in the directory of the file being linted, and then in each of its parent directories. -# Lint cloud-dedicated -npx vale --output=line --relative --minAlertLevel=error $contentpath/influxdb/cloud-dedicated +# Run Vale to lint files for writing style and consistency -# Lint cloud-serverless -npx vale --config=$contentpath/influxdb/cloud-serverless/.vale.ini --output=line --relative --minAlertLevel=error $contentpath/influxdb/cloud-serverless +# Example usage: -# Lint clustered -npx vale --config=$contentpath/influxdb/clustered/.vale.ini --output=line --relative --minAlertLevel=error $contentpath/influxdb/clustered +# Lint all added and modified files in the cloud-dedicated directory and report suggestions, warnings, and errors. -# Lint telegraf -# npx vale --config=$docspath/.vale.ini --output=line --relative --minAlertLevel=error $contentpath/telegraf +# git diff --name-only --diff-filter=d HEAD | grep "content/influxdb/cloud-dedicated" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=content/influxdb/cloud-dedicated/.vale.ini + +# Lint files provided as arguments +docker run \ + --rm \ + --label tag=influxdata-docs \ + --label stage=lint \ + --mount type=bind,src=$(pwd),dst=/workdir \ + -w /workdir \ + --entrypoint /bin/vale \ + jdkato/vale:latest \ + "$@" \ No newline at end of file diff --git a/.lintstagedrc.mjs b/.lintstagedrc.mjs index 1cd58f178..272981b9c 100644 --- a/.lintstagedrc.mjs +++ b/.lintstagedrc.mjs @@ -27,7 +27,7 @@ function testStagedContent(paths, productPath) { // This script first checks if there are any tests to run using `pytest --collect-only`. // If there are tests, it runs them; otherwise, it exits with a success code. // Whether tests pass or fail, the container is removed, - // but the CONTENT container will remain until the next run. + // but the CONTENT container and associated volume will remain until the next run. `sh -c "docker run --rm --name ${TEST}-collector \ --env-file ${productPath}/.env.test \ --volumes-from ${CONTENT} \ @@ -46,23 +46,55 @@ function testStagedContent(paths, productPath) { ]; } +// Export a lint-staged configuration object. +// Run tests and linters on staged files. export default { - "*.{js,css}": paths => `prettier --write ${paths.join(' ')}`, + "*.{js,css}": paths => `prettier --write ${paths.join(' ')}`, - // Don't let prettier check or write Markdown files for now; - // it indents code blocks within list items, which breaks Hugo's rendering. - // "*.md": paths => `prettier --check ${paths.join(' ')}`, + "*.md": paths => `.ci/vale/vale.sh --config .vale.ini ${paths} --min|| true`, - "content/influxdb/cloud-dedicated/**/*.md": - paths => [...testStagedContent(paths, 'content/influxdb/cloud-dedicated')], - "content/influxdb/cloud-serverless/**/*.md": - paths => [...testStagedContent(paths, 'content/influxdb/cloud-serverless')], - "content/influxdb/clustered/**/*.md": - paths => [...testStagedContent(paths, 'content/influxdb/clustered')], - - // "content/influxdb/cloud-serverless/**/*.md": "docker compose run -T lint --config=content/influxdb/cloud-serverless/.vale.ini --minAlertLevel=error", + "content/influxdb/api-docs/": paths => + `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, - // "content/influxdb/clustered/**/*.md": "docker compose run -T lint --config=content/influxdb/clustered/.vale.ini --minAlertLevel=error", + "content/influxdb/cloud/**/*.md": + paths => [ + `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, + ...testStagedContent(paths, 'content/influxdb/cloud'), + ], - // "content/influxdb/{cloud,v2,telegraf}/**/*.md": "docker compose run -T lint --config=.vale.ini --minAlertLevel=error" + "content/influxdb/cloud-dedicated/**/*.md": + paths => [ + `.ci/vale/vale.sh --config content/influxdb/cloud-dedicated/.vale.ini --minAlertLevel error ${paths}`, + ...testStagedContent(paths, 'content/influxdb/cloud-dedicated'), + ], + + "content/influxdb/cloud-serverless/**/*.md": + paths => [ + `.ci/vale/vale.sh --config content/influxdb/cloud-serverless/.vale.ini --minAlertLevel error ${paths}`, + ...testStagedContent(paths, 'content/influxdb/cloud-serverless'), + ], + + "content/influxdb/clustered/**/*.md": + paths => [ + `.ci/vale/vale.sh --config content/influxdb/clustered/.vale.ini --minAlertLevel error ${paths}`, + ...testStagedContent(paths, 'content/influxdb/clustered'), + ], + + "content/influxdb/v1/**/*.md": + paths => [ + `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, + ...testStagedContent(paths, 'content/influxdb/v1'), + ], + + "content/influxdb/v2/**/*.md": + paths => [ + `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, + ...testStagedContent(paths, 'content/influxdb/v2'), + ], + + "content/telegraf/**/*.md": + paths => [ + `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, + ...testStagedContent(paths, 'content/telegraf'), + ], } diff --git a/.vale.ini b/.vale.ini index e6a2552f2..88c1fcd2f 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,12 +1,15 @@ -StylesPath = ".ci/vale/styles" +StylesPath = .ci/vale/styles MinAlertLevel = warning -Packages = Google, Hugo, write-good +Vocab = InfluxDataDocs + +Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Google, write-good Google.Ellipses = NO Google.Headings = NO -Google.WordList = NO \ No newline at end of file +Google.WordList = NO +Vale.Spelling = NO \ No newline at end of file diff --git a/compose.yaml b/compose.yaml index d0edb5c4d..c61cd8910 100644 --- a/compose.yaml +++ b/compose.yaml @@ -1,39 +1,7 @@ # This is a Docker Compose file for the InfluxData documentation site. ## Run documentation tests for code samples. name: influxdata-docs -volumes: - test-content: services: - markdownlint: - image: davidanson/markdownlint-cli2:v0.13.0 - container_name: markdownlint - profiles: - - ci - - lint - volumes: - - type: bind - source: . - target: /workdir - working_dir: /workdir - build: - context: . - vale: - image: jdkato/vale:latest - container_name: vale - profiles: - - ci - - lint - volumes: - - type: bind - source: . - target: /workdir - working_dir: /workdir - entrypoint: ["/bin/vale"] - build: - context: . - dockerfile_inline: | - COPY .ci /src/.ci - COPY **/.vale.ini /src/ ## Run InfluxData documentation with the hugo development server on port 1313. ## For more information about the hugomods/hugo image, see ## https://docker.hugomods.com/docs/development/docker-compose/ diff --git a/content/influxdb/cloud-dedicated/.vale.ini b/content/influxdb/cloud-dedicated/.vale.ini index 9a9120b7e..6d35f96b0 100644 --- a/content/influxdb/cloud-dedicated/.vale.ini +++ b/content/influxdb/cloud-dedicated/.vale.ini @@ -1,14 +1,15 @@ StylesPath = "../../../.ci/vale/styles" -Vocab = Cloud-Dedicated +Vocab = InfluxDataDocs MinAlertLevel = warning -Packages = Google, Hugo, write-good +Packages = Google, write-good, Hugo [*.md] -BasedOnStyles = Vale, InfluxDataDocs, Google, write-good +BasedOnStyles = Vale, InfluxDataDocs, Cloud-Dedicated, Google, write-good Google.Ellipses = NO Google.Headings = NO -Google.WordList = NO \ No newline at end of file +Google.WordList = NO +Vale.Spelling = NO \ No newline at end of file diff --git a/content/influxdb/cloud-dedicated/get-started/_index.md b/content/influxdb/cloud-dedicated/get-started/_index.md index e0ab6569c..621a0952b 100644 --- a/content/influxdb/cloud-dedicated/get-started/_index.md +++ b/content/influxdb/cloud-dedicated/get-started/_index.md @@ -174,9 +174,7 @@ can write data to {{% product-name %}}. ## Authorization **{{% product-name %}} requires authentication** using -[tokens](/influxdb/cloud-dedicated/admin/tokens/). - -There are two types of tokens: +one of the following [token](/influxdb/cloud-dedicated/admin/tokens/) types: - **Database token**: A token that grants read and write access to InfluxDB databases. diff --git a/content/influxdb/cloud-serverless/.vale.ini b/content/influxdb/cloud-serverless/.vale.ini index a8c080a2f..191227f55 100644 --- a/content/influxdb/cloud-serverless/.vale.ini +++ b/content/influxdb/cloud-serverless/.vale.ini @@ -1,14 +1,15 @@ StylesPath = "../../../.ci/vale/styles" -Vocab = Cloud-Serverless +Vocab = InfluxDataDocs MinAlertLevel = warning -Packages = Google, Hugo, write-good +Packages = Google, write-good, Hugo [*.md] -BasedOnStyles = Vale, InfluxDataDocs, Google, write-good +BasedOnStyles = Vale, InfluxDataDocs, Cloud-Serverless, Google, write-good Google.Ellipses = NO Google.Headings = NO -Google.WordList = NO \ No newline at end of file +Google.WordList = NO +Vale.Spelling = NO \ No newline at end of file diff --git a/content/influxdb/clustered/.vale.ini b/content/influxdb/clustered/.vale.ini index ba6c62497..2095bfd0c 100644 --- a/content/influxdb/clustered/.vale.ini +++ b/content/influxdb/clustered/.vale.ini @@ -1,14 +1,15 @@ StylesPath = "../../../.ci/vale/styles" -Vocab = Clustered +Vocab = InfluxDataDocs MinAlertLevel = warning -Packages = Google, Hugo, write-good +Packages = Google, write-good, Hugo [*.md] -BasedOnStyles = Vale, InfluxDataDocs, Google, write-good +BasedOnStyles = Vale, InfluxDataDocs, Clustered, Google, write-good Google.Ellipses = NO Google.Headings = NO -Google.WordList = NO \ No newline at end of file +Google.WordList = NO +Vale.Spelling = NO \ No newline at end of file diff --git a/content/influxdb/clustered/get-started/_index.md b/content/influxdb/clustered/get-started/_index.md index f9e04d982..bff1438f9 100644 --- a/content/influxdb/clustered/get-started/_index.md +++ b/content/influxdb/clustered/get-started/_index.md @@ -161,9 +161,7 @@ They use the HTTP API to write data and use InfluxDB's Flight gRPC API to query ## Authorization **{{% product-name %}} requires authentication** using -[tokens](/influxdb/clustered/admin/tokens/). - -There are two types of tokens: +one of the following [token](/influxdb/clustered/admin/tokens/) types: - **Database token**: A token that grants read and write access to InfluxDB databases. diff --git a/package.json b/package.json index 60fe94e2c..5e2c28c16 100644 --- a/package.json +++ b/package.json @@ -20,9 +20,15 @@ "js-yaml": "^4.1.0" }, "scripts": { + "lint-cloud": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/cloud\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=.vale.ini", + "lint-clustered": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/clustered\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=content/influxdb/clustered/.vale.ini", + "lint-dedicated": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/cloud-dedicated\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=content/influxdb/cloud-dedicated/.vale.ini", + "lint-serverless": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/cloud-serverless\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=content/influxdb/cloud-serverless/.vale.ini", + "lint-telegraf": "git diff --name-only --diff-filter=d HEAD | grep \"content/telegraf\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=.vale.ini", + "lint-v1": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/v1\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=.vale.ini", + "lint-v2": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/v2\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=.vale.ini", "prepare": "husky", - "lint-vale": ".ci/vale/vale.sh", - "lint-staged": "lint-staged --relative" + "test": "lint-staged --relative" }, "main": "index.js", "module": "main.js", From ea9b786b83c05dde5da33a5422e7cad70b28a995 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 26 Jun 2024 10:26:52 -0500 Subject: [PATCH 02/96] fix(ci): test content: - Add python replacement for get-started database/bucket name - Fixes race condition when deleting previous content: - Assign each product it's own test content volume instead of sharing a volume. - Delete existing content in the volume before copying test files. - Pros and cons, but I suspect a similar approach will be better when ported to Circle CI. --- .lintstagedrc.mjs | 19 +++++++++++++++++-- .../cloud-dedicated/get-started/query.md | 2 +- .../cloud-serverless/get-started/query.md | 2 +- .../influxdb/clustered/get-started/query.md | 2 +- test/src/prepare-content.sh | 3 +-- 5 files changed, 21 insertions(+), 7 deletions(-) diff --git a/.lintstagedrc.mjs b/.lintstagedrc.mjs index 272981b9c..d07d962d6 100644 --- a/.lintstagedrc.mjs +++ b/.lintstagedrc.mjs @@ -6,14 +6,26 @@ function testStagedContent(paths, productPath) { const TEST = `pytest-${productName}`; return [ - // Remove any existing test container and volume + // Remove existing containers `sh -c "docker rm -f ${CONTENT} || true"`, `sh -c "docker rm -f ${TEST} || true"`, `docker build . -f Dockerfile.tests -t influxdata-docs/tests:latest`, + // Remove any existing Docker volume for staged content + `sh -c "docker volume rm -f ${CONTENT} || true"`, + + // Create a Docker volume for product staged content + `sh -c "docker volume create \ + --label tag=influxdata-docs \ + --label stage=test \ + --name ${CONTENT} || true"`, + // Copy staged content to a volume and run the prepare script + // to remove the existing `docker run --name ${CONTENT} + --label tag=influxdata-docs + --label stage=test --mount type=volume,source=staged-content,target=/app/content --mount type=bind,src=./content,dst=/src/content --mount type=bind,src=./static/downloads,dst=/app/data @@ -38,7 +50,10 @@ function testStagedContent(paths, productPath) { echo 'No tests to run.'; \ exit 0; \ else \ - docker run --rm --name ${TEST} \ + docker run --rm \ + --label tag=influxdata-docs \ + --label stage=test \ + --name ${TEST} \ --env-file ${productPath}/.env.test \ --volumes-from ${CONTENT} \ influxdata-docs/pytest --codeblocks --exitfirst ${productPath}/; diff --git a/content/influxdb/cloud-dedicated/get-started/query.md b/content/influxdb/cloud-dedicated/get-started/query.md index b1f8dde0b..522dced59 100644 --- a/content/influxdb/cloud-dedicated/get-started/query.md +++ b/content/influxdb/cloud-dedicated/get-started/query.md @@ -1014,7 +1014,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl - The `App`, `Write`, and `Query` classes belong to the `com.influxdbv3` package (your project **groupId**). - `App` defines a `main()` function that calls `Write.writeLineProtocol()` and `Query.querySQL()`. -4. In your terminal or editor, use Maven to to install dependencies and compile the project code--for example: +4. In your terminal or editor, use Maven to install dependencies and compile the project code--for example: diff --git a/content/influxdb/cloud-serverless/get-started/query.md b/content/influxdb/cloud-serverless/get-started/query.md index 97495746e..bbd5a56df 100644 --- a/content/influxdb/cloud-serverless/get-started/query.md +++ b/content/influxdb/cloud-serverless/get-started/query.md @@ -1008,7 +1008,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl - The `App`, `Write`, and `Query` classes belong to the `com.influxdbv3` package (your project **groupId**). - `App` defines a `main()` function that calls `Write.writeLineProtocol()` and `Query.querySQL()`. -4. In your terminal or editor, use Maven to to install dependencies and compile the project code--for example: +4. In your terminal or editor, use Maven to install dependencies and compile the project code--for example: diff --git a/content/influxdb/clustered/get-started/query.md b/content/influxdb/clustered/get-started/query.md index dc5210227..0f704a444 100644 --- a/content/influxdb/clustered/get-started/query.md +++ b/content/influxdb/clustered/get-started/query.md @@ -1010,7 +1010,7 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl - The `App`, `Write`, and `Query` classes belong to the `com.influxdbv3` package (your project **groupId**). - `App` defines a `main()` function that calls `Write.writeLineProtocol()` and `Query.querySQL()`. -4. In your terminal or editor, use Maven to to install dependencies and compile the project code--for example: +4. In your terminal or editor, use Maven to install dependencies and compile the project code--for example: diff --git a/test/src/prepare-content.sh b/test/src/prepare-content.sh index 42ba51e33..6620c5a16 100644 --- a/test/src/prepare-content.sh +++ b/test/src/prepare-content.sh @@ -24,6 +24,7 @@ function substitute_placeholders { s/f"API_TOKEN"/os.getenv("INFLUX_TOKEN")/g; s/f"BUCKET_NAME"/os.getenv("INFLUX_DATABASE")/g; s/f"DATABASE_NAME"/os.getenv("INFLUX_DATABASE")/g; + s/f"get-started"/os.getenv("INFLUX_DATABASE")/g; s|f"{{< influxdb/host >}}"|os.getenv("INFLUX_HOSTNAME")|g; s|f"RETENTION_POLICY_NAME\|RETENTION_POLICY"|"autogen"|g; ' $file @@ -76,8 +77,6 @@ setup() { prepare_tests() { TEST_FILES="$*" - # Remove files from the previous run. - rm -rf "$TEST_CONTENT"/* # Copy the test files to the target directory while preserving the directory structure. for FILE in $TEST_FILES; do # Create the parent directories of the destination file From 9c035fbd4d1ec9515db2cdc012afeb1399ad4597 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 1 Jul 2024 09:52:07 -0500 Subject: [PATCH 03/96] fix(ci): Simplify Vale terms list, support OAuth browser flow in tests - For influxctl OAuth flow, add support for writing auth URLs to a container-shared file monitored by the host during the pre-commit hook. - In prepare-content.sh, add Management API-associated placeholder substitutions. - Update CONTRIBUTING.md with env.test requirements. --- .husky/pre-commit | 2 + .lintstagedrc.mjs | 55 +++++---- CONTRIBUTING.md | 173 ++++++++++++++++++++++++++--- Dockerfile.pytest | 10 ++ Dockerfile.tests | 1 - test/.gitignore | 2 + test/README.md | 111 ------------------ test/env.test.example | 10 ++ test/src/conftest.py | 60 ++++++++++ test/src/monitor-container-urls.sh | 23 ++++ test/src/monitor-tests.sh | 13 +++ test/src/prepare-content.sh | 28 +++-- test/src/requirements.txt | 3 + 13 files changed, 324 insertions(+), 167 deletions(-) delete mode 100644 test/README.md create mode 100644 test/env.test.example create mode 100644 test/src/conftest.py create mode 100755 test/src/monitor-container-urls.sh create mode 100755 test/src/monitor-tests.sh diff --git a/.husky/pre-commit b/.husky/pre-commit index e3456b228..6e0acb87e 100644 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -1 +1,3 @@ +./test/src/monitor-tests.sh start npx lint-staged --relative +./test/src/monitor-tests.sh kill diff --git a/.lintstagedrc.mjs b/.lintstagedrc.mjs index d07d962d6..66a00a12f 100644 --- a/.lintstagedrc.mjs +++ b/.lintstagedrc.mjs @@ -1,6 +1,6 @@ // Lint-staged configuration. This file must export a lint-staged configuration object. -function testStagedContent(paths, productPath) { +function pytestStagedContent(paths, productPath) { const productName = productPath.replace(/\//g, '-'); const CONTENT = `staged-${productName}`; const TEST = `pytest-${productName}`; @@ -26,7 +26,7 @@ function testStagedContent(paths, productPath) { `docker run --name ${CONTENT} --label tag=influxdata-docs --label stage=test - --mount type=volume,source=staged-content,target=/app/content + --mount type=volume,source=${CONTENT},target=/app/content --mount type=bind,src=./content,dst=/src/content --mount type=bind,src=./static/downloads,dst=/app/data influxdata-docs/tests --files "${paths.join(' ')}"`, @@ -36,28 +36,23 @@ function testStagedContent(paths, productPath) { -t influxdata-docs/pytest:latest`, // Run test runners. - // This script first checks if there are any tests to run using `pytest --collect-only`. - // If there are tests, it runs them; otherwise, it exits with a success code. + // Uses a pytest plugin to suppress exit code 5 (if no tests are found), + // This avoids needing to "pre-run" test collection in a subshell to check the exit code. + // Instead of the plugin, we could use a placeholder test that always or conditionally passes. // Whether tests pass or fail, the container is removed, // but the CONTENT container and associated volume will remain until the next run. - `sh -c "docker run --rm --name ${TEST}-collector \ + // Note: the "--network host" setting and `host-open` script are used to + // forward influxctl authentication URLs from the container to the host + // where they can be opened and approved in a host browser. + // Allowing "--network host" has security implications and isn't ideal. + `docker run --rm -t \ + --label tag=influxdata-docs \ + --label stage=test \ + --name ${TEST} \ --env-file ${productPath}/.env.test \ --volumes-from ${CONTENT} \ - influxdata-docs/pytest --codeblocks --collect-only \ - ${productPath}/ > /dev/null 2>&1; \ - TEST_COLLECT_EXIT_CODE=$?; \ - if [ $TEST_COLLECT_EXIT_CODE -eq 5 ]; then \ - echo 'No tests to run.'; \ - exit 0; \ - else \ - docker run --rm \ - --label tag=influxdata-docs \ - --label stage=test \ - --name ${TEST} \ - --env-file ${productPath}/.env.test \ - --volumes-from ${CONTENT} \ - influxdata-docs/pytest --codeblocks --exitfirst ${productPath}/; - fi"` + --mount type=bind,src=./test/shared,dst=/shared \ + influxdata-docs/pytest --codeblocks --suppress-no-test-exit-code --exitfirst ${productPath}/`, ]; } @@ -74,42 +69,42 @@ export default { "content/influxdb/cloud/**/*.md": paths => [ `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, - ...testStagedContent(paths, 'content/influxdb/cloud'), + ...pytestStagedContent(paths, 'content/influxdb/cloud'), ], - "content/influxdb/cloud-dedicated/**/*.md": + "content/influxdb/cloud-dedicated/**/*.md": paths => [ - `.ci/vale/vale.sh --config content/influxdb/cloud-dedicated/.vale.ini --minAlertLevel error ${paths}`, - ...testStagedContent(paths, 'content/influxdb/cloud-dedicated'), - ], + `.ci/vale/vale.sh --config content/influxdb/cloud-dedicated/.vale.ini --minAlertLevel error ${paths}`, + ...pytestStagedContent(paths, 'content/influxdb/cloud-dedicated'), + ], "content/influxdb/cloud-serverless/**/*.md": paths => [ `.ci/vale/vale.sh --config content/influxdb/cloud-serverless/.vale.ini --minAlertLevel error ${paths}`, - ...testStagedContent(paths, 'content/influxdb/cloud-serverless'), + ...pytestStagedContent(paths, 'content/influxdb/cloud-serverless'), ], "content/influxdb/clustered/**/*.md": paths => [ `.ci/vale/vale.sh --config content/influxdb/clustered/.vale.ini --minAlertLevel error ${paths}`, - ...testStagedContent(paths, 'content/influxdb/clustered'), + ...pytestStagedContent(paths, 'content/influxdb/clustered'), ], "content/influxdb/v1/**/*.md": paths => [ `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, - ...testStagedContent(paths, 'content/influxdb/v1'), + ...pytestStagedContent(paths, 'content/influxdb/v1'), ], "content/influxdb/v2/**/*.md": paths => [ `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, - ...testStagedContent(paths, 'content/influxdb/v2'), + ...pytestStagedContent(paths, 'content/influxdb/v2'), ], "content/telegraf/**/*.md": paths => [ `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, - ...testStagedContent(paths, 'content/telegraf'), + ...pytestStagedContent(paths, 'content/telegraf'), ], } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7aecc6bb7..6b93ebb0a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,40 +85,179 @@ git commit -m "" --no-verify For more options, see the [Husky documentation](https://typicode.github.io/husky/how-to.html#skipping-git-hooks). -### Configure test credentials +### Set up test scripts and credentials -To configure credentials for tests, set the usual InfluxDB environment variables -for each product inside a `content/influxdb//.env.test` file. +To set up your docs-v2 instance to run tests locally, do the following: -The Docker commands in the `.lintstagedrc.mjs` lint-staged configuration load -the `.env.test` as product-specific environment variables. +1. **Set executable permissions on test scripts** in `./test/src`: -**Warning**: To prevent accidentally adding credentials to the docs-v2 repo, + ```sh + chmod +x ./test/src/*.sh + ``` + +2. **Create credentials for tests**: + + - Create databases, buckets, and tokens for the product(s) you're testing. + - If you don't have access to a Clustered instance, you can use your +Cloud Dedicated instance for testing in most cases. To avoid conflicts when + running tests, create separate Cloud Dedicated and Clustered databases. + +3. **Create .env.test**: Copy the `./test/env.test.example` file into each + product directory to test and rename the file as `.env.test`--for example: + + ```sh + ./content/influxdb/cloud-dedicated/.env.test + ``` + +4. Inside each product's `.env.test` file, assign your InfluxDB credentials to + environment variables. + + In addition to the usual `INFLUX_` environment variables, in your + `cloud-dedicated/.env.test` and `clustered/.env.test` files define the + following variables: + + - `ACCOUNT_ID`, `CLUSTER_ID`: You can find these values in your `influxctl` + `config.toml` configuration file. + - `MANAGEMENT_TOKEN`: Use the `influxctl management create` command to generate + a long-lived management token to authenticate Management API requests + + For the full list of variables you'll need to include, see the substitution + patterns in `./test/src/prepare-content.sh`. + + **Warning**: The database you configure in `.env.test` and any written data may +be deleted during test runs. + + **Warning**: To prevent accidentally adding credentials to the docs-v2 repo, Git is configured to ignore `.env*` files. Don't add your `.env.test` files to Git. Consider backing them up on your local machine in case of accidental deletion. +5. For influxctl commands to run in tests, move or copy your `config.toml` file + to the `./test` directory. + ### Pre-commit linting and testing When you try to commit your changes using `git commit` or your editor, the project automatically runs pre-commit checks for spelling, punctuation, and style on your staged files. -The pre-commit hook calls [`lint-staged`](https://github.com/lint-staged/lint-staged) using the configuration in `.lintstagedrc.mjs`. +`.husky/pre-commit` script runs Git pre-commit hook commands, including +[`lint-staged`](https://github.com/lint-staged/lint-staged). -To run `lint-staged` scripts manually (without committing), enter the following -command in your terminal: +The `.lintstagedrc.mjs` lint-staged configuration maps product-specific glob +patterns to lint and test commands and passes a product-specific +`.env.test` file to a test runner Docker container. +The container then loads the `.env` file into the container's environment variables. -```sh -npx lint-staged --relative --verbose -``` +To test or troubleshoot testing and linting scripts and configurations before +committing, choose from the following: + +- To run pre-commit scripts without actually committing, append `exit 1` to the +`.husky/pre-commit` script--for example: + + ```sh + ./test/src/monitor-tests.sh start + npx lint-staged --relative + ./test/src/monitor-tests.sh kill + exit 1 + ``` + + And then run `git commit`. + + The `exit 1` status fails the commit, even if all the tasks succeed. + +- Use `yarn` to run one of the lint or test scripts configured in + `package.json`--for example: + + ```sh + yarn run test + ``` + +- Run `lint-staged` directly and specify options: + + ```sh + npx lint-staged --relative --verbose + ``` The pre-commit linting configuration checks for _error-level_ problems. -An error-level rule violation fails the commit and you must -fix the problems before you can commit your changes. +An error-level rule violation fails the commit and you must do one of the following before you can commit your changes: -If an error doesn't warrant a fix (for example, a term that should be allowed), -you can override the check and try the commit again or you can edit the linter -style rules to permanently allow the content. See **Configure style rules**. +- fix the reported problem in the content + +- edit the linter rules to permanently allow the content. + See **Configure style rules**. + +- temporarily override the hook (using `git commit --no-verify`) + +#### Test shell and python code blocks + +[pytest-codeblocks](https://github.com/nschloe/pytest-codeblocks/tree/main) extracts code from python and shell Markdown code blocks and executes assertions for the code. +If you don't assert a value (using a Python `assert` statement), `--codeblocks` considers a non-zero exit code to be a failure. + +**Note**: `pytest --codeblocks` uses Python's `subprocess.run()` to execute shell code. + +You can use this to test CLI and interpreter commands, regardless of programming +language, as long as they return standard exit codes. + +To make the documented output of a code block testable, precede it with the +`` tag and **omit the code block language +descriptor**--for example, in your Markdown file: + +##### Example markdown + +```python +print("Hello, world!") +``` + + + +The next code block is treated as an assertion. +If successful, the output is the following: + +``` +Hello, world! +``` + +For commands, such as `influxctl` CLI commands, that require launching an +OAuth URL in a browser, wrap the command in a subshell and redirect the output +to `/shared/urls.txt` in the container--for example: + +```sh +# Test the preceding command outside of the code block. +# influxctl authentication requires TTY interaction-- +# output the auth URL to a file that the host can open. +script -c "influxctl user list " \ + /dev/null > /shared/urls.txt +``` + +You probably don't want to display this syntax in the docs, which unfortunately +means you'd need to include the test block separately from the displayed code +block. +To hide it from users, wrap the code block inside an HTML comment. +Pytest-codeblocks will still collect and run the code block. + +##### Mark tests to skip + +pytest-codeblocks has features for skipping tests and marking blocks as failed. +To learn more, see the pytest-codeblocks README and tests. + +#### Troubleshoot tests + +### Pytest collected 0 items + +Potential reasons: + +- See the test discovery options in `pytest.ini`. +- For Python code blocks, use the following delimiter: + + ```python + # Codeblocks runs this block. + ``` + + `pytest --codeblocks` ignores code blocks that use the following: + + ```py + # Codeblocks ignores this block. + ``` ### Vale style linting diff --git a/Dockerfile.pytest b/Dockerfile.pytest index 1eeb122c1..f7bb443c9 100644 --- a/Dockerfile.pytest +++ b/Dockerfile.pytest @@ -26,10 +26,20 @@ ENV PYTHONUNBUFFERED=1 WORKDIR /app +# Create a mock xdg-open script` to prevent the test suite from attempting to open a browser (for example, during influxctl OAuth2 authentication), and instead execute the host-open script. +RUN echo '#!/bin/bash' > /usr/local/bin/xdg-open \ + && echo 'echo "$1" > /shared/urls.txt' >> /usr/local/bin/xdg-open \ + && echo 'echo "$1" >> /shared/host_open.log' >> /usr/local/bin/xdg-open \ + && chmod +x /usr/local/bin/xdg-open + # 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. COPY ./test/src/pytest.ini pytest.ini +# Python and Pytest dependencies. COPY ./test/src/requirements.txt requirements.txt +# Pytest fixtures. +COPY ./test/src/conftest.py conftest.py RUN pip install -Ur requirements.txt # Activate the Python virtual environment configured in the Dockerfile. diff --git a/Dockerfile.tests b/Dockerfile.tests index b1bc12e4f..852ce2e04 100644 --- a/Dockerfile.tests +++ b/Dockerfile.tests @@ -1,7 +1,6 @@ # Use the Dockerfile 1.2 syntax to leverage BuildKit features like cache mounts and inline mounts--temporary mounts that are only available during the build step, not at runtime. # syntax=docker/dockerfile:1.2 -# Starting from a Go base image is easier than setting up the Go environment later. FROM python:3.9-slim # Install the necessary packages for the test environment. diff --git a/test/.gitignore b/test/.gitignore index a8aabc891..21065a63c 100644 --- a/test/.gitignore +++ b/test/.gitignore @@ -2,7 +2,9 @@ /Cargo.lock config.toml content +monitor_urls_pid node_modules +shared tmp .config* .env* diff --git a/test/README.md b/test/README.md deleted file mode 100644 index 57582adda..000000000 --- a/test/README.md +++ /dev/null @@ -1,111 +0,0 @@ -Test code blocks in Markdown files. - -This project contains the following: - -- `test.sh`: The primary entrypoint for running tests. - Copies Markdown files to a temporary directory shared with the `test` Docker image and runs the test container. -- `test/run-tests.sh`: The Docker image entrypoint. - Substitutes placeholders with environment variables in code blocks. - Passes test files to test runners (for example, `pytest --codeblocks` for Python and shell code samples). -- `compose.yaml` and `Dockerfile`: Docker image for the **test** service that installs test dependencies and passes test files to test runners. - -## Set configuration values - -To set your InfluxDB credentials for testing, create a `.env.` file and add key=value properties--for example, in `.env.serverless` - -```text -INFLUX_HOST=https://us-east-1-1.aws.cloud2.influxdata.com -INFLUX_HOSTNAME=us-east-1-1.aws.cloud2.influxdata.com -INFLUX_TOKEN=5Vz... -INFLUX_ORG=28d... -INFLUX_DATABASE=jason-test-create-bucket -INFLUX_RETENTION_POLICY=test-autogen -``` - -Storing configuration properties in a `.env` (dotenv) file is generally preferable to using environment variables. - -## Build the image - -1. Install Docker for your system. - -2. Build the Docker image. - - ```shell - docker compose build test - ``` - - After editing configuration or files used by the image, re-run the preceding build command. - -## Run tests - -Test code blocks in Markdown files that have changed relative to your git `master` branch: - -```sh -sh test.sh -``` - -Test code blocks in files that match a pattern: - -```sh -sh test.sh ./content/**/*.md -``` - -`test.sh` copies files into `./test/tmp/` for testing and runs the tests in Docker. - -### Test runners - -_Experimental--work in progress_ - -[pytest-codeblocks](https://github.com/nschloe/pytest-codeblocks/tree/main) extracts code from python and shell Markdown code blocks and executes assertions for the code. -If you don't assert a value, `--codeblocks` considers a non-zero exit code to be a failure. -_Note_: `pytest --codeblocks` uses Python's `subprocess.run()` to execute shell code. - -To assert (and display) the expected output of your code, follow the code block with the `` comment tag, and then the expected output in a code block--for example: - - - -```python -print("Hello, world!") -``` - - - -If successful, the output is the following: - -``` -Hello, world! -``` - - - -pytest-codeblocks has features for skipping tests and marking blocks as failed. -To learn more, see the pytest-codeblocks README and tests. - -#### Other tools and ideas for testing code blocks - -The `codedown` NPM package extracts code from Markdown code blocks for each language and -can pipe the output to a test runner for the language. - -`pytest` and `pytest-codeblocks` use the Python `Assertions` module to keep testing overhead low. -Node.js also provides an `Assertions` package. - -The `runmd` NPM package runs `javascript` code blocks in Markdown and generates a new Markdown file with the code block output inserted. - -## Troubleshoot - -### Pytest collected 0 items - -Potential reasons: - -- See the test discovery options in `pytest.ini`. -- For Python code blocks, use the following delimiter: - - ```python - # Codeblocks runs this block. - ``` - - `pytest --codeblocks` ignores code blocks that use the following: - - ```py - # Codeblocks ignores this block. - ``` \ No newline at end of file diff --git a/test/env.test.example b/test/env.test.example new file mode 100644 index 000000000..7faf61dd3 --- /dev/null +++ b/test/env.test.example @@ -0,0 +1,10 @@ +ACCOUNT_ID= +CLUSTER_ID= +INFLUX_ORG= +INFLUX_TOKEN= +INFLUX_HOST=https:// +INFLUX_HOSTNAME= +INFLUX_DATABASE=myname-test-dedicated +INFLUX_USER_NAME= +INFLUX_RETENTION_POLICY=test-autogen +MANAGEMENT_TOKEN= \ No newline at end of file diff --git a/test/src/conftest.py b/test/src/conftest.py new file mode 100644 index 000000000..193237ae9 --- /dev/null +++ b/test/src/conftest.py @@ -0,0 +1,60 @@ +# Test setup fixtures + +import pytest +import requests +import os + +def v3_management_api(): + return { + 'url': os.getenv('INFLUX_HOST') + '/api/v0/accounts/' + os.getenv('ACCOUNT_ID') + '/clusters/' + os.getenv('CLUSTER_ID'), + 'headers': { + 'Content-Type': 'application/json', + 'Accept': 'application/json', + 'Authorization': 'Bearer ' + os.getenv('MANAGEMENT_TOKEN') + } + } + + +@pytest.fixture +def create_v3_token(): + api = v3_management_api() + url = api['url'] + '/databases/' + os.getenv('INFLUX_DATABASE') + headers = api['headers'] + data = { + "description": "v3 read token", + "permissions": [ + { + "action": "read", + "resource": os.getenv('INFLUX_DATABASE') + }, + { + "action": "write", + "resource": os.getenv('INFLUX_DATABASE') + }, + ] + } + response = requests.post(url, data=data, headers=headers) + return response.json()['token'] + +# Example test function using the setup_v3_db fixture: +# def test_setup(setup_v3_db): + # database, token = setup_v3_db + # assert database + # assert token +@pytest.fixture +def set_token(): + try: + token = create_v3_token() + os.environ.update({'INFLUX_TOKEN': token}) + yield token + except Exception as e: + print(e) + assert False + +@pytest.fixture +def delete_v3_database(): + api = v3_management_api() + url = api['url'] + '/databases/' + os.getenv('INFLUX_TEMP_DATABASE') + headers = api['headers'] + response = requests.delete(url, headers=headers) + return response.json()['name'] \ No newline at end of file diff --git a/test/src/monitor-container-urls.sh b/test/src/monitor-container-urls.sh new file mode 100755 index 000000000..d9113d1c1 --- /dev/null +++ b/test/src/monitor-container-urls.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +## This script is meant to be run on the host and monitors a file for URLs written by a container. + +# The file to monitor for URLs written by the container. +FILE="./test/shared/urls.txt" +# Define the URL pattern for OAuth2 authorization. +OAUTH_PATTERN='https://auth\.influxdata\.com/activate\?user_code=[A-Z]{1,8}-[A-Z]{1,8}' + +# Loop indefinitely +while true; do + if [ -f "$FILE" ]; then + # Extract an OAuth2 authorization URL from the file + URL=$(grep -Eo "$OAUTH_PATTERN" "$FILE") + if [ "$URL" ]; then + # Open the URL in the default browser + open "$URL" + # Clear the file to indicate the URL has been handled + > "$FILE" + fi + fi + sleep 1 +done diff --git a/test/src/monitor-tests.sh b/test/src/monitor-tests.sh new file mode 100755 index 000000000..f3aa56c5c --- /dev/null +++ b/test/src/monitor-tests.sh @@ -0,0 +1,13 @@ +function start { + ./test/src/monitor-container-urls.sh & echo $! > ./test/monitor_urls_pid +} + +function kill_process { + PID=$(cat ./test/monitor_urls_pid) && kill -9 $PID && rm ./test/monitor_urls_pid +} + +case "$1" in + start) start ;; + kill) kill_process ;; + *) echo "Usage: $0 {start|kill}" ;; +esac \ No newline at end of file diff --git a/test/src/prepare-content.sh b/test/src/prepare-content.sh index 6620c5a16..6490ae585 100644 --- a/test/src/prepare-content.sh +++ b/test/src/prepare-content.sh @@ -20,12 +20,15 @@ function substitute_placeholders { # Use f-strings to identify placeholders in Python while also keeping valid syntax if # the user replaces the value. # Remember to import os for your example code. - sed -i 's/f"DATABASE_TOKEN"/os.getenv("INFLUX_TOKEN")/g; + sed -i 's/f"ACCOUNT_ID"/os.getenv("ACCOUNT_ID")/g; s/f"API_TOKEN"/os.getenv("INFLUX_TOKEN")/g; s/f"BUCKET_NAME"/os.getenv("INFLUX_DATABASE")/g; + s/f"CLUSTER_ID"/os.getenv("CLUSTER_ID")/g; s/f"DATABASE_NAME"/os.getenv("INFLUX_DATABASE")/g; + s/f"DATABASE_TOKEN"/os.getenv("INFLUX_TOKEN")/g; s/f"get-started"/os.getenv("INFLUX_DATABASE")/g; s|f"{{< influxdb/host >}}"|os.getenv("INFLUX_HOSTNAME")|g; + s/f"MANAGEMENT_TOKEN"/os.getenv("MANAGEMENT_TOKEN")/g; s|f"RETENTION_POLICY_NAME\|RETENTION_POLICY"|"autogen"|g; ' $file @@ -35,15 +38,24 @@ function substitute_placeholders { s|"name": "BUCKET_NAME"|"name": "$INFLUX_DATABASE"|g;' \ $file - sed -i 's/API_TOKEN/$INFLUX_TOKEN/g; - s/ORG_ID/$INFLUX_ORG/g; - s/DATABASE_TOKEN/$INFLUX_TOKEN/g; - s/--bucket-id BUCKET_ID/--bucket-id $INFLUX_BUCKET_ID/g; - s/BUCKET_NAME/$INFLUX_DATABASE/g; - s/DATABASE_NAME/$INFLUX_DATABASE/g; + sed -i 's|"influxctl database create --retention-period 1y get-started"|"influxctl database create --retention-period 1y $INFLUX_TMP_DATABASE"|g;' \ + $file + + # Replace remaining placeholders with variables. + # If the placeholder is inside of a Python os.getenv() function, don't replace it. + # Note the specific use of double quotes for the os.getenv() arguments here. You'll need to use double quotes in your code samples for this to match. + sed -i '/os.getenv("ACCOUNT_ID")/! s/ACCOUNT_ID/$ACCOUNT_ID/g; + /os.getenv("API_TOKEN")/! s/API_TOKEN/$INFLUX_TOKEN/g; + /os.getenv("BUCKET_ID")/! s/--bucket-id BUCKET_ID/--bucket-id $INFLUX_BUCKET_ID/g; + /os.getenv("BUCKET_NAME")/! s/BUCKET_NAME/$INFLUX_DATABASE/g; + /os.getenv("CLUSTER_ID")/! s/CLUSTER_ID/$CLUSTER_ID/g; + /os.getenv("DATABASE_TOKEN")/! s/DATABASE_TOKEN/$INFLUX_TOKEN/g; + /os.getenv("DATABASE_NAME")/! s/DATABASE_NAME/$INFLUX_DATABASE/g; s/--id DBRP_ID/--id $INFLUX_DBRP_ID/g; s/get-started/$INFLUX_DATABASE/g; - s/RETENTION_POLICY_NAME\|RETENTION_POLICY/$INFLUX_RETENTION_POLICY/g; + /os.getenv("MANAGEMENT_TOKEN")/! s/MANAGEMENT_TOKEN/$MANAGEMENT_TOKEN/g; + /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;' \ $file diff --git a/test/src/requirements.txt b/test/src/requirements.txt index f871ed228..7d366d868 100644 --- a/test/src/requirements.txt +++ b/test/src/requirements.txt @@ -4,6 +4,9 @@ pytest-cov>=2.12.1 pytest-codeblocks>=0.16.1 python-dotenv>=1.0.0 pytest-dotenv>=0.5.2 +# Allow pytest to pass if no tests (i.e. testable code blocks) are found. +pytest-custom-exit-code>=0.3.0 +requests>=2.26.0 # Code sample dependencies influxdb3-python @ git+https://github.com/InfluxCommunity/influxdb3-python@v0.5.0 influxdb3-python-cli @ git+https://github.com/InfluxCommunity/influxdb3-python-cli@main From 75f3e996b371b4424f0e866478031ae09347720d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 1 Jul 2024 13:39:58 -0500 Subject: [PATCH 04/96] chore(v3): Improve linting, test influxctl: - Remove date format linting in table cells. Copies Google's DateFormat style config to InfluxDataDocs style with modified scope. - Update styles (vale sync) - Skip database create in tests. - Add example test for table create. - Fix linting errors. - Add TEST_RUN placeholder replacement in prepare-content.sh. --- .ci/vale/styles/InfluxDataDocs/DateFormat.yml | 11 + .ci/vale/styles/write-good/Weasel.yml | 198 +----------------- .vale.ini | 1 + content/influxdb/cloud-dedicated/.vale.ini | 1 + .../define-custom-partitions.md | 50 ++++- content/influxdb/cloud-serverless/.vale.ini | 1 + content/influxdb/clustered/.vale.ini | 1 + .../define-custom-partitions.md | 50 ++++- test/src/prepare-content.sh | 3 +- 9 files changed, 119 insertions(+), 197 deletions(-) create mode 100644 .ci/vale/styles/InfluxDataDocs/DateFormat.yml diff --git a/.ci/vale/styles/InfluxDataDocs/DateFormat.yml b/.ci/vale/styles/InfluxDataDocs/DateFormat.yml new file mode 100644 index 000000000..5dfb7810f --- /dev/null +++ b/.ci/vale/styles/InfluxDataDocs/DateFormat.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Use 'July 31, 2016' format, not '%s'." +link: 'https://developers.google.com/style/dates-times' +ignorecase: true +level: error +nonword: true +scope: + - ~table.cell +tokens: + - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}' + - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/.ci/vale/styles/write-good/Weasel.yml b/.ci/vale/styles/write-good/Weasel.yml index e29391444..d1d90a7bc 100644 --- a/.ci/vale/styles/write-good/Weasel.yml +++ b/.ci/vale/styles/write-good/Weasel.yml @@ -3,205 +3,27 @@ message: "'%s' is a weasel word!" ignorecase: true level: warning tokens: - - absolutely - - accidentally - - additionally - - allegedly - - alternatively - - angrily - - anxiously - - approximately - - awkwardly - - badly - - barely - - beautifully - - blindly - - boldly - - bravely - - brightly - - briskly - - bristly - - bubbly - - busily - - calmly - - carefully - - carelessly - - cautiously - - cheerfully - clearly - - closely - - coldly - completely - - consequently - - correctly - - courageously - - crinkly - - cruelly - - crumbly - - cuddly - - currently - - daily - - daringly - - deadly - - definitely - - deliberately - - doubtfully - - dumbly - - eagerly - - early - - easily - - elegantly - - enormously - - enthusiastically - - equally - - especially - - eventually - - exactly - exceedingly - - exclusively + - excellent - extremely - fairly - - faithfully - - fatally - - fiercely - - finally - - fondly - - few - - foolishly - - fortunately - - frankly - - frantically - - generously - - gently - - giggly - - gladly - - gracefully - - greedily - - happily - - hardly - - hastily - - healthily - - heartily - - helpfully - - honestly - - hourly - - hungrily - - hurriedly - - immediately - - impatiently - - inadequately - - ingeniously - - innocently - - inquisitively + - huge - interestingly - - irritably - - jiggly - - joyously - - justly - - kindly + - is a number - largely - - lately - - lazily - - likely - - literally - - lonely - - loosely - - loudly - - loudly - - luckily - - madly - - many - - mentally - - mildly - - monthly - - mortally - mostly - - mysteriously - - neatly - - nervously - - nightly - - noisily - - normally - - obediently - - occasionally - - only - - openly - - painfully - - particularly - - patiently - - perfectly - - politely - - poorly - - powerfully - - presumably - - previously - - promptly - - punctually - - quarterly - - quickly - - quietly - - rapidly - - rarely - - really - - recently - - recklessly - - regularly - - remarkably + - obviously + - quite - relatively - - reluctantly - - repeatedly - - rightfully - - roughly - - rudely - - sadly - - safely - - selfishly - - sensibly - - seriously - - sharply - - shortly - - shyly + - remarkably + - several - significantly - - silently - - simply - - sleepily - - slowly - - smartly - - smelly - - smoothly - - softly - - solemnly - - sparkly - - speedily - - stealthily - - sternly - - stupidly - substantially - - successfully - - suddenly - surprisingly - - suspiciously - - swiftly - - tenderly - - tensely - - thoughtfully - - tightly - - timely - - truthfully - - unexpectedly - - unfortunately + - tiny - usually + - various + - vast - very - - victoriously - - violently - - vivaciously - - warmly - - waverly - - weakly - - wearily - - weekly - - wildly - - wisely - - worldly - - wrinkly - - yearly diff --git a/.vale.ini b/.vale.ini index 88c1fcd2f..8d4262290 100644 --- a/.vale.ini +++ b/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Google, write-good +Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO diff --git a/content/influxdb/cloud-dedicated/.vale.ini b/content/influxdb/cloud-dedicated/.vale.ini index 6d35f96b0..8973c692c 100644 --- a/content/influxdb/cloud-dedicated/.vale.ini +++ b/content/influxdb/cloud-dedicated/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Cloud-Dedicated, Google, write-good +Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO diff --git a/content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md b/content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md index 7974c595c..46129a41b 100644 --- a/content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md +++ b/content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md @@ -33,7 +33,7 @@ table. #### Partition templates can only be applied on create You can only apply a partition template when creating a database or table. -There is no way to update a partition template on an existing resource. +You can't update a partition template on an existing resource. {{% /note %}} Use the following command flags to identify @@ -71,6 +71,9 @@ The following example creates a new `example-db` database and applies a partitio template that partitions by distinct values of two tags (`room` and `sensor-type`), bucketed values of the `customerID` tag, and by week using the time format `%Y wk:%W`: + + + ```sh influxctl database create \ --template-tag room \ @@ -82,21 +85,60 @@ influxctl database create \ ## Create a table with a custom partition template -The following example creates a new `example-table` table in the `example-db` +The following example creates a new `example-table` table in the specified database and applies a partition template that partitions by distinct values of two tags (`room` and `sensor-type`), bucketed values of the `customerID` tag, and by month using the time format `%Y-%m`: + + + +{{% code-placeholders "DATABASE_NAME" %}} + ```sh influxctl table create \ --template-tag room \ --template-tag sensor-type \ --template-tag-bucket customerID,500 \ --template-timeformat '%Y-%m' \ - example-db \ + DATABASE_NAME \ example-table ``` +{{% /code-placeholders %}} + +Replace the following in your command: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) + + + ## Example partition templates Given the following [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) @@ -108,7 +150,7 @@ prod,line=A,station=weld1 temp=81.9,qty=36i 1704067200000000000 ##### Partitioning by distinct tag values -| Description | Tag part(s) | Time part | Resulting partition key | +| Description | Tag parts | Time part | Resulting partition key | | :---------------------- | :---------------- | :--------- | :----------------------- | | By day (default) | | `%Y-%m-%d` | 2024-01-01 | | By day (non-default) | | `%d %b %Y` | 01 Jan 2024 | diff --git a/content/influxdb/cloud-serverless/.vale.ini b/content/influxdb/cloud-serverless/.vale.ini index 191227f55..43840007e 100644 --- a/content/influxdb/cloud-serverless/.vale.ini +++ b/content/influxdb/cloud-serverless/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Cloud-Serverless, Google, write-good +Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO diff --git a/content/influxdb/clustered/.vale.ini b/content/influxdb/clustered/.vale.ini index 2095bfd0c..193ae44b3 100644 --- a/content/influxdb/clustered/.vale.ini +++ b/content/influxdb/clustered/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Clustered, Google, write-good +Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO diff --git a/content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md b/content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md index 9b7b7ecf1..ffd7d61c0 100644 --- a/content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md +++ b/content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md @@ -33,7 +33,7 @@ table. #### Partition templates can only be applied on create You can only apply a partition template when creating a database or table. -There is no way to update a partition template on an existing resource. +You can't update a partition template on an existing resource. {{% /note %}} Use the following command flags to identify @@ -71,6 +71,9 @@ The following example creates a new `example-db` database and applies a partitio template that partitions by distinct values of two tags (`room` and `sensor-type`), bucketed values of the `customerID` tag, and by week using the time format `%Y wk:%W`: + + + ```sh influxctl database create \ --template-tag room \ @@ -82,21 +85,60 @@ influxctl database create \ ## Create a table with a custom partition template -The following example creates a new `example-table` table in the `example-db` +The following example creates a new `example-table` table in the specified database and applies a partition template that partitions by distinct values of two tags (`room` and `sensor-type`), bucketed values of the `customerID` tag, and by month using the time format `%Y-%m`: + + + +{{% code-placeholders "DATABASE_NAME" %}} + ```sh influxctl table create \ --template-tag room \ --template-tag sensor-type \ --template-tag-bucket customerID,500 \ --template-timeformat '%Y-%m' \ - example-db \ + DATABASE_NAME \ example-table ``` +{{% /code-placeholders %}} + +Replace the following in your command: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) + + + ## Example partition templates Given the following [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) @@ -108,7 +150,7 @@ prod,line=A,station=weld1 temp=81.9,qty=36i 1704067200000000000 ##### Partitioning by distinct tag values -| Description | Tag part(s) | Time part | Resulting partition key | +| Description | Tag parts | Time part | Resulting partition key | | :---------------------- | :---------------- | :--------- | :----------------------- | | By day (default) | | `%Y-%m-%d` | 2024-01-01 | | By day (non-default) | | `%d %b %Y` | 01 Jan 2024 | diff --git a/test/src/prepare-content.sh b/test/src/prepare-content.sh index 6490ae585..a41d4b6d4 100644 --- a/test/src/prepare-content.sh +++ b/test/src/prepare-content.sh @@ -56,7 +56,8 @@ function substitute_placeholders { /os.getenv("MANAGEMENT_TOKEN")/! s/MANAGEMENT_TOKEN/$MANAGEMENT_TOKEN/g; /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/CONFIG_NAME/CONFIG_$(shuf -i 0-100 -n1)/g; + s/TEST_RUN/TEST_RUN_$(date +%s)/g' \ $file # v2-specific replacements. From cf9756c0f1f1931ae33b79699743377234273433 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 1 Jul 2024 16:39:39 -0500 Subject: [PATCH 05/96] chore(Dedicated): Update management tokena and Management API info. --- .../cloud-dedicated/get-started/_index.md | 22 +++- .../cloud-dedicated/get-started/setup.md | 24 ++-- .../reference/internals/security.md | 123 ++++++++++++------ 3 files changed, 116 insertions(+), 53 deletions(-) diff --git a/content/influxdb/cloud-dedicated/get-started/_index.md b/content/influxdb/cloud-dedicated/get-started/_index.md index 621a0952b..768841557 100644 --- a/content/influxdb/cloud-dedicated/get-started/_index.md +++ b/content/influxdb/cloud-dedicated/get-started/_index.md @@ -178,15 +178,29 @@ one of the following [token](/influxdb/cloud-dedicated/admin/tokens/) types: - **Database token**: A token that grants read and write access to InfluxDB databases. -- **Management token**: A short-lived (1 hour) [Auth0 token](#) used to - administer your InfluxDB cluster. These are generated by the `influxctl` CLI - and do not require any direct management. Management tokens authorize a user - to perform tasks related to: +- **Management token**: + [Auth0 authentication token](/influxdb/cloud-dedicated/reference/internals/security/#access-authentication-and-authorization) generated by the `influxctl` CLI and used to administer your InfluxDB cluster. +Management tokens authorize a user to perform tasks related to: - Account management - Database management - Database token management - Pricing + +By default, management tokens are + + - short-lived + - issued for a specific user + - issued by an OAuth2 identity provider + - managed by `influxctl` and don't require management by users + +However, for automation purposes, an `influxctl` user can +[manually create a long-lived +management token](/influxdb/cloud-dedicated/admin/tokens/management/#create-a-management-token) +for use with the +[Management API for Cloud Dedicated](/influxdb/cloud-dedicated/api/management). +Manually-created management tokens authenticate directly with your InfluxDB +cluster and don't require human interaction with your identity provider. {{< page-nav next="/influxdb/clustered/get-started/setup/" >}} diff --git a/content/influxdb/cloud-dedicated/get-started/setup.md b/content/influxdb/cloud-dedicated/get-started/setup.md index 7d2ab2256..d91c700ee 100644 --- a/content/influxdb/cloud-dedicated/get-started/setup.md +++ b/content/influxdb/cloud-dedicated/get-started/setup.md @@ -45,13 +45,13 @@ following information: ## Download, install, and configure the influxctl CLI The [`influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/) -provides a simple way to manage your InfluxDB Cloud Dedicated cluster from a -command line. It lets you perform administrative tasks such as managing +lets you manage your {{< product-name omit="Clustered" >}} cluster from a +command line and perform administrative tasks such as managing databases and tokens. 1. [Download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). -2. **Create a connection profile and provide your InfluxDB Cloud Dedicated connection credentials**. +2. **Create a connection profile and provide your {{< product-name omit="Clustered" >}} connection credentials**. The `influxctl` CLI uses [connection profiles](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) to connect to and authenticate with your InfluxDB Cloud Dedicated cluster. @@ -72,7 +72,7 @@ If stored at a non-default location, include the `--config` flag with each {{% /note %}} - **Copy and paste the sample configuration profile code** into your `config.toml`: +3. **Copy and paste the sample configuration profile code** into your `config.toml`: {{% code-placeholders "ACCOUNT_ID|CLUSTER_ID" %}} @@ -97,10 +97,11 @@ _For detailed information about `influxctl` profiles, see ## Create a database -Use the [`influxctl database create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/create/) +Use the +[`influxctl database create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/database/create/) to create a database. You can use an existing database or create a new one specifically for this getting started tutorial. -_Examples in this getting started tutorial assume a database named **"get-started"**._ +_Examples in this getting started tutorial assume a database named `get-started`._ {{% note %}} @@ -109,15 +110,19 @@ _Examples in this getting started tutorial assume a database named **"get-starte The first time you run an `influxctl` CLI command, you are directed to login to **Auth0**. Once logged in, Auth0 issues a short-lived (1 hour) management token for the `influxctl` CLI that grants administrative access -to your InfluxDB Cloud Dedicated cluster. +to your {{< product-name omit="Clustered" >}} cluster. {{% /note %}} Provide the following: - Database name. -- _Optional:_ Database [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) +- _Optional:_ Database + [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) as a duration value. If no retention period is specified, the default is infinite. + + + {{% code-placeholders "get-started|1y" %}} ```sh @@ -128,7 +133,8 @@ influxctl database create --retention-period 1y get-started ## Create a database token -Use the [`influxctl token create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/) +Use the +[`influxctl token create` command](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/) to create a database token with read and write permissions for your database. Provide the following: diff --git a/content/influxdb/cloud-dedicated/reference/internals/security.md b/content/influxdb/cloud-dedicated/reference/internals/security.md index 857ffee80..915c486c4 100644 --- a/content/influxdb/cloud-dedicated/reference/internals/security.md +++ b/content/influxdb/cloud-dedicated/reference/internals/security.md @@ -14,7 +14,7 @@ InfluxData's information security program is based on industry-recognized standa including but not limited to ISO 27001, NIST 800-53, CIS20, and SOC2 Type II. The security policy describes the secure development, deployment, and operation of InfluxDB Cloud. -To protect data, InfluxDB Cloud Dedicated includes the following: +To protect data, {{% product-name %}} includes the following: - Guaranteed [tenant isolation](#tenant-isolation) and [data integrity](#data-integrity). - Trusted cloud infrastructure @@ -48,30 +48,30 @@ To protect data, InfluxDB Cloud Dedicated includes the following: ## Tenant isolation -In the InfluxDB Cloud Dedicated platform, access controls ensure that only valid +In the {{% product-name %}} platform, access controls ensure that only valid authenticated and authorized requests access your account data. Access control includes: -- A unique cluster ID assigned to each InfluxDB Cloud Dedicated cluster. +- A unique cluster ID assigned to each {{% product-name %}} cluster. All internal Cloud services require this cluster ID to authenticate entities before accessing or operating on data. - All external requests must be authorized with a valid token or session. - Every InfluxDB Cloud Dedicated service enforces this policy. + Every {{% product-name %}} service enforces this policy. ## Data integrity A dedicated internal service ensures data integrity by periodically creating, recording, and writing test data into test buckets. The service periodically executes queries to ensure the data hasn't been lost or corrupted. -A separate instance of this service lives within each InfluxDB Cloud Dedicated cluster. +A separate instance of this service lives within each {{% product-name %}} cluster. Additionally, the service creates out-of-band backups in [line protocol](https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol/), and ensures the backup data matches the data on disk. ## Cloud infrastructure -![InfluxDB Cloud Dedicated cluster architecture](https://docs.influxdata.com/img/influxdb/cloud-internals-cluster.png) +![{{% product-name %}} cluster architecture](https://docs.influxdata.com/img/influxdb/cloud-internals-cluster.png) -InfluxDB Cloud Dedicated is available on the following cloud providers: +{{% product-name %}} is available on the following cloud providers: - [Amazon Web Services (AWS)](https://aws.amazon.com/) - [Microsoft Azure](https://azure.microsoft.com/en-us/) _(Coming)_ @@ -80,17 +80,17 @@ InfluxDB Cloud Dedicated is available on the following cloud providers: To ensure data security, availability, and durability, each instance is isolated and protected in its own virtual private cloud (VPC). -Users interact with InfluxDB Cloud Dedicated only through Cloud Dedicated established APIs. +Users interact with {{% product-name %}} only through Cloud Dedicated established APIs. For cluster management activities, authorized users interact with the Granite service. For workload clusters, authorized users interact with APIs for InfluxDB v3 Ingesters (writes) and Queriers (reads). These services don't expose AWS S3 or other cloud provider or internal services. -InfluxDB Cloud Dedicated uses separate S3 buckets for each customer's cluster to persist writes. +{{% product-name %}} uses separate S3 buckets for each customer's cluster to persist writes. The S3 buckets are only accessible by the customer's cluster services. Separate configuration ensures one customer's S3 buckets cannot be accessed by another customer (for example, in the event of a service defect). ### Amazon Web Services (AWS) -An instance of InfluxDB Cloud Dedicated consists of microservices in Kubernetes. +An instance of {{% product-name %}} consists of microservices in Kubernetes. Each VPC within AWS is segmented into public and private subnets: - The public subnet contains resources exposed to the public internet, including @@ -103,7 +103,7 @@ For detail about AWS's physical security and data center protocols, see [AWS's C ### Google Cloud Platform (GCP) -In Google Cloud Platform (GCP), InfluxDB Cloud Dedicated uses the Google Kubernetes Engine (GKE) +In Google Cloud Platform (GCP), {{% product-name %}} uses the Google Kubernetes Engine (GKE) and Google Compute Engine to deploy individual cluster components. Clusters are isolated at the project level to enhance access controls and data governance, and support auditing. @@ -113,7 +113,7 @@ For detail about physical security in GCP data centers, see [Google's Compliance ### Microsoft Azure -In Microsoft Azure, InfluxDB Cloud Dedicated uses Azure Kubernetes Service (AKS) +In Microsoft Azure, {{% product-name %}} uses Azure Kubernetes Service (AKS) and Azure Virtual Machines to deploy individual cluster components. To support auditing and authorization control within Azure, clusters are deployed into dedicated VNets within each region. @@ -123,9 +123,9 @@ For detail about physical security within Microsoft Azure data centers, see [Mic ### Data encryption -InfluxDB Cloud Dedicated enforces TLS encryption for data in transit from all +{{% product-name %}} enforces TLS encryption for data in transit from all clients, including Telegraf agents, browsers, and custom applications. -TLS 1.2 is the minimum TLS version allowed by InfluxDB Cloud Dedicated, including Granite server and management cluster TLS termination. +TLS 1.2 is the minimum TLS version allowed by {{% product-name %}}, including Granite server and management cluster TLS termination. Requests using TLS 1.1 or earlier are rejected. By default, data at rest is encrypted using strong encryption methods (AES-256) @@ -145,11 +145,11 @@ InfluxData maintains the following application and service security controls: - Multi-factor authentication (MFA) is required for all infrastructure (AWS, GCP, and Azure) and for other production systems with access to user information (see [InfluxData Subprocessors](https://www.influxdata.com/legal/influxdata-subprocessors/)). -- InfluxDB Cloud Dedicated access is logged and audited regularly. +- {{% product-name %}} access is logged and audited regularly. ### Configuration management -InfluxDB Cloud Dedicated is programmatically managed and deployed using +{{% product-name %}} is programmatically managed and deployed using “infrastructure as code” which undergoes version control and testing as part of the automated deployment process. Permission to push code is tightly controlled, @@ -191,7 +191,7 @@ Dedicated environments. for event analysis, capacity planning, alerting, and instrumentation. Access to these logs and operator interfaces is controlled by group access permissions, and provided only to teams that require access to deliver - InfluxDB Cloud Dedicated services. + {{% product-name %}} services. ### Security assessments @@ -212,7 +212,7 @@ The Business Continuity Plan and Disaster Recovery Plan are updated annually. ### Data durability -Data is replicated within multiple storage engines of InfluxDB Cloud Dedicated. +Data is replicated within multiple storage engines of {{% product-name %}}. The replication mechanism executes a serializable upsert and delete stream against all replicas and runs background entropy detection processes to identify diverged replicas. @@ -233,7 +233,9 @@ Users can configure the following security controls: ### Access, authentication, and authorization -InfluxDB Cloud Dedicated uses [Auth0](https://auth0.com/) for authentication and separates workload cluster management authorizations (using _management tokens_) from database read and write authorizations (using _database tokens_). +{{< product-name >}} uses [Auth0](https://auth0.com/) for authentication and +separates workload cluster management authorizations (using _management tokens_) +from database read and write authorizations (using _database tokens_). - [User provisioning](#user-provisioning) - [Management tokens](#management-tokens) @@ -241,23 +243,32 @@ InfluxDB Cloud Dedicated uses [Auth0](https://auth0.com/) for authentication and #### User provisioning -InfluxData uses Auth0 to create user accounts and assign permission sets to user accounts on the InfluxDB Cloud Dedicated system. +InfluxData uses [Auth0](https://auth0.com/) to create user accounts and assign +permission sets to user accounts on {{% product-name %}}. After a user account is created, InfluxData provides the user with the following: - An **Auth0 login** to authenticate access to the cluster -- The InfluxDB Cloud Dedicated **account ID** -- The InfluxDB Cloud Dedicated **cluster ID** -- The InfluxDB Cloud Dedicated **cluster URL** +- The {{% product-name %}} **account ID** +- The {{% product-name %}} **cluster ID** +- The {{% product-name %}} **cluster URL** - A password reset email for setting the login password -With a valid password, the user can login via InfluxData's `influxctl` command line tool. -The login command initiates an Auth0 browser login so that the password is never exchanged with `influxctl`. -With a successful authentication to Auth0, InfluxDB Cloud Dedicated provides the user's `influxctl` session with a short-lived [management token](#management-tokens) for access to the Granite service. -The user interacts with the `influxctl` command line tool to manage the workload cluster, including creating [database tokens](#database-tokens) for database read and write access. +With a valid password, the user can login by invoking one of the +[`influxctl` commands](/influxdb/cloud-dedicated/reference/influxctl/). +The command initiates an Auth0 browser login so that the password is never +exchanged with `influxctl`. +After a successful Auth0 authentication, {{% product-name %}} provides the +user's `influxctl` session with a short-lived +[management token](#management-tokens) for access to the Granite service. +The user interacts with the `influxctl` command line tool to manage the workload +cluster, including creating [database tokens](#database-tokens) for database +read and write access and [creating long-lived management tokens](/influxdb/cloud-dedicated/admin/management-tokens/) +for use with the [Management API](/influxdb/cloud-dedicated/api/management/). #### Management tokens -Management tokens authenticate user accounts to the Granite service and provide authorizations for workload cluster management activities, including: +Management tokens authenticate user accounts to the Granite service and provide +authorizations for workload cluster management activities, including: - account, pricing, and infrastructure management - inviting, listing, and deleting users @@ -268,19 +279,51 @@ Management tokens consist of the following: - An access token string (sensitive) - A permission set for management activities (configured during user provisioning) -- A mandatory 1 hour expiration +- A mandatory 1 hour expiration for tokens generated by logging in to `influxctl` -When a user issues a command using the `influxctl` command-line tool, `influxctl` sends the management token string with the request to the server, where Granite validates the token (for example, using Auth0). -If the management token is valid and not expired, the service then compares the token's permissions against the permissions needed to complete the user's request. +When a user issues a command using the `influxctl` command-line tool, +`influxctl` sends the management token string with the request to the server, +where Granite validates the token (for example, using Auth0). +If the management token is valid and not expired, the service then compares the +token's permissions against the permissions needed to complete the user's request. -Only valid unexpired tokens that have the necessary permission sets are authorized to perform management functions with InfluxDB Cloud Dedicated. -Following security best practice, management tokens are never stored on InfluxDB Cloud Dedicated (Granite or workload cluster) servers, which prevents token theft from the server. -On the client (the user's system), the management token is stored on disk with restricted permissions for `influxctl` to use on subsequent runs. -For example, a user's Linux system would store the management token at `~/.cache/influxctl/*.json` with `0600` permissions (that is, owner read and write, and no access for _group_ or _other_). +Only valid unexpired tokens that have the necessary permission sets are +authorized to perform management functions with {{% product-name %}}. +Following security best practice, management tokens are never stored on +{{% product-name %}} (Granite or workload cluster) servers, which prevents token +theft from the server. +On the client (the user's system), the management token is stored on disk with +restricted permissions for `influxctl` to use on subsequent runs. +For example, a user's Linux system would store the management token at +`~/.cache/influxctl/*.json` with `0600` permissions +(that is, owner read and write, and no access for _group_ or _other_). + +##### Management tokens and the Management API + +A user associated with the cluster and authorized through OAuth may use +`influxctl` to +[manually create and revoke management tokens](/influxdb/cloud-dedicated/admin/tokens/management/) +for automation use +cases--for example, using the [Management API for +{{% product-name %}}](/influxdb/cloud-dedicated/api/management/) to rotate +database tokens or create tables. + +To authenticate a Management API request, the user passes the manually created +token in the HTTP `Authorization` header: + +```HTTP +Authorization MANAGEMENT_TOKEN +``` + +A manually created management token has an optional expiration and +doesn't require human interaction with the OAuth provider. + +Manually created management tokens are meant for automation use cases +and shouldn't be used to circumvent the OAuth provider. #### Database tokens -Database tokens provide authorization for users and client applications to read and write data and metadata in an InfluxDB Cloud Dedicated database. +Database tokens provide authorization for users and client applications to read and write data and metadata in an {{% product-name %}} database. All data write and query API requests require a valid database token with sufficient permissions. _**Note:** an all-access management token can't read or write to a database because it's not a database token._ @@ -291,13 +334,13 @@ Database tokens consist of the following: - A permission set for reading from a database, writing to a database, or both - An API key string (sensitive, with the format apiv_) -When a user successfully creates a database token, the InfluxDB Cloud Dedicated Granite server reveals the new database token to the user as an API key string--the key string is only visible when it's created. +When a user successfully creates a database token, the {{% product-name %}} Granite server reveals the new database token to the user as an API key string--the key string is only visible when it's created. The user is responsible for securely storing and managing the API key string. -Following security best practice, a database token's raw API key string is never stored on InfluxDB Cloud Dedicated (Granite or workload cluster) servers, which prevents token theft from the server. +Following security best practice, a database token's raw API key string is never stored on {{% product-name %}} (Granite or workload cluster) servers, which prevents token theft from the server. The servers store non-sensitive database token attributes (identifier, description, and permission set) and the SHA-512 of the token API key string. When a user provides the API key as part of a request to the workload cluster, the cluster validates the token's SHA-512 against the stored SHA-512. -If the database token is valid, InfluxDB Cloud Dedicated compares the token's permissions against the permissions needed to complete the user's request. +If the database token is valid, {{% product-name %}} compares the token's permissions against the permissions needed to complete the user's request. The request is only authorized if it contains a valid token with the necessary permission set. ##### Token rotation @@ -310,7 +353,7 @@ To rotate a token, a user deletes the database token and issues a new one. InfluxDB Cloud accounts support multiple users in an organization. By default, each user with the *Owner* role has full permissions on resources -in your InfluxDB Cloud Dedicated cluster. +in your {{% product-name %}} cluster. ### Advanced controls From f6a9e72c5087df2495cc4c7d822daf172a91235a Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 1 Jul 2024 19:49:37 -0500 Subject: [PATCH 06/96] chore(v3): Test influxctl token create --- .../cloud-dedicated/get-started/setup.md | 28 +++++- .../influxdb/clustered/get-started/setup.md | 86 +++++++++++++++---- 2 files changed, 94 insertions(+), 20 deletions(-) diff --git a/content/influxdb/cloud-dedicated/get-started/setup.md b/content/influxdb/cloud-dedicated/get-started/setup.md index d91c700ee..89d4fbeb2 100644 --- a/content/influxdb/cloud-dedicated/get-started/setup.md +++ b/content/influxdb/cloud-dedicated/get-started/setup.md @@ -51,10 +51,10 @@ databases and tokens. 1. [Download and install the `influxctl` CLI](/influxdb/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl). -2. **Create a connection profile and provide your {{< product-name omit="Clustered" >}} connection credentials**. +2. **Create a connection profile and provide your {{< product-name >}} connection credentials**. The `influxctl` CLI uses [connection profiles](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) - to connect to and authenticate with your InfluxDB Cloud Dedicated cluster. + to connect to and authenticate with your {{< product-name omit="Clustered" >}} cluster. Create a file named `config.toml` at the following location depending on your operating system. @@ -144,6 +144,10 @@ Provide the following: - `--write-database` Grants write access to a database - Token description + + + + {{% code-placeholders "get-started" %}} ```sh @@ -155,6 +159,26 @@ influxctl token create \ {{% /code-placeholders %}} + + The command returns the token ID and the token string. Store the token string in a safe place. You'll need it later. diff --git a/content/influxdb/clustered/get-started/setup.md b/content/influxdb/clustered/get-started/setup.md index c966ec295..39a4c9b9c 100644 --- a/content/influxdb/clustered/get-started/setup.md +++ b/content/influxdb/clustered/get-started/setup.md @@ -29,15 +29,14 @@ you need is in place. ## Install and configure your InfluxDB cluster -{{% note %}} -_InfluxDB Clustered installation instructions are coming soon._ -{{% /note %}} +Follow the [Install InfluxDB Clustered](/influxdb/clustered/install/) guide to +install prerequisites and set up your cluster. ## Download, install, and configure the influxctl CLI - + The [`influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/) -provides a simple way to manage your {{< product-name omit="Clustered" >}} cluster from a -command line. It lets you perform administrative tasks such as managing +lets you manage your {{< product-name omit="Clustered" >}} cluster from a +command line and perform administrative tasks such as managing databases and tokens. 1. [Download and install the `influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/#download-and-install-influxctl). @@ -57,13 +56,16 @@ databases and tokens. | Windows | `%APPDATA%\influxctl\config.toml` | {{% note %}} + If stored at a non-default location, include the `--config` flag with each `influxctl` command and provide the path to your profile configuration file. + {{% /note %}} - **Copy and paste the sample configuration profile code** into your `config.toml`: +1. **Copy and paste the sample configuration profile code** into your `config.toml`: {{% code-placeholders "PORT|OAUTH_TOKEN_URL|OAUTH_DEVICE_URL|OAUTH_CLIENT_ID" %}} + ```toml [[profile]] name = "default" @@ -77,28 +79,32 @@ If stored at a non-default location, include the `--config` flag with each token_url = "OAUTH_TOKEN_URL" device_url = "OAUTH_DEVICE_URL" ``` + {{% /code-placeholders %}} Replace the following with your {{< product-name >}} credentials: - - {{% code-placeholder-key %}}`PORT`{{% /code-placeholder-key %}}: the port to use to access your InfluxDB cluster - - {{% code-placeholder-key %}}`OAUTH_CLIENT_ID`{{% /code-placeholder-key %}}: the client URL of your OAuth2 provider - (for example: `https://identityprovider/oauth2/v2/token`) - - {{% code-placeholder-key %}}`OAUTH_DEVICE_ID`{{% /code-placeholder-key %}}: the device URL of your OAuth2 provider - (for example: `https://identityprovider/oauth2/v2/auth/device`) + +- {{% code-placeholder-key %}}`PORT`{{% /code-placeholder-key %}}: the port to use to access your InfluxDB cluster +- {{% code-placeholder-key %}}`OAUTH_CLIENT_ID`{{% /code-placeholder-key %}}: the client URL of your OAuth2 provider +(for example: `https://identityprovider/oauth2/v2/token`) +- {{% code-placeholder-key %}}`OAUTH_DEVICE_ID`{{% /code-placeholder-key %}}: the device URL of your OAuth2 provider +(for example: `https://identityprovider/oauth2/v2/auth/device`) _For detailed information about `influxctl` profiles, see [Configure connection profiles](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles)_. ## Create a database -Use the [`influxctl database create` command](/influxdb/clustered/reference/cli/influxctl/database/create/) +Use the +[`influxctl database create` command](/influxdb/clustered/reference/cli/influxctl/database/create/) to create a database. You can use an existing database or create a new one specifically for this getting started tutorial. -_Examples in this getting started tutorial assume a database named **"get-started"**._ +_Examples in this getting started tutorial assume a database named `get-started`._ {{% note %}} + #### Authenticate with your cluster - + The first time you run an `influxctl` CLI command, you are directed to login to your **OAuth provider**. Once logged in, your OAuth provider issues a short-lived (1 hour) management token for the `influxctl` CLI that grants @@ -108,18 +114,25 @@ administrative access to your {{< product-name omit="Clustered" >}} cluster. Provide the following: - Database name. -- _Optional:_ Database [retention period](/influxdb/clustered/admin/databases/#retention-periods) +- _Optional:_ Database + [retention period](/influxdb/clustered/admin/databases/#retention-periods) as a duration value. If no retention period is specified, the default is infinite. + + + {{% code-placeholders "get-started|1y" %}} + ```sh influxctl database create --retention-period 1y get-started ``` + {{% /code-placeholders %}} ## Create a database token -Use the [`influxctl token create` command](/influxdb/clustered/reference/cli/influxctl/token/create/) +Use the +[`influxctl token create` command](/influxdb/clustered/reference/cli/influxctl/token/create/) to create a database token with read and write permissions for your database. Provide the following: @@ -129,15 +142,39 @@ Provide the following: - `--write-database` Grants write access to a database - Token description + + + {{% code-placeholders "get-started" %}} + ```sh influxctl token create \ --read-database get-started \ --write-database get-started \ "Read/write token for get-started database" ``` + {{% /code-placeholders %}} + The command returns the token ID and the token string. Store the token string in a safe place. @@ -145,6 +182,7 @@ You'll need it later. **This is the only time the token string is available in plain text.** {{% note %}} + #### Store secure tokens in a secret store Token strings are returned _only_ on token creation. @@ -159,44 +197,56 @@ Code samples in later sections assume you assigned the token string to an {{< tabs-wrapper >}} {{% tabs %}} -[macOS and Linux](#) +[MacOS and Linux](#) [PowerShell](#) [CMD](#) {{% /tabs %}} {{% tab-content %}} + {{% code-placeholders "DATABASE_TOKEN" %}} + ```sh export INFLUX_TOKEN=DATABASE_TOKEN ``` + {{% /code-placeholders %}} + {{% /tab-content %}} {{% tab-content %}} + {{% code-placeholders "DATABASE_TOKEN" %}} + ```powershell $env:INFLUX_TOKEN = "DATABASE_TOKEN" ``` + {{% /code-placeholders %}} + {{% /tab-content %}} {{% tab-content %}} + {{% code-placeholders "DATABASE_TOKEN" %}} + ```sh set INFLUX_TOKEN=DATABASE_TOKEN # Make sure to include a space character at the end of this command. ``` + {{% /code-placeholders %}} + {{% /tab-content %}} {{< /tabs-wrapper >}} From 478cb393325fedbab439dc7c4ea4ad856df3f355 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 1 Jul 2024 21:30:12 -0500 Subject: [PATCH 07/96] chore(v3): Skip tests for influxctl database create. Fix influxctl reference. --- .../cloud-dedicated/get-started/setup.md | 1 - .../cli/influxctl/database/create.md | 41 ++++++++++++++++--- .../cli/influxctl/database/create.md | 37 +++++++++++++++-- 3 files changed, 68 insertions(+), 11 deletions(-) diff --git a/content/influxdb/cloud-dedicated/get-started/setup.md b/content/influxdb/cloud-dedicated/get-started/setup.md index 89d4fbeb2..3b4f137b2 100644 --- a/content/influxdb/cloud-dedicated/get-started/setup.md +++ b/content/influxdb/cloud-dedicated/get-started/setup.md @@ -147,7 +147,6 @@ Provide the following: - {{% code-placeholders "get-started" %}} ```sh diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/database/create.md b/content/influxdb/cloud-dedicated/reference/cli/influxctl/database/create.md index 989dbe89c..bb15512a4 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/database/create.md +++ b/content/influxdb/cloud-dedicated/reference/cli/influxctl/database/create.md @@ -65,12 +65,29 @@ Be sure to follow [partitioning best practices](/influxdb/cloud-dedicated/admin/ If defining a custom partition template for your database with any of the `--template-*` flags, always include the `--template-timeformat` flag with a -time format to use in your partition template. Otherwise time will be omitted -from the partition template and partitions won't be able to be compacted. +time format to use in your partition template. +Otherwise, InfluxDB omits time from the partition template and won't compact partitions. {{% /note %}} +{{% warn %}} +#### Cannot reuse deleted database names + +You cannot reuse the name of a deleted database when creating a new database. +If you try to reuse the name, the API response status code +is `400` and the `message` field contains the following: + +```text +'iox_proxy.app.CreateDatabase failed to create database: \ +rpc error: code = AlreadyExists desc = A namespace with the +name `` already exists' +``` +{{% /warn %}} + ## Usage + + + ```sh influxctl database create [flags] ``` @@ -85,12 +102,12 @@ influxctl database create [flags] | Flag | | Description | | :--- | :---------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | -| | `--retention-period` | Database retention period (default is 0s or infinite) | -| | `--max-tables` | Maximum tables per database (default is 500, 0 uses default) | -| | `--max-columns` | Maximum columns per table (default is 250, 0 uses default) | +| | `--retention-period` | Database retention period (default is `0s`, infinite) | +| | `--max-tables` | Maximum tables per database (default is 500, `0` uses default) | +| | `--max-columns` | Maximum columns per table (default is 250, `0` uses default) | | | `--template-tag` | Tag to add to partition template (can include multiple of this flag) | | | `--template-tag-bucket` | Tag and number of buckets to partition tag values into separated by a comma--for example: `tag1,100` (can include multiple of this flag) | -| | `--template-timeformat` | Timestamp format for partition template | +| | `--template-timeformat` | Timestamp format for partition template (default is `%Y-%m-%d`) | | `-h` | `--help` | Output command help | {{% caption %}} @@ -106,12 +123,18 @@ _Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/inf ### Create a database with an infinite retention period + + + ```sh influxctl database create mydb ``` ### Create a database with a 30-day retention period + + + ```sh influxctl database create \ --retention-period 30d \ @@ -120,6 +143,9 @@ influxctl database create \ ### Create a database with non-default table and column limits + + + ```sh influxctl database create \ --max-tables 200 \ @@ -133,6 +159,9 @@ The following example creates a new `mydb` database and applies a partition template that partitions by two tags (`room` and `sensor-type`) and by week using the time format `%Y wk:%W`: + + + ```sh influxctl database create \ --template-tag room \ diff --git a/content/influxdb/clustered/reference/cli/influxctl/database/create.md b/content/influxdb/clustered/reference/cli/influxctl/database/create.md index 27cb11745..1767fbbf2 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/database/create.md +++ b/content/influxdb/clustered/reference/cli/influxctl/database/create.md @@ -68,8 +68,25 @@ time format to use in your partition template. Otherwise, InfluxDB omits time from the partition template and won't compact partitions. {{% /note %}} +{{% warn %}} +#### Cannot reuse deleted database names + +You cannot reuse the name of a deleted database when creating a new database. +If you try to reuse the name, the API response status code +is `400` and the `message` field contains the following: + +```text +'iox_proxy.app.CreateDatabase failed to create database: \ +rpc error: code = AlreadyExists desc = A namespace with the +name `` already exists' +``` +{{% /warn %}} + ## Usage + + + ```sh influxctl database create [flags] ``` @@ -84,12 +101,12 @@ influxctl database create [flags] | Flag | | Description | | :--- | :---------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | -| | `--retention-period` | Database retention period (default is 0s or infinite) | -| | `--max-tables` | Maximum tables per database (default is 500, 0 uses default) | -| | `--max-columns` | Maximum columns per table (default is 250, 0 uses default) | +| | `--retention-period` | Database retention period (default is `0s`, infinite) | +| | `--max-tables` | Maximum tables per database (default is 500, `0` uses default) | +| | `--max-columns` | Maximum columns per table (default is 250, `0` uses default) | | | `--template-tag` | Tag to add to partition template (can include multiple of this flag) | | | `--template-tag-bucket` | Tag and number of buckets to partition tag values into separated by a comma--for example: `tag1,100` (can include multiple of this flag) | -| | `--template-timeformat` | Timestamp format for partition template | +| | `--template-timeformat` | Timestamp format for partition template (default is `%Y-%m-%d`) | | `-h` | `--help` | Output command help | {{% caption %}} @@ -105,12 +122,18 @@ _Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl ### Create a database with an infinite retention period + + + ```sh influxctl database create mydb ``` ### Create a database with a 30-day retention period + + + ```sh influxctl database create \ --retention-period 30d \ @@ -119,6 +142,9 @@ influxctl database create \ ### Create a database with non-default table and column limits + + + ```sh influxctl database create \ --max-tables 200 \ @@ -132,6 +158,9 @@ The following example creates a new `mydb` database and applies a partition template that partitions by two tags (`room` and `sensor-type`) and by week using the time format `%Y wk:%W`: + + + ```sh influxctl database create \ --template-tag room \ From 23816d9a7e2198b1d7ab9fbebde142b3b962aa0b Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 2 Jul 2024 09:29:16 -0500 Subject: [PATCH 08/96] fix(v3): Skip tests for creating databases; namespaces aren't reusable. --- .../vocabularies/InfluxDataDocs/accept.txt | 2 +- .../cloud-dedicated/admin/databases/create.md | 48 ++++++++++++------- .../clustered/admin/databases/create.md | 21 +++++--- 3 files changed, 48 insertions(+), 23 deletions(-) diff --git a/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt index 2d7ef17b4..5eb80d548 100644 --- a/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt +++ b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt @@ -7,7 +7,7 @@ Anaconda Apache Superset Arrow AuthToken -CLI +CLI|\/cli\/ CSV Data Explorer Dedup diff --git a/content/influxdb/cloud-dedicated/admin/databases/create.md b/content/influxdb/cloud-dedicated/admin/databases/create.md index 54ff45460..a40c1bc15 100644 --- a/content/influxdb/cloud-dedicated/admin/databases/create.md +++ b/content/influxdb/cloud-dedicated/admin/databases/create.md @@ -10,20 +10,22 @@ menu: parent: Manage databases weight: 201 list_code_example: | + ##### CLI ```sh influxctl database create \ --retention-period 30d \ --max-tables 500 \ --max-columns 250 \ - + DATABASE_NAME ``` + ##### API ```sh curl \ --location "https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" \ - --request POST + --request POST \ --header "Accept: application/json" \ --header 'Content-Type: application/json' \ --header "Authorization: Bearer MANAGEMENT_TOKEN" \ @@ -103,6 +105,9 @@ to create a database in your {{< product-name omit=" Clustered" >}} cluster. _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._ {{% /note %}} + + + {{% code-placeholders "DATABASE_NAME|30d|500|100|300|(TAG_KEY(_\d)?)" %}} ```sh @@ -127,11 +132,15 @@ Replace the following in your command: ## Database attributes -- [Retention period syntax (influxctl CLI)](#retention-period-syntax-influxctl-cli) -- [Custom partitioning (influxctl CLI)](#custom-partitioning-influxctl-cli) -- [Database naming restrictions](#database-naming-restrictions) -- [InfluxQL DBRP naming convention](#influxql-dbrp-naming-convention) -- [Table and column limits](#table-and-column-limits) +- [Database attributes](#database-attributes) + - [Retention period syntax (influxctl CLI)](#retention-period-syntax-influxctl-cli) + - [Custom partitioning (influxctl CLI)](#custom-partitioning-influxctl-cli) +- [Database attributes](#database-attributes-1) + - [Retention period syntax (Management API)](#retention-period-syntax-management-api) + - [Custom partitioning (Management API)](#custom-partitioning-management-api) + - [Database naming restrictions](#database-naming-restrictions) + - [InfluxQL DBRP naming convention](#influxql-dbrp-naming-convention) + - [Table and column limits](#table-and-column-limits) ### Retention period syntax (influxctl CLI) @@ -190,7 +199,7 @@ For more information, see [Manage data partitioning](/influxdb/cloud-dedicated/a #### Partition templates can only be applied on create You can only apply a partition template when creating a database. -There is no way to update a partition template on an existing database. +You can't update a partition template on an existing database. {{% /note %}} @@ -237,12 +246,15 @@ _{{< product-name >}} supports up to 7 total tags or tag buckets in the partitio The following example shows how to use the Management API to create a database with custom partitioning: + + + {{% code-placeholders "DATABASE_NAME|2592000000000|500|100|300|250|ACCOUNT_ID|CLUSTER_ID|MANAGEMENT_TOKEN|(TAG_KEY(_\d)?)" %}} ```sh curl \ --location "https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" \ - --request POST + --request POST \ --header "Accept: application/json" \ --header 'Content-Type: application/json' \ --header "Authorization: Bearer MANAGEMENT_TOKEN" \ @@ -294,11 +306,15 @@ Replace the following in your request: ## Database attributes -- [Retention period syntax (Management API)](#retention-period-syntax-management-api) -- [Custom partitioning (Management API)](#custom-partitioning-management-api) -- [Database naming restrictions](#database-naming-restrictions) -- [InfluxQL DBRP naming convention](#influxql-dbrp-naming-convention) -- [Table and column limits](#table-and-column-limits) +- [Database attributes](#database-attributes) + - [Retention period syntax (influxctl CLI)](#retention-period-syntax-influxctl-cli) + - [Custom partitioning (influxctl CLI)](#custom-partitioning-influxctl-cli) +- [Database attributes](#database-attributes-1) + - [Retention period syntax (Management API)](#retention-period-syntax-management-api) + - [Custom partitioning (Management API)](#custom-partitioning-management-api) + - [Database naming restrictions](#database-naming-restrictions) + - [InfluxQL DBRP naming convention](#influxql-dbrp-naming-convention) + - [Table and column limits](#table-and-column-limits) ### Retention period syntax (Management API) @@ -334,7 +350,7 @@ For more information, see [Manage data partitioning](/influxdb/cloud-dedicated/a #### Partition templates can only be applied on create You can only apply a partition template when creating a database. -There is no way to update a partition template on an existing database. +You can't update a partition template on an existing database. {{% /note %}} @@ -364,7 +380,7 @@ database and retention policy (DBRP) to be queryable with InfluxQL. **When naming a database that you want to query with InfluxQL**, use the following naming convention to automatically map v1 DBRP combinations to an {{% product-name %}} database: -```sh +```text database_name/retention_policy_name ``` diff --git a/content/influxdb/clustered/admin/databases/create.md b/content/influxdb/clustered/admin/databases/create.md index 5ad5598ed..9b1d7a8b7 100644 --- a/content/influxdb/clustered/admin/databases/create.md +++ b/content/influxdb/clustered/admin/databases/create.md @@ -1,20 +1,22 @@ --- title: Create a database description: > - Use the [`influxctl database create` command](/influxdb/clustered/reference/cli/influxctl/database/create/) - to create a new InfluxDB database in your InfluxDB cluster. + Use the [`influxctl database create` command](/influxdb/clustered/reference/cli/influxctl/database/create/) to create a new InfluxDB database in your InfluxDB cluster. Provide a database name and an optional retention period. menu: influxdb_clustered: parent: Manage databases weight: 201 list_code_example: | + + ##### CLI + ```sh influxctl database create \ --retention-period 30d \ --max-tables 500 \ --max-columns 250 \ - + DATABASE_NAME ``` related: - /influxdb/clustered/reference/cli/influxctl/database/create/ @@ -44,7 +46,11 @@ to create a database in your {{< product-name omit=" Clustered" >}} cluster. _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._ {{% /note %}} + + + {{% code-placeholders "DATABASE_NAME|30d|500|200" %}} + ```sh influxctl database create \ --retention-period 30d \ @@ -57,13 +63,16 @@ influxctl database create \ --template-timeformat '%Y-%m-%d' \ DATABASE_NAME ``` + {{% /code-placeholders %}} - [Retention period syntax](#retention-period-syntax) - [Database naming restrictions](#database-naming-restrictions) - [InfluxQL DBRP naming convention](#influxql-dbrp-naming-convention) - [Table and column limits](#table-and-column-limits) -- [Custom partitioning](#custom-partitioning) + - [Table limit](#table-limit) + - [Column limit](#column-limit) + - [Custom partitioning](#custom-partitioning) ## Retention period syntax @@ -127,7 +136,7 @@ database and retention policy (DBRP) to be queryable with InfluxQL. **When naming a database that you want to query with InfluxQL**, use the following naming convention to automatically map v1 DBRP combinations to an {{% product-name %}} database: -```sh +```text database_name/retention_policy_name ``` @@ -225,5 +234,5 @@ For more information, see [Manage data partitioning](/influxdb/clustered/admin/c #### Partition templates can only be applied on create You can only apply a partition template when creating a database. -There is no way to update a partition template on an existing database. +You can't update a partition template on an existing database. {{% /note %}} From 2591db73155367126bcd432211cdc4c1255b3da0 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 2 Jul 2024 10:47:06 -0500 Subject: [PATCH 09/96] fix(v3): Don't use test monitoring script when running a container with -t (TTY). Fix update example. --- .husky/pre-commit | 7 +++++-- .../cloud-dedicated/admin/databases/update.md | 13 +++++++------ 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/.husky/pre-commit b/.husky/pre-commit index 6e0acb87e..9b223fbff 100644 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -1,3 +1,6 @@ -./test/src/monitor-tests.sh start +# If you're running tests in a container that doesn't support TTY (docker run -t), you can use monitor-tests.sh to open URLs in the host's browser. +# Your test needs to redirect the URL to the test/urls.txt file--for example: +# influxctl database update /dev/null > test/urls.txt +# ./test/src/monitor-tests.sh start npx lint-staged --relative -./test/src/monitor-tests.sh kill +# ./test/src/monitor-tests.sh kill diff --git a/content/influxdb/cloud-dedicated/admin/databases/update.md b/content/influxdb/cloud-dedicated/admin/databases/update.md index a025f1540..a8a969659 100644 --- a/content/influxdb/cloud-dedicated/admin/databases/update.md +++ b/content/influxdb/cloud-dedicated/admin/databases/update.md @@ -15,8 +15,8 @@ list_code_example: | influxctl database update \ --retention-period 30d \ --max-tables 500 \ - --max-columns 250 - + --max-columns 250 \ + DATABASE_NAME ``` ##### API @@ -64,10 +64,11 @@ to update a database in your {{< product-name omit=" Clustered" >}} cluster. {{% code-placeholders "DATABASE_NAME|30d|500|200" %}} ```sh -influxctl database update DATABASE_NAME \ +influxctl database update \ --retention-period 30d \ --max-tables 500 \ - --max-columns 250 + --max-columns 250 \ + DATABASE_NAME ``` {{% /code-placeholders %}} @@ -217,7 +218,7 @@ database to apply updates to. The database name itself can't be updated. #### Partition templates can't be updated You can only apply a partition template when creating a database. -There is no way to update a partition template on an existing database. +You can't update a partition template on an existing database. {{% /warn %}} ### Database naming restrictions @@ -243,7 +244,7 @@ database and retention policy (DBRP) to be queryable with InfluxQL. **When naming a database that you want to query with InfluxQL**, use the following naming convention to automatically map v1 DBRP combinations to a database: -```sh +```text database_name/retention_policy_name ``` From e4b32fbec62ab0448aa7a67c1b0c8e9be2a1da40 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 2 Jul 2024 11:21:39 -0500 Subject: [PATCH 10/96] fix(v3): database update formatting --- .../cloud-dedicated/admin/databases/update.md | 21 +++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/content/influxdb/cloud-dedicated/admin/databases/update.md b/content/influxdb/cloud-dedicated/admin/databases/update.md index a8a969659..d7d762c6a 100644 --- a/content/influxdb/cloud-dedicated/admin/databases/update.md +++ b/content/influxdb/cloud-dedicated/admin/databases/update.md @@ -56,8 +56,8 @@ to update a database in your {{< product-name omit=" Clustered" >}} cluster. 2. In your terminal, run the `influxctl database update` command and provide the following: - Database name - - _Optional_: Database [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods) - Default is `infinite` (`0`). + - _Optional_: Database [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods). + Default is infinite (`0`). - _Optional_: Database table (measurement) limit. Default is `500`. - _Optional_: Database column limit. Default is `250`. @@ -77,6 +77,13 @@ Replace the following in your command: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) +{{% warn %}} +#### Database names can't be updated + +The `influxctl database update` command uses the database name to identify which +database to apply updates to. The database name itself can't be updated. +{{% /warn %}} + ## Database attributes - [Retention period syntax](#retention-period-syntax-influxctl-cli) @@ -92,7 +99,7 @@ for the database. The retention period value is a time duration value made up of a numeric value plus a duration unit. For example, `30d` means 30 days. -A zero duration (`0d`) retention period is infinite and data won't expire. +A zero duration (for example, `0s` or `0d`) retention period is infinite and data won't expire. The retention period value cannot be negative or contain whitespace. {{< flex >}} @@ -212,8 +219,10 @@ The retention period value cannot be negative or contain whitespace. #### Database names can't be updated -The `influxctl database update` command uses the database name to identify which -database to apply updates to. The database name itself can't be updated. +The Management API `PATCH /api/v0/database` endpoint and +the`influxctl database update` command use the database name to identify which +database to apply updates to. +The database name itself can't be updated. #### Partition templates can't be updated @@ -235,7 +244,7 @@ Database names must adhere to the following naming restrictions: In InfluxDB 1.x, data is stored in [databases](/influxdb/v1/concepts/glossary/#database) and [retention policies](/influxdb/v1/concepts/glossary/#retention-policy-rp). -In InfluxDB Cloud Dedicated, databases and retention policies have been merged into +In {{< product-name >}}, databases and retention policies have been merged into _databases_, where databases have a retention period, but retention policies are no longer part of the data model. Because InfluxQL uses the 1.x data model, a database must be mapped to a v1 From b5a8e2b7b3e5501feadad15433837c5bce4ad21c Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 2 Jul 2024 11:23:08 -0500 Subject: [PATCH 11/96] fix(v3): Clustered update database --- .../clustered/admin/databases/update.md | 55 +++++++++++-------- 1 file changed, 33 insertions(+), 22 deletions(-) diff --git a/content/influxdb/clustered/admin/databases/update.md b/content/influxdb/clustered/admin/databases/update.md index 72a3008de..99534f0ad 100644 --- a/content/influxdb/clustered/admin/databases/update.md +++ b/content/influxdb/clustered/admin/databases/update.md @@ -9,10 +9,11 @@ menu: weight: 201 list_code_example: | ```sh - influxctl database update DATABASE_NAME \ + influxctl database update \ --retention-period 30d \ --max-tables 500 \ - --max-columns 250 + --max-columns 250 \ + DATABASE_NAME ``` related: - /influxdb/clustered/reference/cli/influxctl/database/update/ @@ -25,20 +26,27 @@ to update a database in your {{< product-name omit=" Clustered" >}} cluster. 2. Run the `influxctl database update` command and provide the following: - Database name - - _Optional_: Database [retention period](/influxdb/clustered/admin/databases/#retention-periods) - _(default is infinite)_ - - _Optional_: Database table (measurement) limit _(default is 500)_ - - _Optional_: Database column limit _(default is 250)_ + - _Optional_: Database [retention period](/influxdb/cloud-dedicated/admin/databases/#retention-periods). + Default is infinite (`0`). + - _Optional_: Database table (measurement) limit. Default is `500`. + - _Optional_: Database column limit. Default is `250`. {{% code-placeholders "DATABASE_NAME|30d|500|200" %}} + ```sh -influxctl database update DATABASE_NAME \ +influxctl database update \ --retention-period 30d \ --max-tables 500 \ - --max-columns 250 + --max-columns 250 \ + DATABASE_NAME ``` + {{% /code-placeholders %}} +Replace the following in your command: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) + {{% warn %}} #### Database names can't be updated @@ -46,25 +54,28 @@ The `influxctl database update` command uses the database name to identify which database to apply updates to. The database name itself can't be updated. {{% /warn %}} -- [Retention period syntax](#retention-period-syntax) +## Database attributes + +- [Retention period syntax](#retention-period-syntax-influxctl-cli) - [Database naming restrictions](#database-naming-restrictions) - [InfluxQL DBRP naming convention](#influxql-dbrp-naming-convention) - [Table and column limits](#table-and-column-limits) -## Retention period syntax +### Retention period syntax (influxctl CLI) Use the `--retention-period` flag to define a specific [retention period](/influxdb/clustered/admin/databases/#retention-periods) for the database. The retention period value is a time duration value made up of a numeric value -plus a duration unit. For example, `30d` means 30 days. -A zero duration retention period is infinite and data will not expire. +plus a duration unit. +For example, `30d` means 30 days. +A zero duration (for example, `0s` or `0d`) retention period is infinite and data won't expire. The retention period value cannot be negative or contain whitespace. {{< flex >}} -{{% flex-content %}} +{{% flex-content "half" %}} -##### Valid durations units include +#### Valid durations units include - **m**: minute - **h**: hour @@ -74,9 +85,9 @@ The retention period value cannot be negative or contain whitespace. - **y**: year {{% /flex-content %}} -{{% flex-content %}} +{{% flex-content "half" %}} -##### Example retention period values +#### Example retention period values - `0d`: infinite/none - `3d`: 3 days @@ -99,7 +110,7 @@ Database names must adhere to the following naming restrictions: - Should not start with an underscore (`_`). - Maximum length of 64 characters. -## InfluxQL DBRP naming convention +### InfluxQL DBRP naming convention In InfluxDB 1.x, data is stored in [databases](/influxdb/v1/concepts/glossary/#database) and [retention policies](/influxdb/v1/concepts/glossary/#retention-policy-rp). @@ -112,11 +123,11 @@ database and retention policy (DBRP) to be queryable with InfluxQL. **When naming a database that you want to query with InfluxQL**, use the following naming convention to automatically map v1 DBRP combinations to a database: -```sh +```text database_name/retention_policy_name ``` -##### Database naming examples +#### Database naming examples | v1 Database name | v1 Retention Policy name | New database name | | :--------------- | :----------------------- | :------------------------ | @@ -124,12 +135,12 @@ database_name/retention_policy_name | telegraf | autogen | telegraf/autogen | | webmetrics | 1w-downsampled | webmetrics/1w-downsampled | -## Table and column limits +### Table and column limits In {{< product-name >}}, table (measurement) and column limits can be configured using the `--max-tables` and `--max-columns` flags. -### Table limit +#### Table limit **Default maximum number of tables**: 500 @@ -172,7 +183,7 @@ operating cost of your cluster. {{% /expand %}} {{< /expand-wrapper >}} -### Column limit +#### Column limit **Default maximum number of columns**: 250 From 61acef15272e87b6c77dc26d658ea4dd8b033e78 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 2 Jul 2024 13:24:32 -0500 Subject: [PATCH 12/96] chore(v3): whitespace fix --- .lintstagedrc.mjs | 5 +---- content/influxdb/cloud-dedicated/get-started/write.md | 10 ++++++---- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/.lintstagedrc.mjs b/.lintstagedrc.mjs index 66a00a12f..c88b4ac20 100644 --- a/.lintstagedrc.mjs +++ b/.lintstagedrc.mjs @@ -41,10 +41,7 @@ function pytestStagedContent(paths, productPath) { // Instead of the plugin, we could use a placeholder test that always or conditionally passes. // Whether tests pass or fail, the container is removed, // but the CONTENT container and associated volume will remain until the next run. - // Note: the "--network host" setting and `host-open` script are used to - // forward influxctl authentication URLs from the container to the host - // where they can be opened and approved in a host browser. - // Allowing "--network host" has security implications and isn't ideal. + // Note: the docker run -t flag is required to allocate a pseudo-TTY for the container--required for opening influxctl OAuth URLs. `docker run --rm -t \ --label tag=influxdata-docs \ --label stage=test \ diff --git a/content/influxdb/cloud-dedicated/get-started/write.md b/content/influxdb/cloud-dedicated/get-started/write.md index 27e9267ba..ce37dcbcb 100644 --- a/content/influxdb/cloud-dedicated/get-started/write.md +++ b/content/influxdb/cloud-dedicated/get-started/write.md @@ -40,7 +40,8 @@ line protocol for you, but it's good to understand how line protocol works. All data written to InfluxDB is written using **line protocol**, a text-based format that lets you provide the necessary information to write a data point to -InfluxDB. _This tutorial covers the basics of line protocol, but for detailed +InfluxDB. +_This tutorial covers the basics of line protocol, but for detailed information, see the [Line protocol reference](/influxdb/cloud-dedicated/reference/syntax/line-protocol/)._ @@ -163,7 +164,8 @@ The following examples show how to write the preceding [sample data](#home-sensor-data-line-protocol), already in line protocol format, to an {{% product-name %}} database. -To learn more about available tools and options, see [Write data](/influxdb/cloud-dedicated/write-data/). +To learn more about available tools and options, see +[Write data](/influxdb/cloud-dedicated/write-data/). {{% note %}} Some examples in this getting started tutorial assume your InfluxDB @@ -243,12 +245,12 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200' If successful, the output is the success message; otherwise, error details and the failure message. - + {{% /tab-content %}} {{% tab-content %}} - + {{% influxdb/custom-timestamps %}} From dbaa790fdbac63883c2d27a038a50ee4b79c4633 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 2 Jul 2024 14:39:26 -0500 Subject: [PATCH 13/96] fix(v3): curl write examples --- .../cloud-dedicated/get-started/write.md | 12 +- .../cloud-serverless/get-started/write.md | 451 +++++++++--------- .../influxdb/clustered/get-started/write.md | 12 +- 3 files changed, 240 insertions(+), 235 deletions(-) diff --git a/content/influxdb/cloud-dedicated/get-started/write.md b/content/influxdb/cloud-dedicated/get-started/write.md index ce37dcbcb..636169281 100644 --- a/content/influxdb/cloud-dedicated/get-started/write.md +++ b/content/influxdb/cloud-dedicated/get-started/write.md @@ -447,7 +447,7 @@ to InfluxDB: {{% code-placeholders "DATABASE_TOKEN" %}} ```sh -response=$(curl --silent --write-out "%{response_code}:%{errormsg}" \ +response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ "https://{{< influxdb/host >}}/write?db=get-started&precision=s" \ --header "Authorization: Bearer DATABASE_TOKEN" \ --header "Content-type: text/plain; charset=utf-8" \ @@ -482,8 +482,8 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 ") # Format the response code and error message output. -response_code=${response%%:*} -errormsg=${response#*:} +response_code=${response%%:-*} +errormsg=${response#*:-} # Remove leading and trailing whitespace from errormsg errormsg=$(echo "${errormsg}" | tr -d '[:space:]') @@ -559,7 +559,7 @@ to InfluxDB: {{% code-placeholders "DATABASE_TOKEN"%}} ```sh -response=$(curl --silent --write-out "%{response_code}:%{errormsg}" \ +response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ "https://{{< influxdb/host >}}/api/v2/write?bucket=get-started&precision=s" \ --header "Authorization: Bearer DATABASE_TOKEN" \ --header "Content-Type: text/plain; charset=utf-8" \ @@ -594,8 +594,8 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 ") # Format the response code and error message output. -response_code=${response%%:*} -errormsg=${response#*:} +response_code=${response%%:-*} +errormsg=${response#*:-} # Remove leading and trailing whitespace from errormsg errormsg=$(echo "${errormsg}" | tr -d '[:space:]') diff --git a/content/influxdb/cloud-serverless/get-started/write.md b/content/influxdb/cloud-serverless/get-started/write.md index e1ac5e4ef..cd358cdb4 100644 --- a/content/influxdb/cloud-serverless/get-started/write.md +++ b/content/influxdb/cloud-serverless/get-started/write.md @@ -19,9 +19,11 @@ related: - /telegraf/v1/ --- -This tutorial walks you through the fundamental of creating **line protocol** data and writing it to InfluxDB. +This tutorial walks you through the fundamental of creating **line protocol** +data and writing it to InfluxDB. -InfluxDB provides many different options for ingesting or writing data, including the following: +InfluxDB provides many different options for ingesting or writing data, +including the following: - Influx user interface (UI) - InfluxDB HTTP API (v1 and v2) @@ -30,15 +32,17 @@ InfluxDB provides many different options for ingesting or writing data, includin - InfluxDB client libraries - `influx` CLI -If using tools like Telegraf or InfluxDB client libraries, they can -build the line protocol for you, but it's good to understand how line protocol works. +If using tools like Telegraf or InfluxDB client libraries, they can build the +line protocol for you, but it's good to understand how line protocol works. ## Line protocol All data written to InfluxDB is written using **line protocol**, a text-based -format that lets you provide the necessary information to write a data point to InfluxDB. +format that lets you provide the necessary information to write a data point to +InfluxDB. _This tutorial covers the basics of line protocol, but for detailed information, -see the [Line protocol reference](/influxdb/cloud-serverless/reference/syntax/line-protocol/)._ +see the +[Line protocol reference](/influxdb/cloud-serverless/reference/syntax/line-protocol/)._ ### Line protocol elements @@ -80,7 +84,8 @@ whitespace sensitive. --- -_For schema design recommendations, see [InfluxDB schema design](/influxdb/cloud-serverless/write-data/best-practices/schema-design/)._ +_For schema design recommendations, see +[InfluxDB schema design](/influxdb/cloud-serverless/write-data/best-practices/schema-design/)._ ## Construct line protocol @@ -109,32 +114,32 @@ The following line protocol sample represents data collected hourly beginning at ##### Home sensor data line protocol ```text -home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 -home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 -home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 -home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 -home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 -home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 -home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 -home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 -home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 -home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 -home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 -home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 -home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 -home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 -home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 -home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 -home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 -home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 -home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 -home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 -home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 -home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 -home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 -home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 -home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 -home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 +home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719924000 +home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719924000 +home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719927600 +home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719927600 +home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719931200 +home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719931200 +home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719934800 +home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719934800 +home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719938400 +home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719938400 +home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719942000 +home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719942000 +home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719945600 +home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719945600 +home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719949200 +home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719949200 +home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719952800 +home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719952800 +home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719956400 +home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719956400 +home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719960000 +home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719960000 +home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719963600 +home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719963600 +home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719967200 +home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719967200 ``` {{% /influxdb/custom-timestamps %}} @@ -210,32 +215,32 @@ The UI confirms that the data has been written successfully. influx write \ --bucket get-started \ --precision s " -home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 -home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 -home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 -home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 -home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 -home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 -home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 -home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 -home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 -home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 -home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 -home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 -home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 -home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 -home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 -home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 -home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 -home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 -home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 -home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 -home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 -home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 -home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 -home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 -home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 -home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 +home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719924000 +home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719924000 +home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719927600 +home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719927600 +home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719931200 +home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719931200 +home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719934800 +home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719934800 +home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719938400 +home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719938400 +home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719942000 +home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719942000 +home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719945600 +home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719945600 +home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719949200 +home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719949200 +home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719952800 +home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719952800 +home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719956400 +home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719956400 +home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719960000 +home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719960000 +home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719963600 +home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719963600 +home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719967200 +home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719967200 " ``` @@ -261,32 +266,32 @@ Use [Telegraf](/telegraf/v1/) to consume line protocol, and then write it to ```sh cat <<- EOF > home.lp - home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 - home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 - home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 - home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 - home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 - home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 - home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 - home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 - home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 - home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 - home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 - home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 - home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 - home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 - home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 - home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 - home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 - home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 - home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 - home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 - home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 - home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 - home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 - home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 - home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 - home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 + home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719924000 + home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719924000 + home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719927600 + home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719927600 + home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719931200 + home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719931200 + home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719934800 + home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719934800 + home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719938400 + home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719938400 + home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719942000 + home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719942000 + home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719945600 + home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719945600 + home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719949200 + home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719949200 + home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719952800 + home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719952800 + home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719956400 + home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719956400 + home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719960000 + home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719960000 + home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719963600 + home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719963600 + home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719967200 + home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719967200 EOF ``` @@ -434,7 +439,7 @@ InfluxDB creates a bucket named `get-started/autogen` and an {{% code-placeholders "API_TOKEN " %}} ```sh -response=$(curl --silent --write-out "%{response_code}:%{errormsg}" \ +response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ "https://{{< influxdb/host >}}/write?db=get-started&precision=s" \ --header "Authorization: Token API_TOKEN" \ --header "Content-type: text/plain; charset=utf-8" \ @@ -469,15 +474,15 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 ") # Format the response code and error message output. -response_code=${response%%:*} -errormsg=${response#*:} +response_code=${response%%:-*} +errormsg=${response#*:-} # Remove leading and trailing whitespace from errormsg errormsg=$(echo "${errormsg}" | tr -d '[:space:]') echo "$response_code" if [[ $errormsg ]]; then - echo "$errormsg" + echo "$response" fi ``` @@ -536,9 +541,9 @@ to InfluxDB: {{% code-placeholders "API_TOKEN" %}} ```sh -response=$(curl --silent --write-out "%{response_code}:%{errormsg}" \ +response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ "https://{{< influxdb/host >}}/api/v2/write?bucket=get-started&precision=s" \ - --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Authorization: Token DATABASE_TOKEN" \ --header "Content-Type: text/plain; charset=utf-8" \ --header "Accept: application/json" \ --data-binary " @@ -571,8 +576,8 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 ") # Format the response code and error message output. -response_code=${response%%:*} -errormsg=${response#*:} +response_code=${response%%:-*} +errormsg=${response#*:-} # Remove leading and trailing whitespace from errormsg errormsg=$(echo "${errormsg}" | tr -d '[:space:]') @@ -683,32 +688,32 @@ dependencies to your current project. ) lines = [ - "home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000", - "home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000", - "home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600", - "home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600", - "home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200", - "home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200", - "home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800", - "home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800", - "home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400", - "home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400", - "home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000", - "home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000", - "home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600", - "home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600", - "home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200", - "home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200", - "home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800", - "home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800", - "home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400", - "home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400", - "home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000", - "home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000", - "home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600", - "home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600", - "home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200", - "home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200" + "home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719924000", + "home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719924000", + "home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719927600", + "home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719927600", + "home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719931200", + "home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719931200", + "home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719934800", + "home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719934800", + "home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719938400", + "home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719938400", + "home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719942000", + "home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719942000", + "home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719945600", + "home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719945600", + "home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719949200", + "home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719949200", + "home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719952800", + "home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719952800", + "home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719956400", + "home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719956400", + "home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719960000", + "home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719960000", + "home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719963600", + "home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719963600", + "home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719967200", + "home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719967200" ] client.write(lines,write_precision='s') @@ -831,32 +836,32 @@ InfluxDB v3 [influxdb3-go client library package](https://github.com/InfluxCommu // to preserve backslashes and prevent interpretation // of escape sequences--for example, escaped spaces in tag values. lines := [...]string{ - `home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641124000`, - `home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641124000`, - `home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641127600`, - `home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641127600`, - `home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641131200`, - `home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641131200`, - `home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641134800`, - `home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641134800`, - `home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641138400`, - `home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641138400`, - `home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641142000`, - `home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641142000`, - `home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641145600`, - `home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641145600`, - `home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641149200`, - `home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641149200`, - `home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641152800`, - `home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641152800`, - `home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641156400`, - `home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641156400`, - `home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641160000`, - `home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641160000`, - `home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641163600`, - `home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641163600`, - `home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641167200`, - `home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641167200`, + `home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719124000`, + `home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719124000`, + `home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719127600`, + `home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719127600`, + `home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719131200`, + `home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719131200`, + `home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719134800`, + `home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719134800`, + `home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719138400`, + `home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719138400`, + `home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719142000`, + `home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719142000`, + `home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719145600`, + `home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719145600`, + `home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719149200`, + `home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719149200`, + `home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719152800`, + `home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719152800`, + `home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719156400`, + `home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719156400`, + `home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719160000`, + `home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719160000`, + `home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719163600`, + `home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719163600`, + `home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719167200`, + `home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719167200`, } // Iterate over the lines array and write each line @@ -1007,32 +1012,32 @@ the failure message. * Define line protocol records to write. */ const records = [ - `home,room=Living\\ Room temp=21.1,hum=35.9,co=0i 1641124000`, - `home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641124000`, - `home,room=Living\\ Room temp=21.4,hum=35.9,co=0i 1641127600`, - `home,room=Kitchen temp=23.0,hum=36.2,co=0 1641127600`, - `home,room=Living\\ Room temp=21.8,hum=36.0,co=0i 1641131200`, - `home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641131200`, - `home,room=Living\\ Room temp=22.2,hum=36.0,co=0i 1641134800`, - `home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641134800`, - `home,room=Living\\ Room temp=22.2,hum=35.9,co=0i 1641138400`, - `home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641138400`, - `home,room=Living\\ Room temp=22.4,hum=36.0,co=0i 1641142000`, - `home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641142000`, - `home,room=Living\\ Room temp=22.3,hum=36.1,co=0i 1641145600`, - `home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641145600`, - `home,room=Living\\ Room temp=22.3,hum=36.1,co=1i 1641149200`, - `home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641149200`, - `home,room=Living\\ Room temp=22.4,hum=36.0,co=4i 1641152800`, - `home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641152800`, - `home,room=Living\\ Room temp=22.6,hum=35.9,co=5i 1641156400`, - `home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641156400`, - `home,room=Living\\ Room temp=22.8,hum=36.2,co=9i 1641160000`, - `home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641160000`, - `home,room=Living\\ Room temp=22.5,hum=36.3,co=14i 1641163600`, - `home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641163600`, - `home,room=Living\\ Room temp=22.2,hum=36.4,co=17i 1641167200`, - `home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641167200`, + `home,room=Living\\ Room temp=21.1,hum=35.9,co=0i 1719124000`, + `home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719124000`, + `home,room=Living\\ Room temp=21.4,hum=35.9,co=0i 1719127600`, + `home,room=Kitchen temp=23.0,hum=36.2,co=0 1719127600`, + `home,room=Living\\ Room temp=21.8,hum=36.0,co=0i 1719131200`, + `home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719131200`, + `home,room=Living\\ Room temp=22.2,hum=36.0,co=0i 1719134800`, + `home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719134800`, + `home,room=Living\\ Room temp=22.2,hum=35.9,co=0i 1719138400`, + `home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719138400`, + `home,room=Living\\ Room temp=22.4,hum=36.0,co=0i 1719142000`, + `home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719142000`, + `home,room=Living\\ Room temp=22.3,hum=36.1,co=0i 1719145600`, + `home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719145600`, + `home,room=Living\\ Room temp=22.3,hum=36.1,co=1i 1719149200`, + `home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719149200`, + `home,room=Living\\ Room temp=22.4,hum=36.0,co=4i 1719152800`, + `home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719152800`, + `home,room=Living\\ Room temp=22.6,hum=35.9,co=5i 1719156400`, + `home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719156400`, + `home,room=Living\\ Room temp=22.8,hum=36.2,co=9i 1719160000`, + `home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719160000`, + `home,room=Living\\ Room temp=22.5,hum=36.3,co=14i 1719163600`, + `home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719163600`, + `home,room=Living\\ Room temp=22.2,hum=36.4,co=17i 1719167200`, + `home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719167200`, ]; /** @@ -1204,32 +1209,32 @@ the failure message. * escaped spaces in tag values. */ string[] lines = new string[] { - "home,room=Living\\ Room temp=21.1,hum=35.9,co=0i 1641024000", - "home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000", - "home,room=Living\\ Room temp=21.4,hum=35.9,co=0i 1641027600", - "home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600", - "home,room=Living\\ Room temp=21.8,hum=36.0,co=0i 1641031200", - "home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200", - "home,room=Living\\ Room temp=22.2,hum=36.0,co=0i 1641034800", - "home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800", - "home,room=Living\\ Room temp=22.2,hum=35.9,co=0i 1641038400", - "home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400", - "home,room=Living\\ Room temp=22.4,hum=36.0,co=0i 1641042000", - "home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000", - "home,room=Living\\ Room temp=22.3,hum=36.1,co=0i 1641045600", - "home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600", - "home,room=Living\\ Room temp=22.3,hum=36.1,co=1i 1641049200", - "home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200", - "home,room=Living\\ Room temp=22.4,hum=36.0,co=4i 1641052800", - "home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800", - "home,room=Living\\ Room temp=22.6,hum=35.9,co=5i 1641056400", - "home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400", - "home,room=Living\\ Room temp=22.8,hum=36.2,co=9i 1641060000", - "home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000", - "home,room=Living\\ Room temp=22.5,hum=36.3,co=14i 1641063600", - "home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600", - "home,room=Living\\ Room temp=22.2,hum=36.4,co=17i 1641067200", - "home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200" + "home,room=Living\\ Room temp=21.1,hum=35.9,co=0i 1719924000", + "home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719924000", + "home,room=Living\\ Room temp=21.4,hum=35.9,co=0i 1719927600", + "home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719927600", + "home,room=Living\\ Room temp=21.8,hum=36.0,co=0i 1719931200", + "home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719931200", + "home,room=Living\\ Room temp=22.2,hum=36.0,co=0i 1719934800", + "home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719934800", + "home,room=Living\\ Room temp=22.2,hum=35.9,co=0i 1719938400", + "home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719938400", + "home,room=Living\\ Room temp=22.4,hum=36.0,co=0i 1719942000", + "home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719942000", + "home,room=Living\\ Room temp=22.3,hum=36.1,co=0i 1719945600", + "home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719945600", + "home,room=Living\\ Room temp=22.3,hum=36.1,co=1i 1719949200", + "home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719949200", + "home,room=Living\\ Room temp=22.4,hum=36.0,co=4i 1719952800", + "home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719952800", + "home,room=Living\\ Room temp=22.6,hum=35.9,co=5i 1719956400", + "home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719956400", + "home,room=Living\\ Room temp=22.8,hum=36.2,co=9i 1719960000", + "home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719960000", + "home,room=Living\\ Room temp=22.5,hum=36.3,co=14i 1719963600", + "home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719963600", + "home,room=Living\\ Room temp=22.2,hum=36.4,co=17i 1719967200", + "home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719967200" }; // Write each record separately. @@ -1408,32 +1413,32 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ token, database)) { // Create a list of line protocol records. final List records = List.of( - "home,room=Living\\ Room temp=21.1,hum=35.9,co=0i 1641024000", - "home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000", - "home,room=Living\\ Room temp=21.4,hum=35.9,co=0i 1641027600", - "home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600", - "home,room=Living\\ Room temp=21.8,hum=36.0,co=0i 1641031200", - "home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200", - "home,room=Living\\ Room temp=22.2,hum=36.0,co=0i 1641034800", - "home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800", - "home,room=Living\\ Room temp=22.2,hum=35.9,co=0i 1641038400", - "home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400", - "home,room=Living\\ Room temp=22.4,hum=36.0,co=0i 1641042000", - "home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000", - "home,room=Living\\ Room temp=22.3,hum=36.1,co=0i 1641045600", - "home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600", - "home,room=Living\\ Room temp=22.3,hum=36.1,co=1i 1641049200", - "home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200", - "home,room=Living\\ Room temp=22.4,hum=36.0,co=4i 1641052800", - "home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800", - "home,room=Living\\ Room temp=22.6,hum=35.9,co=5i 1641056400", - "home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400", - "home,room=Living\\ Room temp=22.8,hum=36.2,co=9i 1641060000", - "home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000", - "home,room=Living\\ Room temp=22.5,hum=36.3,co=14i 1641063600", - "home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600", - "home,room=Living\\ Room temp=22.2,hum=36.4,co=17i 1641067200", - "home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200" + "home,room=Living\\ Room temp=21.1,hum=35.9,co=0i 1719924000", + "home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719924000", + "home,room=Living\\ Room temp=21.4,hum=35.9,co=0i 1719927600", + "home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719927600", + "home,room=Living\\ Room temp=21.8,hum=36.0,co=0i 1719931200", + "home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719931200", + "home,room=Living\\ Room temp=22.2,hum=36.0,co=0i 1719934800", + "home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719934800", + "home,room=Living\\ Room temp=22.2,hum=35.9,co=0i 1719938400", + "home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719938400", + "home,room=Living\\ Room temp=22.4,hum=36.0,co=0i 1719942000", + "home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719942000", + "home,room=Living\\ Room temp=22.3,hum=36.1,co=0i 1719945600", + "home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719945600", + "home,room=Living\\ Room temp=22.3,hum=36.1,co=1i 1719949200", + "home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719949200", + "home,room=Living\\ Room temp=22.4,hum=36.0,co=4i 1719952800", + "home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719952800", + "home,room=Living\\ Room temp=22.6,hum=35.9,co=5i 1719956400", + "home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719956400", + "home,room=Living\\ Room temp=22.8,hum=36.2,co=9i 1719960000", + "home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719960000", + "home,room=Living\\ Room temp=22.5,hum=36.3,co=14i 1719963600", + "home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719963600", + "home,room=Living\\ Room temp=22.2,hum=36.4,co=17i 1719967200", + "home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719967200" ); /** diff --git a/content/influxdb/clustered/get-started/write.md b/content/influxdb/clustered/get-started/write.md index 62de9e0d4..7c6b31ef7 100644 --- a/content/influxdb/clustered/get-started/write.md +++ b/content/influxdb/clustered/get-started/write.md @@ -439,7 +439,7 @@ to InfluxDB: {{% code-placeholders "DATABASE_TOKEN" %}} ```sh -response=$(curl --silent --write-out "%{response_code}:%{errormsg}" \ +response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ "https://{{< influxdb/host >}}/write?db=get-started&precision=s" \ --header "Authorization: Bearer DATABASE_TOKEN" \ --header "Content-type: text/plain; charset=utf-8" \ @@ -474,8 +474,8 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 ") # Format the response code and error message output. -response_code=${response%%:*} -errormsg=${response#*:} +response_code=${response%%:-*} +errormsg=${response#*:-} # Remove leading and trailing whitespace from errormsg errormsg=$(echo "${errormsg}" | tr -d '[:space:]') @@ -550,7 +550,7 @@ to InfluxDB: {{% code-placeholders "DATABASE_TOKEN"%}} ```sh -response=$(curl --silent --write-out "%{response_code}:%{errormsg}" \ +response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ "https://{{< influxdb/host >}}/api/v2/write?bucket=get-started&precision=s" \ --header "Authorization: Bearer DATABASE_TOKEN" \ --header "Content-Type: text/plain; charset=utf-8" \ @@ -585,8 +585,8 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 ") # Format the response code and error message output. -response_code=${response%%:*} -errormsg=${response#*:} +response_code=${response%%:-*} +errormsg=${response#*:-} # Remove leading and trailing whitespace from errormsg errormsg=$(echo "${errormsg}" | tr -d '[:space:]') From 9e5f346636d344e2224b1f763820370450339006 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 2 Jul 2024 14:40:13 -0500 Subject: [PATCH 14/96] chore(dedicated): cleanup get-started/query --- .../cloud-dedicated/get-started/query.md | 100 ++++++++++-------- 1 file changed, 58 insertions(+), 42 deletions(-) diff --git a/content/influxdb/cloud-dedicated/get-started/query.md b/content/influxdb/cloud-dedicated/get-started/query.md index 522dced59..e87a7001a 100644 --- a/content/influxdb/cloud-dedicated/get-started/query.md +++ b/content/influxdb/cloud-dedicated/get-started/query.md @@ -35,8 +35,10 @@ the simplicity of SQL. {{% note %}} The examples in this section of the tutorial query the -[**get-started** database](/influxdb/cloud-dedicated/get-started/setup/#create-a-database) for data written in the -[Get started writing data](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) section. +[**get-started** database](/influxdb/cloud-dedicated/get-started/setup/#create-a-database) +for data written in the +[Get started writing data](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) +section. {{% /note %}} ## Tools to execute queries @@ -204,7 +206,7 @@ WHERE {{% note %}} Some examples in this getting started tutorial assume your InfluxDB -credentials (**URL**, and **token**) are provided by +credentials (**URL** and **token**) are provided by [environment variables](/influxdb/cloud-dedicated/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). {{% /note %}} @@ -233,18 +235,20 @@ Provide the following: {{% influxdb/custom-timestamps %}} {{% code-placeholders "get-started" %}} + ```sh influxctl query \ --database get-started \ --token $INFLUX_TOKEN \ "SELECT - * -FROM - home -WHERE - time >= '2022-01-01T08:00:00Z' - AND time <= '2022-01-01T20:00:00Z'" + * + FROM + home + WHERE + time >= '2022-01-01T08:00:00Z' + AND time <= '2022-01-01T20:00:00Z'" ``` + {{% /code-placeholders %}} {{% /influxdb/custom-timestamps %}} @@ -308,12 +312,12 @@ _If your project's virtual environment is already running, skip to step 3._ - ```sh - influx3 sql "SELECT * + ```sh + influx3 sql "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T20:00:00Z'" - ``` + ``` `influx3` displays query results in your terminal. @@ -348,7 +352,7 @@ _If your project's virtual environment is already running, skip to step 3._ python -m venv envs/virtual-env && . ./envs/virtual-env/bin/activate ``` - 3. Install the following dependencies: + 2. Install the following dependencies: {{< req type="key" text="Already installed in the [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Python#write-line-protocol-to-influxdb)" color="magenta" >}} @@ -364,7 +368,7 @@ _If your project's virtual environment is already running, skip to step 3._ pip install influxdb3-python pandas tabulate ``` - 4. In your terminal or editor, create a new file for your code--for example: `query.py`. + 3. In your terminal or editor, create a new file for your code--for example: `query.py`. 2. In `query.py`, enter the following sample code: @@ -403,10 +407,15 @@ _If your project's virtual environment is already running, skip to step 3._ {{< expand-wrapper >}} {{% expand "Important: If using **Windows**, specify the **Windows** certificate path" %}} - When instantiating the client, Python looks for SSL/TLS certificate authority (CA) certificates for verifying the server's authenticity. - If using a non-POSIX-compliant operating system (such as Windows), you need to specify a certificate bundle path that Python can access on your system. + When instantiating the client, Python looks for SSL/TLS certificate authority + (CA) certificates for verifying the server's authenticity. + If using a non-POSIX-compliant operating system (such as Windows), you need to + specify a certificate bundle path that Python can access on your system. - The following example shows how to use the [Python `certifi` package](https://certifiio.readthedocs.io/en/latest/) and client library options to provide a bundle of trusted certificates to the Python Flight client: + The following example shows how to use the + [Python `certifi` package](https://certifiio.readthedocs.io/en/latest/) and + client library options to provide a bundle of trusted certificates to the + Python Flight client: 1. In your terminal, install the Python `certifi` package. @@ -445,29 +454,31 @@ _If your project's virtual environment is already running, skip to step 3._ 2. Calls the `InfluxDBClient3()` constructor method with credentials to instantiate an InfluxDB `client` with the following credentials: - - **`host`**: {{% product-name omit=" Clustered" %}} cluster URL (without `https://` protocol or trailing slash) + - **`host`**: {{% product-name omit=" Clustered" %}} cluster URL + (without `https://` protocol or trailing slash) - **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) with read access to the specified database. - _Store this in a secret store or environment variable to avoid exposing the raw token string._ + _Store this in a secret store or environment variable to avoid exposing + the raw token string._ - **`database`**: the name of the {{% product-name %}} database to query - 3. Defines the SQL query to execute and assigns it to a `query` variable. + 1. Defines the SQL query to execute and assigns it to a `query` variable. - 4. Calls the `client.query()` method with the SQL query. + 2. Calls the `client.query()` method with the SQL query. `query()` sends a Flight request to InfluxDB, queries the database, retrieves result data from the endpoint, and then returns a [`pyarrow.Table`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table) assigned to the `table` variable. - 5. Calls the [`to_pandas()` method](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table.to_pandas) + 3. Calls the [`to_pandas()` method](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table.to_pandas) to convert the Arrow table to a [`pandas.DataFrame`](https://arrow.apache.org/docs/python/pandas.html). - 6. Calls the [`pandas.DataFrame.to_markdown()` method](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_markdown.html) + 4. Calls the [`pandas.DataFrame.to_markdown()` method](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_markdown.html) to convert the DataFrame to a markdown table. - 7. Calls the `print()` method to print the markdown table to stdout. + 5. Calls the `print()` method to print the markdown table to stdout. -2. Enter the following command to run the program and query your {{% product-name omit=" Clustered" %}} cluster: +1. Enter the following command to run the program and query your {{% product-name omit=" Clustered" %}} cluster: @@ -606,20 +617,25 @@ _If your project's virtual environment is already running, skip to step 3._ 2. Defines a `Query()` function that does the following: - 1. Instantiates `influx.Client` with InfluxDB credentials. + 1. Instantiates `influx.Client` with the following parameters for InfluxDB credentials: - **`Host`**: your {{% product-name omit=" Clustered" %}} cluster URL - - **`Database`**: The name of your {{% product-name %}} database + - **`Database`**: the name of your {{% product-name %}} database - **`Token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) with read permission on the specified database. - _Store this in a secret store or environment variable to avoid exposing the raw token string._ + _Store this in a secret store or environment variable to avoid + exposing the raw token string._ 2. Defines a deferred function to close the client after execution. 3. Defines a string variable for the SQL query. - 4. Calls the `influxdb3.Client.Query(sql string)` method and passes the SQL string to query InfluxDB. - `Query(sql string)` method returns an `iterator` for data in the response stream. - 5. Iterates over rows, formats the timestamp as an [RFC3339 timestamp](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp), and prints the data in table format to stdout. + 4. Calls the `influxdb3.Client.Query(sql string)` method and passes the + SQL string to query InfluxDB. + The `Query(sql string)` method returns an `iterator` for data in the + response stream. + 5. Iterates over rows, formats the timestamp as an + [RFC3339 timestamp](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp), + and prints the data in table format to stdout. 3. In your editor, open the `main.go` file you created in the [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Go#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: @@ -633,12 +649,13 @@ _If your project's virtual environment is already running, skip to step 3._ } ``` -4. In your terminal, enter the following command to install the necessary packages, build the module, and run the program: +4. In your terminal, enter the following command to install the necessary + packages, build the module, and run the program: ```sh - go mod tidy && go build && go run influxdb_go_client + go mod tidy && go run influxdb_go_client ``` The program executes the `main()` function that writes the data and prints the query results to the console. @@ -724,18 +741,19 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j - **`host`**: your {{% product-name omit=" Clustered" %}} cluster URL - **`token`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) with read permission on the database you want to query. - _Store this in a secret store or environment variable to avoid exposing the raw token string._ + _Store this in a secret store or environment variable to avoid exposing + the raw token string._ - 3. Defines a string variable (`sql`) for the SQL query. - 4. Defines an object (`data`) with column names for keys and array values for storing row data. - 5. Calls the `InfluxDBClient.query()` method with the following arguments: + 1. Defines a string variable (`sql`) for the SQL query. + 2. Defines an object (`data`) with column names for keys and array values for storing row data. + 3. Calls the `InfluxDBClient.query()` method with the following arguments: - **`sql`**: the query to execute - **`database`**: the name of the {{% product-name %}} database to query `query()` returns a stream of row vectors. - 6. Iterates over rows and adds the column data to the arrays in `data`. - 7. Passes `data` to the Arrow `tableFromArrays()` function to format the arrays as a table, and then passes the result to the `console.table()` method to output a highlighted table in the terminal. + 4. Iterates over rows and adds the column data to the arrays in `data`. + 5. Passes `data` to the Arrow `tableFromArrays()` function to format the arrays as a table, and then passes the result to the `console.table()` method to output a highlighted table in the terminal. 5. Inside of `index.mjs` (created in the [Write data section](/influxdb/cloud-dedicated/get-started/write/?t=Nodejs)), enter the following sample code to import the modules and call the functions: ```js @@ -756,7 +774,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j main(); ``` -9. In your terminal, execute `index.mjs` to write to and query {{% product-name %}}: +6. In your terminal, execute `index.mjs` to write to and query {{% product-name %}}: @@ -1029,8 +1047,6 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl **Linux/MacOS** - - ```sh export MAVEN_OPTS="--add-opens=java.base/java.nio=ALL-UNNAMED" ``` From 8f0e583cdc6e16023149bc7019de50e5ce7bd0d6 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 2 Jul 2024 22:21:05 -0500 Subject: [PATCH 15/96] fix(clustered): Clustered Telegraf config and example: - Mount a volume to store test project files generated in tests. - Allow URL and `url` in the linter - Set timestamp precision for Telegraf example - Fix Telegraf test, use Python to edit the TOML config file --- .ci/vale/styles/InfluxDataDocs/WordList.yml | 1 - .../vocabularies/InfluxDataDocs/accept.txt | 2 + .lintstagedrc.mjs | 8 + .../influxdb/clustered/get-started/write.md | 264 ++++++++++-------- test/src/requirements.txt | 1 + 5 files changed, 154 insertions(+), 122 deletions(-) diff --git a/.ci/vale/styles/InfluxDataDocs/WordList.yml b/.ci/vale/styles/InfluxDataDocs/WordList.yml index 59ab8922c..5582bd6ac 100644 --- a/.ci/vale/styles/InfluxDataDocs/WordList.yml +++ b/.ci/vale/styles/InfluxDataDocs/WordList.yml @@ -82,6 +82,5 @@ swap: tablename: table name tablet: device touch: tap - url: URL vs\.: versus World Wide Web: web diff --git a/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt index 5eb80d548..2d1e152a6 100644 --- a/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt +++ b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt @@ -72,6 +72,8 @@ quoteChar retentionRules sourceBucket tagKey +`url[s]?` +URL v2 v3 venv diff --git a/.lintstagedrc.mjs b/.lintstagedrc.mjs index c88b4ac20..31c075721 100644 --- a/.lintstagedrc.mjs +++ b/.lintstagedrc.mjs @@ -34,6 +34,13 @@ function pytestStagedContent(paths, productPath) { `docker build . -f Dockerfile.pytest -t influxdata-docs/pytest:latest`, + + + // Create a Docker volume for temporary files generated during testing + `sh -c "docker volume create \ + --label tag=influxdata-docs \ + --label stage=test \ + --name test-tmp || true"`, // Run test runners. // Uses a pytest plugin to suppress exit code 5 (if no tests are found), @@ -49,6 +56,7 @@ function pytestStagedContent(paths, productPath) { --env-file ${productPath}/.env.test \ --volumes-from ${CONTENT} \ --mount type=bind,src=./test/shared,dst=/shared \ + --mount type=volume,source=test-tmp,target=/app/iot-starter \ influxdata-docs/pytest --codeblocks --suppress-no-test-exit-code --exitfirst ${productPath}/`, ]; } diff --git a/content/influxdb/clustered/get-started/write.md b/content/influxdb/clustered/get-started/write.md index 7c6b31ef7..fa3150f9b 100644 --- a/content/influxdb/clustered/get-started/write.md +++ b/content/influxdb/clustered/get-started/write.md @@ -204,32 +204,32 @@ influxctl write \ --database get-started \ --token $INFLUX_TOKEN \ --precision s \ - 'home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 -home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 -home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 -home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 -home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 -home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 -home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 -home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 -home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 -home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 -home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 -home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 -home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 -home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 -home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 -home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 -home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 -home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 -home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 -home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 -home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 -home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 -home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 -home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 -home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 -home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200' + 'home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719734400 +home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719734400 +home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719738000 +home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719738000 +home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719741600 +home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719741600 +home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719745200 +home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719745200 +home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719748800 +home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719748800 +home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719752400 +home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719752400 +home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719756000 +home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719756000 +home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719759600 +home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719759600 +home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719763200 +home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719763200 +home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719766800 +home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719766800 +home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719770400 +home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719770400 +home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719774000 +home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719774000 +home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719777600 +home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719777600' ``` {{% /code-placeholders %}} @@ -258,47 +258,48 @@ and then write it to {{< product-name >}}. ```sh cat <<- EOF > home.lp - home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 - home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 - home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 - home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 - home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 - home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 - home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 - home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 - home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 - home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 - home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 - home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 - home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 - home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 - home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 - home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 - home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 - home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 - home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 - home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 - home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 - home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 - home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 - home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 - home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 - home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 + home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719820800 + home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719820800 + home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719824400 + home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719824400 + home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719828000 + home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719828000 + home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719831600 + home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719831600 + home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719835200 + home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719835200 + home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719838800 + home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719838800 + home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719842400 + home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719842400 + home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719846000 + home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719846000 + home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719849600 + home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719849600 + home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719853200 + home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719853200 + home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719856800 + home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719856800 + home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719860400 + home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719860400 + home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719864000 + home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719864000 EOF ``` 3. Run the following command to generate a Telegraf configuration file - (`./telegraf.conf`) that enables the `inputs.file` and `outputs.influxdb_v2` + (`telegraf.conf`) that enables the `inputs.file` and `outputs.influxdb_v2` plugins: ```sh - telegraf --sample-config \ + mkdir -p iot-project \ + && telegraf --sample-config \ --input-filter file \ --output-filter influxdb_v2 \ - > telegraf.conf + > iot-project/telegraf.conf ``` -4. In your editor, open `./telegraf.conf` and configure the following: +4. In your editor, open `iot-project/telegraf.conf` and configure the following: - **`file` input plugin**: In the `[[inputs.file]].files` list, replace `"/tmp/metrics.out"` with your sample data filename. If Telegraf can't @@ -309,12 +310,28 @@ and then write it to {{< product-name >}}. ## Files to parse each interval. Accept standard unix glob matching rules, ## as well as ** to match recursive files and directories. files = ["home.lp"] + # Set the timestamp precision to the precision in your data. + influx_timestamp_precision = '1s' + ## Optionally, use the newer, more efficient line protocol parser + influx_parser_type = 'upstream' ``` @@ -338,15 +355,20 @@ and then write it to {{< product-name >}}. ``` @@ -367,7 +389,7 @@ and then write it to {{< product-name >}}. Enter the following command in your terminal: ```sh - telegraf --once --config ./telegraf.conf + telegraf --once --config iot-project/telegraf.conf ``` If the write is successful, the output is similar to the following: @@ -445,32 +467,32 @@ response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ --header "Content-type: text/plain; charset=utf-8" \ --header "Accept: application/json" \ --data-binary " -home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 -home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 -home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 -home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 -home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 -home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 -home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 -home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 -home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 -home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 -home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 -home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 -home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 -home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 -home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 -home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 -home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 -home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 -home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 -home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 -home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 -home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 -home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 -home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 -home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 -home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 +home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719734400 +home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719734400 +home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719738000 +home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719738000 +home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719741600 +home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719741600 +home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719745200 +home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719745200 +home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719748800 +home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719748800 +home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719752400 +home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719752400 +home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719756000 +home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719756000 +home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719759600 +home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719759600 +home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719763200 +home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719763200 +home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719766800 +home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719766800 +home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719770400 +home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719770400 +home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719774000 +home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719774000 +home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719777600 +home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719777600 ") # Format the response code and error message output. @@ -556,32 +578,32 @@ response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ --header "Content-Type: text/plain; charset=utf-8" \ --header "Accept: application/json" \ --data-binary " -home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 -home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 -home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 -home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 -home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 -home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 -home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 -home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 -home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 -home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 -home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 -home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 -home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 -home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 -home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 -home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 -home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 -home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 -home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 -home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 -home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 -home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 -home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 -home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 -home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 -home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 +home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719734400 +home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719734400 +home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719738000 +home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719738000 +home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719741600 +home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719741600 +home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719745200 +home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719745200 +home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719748800 +home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719748800 +home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719752400 +home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719752400 +home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719756000 +home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719756000 +home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719759600 +home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719759600 +home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719763200 +home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719763200 +home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719766800 +home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719766800 +home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719770400 +home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719770400 +home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719774000 +home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719774000 +home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719777600 +home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719777600 ") # Format the response code and error message output. diff --git a/test/src/requirements.txt b/test/src/requirements.txt index 7d366d868..788173c44 100644 --- a/test/src/requirements.txt +++ b/test/src/requirements.txt @@ -7,6 +7,7 @@ pytest-dotenv>=0.5.2 # Allow pytest to pass if no tests (i.e. testable code blocks) are found. pytest-custom-exit-code>=0.3.0 requests>=2.26.0 +toml # Code sample dependencies influxdb3-python @ git+https://github.com/InfluxCommunity/influxdb3-python@v0.5.0 influxdb3-python-cli @ git+https://github.com/InfluxCommunity/influxdb3-python-cli@main From bb64ca32bba7d18d3d7ce32624ff8659674834a0 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 3 Jul 2024 09:38:20 -0500 Subject: [PATCH 16/96] fix(v3): duplicate word, test updates --- .lintstagedrc.mjs | 18 ++- CONTRIBUTING.md | 7 +- .../query-data/influxql/basic-query.md | 111 ++++++++++------- .../query-data/influxql/basic-query.md | 113 +++++++++++------- test/src/prepare-content.sh | 1 + 5 files changed, 158 insertions(+), 92 deletions(-) diff --git a/.lintstagedrc.mjs b/.lintstagedrc.mjs index 31c075721..fd6794abc 100644 --- a/.lintstagedrc.mjs +++ b/.lintstagedrc.mjs @@ -48,16 +48,14 @@ function pytestStagedContent(paths, productPath) { // Instead of the plugin, we could use a placeholder test that always or conditionally passes. // Whether tests pass or fail, the container is removed, // but the CONTENT container and associated volume will remain until the next run. - // Note: the docker run -t flag is required to allocate a pseudo-TTY for the container--required for opening influxctl OAuth URLs. - `docker run --rm -t \ - --label tag=influxdata-docs \ - --label stage=test \ - --name ${TEST} \ - --env-file ${productPath}/.env.test \ - --volumes-from ${CONTENT} \ - --mount type=bind,src=./test/shared,dst=/shared \ - --mount type=volume,source=test-tmp,target=/app/iot-starter \ - influxdata-docs/pytest --codeblocks --suppress-no-test-exit-code --exitfirst ${productPath}/`, + // Note: TTY is required for the container to open influxctl OAuth URLs in the host browser. + `docker run --tty=true --label tag=influxdata-docs --label stage=test \ + --name ${TEST} \ + --env-file ${productPath}/.env.test \ + --volumes-from ${CONTENT} \ + --mount type=bind,src=./test/shared,dst=/shared \ + --mount type=volume,source=test-tmp,target=/app/iot-starter \ + influxdata-docs/pytest --codeblocks --suppress-no-test-exit-code --exitfirst ${productPath}/`, ]; } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b93ebb0a..031707ba1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,12 +77,17 @@ scripts configured in `.husky/pre-commit`, including linting and tests for your **We strongly recommend running linting and tests**, but you can skip them (and avoid installing dependencies) -by including the `--no-verify` flag with your commit--for example, enter the following command in your terminal: +by including the `HUSKY=0` environment variable or the `--no-verify` flag with +your commit--for example: ```sh git commit -m "" --no-verify ``` +```sh +HUSKY=0 git commit +``` + For more options, see the [Husky documentation](https://typicode.github.io/husky/how-to.html#skipping-git-hooks). ### Set up test scripts and credentials diff --git a/content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md b/content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md index 1b6a1b779..13f1611aa 100644 --- a/content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md +++ b/content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md @@ -25,20 +25,29 @@ following clauses: {{< req type="key" >}} -- {{< req "\*">}} `SELECT`: Specify fields, tags, and calculations to return from a - measurement or use the wildcard alias (`*`) to select all fields and tags - from a measurement. It requires at least one - [field key](/influxdb/cloud-dedicated/reference/glossary/#field-key) or the wildcard alias (`*`). - For more information, see [Notable SELECT statement behaviors](/influxdb/cloud-dedicated/reference/influxql/select/#notable-select-statement-behaviors). -- {{< req "\*">}} `FROM`: Specify the [measurement](/influxdb/cloud-dedicated/reference/glossary/#measurement) to query from. -It requires one or more comma-delimited [measurement expressions](/influxdb/cloud-dedicated/reference/influxql/select/#measurement_expression). +- {{< req "\*">}} `SELECT`: Specify fields, tags, and calculations to return + from a [table](/influxdb/cloud-dedicated/reference/glossary/#table) or use the + wildcard alias (`*`) to select all fields and tags from a table. It requires + at least one + [field key](/influxdb/cloud-dedicated/reference/glossary/#field-key) or the + wildcard alias (`*`). For more information, see + [Notable SELECT statement behaviors](/influxdb/cloud-dedicated/reference/influxql/select/#notable-select-statement-behaviors). +- {{< req "\*">}} `FROM`: Specify the + [table](/influxdb/cloud-dedicated/reference/glossary/#table) to query from. + + It requires one or more comma-delimited + [measurement expressions](/influxdb/cloud-dedicated/reference/influxql/select/#measurement_expression). + - `WHERE`: Filter data based on -[field values](/influxdb/cloud-dedicated/reference/glossary/#field), -[tag values](/influxdb/cloud-dedicated/reference/glossary/#tag), or -[timestamps](/influxdb/cloud-dedicated/reference/glossary/#timestamp). Only return data that meets the specified conditions--for example, falls within - a time range, contains specific tag values, or contains a field value outside a specified range. + [field values](/influxdb/cloud-dedicated/reference/glossary/#field), + [tag values](/influxdb/cloud-dedicated/reference/glossary/#tag), or + [timestamps](/influxdb/cloud-dedicated/reference/glossary/#timestamp). Only + return data that meets the specified conditions--for example, falls within a + time range, contains specific tag values, or contains a field value outside a + specified range. {{% influxdb/custom-timestamps %}} + ```sql SELECT temp, @@ -49,21 +58,28 @@ WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T20:00:00Z' ``` + {{% /influxdb/custom-timestamps %}} ## Result set -If at least one row satisfies the query, {{% product-name %}} returns row data in the query result set. -If a query uses a `GROUP BY` clause, the result set includes the following: +If at least one row satisfies the query, {{% product-name %}} returns row data +in the query result set. +If a query uses a `GROUP BY` clause, the result set +includes the following: - Columns listed in the query's `SELECT` clause - A `time` column that contains the timestamp for the record or the group -- An `iox::measurement` column that contains the record's measurement (table) name -- Columns listed in the query's `GROUP BY` clause; each row in the result set contains the values used for grouping +- An `iox::measurement` column that contains the record's + [table](/influxdb/cloud-dedicated/reference/glossary/#table) name +- Columns listed in the query's `GROUP BY` clause; each row in the result set + contains the values used for grouping ### GROUP BY result columns -If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then groups are based on the [default time range](/influxdb/cloud-dedicated/reference/influxql/group-by/#default-time-range). +If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then +groups are based on the +[default time range](/influxdb/cloud-dedicated/reference/influxql/group-by/#default-time-range). ## Basic query examples @@ -75,9 +91,10 @@ If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then g - [Alias queried fields and tags](#alias-queried-fields-and-tags) {{% note %}} + #### Sample data -The following examples use the +The following examples use the [Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, [write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) @@ -89,12 +106,14 @@ to your {{% product-name %}} database before running the example queries. - Use the `SELECT` clause to specify what tags and fields to return. Specify at least one field key. To return all tags and fields, use the wildcard alias (`*`). -- Specify the measurement to query in the `FROM` clause. -- Specify time boundaries in the `WHERE` clause. - Include time-based predicates that compare the value of the `time` column to a timestamp. +- Specify the [table](/influxdb/cloud-dedicated/reference/glossary/#table) to + query in the `FROM` clause. +- Specify time boundaries in the `WHERE` clause. Include time-based predicates + that compare the value of the `time` column to a timestamp. Use the `AND` logical operator to chain multiple predicates together. {{% influxdb/custom-timestamps %}} + ```sql SELECT * FROM home @@ -102,13 +121,13 @@ WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T12:00:00Z' ``` + {{% /influxdb/custom-timestamps %}} Query time boundaries can be relative or absolute. {{< expand-wrapper >}} {{% expand "Query with relative time boundaries" %}} - To query data from relative time boundaries, compare the value of the `time` column to a timestamp calculated by subtracting an interval from a timestamp. Use `now()` to return the timestamp for the current time (UTC). @@ -119,7 +138,7 @@ Use `now()` to return the timestamp for the current time (UTC). SELECT * FROM home WHERE time >= now() - 30d ``` -##### Query one day of data data from a week ago +##### Query one day of data from a week ago ```sql SELECT * @@ -128,16 +147,18 @@ WHERE time >= now() - 7d AND time <= now() - 6d ``` + {{% /expand %}} {{% expand "Query with absolute time boundaries" %}} -To query data from absolute time boundaries, compare the value of the `time` column -to a timestamp literal. -Use the `AND` logical operator to chain together multiple predicates and define -both start and stop boundaries for the query. +To query data from absolute time boundaries, compare the value of the `time` +column to a timestamp literal. +Use the `AND` logical operator to chain together +multiple predicates and define both start and stop boundaries for the query. {{% influxdb/custom-timestamps %}} + ```sql SELECT * @@ -147,6 +168,7 @@ WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T20:00:00Z' ``` + {{% /influxdb/custom-timestamps %}} {{% /expand %}} @@ -156,8 +178,8 @@ WHERE To query data without time boundaries, do not include any time-based predicates in your `WHERE` clause. -If a time range is not defined in the `WHERE` clause, the default time range is -the Unix epoch (`1970-01-01T00:00:00Z`) to _now_. +If a time range is not defined in the `WHERE` clause, +the default time range is the Unix epoch (`1970-01-01T00:00:00Z`) to _now_. {{% warn %}} Querying data _without time bounds_ can return an unexpected amount of data. @@ -172,8 +194,8 @@ SELECT * FROM home To query specific fields, include them in the `SELECT` clause. If querying multiple fields or tags, comma-delimit each. -If a field or tag key includes special characters or spaces or is case-sensitive, -wrap the key in _double-quotes_. +If a field or tag key includes special characters or spaces or is +case-sensitive, wrap the key in _double-quotes_. ```sql SELECT time, room, temp, hum FROM home @@ -181,10 +203,12 @@ SELECT time, room, temp, hum FROM home ### Query fields based on tag values -- In the `SELECT` clause, include fields you want to query and tags you want to base conditions on. -- In the `WHERE` clause, include predicates that compare the tag identifier to a string literal. - Use [logical operators](/influxdb/cloud-dedicated/reference/influxql/where/#logical-operators) to chain multiple predicates together and apply - multiple conditions. +- In the `SELECT` clause, include fields you want to query and tags you want to + base conditions on. +- In the `WHERE` clause, include predicates that compare the tag identifier to a + string literal. Use + [logical operators](/influxdb/cloud-dedicated/reference/influxql/where/#logical-operators) + to chain multiple predicates together and apply multiple conditions. ```sql SELECT * FROM home WHERE room = 'Kitchen' @@ -193,9 +217,12 @@ SELECT * FROM home WHERE room = 'Kitchen' ### Query points based on field values - In the `SELECT` clause, include fields you want to query. -- In the `WHERE` clause, include predicates that compare the field identifier to a value or expression. - Use [logical operators](/influxdb/cloud-dedicated/reference/influxql/where/#logical-operators) (`AND`, `OR`) to chain multiple predicates together - and apply multiple conditions. +- In the `WHERE` clause, include predicates that compare the field identifier to + a value or expression. + Use + [logical operators](/influxdb/cloud-dedicated/reference/influxql/where/#logical-operators) + (`AND`, `OR`) to chain multiple predicates together and apply multiple + conditions. ```sql SELECT co, time FROM home WHERE co >= 10 OR co <= -10 @@ -204,13 +231,17 @@ SELECT co, time FROM home WHERE co >= 10 OR co <= -10 ### Alias queried fields and tags To alias or rename fields and tags that you query, use the `AS` clause. -After the tag, field, or expression you want to alias, pass `AS` followed by the alias name as an identifier (wrap in double quotes (`"`) if the alias includes spaces or special characters)--for example: +After the tag, field, or expression you want to alias, pass `AS` followed by the +alias name as an identifier (wrap in double quotes (`"`) if the alias includes +spaces or special characters)--for example: ```sql SELECT temp AS temperature, hum AS "humidity (%)" FROM home ``` {{% note %}} -When aliasing columns in **InfluxQL**, use the `AS` clause and an [identifier](/influxdb/cloud-dedicated/reference/influxql/#identifiers). -When [aliasing columns in **SQL**](/influxdb/cloud-dedicated/query-data/sql/basic-query/#alias-queried-fields-and-tags), you can use the `AS` clause to define the alias, but it isn't necessary. +When aliasing columns in **InfluxQL**, use the `AS` clause and an +[identifier](/influxdb/cloud-dedicated/reference/influxql/#identifiers). When +[aliasing columns in **SQL**](/influxdb/cloud-dedicated/query-data/sql/basic-query/#alias-queried-fields-and-tags), +you can use the `AS` clause to define the alias, but it isn't necessary. {{% /note %}} diff --git a/content/influxdb/clustered/query-data/influxql/basic-query.md b/content/influxdb/clustered/query-data/influxql/basic-query.md index d4126cce1..db9d336a8 100644 --- a/content/influxdb/clustered/query-data/influxql/basic-query.md +++ b/content/influxdb/clustered/query-data/influxql/basic-query.md @@ -25,20 +25,29 @@ following clauses: {{< req type="key" >}} -- {{< req "\*">}} `SELECT`: Specify fields, tags, and calculations to return from a - measurement or use the wildcard alias (`*`) to select all fields and tags - from a measurement. It requires at least one - [field key](/influxdb/clustered/reference/glossary/#field-key) or the wildcard alias (`*`). - For more information, see [Notable SELECT statement behaviors](/influxdb/clustered/reference/influxql/select/#notable-select-statement-behaviors). -- {{< req "\*">}} `FROM`: Specify the [measurement](/influxdb/clustered/reference/glossary/#measurement) to query from. -It requires one or more comma-delimited [measurement expressions](/influxdb/clustered/reference/influxql/select/#measurement_expression). +- {{< req "\*">}} `SELECT`: Specify fields, tags, and calculations to return + from a [table](/influxdb/clustered/reference/glossary/#table) or use the + wildcard alias (`*`) to select all fields and tags from a table. It requires + at least one + [field key](/influxdb/clustered/reference/glossary/#field-key) or the + wildcard alias (`*`). For more information, see + [Notable SELECT statement behaviors](/influxdb/clustered/reference/influxql/select/#notable-select-statement-behaviors). +- {{< req "\*">}} `FROM`: Specify the + [table](/influxdb/clustered/reference/glossary/#table) to query from. + + It requires one or more comma-delimited + [measurement expressions](/influxdb/clustered/reference/influxql/select/#measurement_expression). + - `WHERE`: Filter data based on -[field values](/influxdb/clustered/reference/glossary/#field), -[tag values](/influxdb/clustered/reference/glossary/#tag), or -[timestamps](/influxdb/clustered/reference/glossary/#timestamp). Only return data that meets the specified conditions--for example, falls within - a time range, contains specific tag values, or contains a field value outside a specified range. + [field values](/influxdb/clustered/reference/glossary/#field), + [tag values](/influxdb/clustered/reference/glossary/#tag), or + [timestamps](/influxdb/clustered/reference/glossary/#timestamp). Only + return data that meets the specified conditions--for example, falls within a + time range, contains specific tag values, or contains a field value outside a + specified range. {{% influxdb/custom-timestamps %}} + ```sql SELECT temp, @@ -49,21 +58,28 @@ WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T20:00:00Z' ``` + {{% /influxdb/custom-timestamps %}} ## Result set -If at least one row satisfies the query, {{% product-name %}} returns row data in the query result set. -If a query uses a `GROUP BY` clause, the result set includes the following: +If at least one row satisfies the query, {{% product-name %}} returns row data +in the query result set. +If a query uses a `GROUP BY` clause, the result set +includes the following: - Columns listed in the query's `SELECT` clause - A `time` column that contains the timestamp for the record or the group -- An `iox::measurement` column that contains the record's measurement (table) name -- Columns listed in the query's `GROUP BY` clause; each row in the result set contains the values used for grouping +- An `iox::measurement` column that contains the record's + [table](/influxdb/clustered/reference/glossary/#table) name +- Columns listed in the query's `GROUP BY` clause; each row in the result set + contains the values used for grouping ### GROUP BY result columns -If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then groups are based on the [default time range](/influxdb/clustered/reference/influxql/group-by/#default-time-range). +If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then +groups are based on the +[default time range](/influxdb/clustered/reference/influxql/group-by/#default-time-range). ## Basic query examples @@ -75,9 +91,10 @@ If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then g - [Alias queried fields and tags](#alias-queried-fields-and-tags) {{% note %}} + #### Sample data -The following examples use the +The following examples use the [Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data). To run the example queries and return results, [write the sample data](/influxdb/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) @@ -89,12 +106,14 @@ to your {{% product-name %}} database before running the example queries. - Use the `SELECT` clause to specify what tags and fields to return. Specify at least one field key. To return all tags and fields, use the wildcard alias (`*`). -- Specify the measurement to query in the `FROM` clause. -- Specify time boundaries in the `WHERE` clause. - Include time-based predicates that compare the value of the `time` column to a timestamp. +- Specify the [table](/influxdb/clustered/reference/glossary/#table) to + query in the `FROM` clause. +- Specify time boundaries in the `WHERE` clause. Include time-based predicates + that compare the value of the `time` column to a timestamp. Use the `AND` logical operator to chain multiple predicates together. {{% influxdb/custom-timestamps %}} + ```sql SELECT * FROM home @@ -102,6 +121,7 @@ WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T12:00:00Z' ``` + {{% /influxdb/custom-timestamps %}} Query time boundaries can be relative or absolute. @@ -119,7 +139,8 @@ Use `now()` to return the timestamp for the current time (UTC). SELECT * FROM home WHERE time >= now() - 30d ``` -##### Query one day of data data from a week ago +##### Query one day of data from a week ago + ```sql SELECT * FROM home @@ -127,16 +148,18 @@ WHERE time >= now() - 7d AND time <= now() - 6d ``` + {{% /expand %}} {{% expand "Query with absolute time boundaries" %}} -To query data from absolute time boundaries, compare the value of the `time` column -to a timestamp literal. -Use the `AND` logical operator to chain together multiple predicates and define -both start and stop boundaries for the query. +To query data from absolute time boundaries, compare the value of the `time` +column to a timestamp literal. +Use the `AND` logical operator to chain together +multiple predicates and define both start and stop boundaries for the query. {{% influxdb/custom-timestamps %}} + ```sql SELECT * @@ -146,6 +169,7 @@ WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T20:00:00Z' ``` + {{% /influxdb/custom-timestamps %}} {{% /expand %}} @@ -155,8 +179,8 @@ WHERE To query data without time boundaries, do not include any time-based predicates in your `WHERE` clause. -If a time range is not defined in the `WHERE` clause, the default time range is -the Unix epoch (`1970-01-01T00:00:00Z`) to _now_. +If a time range is not defined in the `WHERE` clause, +the default time range is the Unix epoch (`1970-01-01T00:00:00Z`) to _now_. {{% warn %}} Querying data _without time bounds_ can return an unexpected amount of data. @@ -171,8 +195,8 @@ SELECT * FROM home To query specific fields, include them in the `SELECT` clause. If querying multiple fields or tags, comma-delimit each. -If a field or tag key includes special characters or spaces or is case-sensitive, -wrap the key in _double-quotes_. +If a field or tag key includes special characters or spaces or is +case-sensitive, wrap the key in _double-quotes_. ```sql SELECT time, room, temp, hum FROM home @@ -180,10 +204,12 @@ SELECT time, room, temp, hum FROM home ### Query fields based on tag values -- In the `SELECT` clause, include fields you want to query and tags you want to base conditions on. -- In the `WHERE` clause, include predicates that compare the tag identifier to a string literal. - Use [logical operators](/influxdb/clustered/reference/influxql/where/#logical-operators) to chain multiple predicates together and apply - multiple conditions. +- In the `SELECT` clause, include fields you want to query and tags you want to + base conditions on. +- In the `WHERE` clause, include predicates that compare the tag identifier to a + string literal. Use + [logical operators](/influxdb/clustered/reference/influxql/where/#logical-operators) + to chain multiple predicates together and apply multiple conditions. ```sql SELECT * FROM home WHERE room = 'Kitchen' @@ -192,9 +218,12 @@ SELECT * FROM home WHERE room = 'Kitchen' ### Query points based on field values - In the `SELECT` clause, include fields you want to query. -- In the `WHERE` clause, include predicates that compare the field identifier to a value or expression. - Use [logical operators](/influxdb/clustered/reference/influxql/where/#logical-operators) (`AND`, `OR`) to chain multiple predicates together - and apply multiple conditions. +- In the `WHERE` clause, include predicates that compare the field identifier to + a value or expression. + Use + [logical operators](/influxdb/clustered/reference/influxql/where/#logical-operators) + (`AND`, `OR`) to chain multiple predicates together and apply multiple + conditions. ```sql SELECT co, time FROM home WHERE co >= 10 OR co <= -10 @@ -203,15 +232,17 @@ SELECT co, time FROM home WHERE co >= 10 OR co <= -10 ### Alias queried fields and tags To alias or rename fields and tags that you query, use the `AS` clause. -After the tag, field, or expression you want to alias, pass `AS` followed by the alias name as an identifier (wrap in double quotes (`"`) if the alias includes spaces or special characters)--for example: +After the tag, field, or expression you want to alias, pass `AS` followed by the +alias name as an identifier (wrap in double quotes (`"`) if the alias includes +spaces or special characters)--for example: ```sql SELECT temp AS temperature, hum AS "humidity (%)" FROM home ``` {{% note %}} -When aliasing columns in **InfluxQL**, use the `AS` clause and an [identifier](/influxdb/clustered/reference/influxql/#identifiers). -When [aliasing columns in **SQL**](/influxdb/clustered/query-data/sql/basic-query/#alias-queried-fields-and-tags), you can use the `AS` clause to define the alias, but it isn't necessary. +When aliasing columns in **InfluxQL**, use the `AS` clause and an +[identifier](/influxdb/clustered/reference/influxql/#identifiers). When +[aliasing columns in **SQL**](/influxdb/clustered/query-data/sql/basic-query/#alias-queried-fields-and-tags), +you can use the `AS` clause to define the alias, but it isn't necessary. {{% /note %}} - - diff --git a/test/src/prepare-content.sh b/test/src/prepare-content.sh index a41d4b6d4..42ed5dfe9 100644 --- a/test/src/prepare-content.sh +++ b/test/src/prepare-content.sh @@ -52,6 +52,7 @@ function substitute_placeholders { /os.getenv("DATABASE_TOKEN")/! s/DATABASE_TOKEN/$INFLUX_TOKEN/g; /os.getenv("DATABASE_NAME")/! s/DATABASE_NAME/$INFLUX_DATABASE/g; s/--id DBRP_ID/--id $INFLUX_DBRP_ID/g; + s/example-db/$INFLUX_DATABASE/g; s/get-started/$INFLUX_DATABASE/g; /os.getenv("MANAGEMENT_TOKEN")/! s/MANAGEMENT_TOKEN/$MANAGEMENT_TOKEN/g; /os.getenv("ORG_ID")/! s/ORG_ID/$INFLUX_ORG/g; From 4e601710b1fc73559f970b2b4bdfbe9c6e935a78 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 3 Jul 2024 13:23:57 -0500 Subject: [PATCH 17/96] chore(ci): Adjusts Unix timestamps (line protocol) and query time bounds for testing - Adjusts times for writing and querying data within a recent retention period. - Adjusts Unix timestamps (in line protocol samples) to yesterday's date. - Adjusts UTC time bounds (in queries) to today and yesterday. - Reverts mistakenly changed timestamps in clustered. --- .../cloud-dedicated/get-started/query.md | 48 ++++ .../influxdb/clustered/get-started/query.md | 78 +++++-- .../influxdb/clustered/get-started/write.md | 208 +++++++++--------- test/src/prepare-content.sh | 41 +++- 4 files changed, 253 insertions(+), 122 deletions(-) diff --git a/content/influxdb/cloud-dedicated/get-started/query.md b/content/influxdb/cloud-dedicated/get-started/query.md index e87a7001a..a3437de27 100644 --- a/content/influxdb/cloud-dedicated/get-started/query.md +++ b/content/influxdb/cloud-dedicated/get-started/query.md @@ -204,6 +204,44 @@ WHERE ``` {{% /influxdb/custom-timestamps %}} + + {{% note %}} Some examples in this getting started tutorial assume your InfluxDB credentials (**URL** and **token**) are provided by @@ -252,6 +290,16 @@ influxctl query \ {{% /code-placeholders %}} {{% /influxdb/custom-timestamps %}} +{{% note %}} +#### Query using stored credentials + +Optionally, you can configure `database` and `token` query credentials in your `influxctl` +[connection profile](/influxdb/clustered/reference/cli/influxctl/#create-a-configuration-file). + +The `--database` and `--token` command line flags override credentials in your +configuration file. +{{% /note %}} + {{% /tab-content %}} {{% tab-content %}} diff --git a/content/influxdb/clustered/get-started/query.md b/content/influxdb/clustered/get-started/query.md index 0f704a444..530c5551a 100644 --- a/content/influxdb/clustered/get-started/query.md +++ b/content/influxdb/clustered/get-started/query.md @@ -35,8 +35,10 @@ the simplicity of SQL. {{% note %}} The examples in this section of the tutorial query the -[**get-started** database](/influxdb/clustered/get-started/setup/#create-a-database) for data written in the -[Get started writing data](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb) section. +[**get-started** database](/influxdb/clustered/get-started/setup/#create-a-database) +for data written in the +[Get started writing data](/influxdb/clustered/get-started/write/#write-line-protocol-to-influxdb) +section. {{% /note %}} ## Tools to execute queries @@ -202,6 +204,44 @@ WHERE ``` {{% /influxdb/custom-timestamps %}} + + {{% note %}} Some examples in this getting started tutorial assume your InfluxDB credentials (**URL** and **token**) are provided by @@ -233,21 +273,33 @@ Provide the following: {{% influxdb/custom-timestamps %}} {{% code-placeholders "get-started" %}} + ```sh influxctl query \ --database get-started \ --token $INFLUX_TOKEN \ "SELECT - * -FROM - home -WHERE - time >= '2022-01-01T08:00:00Z' - AND time <= '2022-01-01T20:00:00Z'" + * + FROM + home + WHERE + time >= '2022-01-01T08:00:00Z' + AND time <= '2022-01-01T20:00:00Z'" ``` + {{% /code-placeholders %}} {{% /influxdb/custom-timestamps %}} +{{% note %}} +#### Query using stored credentials + +Optionally, you can configure `database` and `token` query credentials in your `influxctl` +[connection profile](/influxdb/clustered/reference/cli/influxctl/#create-a-configuration-file). + +The `--database` and `--token` command line flags override credentials in your +configuration file. +{{% /note %}} + {{% /tab-content %}} {{% tab-content %}} @@ -308,12 +360,12 @@ _If your project's virtual environment is already running, skip to step 3._ - ```sh - influx3 sql "SELECT * + ```sh + influx3 sql "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z' AND time <= '2022-01-01T20:00:00Z'" - ``` + ``` `influx3` displays query results in your terminal. @@ -606,7 +658,7 @@ _If your project's virtual environment is already running, skip to step 3._ 2. Defines a `Query()` function that does the following: - 1. Instantiates `influx.Client` with InfluxDB credentials. + 1. Instantiates `influx.Client` with the following parameters for InfluxDB credentials: - **`Host`**: your {{% product-name omit=" Clustered" %}} cluster URL - **`Database`**: the name of your {{% product-name %}} database @@ -637,7 +689,7 @@ _If your project's virtual environment is already running, skip to step 3._ ```sh - go mod tidy && go build && go run influxdb_go_client + go mod tidy && go run influxdb_go_client ``` The program executes the `main()` function that writes the data and prints the query results to the console. diff --git a/content/influxdb/clustered/get-started/write.md b/content/influxdb/clustered/get-started/write.md index fa3150f9b..18dd81f20 100644 --- a/content/influxdb/clustered/get-started/write.md +++ b/content/influxdb/clustered/get-started/write.md @@ -204,32 +204,32 @@ influxctl write \ --database get-started \ --token $INFLUX_TOKEN \ --precision s \ - 'home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719734400 -home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719734400 -home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719738000 -home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719738000 -home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719741600 -home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719741600 -home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719745200 -home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719745200 -home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719748800 -home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719748800 -home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719752400 -home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719752400 -home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719756000 -home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719756000 -home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719759600 -home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719759600 -home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719763200 -home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719763200 -home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719766800 -home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719766800 -home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719770400 -home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719770400 -home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719774000 -home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719774000 -home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719777600 -home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719777600' + 'home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 +home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 +home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 +home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 +home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 +home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 +home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 +home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 +home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 +home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 +home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 +home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 +home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 +home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 +home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 +home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 +home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 +home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 +home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 +home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 +home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 +home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 +home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 +home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 +home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 +home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200' ``` {{% /code-placeholders %}} @@ -258,32 +258,32 @@ and then write it to {{< product-name >}}. ```sh cat <<- EOF > home.lp - home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719820800 - home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719820800 - home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719824400 - home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719824400 - home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719828000 - home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719828000 - home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719831600 - home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719831600 - home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719835200 - home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719835200 - home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719838800 - home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719838800 - home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719842400 - home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719842400 - home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719846000 - home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719846000 - home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719849600 - home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719849600 - home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719853200 - home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719853200 - home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719856800 - home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719856800 - home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719860400 - home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719860400 - home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719864000 - home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719864000 + home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 + home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 + home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 + home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 + home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 + home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 + home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 + home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 + home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 + home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 + home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 + home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 + home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 + home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 + home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 + home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 + home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 + home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 + home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 + home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 + home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 + home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 + home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 + home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 + home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 + home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 EOF ``` @@ -467,32 +467,32 @@ response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ --header "Content-type: text/plain; charset=utf-8" \ --header "Accept: application/json" \ --data-binary " -home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719734400 -home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719734400 -home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719738000 -home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719738000 -home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719741600 -home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719741600 -home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719745200 -home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719745200 -home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719748800 -home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719748800 -home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719752400 -home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719752400 -home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719756000 -home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719756000 -home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719759600 -home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719759600 -home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719763200 -home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719763200 -home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719766800 -home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719766800 -home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719770400 -home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719770400 -home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719774000 -home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719774000 -home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719777600 -home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719777600 +home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 +home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 +home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 +home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 +home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 +home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 +home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 +home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 +home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 +home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 +home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 +home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 +home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 +home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 +home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 +home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 +home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 +home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 +home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 +home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 +home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 +home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 +home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 +home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 +home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 +home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 ") # Format the response code and error message output. @@ -578,32 +578,32 @@ response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ --header "Content-Type: text/plain; charset=utf-8" \ --header "Accept: application/json" \ --data-binary " -home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1719734400 -home,room=Kitchen temp=21.0,hum=35.9,co=0i 1719734400 -home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1719738000 -home,room=Kitchen temp=23.0,hum=36.2,co=0i 1719738000 -home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1719741600 -home,room=Kitchen temp=22.7,hum=36.1,co=0i 1719741600 -home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1719745200 -home,room=Kitchen temp=22.4,hum=36.0,co=0i 1719745200 -home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1719748800 -home,room=Kitchen temp=22.5,hum=36.0,co=0i 1719748800 -home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1719752400 -home,room=Kitchen temp=22.8,hum=36.5,co=1i 1719752400 -home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1719756000 -home,room=Kitchen temp=22.8,hum=36.3,co=1i 1719756000 -home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1719759600 -home,room=Kitchen temp=22.7,hum=36.2,co=3i 1719759600 -home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1719763200 -home,room=Kitchen temp=22.4,hum=36.0,co=7i 1719763200 -home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1719766800 -home,room=Kitchen temp=22.7,hum=36.0,co=9i 1719766800 -home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1719770400 -home,room=Kitchen temp=23.3,hum=36.9,co=18i 1719770400 -home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1719774000 -home,room=Kitchen temp=23.1,hum=36.6,co=22i 1719774000 -home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1719777600 -home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719777600 +home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 +home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 +home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 +home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 +home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200 +home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200 +home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800 +home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800 +home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400 +home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400 +home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000 +home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000 +home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600 +home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600 +home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200 +home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200 +home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800 +home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800 +home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400 +home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400 +home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000 +home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000 +home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600 +home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600 +home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 +home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 ") # Format the response code and error message output. diff --git a/test/src/prepare-content.sh b/test/src/prepare-content.sh index 42ed5dfe9..4da6fa345 100644 --- a/test/src/prepare-content.sh +++ b/test/src/prepare-content.sh @@ -5,6 +5,12 @@ TEST_CONTENT="/app/content" +# Pattern to match a 10-digit Unix timestamp +TIMESTAMP_PATTERN='[0-9]{10}' + +NOW=$(date -u +"%Y-%m-%dT%H:%M:%SZ") +YESTERDAY=$(date -u -d 'yesterday 00:00' '+%Y-%m-%dT%H:%M:%SZ') + function substitute_placeholders { for file in `find "$TEST_CONTENT" -type f \( -iname '*.md' \)`; do if [ -f "$file" ]; then @@ -12,9 +18,37 @@ function substitute_placeholders { # Replaces placeholder values with environment variable references. + # Date-specific replacements. + + grep -oE "$TIMESTAMP_PATTERN" "$file" | while read -r timestamp; do + # Replace Unix timestamps (for example, in line protocol sample data) with yesterday's date. + # Assuming the Unix timestamp is the whole line or a standalone word in the line + # Validate the extracted timestamp (optional) + if [[ $timestamp =~ ^1641[0-9]{6,12}$ ]]; then + specific_timestamp=$timestamp + + # Extract the time part + specific_time=$(date -u -d "@$specific_timestamp" '+%T') + + # Calculate 'yesterday' date but use 'specific_time' for the time part + yesterday_date=$(date -u -d 'yesterday' '+%Y-%m-%d') + yesterday_datetime="$yesterday_date"T"$specific_time"Z + + # Convert 'yesterday_datetime' to Unix timestamp + yesterday_timestamp=$(date -u -d "$yesterday_datetime" +%s) + + # Replace the extracted timestamp with `yesterday_timestamp` + sed -i "s|$specific_timestamp|$yesterday_timestamp|g;" $file + fi + done + + ## Adjust time bounds in queries to be the current time and yesterday. + sed -i "s|'2022-01-01T20:00:00Z'|'$NOW'|g; + s|'2022-01-01T08:00:00Z'|'$YESTERDAY'|g; + " $file + # Non-language-specific replacements. - sed -i 's|https:\/\/{{< influxdb/host >}}|$INFLUX_HOST|g; - ' $file + sed -i 's|https:\/\/{{< influxdb/host >}}|$INFLUX_HOST|g;' $file # Python-specific replacements. # Use f-strings to identify placeholders in Python while also keeping valid syntax if @@ -38,9 +72,6 @@ function substitute_placeholders { s|"name": "BUCKET_NAME"|"name": "$INFLUX_DATABASE"|g;' \ $file - sed -i 's|"influxctl database create --retention-period 1y get-started"|"influxctl database create --retention-period 1y $INFLUX_TMP_DATABASE"|g;' \ - $file - # Replace remaining placeholders with variables. # If the placeholder is inside of a Python os.getenv() function, don't replace it. # Note the specific use of double quotes for the os.getenv() arguments here. You'll need to use double quotes in your code samples for this to match. From a8a772264cb49a8ad35a122e40a2c2f107c08bdf Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 3 Jul 2024 13:50:27 -0500 Subject: [PATCH 18/96] chore(ci): Skip tests for deleting databases. --- .../reference/cli/influxctl/database/delete.md | 9 +++++++++ .../clustered/reference/cli/influxctl/database/delete.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/database/delete.md b/content/influxdb/cloud-dedicated/reference/cli/influxctl/database/delete.md index 98b8e7f4e..e93f454d0 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/database/delete.md +++ b/content/influxdb/cloud-dedicated/reference/cli/influxctl/database/delete.md @@ -14,6 +14,9 @@ Cloud Dedicated cluster. ## Usage + + + ```sh influxctl database delete [command options] [--force] [...] ``` @@ -50,12 +53,18 @@ _Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/inf ##### Delete a database named "mydb" + + + ```sh influxctl database delete mydb ``` ##### Delete multiple databases + + + ```sh influxctl database delete mydb1 mydb2 ``` diff --git a/content/influxdb/clustered/reference/cli/influxctl/database/delete.md b/content/influxdb/clustered/reference/cli/influxctl/database/delete.md index 66e1da395..3d69c355b 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/database/delete.md +++ b/content/influxdb/clustered/reference/cli/influxctl/database/delete.md @@ -12,6 +12,9 @@ The `influxctl database delete` command deletes a database from an InfluxDB clus ## Usage + + + ```sh influxctl database delete [command options] [--force] [...] ``` @@ -48,12 +51,18 @@ _Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl ##### Delete a database named "mydb" + + + ```sh influxctl database delete mydb ``` ##### Delete multiple databases + + + ```sh influxctl database delete mydb1 mydb2 ``` From 8b590068d0a25e8974ccca0be3f0dc682efd6dfa Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 3 Jul 2024 13:54:07 -0500 Subject: [PATCH 19/96] fix(v3): Tips, typos, and formatting --- .../cloud-serverless/get-started/query.md | 58 +++++++++++-------- 1 file changed, 35 insertions(+), 23 deletions(-) diff --git a/content/influxdb/cloud-serverless/get-started/query.md b/content/influxdb/cloud-serverless/get-started/query.md index bbd5a56df..823cd453a 100644 --- a/content/influxdb/cloud-serverless/get-started/query.md +++ b/content/influxdb/cloud-serverless/get-started/query.md @@ -1,6 +1,6 @@ --- title: Get started querying data -seotitle: Query data | Get started with InfluxDB +seotitle: Query data | Get started with InfluxDB Cloud Serverless list_title: Query data description: > Get started querying data in InfluxDB by learning about SQL and InfluxQL, and @@ -402,10 +402,15 @@ _If your project's virtual environment is already running, skip to step 3._ {{< expand-wrapper >}} {{% expand "Important: If using **Windows**, specify the **Windows** certificate path" %}} - When instantiating the client, Python looks for SSL/TLS certificate authority (CA) certificates for verifying the server's authenticity. - If using a non-POSIX-compliant operating system (such as Windows), you need to specify a certificate bundle path that Python can access on your system. + When instantiating the client, Python looks for SSL/TLS certificate authority + (CA) certificates for verifying the server's authenticity. + If using a non-POSIX-compliant operating system (such as Windows), you need to + specify a certificate bundle path that Python can access on your system. - The following example shows how to use the [Python `certifi` package](https://certifiio.readthedocs.io/en/latest/) and client library options to provide a bundle of trusted certificates to the Python Flight client: + The following example shows how to use the + [Python `certifi` package](https://certifiio.readthedocs.io/en/latest/) and + client library options to provide a bundle of trusted certificates to the + Python Flight client: 1. In your terminal, install the Python `certifi` package. @@ -444,28 +449,30 @@ _If your project's virtual environment is already running, skip to step 3._ 2. Calls the `InfluxDBClient3()` constructor method with credentials to instantiate an InfluxDB `client` with the following credentials: - - **`host`**: {{% product-name %}} region hostname (URL without protocol or trailing slash) + - **`host`**: {{% product-name %}} region hostname + (without `https://` protocol or trailing slash) - **`database`**: the name of the [{{% product-name %}} bucket](/influxdb/cloud-serverless/admin/buckets/) to query - **`token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) with _read_ access to the specified bucket. - _Store this in a secret store or environment variable to avoid exposing the raw token string._ + _Store this in a secret store or environment variable to avoid exposing + the raw token string._ - 3. Defines the SQL query to execute and assigns it to a `query` variable. + 1. Defines the SQL query to execute and assigns it to a `query` variable. - 4. Calls the `client.query()` method with the SQL query. + 2. Calls the `client.query()` method with the SQL query. `query()` sends a Flight request to InfluxDB, queries the database (bucket), retrieves result data from the endpoint, and then returns a [`pyarrow.Table`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table) assigned to the `table` variable. - 5. Calls the [`to_pandas()` method](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table.to_pandas) + 3. Calls the [`to_pandas()` method](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table.to_pandas) to convert the Arrow table to a [`pandas.DataFrame`](https://arrow.apache.org/docs/python/pandas.html). - 6. Calls the [`pandas.DataFrame.to_markdown()` method](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_markdown.html) + 4. Calls the [`pandas.DataFrame.to_markdown()` method](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_markdown.html) to convert the DataFrame to a markdown table. - 7. Calls the `print()` method to print the markdown table to stdout. + 5. Calls the `print()` method to print the markdown table to stdout. -6. In your terminal, enter the following command to run the program and query {{% product-name %}}: +1. In your terminal, enter the following command to run the program and query {{% product-name %}}: @@ -609,14 +616,18 @@ _If your project's virtual environment is already running, skip to step 3._ - **`Host`**: your {{% product-name %}} region URL - **`Database`**: The name of your {{% product-name %}} bucket - **`Token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) with read permission on the specified bucket. - _Store this in a secret store or environment variable to avoid exposing the raw token string._ + _Store this in a secret store or environment variable to avoid + exposing the raw token string._ 2. Defines a deferred function to close the client after execution. 3. Defines a string variable for the SQL query. - 4. Calls the `influxdb3.Client.Query(sql string)` method and passes the SQL string to query InfluxDB. - `Query(sql string)` method returns an `iterator` for data in the response stream. - 5. Iterates over rows, formats the timestamp as an [RFC3339 timestamp](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp), and prints the data in table format to stdout. + 4. Calls the `influxdb3.Client.Query(sql string)` method and passes the + SQL string to query InfluxDB. + The `Query(sql string)` method returns an `iterator` for data in the + response stream. + 5. Iterates over rows, formats the timestamp as an + [RFC3339 timestamp](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp),and prints the data in table format to stdout. 3. In your editor, open the `main.go` file you created in the [Write data section](/influxdb/cloud-serverless/get-started/write/?t=Go#write-line-protocol-to-influxdb) and insert code to call the `Query()` function--for example: @@ -630,12 +641,13 @@ _If your project's virtual environment is already running, skip to step 3._ } ``` -4. In your terminal, enter the following command to install the necessary packages, build the module, and run the program: +4. In your terminal, enter the following command to install the necessary + packages, build the module, and run the program: ```sh - go mod tidy && go build && go run influxdb_go_client + go mod tidy && go run influxdb_go_client ``` The program executes the `main()` function that writes the data and prints the query results to the console. @@ -719,8 +731,10 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j with InfluxDB credentials. - **`host`**: your {{% product-name %}} region URL - - **`token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) with _read_ access to the specified bucket. - _Store this in a secret store or environment variable to avoid exposing the raw token string._ + - **`token`**: an [API token](/influxdb/cloud-serverless/admin/tokens/) + with _read_ permission on the bucket you want to query. + _Store this in a secret store or environment variable to avoid exposing + the raw token string._ 3. Defines a string variable (`sql`) for the SQL query. 4. Defines an object (`data`) with column names for keys and array values for storing row data. @@ -752,7 +766,7 @@ _This tutorial assumes you installed Node.js and npm, and created an `influxdb_j main(); ``` -9. In your terminal, execute `index.mjs` to write to and query {{% product-name %}}: +6. In your terminal, execute `index.mjs` to write to and query {{% product-name %}}: @@ -1023,8 +1037,6 @@ _This tutorial assumes using Maven version 3.9, Java version >= 15, and an `infl **Linux/MacOS** - - ```sh export MAVEN_OPTS="--add-opens=java.base/java.nio=ALL-UNNAMED" ``` From 838d615692428c651860f3d48cf6b09eaa34538e Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 3 Jul 2024 16:58:43 -0500 Subject: [PATCH 20/96] chore(ci): Update migrate guide for testing. Monitor for URLs that the container tries to open in a browser and then open them in the host. --- .husky/pre-commit | 4 ++-- .lintstagedrc.mjs | 10 ++++++-- Dockerfile.pytest | 3 +-- .../migrate-1x-to-cloud-dedicated.md | 24 ++++++++++++++++--- test/src/monitor-container-urls.sh | 8 +++---- test/src/monitor-tests.sh | 23 ++++++++++++++---- test/src/pytest.ini | 8 ++++++- 7 files changed, 61 insertions(+), 19 deletions(-) diff --git a/.husky/pre-commit b/.husky/pre-commit index 9b223fbff..42e27d76a 100644 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -1,6 +1,6 @@ # If you're running tests in a container that doesn't support TTY (docker run -t), you can use monitor-tests.sh to open URLs in the host's browser. # Your test needs to redirect the URL to the test/urls.txt file--for example: # influxctl database update /dev/null > test/urls.txt -# ./test/src/monitor-tests.sh start +sh ./test/src/monitor-tests.sh start npx lint-staged --relative -# ./test/src/monitor-tests.sh kill +sh ./test/src/monitor-tests.sh stop diff --git a/.lintstagedrc.mjs b/.lintstagedrc.mjs index fd6794abc..2a36884cd 100644 --- a/.lintstagedrc.mjs +++ b/.lintstagedrc.mjs @@ -48,14 +48,20 @@ function pytestStagedContent(paths, productPath) { // Instead of the plugin, we could use a placeholder test that always or conditionally passes. // Whether tests pass or fail, the container is removed, // but the CONTENT container and associated volume will remain until the next run. - // Note: TTY is required for the container to open influxctl OAuth URLs in the host browser. + // Note: Run the container with TTY to open influxctl OAuth URLs in the host browser. + // Run pytest with: + // -s to make pytest output log info during the test (instead of after). + // --suppress-no-test-exit-code to suppress exit code 5 (no tests collected). + // --exitfirst to stop after the first failure. + // --codeblocks to test code blocks in markdown files. + // Run `docker run --tty=true --label tag=influxdata-docs --label stage=test \ --name ${TEST} \ --env-file ${productPath}/.env.test \ --volumes-from ${CONTENT} \ --mount type=bind,src=./test/shared,dst=/shared \ --mount type=volume,source=test-tmp,target=/app/iot-starter \ - influxdata-docs/pytest --codeblocks --suppress-no-test-exit-code --exitfirst ${productPath}/`, + influxdata-docs/pytest -s --codeblocks --suppress-no-test-exit-code --exitfirst ${productPath}/`, ]; } diff --git a/Dockerfile.pytest b/Dockerfile.pytest index f7bb443c9..fd1ee1c23 100644 --- a/Dockerfile.pytest +++ b/Dockerfile.pytest @@ -26,10 +26,9 @@ ENV PYTHONUNBUFFERED=1 WORKDIR /app -# Create a mock xdg-open script` to prevent the test suite from attempting to open a browser (for example, during influxctl OAuth2 authentication), and instead execute the host-open script. +# Create a mock xdg-open script` to prevent the test suite from attempting to open a browser (for example, during influxctl OAuth2 authentication). RUN echo '#!/bin/bash' > /usr/local/bin/xdg-open \ && echo 'echo "$1" > /shared/urls.txt' >> /usr/local/bin/xdg-open \ - && echo 'echo "$1" >> /shared/host_open.log' >> /usr/local/bin/xdg-open \ && chmod +x /usr/local/bin/xdg-open # Some Python test dependencies (pytest-dotenv and pytest-codeblocks) aren't diff --git a/content/influxdb/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md b/content/influxdb/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md index 3f6c1e49f..543e28eeb 100644 --- a/content/influxdb/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md +++ b/content/influxdb/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md @@ -60,7 +60,7 @@ The simplest way to do this is to directly modify the line protocol exported in For example, the following line protocol includes both a tag and field named `temp`. -``` +```text home,room=Kitchen,temp=F co=0i,hum=56.6,temp=71.0 1672531200000000000 ``` @@ -143,13 +143,13 @@ the [exported line protocol](#migrate-data-step-1) to group certain fields into unique measurements. For example: -``` +```text example-measurement field1=0,field2=0,field3=0,field4=0,field5=0,field6=0,field7=0,field8=0 1672531200000000000 ``` Would become: -``` +```text new-measurement-1 field1=0,field2=0,field3=0,field4=0 1672531200000000000 new-measurement-2 field5=0,field6=0,field7=0,field8=0 1672531200000000000 ``` @@ -209,6 +209,9 @@ databases. {{% /note %}} ##### Export all data in a database and retention policy to a file + + + ```sh influx_inspect export \ -lponly \ @@ -221,6 +224,8 @@ databases. {{< expand-wrapper >}} {{% expand "Export all data to a file" %}} + + ```sh influx_inspect export \ -lponly \ @@ -231,6 +236,8 @@ influx_inspect export \ {{% expand "Export all data to a compressed file" %}} + + ```sh influx_inspect export \ -lponly \ @@ -242,6 +249,8 @@ influx_inspect export \ {{% expand "Export data within time bounds to a file" %}} + + ```sh influx_inspect export \ -lponly \ @@ -254,6 +263,8 @@ influx_inspect export \ {{% expand "Export a database and all its retention policies to a file" %}} + + ```sh influx_inspect export \ -lponly \ @@ -265,6 +276,8 @@ influx_inspect export \ {{% expand "Export a specific database and retention policy to a file" %}} + + ```sh influx_inspect export \ -lponly \ @@ -277,6 +290,8 @@ influx_inspect export \ {{% expand "Export all data from _non-default_ `data` and `wal` directories" %}} + + ```sh influx_inspect export \ -lponly \ @@ -329,6 +344,9 @@ You would create the following InfluxDB {{< current-version >}} databases: (default is infinite) - Database name _(see [Database naming restrictions](#database-naming-restrictions))_ + + + ```sh influxctl database create --retention-period 30d ``` diff --git a/test/src/monitor-container-urls.sh b/test/src/monitor-container-urls.sh index d9113d1c1..1938c5727 100755 --- a/test/src/monitor-container-urls.sh +++ b/test/src/monitor-container-urls.sh @@ -3,20 +3,20 @@ ## This script is meant to be run on the host and monitors a file for URLs written by a container. # The file to monitor for URLs written by the container. -FILE="./test/shared/urls.txt" +URL_FILE="./test/shared/urls.txt" # Define the URL pattern for OAuth2 authorization. OAUTH_PATTERN='https://auth\.influxdata\.com/activate\?user_code=[A-Z]{1,8}-[A-Z]{1,8}' # Loop indefinitely while true; do - if [ -f "$FILE" ]; then + if [ -f "$URL_FILE" ]; then # Extract an OAuth2 authorization URL from the file - URL=$(grep -Eo "$OAUTH_PATTERN" "$FILE") + URL=$(grep -Eo "$OAUTH_PATTERN" "$URL_FILE") if [ "$URL" ]; then # Open the URL in the default browser open "$URL" # Clear the file to indicate the URL has been handled - > "$FILE" + > "$URL_FILE" fi fi sleep 1 diff --git a/test/src/monitor-tests.sh b/test/src/monitor-tests.sh index f3aa56c5c..fac2fad2a 100755 --- a/test/src/monitor-tests.sh +++ b/test/src/monitor-tests.sh @@ -1,13 +1,26 @@ +pid_file=./test/monitor_urls_pid function start { - ./test/src/monitor-container-urls.sh & echo $! > ./test/monitor_urls_pid + ./test/src/monitor-container-urls.sh & echo $! >> "$pid_file" } -function kill_process { - PID=$(cat ./test/monitor_urls_pid) && kill -9 $PID && rm ./test/monitor_urls_pid +function kill_processes { + # Kill all processes in the monitor_urls_pid file + echo "Cleaning up monitor-container-urls processes..." + while read -r PID; do + kill $PID 2>/dev/null; ps -p $PID > /dev/null + if [ $? -ne 0 ]; then + sed -i '' "/$PID/d" "$pid_file" + echo "Successfully stopped monitor-container-urls process $PID" + else + # Leave it in the file to try stopping it again next time + # and output the error message + echo "Failed to stop monitor-container-urls process $PID" + fi + done < "$pid_file" } case "$1" in start) start ;; - kill) kill_process ;; - *) echo "Usage: $0 {start|kill}" ;; + stop) kill_processes ;; + *) echo "Usage: $0 {start|stop}" ;; esac \ No newline at end of file diff --git a/test/src/pytest.ini b/test/src/pytest.ini index 79e51cf9b..2a8564cca 100644 --- a/test/src/pytest.ini +++ b/test/src/pytest.ini @@ -8,4 +8,10 @@ python_classes = *Test # Collect all functions. python_functions = * -filterwarnings = ignore::pytest.PytestReturnNotNoneWarning \ No newline at end of file +filterwarnings = ignore::pytest.PytestReturnNotNoneWarning +# Log settings. +log_file = /shared/tests_run.log +log_file_date_format = %Y-%m-%d %H:%M:%S +log_file_format = %(asctime)s - %(name)s %(levelname)s %(message)s +# INFO level log messages for extracting authentication URLs output during tests. +log_file_level = INFO \ No newline at end of file From 91c3577c6fa4ebc397c11d30e8240e3d0219661f Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 3 Jul 2024 17:11:37 -0500 Subject: [PATCH 21/96] chore(ci): Fix comment. --- .lintstagedrc.mjs | 1 - 1 file changed, 1 deletion(-) diff --git a/.lintstagedrc.mjs b/.lintstagedrc.mjs index 2a36884cd..13d88eb1d 100644 --- a/.lintstagedrc.mjs +++ b/.lintstagedrc.mjs @@ -48,7 +48,6 @@ function pytestStagedContent(paths, productPath) { // Instead of the plugin, we could use a placeholder test that always or conditionally passes. // Whether tests pass or fail, the container is removed, // but the CONTENT container and associated volume will remain until the next run. - // Note: Run the container with TTY to open influxctl OAuth URLs in the host browser. // Run pytest with: // -s to make pytest output log info during the test (instead of after). // --suppress-no-test-exit-code to suppress exit code 5 (no tests collected). From e061b5172628f945e1c6537434c2e8f1fbb1334d Mon Sep 17 00:00:00 2001 From: Jennifer Moore Date: Wed, 10 Jul 2024 12:03:19 -0500 Subject: [PATCH 22/96] clustered: add section for custom CA on egress (#5519) * clustered: add section for custom CA on egress * Apply suggestions from code review Address review comments Co-authored-by: Scott Anderson --------- Co-authored-by: Scott Anderson --- .../clustered/install/configure-cluster.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/content/influxdb/clustered/install/configure-cluster.md b/content/influxdb/clustered/install/configure-cluster.md index 5b8d0bbcd..b3dcf52d1 100644 --- a/content/influxdb/clustered/install/configure-cluster.md +++ b/content/influxdb/clustered/install/configure-cluster.md @@ -821,4 +821,57 @@ spec: {{% /code-placeholders %}} +### Provide a custom certificate authority bundle {metadata="Optional"} + +InfluxDB attempts to make TLS connections to the services it depends on; notably +the [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog), +and the [Object store](/influxdb/clustered/reference/internals/storage-engine/#object-store). +InfluxDB validates the certificates for all of the connections it makes. + +**If you host these services yourself and you use a private or otherwise not +well-known certificate authority to issue certificates to theses services**, +InfluxDB will not recognize the issuer and will be unable to validate the certificates. +To allow InfluxDB to validate these certificates, provide a PEM certificate +bundle containing your custom certificate authority chain. + +1. Use `kubectl` to create a config map containing your PEM bundle. + Your certificate authority administrator should provide you with a + PEM-formatted certificate bundle file. + + {{% note %}} +This PEM-formatted bundle file is *not* the certificate that InfluxDB uses to +host its own TLS endpoints. This bundle establishes a chain of trust for the +external services that InfluxDB depends on. + {{% /note %}} + + In the example below, `private_ca.pem` is the certificate bundle file. + + ```sh + kubectl --namespace influxdb create configmap custom-ca --from-file=certs.pem=/path/to/private_ca.pem + ``` + + {{% note %}} +It's possible to append multiple certificates into the same bundle. +This can help if you need to include intermediate certificates or explicitly +include leaf certificates. Leaf certificates should be included before any +intermediate certificates they depend on. The root certificate should +be last in the bundle. + {{% /note %}} + +2. Update your `AppInstance` resource in your `myinfluxdb.yml` to refer to your + certificate authority config map. Update the `.spec.package.spec.egress` + property to refer to that config map. For example: + + ```yml + spec: + package: + spec: + egress: + customCertificates: + valueFrom: + configMapKeyRef: + key: ca.pem + name: custom-ca + ``` + {{< page-nav prev="/influxdb/clustered/install/auth/" prevText="Set up authentication" next="/influxdb/clustered/install/deploy/" nextText="Deploy your cluster" >}} From 0deaa85aeb6346437ea4eaff7af1e5f7c7a1328c Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 10 Jul 2024 11:15:14 -0600 Subject: [PATCH 23/96] hotfix: minor edits to clustered config doc --- .../clustered/install/configure-cluster.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/content/influxdb/clustered/install/configure-cluster.md b/content/influxdb/clustered/install/configure-cluster.md index b3dcf52d1..443ac2f06 100644 --- a/content/influxdb/clustered/install/configure-cluster.md +++ b/content/influxdb/clustered/install/configure-cluster.md @@ -72,12 +72,14 @@ template) that contains key information, such as: ## Configure your cluster -1. [Create a cluster configuration file](#create-a-cluster-configuration-file) -2. [Create a namespace for InfluxDB](#create-a-namespace-for-influxdb) -3. [Install kubecfg kubit operator](#install-kubecfg-kubit-operator) -4. [Configure access to the InfluxDB container registry](#configure-access-to-the-influxdb-container-registry) -5. [Set up cluster ingress](#set-up-cluster-ingress) -6. [Modify the configuration file to point to prerequisites](#modify-the-configuration-file-to-point-to-prerequisites) +1. [Create a cluster configuration file](#create-a-cluster-configuration-file) +2. [Create a namespace for InfluxDB](#create-a-namespace-for-influxdb) +3. [Install kubecfg kubit operator](#install-kubecfg-kubit-operator) +4. [Configure access to the InfluxDB container registry](#configure-access-to-the-influxdb-container-registry) +5. [Set up cluster ingress](#set-up-cluster-ingress) +6. [Modify the configuration file to point to prerequisites](#modify-the-configuration-file-to-point-to-prerequisites) +7. [Provide a custom certificate authority bundle](#provide-a-custom-certificate-authority-bundle) + (Optional) ### Create a cluster configuration file @@ -821,7 +823,7 @@ spec: {{% /code-placeholders %}} -### Provide a custom certificate authority bundle {metadata="Optional"} +### Provide a custom certificate authority bundle {note="Optional"} InfluxDB attempts to make TLS connections to the services it depends on; notably the [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog), From 59d8958ebc38be7f437626a929548558771844f2 Mon Sep 17 00:00:00 2001 From: Jennifer Moore Date: Thu, 11 Jul 2024 18:03:38 -0500 Subject: [PATCH 24/96] docs(clustered): initial license onboarding guide (#5508) * docs(clustered): initial license onboarding guide * refactor: run `deno fmt` * fix(clustered): make room for documents in between existing ones * fix(clustered): introduce sensible deterministic order for reference documents * refactor: separate license installation from license reference * fix: markdown typo, confusing verbiage * Licensing content and structure updates (#5520) * WIP licensing content * changes to licensing content and structure * Update content/influxdb/clustered/admin/licensing.md Co-authored-by: Jennifer Moore * updated TOC link to license recovery section * Apply suggestions from code review Co-authored-by: Jason Stirnaman * updated license recovery content --------- Co-authored-by: Jennifer Moore Co-authored-by: Jason Stirnaman * ported edits to new feature branch --------- Co-authored-by: Scott Anderson Co-authored-by: wayne warren Co-authored-by: Scott Anderson Co-authored-by: Jason Stirnaman --- .../clustered/admin/databases/_index.md | 2 +- content/influxdb/clustered/admin/licensing.md | 169 ++++++++++++++++++ .../influxdb/clustered/admin/tables/_index.md | 2 +- .../influxdb/clustered/admin/tokens/_index.md | 2 +- content/influxdb/clustered/install/auth.md | 2 +- .../clustered/install/configure-cluster.md | 4 +- content/influxdb/clustered/install/deploy.md | 5 +- .../influxdb/clustered/install/licensing.md | 104 +++++++++++ .../clustered/install/prerequisites.md | 2 +- .../clustered/install/use-your-cluster.md | 2 +- .../report-query-performance-issues.md | 2 +- .../clustered/reference/api/_index.md | 2 +- .../clustered/reference/cli/_index.md | 2 +- .../reference/client-libraries/_index.md | 2 +- .../influxdb/clustered/reference/glossary.md | 2 +- .../clustered/reference/influxql/_index.md | 2 +- .../clustered/reference/internals/_index.md | 4 +- .../reference/release-notes/_index.md | 2 +- .../clustered/reference/sample-data.md | 2 +- .../clustered/reference/sql/_index.md | 2 +- .../clustered/reference/syntax/_index.md | 2 +- yarn.lock | 97 +++++----- 22 files changed, 347 insertions(+), 68 deletions(-) create mode 100644 content/influxdb/clustered/admin/licensing.md create mode 100644 content/influxdb/clustered/install/licensing.md diff --git a/content/influxdb/clustered/admin/databases/_index.md b/content/influxdb/clustered/admin/databases/_index.md index 3d2ecb010..1dbb4a19a 100644 --- a/content/influxdb/clustered/admin/databases/_index.md +++ b/content/influxdb/clustered/admin/databases/_index.md @@ -9,7 +9,7 @@ description: > menu: influxdb_clustered: parent: Administer InfluxDB Clustered -weight: 101 +weight: 102 influxdb/clustered/tags: [databases] --- diff --git a/content/influxdb/clustered/admin/licensing.md b/content/influxdb/clustered/admin/licensing.md new file mode 100644 index 000000000..0e0ede2a5 --- /dev/null +++ b/content/influxdb/clustered/admin/licensing.md @@ -0,0 +1,169 @@ +--- +title: Manage your InfluxDB Clustered license +description: > + Install and manage your InfluxDB Clustered license to authorize the use of + the InfluxDB Clustered software. +menu: + influxdb_clustered: + parent: Administer InfluxDB Clustered + name: Manage your license +weight: 101 +influxdb/clustered/tags: [licensing] +related: + - /influxdb/clustered/install/licensing/ + - /influxdb/clustered/admin/upgrade/ +--- + +Install and manage your InfluxDB Clustered license to authorize the use of +the InfluxDB Clustered software. + +- [Install your InfluxDB license](#install-your-influxdb-license) +- [Recover from a license misconfiguration](#recover-from-a-license-misconfiguration) +- [Renew your license](#renew-your-license) +- [License enforcement](#license-enforcement) + - [A valid license is required](#a-valid-license-is-required) + - [Periodic license checks](#periodic-license-checks) + - [License grace periods](#license-grace-periods) + - [License expiry logs](#license-expiry-logs) + - [Query brownout](#query-brownout) + +{{% note %}} +#### License enforcement is currently an opt-in feature + +In currently available versions of InfluxDB Clustered, license enforcement is an +opt-in feature that allows InfluxData to introduce license enforcement to +customers, and allows customers to deactivate the feature if issues arise. +In the future, all releases of InfluxDB Clustered will require customers to +configure an active license before they can use the product. + +To opt into license enforcement, include the `useLicensedBinaries` feature flag +in your `AppInstance` resource _([See the example below](#enable-feature-flag))_. +To deactivate license enforcement, remove the `useLicensedBinaries` feature flag. +{{% /note %}} + +## Install your InfluxDB license + +{{% note %}} +If setting up an InfluxDB Clustered deployment for the first time, first +[set up the prerequisites](/influxdb/clustered/install/licensing/) and +[configure your cluster](/influxdb/clustered/install/configure-cluster/). +After your InfluxDB namespace is created and prepared, you will be able to +install your license. +{{% /note %}} + +1. If you haven't already, + [request an InfluxDB Clustered license](https://influxdata.com/contact-sales). +2. InfluxData provides you with a `license.yml` file that encapsulates your + license token as a custom Kubernetes resource. +3. Use `kubectl` to apply and create the `License` resource in your InfluxDB + namespace: + + ```sh + kubectl apply --filename license.yml --namespace influxdb + ``` + +4. + Update your `AppInstance` resource to include the `useLicensedBinaries` feature flag. + Add the `useLicensedBinaries` entry to the `.spec.package.spec.featureFlags` + property--for example: + + ```yml + apiVersion: kubecfg.dev/v1alpha1 + kind: AppInstance + # ... + spec: + package: + spec: + featureFlags: + - useLicensedBinaries + ``` + +InfluxDB Clustered detects the `License` resource and extracts the credentials +into a secret required by InfluxDB Clustered Kubernetes pods. +Pods validate the license secret both at startup and periodically (roughly once +per hour) while running. + +## Recover from a license misconfiguration + +If you deploy a licensed release of InfluxDB Clustered without an invalid or +expired license, many of the pods in your cluster will crash on startup and will +likely enter a `CrashLoopBackoff` state without ever running or becoming healthy. +Because the license is stored in a volume-mounted Kubernetes secret, invalid +licenses affect both old and new pods. + +Once a valid `License` resource is applied, new pods will begin to start up normally. +Licenses are validated when the `License` resource is applied. If the license +is invalid when you attempt to apply it, the InfluxDB clustered license +controller will not add or update the required secret. + +## Renew your license + +In advance of your license expiration, your InfluxData sales representative will +contact you regarding license renewal. +You may also contact your sales representative at any time. + +--- + +## License enforcement + +InfluxDB Clustered authorizes use of InfluxDB software through licenses issued +by InfluxData. The following sections provide information about InfluxDB Clustered +license enforcement. + +### A valid license is required + +_When you include the `useLicensedBinaries` feature flag_, +Kubernetes pods running in your InfluxDB cluster must have a valid `License` +resource to run. Licenses are issued by InfluxData. If there is no `License` +resource installed in your cluster, one of two things may happen: + +- Pods may become stuck in a `ContainerCreating` state if the cluster has + never had a valid `License` resource installed. +- If an expired or invalid license is installed in the cluster, pods will become + stuck in a `CrashLoopBackoff` state. + Pod containers will attempt to start, detect the invalid license condition, + print an error message, and then exit with a non-zero exit code. + +### Periodic license checks + +During normal operation, pods in your InfluxDB cluster check for a valid license +once per hour. You may see messages in your pod logs related to this behavior. + +### License grace periods + +When InfluxData issues a license, it is configured with two expiry dates. +The first is the expiry date of the contractual license. The second is a hard +expiry of the license credentials, after which pods in your cluster will begin +crash-looping until a new, valid license is installed in the cluster. + +The period of time between the contractual license expiry and the hard license +expiry is considered the _grace period_. The standard grace period is 90 days, +but this may be negotiated as needed with your InfluxData sales representative. + +#### License expiry logs + +The following table outlines license expiry logging behavior to show when the log +messages begin, the level (`Warn` or `Error`), and the periodicity at which they +repeat. + +| Starts at | Log level | Log periodicity | +| :-------------------- | :-------- | :-------------- | +| 1 month before expiry | Warn | 1 msg per hour | +| 1 week before expiry | Warn | 1 msg per 5 min | +| At expiry | Error | 1 msg per 5 min | + +#### Query brownout + +Starting one month after your contractual license expiry, the InfluxDB +[Querier](/influxdb/clustered/reference/internals/storage-engine/#querier) +begins "browning out" requests. Brownouts return +`FailedPrecondition` response codes to queries for a portion of every hour. + +| Starts at | Brownout coverage | +| :------------------- | :----------------- | +| 7 days after expiry | 5 minutes per hour | +| 1 month after expiry | 100% of queries | + +**Brownouts only occur after the license has contractually expired**. +Also, they **only impact query operations**--no other operations (writes, +compaction, garbage collection, etc) are affected. diff --git a/content/influxdb/clustered/admin/tables/_index.md b/content/influxdb/clustered/admin/tables/_index.md index f71a3bdfe..991704d89 100644 --- a/content/influxdb/clustered/admin/tables/_index.md +++ b/content/influxdb/clustered/admin/tables/_index.md @@ -8,7 +8,7 @@ description: > menu: influxdb_clustered: parent: Administer InfluxDB Clustered -weight: 101 +weight: 102 influxdb/clustered/tags: [tables] --- diff --git a/content/influxdb/clustered/admin/tokens/_index.md b/content/influxdb/clustered/admin/tokens/_index.md index 6234f3471..26823dfe9 100644 --- a/content/influxdb/clustered/admin/tokens/_index.md +++ b/content/influxdb/clustered/admin/tokens/_index.md @@ -8,7 +8,7 @@ description: > menu: influxdb_clustered: parent: Administer InfluxDB Clustered -weight: 101 +weight: 102 influxdb/clustered/tags: [tokens] --- diff --git a/content/influxdb/clustered/install/auth.md b/content/influxdb/clustered/install/auth.md index ca2a1ead4..d45f45720 100644 --- a/content/influxdb/clustered/install/auth.md +++ b/content/influxdb/clustered/install/auth.md @@ -6,7 +6,7 @@ menu: influxdb_clustered: name: Set up authentication parent: Install InfluxDB Clustered -weight: 102 +weight: 120 --- Administrative access to your InfluxDB cluster is managed through your identity diff --git a/content/influxdb/clustered/install/configure-cluster.md b/content/influxdb/clustered/install/configure-cluster.md index 443ac2f06..a3e8dd584 100644 --- a/content/influxdb/clustered/install/configure-cluster.md +++ b/content/influxdb/clustered/install/configure-cluster.md @@ -7,7 +7,7 @@ menu: influxdb_clustered: name: Configure your cluster parent: Install InfluxDB Clustered -weight: 103 +weight: 130 related: - /influxdb/clustered/admin/upgrade/ --- @@ -876,4 +876,4 @@ be last in the bundle. name: custom-ca ``` -{{< page-nav prev="/influxdb/clustered/install/auth/" prevText="Set up authentication" next="/influxdb/clustered/install/deploy/" nextText="Deploy your cluster" >}} +{{< page-nav prev="/influxdb/clustered/install/auth/" prevText="Set up authentication" next="/influxdb/clustered/install/licensing/" nextText="Install your license" >}} diff --git a/content/influxdb/clustered/install/deploy.md b/content/influxdb/clustered/install/deploy.md index 04bb84daa..cb6d95142 100644 --- a/content/influxdb/clustered/install/deploy.md +++ b/content/influxdb/clustered/install/deploy.md @@ -6,9 +6,10 @@ menu: influxdb_clustered: name: Deploy your cluster parent: Install InfluxDB Clustered -weight: 104 +weight: 140 related: - /influxdb/clustered/admin/upgrade/ + - /influxdb/clustered/install/licensing/ --- Use Kubernetes and related tools to deploy your InfluxDB cluster. @@ -172,4 +173,4 @@ influxdb iox-shared-querier-7f5998b9b-fpt62 4/4 Running 1 (6 influxdb kubit-apply-influxdb-g6qpx 0/1 Completed 0 8s ``` -{{< page-nav prev="/influxdb/clustered/install/configure-cluster/" prevText="Configure your cluster" next="/influxdb/clustered/install/use-your-cluster/" nextText="Use your cluster" >}} +{{< page-nav prev="/influxdb/clustered/install/licensing/" prevText="Install your license" next="/influxdb/clustered/install/use-your-cluster/" nextText="Use your cluster" >}} diff --git a/content/influxdb/clustered/install/licensing.md b/content/influxdb/clustered/install/licensing.md new file mode 100644 index 000000000..1d913fe4b --- /dev/null +++ b/content/influxdb/clustered/install/licensing.md @@ -0,0 +1,104 @@ +--- +title: Install your InfluxDB Clustered license +description: > + Install your InfluxDB Clustered license to authorize the use of the InfluxDB + Clustered software. +menu: + influxdb_clustered: + name: Install your License + parent: Install InfluxDB Clustered +weight: 135 +influxdb/clustered/tags: [licensing] +related: + - /influxdb/clustered/admin/licensing/ + - /influxdb/clustered/admin/upgrade/ +--- + +Install your InfluxDB Clustered license in your cluster to authorize the use +of the InfluxDB Clustered software. + +{{% note %}} +#### License enforcement is currently an opt-in feature + +In currently available versions of InfluxDB Clustered, license enforcement is an +opt-in feature that allows InfluxData to introduce license enforcement to +customers, and allows customers to deactivate the feature if issues arise. +In the future, all releases of InfluxDB Clustered will require customers to +configure an active license before they can use the product. + +To opt into license enforcement, include the `useLicensedBinaries` feature flag +in your `AppInstance` resource _([See the example below](#enable-feature-flag))_. +To deactivate license enforcement, remove the `useLicensedBinaries` feature flag. +{{% /note %}} + +## Install your InfluxDB license + +1. If you haven't already, + [request an InfluxDB Clustered license](https://influxdata.com/contact-sales). +2. InfluxData provides you with a `license.yml` file that encapsulates your + license token as a custom Kubernetes resource. +3. Use `kubectl` to apply and create the `License` resource in your InfluxDB + namespace: + + ```sh + kubectl apply --filename license.yml --namespace influxdb + ``` + +4. + Update your `AppInstance` resource to enable the `useLicensedBinaries` feature flag. + Add the `useLicensedBinaries` entry to the `.spec.package.spec.featureFlags` + property--for example: + + ```yml + apiVersion: kubecfg.dev/v1alpha1 + kind: AppInstance + # ... + spec: + package: + spec: + featureFlags: + - useLicensedBinaries + ``` + +InfluxDB Clustered detects the `License` resource and extracts the credentials +into a secret required by InfluxDB Clustered Kubernetes pods. +Pods validate the license secret both at startup and periodically (roughly once +per hour) while running. + +## Upgrade from a non-licensed release + +If you are currently using a non-licensed preview release of InfluxDB Clustered +and want to upgrade to a licensed release, do the following: + +1. [Install an InfluxDB license](#install-your-influxdb-license) +2. In your `myinfluxdb.yml`, update the package version defined in + `spec.package.image` to use a licensed release. + + {{% warn %}} +#### Upgrade to checkpoint releases first + +When upgrading InfluxDB Clustered, always upgrade to each +[checkpoint release](/influxdb/clustered/admin/upgrade/#checkpoint-releases) +first, before proceeding to newer versions. +Upgrading past a checkpoint release without first upgrading to it may result in +corrupt or lost data. + {{% /warn %}} + +{{% code-placeholders "PACKAGE_VERSION" %}} + +```yml +apiVersion: kubecfg.dev/v1alpha1 +kind: AppInstance +# ... +spec: + package: + # ... + image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:PACKAGE_VERSION +``` + +{{% /code-placeholders %}} + +Replace {{% code-placeholder-key %}}`PACKAGE_VERSION`{{% /code-placeholder-key %}} with +the version number to upgrade to. + +{{< page-nav prev="/influxdb/clustered/install/configure-cluster/" prevText="Configure your cluster" next="/influxdb/clustered/install/deploy/" nextText="Deploy your cluster" >}} diff --git a/content/influxdb/clustered/install/prerequisites.md b/content/influxdb/clustered/install/prerequisites.md index 29e61cd43..5cd4b0a9c 100644 --- a/content/influxdb/clustered/install/prerequisites.md +++ b/content/influxdb/clustered/install/prerequisites.md @@ -8,7 +8,7 @@ menu: influxdb_clustered: name: Prerequisites parent: Install InfluxDB Clustered -weight: 101 +weight: 110 --- InfluxDB Clustered requires the following prerequisites: diff --git a/content/influxdb/clustered/install/use-your-cluster.md b/content/influxdb/clustered/install/use-your-cluster.md index 2c9643818..9e7debdbe 100644 --- a/content/influxdb/clustered/install/use-your-cluster.md +++ b/content/influxdb/clustered/install/use-your-cluster.md @@ -6,7 +6,7 @@ menu: influxdb_clustered: name: Use your cluster parent: Install InfluxDB Clustered -weight: 105 +weight: 150 --- Now that your InfluxDB cluster is deployed, you can use and test it. diff --git a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md b/content/influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md index 4d6ccf441..0bd923a5b 100644 --- a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md +++ b/content/influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md @@ -173,7 +173,7 @@ tar -czf "${DATETIME}-cluster-info.tar.gz" "${DATETIME}-cluster-info/" #### Query analysis -**Outputs (InfluxQl):** +**Outputs (InfluxQL):** - `explain.csv` - `explain-verbose.csv` diff --git a/content/influxdb/clustered/reference/api/_index.md b/content/influxdb/clustered/reference/api/_index.md index 1ba05d8be..49009b350 100644 --- a/content/influxdb/clustered/reference/api/_index.md +++ b/content/influxdb/clustered/reference/api/_index.md @@ -8,7 +8,7 @@ menu: influxdb_clustered: parent: Reference name: InfluxDB HTTP API -weight: 104 +weight: 127 influxdb/clustered/tags: [api] --- diff --git a/content/influxdb/clustered/reference/cli/_index.md b/content/influxdb/clustered/reference/cli/_index.md index 15de48f0a..c7fa9889d 100644 --- a/content/influxdb/clustered/reference/cli/_index.md +++ b/content/influxdb/clustered/reference/cli/_index.md @@ -9,7 +9,7 @@ menu: influxdb_clustered: parent: Reference name: CLIs -weight: 104 +weight: 120 --- InfluxDB provides command line tools designed to manage and work with your diff --git a/content/influxdb/clustered/reference/client-libraries/_index.md b/content/influxdb/clustered/reference/client-libraries/_index.md index e9fa12780..02e359917 100644 --- a/content/influxdb/clustered/reference/client-libraries/_index.md +++ b/content/influxdb/clustered/reference/client-libraries/_index.md @@ -4,7 +4,7 @@ description: > InfluxDB client libraries are language-specific tools that integrate with InfluxDB APIs. View the list of available client libraries. list_title: API client libraries -weight: 105 +weight: 125 aliases: - /influxdb/clustered/reference/api/client-libraries/ - /influxdb/clustered/tools/client-libraries/ diff --git a/content/influxdb/clustered/reference/glossary.md b/content/influxdb/clustered/reference/glossary.md index c067954a5..4489c1432 100644 --- a/content/influxdb/clustered/reference/glossary.md +++ b/content/influxdb/clustered/reference/glossary.md @@ -2,7 +2,7 @@ title: Glossary description: > Terms related to InfluxData products and platforms. -weight: 109 +weight: 180 menu: influxdb_clustered: parent: Reference diff --git a/content/influxdb/clustered/reference/influxql/_index.md b/content/influxdb/clustered/reference/influxql/_index.md index 25f21e329..d9214a790 100644 --- a/content/influxdb/clustered/reference/influxql/_index.md +++ b/content/influxdb/clustered/reference/influxql/_index.md @@ -7,7 +7,7 @@ menu: parent: Reference name: InfluxQL reference identifier: influxql-reference -weight: 102 +weight: 143 --- InfluxQL (Influx Query Language) is an SQL-like query language used to interact diff --git a/content/influxdb/clustered/reference/internals/_index.md b/content/influxdb/clustered/reference/internals/_index.md index da09bb191..eea2a7a7a 100644 --- a/content/influxdb/clustered/reference/internals/_index.md +++ b/content/influxdb/clustered/reference/internals/_index.md @@ -5,7 +5,7 @@ description: > menu: influxdb_clustered: parent: Reference -weight: 108 +weight: 130 --- -{{< children >}} \ No newline at end of file +{{< children >}} diff --git a/content/influxdb/clustered/reference/release-notes/_index.md b/content/influxdb/clustered/reference/release-notes/_index.md index 95b298419..3cb80d0e5 100644 --- a/content/influxdb/clustered/reference/release-notes/_index.md +++ b/content/influxdb/clustered/reference/release-notes/_index.md @@ -7,7 +7,7 @@ menu: influxdb_clustered: name: Release notes parent: Reference -weight: 101 +weight: 190 --- View release notes and updates for products and tools related to diff --git a/content/influxdb/clustered/reference/sample-data.md b/content/influxdb/clustered/reference/sample-data.md index a9b1b49f3..e1c022a40 100644 --- a/content/influxdb/clustered/reference/sample-data.md +++ b/content/influxdb/clustered/reference/sample-data.md @@ -8,7 +8,7 @@ menu: influxdb_clustered: name: Sample data parent: Reference -weight: 110 +weight: 182 --- Sample datasets are used throughout the {{< product-name >}} documentation to diff --git a/content/influxdb/clustered/reference/sql/_index.md b/content/influxdb/clustered/reference/sql/_index.md index 3fef4346f..713a95ac6 100644 --- a/content/influxdb/clustered/reference/sql/_index.md +++ b/content/influxdb/clustered/reference/sql/_index.md @@ -6,7 +6,7 @@ menu: influxdb_clustered: name: SQL reference parent: Reference -weight: 101 +weight: 141 related: - /influxdb/clustered/reference/internals/arrow-flightsql/ --- diff --git a/content/influxdb/clustered/reference/syntax/_index.md b/content/influxdb/clustered/reference/syntax/_index.md index a82679ba7..dc93900c7 100644 --- a/content/influxdb/clustered/reference/syntax/_index.md +++ b/content/influxdb/clustered/reference/syntax/_index.md @@ -3,7 +3,7 @@ title: Other InfluxDB syntaxes description: > InfluxDB uses a handful of languages and syntaxes to perform tasks such as writing, querying, and processing data. -weight: 105 +weight: 145 menu: influxdb_clustered: name: Other syntaxes diff --git a/yarn.lock b/yarn.lock index a266ccb7e..c9db0f1d8 100644 --- a/yarn.lock +++ b/yarn.lock @@ -45,7 +45,7 @@ "@nodelib/fs.stat" "2.0.5" run-parallel "^1.1.9" -"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": +"@nodelib/fs.stat@^2.0.2", "@nodelib/fs.stat@2.0.5": version "2.0.5" resolved "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz" integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== @@ -236,7 +236,7 @@ braces@^3.0.3, braces@~3.0.2: dependencies: fill-range "^7.1.1" -browserslist@^4.23.0: +browserslist@^4.23.0, "browserslist@>= 4.21.0": version "4.23.0" resolved "https://registry.npmjs.org/browserslist/-/browserslist-4.23.0.tgz" integrity sha512-QW8HiM1shhT2GuzkvklfjcKDiWFXHOeFCIA/huJPwHsslwcydgk7X+z2zXpEijP98UCY7HbubZt5J2Zgvf0CaQ== @@ -401,16 +401,16 @@ color-convert@^2.0.1: dependencies: color-name "~1.1.4" -color-name@1.1.3: - version "1.1.3" - resolved "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz" - integrity sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== - color-name@~1.1.4: version "1.1.4" resolved "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz" integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz" + integrity sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== + colorette@^2.0.20: version "2.0.20" resolved "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz" @@ -543,7 +543,7 @@ dependency-graph@^0.11.0: discontinuous-range@1.0.0: version "1.0.0" - resolved "https://registry.yarnpkg.com/discontinuous-range/-/discontinuous-range-1.0.0.tgz#e38331f0844bba49b9a9cb71c771585aab1bc65a" + resolved "https://registry.npmjs.org/discontinuous-range/-/discontinuous-range-1.0.0.tgz" integrity sha512-c68LpLbO+7kP/b1Hr1qs8/BJ09F5khZGTxqxZuhzxpmwJKOgRFHJWIb9/KmqnqHhLdO55aOxFH/EGBvUQbL/RQ== duplexer2@~0.1.4: @@ -765,16 +765,16 @@ get-east-asian-width@^1.0.0: resolved "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.2.0.tgz" integrity sha512-2nk+7SIVb14QrgXFHcm84tD4bKQz0RxPuMT8Ag5KPOq7J5fEmAg0UbXdTOSHqNuHSU28k55qnceesxXRZGzKWA== -get-stdin@=8.0.0: - version "8.0.0" - resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-8.0.0.tgz#cbad6a73feb75f6eeb22ba9e01f89aa28aa97a53" - integrity sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg== - get-stdin@^9.0.0: version "9.0.0" resolved "https://registry.npmjs.org/get-stdin/-/get-stdin-9.0.0.tgz" integrity sha512-dVKBjfWisLAicarI2Sf+JuBE/DghV4UzNAVe9yhEJuzeREd3JhOTE9cUaJTeSa77fsbQUK3pcOpJfM59+VKZaA== +get-stdin@=8.0.0: + version "8.0.0" + resolved "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz" + integrity sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg== + get-stream@^2.2.0: version "2.3.1" resolved "https://registry.npmjs.org/get-stream/-/get-stream-2.3.1.tgz" @@ -926,7 +926,7 @@ inflight@^1.0.4: once "^1.3.0" wrappy "1" -inherits@2, inherits@~2.0.0, inherits@~2.0.3: +inherits@~2.0.0, inherits@~2.0.3, inherits@2: version "2.0.4" resolved "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz" integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== @@ -1061,7 +1061,7 @@ jsonfile@^6.0.1: jsox@^1.2.118: version "1.2.119" - resolved "https://registry.yarnpkg.com/jsox/-/jsox-1.2.119.tgz#decc12b6d3948d89460da6c5e144ee76c1d054ce" + resolved "https://registry.npmjs.org/jsox/-/jsox-1.2.119.tgz" integrity sha512-f37obwxWKKuylcaOzNlUlzfDvURSCpqTXs8yEivhvsp86D/DTIySxP4v5Qdlg24qCuzDSZ0mJr3krc/f7TZ/5A== keyv@^4.5.3: @@ -1240,12 +1240,17 @@ minipass@^3.0.0: dependencies: yallist "^4.0.0" +"minipass@^5.0.0 || ^6.0.2 || ^7.0.0": + version "7.1.2" + resolved "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz" + integrity sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw== + minipass@^5.0.0: version "5.0.0" resolved "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz" integrity sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ== -"minipass@^5.0.0 || ^6.0.2 || ^7.0.0", minipass@^7.1.2: +minipass@^7.1.2: version "7.1.2" resolved "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz" integrity sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw== @@ -1258,6 +1263,11 @@ minizlib@^2.1.1: minipass "^3.0.0" yallist "^4.0.0" +mkdirp@^1.0.3: + version "1.0.4" + resolved "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz" + integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== + "mkdirp@>=0.5 0": version "0.5.6" resolved "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.6.tgz" @@ -1265,14 +1275,9 @@ minizlib@^2.1.1: dependencies: minimist "^1.2.6" -mkdirp@^1.0.3: - version "1.0.4" - resolved "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz" - integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== - moo@^0.5.0: version "0.5.2" - resolved "https://registry.yarnpkg.com/moo/-/moo-0.5.2.tgz#f9fe82473bc7c184b0d32e2215d3f6e67278733c" + resolved "https://registry.npmjs.org/moo/-/moo-0.5.2.tgz" integrity sha512-iSAJLHYKnX41mKcJKjqvnAN9sf0LMDTXDEvFv+ffuRR9a1MIuXLjMNL6EsnDHSkKLTWNqQQ5uo61P4EbU4NU+Q== ms@2.1.2: @@ -1287,7 +1292,7 @@ nanoid@^3.3.7: nearley@^2.20.1: version "2.20.1" - resolved "https://registry.yarnpkg.com/nearley/-/nearley-2.20.1.tgz#246cd33eff0d012faf197ff6774d7ac78acdd474" + resolved "https://registry.npmjs.org/nearley/-/nearley-2.20.1.tgz" integrity sha512-+Mc8UaAebFzgV+KpI5n7DasuuQCHA89dmwm7JXw3TV43ukfNQ9DnBH3Mdb2g/I4Fdxc26pwimBWvjIw0UAILSQ== dependencies: commander "^2.19.0" @@ -1302,7 +1307,7 @@ node-releases@^2.0.14: node-sql-parser@^4.12.0: version "4.18.0" - resolved "https://registry.yarnpkg.com/node-sql-parser/-/node-sql-parser-4.18.0.tgz#516b6e633c55c5abbba1ca588ab372db81ae9318" + resolved "https://registry.npmjs.org/node-sql-parser/-/node-sql-parser-4.18.0.tgz" integrity sha512-2YEOR5qlI1zUFbGMLKNfsrR5JUvFg9LxIRVE+xJe962pfVLH0rnItqLzv96XVs1Y1UIR8FxsXAuvX/lYAWZ2BQ== dependencies: big-integer "^1.6.48" @@ -1508,7 +1513,7 @@ postcss-value-parser@^4.2.0: resolved "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz" integrity sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ== -postcss@>=8.4.31: +postcss@^8.0.0, postcss@^8.1.0, postcss@>=8.0.9, postcss@>=8.4.31: version "8.4.38" resolved "https://registry.npmjs.org/postcss/-/postcss-8.4.38.tgz" integrity sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A== @@ -1519,7 +1524,7 @@ postcss@>=8.4.31: prettier-plugin-sql@^0.18.0: version "0.18.0" - resolved "https://registry.yarnpkg.com/prettier-plugin-sql/-/prettier-plugin-sql-0.18.0.tgz#b30fdccf5da714b22233828d1f3536980faef485" + resolved "https://registry.npmjs.org/prettier-plugin-sql/-/prettier-plugin-sql-0.18.0.tgz" integrity sha512-E7WXooLNtWyv79sYYHtQbfvXZ5B/OOR0ySBsB2evfrfvD4wJos1OKLBvVLC/a7+7YpG30bSUTgc2DEwz8ctPmQ== dependencies: jsox "^1.2.118" @@ -1527,7 +1532,7 @@ prettier-plugin-sql@^0.18.0: sql-formatter "^15.0.2" tslib "^2.6.2" -prettier@^3.2.5: +prettier@^3.0.3, prettier@^3.2.5: version "3.2.5" resolved "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz" integrity sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A== @@ -1559,12 +1564,12 @@ quick-lru@^5.1.1: railroad-diagrams@^1.0.0: version "1.0.0" - resolved "https://registry.yarnpkg.com/railroad-diagrams/-/railroad-diagrams-1.0.0.tgz#eb7e6267548ddedfb899c1b90e57374559cddb7e" + resolved "https://registry.npmjs.org/railroad-diagrams/-/railroad-diagrams-1.0.0.tgz" integrity sha512-cz93DjNeLY0idrCNOH6PviZGRN9GJhsdm9hpn1YCS879fj4W+x5IFJhhkRZcwVgMmFF7R82UA/7Oh+R8lLZg6A== randexp@0.4.6: version "0.4.6" - resolved "https://registry.yarnpkg.com/randexp/-/randexp-0.4.6.tgz#e986ad5e5e31dae13ddd6f7b3019aa7c87f60ca3" + resolved "https://registry.npmjs.org/randexp/-/randexp-0.4.6.tgz" integrity sha512-80WNmd9DA0tmZrw9qQa62GPPWfuXJknrmVmLcxvq4uZBdYqb1wYoKTmnlGUchvVWe0XiLupYkBoXVOxz3C8DYQ== dependencies: discontinuous-range "1.0.0" @@ -1643,7 +1648,7 @@ restore-cursor@^4.0.0: ret@~0.1.10: version "0.1.15" - resolved "https://registry.yarnpkg.com/ret/-/ret-0.1.15.tgz#b8a4825d5bdb1fc3f6f53c2bc33f81388681c7bc" + resolved "https://registry.npmjs.org/ret/-/ret-0.1.15.tgz" integrity sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg== reusify@^1.0.4: @@ -1656,13 +1661,6 @@ rfdc@^1.3.1: resolved "https://registry.npmjs.org/rfdc/-/rfdc-1.3.1.tgz" integrity sha512-r5a3l5HzYlIC68TpmYKlxWjmOP6wiPJ1vWv2HeLhNsRZMrCkxeqxiHlQ21oXmQ4F3SiryXBHhAD7JZqvOJjFmg== -rimraf@2: - version "2.7.1" - resolved "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz" - integrity sha512-uWjbaKIK3T1OSVptzX7Nl6PvQ3qAGtKEtVRjRuazjfL3Bx5eI409VZSqgND+4UNnmzLVdPj9FqFJNPqBZFve4w== - dependencies: - glob "^7.1.3" - rimraf@^5.0.0: version "5.0.7" resolved "https://registry.npmjs.org/rimraf/-/rimraf-5.0.7.tgz" @@ -1670,6 +1668,13 @@ rimraf@^5.0.0: dependencies: glob "^10.3.7" +rimraf@2: + version "2.7.1" + resolved "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz" + integrity sha512-uWjbaKIK3T1OSVptzX7Nl6PvQ3qAGtKEtVRjRuazjfL3Bx5eI409VZSqgND+4UNnmzLVdPj9FqFJNPqBZFve4w== + dependencies: + glob "^7.1.3" + run-parallel@^1.1.9: version "1.2.0" resolved "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz" @@ -1780,13 +1785,20 @@ spdx-license-ids@^3.0.0: sql-formatter@^15.0.2: version "15.3.2" - resolved "https://registry.yarnpkg.com/sql-formatter/-/sql-formatter-15.3.2.tgz#696fb84c3ce6d368b0d16248a605aa0e7a41751e" + resolved "https://registry.npmjs.org/sql-formatter/-/sql-formatter-15.3.2.tgz" integrity sha512-pNxSMf5DtwhpZ8gUcOGCGZIWtCcyAUx9oLgAtlO4ag7DvlfnETL0BGqXaISc84pNrXvTWmt8Wal1FWKxdTsL3Q== dependencies: argparse "^2.0.1" get-stdin "=8.0.0" nearley "^2.20.1" +string_decoder@~1.1.1: + version "1.1.1" + resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz" + integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== + dependencies: + safe-buffer "~5.1.0" + string-argv@~0.3.2: version "0.3.2" resolved "https://registry.npmjs.org/string-argv/-/string-argv-0.3.2.tgz" @@ -1828,13 +1840,6 @@ string-width@^7.0.0: get-east-asian-width "^1.0.0" strip-ansi "^7.1.0" -string_decoder@~1.1.1: - version "1.1.1" - resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz" - integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== - dependencies: - safe-buffer "~5.1.0" - "strip-ansi-cjs@npm:strip-ansi@^6.0.1": version "6.0.1" resolved "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz" @@ -1944,7 +1949,7 @@ to-regex-range@^5.0.1: tslib@^2.6.2: version "2.6.3" - resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.6.3.tgz#0438f810ad7a9edcde7a241c3d80db693c8cbfe0" + resolved "https://registry.npmjs.org/tslib/-/tslib-2.6.3.tgz" integrity sha512-xNvxJEOUiWPGhUuUdQgAJPKOOJfGnIyKySOc09XkKsgdUV/3E2zvwZYdejjmRgPCgcym1juLH3226yA7sEFJKQ== type-fest@^1.0.1: From ab52a00624f1df1a23acc2334f51cfff960716cd Mon Sep 17 00:00:00 2001 From: Jack <56563911+jdockerty@users.noreply.github.com> Date: Fri, 12 Jul 2024 00:25:59 +0100 Subject: [PATCH 25/96] docs(clustered): clarify tuning garbage collector env vars (#5517) * docs: clarify clustered gc env tunables * docs: use suggested wording Co-authored-by: Scott Anderson --------- Co-authored-by: Scott Anderson --- .../clustered/write-data/best-practices/data-lifecycle.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/influxdb/clustered/write-data/best-practices/data-lifecycle.md b/content/influxdb/clustered/write-data/best-practices/data-lifecycle.md index 91420dbd5..55194db8f 100644 --- a/content/influxdb/clustered/write-data/best-practices/data-lifecycle.md +++ b/content/influxdb/clustered/write-data/best-practices/data-lifecycle.md @@ -45,6 +45,9 @@ Use the following environment variables to tune the garbage collector: - `INFLUXDB_IOX_GC_PARQUETFILE_CUTOFF`: how long to retain rows in the Catalog that reference Parquet files marked for deletion. The default is `30d`. +These values tune how aggressive the garbage collector can be. A shorter duration +value means that files can be removed at a faster pace. + {{% warn %}} To ensure there is a grace period before files and references are removed, the minimum garbage collector (GC) object store and Parquet file cutoff time is From ca8ab1e4a1ee81a54f490b5d05aff09126219703 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 15 Jul 2024 15:06:59 -0600 Subject: [PATCH 26/96] InfluxDB 2.7.7 (#5521) * InfluxDB 2.7.7 * updated latest patch for oss v2 * Update content/influxdb/v2/reference/release-notes/influxdb.md Co-authored-by: Jason Stirnaman --------- Co-authored-by: Jason Stirnaman --- .../v2/reference/release-notes/influxdb.md | 130 +++++++++++++++--- data/products.yml | 2 +- 2 files changed, 113 insertions(+), 19 deletions(-) diff --git a/content/influxdb/v2/reference/release-notes/influxdb.md b/content/influxdb/v2/reference/release-notes/influxdb.md index e4b94960f..7cb723105 100644 --- a/content/influxdb/v2/reference/release-notes/influxdb.md +++ b/content/influxdb/v2/reference/release-notes/influxdb.md @@ -8,8 +8,37 @@ menu: weight: 101 --- +## v2.7.7 {date="2024-07-12"} + +### Features + +- Disable `file://` URLs when [hardening is enabled](/influxdb/v2/reference/config-options/#hardening-enabled). + +### Bug Fixes + +- Ensure `TSMBatchKeyIterator` and `FileStore` close all `TSMReader`s. +- Return `MergeIterator.Close` errors. +- Ensure `GROUP BY` queries with an offset that crosses a date time boundary + (daylight savings time, British summer time, etc.) do not fail. +- Preserve time zone information in the Task Scheduler. +- Prevent the retention service from becoming unresponsive. + +### Maintenance + +- Update Flux to v0.195.1. +- Update `logrus` to 1.9.3. +- Update `golang.org/x/net` to v0.23.0. +- Update `protocol` buffers to v5.26.1. +- Update `go` toolchain to 1.21.10. + +--- + ## v2.7.6 {date="2024-04-12"} +### Features + +- Add optional [stricter password requirements](/influxdb/v2/reference/config-options/#strong-passwords). + ### Bug Fixes - Fix `panic index out of range` error for invalid series keys. @@ -19,16 +48,19 @@ weight: 101 - Return and respect cursor errors. - Update constant time code to make password strength calculations more constant. -### Features - -- Add optional [stricter password requirements](/influxdb/v2/reference/config-options/#strong-passwords). - ### Maintenance - Upgrade to Go to 1.21.9. +--- + ## v2.7.5 {date="2024-01-05"} +### Features + +- Add authenticating ID and user ID to request logging. +- Write detailed logs from endpoint detection and response (EDR) failures. + ### Bug Fixes - Only execute `init_config` on install. @@ -36,32 +68,35 @@ weight: 101 - Correctly return `4xx` errors instead of `5xx` errors. - Prevent retention service from creating orphaned shard files. -### Features - -- Add authenticating ID and user ID to request logging. -- Write detailed logs from endpoint detection and response (EDR) failures. - ### Maintenance - Emit build commands during tests. - Upgrade Flux to 0.194.5. +--- + ## v2.7.4 {date="2023-11-14"} _Internal changes only._ +--- + ## v2.7.3 {date="2023-10-17"} ### Maintenance - Upgrade Flux to 0.194.3. +--- + ## v2.7.1 {date="2023-04-28"} ### Bug Fixes - Update the InfluxDB UI to remove non-functional Data Explorer. +--- + ## v2.7.0 {date="2023-04-05"} ### Bug Fixes @@ -89,6 +124,8 @@ _Internal changes only._ - Bump `containerd` to 1.6.18. - Bump `github.com/opencontainers/runc` from 1.1.3 to 1.1.5. +--- + ## v2.6.1 {date="2022-12-29"} ### Bug Fixes @@ -96,6 +133,8 @@ _Internal changes only._ - Update user interface (UI) to fix dashboard page crash issue. - Fix `All Access` token creation issue. +--- + ## v2.6.0 {date="2022-12-15"} ### Features @@ -122,12 +161,16 @@ _Internal changes only._ - Upgrade to Go 1.18.9. - Upgrade Flux to v0.191.0. +--- + ## v2.5.1 {date="2022-11-09"} ### Bug fixes - Fix permissions issue in Debian and Red Hat package managers. +--- + ## v2.5.0 {date="2022-11-01"} ### Features @@ -154,6 +197,8 @@ _Internal changes only._ - Upgrade to [Go 1.18.7](https://go.dev/doc/go1.18) - Upgrade to [Rust 1.63.0](https://www.rust-lang.org/) +--- + ## v2.4.0 {date="2022-08-19"} ### Features @@ -196,6 +241,8 @@ _Internal changes only._ - Upgrade to [Go 1.18.4](https://go.dev/doc/go1.18). - Upgrade to [Flux 0.179.0](/flux/v0/release-notes/#v01790). +--- + ## v2.3.0 {date="2022-06-17"} This release includes the following [maintenance](#maintenance), [features](#features), [security updates](#security-updates) and [bug fixes](#bug-fixes). @@ -255,6 +302,8 @@ Several security issues were fixed in dependencies and the toolchain used to bui - Fix rare case where measurement cardinality reported less than zero. - Resolve panic on cleaning up failed iterators. +--- + ## v2.2.0 {date="2022-04-06"} This release includes the following new [features](#features) and several [bug fixes](#bug-fixes). @@ -397,9 +446,11 @@ the toolchain used to build InfluxDB, including: - `nats-port` and `nats-max-payload-bytes` flags have been deprecated. - NATS is no longer embedded in InfluxDB. Because InfluxDB no longer requires a port for NATS, port conflict issues are reduced. - Resolve the issue that prevented the browser from tracking the cookie `expiry` correctly, causing the cookie to expire automatically when restarting the browser or changing tabs. Now, the cookie is correctly preserved. -- Allow unlimited Flux HTTP calls. Previously, HTTP requests failed silently after 100MB of data transfer. +- Allow unlimited Flux HTTP calls. Previously, HTTP requests failed silently after 100 MB of data transfer. - Remove pagination limits on the `/telegrafs` API. Previously, pagination wasn't exposed to the API, so API requests were limited to the default 20 pages. +--- + ## v2.1.1 {date="2021-11-08"} {{% note %}} @@ -542,6 +593,8 @@ For more information about each plugin, see [Telegraf plugins](/telegraf/v1/plug - Do not allow shard creation to create overlapping shards. - Don't drop shard group durations when upgrading InfluxDB. +--- + ## v2.0.9 {date="2021-09-27"} This release includes several new [features](#features) and [bug fixes](#bug-fixes). @@ -632,7 +685,7 @@ This release includes the following bug fixes and updates: #### Task updates -- Updating an inactive task no longer schedules it. Thanks @raffs! +- Updating an inactive task no longer schedules it. - Preserve comments in Flux queries when saving task definitions. #### Version maintenance @@ -640,6 +693,8 @@ This release includes the following bug fixes and updates: - Fix `X-Influxdb-Build` and `X-Influxdb-Version` response header at `/ping`. - Upgrade `influxql` to latest version and fix predicate handling for `SHOW TAG VALUES` meta queries. +--- + ## v2.0.8 {date="2021-08-13"} {{% warn %}} #### Upcoming changes to influx CLI packaging @@ -679,7 +734,9 @@ To adopt the new, separate `influx` CLI early, download the latest release from - Prevent silently dropped writes when there are overlapping shards. - Invalid requests to `/api/v2` subroutes now return 404 instead of a list of links. - Flux meta queries for `_field` take fast path if `_measurement` is the only predicate. -- Copy names from mmapped memory before closing iterator. +- Copy names from `mmap` mapped memory before closing iterator. + +--- ## v2.0.7 {date="2021-06-04"} @@ -716,6 +773,8 @@ To adopt the new, separate `influx` CLI early, download the latest release from - Correctly validate when `query-concurrency` is `0` and `query-queue-size` is greater than `0`. +--- + ## v2.0.5 General Availability {date="2021-04-27"} {{% warn %}} @@ -797,7 +856,7 @@ The prefix used for Prometheus metrics from the query controller has changed fro - Fix use-after-free bug in series ID iterator. - Fix TSM and WAL segment size check to check against the local `SegmentSize`. - Fix TSM and WAL segment size computing to correctly calculate `totalOldDiskSize`. -- Update references to the documentation site site to use current URLs. +- Update references to the documentation site to use current URLs. - Fix data race in then TSM engine when inspecting tombstone statistics. - Fix data race in then TSM cache. - Deprecate misleading `retentionPeriodHrs` key in the onboarding API. @@ -815,6 +874,8 @@ The prefix used for Prometheus metrics from the query controller has changed fro - Reduce lock contention when adding new fields and measurements. - Escape dots in community templates hostname regular expression. +--- + ## v2.0.4 General Availability {date="2021-02-04"} ### Docker @@ -891,6 +952,8 @@ The startup process automatically generates replacement `tsi1` indexes for shard - Support creating users without initial passwords in `influx user create`. - Fix incorrect errors when passing `--bucket-id` to `influx write`. +--- + ## v2.0.3 General Availability {date="2020-12-14"} ### Breaking Changes @@ -935,6 +998,8 @@ This release also defines v2-specific path defaults and provides [helper scripts - Allow for 0 (infinite) values for `--retention` in `influx setup`. - Fix panic when using a `null` value as a record or array in a Flux query. +--- + ## v2.0.2 General Availability {date="2020-11-19"} ### Breaking changes @@ -969,6 +1034,8 @@ Previously, the database retention policy (DBRP) mapping API did not match the s - Allow self-signed certificates for scraper targets. - Bump version in `package.json` so it appears correctly. +--- + ## v2.0.1 General Availability {date="2020-11-10"} InfluxDB 2.0 general availability (GA) introduces the first **production-ready** open source version of InfluxDB 2.0. This release comprises all features and bug fixes included in prior alpha, beta, and release candidate versions. @@ -996,6 +1063,8 @@ Highlights include: If you're new to InfluxDB 2.0, we recommend checking out [how to get started](/influxdb/v2/get-started/) and [InfluxDB key concepts](/influxdb/v2/reference/key-concepts/). +--- + ## v2.0.0 {date="2020-11-09"} ### Features @@ -1017,6 +1086,8 @@ If you're new to InfluxDB 2.0, we recommend checking out [how to get started](/i - Remove bucket and mapping auto-creation from `/write` 1.x compatibility API. - Fix misuse of `reflect.SliceHeader`. +--- + ## v2.0.0-rc.4 {date="2020-11-05"} ### Features @@ -1041,6 +1112,8 @@ If you're new to InfluxDB 2.0, we recommend checking out [how to get started](/i - Return an empty iterator instead of null in `tagValues`. - Fix the `/ready` response content type to return `application/json`. +--- + ## v2.0.0-rc.3 {date="2020-10-29"} ### Features @@ -1063,6 +1136,8 @@ If you're new to InfluxDB 2.0, we recommend checking out [how to get started](/i - Refactor to allow `newIndexSeriesCursor()` to accept an `influxql.Expr`. - Remove unreferenced packages. +--- + ## v2.0.0-rc.2 {date="2020-10-22"} ### Features @@ -1081,6 +1156,8 @@ If you're new to InfluxDB 2.0, we recommend checking out [how to get started](/i - Enable the new `AuthorizationService` from authorization package in the `launcher` package (`cmd\influxd\launcher`). - Update `config upgrade` to save the correct InfluxDB configuration filename. +--- + ## v2.0.0-rc.1 {date="2020-10-14"} ### Features @@ -1095,6 +1172,8 @@ If you're new to InfluxDB 2.0, we recommend checking out [how to get started](/i - Resolve issue to ensure the `influx` CLI successfully returns a single Telegraf configuration. - Ensure passwords are at least 8 characters in `influx setup`. +--- + ## v2.0.0-rc.0 {date="2020-09-29"} {{% warn %}} @@ -1161,6 +1240,8 @@ To simplify the migration for existing users of InfluxDB 1.x, this release inclu - Ensure the group annotation does not override the existing line part (measurement, field, tag, time) in a CSV group annotation. - Added `PATCH` to the list of allowed methods. +--- + ## v2.0.0-beta.16 {date="2020-08-06"} {{% warn %}} @@ -1190,6 +1271,8 @@ This release includes breaking changes: - Alerts page filter inputs now have tab indices for keyboard navigation. +--- + ## v2.0.0-beta.15 {date="2020-07-23"} ### Features @@ -1206,6 +1289,8 @@ This release includes breaking changes: - Single Stat cells render properly in Safari. - Limit variable querying when submitting queries to used variables. +--- + ## v2.0.0-beta.14 {date="2020-07-08"} ### Features @@ -1222,6 +1307,8 @@ This release includes breaking changes: - Fix issue where define query was unusable after importing a Check. - Update documentation links +--- + ## v2.0.0-beta.13 {date="2020-06-25"} ### Features @@ -1251,6 +1338,8 @@ This release includes breaking changes: - Validate `host-url` for `influx config create` and `influx config set` commands. - Fix `influx` CLI flags to accurately depict flags for all commands. +--- + ## v2.0.0-beta.12 {date="2020-06-12"} ### Features @@ -1281,6 +1370,8 @@ This release includes breaking changes: - Reduce the number of variables being hydrated when toggling variables. - Redesign dashboard cell loading indicator to be more obvious. +--- + ## v2.0.0-beta.11 {date="2020-05-27"} {{% warn %}} @@ -1303,6 +1394,8 @@ The beta 11 version was **not released**. Changes below are included in the beta - Resolve scrollbar issues to ensure datasets are visible and scrollable. - Check status now displays a warning if loading a large amount. +--- + ## v2.0.0-beta.10 {date="2020-05-07"} ### Features @@ -1368,7 +1461,7 @@ The beta 11 version was **not released**. Changes below are included in the beta - Make all `pkg` resources unique by `metadata.name` field. - Ensure Telegraf configuration tokens aren't retrievable after creation. New tokens can be created after Telegraf has been setup. - [Delete bucket by name](/influxdb/v2/admin/buckets/delete-bucket/#delete-a-bucket-by-name) using the `influx` CLI. -- Add helper module to write line protocol to specified url, org, and bucket. +- Add helper module to write line protocol to specified URL, organization, and bucket. - Add [`pkg stack`](/influxdb/v2/reference/cli/influx/stacks) for stateful package management. - Add `--no-tasks` flag to `influxd` to disable scheduling of tasks. - Add ability to output CLI output as JSON and hide table headers. @@ -1710,8 +1803,9 @@ The beta 11 version was **not released**. Changes below are included in the beta #### Known Issues The version of Flux included in Alpha 14 introduced `null` support. -Most issues related to the `null` implementation have been fixed, but one known issue remains – -The `map()` function panics if the first record processed has a `null` value. +Most issues related to the `null` implementation have been fixed, but one known +issue remains--the `map()` function panics if the first record processed has a +`null` value. --- @@ -1918,7 +2012,7 @@ This release includes a breaking change to the format in which Time-Structured M _**Existing local data will not be queryable after upgrading to this release.**_ Prior to installing this release, remove all storage-engine data from your local InfluxDB 2.x installation. -To remove only TSM and index data and preserve all other other InfluxDB 2.x data (organizations, buckets, settings, etc), +To remove only TSM and index data and preserve all other InfluxDB 2.x data (organizations, buckets, settings, etc), run the following command. ###### Linux and macOS @@ -2011,7 +2105,7 @@ Once completed, InfluxDB v2.0.0-alpha.5 can be started. - Change the wording for the plugin config form button to "Done." - Change the wording for the Collectors configure step button to "Create and Verify." - Standardize page loading spinner styles. -- Show checkbox on "Save As" button in data explorer. +- Show checkbox on "Save As" button in Data Explorer. - Make collectors plugins side bar visible in only the configure step. - Swap retention policies on Create bucket page. diff --git a/data/products.yml b/data/products.yml index be2ace52e..0179bf4e7 100644 --- a/data/products.yml +++ b/data/products.yml @@ -21,7 +21,7 @@ influxdb: - v1.7 latest: v2.7 latest_patches: - v2: 2.7.6 + v2: 2.7.7 v1: 1.8.10 latest_cli: v2: 2.7.5 From a1fb10eb1cc296b8b5a24f7275c360ea498cf319 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 17 Jul 2024 11:31:37 -0600 Subject: [PATCH 27/96] Remove limited access banner from Clustered (#5524) * remove limited access banner from clustered, closes #5523 * fix typo * update clustered install intro --- content/influxdb/clustered/install/_index.md | 8 ++++++++ layouts/index.html | 2 +- layouts/partials/article/limited-availability.html | 3 ++- 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/content/influxdb/clustered/install/_index.md b/content/influxdb/clustered/install/_index.md index 374b4d438..8fe1cac7f 100644 --- a/content/influxdb/clustered/install/_index.md +++ b/content/influxdb/clustered/install/_index.md @@ -10,6 +10,14 @@ InfluxDB Clustered is deployed and managed using Kubernetes. This multi-page guide walks through setting up prerequisites and configuring your InfluxDB cluster deployment. +InfluxDB Clustered is a commercial product offered by InfluxData, the creators +of InfluxDB. Please contact InfluxData Sales to obtain a license before +installing InfluxDB Clustered. + +Contact InfluxData Sales + +## Setup, configure, and deploy InfluxDB Clustered + {{< children type="ordered-list" >}} diff --git a/layouts/index.html b/layouts/index.html index 164705e15..7b15cec16 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -33,7 +33,7 @@

Self-managed

-
+

InfluxDB Clustered

Highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

diff --git a/layouts/partials/article/limited-availability.html b/layouts/partials/article/limited-availability.html index fc4e4bfba..865857847 100644 --- a/layouts/partials/article/limited-availability.html +++ b/layouts/partials/article/limited-availability.html @@ -1,8 +1,9 @@ + {{ $productPathData := findRE "[^/]+.*?" .RelPermalink }} {{ $product := index $productPathData 0 }} {{ $version := index $productPathData 1 }} {{ $productData := index $.Site.Data.products (print $product "_" (replaceRE "-" "_" $version)) }} -{{ $earlyAccessList := slice "influxdb/clustered" }} +{{ $earlyAccessList := slice " " }} {{ if in $earlyAccessList (print $product "/" $version )}}
From 61b127870f18d1a1647d6ce0cc7f0b33e1485acc Mon Sep 17 00:00:00 2001 From: wayne Date: Thu, 18 Jul 2024 14:48:57 -0600 Subject: [PATCH 28/96] chore: update Clustered influxctl example config (#5525) --- .../influxdb/clustered/reference/cli/influxctl/_index.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/content/influxdb/clustered/reference/cli/influxctl/_index.md b/content/influxdb/clustered/reference/cli/influxctl/_index.md index a03017bc0..ba60c8071 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/_index.md +++ b/content/influxdb/clustered/reference/cli/influxctl/_index.md @@ -336,7 +336,16 @@ If stored at a non-default location, include the `--config` flag with each ## By default, the system certificates are used. If a custom certificate ## for connecting to InfluxDB is required, define it below. # [profile.tls] + ## When true, `insecure` influxctl configures HTTPS clients to not + ## verify server certificates. Use this if you are connecting to a + ## TLS endpoint with invalid (expired, self-signed, etc) server + ## certificates. # insecure = false + ## When true, `disable` causes influxctl to use HTTP rather than HTTPS + ## client. Use this if you don't have an ingress controller configured + ## to terminate TLS connections. InfluxDB 3.0 components themselves do + ## not terminate TLS. + # disable = false # cert = "" # key = "" # ca = "" From e851b0089ec7ab2d736f4b760422af52d0a55c22 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 22 Jul 2024 10:05:53 -0600 Subject: [PATCH 29/96] Scale InfluxDB Clustered (#5526) * clustered scaling guide * Update content/influxdb/clustered/admin/scale-cluster.md Co-authored-by: Jason Stirnaman * add information about ingester storage volumes to scaling guide * Update content/influxdb/clustered/reference/glossary.md Co-authored-by: Jason Stirnaman --------- Co-authored-by: Jason Stirnaman --- .../admin/bypass-identity-provider.md | 2 +- .../influxdb/clustered/admin/scale-cluster.md | 352 ++++++++++++++++++ .../clustered/install/configure-cluster.md | 24 +- .../influxdb/clustered/reference/glossary.md | 10 +- .../reference/internals/storage-engine.md | 67 +--- 5 files changed, 385 insertions(+), 70 deletions(-) create mode 100644 content/influxdb/clustered/admin/scale-cluster.md diff --git a/content/influxdb/clustered/admin/bypass-identity-provider.md b/content/influxdb/clustered/admin/bypass-identity-provider.md index 0827a2b13..7d5c7ec3a 100644 --- a/content/influxdb/clustered/admin/bypass-identity-provider.md +++ b/content/influxdb/clustered/admin/bypass-identity-provider.md @@ -7,7 +7,7 @@ description: > menu: influxdb_clustered: parent: Administer InfluxDB Clustered -weight: 207 +weight: 208 --- {{< product-name >}} generates a valid access token (known as the _admin token_) diff --git a/content/influxdb/clustered/admin/scale-cluster.md b/content/influxdb/clustered/admin/scale-cluster.md new file mode 100644 index 000000000..061a3e702 --- /dev/null +++ b/content/influxdb/clustered/admin/scale-cluster.md @@ -0,0 +1,352 @@ +--- +title: Scale your InfluxDB cluster +description: > + InfluxDB Clustered lets you scale individual components of your cluster both + vertically and horizontally to match your specific workload. +menu: + influxdb_clustered: + parent: Administer InfluxDB Clustered + name: Scale your cluster +weight: 207 +influxdb/clustered/tags: [scale] +related: + - /influxdb/clustered/reference/internals/storage-engine/ + - https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits, Kubernetes resource requests and limits +--- + +InfluxDB Clustered lets you scale individual components of your cluster both +vertically and horizontally to match your specific workload. +Use the `AppInstance` resource defined in your `influxdb.yml` to manage +resources available to each component. + +- [Scaling strategies](#scaling-strategies) + - [Vertical scaling](#vertical-scaling) + - [Horizontal scaling](#horizontal-scaling) +- [Scale components in your cluster](#scale-components-in-your-cluster) + - [Horizontally scale a component](#horizontally-scale-a-component) + - [Vertically scale a component](#vertically-scale-a-component) + - [Apply your changes](#apply-your-changes) +- [Scale your cluster as a whole](#scale-your-cluster-as-a-whole) +- [Recommended scaling strategies per component](#recommended-scaling-strategies-per-component) + - [Ingester](#ingester) + - [Querier](#querier) + - [Router](#router) + - [Compactor](#compactor) + - [Catalog](#catalog) + - [Object store](#object-store) + +## Scaling strategies + +The following scaling strategies can be applied to components in your InfluxDB +cluster. + +### Vertical scaling + +Vertical scaling (also known as "scaling up") involves increasing the resources +(such as RAM or CPU) available to a process or system. +Vertical scaling is typically used to handle resource-intensive tasks that +require more processing power. + +{{< html-diagram/scaling-strategy "vertical" >}} + +### Horizontal scaling + +Horizontal scaling (also known as "scaling out") involves increasing the number of +nodes or processes available to perform a given task. +Horizontal scaling is typically used to increase the amount of workload or +throughput a system can manage, but also provides additional redundancy and failover. + +{{< html-diagram/scaling-strategy "horizontal" >}} + +## Scale components in your cluster + +The following components of your InfluxDB cluster are scaled by modifying +properties in your `AppInstance` resource: + +- Ingester +- Querier +- Compactor +- Router + +{{% note %}} +#### Scale your Catalog and Object store + +Your InfluxDB [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog) +and [Object store](/influxdb/clustered/reference/internals/storage-engine/#object-store) +are managed outside of your `AppInstance` resource. Scaling mechanisms for these +components depend on the technology and underlying provider used for each. +{{% /note %}} + +Use the `spec.package.spec.resources` property in your `AppInstance` resource +defined in your `influxdb.yml` to define system resource minimums and limits +for each pod and the number of replicas per component. +`requests` are the minimum that the Kubernetes scheduler should reserve for a pod. +`limits` are the maximum that a pod should be allowed to use. + +Your `AppInstance` resource can include the following properties to define +resource minimums and limits per pod and replicas per component: + +- `spec.package.spec.resources` + - `ingester` + - `requests` + - `cpu`: Minimum CPU resource units to assign to ingesters + - `memory`: Minimum memory resource units to assign to ingesters + - `replicas`: Number of ingester replicas to provision + - `limits` + - `cpu`: Maximum CPU resource units to assign to ingesters + - `memory`: Maximum memory resource units to assign to ingesters + - `compactor` + - `requests` + - `cpu`: Minimum CPU resource units to assign to compactors + - `memory`: Minimum memory resource units to assign to compactors + - `replicas`: Number of compactor replicas to provision + - `limits` + - `cpu`: Maximum CPU resource units to assign to compactors + - `memory`: Maximum memory resource units to assign to compactors + - `querier` + - `requests` + - `cpu`: Minimum CPU resource units to assign to queriers + - `memory`: Minimum memory resource units to assign to queriers + - `replicas`: Number of querier replicas to provision + - `limits` + - `cpu`: Maximum CPU resource units to assign to queriers + - `memory`: Maximum memory resource units to assign to queriers + - `router` + - `requests` + - `cpu`: Minimum CPU resource units to assign to routers + - `memory`: Minimum memory resource units to assign to routers + - `replicas`: Number of router replicas to provision + - `limits` + - `cpu`: Maximum CPU Resource units to assign to routers + - `memory`: Maximum memory resource units to assign to routers + +{{< expand-wrapper >}} +{{% expand "View example `AppInstance` with resource requests and limits" %}} + +{{% code-placeholders "(INGESTER|COMPACTOR|QUERIER|ROUTER)_(CPU_(MAX|MIN)|MEMORY_(MAX|MIN)|REPLICAS)" %}} + +```yml +apiVersion: kubecfg.dev/v1alpha1 +kind: AppInstance +# ... +spec: + package: + spec: + # The following settings tune the various pods for their cpu/memory/replicas + # based on workload needs. Only uncomment the specific resources you want + # to change. Anything left commented will use the package default. + resources: + ingester: + requests: + cpu: INGESTER_CPU_MIN + memory: INGESTER_MEMORY_MIN + replicas: INGESTER_REPLICAS # Default is 3 + limits: + cpu: INGESTER_CPU_MAX + memory: INGESTER_MEMORY_MAX + compactor: + requests: + cpu: COMPACTOR_CPU_MIN + memory: COMPACTOR_MEMORY_MIN + replicas: COMPACTOR_REPLICAS # Default is 1 + limits: + cpu: COMPACTOR_CPU_MAX + memory: COMPACTOR_MEMORY_MAX + querier: + requests: + cpu: QUERIER_CPU_MIN + memory: QUERIER_MEMORY_MIN + replicas: QUERIER_REPLICAS # Default is 1 + limits: + cpu: QUERIER_CPU_MAX + memory: QUERIER_MEMORY_MAX + router: + requests: + cpu: ROUTER_CPU_MIN + memory: ROUTER_MEMORY_MIN + replicas: ROUTER_REPLICAS # Default is 1 + limits: + cpu: ROUTER_CPU_MAX + memory: ROUTER_MEMORY_MAX +``` + +{{% /code-placeholders %}} + +{{% /expand %}} +{{< /expand-wrapper >}} + +{{% note %}} +Applying resource limits to pods is optional, but provides better resource +isolation and protects against pods using more resources than intended. For +information, see [Kubernetes resource requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits). +{{% /note %}} + +##### Related Kubernetes documentation + +- [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) +- [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) + +### Horizontally scale a component + +To horizontally scale a component in your InfluxDB cluster, increase or decrease +the number of replicas for the component in the `spec.package.spec.resources` +property in your `AppInstance` resource and [apply the change](#apply-your-changes). + +{{% warn %}} +#### Only use the AppInstance to scale component replicas + +Only use the `AppInstance` resource to scale component replicas. +Manually scaling replicas may cause errors. +{{% /warn %}} + +For example--to horizontally scale your +[Ingester](/influxdb/clustered/reference/internals/storage-engine/#ingester): + +```yaml +apiVersion: kubecfg.dev/v1alpha1 +kind: AppInstance +# ... +spec: + package: + spec: + resources: + ingester: + requests: + # ... + replicas: 6 +``` + +### Vertically scale a component + +To vertically scale a component in your InfluxDB cluster, increase or decrease +the CPU and memory resource units to assign to component pods in the +`spec.package.spec.resources` property in your `AppInstance` resource and +[apply the change](#apply-your-changes). + +```yaml +apiVersion: kubecfg.dev/v1alpha1 +kind: AppInstance +# ... +spec: + package: + spec: + resources: + ingester: + requests: + cpu: "500m" + memory: "512MiB" + # ... + limits: + cpu: "1000m" + memory: "1024MiB" +``` + +### Apply your changes + +After modifying the `AppInstance` resource, use `kubectl apply` to apply the +configuration changes to your cluster and scale the updated components. + +```sh +kubectl apply \ + --filename myinfluxdb.yml \ + --namespace influxdb +``` + +## Scale your cluster as a whole + +Scaling your entire InfluxDB Cluster is done by scaling your Kubernetes cluster +and is managed outside of InfluxDB. The process of scaling your entire Kubernetes +cluster depends on your underlying Kubernetes provider. You can also use +[Kubernetes autoscaling](https://kubernetes.io/docs/concepts/cluster-administration/cluster-autoscaling/) +to automatically scale your cluster as needed. + +## Recommended scaling strategies per component + +- [Ingester](#ingester) +- [Querier](#querier) +- [Router](#router) +- [Compactor](#compactor) +- [Catalog](#catalog) +- [Object store](#object-store) + +### Ingester + +The Ingester can be scaled both [vertically](#vertical-scaling) and +[horizontally](#horizontal-scaling). +Vertical scaling increases write throughput and is typically the most effective +scaling strategy for the Ingester. + +#### Ingester storage volume + +Ingesters use an attached storage volume to store the +[Write-Ahead Log (WAL)](/influxdb/clustered/reference/glossary/#wal-write-ahead-log). +With more storage available, Ingesters can keep bigger WAL buffers, which +improves query performance and reduces pressure on the Compactor. +Storage speed also helps with query performance. + +Configure the storage volume attached to Ingester pods in the +`spec.package.spec.ingesterStorage` property of your `AppInstance` resource. + +{{< expand-wrapper >}} +{{% expand "View example Ingester storage configuration" %}} + +{{% code-placeholders "STORAGE_(CLASS|SIZE)" %}} + +```yml +apiVersion: kubecfg.dev/v1alpha1 +kind: AppInstance +# ... +spec: + package: + spec: + # ... + ingesterStorage: + # (Optional) Set the storage class. This will differ based on the K8s + #environment and desired storage characteristics. + # If not set, the default storage class is used. + storageClassName: STORAGE_CLASS + # Set the storage size (minimum 2Gi recommended) + storage: STORAGE_SIZE +``` + +{{% /code-placeholders %}} + +{{% /expand %}} +{{< /expand-wrapper >}} + +### Querier + +The Querier can be scaled both [vertically](#vertical-scaling) and +[horizontally](#horizontal-scaling). +Horizontal scaling increases query throughput to handle more concurrent queries. +Vertical scaling improves the Querier’s ability to process computationally +intensive queries. + +### Router + +The Router can be scaled both [vertically](#vertical-scaling) and +[horizontally](#horizontal-scaling). +Horizontal scaling increases request throughput and is typically the most effective +scaling strategy for the Router. + +### Compactor + +The Compactor can be scaled both [vertically](#vertical-scaling) and +[horizontally](#horizontal-scaling). +Because compaction is a compute-heavy process, vertical scaling (especially +increasing the available CPU) is the most effective scaling strategy for the +Compactor. Horizontal scaling increases compaction throughput, but not as +efficiently as vertical scaling. + +### Catalog + +Scaling strategies available for the Catalog depend on the PostgreSQL-compatible +database used to run the catalog. All support [vertical scaling](#vertical-scaling). +Most support [horizontal scaling](#horizontal-scaling) for redundancy and failover. + +### Object store + +Scaling strategies available for the Object store depend on the underlying +object storage services used to run the object store. Most support +[horizontal scaling](#horizontal-scaling) for redundancy, failover, and +increased capacity. diff --git a/content/influxdb/clustered/install/configure-cluster.md b/content/influxdb/clustered/install/configure-cluster.md index a3e8dd584..3c521f681 100644 --- a/content/influxdb/clustered/install/configure-cluster.md +++ b/content/influxdb/clustered/install/configure-cluster.md @@ -757,21 +757,21 @@ your anticipated workload. in your `myinfluxdb.yml`. If omitted, your cluster will use the default scale settings. - `spec.package.spec.resources` - - `.ingester.requests` - - `.cpu`: CPU Resource units to assign to ingesters - - `.memory`: Memory resource units to assign to ingesters + - `ingester.requests` + - `cpu`: CPU resource units to assign to ingesters + - `memory`: Memory resource units to assign to ingesters - `replicas`: Number of ingester replicas to provision - - `.compactor.requests` - - `.cpu`: CPU Resource units to assign to compactors - - `.memory`: Memory resource units to assign to compactors + - `compactor.requests` + - `cpu`: CPU resource units to assign to compactors + - `memory`: Memory resource units to assign to compactors - `replicas`: Number of compactor replicas to provision - - `.querier.requests` - - `.cpu`: CPU Resource units to assign to queriers - - `.memory`: Memory resource units to assign to queriers + - `querier.requests` + - `cpu`: CPU resource units to assign to queriers + - `memory`: Memory resource units to assign to queriers - `replicas`: Number of querier replicas to provision - - `.router.requests` - - `.cpu`: CPU Resource units to assign to routers - - `.memory`: Memory resource units to assign to routers + - `router.requests` + - `cpu`: CPU resource units to assign to routers + - `memory`: Memory resource units to assign to routers - `replicas`: Number of router replicas to provision ###### Related Kubernetes documentation diff --git a/content/influxdb/clustered/reference/glossary.md b/content/influxdb/clustered/reference/glossary.md index 4489c1432..307e6d483 100644 --- a/content/influxdb/clustered/reference/glossary.md +++ b/content/influxdb/clustered/reference/glossary.md @@ -1131,15 +1131,17 @@ A statement that sets or updates the value stored in a variable. ## W -### WAL (Write Ahead Log) - enterprise +### WAL (Write-Ahead Log) The temporary cache for recently written points. To reduce the frequency that permanent storage files are accessed, InfluxDB caches new points in the WAL until their total size or age triggers a flush to -more permanent storage. This allows for efficient batching of the writes into the TSM. +more permanent storage. This allows for efficient batching of the writes into +the storage engine. -Points in the WAL can be queried and persist through a system reboot. -On process start, all points in the WAL must be flushed before the system accepts new writes. +Points in the WAL are queryable and persist through a system reboot. +On process start, all points in the WAL must be flushed before the system +accepts new writes. Related entries: [tsm](#tsm-time-structured-merge-tree) diff --git a/content/influxdb/clustered/reference/internals/storage-engine.md b/content/influxdb/clustered/reference/internals/storage-engine.md index f20927fa3..c26add10d 100644 --- a/content/influxdb/clustered/reference/internals/storage-engine.md +++ b/content/influxdb/clustered/reference/internals/storage-engine.md @@ -28,9 +28,6 @@ queries, and is optimized to reduce storage cost. - [Catalog](#catalog) - [Object store](#object-store) - [Compactor](#compactor) -- [Scaling strategies](#scaling-strategies) - - [Vertical scaling](#vertical-scaling) - - [Horizontal scaling](#horizontal-scaling) ## Storage engine diagram @@ -66,8 +63,8 @@ In this process, the Ingester does the following: ##### Ingester scaling strategies -The Ingester can be scaled both [vertically](#vertical-scaling) and -[horizontally](#horizontal-scaling). +The Ingester can be scaled both [vertically](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) +and [horizontally](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling). Vertical scaling increases write throughput and is typically the most effective scaling strategy for the Ingester. @@ -98,10 +95,11 @@ At query time, the querier: ##### Querier scaling strategies -The Querier can be scaled both [vertically](#vertical-scaling) and -[horizontally](#horizontal-scaling). +The Querier can be scaled both [vertically](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) +and [horizontally](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling). Horizontal scaling increases query throughput to handle more concurrent queries. -Vertical scaling improves the Querier's ability to process computationally intensive queries. +Vertical scaling improves the Querier's ability to process computationally +intensive queries. ### Catalog @@ -117,8 +115,10 @@ It fulfills the following roles: ##### Catalog scaling strategies Scaling strategies available for the Catalog depend on the PostgreSQL-compatible -database used to run the catalog. All support [vertical scaling](#vertical-scaling). -Most support [horizontal scaling](#horizontal-scaling) for redundancy and failover. +database used to run the catalog. All support +[vertical scaling](/influxdb/clustered/admin/scale-cluster/#vertical-scaling). +Most support [horizontal scaling](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling) +for redundancy and failover. ### Object store @@ -132,8 +132,8 @@ Data in each Parquet file is sorted, encoded, and compressed. Scaling strategies available for the Object store depend on the underlying object storage services used to run the object store. -Most support [horizontal scaling](#horizontal-scaling) for redundancy, failover, -and increased capacity. +Most support [horizontal scaling](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling) +for redundancy, failover, and increased capacity. ### Compactor @@ -143,48 +143,9 @@ It then updates the [Catalog](#catalog) with locations of compacted data. ##### Compactor scaling strategies -The Compactor can be scaled both [vertically](#vertical-scaling) and -[horizontally](#horizontal-scaling). +The Compactor can be scaled both [vertically](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) +and [horizontally](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling). Because compaction is a compute-heavy process, vertical scaling (especially increasing the available CPU) is the most effective scaling strategy for the Compactor. Horizontal scaling increases compaction throughput, but not as efficiently as vertical scaling. - ---- - -## Scaling strategies - -The following scaling strategies can be applied to components of the InfluxDB v3 -storage architecture. - -{{% note %}} - - - -For information about scaling your {{< product-name >}} infrastructure, -[contact InfluxData support](https://support.influxdata.com). -{{% /note %}} - -### Vertical scaling - -Vertical scaling (also known as "scaling up") involves increasing the resources -(such as RAM or CPU) available to a process or system. -Vertical scaling is typically used to handle resource-intensive tasks that -require more processing power. - -{{< html-diagram/scaling-strategy "vertical" >}} - -### Horizontal scaling - -Horizontal scaling (also known as "scaling out") involves increasing the number of -nodes or processes available to perform a given task. -Horizontal scaling is typically used to increase the amount of workload or -throughput a system can manage, but also provides additional redundancy and failover. - -{{% warn %}} -#### Only use the AppInstance to scale component replicas - -Manually scaling resources may cause errors. -{{% /warn %}} - -{{< html-diagram/scaling-strategy "horizontal" >}} From 5c7d3407ade43d777824e79c5e6ce3ffea441254 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 22 Jul 2024 16:55:00 -0600 Subject: [PATCH 30/96] Update the placeholder URL for dedicated (#5527) * update the placeholder URL for dedicated * added dedicated URL migration --- .../cloud-dedicated/v2/content/servers.yml | 4 +- api-docs/cloud-dedicated/v2/ref.yml | 16 ++-- api-docs/clustered/v2/ref.yml | 12 +-- assets/js/cookies.js | 2 +- assets/js/influxdb-url.js | 78 +++++++++++-------- assets/js/notifications.js | 14 ++-- .../execute-queries/client-libraries/go.md | 2 +- .../client-libraries/flight/java-flightsql.md | 2 +- .../execute-queries/client-libraries/go.md | 2 +- .../client-libraries/flight/java-flightsql.md | 2 +- data/products.yml | 2 +- layouts/partials/footer/javascript.html | 8 +- .../partials/footer/modals/influxdb-url.html | 2 +- shared/text/api/cloud-dedicated/basic-auth.sh | 2 +- .../cloud-dedicated/bearer-auth-v1-query.sh | 2 +- .../cloud-dedicated/bearer-auth-v1-write.sh | 2 +- .../cloud-dedicated/bearer-auth-v2-write.sh | 2 +- .../api/cloud-dedicated/querystring-auth.sh | 2 +- .../cloud-dedicated/token-auth-v1-query.sh | 2 +- .../cloud-dedicated/token-auth-v1-write.sh | 2 +- .../cloud-dedicated/token-auth-v2-write.sh | 2 +- 21 files changed, 85 insertions(+), 77 deletions(-) diff --git a/api-docs/cloud-dedicated/v2/content/servers.yml b/api-docs/cloud-dedicated/v2/content/servers.yml index 4bc2e19d3..4b4503143 100644 --- a/api-docs/cloud-dedicated/v2/content/servers.yml +++ b/api-docs/cloud-dedicated/v2/content/servers.yml @@ -3,6 +3,6 @@ variables: baseurl: enum: - - 'cluster-id.influxdb.io' - default: 'cluster-id.influxdb.io' + - 'cluster-id.a.influxdb.io' + default: 'cluster-id.a.influxdb.io' description: InfluxDB Cloud Dedicated URL diff --git a/api-docs/cloud-dedicated/v2/ref.yml b/api-docs/cloud-dedicated/v2/ref.yml index 78a898920..21cfdea6e 100644 --- a/api-docs/cloud-dedicated/v2/ref.yml +++ b/api-docs/cloud-dedicated/v2/ref.yml @@ -17,8 +17,8 @@ servers: variables: baseurl: enum: - - cluster-id.influxdb.io - default: cluster-id.influxdb.io + - cluster-id.a.influxdb.io + default: cluster-id.a.influxdb.io description: InfluxDB Cloud Dedicated URL security: - BearerAuthentication: [] @@ -1996,7 +1996,7 @@ components: # Use the --user option with `--user username:DATABASE_TOKEN` syntax ####################################### - curl --get "http://cluster-id.influxdb.io/query" \ + curl --get "http://cluster-id.a.influxdb.io/query" \ --user "":"DATABASE_TOKEN" \ --data-urlencode "db=DATABASE_NAME" \ --data-urlencode "q=SELECT * FROM MEASUREMENT" @@ -2024,8 +2024,8 @@ components: ### Syntax ```http - https://cluster-id.influxdb.io/query/?[u=any]&p=DATABASE_TOKEN - https://cluster-id.influxdb.io/write/?[u=any]&p=DATABASE_TOKEN + https://cluster-id.a.influxdb.io/query/?[u=any]&p=DATABASE_TOKEN + https://cluster-id.a.influxdb.io/write/?[u=any]&p=DATABASE_TOKEN ``` ### Example @@ -2041,7 +2041,7 @@ components: # ?p=DATABASE_TOKEN ####################################### - curl --get "https://cluster-id.influxdb.io/query" \ + curl --get "https://cluster-id.a.influxdb.io/query" \ --data-urlencode "p=DATABASE_TOKEN" \ --data-urlencode "db=DATABASE_NAME" \ --data-urlencode "q=SELECT * FROM MEASUREMENT" @@ -2078,7 +2078,7 @@ components: # to write data. ######################################################## - curl --request post "https://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \ + curl --request post "https://cluster-id.a.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \ --header "Authorization: Bearer DATABASE_TOKEN" \ --data-binary 'home,room=kitchen temp=72 1463683075' ``` @@ -2109,7 +2109,7 @@ components: # to write data. ######################################################## - curl --request post "https://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \ + curl --request post "https://cluster-id.a.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \ --header "Authorization: Token DATABASE_TOKEN" \ --data-binary 'home,room=kitchen temp=72 1463683075' ``` diff --git a/api-docs/clustered/v2/ref.yml b/api-docs/clustered/v2/ref.yml index f8e505b43..239859457 100644 --- a/api-docs/clustered/v2/ref.yml +++ b/api-docs/clustered/v2/ref.yml @@ -1980,7 +1980,7 @@ components: # Use the --user option with `--user username:DATABASE_TOKEN` syntax ####################################### - curl --get "http://cluster-id.influxdb.io/query" \ + curl --get "http://cluster-id.a.influxdb.io/query" \ --user "":"DATABASE_TOKEN" \ --data-urlencode "db=DATABASE_NAME" \ --data-urlencode "q=SELECT * FROM MEASUREMENT" @@ -2008,8 +2008,8 @@ components: ### Syntax ```http - https://cluster-id.influxdb.io/query/?[u=any]&p=DATABASE_TOKEN - https://cluster-id.influxdb.io/write/?[u=any]&p=DATABASE_TOKEN + https://cluster-id.a.influxdb.io/query/?[u=any]&p=DATABASE_TOKEN + https://cluster-id.a.influxdb.io/write/?[u=any]&p=DATABASE_TOKEN ``` ### Example @@ -2025,7 +2025,7 @@ components: # ?p=DATABASE_TOKEN ####################################### - curl --get "https://cluster-id.influxdb.io/query" \ + curl --get "https://cluster-id.a.influxdb.io/query" \ --data-urlencode "p=DATABASE_TOKEN" \ --data-urlencode "db=DATABASE_NAME" \ --data-urlencode "q=SELECT * FROM MEASUREMENT" @@ -2062,7 +2062,7 @@ components: # to write data. ######################################################## - curl --request post "https://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \ + curl --request post "https://cluster-id.a.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \ --header "Authorization: Bearer DATABASE_TOKEN" \ --data-binary 'home,room=kitchen temp=72 1463683075' ``` @@ -2093,7 +2093,7 @@ components: # to write data. ######################################################## - curl --request post "https://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \ + curl --request post "https://cluster-id.a.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \ --header "Authorization: Token DATABASE_TOKEN" \ --data-binary 'home,room=kitchen temp=72 1463683075' ``` diff --git a/assets/js/cookies.js b/assets/js/cookies.js index 4a73ca60f..456794183 100644 --- a/assets/js/cookies.js +++ b/assets/js/cookies.js @@ -93,7 +93,7 @@ var defaultUrls = { oss: 'http://localhost:8086', cloud: 'https://us-west-2-1.aws.cloud2.influxdata.com', serverless: 'https://us-east-1-1.aws.cloud2.influxdata.com', - dedicated: 'cluster-id.influxdb.io', + dedicated: 'cluster-id.a.influxdb.io', clustered: 'cluster-host.com', }; diff --git a/assets/js/influxdb-url.js b/assets/js/influxdb-url.js index b17ff34f9..a2f152748 100644 --- a/assets/js/influxdb-url.js +++ b/assets/js/influxdb-url.js @@ -2,7 +2,7 @@ var placeholderUrls = { oss: 'http://localhost:8086', cloud: 'https://cloud2.influxdata.com', serverless: 'https://cloud2.influxdata.com', - dedicated: 'cluster-id.influxdb.io', + dedicated: 'cluster-id.a.influxdb.io', clustered: 'cluster-host.com', }; @@ -13,7 +13,7 @@ var placeholderUrls = { var elementSelector = '.article--content pre:not(.preserve)'; // Return the page context (cloud, serverless, oss/enterprise, dedicated, clustered, other) -function context () { +function context() { if (/\/influxdb\/cloud\//.test(window.location.pathname)) { return 'cloud'; } else if (/\/influxdb\/cloud-serverless/.test(window.location.pathname)) { @@ -37,12 +37,12 @@ function context () { // Retrieve the user's InfluxDB preference (cloud or oss) from the influxdb_pref session cookie // Default is cloud. -function getURLPreference () { +function getURLPreference() { return getPreference('influxdb_url'); } // Set the user's selected InfluxDB preference (cloud or oss) -function setURLPreference (preference) { +function setURLPreference(preference) { setPreference('influxdb_url', preference); } @@ -61,7 +61,7 @@ function setURLPreference (preference) { */ // Store URLs in the urls session cookies -function storeUrl (context, newUrl, prevUrl) { +function storeUrl(context, newUrl, prevUrl) { urlsObj = {}; urlsObj['prev_' + context] = prevUrl; urlsObj[context] = newUrl; @@ -71,20 +71,20 @@ function storeUrl (context, newUrl, prevUrl) { // Store custom URL in the url session cookie. // Used to populate the custom URL field -function storeCustomUrl (customUrl) { +function storeCustomUrl(customUrl) { setInfluxDBUrls({ custom: customUrl }); $('input#custom[type=radio]').val(customUrl); } // Set a URL in the urls session cookie to an empty string // Used to clear the form when custom url input is left empty -function removeCustomUrl () { +function removeCustomUrl() { removeInfluxDBUrl('custom'); } // Store a product URL in the urls session cookie // Used to populate the custom URL field -function storeProductUrl (product, productUrl) { +function storeProductUrl(product, productUrl) { urlsObj = {}; urlsObj[product] = productUrl; @@ -94,7 +94,7 @@ function storeProductUrl (product, productUrl) { // Set a product URL in the urls session cookie to an empty string // Used to clear the form when dedicated url input is left empty -function removeProductUrl (product) { +function removeProductUrl(product) { removeInfluxDBUrl(product); } @@ -104,7 +104,7 @@ function removeProductUrl (product) { // Preserve URLs in codeblocks that come just after or are inside a div // with the class, .keep-url -function addPreserve () { +function addPreserve() { $('.keep-url').each(function () { // For code blocks with no syntax highlighting $(this).next('pre').addClass('preserve'); @@ -119,7 +119,7 @@ function addPreserve () { } // Retrieve the currently selected URLs from the urls session cookie. -function getUrls () { +function getUrls() { var storedUrls = getInfluxDBUrls(); var currentCloudUrl = storedUrls.cloud; var currentOSSUrl = storedUrls.oss; @@ -138,7 +138,7 @@ function getUrls () { // Retrieve the previously selected URLs from the from the urls session cookie. // This is used to update URLs whenever you switch between browser tabs. -function getPrevUrls () { +function getPrevUrls() { var storedUrls = getInfluxDBUrls(); var prevCloudUrl = storedUrls.prev_cloud; var prevOSSUrl = storedUrls.prev_oss; @@ -156,7 +156,7 @@ function getPrevUrls () { } // Iterate through code blocks and update InfluxDB urls -function updateUrls (prevUrls, newUrls) { +function updateUrls(prevUrls, newUrls) { var preference = getURLPreference(); var prevUrlsParsed = { oss: {}, @@ -244,7 +244,7 @@ function updateUrls (prevUrls, newUrls) { } }); - function replaceWholename (startStr, endStr, replacement) { + function replaceWholename(startStr, endStr, replacement) { var startsWithSeparator = new RegExp('[/.]'); var endsWithSeparator = new RegExp('[-.:]'); if ( @@ -278,7 +278,7 @@ function updateUrls (prevUrls, newUrls) { } // Append the URL selector button to each codeblock containing a placeholder URL -function appendUrlSelector () { +function appendUrlSelector() { var appendToUrls = [ placeholderUrls.oss, placeholderUrls.cloud, @@ -290,15 +290,15 @@ function appendUrlSelector () { getBtnText = (context) => { contextText = { 'oss/enterprise': 'Change InfluxDB URL', - 'cloud': 'InfluxDB Cloud Region', - 'serverless': 'InfluxDB Cloud Region', - 'dedicated': 'Set Dedicated cluster URL', - 'clustered': 'Set InfluxDB cluster URL', - 'other': 'InfluxDB Cloud or OSS?' - } - - return contextText[context] - } + cloud: 'InfluxDB Cloud Region', + serverless: 'InfluxDB Cloud Region', + dedicated: 'Set Dedicated cluster URL', + clustered: 'Set InfluxDB cluster URL', + other: 'InfluxDB Cloud or OSS?', + }; + + return contextText[context]; + }; appendToUrls.forEach(function (url) { $(elementSelector).each(function () { @@ -344,7 +344,7 @@ $('.url-trigger').click(function (e) { }); // Set the selected URL radio buttons to :checked -function setRadioButtons () { +function setRadioButtons() { currentUrls = getUrls(); $('input[name="influxdb-cloud-url"][value="' + currentUrls.cloud + '"]').prop( 'checked', @@ -426,7 +426,7 @@ $('input[name="influxdb-clustered-url"]').change(function () { }); // Toggle preference tabs -function togglePrefBtns (el) { +function togglePrefBtns(el) { preference = el.length ? el.attr('id').replace('pref-', '') : 'cloud'; prefUrls = $('#' + preference + '-urls'); @@ -443,7 +443,7 @@ $('#pref-tabs .pref-tab').click(function () { }); // Select preference tab from cookie -function showPreference () { +function showPreference() { var preference = getPreference('influxdb_url'); prefTab = $('#pref-' + preference); togglePrefBtns(prefTab); @@ -457,7 +457,7 @@ showPreference(); //////////////////////////////////////////////////////////////////////////////// // Validate custom URLs -function validateUrl (url) { +function validateUrl(url) { /** validDomain = (Named host | IPv6 host | IPvFuture host)(:Port)? **/ var validDomain = new RegExp( `([a-z0-9\-._~%]+` + @@ -505,19 +505,19 @@ function validateUrl (url) { } // Show validation errors -function showValidationMessage (validation) { +function showValidationMessage(validation) { $('#custom-url').addClass('error'); $('#custom-url').attr('data-message', validation.error); } // Hide validation messages and replace the message attr with empty string -function hideValidationMessage () { +function hideValidationMessage() { $('#custom-url').removeClass('error').attr('data-message', ''); } // Set the custom URL cookie and apply the change // If the custom URL field is empty, it defaults to the OSS default -function applyCustomUrl () { +function applyCustomUrl() { var custUrl = $('#custom-url-field').val(); let urlValidation = validateUrl(custUrl); if (custUrl.length > 0) { @@ -540,7 +540,7 @@ function applyCustomUrl () { // Set the product URL cookie and apply the change // If the product URL field is empty, it defaults to the product default -function applyProductUrl (product) { +function applyProductUrl(product) { var productUrl = $(`#${product}-url-field`).val(); let urlValidation = validateUrl(productUrl); if (productUrl.length > 0) { @@ -605,7 +605,7 @@ $(urlValueElements).blur(function () { /** Delay execution of a function `fn` for a number of milliseconds `ms` * e.g., delay a validation handler to avoid annoying the user. */ -function delay (fn, ms) { +function delay(fn, ms) { let timer = 0; return function (...args) { clearTimeout(timer); @@ -613,7 +613,7 @@ function delay (fn, ms) { }; } -function handleUrlValidation () { +function handleUrlValidation() { let url = $(urlValueElements).val(); let urlValidation = validateUrl(url); if (urlValidation.valid) { @@ -658,3 +658,13 @@ if (cloudUrls.includes(referrerHost)) { setURLPreference('cloud'); showPreference(); } + +//////////////////////////////////////////////////////////////////////////////// +//////////////////////////// Dedicated URL Migration /////////////////////////// +///////////////////////// REMOVE AFTER AUGUST 22, 2024 ///////////////////////// +//////////////////////////////////////////////////////////////////////////////// + +if (getUrls().dedicated == 'cluster-id.influxdb.io') { + storeUrl('dedicated', 'cluster-id.a.influxdb.io', getUrls().dedicated); + updateUrls(getPrevUrls(), getUrls()); +} diff --git a/assets/js/notifications.js b/assets/js/notifications.js index efa7a08d3..2400f9052 100644 --- a/assets/js/notifications.js +++ b/assets/js/notifications.js @@ -6,16 +6,16 @@ */ // Get notification ID -function notificationID (el) { +function notificationID(el) { return $(el).attr('id'); } // Show notifications that are within scope and haven't been read -function showNotifications () { +function showNotifications() { $('#docs-notifications > .notification').each(function () { // Check if the path includes paths defined in the data-scope attribute // of the notification html element - function inScope (path, scope) { + function inScope(path, scope) { for (let i = 0; i < scope.length; i++) { if (path.includes(scope[i])) { return true; @@ -24,14 +24,14 @@ function showNotifications () { return false; } - function excludePage (path, exclude) { + function excludePage(path, exclude) { if (exclude[0].length > 0) { for (let i = 0; i < exclude.length; i++) { if (path.includes(exclude[i])) { return true; } } - } + } return false; } @@ -41,8 +41,6 @@ function showNotifications () { var pageExcluded = excludePage(window.location.pathname, exclude); var notificationRead = notificationIsRead(notificationID(this), 'message'); - console.log(pageExcluded) - if (pageInScope && !pageExcluded && !notificationRead) { $(this).show().animate({ right: 0, opacity: 1 }, 200, 'swing'); } @@ -50,7 +48,7 @@ function showNotifications () { } // Hide a notification and set the notification as read -function hideNotification (el) { +function hideNotification(el) { $(el) .closest('.notification') .animate({ height: 0, opacity: 0 }, 200, 'swing', function () { diff --git a/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/go.md b/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/go.md index 8a273244a..df1933e5f 100644 --- a/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/go.md +++ b/content/influxdb/cloud-dedicated/query-data/execute-queries/client-libraries/go.md @@ -26,7 +26,7 @@ list_code_example: | func Query() error { client, err := influxdb3.New(influxdb3.ClientConfig{ - Host: "https://cluster-id.influxdb.io", + Host: "https://cluster-id.a.influxdb.io", Token: "DATABASE_TOKEN", Database: "DATABASE_NAME", }) diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md b/content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md index 64345e7c2..2d14246e3 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md +++ b/content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md @@ -486,7 +486,7 @@ Follow these steps to build and run the application using Docker: ```sh docker build \ --build-arg DATABASE_NAME=INFLUX_DATABASE \ - --build-arg HOST=cluster-id.influxdb.io \ + --build-arg HOST={{% influxdb/host %}}\ --build-arg TOKEN=INFLUX_TOKEN \ -t javaflight . ``` diff --git a/content/influxdb/clustered/query-data/execute-queries/client-libraries/go.md b/content/influxdb/clustered/query-data/execute-queries/client-libraries/go.md index 28d92c431..5d30caf43 100644 --- a/content/influxdb/clustered/query-data/execute-queries/client-libraries/go.md +++ b/content/influxdb/clustered/query-data/execute-queries/client-libraries/go.md @@ -26,7 +26,7 @@ list_code_example: | func Query() error { client, err := influxdb3.New(influxdb3.ClientConfig{ - Host: "https://cluster-id.influxdb.io", + Host: "https://cluster-host.com", Token: "DATABASE_TOKEN", Database: "DATABASE_NAME", }) diff --git a/content/influxdb/clustered/reference/client-libraries/flight/java-flightsql.md b/content/influxdb/clustered/reference/client-libraries/flight/java-flightsql.md index 4166bbdd5..5b9b0b3fb 100644 --- a/content/influxdb/clustered/reference/client-libraries/flight/java-flightsql.md +++ b/content/influxdb/clustered/reference/client-libraries/flight/java-flightsql.md @@ -487,7 +487,7 @@ Follow these steps to build and run the application using Docker: ```sh docker build \ --build-arg DATABASE_NAME=INFLUX_DATABASE \ - --build-arg HOST=cluster-id.influxdb.io \ + --build-arg HOST={{% influxdb/host %}} \ --build-arg TOKEN=INFLUX_TOKEN \ -t javaflight . ``` diff --git a/data/products.yml b/data/products.yml index 0179bf4e7..7cab39e49 100644 --- a/data/products.yml +++ b/data/products.yml @@ -56,7 +56,7 @@ influxdb_cloud_dedicated: latest: cloud-dedicated link: "https://www.influxdata.com/contact-sales-form/" latest_cli: 2.9.3 - placeholder_host: cluster-id.influxdb.io + placeholder_host: cluster-id.a.influxdb.io influxdb_clustered: name: InfluxDB Clustered diff --git a/layouts/partials/footer/javascript.html b/layouts/partials/footer/javascript.html index 0a41bd5a3..4b4e310f5 100644 --- a/layouts/partials/footer/javascript.html +++ b/layouts/partials/footer/javascript.html @@ -34,9 +34,6 @@ ] - - - {{ if .Page.HasShortcode "diagram" }} @@ -77,4 +74,7 @@ {{ if .Page.HasShortcode "code-placeholders" }} -{{ end }} \ No newline at end of file +{{ end }} + + + \ No newline at end of file diff --git a/layouts/partials/footer/modals/influxdb-url.html b/layouts/partials/footer/modals/influxdb-url.html index ce3835b67..ddbdc2a57 100644 --- a/layouts/partials/footer/modals/influxdb-url.html +++ b/layouts/partials/footer/modals/influxdb-url.html @@ -150,7 +150,7 @@ {{ else if $isServerless }} {{ template "productSection" dict "product" .Site.Data.influxdb_urls.cloud "formID" "serverless" "filterServerless" true }} {{ else if $isDedicated }} - {{ template "productSpecificForm" dict "product" nil "formID" "dedicated" "placeholder" "cluster-id.influxdb.io" }} + {{ template "productSpecificForm" dict "product" nil "formID" "dedicated" "placeholder" "cluster-id.a.influxdb.io" }} {{ else if $isClustered }} {{ template "productSpecificForm" dict "product" nil "formID" "clustered" "placeholder" "cluster-host.com" }} {{ end }} diff --git a/shared/text/api/cloud-dedicated/basic-auth.sh b/shared/text/api/cloud-dedicated/basic-auth.sh index cb482e59e..44e679068 100644 --- a/shared/text/api/cloud-dedicated/basic-auth.sh +++ b/shared/text/api/cloud-dedicated/basic-auth.sh @@ -4,7 +4,7 @@ ####################################### -curl --get "https://cluster-id.influxdb.io/query" \ +curl --get "https://cluster-id.a.influxdb.io/query" \ --user "":"DATABASE_TOKEN" \ --data-urlencode "db=DATABASE_NAME" \ --data-urlencode "q=SELECT * FROM MEASUREMENT" diff --git a/shared/text/api/cloud-dedicated/bearer-auth-v1-query.sh b/shared/text/api/cloud-dedicated/bearer-auth-v1-query.sh index cf114805b..1b1bdc8a5 100644 --- a/shared/text/api/cloud-dedicated/bearer-auth-v1-query.sh +++ b/shared/text/api/cloud-dedicated/bearer-auth-v1-query.sh @@ -3,7 +3,7 @@ # to query the InfluxDB v1 API ######################################################## -curl --get "https://cluster-id.influxdb.io/query" \ +curl --get "https://cluster-id.a.influxdb.io/query" \ --header "Authorization: Bearer DATABASE_TOKEN" \ --header 'Content-type: application/json' \ --data-urlencode "db=DATABASE_NAME" \ diff --git a/shared/text/api/cloud-dedicated/bearer-auth-v1-write.sh b/shared/text/api/cloud-dedicated/bearer-auth-v1-write.sh index 76bd02400..0943ee5d5 100644 --- a/shared/text/api/cloud-dedicated/bearer-auth-v1-write.sh +++ b/shared/text/api/cloud-dedicated/bearer-auth-v1-write.sh @@ -3,7 +3,7 @@ # to write data. ######################################################## -curl -i "https://cluster-id.influxdb.io/write?db=DATABASE_NAME&precision=ms" \ +curl -i "https://cluster-id.a.influxdb.io/write?db=DATABASE_NAME&precision=ms" \ --header "Authorization: Bearer DATABASE_TOKEN" \ --header "Content-type: text/plain; charset=utf-8" \ --data-binary 'home,room=kitchen temp=72 1682358973500' \ No newline at end of file diff --git a/shared/text/api/cloud-dedicated/bearer-auth-v2-write.sh b/shared/text/api/cloud-dedicated/bearer-auth-v2-write.sh index fe41a6ad6..d42940078 100644 --- a/shared/text/api/cloud-dedicated/bearer-auth-v2-write.sh +++ b/shared/text/api/cloud-dedicated/bearer-auth-v2-write.sh @@ -3,6 +3,6 @@ # to write data. ######################################################## -curl --request post 'https://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s' \ +curl --request post 'https://cluster-id.a.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s' \ --header 'Authorization: Bearer DATABASE_TOKEN' \ --data-binary 'home,room=kitchen temp=72 1463683075' diff --git a/shared/text/api/cloud-dedicated/querystring-auth.sh b/shared/text/api/cloud-dedicated/querystring-auth.sh index 620f40b6e..8298b5dcb 100644 --- a/shared/text/api/cloud-dedicated/querystring-auth.sh +++ b/shared/text/api/cloud-dedicated/querystring-auth.sh @@ -6,7 +6,7 @@ # ?p=DATABASE_TOKEN ####################################### -curl --get "https://cluster-id.influxdb.io/query" \ +curl --get "https://cluster-id.a.influxdb.io/query" \ --data-urlencode "p=DATABASE_TOKEN" \ --data-urlencode "db=DATABASE_NAME" \ --data-urlencode "q=SELECT * FROM MEASUREMENT" diff --git a/shared/text/api/cloud-dedicated/token-auth-v1-query.sh b/shared/text/api/cloud-dedicated/token-auth-v1-query.sh index 781189441..0867b52f7 100644 --- a/shared/text/api/cloud-dedicated/token-auth-v1-query.sh +++ b/shared/text/api/cloud-dedicated/token-auth-v1-query.sh @@ -3,7 +3,7 @@ # to query the InfluxDB v1 API ######################################################## -curl --get "https://cluster-id.influxdb.io/query" \ +curl --get "https://cluster-id.a.influxdb.io/query" \ --header "Authorization: Token DATABASE_TOKEN" \ --header 'Content-type: application/json' \ --data-urlencode "db=DATABASE_NAME" \ diff --git a/shared/text/api/cloud-dedicated/token-auth-v1-write.sh b/shared/text/api/cloud-dedicated/token-auth-v1-write.sh index 6621613a1..a4fcb39ea 100644 --- a/shared/text/api/cloud-dedicated/token-auth-v1-write.sh +++ b/shared/text/api/cloud-dedicated/token-auth-v1-write.sh @@ -3,7 +3,7 @@ # to write data. ######################################################## -curl -i "https://cluster-id.influxdb.io/write?db=DATABASE_NAME&precision=ms" \ +curl -i "https://cluster-id.a.influxdb.io/write?db=DATABASE_NAME&precision=ms" \ --header "Authorization: Token DATABASE_TOKEN" \ --header "Content-type: text/plain; charset=utf-8" \ --data-binary 'home,room=kitchen temp=72 1682358973500' \ No newline at end of file diff --git a/shared/text/api/cloud-dedicated/token-auth-v2-write.sh b/shared/text/api/cloud-dedicated/token-auth-v2-write.sh index 78534adb2..582ce7c57 100644 --- a/shared/text/api/cloud-dedicated/token-auth-v2-write.sh +++ b/shared/text/api/cloud-dedicated/token-auth-v2-write.sh @@ -3,6 +3,6 @@ # to write data. ######################################################## -curl --request post "https://cluster-id.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \ +curl --request post "https://cluster-id.a.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \ --header "Authorization: Token DATABASE_TOKEN" \ --data-binary 'home,room=kitchen temp=72 1463683075' From 3a4235c27d781fe7325d5a6d4acc3209acdff0f6 Mon Sep 17 00:00:00 2001 From: Adam Date: Mon, 22 Jul 2024 16:18:38 -0700 Subject: [PATCH 31/96] Update _index.md (#5528) --- .../influxdb/cloud-dedicated/admin/custom-partitions/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/cloud-dedicated/admin/custom-partitions/_index.md b/content/influxdb/cloud-dedicated/admin/custom-partitions/_index.md index 5743ee95a..5e5975061 100644 --- a/content/influxdb/cloud-dedicated/admin/custom-partitions/_index.md +++ b/content/influxdb/cloud-dedicated/admin/custom-partitions/_index.md @@ -335,7 +335,7 @@ _For more information about the query lifecycle, see ##### Query example Consider the following query that selects everything in the `production` table -where the `line` tag is `A` and the `station` tag is `1`: +where the `line` tag is `A` and the `station` tag is `cnc`: ```sql SELECT * From 711451d4e0db064698c474e69bcf626903d07d6e Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Tue, 23 Jul 2024 16:43:11 +0100 Subject: [PATCH 32/96] Update java.md Updated this page with steps to install the v3 client SDK and sample program so as to make developer's life bit easy. --- .../reference/client-libraries/v3/java.md | 70 +++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 3c842f4fb..a42321007 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -21,3 +21,73 @@ to write and query data stored in an {{% product-name %}} bucket. The documentation for this client library is available on GitHub. InfluxDB v3 Java client library + +## Installation + +### Maven +```xml + + com.influxdb + influxdb3-java + RELEASE + +``` + +### Gradle +```groovy +implementation group: 'com.influxdb', name: 'influxdb3-java', version: 'latest.release' +``` + +## Sample Code + +```java +public class HelloInfluxDB { + private static final String HOST_URL = "https://eu-central-1-1.aws.cloud2.influxdata.com"; // URL information is present in the cloud portal + private static final String DATABASE = "java"; // Database name is the bucket name present in the cloud portal + private static final char[] API_TOKEN = "API_TOKEN".toCharArray(); // Avoid hard-coding API_TOKEN in production. It is present in the cloud portal. + + // Authenticate, Write and Query data from the serverless InfluxDB + public static void main(String[] args) { + try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, API_TOKEN, DATABASE)) { + writeData(client); + queryData(client); + } + catch (Exception e) { + System.err.println("An error occurred while connecting with the serverless InfluxDB!"); + e.printStackTrace(); + } + } + + // Write sample measurement using Point class API + private static void writeData(InfluxDBClient client) { + Point point = Point.measurement("temperature") + .setTag("location", "London") + .setField("value", 30.01) + .setTimestamp(Instant.now().minusSeconds(10)); + try { + client.writePoint(point); + System.out.println("Data written to the bucket."); + } + catch (Exception e) { + System.err.println("Failed to write data to the bucket."); + e.printStackTrace(); + } + } + + // Query the latest 10 measurements using SQL + private static void queryData(InfluxDBClient client) { + System.out.printf("--------------------------------------------------------%n"); + System.out.printf("| %-8s | %-8s | %-30s |%n", "location", "value", "time"); + System.out.printf("--------------------------------------------------------%n"); + + String sql = "select time,location,value from temperature order by time desc limit 10"; + try (Stream stream = client.query(sql)) { + stream.forEach(row -> System.out.printf("| %-8s | %-8s | %-30s |%n", row[1], row[2], row[0])); + } + catch (Exception e) { + System.err.println("Failed to query data from the bucket."); + e.printStackTrace(); + } + } +} +``` From 9a71e78b3498511854ebb3ad45a678f86fc0f6c2 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Tue, 23 Jul 2024 16:51:15 +0100 Subject: [PATCH 33/96] Update java.md Added step to run the program correctly --- .../reference/client-libraries/v3/java.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index a42321007..8aa4563cb 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -91,3 +91,11 @@ public class HelloInfluxDB { } } ``` +## Running the program + +Build the project and then run the executable .jar file with this [JVM Flag](https://arrow.apache.org/docs/java/install.html). +

+**Example:** +```sh + java --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar target/{your-jar-file}.jar +``` From e339cc0601d290ecf85f478f0149071773326fb2 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Tue, 23 Jul 2024 13:56:16 -0600 Subject: [PATCH 34/96] hotfix: fix v2 influxql query examples --- content/influxdb/v2/query-data/influxql/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/influxdb/v2/query-data/influxql/_index.md b/content/influxdb/v2/query-data/influxql/_index.md index fcc95aa04..701f0c5b2 100644 --- a/content/influxdb/v2/query-data/influxql/_index.md +++ b/content/influxdb/v2/query-data/influxql/_index.md @@ -77,7 +77,7 @@ The [`influx` CLI](/influxdb/v2/reference/cli/influx/) provides an [InfluxQL she 3. Execute an InfluxQL query inside the InfluxQL shell. ```sql - SELECT used_percent FROM example-db.example-rp.example-measurement WHERE host=host1 + SELECT used_percent FROM "example-db"."example-rp"."example-measurement" WHERE host=host1 ``` For more information, see how to [use the InfluxQL shell](/influxdb/v2/tools/influxql-shell/). For more information about DBRP mappings, see [Manage DBRP mappings](/influxdb/v2/query-data/influxql/dbrp/). @@ -105,7 +105,7 @@ all InfluxDB 1.x client libraries and integrations in InfluxDB {{< current-versi ```sh curl --get http://localhost:8086/query?db=example-db \ --header "Authorization: Token YourAuthToken" \ - --data-urlencode "q=SELECT used_percent FROM example-db.example-rp.example-measurement WHERE host=host1" + --data-urlencode "q=SELECT used_percent FROM \"example-db\".\"example-rp\".\"example-measurement\" WHERE host=host1" ``` By default, the `/query` compatibility endpoint returns results in **JSON**. From 37a7a7c6e719d90886224562b4fc097dc2bbb385 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 23 Jul 2024 15:08:28 -0500 Subject: [PATCH 35/96] chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked. --- .ci/vale/styles/InfluxDataDocs/Acronyms.yml | 65 ++++ .../styles/InfluxDataDocs/Capitalization.yml | 6 +- .ci/vale/styles/InfluxDataDocs/Spelling.yml | 1 + .../styles/InfluxDataDocs/Terms/ignore.txt | 1 - .../vocabularies/InfluxDataDocs/accept.txt | 17 +- .gitignore | 2 +- .husky/.gitignore | 1 - .husky/_/build | 60 ++++ .husky/_/pre-commit | 60 ++++ .husky/_/pre-push | 60 ++++ .husky/_/prepare-commit-msg | 60 ++++ .husky/_/scripts | 60 ++++ .husky/pre-commit | 6 - .lintstagedrc.mjs | 118 ------- .vale.ini | 1 + Dockerfile.pytest | 66 ++-- Dockerfile.tests | 1 + compose.yaml | 330 +++++++++++++++++- content/influxdb/cloud-dedicated/.vale.ini | 1 + content/influxdb/cloud-serverless/.vale.ini | 1 + content/influxdb/clustered/.vale.ini | 1 + lefthook.yml | 106 ++++++ package.json | 15 +- test/.gitignore | 2 +- test/{src => pytest}/conftest.py | 0 test/{src => pytest}/pytest.ini | 0 test/{src => pytest}/requirements.txt | 0 .../monitor-container-urls.sh | 4 +- test/scripts/monitor-tests.sh | 43 +++ test/{src => scripts}/parse_yaml.sh | 0 test/{src => scripts}/prepare-content.sh | 40 +-- test/scripts/run-tests.sh | 34 ++ test/src/monitor-tests.sh | 26 -- yarn.lock | 324 +++-------------- 34 files changed, 1002 insertions(+), 510 deletions(-) create mode 100644 .ci/vale/styles/InfluxDataDocs/Acronyms.yml delete mode 100644 .husky/.gitignore create mode 100755 .husky/_/build create mode 100755 .husky/_/pre-commit create mode 100755 .husky/_/pre-push create mode 100755 .husky/_/prepare-commit-msg create mode 100755 .husky/_/scripts delete mode 100644 .husky/pre-commit delete mode 100644 .lintstagedrc.mjs create mode 100644 lefthook.yml rename test/{src => pytest}/conftest.py (100%) rename test/{src => pytest}/pytest.ini (100%) rename test/{src => pytest}/requirements.txt (100%) rename test/{src => scripts}/monitor-container-urls.sh (88%) create mode 100755 test/scripts/monitor-tests.sh rename test/{src => scripts}/parse_yaml.sh (100%) rename test/{src => scripts}/prepare-content.sh (83%) create mode 100644 test/scripts/run-tests.sh delete mode 100755 test/src/monitor-tests.sh diff --git a/.ci/vale/styles/InfluxDataDocs/Acronyms.yml b/.ci/vale/styles/InfluxDataDocs/Acronyms.yml new file mode 100644 index 000000000..4b007968e --- /dev/null +++ b/.ci/vale/styles/InfluxDataDocs/Acronyms.yml @@ -0,0 +1,65 @@ +extends: conditional +message: "Spell out '%s', if it's unfamiliar to the audience." +link: 'https://developers.google.com/style/abbreviations' +level: suggestion +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - \b(\[[A-Z]{3,5})\]\(.*\)\b + - API + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DOM + - DPI + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - OSS + - PATH + - PDF + - PHP + - POST + - RAM + - REPL + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - URI + - URL + - USB + - UTF + - XML + - XSS + - YAML + - ZIP diff --git a/.ci/vale/styles/InfluxDataDocs/Capitalization.yml b/.ci/vale/styles/InfluxDataDocs/Capitalization.yml index 16456f635..68ed5d3eb 100644 --- a/.ci/vale/styles/InfluxDataDocs/Capitalization.yml +++ b/.ci/vale/styles/InfluxDataDocs/Capitalization.yml @@ -376,4 +376,8 @@ exceptions: - kaufmans_adaptive_moving_average - triple_exponential_moving_average - triple_exponential_derivative - - relative_strength_index \ No newline at end of file + - relative_strength_index + # Telegraf config + - agent + - token + - urls \ No newline at end of file diff --git a/.ci/vale/styles/InfluxDataDocs/Spelling.yml b/.ci/vale/styles/InfluxDataDocs/Spelling.yml index bdce7da2a..39733d532 100644 --- a/.ci/vale/styles/InfluxDataDocs/Spelling.yml +++ b/.ci/vale/styles/InfluxDataDocs/Spelling.yml @@ -12,3 +12,4 @@ ignore: filters: # Allow product-specific Branding.yml configurations to handle [Ss]erverless while also allowing serverless as a valid dictionary word. - '[Ss]erverless' + diff --git a/.ci/vale/styles/InfluxDataDocs/Terms/ignore.txt b/.ci/vale/styles/InfluxDataDocs/Terms/ignore.txt index ad13fb4af..438bb6855 100644 --- a/.ci/vale/styles/InfluxDataDocs/Terms/ignore.txt +++ b/.ci/vale/styles/InfluxDataDocs/Terms/ignore.txt @@ -23,7 +23,6 @@ datasource deduplicate deserialize dotenv -downsample enum file_groups fullscreen diff --git a/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt index 2d1e152a6..83be41c7b 100644 --- a/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt +++ b/.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt @@ -11,12 +11,13 @@ CLI|\/cli\/ CSV Data Explorer Dedup +[Dd]ownsampl(e|ed|es|ing) Execd ExecutionPlan Flight SQL FlightQuery GBs? -Grafana +Grafana|\{\{.*grafana.*\}\} HostURL InfluxDB Cloud InfluxDB OSS @@ -25,6 +26,9 @@ Influxer JavaScript KBs? LogicalPlan +[Mm]axim(ize|um) +[Mm]inim(ize|um) +[Mm]onitor MBs? PBs? Parquet @@ -35,7 +39,7 @@ Splunk [Ss]uperset TBs? UI -URLs +URL US (East|West|Central|North|South|Northeast|Northwest|Southeast|Southwest) Unix WALs? @@ -43,6 +47,8 @@ Webpack [pP]y.*\b \b\w+_\w+\b \b_\w+\b +airSensors +api-endpoint batchBucket batchInterval commentPrefix @@ -51,8 +57,10 @@ destinationHost destinationOrg destinationToken docs-v2 +exampleTag fieldKey fieldType +gotType groupId hostURL hostUrl @@ -61,6 +69,7 @@ influxctl influxd influxdata.com iox +keep-url lat locf logicalplan @@ -72,8 +81,8 @@ quoteChar retentionRules sourceBucket tagKey -`url[s]?` -URL +url[s]? v2 v3 venv +wantType diff --git a/.gitignore b/.gitignore index 2c9564d31..254ec132e 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,6 @@ node_modules /api-docs/redoc-static.html* .vscode/* .idea -config.toml +**/config.toml package-lock.json tmp \ No newline at end of file diff --git a/.husky/.gitignore b/.husky/.gitignore deleted file mode 100644 index 31354ec13..000000000 --- a/.husky/.gitignore +++ /dev/null @@ -1 +0,0 @@ -_ diff --git a/.husky/_/build b/.husky/_/build new file mode 100755 index 000000000..c39a53b1a --- /dev/null +++ b/.husky/_/build @@ -0,0 +1,60 @@ +#!/bin/sh + +if [ "$LEFTHOOK_VERBOSE" = "1" -o "$LEFTHOOK_VERBOSE" = "true" ]; then + set -x +fi + +if [ "$LEFTHOOK" = "0" ]; then + exit 0 +fi + +call_lefthook() +{ + if test -n "$LEFTHOOK_BIN" + then + "$LEFTHOOK_BIN" "$@" + elif lefthook -h >/dev/null 2>&1 + then + lefthook "$@" + else + dir="$(git rev-parse --show-toplevel)" + osArch=$(uname | tr '[:upper:]' '[:lower:]') + cpuArch=$(uname -m | sed 's/aarch64/arm64/;s/x86_64/x64/') + if test -f "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" + then + "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" "$@" + elif test -f "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" + then + "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" "$@" + elif test -f "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" + then + "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" "$@" + elif test -f "$dir/node_modules/lefthook/bin/index.js" + then + "$dir/node_modules/lefthook/bin/index.js" "$@" + + elif bundle exec lefthook -h >/dev/null 2>&1 + then + bundle exec lefthook "$@" + elif yarn lefthook -h >/dev/null 2>&1 + then + yarn lefthook "$@" + elif pnpm lefthook -h >/dev/null 2>&1 + then + pnpm lefthook "$@" + elif swift package plugin lefthook >/dev/null 2>&1 + then + swift package --disable-sandbox plugin lefthook "$@" + elif command -v mint >/dev/null 2>&1 + then + mint run csjones/lefthook-plugin "$@" + elif command -v npx >/dev/null 2>&1 + then + npx lefthook "$@" + else + echo "Can't find lefthook in PATH" + fi + fi +} + +call_lefthook run "build" "$@" diff --git a/.husky/_/pre-commit b/.husky/_/pre-commit new file mode 100755 index 000000000..3fbf5f960 --- /dev/null +++ b/.husky/_/pre-commit @@ -0,0 +1,60 @@ +#!/bin/sh + +if [ "$LEFTHOOK_VERBOSE" = "1" -o "$LEFTHOOK_VERBOSE" = "true" ]; then + set -x +fi + +if [ "$LEFTHOOK" = "0" ]; then + exit 0 +fi + +call_lefthook() +{ + if test -n "$LEFTHOOK_BIN" + then + "$LEFTHOOK_BIN" "$@" + elif lefthook -h >/dev/null 2>&1 + then + lefthook "$@" + else + dir="$(git rev-parse --show-toplevel)" + osArch=$(uname | tr '[:upper:]' '[:lower:]') + cpuArch=$(uname -m | sed 's/aarch64/arm64/;s/x86_64/x64/') + if test -f "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" + then + "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" "$@" + elif test -f "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" + then + "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" "$@" + elif test -f "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" + then + "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" "$@" + elif test -f "$dir/node_modules/lefthook/bin/index.js" + then + "$dir/node_modules/lefthook/bin/index.js" "$@" + + elif bundle exec lefthook -h >/dev/null 2>&1 + then + bundle exec lefthook "$@" + elif yarn lefthook -h >/dev/null 2>&1 + then + yarn lefthook "$@" + elif pnpm lefthook -h >/dev/null 2>&1 + then + pnpm lefthook "$@" + elif swift package plugin lefthook >/dev/null 2>&1 + then + swift package --disable-sandbox plugin lefthook "$@" + elif command -v mint >/dev/null 2>&1 + then + mint run csjones/lefthook-plugin "$@" + elif command -v npx >/dev/null 2>&1 + then + npx lefthook "$@" + else + echo "Can't find lefthook in PATH" + fi + fi +} + +call_lefthook run "pre-commit" "$@" diff --git a/.husky/_/pre-push b/.husky/_/pre-push new file mode 100755 index 000000000..cf59fe1cb --- /dev/null +++ b/.husky/_/pre-push @@ -0,0 +1,60 @@ +#!/bin/sh + +if [ "$LEFTHOOK_VERBOSE" = "1" -o "$LEFTHOOK_VERBOSE" = "true" ]; then + set -x +fi + +if [ "$LEFTHOOK" = "0" ]; then + exit 0 +fi + +call_lefthook() +{ + if test -n "$LEFTHOOK_BIN" + then + "$LEFTHOOK_BIN" "$@" + elif lefthook -h >/dev/null 2>&1 + then + lefthook "$@" + else + dir="$(git rev-parse --show-toplevel)" + osArch=$(uname | tr '[:upper:]' '[:lower:]') + cpuArch=$(uname -m | sed 's/aarch64/arm64/;s/x86_64/x64/') + if test -f "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" + then + "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" "$@" + elif test -f "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" + then + "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" "$@" + elif test -f "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" + then + "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" "$@" + elif test -f "$dir/node_modules/lefthook/bin/index.js" + then + "$dir/node_modules/lefthook/bin/index.js" "$@" + + elif bundle exec lefthook -h >/dev/null 2>&1 + then + bundle exec lefthook "$@" + elif yarn lefthook -h >/dev/null 2>&1 + then + yarn lefthook "$@" + elif pnpm lefthook -h >/dev/null 2>&1 + then + pnpm lefthook "$@" + elif swift package plugin lefthook >/dev/null 2>&1 + then + swift package --disable-sandbox plugin lefthook "$@" + elif command -v mint >/dev/null 2>&1 + then + mint run csjones/lefthook-plugin "$@" + elif command -v npx >/dev/null 2>&1 + then + npx lefthook "$@" + else + echo "Can't find lefthook in PATH" + fi + fi +} + +call_lefthook run "pre-push" "$@" diff --git a/.husky/_/prepare-commit-msg b/.husky/_/prepare-commit-msg new file mode 100755 index 000000000..e8e8dda9d --- /dev/null +++ b/.husky/_/prepare-commit-msg @@ -0,0 +1,60 @@ +#!/bin/sh + +if [ "$LEFTHOOK_VERBOSE" = "1" -o "$LEFTHOOK_VERBOSE" = "true" ]; then + set -x +fi + +if [ "$LEFTHOOK" = "0" ]; then + exit 0 +fi + +call_lefthook() +{ + if test -n "$LEFTHOOK_BIN" + then + "$LEFTHOOK_BIN" "$@" + elif lefthook -h >/dev/null 2>&1 + then + lefthook "$@" + else + dir="$(git rev-parse --show-toplevel)" + osArch=$(uname | tr '[:upper:]' '[:lower:]') + cpuArch=$(uname -m | sed 's/aarch64/arm64/;s/x86_64/x64/') + if test -f "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" + then + "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" "$@" + elif test -f "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" + then + "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" "$@" + elif test -f "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" + then + "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" "$@" + elif test -f "$dir/node_modules/lefthook/bin/index.js" + then + "$dir/node_modules/lefthook/bin/index.js" "$@" + + elif bundle exec lefthook -h >/dev/null 2>&1 + then + bundle exec lefthook "$@" + elif yarn lefthook -h >/dev/null 2>&1 + then + yarn lefthook "$@" + elif pnpm lefthook -h >/dev/null 2>&1 + then + pnpm lefthook "$@" + elif swift package plugin lefthook >/dev/null 2>&1 + then + swift package --disable-sandbox plugin lefthook "$@" + elif command -v mint >/dev/null 2>&1 + then + mint run csjones/lefthook-plugin "$@" + elif command -v npx >/dev/null 2>&1 + then + npx lefthook "$@" + else + echo "Can't find lefthook in PATH" + fi + fi +} + +call_lefthook run "prepare-commit-msg" "$@" diff --git a/.husky/_/scripts b/.husky/_/scripts new file mode 100755 index 000000000..278060b0e --- /dev/null +++ b/.husky/_/scripts @@ -0,0 +1,60 @@ +#!/bin/sh + +if [ "$LEFTHOOK_VERBOSE" = "1" -o "$LEFTHOOK_VERBOSE" = "true" ]; then + set -x +fi + +if [ "$LEFTHOOK" = "0" ]; then + exit 0 +fi + +call_lefthook() +{ + if test -n "$LEFTHOOK_BIN" + then + "$LEFTHOOK_BIN" "$@" + elif lefthook -h >/dev/null 2>&1 + then + lefthook "$@" + else + dir="$(git rev-parse --show-toplevel)" + osArch=$(uname | tr '[:upper:]' '[:lower:]') + cpuArch=$(uname -m | sed 's/aarch64/arm64/;s/x86_64/x64/') + if test -f "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" + then + "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" "$@" + elif test -f "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" + then + "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" "$@" + elif test -f "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" + then + "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" "$@" + elif test -f "$dir/node_modules/lefthook/bin/index.js" + then + "$dir/node_modules/lefthook/bin/index.js" "$@" + + elif bundle exec lefthook -h >/dev/null 2>&1 + then + bundle exec lefthook "$@" + elif yarn lefthook -h >/dev/null 2>&1 + then + yarn lefthook "$@" + elif pnpm lefthook -h >/dev/null 2>&1 + then + pnpm lefthook "$@" + elif swift package plugin lefthook >/dev/null 2>&1 + then + swift package --disable-sandbox plugin lefthook "$@" + elif command -v mint >/dev/null 2>&1 + then + mint run csjones/lefthook-plugin "$@" + elif command -v npx >/dev/null 2>&1 + then + npx lefthook "$@" + else + echo "Can't find lefthook in PATH" + fi + fi +} + +call_lefthook run "scripts" "$@" diff --git a/.husky/pre-commit b/.husky/pre-commit deleted file mode 100644 index 42e27d76a..000000000 --- a/.husky/pre-commit +++ /dev/null @@ -1,6 +0,0 @@ -# If you're running tests in a container that doesn't support TTY (docker run -t), you can use monitor-tests.sh to open URLs in the host's browser. -# Your test needs to redirect the URL to the test/urls.txt file--for example: -# influxctl database update /dev/null > test/urls.txt -sh ./test/src/monitor-tests.sh start -npx lint-staged --relative -sh ./test/src/monitor-tests.sh stop diff --git a/.lintstagedrc.mjs b/.lintstagedrc.mjs deleted file mode 100644 index 13d88eb1d..000000000 --- a/.lintstagedrc.mjs +++ /dev/null @@ -1,118 +0,0 @@ -// Lint-staged configuration. This file must export a lint-staged configuration object. - -function pytestStagedContent(paths, productPath) { - const productName = productPath.replace(/\//g, '-'); - const CONTENT = `staged-${productName}`; - const TEST = `pytest-${productName}`; - - return [ - // Remove existing containers - `sh -c "docker rm -f ${CONTENT} || true"`, - `sh -c "docker rm -f ${TEST} || true"`, - - `docker build . -f Dockerfile.tests -t influxdata-docs/tests:latest`, - - // Remove any existing Docker volume for staged content - `sh -c "docker volume rm -f ${CONTENT} || true"`, - - // Create a Docker volume for product staged content - `sh -c "docker volume create \ - --label tag=influxdata-docs \ - --label stage=test \ - --name ${CONTENT} || true"`, - - // Copy staged content to a volume and run the prepare script - // to remove the existing - `docker run --name ${CONTENT} - --label tag=influxdata-docs - --label stage=test - --mount type=volume,source=${CONTENT},target=/app/content - --mount type=bind,src=./content,dst=/src/content - --mount type=bind,src=./static/downloads,dst=/app/data - influxdata-docs/tests --files "${paths.join(' ')}"`, - - `docker build . - -f Dockerfile.pytest - -t influxdata-docs/pytest:latest`, - - - // Create a Docker volume for temporary files generated during testing - `sh -c "docker volume create \ - --label tag=influxdata-docs \ - --label stage=test \ - --name test-tmp || true"`, - - // Run test runners. - // Uses a pytest plugin to suppress exit code 5 (if no tests are found), - // This avoids needing to "pre-run" test collection in a subshell to check the exit code. - // Instead of the plugin, we could use a placeholder test that always or conditionally passes. - // Whether tests pass or fail, the container is removed, - // but the CONTENT container and associated volume will remain until the next run. - // Run pytest with: - // -s to make pytest output log info during the test (instead of after). - // --suppress-no-test-exit-code to suppress exit code 5 (no tests collected). - // --exitfirst to stop after the first failure. - // --codeblocks to test code blocks in markdown files. - // Run - `docker run --tty=true --label tag=influxdata-docs --label stage=test \ - --name ${TEST} \ - --env-file ${productPath}/.env.test \ - --volumes-from ${CONTENT} \ - --mount type=bind,src=./test/shared,dst=/shared \ - --mount type=volume,source=test-tmp,target=/app/iot-starter \ - influxdata-docs/pytest -s --codeblocks --suppress-no-test-exit-code --exitfirst ${productPath}/`, - ]; -} - -// Export a lint-staged configuration object. -// Run tests and linters on staged files. -export default { - "*.{js,css}": paths => `prettier --write ${paths.join(' ')}`, - - "*.md": paths => `.ci/vale/vale.sh --config .vale.ini ${paths} --min|| true`, - - "content/influxdb/api-docs/": paths => - `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, - - "content/influxdb/cloud/**/*.md": - paths => [ - `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, - ...pytestStagedContent(paths, 'content/influxdb/cloud'), - ], - - "content/influxdb/cloud-dedicated/**/*.md": - paths => [ - `.ci/vale/vale.sh --config content/influxdb/cloud-dedicated/.vale.ini --minAlertLevel error ${paths}`, - ...pytestStagedContent(paths, 'content/influxdb/cloud-dedicated'), - ], - - "content/influxdb/cloud-serverless/**/*.md": - paths => [ - `.ci/vale/vale.sh --config content/influxdb/cloud-serverless/.vale.ini --minAlertLevel error ${paths}`, - ...pytestStagedContent(paths, 'content/influxdb/cloud-serverless'), - ], - - "content/influxdb/clustered/**/*.md": - paths => [ - `.ci/vale/vale.sh --config content/influxdb/clustered/.vale.ini --minAlertLevel error ${paths}`, - ...pytestStagedContent(paths, 'content/influxdb/clustered'), - ], - - "content/influxdb/v1/**/*.md": - paths => [ - `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, - ...pytestStagedContent(paths, 'content/influxdb/v1'), - ], - - "content/influxdb/v2/**/*.md": - paths => [ - `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, - ...pytestStagedContent(paths, 'content/influxdb/v2'), - ], - - "content/telegraf/**/*.md": - paths => [ - `.ci/vale/vale.sh --config .vale.ini --minAlertLevel error ${paths}`, - ...pytestStagedContent(paths, 'content/telegraf'), - ], -} diff --git a/.vale.ini b/.vale.ini index 8d4262290..825180a7f 100644 --- a/.vale.ini +++ b/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Google, write-good +Google.Acronyms = NO Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO diff --git a/Dockerfile.pytest b/Dockerfile.pytest index fd1ee1c23..293676a70 100644 --- a/Dockerfile.pytest +++ b/Dockerfile.pytest @@ -1,9 +1,22 @@ FROM golang:latest +### Install InfluxDB clients for testing +# Install InfluxDB keys to verify client installs. +# Follow the install instructions (https://docs.influxdata.com/telegraf/v1/install/?t=curl), except for sudo (which isn't available in Docker). +# influxdata-archive_compat.key GPG fingerprint: +# 9D53 9D90 D332 8DC7 D6C8 D3B9 D8FF 8E1F 7DF8 B07E +ADD https://repos.influxdata.com/influxdata-archive_compat.key ./influxdata-archive_compat.key +RUN echo '393e8779c89ac8d958f81f942f9ad7fb82a25e133faddaf92e15b16e6ac9ce4c influxdata-archive_compat.key' | sha256sum -c && cat influxdata-archive_compat.key | gpg --dearmor | tee /etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg > /dev/null + +RUN echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg] https://repos.influxdata.com/debian stable main' | tee /etc/apt/sources.list.d/influxdata.list + +# Install InfluxDB clients to use in tests. RUN apt-get update && apt-get upgrade -y && apt-get install -y \ curl \ git \ gpg \ + influxdb2-cli \ + influxctl \ jq \ maven \ nodejs \ @@ -11,6 +24,8 @@ RUN apt-get update && apt-get upgrade -y && apt-get install -y \ python3 \ python3-pip \ python3-venv \ + rsync \ + telegraf \ wget RUN ln -s /usr/bin/python3 /usr/bin/python @@ -26,38 +41,33 @@ ENV PYTHONUNBUFFERED=1 WORKDIR /app +# 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. +COPY ./test/pytest/pytest.ini pytest.ini +# Python and Pytest dependencies. +COPY ./test/pytest/requirements.txt requirements.txt +# Pytest fixtures. +COPY ./test/pytest/conftest.py conftest.py +RUN pip install -Ur requirements.txt + +# Activate the Python virtual environment configured in the Dockerfile. +RUN . /opt/venv/bin/activate + +ARG CONTENT_PATH +ENV CONTENT_PATH="${CONTENT_PATH}" + # Create a mock xdg-open script` to prevent the test suite from attempting to open a browser (for example, during influxctl OAuth2 authentication). 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 -# 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. -COPY ./test/src/pytest.ini pytest.ini -# Python and Pytest dependencies. -COPY ./test/src/requirements.txt requirements.txt -# Pytest fixtures. -COPY ./test/src/conftest.py conftest.py -RUN pip install -Ur requirements.txt - - # Activate the Python virtual environment configured in the Dockerfile. -RUN . /opt/venv/bin/activate - -### Install InfluxDB clients for testing -# Install InfluxDB keys to verify client installs. -# Follow the install instructions (https://docs.influxdata.com/telegraf/v1/install/?t=curl), except for sudo (which isn't available in Docker). -# influxdata-archive_compat.key GPG fingerprint: -# 9D53 9D90 D332 8DC7 D6C8 D3B9 D8FF 8E1F 7DF8 B07E -ADD https://repos.influxdata.com/influxdata-archive_compat.key ./influxdata-archive_compat.key -RUN echo '393e8779c89ac8d958f81f942f9ad7fb82a25e133faddaf92e15b16e6ac9ce4c influxdata-archive_compat.key' | sha256sum -c && cat influxdata-archive_compat.key | gpg --dearmor | tee /etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg > /dev/null - -RUN echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg] https://repos.influxdata.com/debian stable main' | tee /etc/apt/sources.list.d/influxdata.list - -# Install InfluxDB clients to use in tests. -RUN apt-get update && apt-get -y install telegraf influxdb2-cli influxctl -COPY --chmod=755 ./test/config.toml /root/.config/influxctl/config.toml -### End InfluxDB client installs +# Copy test scripts and make them executable. +COPY --chmod=755 ./test/scripts/parse_yaml.sh /usr/local/bin/parse_yaml ENTRYPOINT [ "pytest" ] -CMD [ "" ] \ No newline at end of file + +# Specify command arguments: +# --env-file to pass environment variables to the test suite. +# the test directory to run the test suite. +CMD [ "--codeblocks", "" ] \ No newline at end of file diff --git a/Dockerfile.tests b/Dockerfile.tests index 852ce2e04..5d675f1cf 100644 --- a/Dockerfile.tests +++ b/Dockerfile.tests @@ -12,6 +12,7 @@ COPY --chmod=755 ./test/src/prepare-content.sh /usr/local/bin/prepare-content COPY ./data/products.yml /app/appdata/products.yml WORKDIR /src +# In your docker run or exec command, you can set the prepare-content script as your entrypoint or command. ENTRYPOINT [ "prepare-content" ] # The default command is an empty string to pass all command line arguments to the entrypoint and allow the entrypoint to run. CMD [ "" ] \ No newline at end of file diff --git a/compose.yaml b/compose.yaml index c61cd8910..76b477f8b 100644 --- a/compose.yaml +++ b/compose.yaml @@ -2,12 +2,20 @@ ## Run documentation tests for code samples. name: influxdata-docs services: - ## Run InfluxData documentation with the hugo development server on port 1313. - ## For more information about the hugomods/hugo image, see - ## https://docker.hugomods.com/docs/development/docker-compose/ local-dev: - image: hugomods/hugo:exts-0.123.8 + build: + context: . + dockerfile_inline: | + FROM hugomods/hugo:exts-0.123.8 + RUN apk add --no-cache curl openssl command: hugo server --bind 0.0.0.0 + healthcheck: + test: ["CMD", "curl", "-f", "http://localhost:1313/influxdb/cloud-dedicated/"] + interval: 1m + timeout: 10s + retries: 2 + start_period: 40s + start_interval: 5s ports: - 1313:1313 volumes: @@ -17,3 +25,317 @@ services: - type: bind source: $HOME/hugo_cache target: /tmp/hugo_cache + profiles: + - local + - lint + cloud-pytest: + image: influxdata/docs-pytest + build: + args: + - CONTENT_PATH=content/influxdb/cloud + context: . + dockerfile: Dockerfile.pytest + entrypoint: + - /bin/bash + - /src/test/scripts/run-tests.sh + - pytest + command: + # In the command, pass file paths to test. + # The container preprocesses the files for testing and runs the tests. + - content/influxdb/cloud/**/*.md + profiles: + - test + - v2 + stdin_open: true + tty: true + volumes: + # Site configuration files. + - type: bind + source: . + target: /src + read_only: true + # Files shared between host and container and writeable by both. + - type: bind + source: ./test/shared + target: /shared + - type: bind + source: ./content/influxdb/cloud/.env.test + target: /app/.env.test + read_only: true + # In your code samples, use `/app/data/` or `data/` to access sample data files from the `static/downloads` directory. + - type: bind + source: ./static/downloads + target: /app/data + read_only: true + # In your code samples, use `/app/iot-starter` to store example modules or project files. + - type: volume + source: cloud-tmp + target: /app/iot-starter + # Target directory for the content under test. + # Files are copied from /src/content/ to /app/content/ before running tests. + - type: volume + source: test-content + target: /app/content + working_dir: /app + cloud-dedicated-pytest: + image: influxdata/docs-pytest + build: + args: + - CONTENT_PATH=content/influxdb/cloud-dedicated + context: . + dockerfile: Dockerfile.pytest + entrypoint: + - /bin/bash + - /src/test/scripts/run-tests.sh + - pytest + command: + # In the command, pass file paths to test. + # The container preprocesses the files for testing and runs the tests. + - content/influxdb/cloud-dedicated/**/*.md + profiles: + - test + - v3 + stdin_open: true + tty: true + volumes: + # Site configuration files. + - type: bind + source: . + target: /src + read_only: true + # Files shared between host and container and writeable by both. + - type: bind + source: ./test/shared + target: /shared + - type: bind + source: ./content/influxdb/cloud-dedicated/.env.test + target: /app/.env.test + read_only: true + # The following mount assumes your influxctl configuration file is located at ./content/influxdb/cloud-dedicated/config.toml. + - type: bind + source: ./content/influxdb/cloud-dedicated/config.toml + target: /root/.config/influxctl/config.toml + read_only: true + # In your code samples, use `/app/data/` or `data/` to access sample data files from the `static/downloads` directory. + - type: bind + source: ./static/downloads + target: /app/data + read_only: true + # In your code samples, use `/app/iot-starter` to store example modules or project files. + - type: volume + source: cloud-dedicated-tmp + target: /app/iot-starter + # Target directory for the content under test. + # Files are copied from /src/content/ to /app/content/ before running tests. + - type: volume + source: test-content + target: /app/content + working_dir: /app + cloud-serverless-pytest: + image: influxdata/docs-pytest + build: + args: + - CONTENT_PATH=content/influxdb/cloud-serverless + context: . + dockerfile: Dockerfile.pytest + entrypoint: + - /bin/bash + - /src/test/scripts/run-tests.sh + - pytest + command: + # In the command, pass file paths to test. + # The container preprocesses the files for testing and runs the tests. + - content/influxdb/cloud-serverless/**/*.md + profiles: + - test + - v3 + stdin_open: true + tty: true + volumes: + # Site configuration files. + - type: bind + source: . + target: /src + read_only: true + # Files shared between host and container and writeable by both. + - type: bind + source: ./test/shared + target: /shared + - type: bind + source: ./content/influxdb/cloud-serverless/.env.test + target: /app/.env.test + read_only: true + # In your code samples, use `/app/data/` or `data/` to access sample data files from the `static/downloads` directory. + - type: bind + source: ./static/downloads + target: /app/data + read_only: true + # In your code samples, use `/app/iot-starter` to store example modules or project files. + - type: volume + source: cloud-serverless-tmp + target: /app/iot-starter + # Target directory for the content under test. + # Files are copied from /src/content/ to /app/content/ before running tests. + - type: volume + source: test-content + target: /app/content + working_dir: /app + clustered-pytest: + image: influxdata/docs-pytest + build: + args: + - CONTENT_PATH=content/influxdb/clustered + context: . + dockerfile: Dockerfile.pytest + entrypoint: + - /bin/bash + - /src/test/scripts/run-tests.sh + - pytest + command: + # In the command, pass file paths to test. + # The container preprocesses the files for testing and runs the tests. + - content/influxdb/clustered/**/*.md + profiles: + - test + - v3 + stdin_open: true + tty: true + volumes: + # Site configuration files. + - type: bind + source: . + target: /src + read_only: true + # Files shared between host and container and writeable by both. + - type: bind + source: ./test/shared + target: /shared + - type: bind + source: ./content/influxdb/clustered/.env.test + target: /app/.env.test + read_only: true + # The following mount assumes your influxctl configuration file is located at ./content/influxdb/clustered/config.toml. + - type: bind + source: ./content/influxdb/clustered/config.toml + target: /root/.config/influxctl/config.toml + read_only: true + # In your code samples, use `/app/data/` or `data/` to access sample data files from the `static/downloads` directory. + - type: bind + source: ./static/downloads + target: /app/data + read_only: true + # In your code samples, use `/app/iot-starter` to store example modules or project files. + - type: volume + source: clustered-tmp + target: /app/iot-starter + # Target directory for the content under test. + # Files are copied from /src/content/ to /app/content/ before running tests. + - type: volume + source: test-content + target: /app/content + working_dir: /app + telegraf-pytest: + image: influxdata/docs-pytest + build: + args: + - CONTENT_PATH=content/telegraf + context: . + dockerfile: Dockerfile.pytest + entrypoint: + - /bin/bash + - /src/test/scripts/run-tests.sh + - pytest + command: + # In the command, pass file paths to test. + # The container preprocesses the files for testing and runs the tests. + - content/telegraf/**/*.md + profiles: + - test + stdin_open: true + tty: true + volumes: + # Site configuration files. + - type: bind + source: . + target: /src + read_only: true + # Files shared between host and container and writeable by both. + - type: bind + source: ./test/shared + target: /shared + - type: bind + source: ./content/telegraf/.env.test + target: /app/.env.test + read_only: true + # In your code samples, use `/app/data/` or `data/` to access sample data files from the `static/downloads` directory. + - type: bind + source: ./static/downloads + target: /app/data + read_only: true + # In your code samples, use `/app/iot-starter` to store example modules or project files. + - type: volume + source: telegraf-tmp + target: /app/iot-starter + # Target directory for the content under test. + # Files are copied from /src/content/ to /app/content/ before running tests. + - type: volume + source: test-content + target: /app/content + working_dir: /app + v2-pytest: + image: influxdata/docs-pytest + build: + args: + - CONTENT_PATH=content/influxdb/v2 + context: . + dockerfile: Dockerfile.pytest + entrypoint: + - /bin/bash + - /src/test/scripts/run-tests.sh + - pytest + command: + # In the command, pass file paths to test. + # The container preprocesses the files for testing and runs the tests. + - content/influxdb/v2/**/*.md + profiles: + - test + - v2 + stdin_open: true + tty: true + volumes: + # Site configuration files. + - type: bind + source: . + target: /src + read_only: true + # Files shared between host and container and writeable by both. + - type: bind + source: ./test/shared + target: /shared + - type: bind + source: ./content/influxdb/v2/.env.test + target: /app/.env.test + read_only: true + # In your code samples, use `/app/data/` or `data/` to access sample data files from the `static/downloads` directory. + - type: bind + source: ./static/downloads + target: /app/data + read_only: true + # In your code samples, use `/app/iot-starter` to store example modules or project files. + - type: volume + source: v2-tmp + target: /app/iot-starter + # Target directory for the content under test. + # Files are copied from /src/content/ to /app/content/ before running tests. + - type: volume + source: test-content + target: /app/content + working_dir: /app +volumes: + test-content: + cloud-tmp: + cloud-dedicated-tmp: + cloud-serverless-tmp: + clustered-tmp: + telegraf-tmp: + v2-tmp: \ No newline at end of file diff --git a/content/influxdb/cloud-dedicated/.vale.ini b/content/influxdb/cloud-dedicated/.vale.ini index 8973c692c..c2ca4cb2f 100644 --- a/content/influxdb/cloud-dedicated/.vale.ini +++ b/content/influxdb/cloud-dedicated/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Cloud-Dedicated, Google, write-good +Google.Acronyms = NO Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO diff --git a/content/influxdb/cloud-serverless/.vale.ini b/content/influxdb/cloud-serverless/.vale.ini index 43840007e..4472fd3c1 100644 --- a/content/influxdb/cloud-serverless/.vale.ini +++ b/content/influxdb/cloud-serverless/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Cloud-Serverless, Google, write-good +Google.Acronyms = NO Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO diff --git a/content/influxdb/clustered/.vale.ini b/content/influxdb/clustered/.vale.ini index 193ae44b3..c381f0cde 100644 --- a/content/influxdb/clustered/.vale.ini +++ b/content/influxdb/clustered/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Clustered, Google, write-good +Google.Acronyms = NO Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO diff --git a/lefthook.yml b/lefthook.yml new file mode 100644 index 000000000..e3aea75ba --- /dev/null +++ b/lefthook.yml @@ -0,0 +1,106 @@ +# Refer for explanation to following link: +# https://github.com/evilmartians/lefthook/blob/master/docs/configuration.md +# +pre-push: + commands: + packages-audit: + tags: frontend security + run: yarn audit +pre-commit: + parallel: true + commands: + cloud-lint: + tags: lint v2 + glob: "content/influxdb/cloud/**/*.md" + run: '.ci/vale/vale.sh + -config=.vale.ini + --minAlertLevel=error {staged_files}' + cloud-dedicated-lint: + tags: lint v3 + glob: "content/influxdb/cloud-dedicated/**/*.md" + run: '.ci/vale/vale.sh + --config=content/influxdb/cloud-dedicated/.vale.ini + --minAlertLevel=error {staged_files}' + cloud-serverless-lint: + tags: lint v3 + glob: "content/influxdb/cloud-serverless/**/*.md" + run: '.ci/vale/vale.sh + --config=content/influxdb/cloud-serverless/.vale.ini + --minAlertLevel=error {staged_files}' + clustered-lint: + tags: lint v3 + glob: "content/influxdb/clustered/**/*.md" + run: '.ci/vale/vale.sh + --config=content/influxdb/cloud-serverless/.vale.ini + --minAlertLevel=error {staged_files}' + telegraf-lint: + tags: lint clients + glob: "content/telegraf/**/*.md" + run: '.ci/vale/vale.sh + --config=.vale.ini + --minAlertLevel=error {staged_files}' + v2-lint: + tags: lint v2 + glob: "content/influxdb/v2/**/*.md" + run: '.ci/vale/vale.sh + --config=.vale.ini + --minAlertLevel=error {staged_files}' + cloud-pytest: + glob: content/influxdb/cloud/**/*.md + tags: test codeblocks v2 + env: + - SERVICE: cloud-pytest + run: docker compose run $SERVICE '{staged_files}' + cloud-dedicated-pytest: + tags: test codeblocks v3 + glob: content/influxdb/cloud-dedicated/**/*.md + env: + - SERVICE: cloud-dedicated-pytest + run: | + ./test/scripts/monitor-tests.sh start $SERVICE ; + docker compose run $SERVICE {staged_files} ; + ./test/scripts/monitor-tests.sh stop $SERVICE + cloud-serverless-pytest: + tags: test codeblocks v3 + glob: content/influxdb/cloud-serverless/**/*.md + env: + - SERVICE: cloud-serverless-pytest + run: docker compose run $SERVICE '{staged_files}' + clustered-pytest: + tags: test codeblocks v3 + glob: content/influxdb/clustered/**/*.md + env: + - SERVICE: clustered-pytest + run: | + ./test/scripts/monitor-tests.sh start $SERVICE ; + docker compose run $SERVICE {staged_files} ; + ./test/scripts/monitor-tests.sh stop $SERVICE + telegraf-pytest: + tags: test codeblocks + glob: content/telegraf/**/*.md + env: + - SERVICE: telegraf-pytest + run: docker compose run $SERVICE '{staged_files}' + v2-pytest: + tags: test codeblocks v2 + glob: content/influxdb/v2/**/*.md + env: + - SERVICE: v2-pytest + run: docker compose run $SERVICE '{staged_files}' + prettier: + tags: frontend style + glob: "*.{css,js,ts,jsx,tsx}" + run: yarn prettier {staged_files} + +build: + commands: + prune-legacy-containers: + priority: 1 + tags: test + run: '(docker container ls --format "{{.ID}}" + --filter label=tag=influxdata-docs + --filter status=exited | xargs docker rm) + || true' + rebuild-test-images: + tags: test + run: docker compose build pytest-codeblocks diff --git a/package.json b/package.json index 5e2c28c16..3522aa659 100644 --- a/package.json +++ b/package.json @@ -5,11 +5,10 @@ "description": "InfluxDB documentation", "license": "MIT", "devDependencies": { + "@evilmartians/lefthook": "^1.7.1", "@vvago/vale": "^3.4.2", "autoprefixer": ">=10.2.5", "hugo-extended": ">=0.101.0", - "husky": "^9.0.11", - "lint-staged": "^15.2.5", "postcss": ">=8.4.31", "postcss-cli": ">=9.1.0", "prettier": "^3.2.5", @@ -20,15 +19,9 @@ "js-yaml": "^4.1.0" }, "scripts": { - "lint-cloud": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/cloud\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=.vale.ini", - "lint-clustered": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/clustered\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=content/influxdb/clustered/.vale.ini", - "lint-dedicated": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/cloud-dedicated\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=content/influxdb/cloud-dedicated/.vale.ini", - "lint-serverless": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/cloud-serverless\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=content/influxdb/cloud-serverless/.vale.ini", - "lint-telegraf": "git diff --name-only --diff-filter=d HEAD | grep \"content/telegraf\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=.vale.ini", - "lint-v1": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/v1\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=.vale.ini", - "lint-v2": "git diff --name-only --diff-filter=d HEAD | grep \"content/influxdb/v2\" | xargs .ci/vale/vale.sh --minAlertLevel=suggestion --config=.vale.ini", - "prepare": "husky", - "test": "lint-staged --relative" + "lint": "LEFTHOOK_EXCLUDE=test lefthook run pre-commit && lefthook run pre-push", + "pre-commit": "lefthook run pre-commit", + "test-content": "docker compose --profile test up" }, "main": "index.js", "module": "main.js", diff --git a/test/.gitignore b/test/.gitignore index 21065a63c..726e3ff57 100644 --- a/test/.gitignore +++ b/test/.gitignore @@ -2,7 +2,7 @@ /Cargo.lock config.toml content -monitor_urls_pid +_*_pid node_modules shared tmp diff --git a/test/src/conftest.py b/test/pytest/conftest.py similarity index 100% rename from test/src/conftest.py rename to test/pytest/conftest.py diff --git a/test/src/pytest.ini b/test/pytest/pytest.ini similarity index 100% rename from test/src/pytest.ini rename to test/pytest/pytest.ini diff --git a/test/src/requirements.txt b/test/pytest/requirements.txt similarity index 100% rename from test/src/requirements.txt rename to test/pytest/requirements.txt diff --git a/test/src/monitor-container-urls.sh b/test/scripts/monitor-container-urls.sh similarity index 88% rename from test/src/monitor-container-urls.sh rename to test/scripts/monitor-container-urls.sh index 1938c5727..22e71b888 100755 --- a/test/src/monitor-container-urls.sh +++ b/test/scripts/monitor-container-urls.sh @@ -1,9 +1,9 @@ #!/bin/bash ## This script is meant to be run on the host and monitors a file for URLs written by a container. - +DOCS_ROOT=$(git rev-parse --show-toplevel) # The file to monitor for URLs written by the container. -URL_FILE="./test/shared/urls.txt" +URL_FILE=$DOCS_ROOT/test/shared/urls.txt # Define the URL pattern for OAuth2 authorization. OAUTH_PATTERN='https://auth\.influxdata\.com/activate\?user_code=[A-Z]{1,8}-[A-Z]{1,8}' diff --git a/test/scripts/monitor-tests.sh b/test/scripts/monitor-tests.sh new file mode 100755 index 000000000..af53f557e --- /dev/null +++ b/test/scripts/monitor-tests.sh @@ -0,0 +1,43 @@ +#!/bin/bash + +CONTEXT=$(git rev-parse --show-toplevel) + +function start() { + pid_file=$1 + $CONTEXT/test/scripts/monitor-container-urls.sh & echo $! >> "$pid_file" +} + +function kill_processes() { + pid_file=$1 + # Kill all processes in the monitor_urls_pid file + echo "Cleaning up monitor-container-urls processes..." + while read -r PID; do + kill $PID 2>/dev/null; ps -p $PID > /dev/null + if [ $? -ne 0 ]; then + sed -i '' "/$PID/d" "$pid_file" + echo "Successfully stopped monitor-container-urls process $PID" + else + # Leave it in the file to try stopping it again next time + # and output the error message + echo "Failed to stop monitor-container-urls process $PID" + fi + done < "$pid_file" +} + +function get_pid_path() { + TMP_DIR="${CONTEXT}/test/tmp" + mkdir -p $TMP_DIR + echo "${TMP_DIR}/_${1}_monitor_urls_pid" +} + +case "$1" in + start) + test_name=$2 + start "$(get_pid_path $test_name)" + ;; + stop) + test_name=$2 + kill_processes "$(get_pid_path $test_name)" + ;; + *) echo "Usage: $0 {start TEST_NAME|stop TEST_NAME}" ;; +esac diff --git a/test/src/parse_yaml.sh b/test/scripts/parse_yaml.sh similarity index 100% rename from test/src/parse_yaml.sh rename to test/scripts/parse_yaml.sh diff --git a/test/src/prepare-content.sh b/test/scripts/prepare-content.sh similarity index 83% rename from test/src/prepare-content.sh rename to test/scripts/prepare-content.sh index 4da6fa345..8047ef6df 100644 --- a/test/src/prepare-content.sh +++ b/test/scripts/prepare-content.sh @@ -2,9 +2,7 @@ # This script is used to run tests for the InfluxDB documentation. # The script is designed to be run in a Docker container. It is used to substitute placeholder values in test files. - TEST_CONTENT="/app/content" - # Pattern to match a 10-digit Unix timestamp TIMESTAMP_PATTERN='[0-9]{10}' @@ -17,7 +15,6 @@ function substitute_placeholders { # echo "PRETEST: substituting values in $file" # Replaces placeholder values with environment variable references. - # Date-specific replacements. grep -oE "$TIMESTAMP_PATTERN" "$file" | while read -r timestamp; do @@ -62,7 +59,7 @@ function substitute_placeholders { s/f"DATABASE_TOKEN"/os.getenv("INFLUX_TOKEN")/g; s/f"get-started"/os.getenv("INFLUX_DATABASE")/g; s|f"{{< influxdb/host >}}"|os.getenv("INFLUX_HOSTNAME")|g; - s/f"MANAGEMENT_TOKEN"/os.getenv("MANAGEMENT_TOKEN")/g; + s/f"MANAGEMENT_TOKEN"/os.getenv("INFLUX_MANAGEMENT_TOKEN")/g; s|f"RETENTION_POLICY_NAME\|RETENTION_POLICY"|"autogen"|g; ' $file @@ -80,12 +77,13 @@ function substitute_placeholders { /os.getenv("BUCKET_ID")/! s/--bucket-id BUCKET_ID/--bucket-id $INFLUX_BUCKET_ID/g; /os.getenv("BUCKET_NAME")/! s/BUCKET_NAME/$INFLUX_DATABASE/g; /os.getenv("CLUSTER_ID")/! s/CLUSTER_ID/$CLUSTER_ID/g; + s/0x000000-xy00-0xy-x00-0x00y0000000/$CLUSTER_ID/g; /os.getenv("DATABASE_TOKEN")/! s/DATABASE_TOKEN/$INFLUX_TOKEN/g; /os.getenv("DATABASE_NAME")/! s/DATABASE_NAME/$INFLUX_DATABASE/g; s/--id DBRP_ID/--id $INFLUX_DBRP_ID/g; s/example-db/$INFLUX_DATABASE/g; s/get-started/$INFLUX_DATABASE/g; - /os.getenv("MANAGEMENT_TOKEN")/! s/MANAGEMENT_TOKEN/$MANAGEMENT_TOKEN/g; + /os.getenv("MANAGEMENT_TOKEN")/! s/INFLUX_MANAGEMENT_TOKEN/$MANAGEMENT_TOKEN/g; /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; @@ -111,8 +109,9 @@ function substitute_placeholders { } setup() { + # Set up the environment for the tests. # Parse YAML config files into dotenv files to be used by tests. - parse_yaml /app/appdata/products.yml > /app/appdata/.env.products + mkdir -p /app/appdata && (parse_yaml /src/data/products.yml > /app/appdata/.env.products) # Miscellaneous test setup. # For macOS samples. @@ -120,30 +119,17 @@ setup() { } prepare_tests() { - TEST_FILES="$*" + echo "Preparing test files: $*" + SRC_FILES="$*" # Copy the test files to the target directory while preserving the directory structure. - for FILE in $TEST_FILES; do - # Create the parent directories of the destination file - #mkdir -p "$(dirname "$TEST_TARGET/$FILE")" - # Copy the file - rsync -avz --relative --log-file=./test.log "$FILE" /app/ + cd /src + for FILE in $SRC_FILES; do + rsync -az --relative "$FILE" /app/ done - + cd /app substitute_placeholders + setup } -# If arguments were passed and the first argument is not --files, run the command. This is useful for running "/bin/bash" for debugging the container. -# If --files is passed, prepare all remaining arguments as test files. -# Otherwise (no arguments), run the setup function and return existing files to be tested. -if [ "$1" != "--files" ]; then - echo "Executing $0 without --files argument." - "$@" -fi -if [ "$1" == "--files" ]; then - shift - prepare_tests "$@" -fi -setup -# Return new or existing files to be tested. -find "$TEST_CONTENT" -type f -name '*.md' +prepare_tests "$*" diff --git a/test/scripts/run-tests.sh b/test/scripts/run-tests.sh new file mode 100644 index 000000000..488da2804 --- /dev/null +++ b/test/scripts/run-tests.sh @@ -0,0 +1,34 @@ +#!/bin/bash + +# This script is used to run Pytest for the InfluxDB documentation. + +# Required arguments: +# - A space-separated list of file paths--the files to test--as unnamed arguments. + +src_path="" + +if [[ $CONTENT_PATH =~ ^content/. ]]; then +# Find the source content path in the container. + src_path=$(find "/src/${CONTENT_PATH}" -type d) +fi + +if [[ ! $src_path ]]; then + echo "The CONTENT_PATH variable must reference a directory inside content/." + exit 1 +fi + +runner="$1" +tests="${*:2}" + +rm -rf /app/"${CONTENT_PATH}"/* +bash /src/test/scripts/prepare-content.sh $tests + +if [[ $runner == "pytest" ]]; then + pytest \ + -s \ + --codeblocks \ + --suppress-no-test-exit-code \ + --exitfirst \ + --envfile=/app/.env.test \ + $tests +fi diff --git a/test/src/monitor-tests.sh b/test/src/monitor-tests.sh deleted file mode 100755 index fac2fad2a..000000000 --- a/test/src/monitor-tests.sh +++ /dev/null @@ -1,26 +0,0 @@ -pid_file=./test/monitor_urls_pid -function start { - ./test/src/monitor-container-urls.sh & echo $! >> "$pid_file" -} - -function kill_processes { - # Kill all processes in the monitor_urls_pid file - echo "Cleaning up monitor-container-urls processes..." - while read -r PID; do - kill $PID 2>/dev/null; ps -p $PID > /dev/null - if [ $? -ne 0 ]; then - sed -i '' "/$PID/d" "$pid_file" - echo "Successfully stopped monitor-container-urls process $PID" - else - # Leave it in the file to try stopping it again next time - # and output the error message - echo "Failed to stop monitor-container-urls process $PID" - fi - done < "$pid_file" -} - -case "$1" in - start) start ;; - stop) kill_processes ;; - *) echo "Usage: $0 {start|stop}" ;; -esac \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index c9db0f1d8..683d2d900 100644 --- a/yarn.lock +++ b/yarn.lock @@ -25,6 +25,11 @@ js-tokens "^4.0.0" picocolors "^1.0.0" +"@evilmartians/lefthook@^1.7.1": + version "1.7.1" + resolved "https://registry.yarnpkg.com/@evilmartians/lefthook/-/lefthook-1.7.1.tgz#9278070fcfc0b03acaaa5d4fb1ccfd11527b7adf" + integrity sha512-Wp8DaTMHZM1tUV4Mow6nG+6zq+giruD5054zHmFIDLXlPQxqYxnZMqJg0aYxe16vYwqFmH6NIClEMRdtGucO0Q== + "@isaacs/cliui@^8.0.2": version "8.0.2" resolved "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz" @@ -45,7 +50,7 @@ "@nodelib/fs.stat" "2.0.5" run-parallel "^1.1.9" -"@nodelib/fs.stat@^2.0.2", "@nodelib/fs.stat@2.0.5": +"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": version "2.0.5" resolved "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz" integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== @@ -100,11 +105,6 @@ tar "^6.1.15" unzipper "^0.10.14" -ansi-escapes@^6.2.0: - version "6.2.1" - resolved "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-6.2.1.tgz" - integrity sha512-4nJ3yixlEthEJ9Rk4vPcdBRkZvQZlYyu8j4/Mqz5sgIkddmEnH2Yj2ZrnP9S3tQOvSNRUIgVNF/1yPpRAGNRig== - ansi-regex@^5.0.1: version "5.0.1" resolved "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz" @@ -129,7 +129,7 @@ ansi-styles@^4.0.0: dependencies: color-convert "^2.0.1" -ansi-styles@^6.0.0, ansi-styles@^6.1.0, ansi-styles@^6.2.1: +ansi-styles@^6.1.0: version "6.2.1" resolved "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz" integrity sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug== @@ -236,7 +236,7 @@ braces@^3.0.3, braces@~3.0.2: dependencies: fill-range "^7.1.1" -browserslist@^4.23.0, "browserslist@>= 4.21.0": +browserslist@^4.23.0: version "4.23.0" resolved "https://registry.npmjs.org/browserslist/-/browserslist-4.23.0.tgz" integrity sha512-QW8HiM1shhT2GuzkvklfjcKDiWFXHOeFCIA/huJPwHsslwcydgk7X+z2zXpEijP98UCY7HbubZt5J2Zgvf0CaQ== @@ -338,7 +338,7 @@ chalk@^2.4.2: escape-string-regexp "^1.0.5" supports-color "^5.3.0" -chalk@^5.0.0, chalk@~5.3.0: +chalk@^5.0.0: version "5.3.0" resolved "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz" integrity sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w== @@ -363,21 +363,6 @@ chownr@^2.0.0: resolved "https://registry.npmjs.org/chownr/-/chownr-2.0.0.tgz" integrity sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ== -cli-cursor@^4.0.0: - version "4.0.0" - resolved "https://registry.npmjs.org/cli-cursor/-/cli-cursor-4.0.0.tgz" - integrity sha512-VGtlMu3x/4DOtIUwEkRezxUZ2lBacNJCHash0N0WeZDBS+7Ux1dm3XWAgWYxLJFMMdOeXMHXorshEFhbMSGelg== - dependencies: - restore-cursor "^4.0.0" - -cli-truncate@^4.0.0: - version "4.0.0" - resolved "https://registry.npmjs.org/cli-truncate/-/cli-truncate-4.0.0.tgz" - integrity sha512-nPdaFdQ0h/GEigbPClz11D0v/ZJEwxmeVZGeMo3Z5StPtUTkA9o1lD6QwoirYiSDzbcwn2XcjwmCp68W1IS4TA== - dependencies: - slice-ansi "^5.0.0" - string-width "^7.0.0" - cliui@^8.0.1: version "8.0.1" resolved "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz" @@ -401,21 +386,16 @@ color-convert@^2.0.1: dependencies: color-name "~1.1.4" +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" + integrity sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== + color-name@~1.1.4: version "1.1.4" resolved "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz" integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== -color-name@1.1.3: - version "1.1.3" - resolved "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz" - integrity sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== - -colorette@^2.0.20: - version "2.0.20" - resolved "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz" - integrity sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w== - combined-stream@^1.0.8: version "1.0.8" resolved "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz" @@ -428,11 +408,6 @@ commander@^2.19.0, commander@^2.8.1: resolved "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz" integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ== -commander@~12.1.0: - version "12.1.0" - resolved "https://registry.npmjs.org/commander/-/commander-12.1.0.tgz" - integrity sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA== - concat-map@0.0.1: version "0.0.1" resolved "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz" @@ -443,7 +418,7 @@ core-util-is@~1.0.0: resolved "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz" integrity sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ== -cross-spawn@^7.0.0, cross-spawn@^7.0.3: +cross-spawn@^7.0.0: version "7.0.3" resolved "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz" integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w== @@ -459,7 +434,7 @@ crypto-random-string@^4.0.0: dependencies: type-fest "^1.0.1" -debug@^4.3.4, debug@~4.3.4: +debug@^4.3.4: version "4.3.4" resolved "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz" integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ== @@ -563,11 +538,6 @@ electron-to-chromium@^1.4.668: resolved "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.784.tgz" integrity sha512-9CZwh+sDrhDAeOEFh8s3PqwduzTyYIeYwZolc1b9ENAUt3ePu7R1sJSCWr/820ISssRxCJUyHI9Wb7j+0Uo1AA== -emoji-regex@^10.3.0: - version "10.3.0" - resolved "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.3.0.tgz" - integrity sha512-QpLs9D9v9kArv4lfDEgg1X/gN5XLnf/A6l9cs8SPZLRZR3ZkY9+kwIQTxm+fsSej5UMYGE8fdoaZVIBlqG0XTw== - emoji-regex@^8.0.0: version "8.0.0" resolved "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz" @@ -602,26 +572,6 @@ escape-string-regexp@^1.0.5: resolved "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz" integrity sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg== -eventemitter3@^5.0.1: - version "5.0.1" - resolved "https://registry.npmjs.org/eventemitter3/-/eventemitter3-5.0.1.tgz" - integrity sha512-GWkBvjiSZK87ELrYOSESUYeVIc9mvLLf/nXalMOS5dYrgZq9o5OVkbZAVM06CVxYsCwH9BDZFPlQTlPA1j4ahA== - -execa@~8.0.1: - version "8.0.1" - resolved "https://registry.npmjs.org/execa/-/execa-8.0.1.tgz" - integrity sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg== - dependencies: - cross-spawn "^7.0.3" - get-stream "^8.0.1" - human-signals "^5.0.0" - is-stream "^3.0.0" - merge-stream "^2.0.0" - npm-run-path "^5.1.0" - onetime "^6.0.0" - signal-exit "^4.1.0" - strip-final-newline "^3.0.0" - fast-glob@^3.3.2: version "3.3.2" resolved "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz" @@ -760,21 +710,16 @@ get-caller-file@^2.0.5: resolved "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz" integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg== -get-east-asian-width@^1.0.0: - version "1.2.0" - resolved "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.2.0.tgz" - integrity sha512-2nk+7SIVb14QrgXFHcm84tD4bKQz0RxPuMT8Ag5KPOq7J5fEmAg0UbXdTOSHqNuHSU28k55qnceesxXRZGzKWA== +get-stdin@=8.0.0: + version "8.0.0" + resolved "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz" + integrity sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg== get-stdin@^9.0.0: version "9.0.0" resolved "https://registry.npmjs.org/get-stdin/-/get-stdin-9.0.0.tgz" integrity sha512-dVKBjfWisLAicarI2Sf+JuBE/DghV4UzNAVe9yhEJuzeREd3JhOTE9cUaJTeSa77fsbQUK3pcOpJfM59+VKZaA== -get-stdin@=8.0.0: - version "8.0.0" - resolved "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz" - integrity sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg== - get-stream@^2.2.0: version "2.3.1" resolved "https://registry.npmjs.org/get-stream/-/get-stream-2.3.1.tgz" @@ -788,11 +733,6 @@ get-stream@^6.0.1: resolved "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz" integrity sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg== -get-stream@^8.0.1: - version "8.0.1" - resolved "https://registry.npmjs.org/get-stream/-/get-stream-8.0.1.tgz" - integrity sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA== - glob-parent@^5.1.2, glob-parent@~5.1.2: version "5.1.2" resolved "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz" @@ -898,16 +838,6 @@ hugo-extended@>=0.101.0: log-symbols "^5.1.0" read-pkg-up "^9.1.0" -human-signals@^5.0.0: - version "5.0.0" - resolved "https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz" - integrity sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ== - -husky@^9.0.11: - version "9.0.11" - resolved "https://registry.npmjs.org/husky/-/husky-9.0.11.tgz" - integrity sha512-AB6lFlbwwyIqMdHYhwPe+kjOC3Oc5P3nThEoW/AaO2BX3vJDjWPFxYLxokUZOo6RNX20He3AaT8sESs9NJcmEw== - ieee754@^1.1.13: version "1.2.1" resolved "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz" @@ -926,7 +856,7 @@ inflight@^1.0.4: once "^1.3.0" wrappy "1" -inherits@~2.0.0, inherits@~2.0.3, inherits@2: +inherits@2, inherits@~2.0.0, inherits@~2.0.3: version "2.0.4" resolved "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz" integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== @@ -960,18 +890,6 @@ is-fullwidth-code-point@^3.0.0: resolved "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz" integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== -is-fullwidth-code-point@^4.0.0: - version "4.0.0" - resolved "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-4.0.0.tgz" - integrity sha512-O4L094N2/dZ7xqVdrXhh9r1KODPJpFms8B5sGdJLPy664AgvXsreZUyCQQNItZRDlYug4xStLjNp/sz3HvBowQ== - -is-fullwidth-code-point@^5.0.0: - version "5.0.0" - resolved "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-5.0.0.tgz" - integrity sha512-OVa3u9kkBbw7b8Xw5F9P+D/T9X+Z4+JruYVNapTjPYZYUznQ5YfWeFkOj606XYYW8yugTfC8Pj0hYqvi4ryAhA== - dependencies: - get-east-asian-width "^1.0.0" - is-glob@^4.0.1, is-glob@~4.0.1: version "4.0.3" resolved "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz" @@ -1071,7 +989,7 @@ keyv@^4.5.3: dependencies: json-buffer "3.0.1" -lilconfig@^3.1.1, lilconfig@~3.1.1: +lilconfig@^3.1.1: version "3.1.1" resolved "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.1.tgz" integrity sha512-O18pf7nyvHTckunPWCV1XUNXU1piu01y2b7ATJ0ppkUkk8ocqVWBrYjJBCwHDjD/ZWcfyrA0P4gKhzWGi5EINQ== @@ -1081,39 +999,11 @@ lines-and-columns@^1.1.6: resolved "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz" integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== -lint-staged@^15.2.5: - version "15.2.5" - resolved "https://registry.npmjs.org/lint-staged/-/lint-staged-15.2.5.tgz" - integrity sha512-j+DfX7W9YUvdzEZl3Rk47FhDF6xwDBV5wwsCPw6BwWZVPYJemusQmvb9bRsW23Sqsaa+vRloAWogbK4BUuU2zA== - dependencies: - chalk "~5.3.0" - commander "~12.1.0" - debug "~4.3.4" - execa "~8.0.1" - lilconfig "~3.1.1" - listr2 "~8.2.1" - micromatch "~4.0.7" - pidtree "~0.6.0" - string-argv "~0.3.2" - yaml "~2.4.2" - listenercount@~1.0.1: version "1.0.1" resolved "https://registry.npmjs.org/listenercount/-/listenercount-1.0.1.tgz" integrity sha512-3mk/Zag0+IJxeDrxSgaDPy4zZ3w05PRZeJNnlWhzFz5OkX49J4krc+A8X2d2M69vGMBEX0uyl8M+W+8gH+kBqQ== -listr2@~8.2.1: - version "8.2.1" - resolved "https://registry.npmjs.org/listr2/-/listr2-8.2.1.tgz" - integrity sha512-irTfvpib/rNiD637xeevjO2l3Z5loZmuaRi0L0YE5LfijwVY96oyVn0DFD3o/teAok7nfobMG1THvvcHh/BP6g== - dependencies: - cli-truncate "^4.0.0" - colorette "^2.0.20" - eventemitter3 "^5.0.1" - log-update "^6.0.0" - rfdc "^1.3.1" - wrap-ansi "^9.0.0" - locate-path@^7.1.0: version "7.2.0" resolved "https://registry.npmjs.org/locate-path/-/locate-path-7.2.0.tgz" @@ -1129,17 +1019,6 @@ log-symbols@^5.1.0: chalk "^5.0.0" is-unicode-supported "^1.1.0" -log-update@^6.0.0: - version "6.0.0" - resolved "https://registry.npmjs.org/log-update/-/log-update-6.0.0.tgz" - integrity sha512-niTvB4gqvtof056rRIrTZvjNYE4rCUzO6X/X+kYjd7WFxXeJ0NwEFnRxX6ehkvv3jTwrXnNdtAak5XYZuIyPFw== - dependencies: - ansi-escapes "^6.2.0" - cli-cursor "^4.0.0" - slice-ansi "^7.0.0" - strip-ansi "^7.1.0" - wrap-ansi "^9.0.0" - lowercase-keys@^3.0.0: version "3.0.0" resolved "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-3.0.0.tgz" @@ -1164,17 +1043,12 @@ make-dir@^1.0.0: dependencies: pify "^3.0.0" -merge-stream@^2.0.0: - version "2.0.0" - resolved "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz" - integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== - merge2@^1.3.0: version "1.4.1" resolved "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz" integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== -micromatch@^4.0.4, micromatch@~4.0.7: +micromatch@^4.0.4: version "4.0.7" resolved "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz" integrity sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q== @@ -1194,16 +1068,6 @@ mime-types@^2.1.12: dependencies: mime-db "1.52.0" -mimic-fn@^2.1.0: - version "2.1.0" - resolved "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz" - integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== - -mimic-fn@^4.0.0: - version "4.0.0" - resolved "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz" - integrity sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw== - mimic-response@^3.1.0: version "3.1.0" resolved "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz" @@ -1240,17 +1104,12 @@ minipass@^3.0.0: dependencies: yallist "^4.0.0" -"minipass@^5.0.0 || ^6.0.2 || ^7.0.0": - version "7.1.2" - resolved "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz" - integrity sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw== - minipass@^5.0.0: version "5.0.0" resolved "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz" integrity sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ== -minipass@^7.1.2: +"minipass@^5.0.0 || ^6.0.2 || ^7.0.0", minipass@^7.1.2: version "7.1.2" resolved "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz" integrity sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw== @@ -1263,11 +1122,6 @@ minizlib@^2.1.1: minipass "^3.0.0" yallist "^4.0.0" -mkdirp@^1.0.3: - version "1.0.4" - resolved "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz" - integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== - "mkdirp@>=0.5 0": version "0.5.6" resolved "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.6.tgz" @@ -1275,6 +1129,11 @@ mkdirp@^1.0.3: dependencies: minimist "^1.2.6" +mkdirp@^1.0.3: + version "1.0.4" + resolved "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz" + integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== + moo@^0.5.0: version "0.5.2" resolved "https://registry.npmjs.org/moo/-/moo-0.5.2.tgz" @@ -1337,13 +1196,6 @@ normalize-url@^8.0.0: resolved "https://registry.npmjs.org/normalize-url/-/normalize-url-8.0.1.tgz" integrity sha512-IO9QvjUMWxPQQhs60oOu10CRkWCiZzSUkzbXGGV9pviYl1fXYcvkzQ5jV9z8Y6un8ARoVRl4EtC6v6jNqbaJ/w== -npm-run-path@^5.1.0: - version "5.3.0" - resolved "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz" - integrity sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ== - dependencies: - path-key "^4.0.0" - object-assign@^4.0.1: version "4.1.1" resolved "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz" @@ -1356,20 +1208,6 @@ once@^1.3.0, once@^1.4.0: dependencies: wrappy "1" -onetime@^5.1.0: - version "5.1.2" - resolved "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz" - integrity sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg== - dependencies: - mimic-fn "^2.1.0" - -onetime@^6.0.0: - version "6.0.0" - resolved "https://registry.npmjs.org/onetime/-/onetime-6.0.0.tgz" - integrity sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ== - dependencies: - mimic-fn "^4.0.0" - p-cancelable@^3.0.0: version "3.0.0" resolved "https://registry.npmjs.org/p-cancelable/-/p-cancelable-3.0.0.tgz" @@ -1414,11 +1252,6 @@ path-key@^3.1.0: resolved "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz" integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== -path-key@^4.0.0: - version "4.0.0" - resolved "https://registry.npmjs.org/path-key/-/path-key-4.0.0.tgz" - integrity sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ== - path-scurry@^1.11.1: version "1.11.1" resolved "https://registry.npmjs.org/path-scurry/-/path-scurry-1.11.1.tgz" @@ -1447,11 +1280,6 @@ picomatch@^2.0.4, picomatch@^2.2.1, picomatch@^2.3.1: resolved "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz" integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== -pidtree@~0.6.0: - version "0.6.0" - resolved "https://registry.npmjs.org/pidtree/-/pidtree-0.6.0.tgz" - integrity sha512-eG2dWTVw5bzqGRztnHExczNxt5VGsE6OwTeCG3fdUf9KBsZzO3R5OIIIzWR+iZA0NtZ+RDVdaoE2dK1cn6jH4g== - pify@^2.3.0: version "2.3.0" resolved "https://registry.npmjs.org/pify/-/pify-2.3.0.tgz" @@ -1513,7 +1341,7 @@ postcss-value-parser@^4.2.0: resolved "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz" integrity sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ== -postcss@^8.0.0, postcss@^8.1.0, postcss@>=8.0.9, postcss@>=8.4.31: +postcss@>=8.4.31: version "8.4.38" resolved "https://registry.npmjs.org/postcss/-/postcss-8.4.38.tgz" integrity sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A== @@ -1532,7 +1360,7 @@ prettier-plugin-sql@^0.18.0: sql-formatter "^15.0.2" tslib "^2.6.2" -prettier@^3.0.3, prettier@^3.2.5: +prettier@^3.2.5: version "3.2.5" resolved "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz" integrity sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A== @@ -1638,14 +1466,6 @@ responselike@^3.0.0: dependencies: lowercase-keys "^3.0.0" -restore-cursor@^4.0.0: - version "4.0.0" - resolved "https://registry.npmjs.org/restore-cursor/-/restore-cursor-4.0.0.tgz" - integrity sha512-I9fPXU9geO9bHOt9pHHOhOkYerIMsmVaWB0rA2AI9ERh/+x/i7MV5HKBNrg+ljO5eoPVgCcnFuRjJ9uH6I/3eg== - dependencies: - onetime "^5.1.0" - signal-exit "^3.0.2" - ret@~0.1.10: version "0.1.15" resolved "https://registry.npmjs.org/ret/-/ret-0.1.15.tgz" @@ -1656,10 +1476,12 @@ reusify@^1.0.4: resolved "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz" integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw== -rfdc@^1.3.1: - version "1.3.1" - resolved "https://registry.npmjs.org/rfdc/-/rfdc-1.3.1.tgz" - integrity sha512-r5a3l5HzYlIC68TpmYKlxWjmOP6wiPJ1vWv2HeLhNsRZMrCkxeqxiHlQ21oXmQ4F3SiryXBHhAD7JZqvOJjFmg== +rimraf@2: + version "2.7.1" + resolved "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz" + integrity sha512-uWjbaKIK3T1OSVptzX7Nl6PvQ3qAGtKEtVRjRuazjfL3Bx5eI409VZSqgND+4UNnmzLVdPj9FqFJNPqBZFve4w== + dependencies: + glob "^7.1.3" rimraf@^5.0.0: version "5.0.7" @@ -1668,13 +1490,6 @@ rimraf@^5.0.0: dependencies: glob "^10.3.7" -rimraf@2: - version "2.7.1" - resolved "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz" - integrity sha512-uWjbaKIK3T1OSVptzX7Nl6PvQ3qAGtKEtVRjRuazjfL3Bx5eI409VZSqgND+4UNnmzLVdPj9FqFJNPqBZFve4w== - dependencies: - glob "^7.1.3" - run-parallel@^1.1.9: version "1.2.0" resolved "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz" @@ -1721,12 +1536,7 @@ shebang-regex@^3.0.0: resolved "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz" integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== -signal-exit@^3.0.2: - version "3.0.7" - resolved "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz" - integrity sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ== - -signal-exit@^4.0.1, signal-exit@^4.1.0: +signal-exit@^4.0.1: version "4.1.0" resolved "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz" integrity sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw== @@ -1736,22 +1546,6 @@ slash@^5.0.0, slash@^5.1.0: resolved "https://registry.npmjs.org/slash/-/slash-5.1.0.tgz" integrity sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg== -slice-ansi@^5.0.0: - version "5.0.0" - resolved "https://registry.npmjs.org/slice-ansi/-/slice-ansi-5.0.0.tgz" - integrity sha512-FC+lgizVPfie0kkhqUScwRu1O/lF6NOgJmlCgK+/LYxDCTk8sGelYaHDhFcDN+Sn3Cv+3VSa4Byeo+IMCzpMgQ== - dependencies: - ansi-styles "^6.0.0" - is-fullwidth-code-point "^4.0.0" - -slice-ansi@^7.0.0: - version "7.1.0" - resolved "https://registry.npmjs.org/slice-ansi/-/slice-ansi-7.1.0.tgz" - integrity sha512-bSiSngZ/jWeX93BqeIAbImyTbEihizcwNjFoRUIY/T1wWQsfsm2Vw1agPKylXvQTU7iASGdHhyqRlqQzfz+Htg== - dependencies: - ansi-styles "^6.2.1" - is-fullwidth-code-point "^5.0.0" - source-map-js@^1.2.0: version "1.2.0" resolved "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.0.tgz" @@ -1792,18 +1586,6 @@ sql-formatter@^15.0.2: get-stdin "=8.0.0" nearley "^2.20.1" -string_decoder@~1.1.1: - version "1.1.1" - resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz" - integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== - dependencies: - safe-buffer "~5.1.0" - -string-argv@~0.3.2: - version "0.3.2" - resolved "https://registry.npmjs.org/string-argv/-/string-argv-0.3.2.tgz" - integrity sha512-aqD2Q0144Z+/RqG52NeHEkZauTAUWJO8c6yTftGJKO3Tja5tUgIfmIl6kExvhtxSDP7fXB6DvzkfMpCd/F3G+Q== - "string-width-cjs@npm:string-width@^4.2.0": version "4.2.3" resolved "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz" @@ -1831,14 +1613,12 @@ string-width@^5.0.1, string-width@^5.1.2: emoji-regex "^9.2.2" strip-ansi "^7.0.1" -string-width@^7.0.0: - version "7.1.0" - resolved "https://registry.npmjs.org/string-width/-/string-width-7.1.0.tgz" - integrity sha512-SEIJCWiX7Kg4c129n48aDRwLbFb2LJmXXFrWBG4NGaRtMQ3myKPKbwrD1BKqQn74oCoNMBVrfDEr5M9YxCsrkw== +string_decoder@~1.1.1: + version "1.1.1" + resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz" + integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== dependencies: - emoji-regex "^10.3.0" - get-east-asian-width "^1.0.0" - strip-ansi "^7.1.0" + safe-buffer "~5.1.0" "strip-ansi-cjs@npm:strip-ansi@^6.0.1": version "6.0.1" @@ -1854,7 +1634,7 @@ strip-ansi@^6.0.0, strip-ansi@^6.0.1: dependencies: ansi-regex "^5.0.1" -strip-ansi@^7.0.1, strip-ansi@^7.1.0: +strip-ansi@^7.0.1: version "7.1.0" resolved "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz" integrity sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ== @@ -1868,11 +1648,6 @@ strip-dirs@^2.0.0: dependencies: is-natural-number "^4.0.1" -strip-final-newline@^3.0.0: - version "3.0.0" - resolved "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz" - integrity sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw== - supports-color@^5.3.0: version "5.5.0" resolved "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz" @@ -2058,15 +1833,6 @@ wrap-ansi@^8.1.0: string-width "^5.0.1" strip-ansi "^7.0.1" -wrap-ansi@^9.0.0: - version "9.0.0" - resolved "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.0.tgz" - integrity sha512-G8ura3S+3Z2G+mkgNRq8dqaFZAuxfsxpBB8OCTGRTCtp+l/v9nbFNmCUP1BZMts3G1142MsZfn6eeUKrr4PD1Q== - dependencies: - ansi-styles "^6.2.1" - string-width "^7.0.0" - strip-ansi "^7.1.0" - wrappy@1: version "1.0.2" resolved "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz" @@ -2087,7 +1853,7 @@ yallist@^4.0.0: resolved "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz" integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== -yaml@^2.4.2, yaml@~2.4.2: +yaml@^2.4.2: version "2.4.2" resolved "https://registry.npmjs.org/yaml/-/yaml-2.4.2.tgz" integrity sha512-B3VqDZ+JAg1nZpaEmWtTXUlBneoGx6CPM9b0TENK6aoSu5t73dItudwdgmi6tHlIZZId4dZ9skcAQ2UbcyAeVA== From 94348a87390b1f0cff1d1e8e071f1d21db902146 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 23 Jul 2024 15:22:07 -0500 Subject: [PATCH 36/96] fix(ci): Lefthook config typo. Update management token variable name in env.test.example --- lefthook.yml | 2 +- test/env.test.example | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lefthook.yml b/lefthook.yml index e3aea75ba..bcf27775f 100644 --- a/lefthook.yml +++ b/lefthook.yml @@ -13,7 +13,7 @@ pre-commit: tags: lint v2 glob: "content/influxdb/cloud/**/*.md" run: '.ci/vale/vale.sh - -config=.vale.ini + --config=.vale.ini --minAlertLevel=error {staged_files}' cloud-dedicated-lint: tags: lint v3 diff --git a/test/env.test.example b/test/env.test.example index 7faf61dd3..3362d9921 100644 --- a/test/env.test.example +++ b/test/env.test.example @@ -7,4 +7,4 @@ INFLUX_HOSTNAME= INFLUX_DATABASE=myname-test-dedicated INFLUX_USER_NAME= INFLUX_RETENTION_POLICY=test-autogen -MANAGEMENT_TOKEN= \ No newline at end of file +INFLUX_MANAGEMENT_TOKEN= \ No newline at end of file From 4408a43de372d93eab1c821030e74908f778204d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 23 Jul 2024 15:41:16 -0500 Subject: [PATCH 37/96] fix: failing tests, skip tests for unsupported code samples, typos and updates --- .../cloud-dedicated/get-started/query.md | 15 +- .../cloud-dedicated/get-started/setup.md | 32 ++-- .../cloud-dedicated/get-started/write.md | 71 ++++----- .../client-libraries/flight/java-flightsql.md | 5 + .../cloud/write-data/no-code/third-party.md | 145 ++++++++++++++---- .../process-data/visualize/grafana.md | 4 - .../scrape-prometheus-metrics.md | 2 +- .../v2/write-data/no-code/third-party.md | 127 +++++++++++---- 8 files changed, 265 insertions(+), 136 deletions(-) diff --git a/content/influxdb/cloud-dedicated/get-started/query.md b/content/influxdb/cloud-dedicated/get-started/query.md index a3437de27..4b1ee4f91 100644 --- a/content/influxdb/cloud-dedicated/get-started/query.md +++ b/content/influxdb/cloud-dedicated/get-started/query.md @@ -314,15 +314,15 @@ _If your project's virtual environment is already running, skip to step 3._ 1. Create a directory for your project and change into it: - ```sh - mkdir influx3-query-example && cd $_ + ```bash + mkdir -p influx3-query-example && cd influx3-query-example ``` 2. To create and activate a Python virtual environment, run the following command: - ```sh + ```bash python -m venv envs/virtual-env && . envs/virtual-env/bin/activate ``` @@ -330,7 +330,7 @@ _If your project's virtual environment is already running, skip to step 3._ - ```sh + ```bash pip install influxdb3-python-cli ``` @@ -342,7 +342,7 @@ _If your project's virtual environment is already running, skip to step 3._ ```sh - influx3 config \ + influx3 config create \ --name="config-dedicated" \ --database="get-started" \ --host="{{< influxdb/host >}}" \ @@ -390,7 +390,7 @@ _If your project's virtual environment is already running, skip to step 3._ @@ -448,7 +448,8 @@ _If your project's virtual environment is already running, skip to step 3._ ''' table = client.query(query=sql) - assert table['room'], "Expect table to have room column." + assert table.num_rows > 0, "Expect query to return data." + assert table['room'], f"Expect ${table} to have room column." print(table.to_pandas().to_markdown()) ``` diff --git a/content/influxdb/cloud-dedicated/get-started/setup.md b/content/influxdb/cloud-dedicated/get-started/setup.md index 3b4f137b2..dc9ecc8dd 100644 --- a/content/influxdb/cloud-dedicated/get-started/setup.md +++ b/content/influxdb/cloud-dedicated/get-started/setup.md @@ -144,38 +144,24 @@ Provide the following: - `--write-database` Grants write access to a database - Token description - - - {{% code-placeholders "get-started" %}} -```sh +```bash influxctl token create \ --read-database get-started \ --write-database get-started \ - "Read/write token for get-started database" + "Read/write token for get-started database" > /app/iot-starter/secret.txt ``` {{% /code-placeholders %}} - The command returns the token ID and the token string. @@ -240,6 +226,8 @@ $env:INFLUX_TOKEN = "DATABASE_TOKEN" {{% code-placeholders "DATABASE_TOKEN" %}} + + ```sh set INFLUX_TOKEN=DATABASE_TOKEN # Make sure to include a space character at the end of this command. diff --git a/content/influxdb/cloud-dedicated/get-started/write.md b/content/influxdb/cloud-dedicated/get-started/write.md index 636169281..3e94cf27e 100644 --- a/content/influxdb/cloud-dedicated/get-started/write.md +++ b/content/influxdb/cloud-dedicated/get-started/write.md @@ -206,12 +206,12 @@ to write the [home sensor sample data](#home-sensor-data-line-protocol) to your {{% influxdb/custom-timestamps %}} {{% code-placeholders "get-started" %}} -```sh +```bash influxctl write \ --database get-started \ --token $INFLUX_TOKEN \ --precision s \ - 'home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 +'home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 @@ -263,7 +263,7 @@ Use [Telegraf](/telegraf/v1/) to consume line protocol, and then write it to 2. Copy and save the [home sensor data sample](#home-sensor-data-line-protocol) to a file on your local system--for example, `home.lp`. - ```sh + ```bash cat <<- EOF > home.lp home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 @@ -298,7 +298,7 @@ Use [Telegraf](/telegraf/v1/) to consume line protocol, and then write it to (`./telegraf.conf`) that enables the `inputs.file` and `outputs.influxdb_v2` plugins: - ```sh + ```bash telegraf --sample-config \ --input-filter file \ --output-filter influxdb_v2 \ @@ -353,7 +353,7 @@ Use [Telegraf](/telegraf/v1/) to consume line protocol, and then write it to echo '' >> telegraf.conf echo ' organization = ""' >> telegraf.conf echo '' >> telegraf.conf - echo ' bucket = "get-started"' >> telegraf.conf + echo ' bucket = "${INFLUX_DATABASE}"' >> telegraf.conf ``` --> @@ -373,10 +373,18 @@ Use [Telegraf](/telegraf/v1/) to consume line protocol, and then write it to Enter the following command in your terminal: - ```sh + + + ```bash telegraf --once --config ./telegraf.conf ``` + + If the write is successful, the output is similar to the following: ```plaintext @@ -446,12 +454,13 @@ to InfluxDB: {{% code-placeholders "DATABASE_TOKEN" %}} -```sh -response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ +```bash +response=$(curl --silent \ "https://{{< influxdb/host >}}/write?db=get-started&precision=s" \ --header "Authorization: Bearer DATABASE_TOKEN" \ --header "Content-type: text/plain; charset=utf-8" \ --header "Accept: application/json" \ + --write-out "\n%{response_code}" \ --data-binary " home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 @@ -481,16 +490,15 @@ home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200 home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200 ") -# Format the response code and error message output. -response_code=${response%%:-*} -errormsg=${response#*:-} +# Extract the response body (all but the last line) +response_body=$(echo "$response" | head -n -1) -# Remove leading and trailing whitespace from errormsg -errormsg=$(echo "${errormsg}" | tr -d '[:space:]') +# Extract the HTTP status code (the last line) +response_code=$(echo "$response" | tail -n 1) echo "$response_code" -if [[ $errormsg ]]; then - echo "$errormsg" +if [[ $response_body ]]; then + echo "$response_body" fi ``` @@ -558,7 +566,7 @@ to InfluxDB: {{% code-placeholders "DATABASE_TOKEN"%}} -```sh +```bash response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \ "https://{{< influxdb/host >}}/api/v2/write?bucket=get-started&precision=s" \ --header "Authorization: Bearer DATABASE_TOKEN" \ @@ -801,7 +809,7 @@ To write data to {{% product-name %}} using Go, use the InfluxDB v3 2. Initialize a new Go module in the directory. - + ```bash go mod init influxdb_go_client @@ -810,7 +818,7 @@ To write data to {{% product-name %}} using Go, use the InfluxDB v3 3. In your terminal or editor, create a new file for your code--for example: `write.go`. - + ```bash touch write.go @@ -955,7 +963,7 @@ To write data to {{% product-name %}} using Go, use the InfluxDB v3 - ```sh + ```bash go mod tidy && go run influxdb_go_client ``` @@ -979,15 +987,13 @@ the failure message. `influxdb_js_client` directory for your project: ```bash - mkdir influxdb_js_client && cd influxdb_js_client + mkdir -p influxdb_js_client && cd influxdb_js_client ``` 3. Inside of `influxdb_js_client`, enter the following command to initialize a package. This example configures the package to use [ECMAScript modules (ESM)](https://nodejs.org/api/packages.html#modules-loaders). - - ```bash npm init -y; npm pkg set type="module" ``` @@ -995,8 +1001,6 @@ the failure message. 4. Install the `@influxdata/influxdb3-client` JavaScript client library as a dependency to your project. - - ```bash npm install --save @influxdata/influxdb3-client ``` @@ -1004,7 +1008,6 @@ the failure message. 5. In your terminal or editor, create a `write.js` file. - ```bash touch write.js ``` @@ -1148,9 +1151,9 @@ the failure message. 9. In your terminal, execute `index.js` to write to {{% product-name %}}: - + - ```sh + ```bash node index.js ``` @@ -1176,7 +1179,7 @@ the failure message. - ```sh + ```bash dotnet new console --name influxdb_csharp_client ``` @@ -1184,7 +1187,7 @@ the failure message. - ```sh + ```bash cd influxdb_csharp_client ``` @@ -1193,7 +1196,7 @@ the failure message. - ```sh + ```bash dotnet add package InfluxDB3.Client ``` @@ -1339,7 +1342,7 @@ the failure message. - ```sh + ```bash dotnet run ``` @@ -1362,6 +1365,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ [Maven](https://maven.apache.org/download.cgi) for your system. 2. In your terminal or editor, use Maven to generate a project--for example: + ```bash mvn org.apache.maven.plugins:maven-archetype-plugin:3.1.2:generate \ -DarchetypeArtifactId="maven-archetype-quickstart" \ @@ -1403,7 +1407,6 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ enter the following in your terminal: - ```bash mvn validate ``` @@ -1564,7 +1567,6 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ the project code--for example: - ```bash mvn compile ``` @@ -1573,8 +1575,7 @@ _The tutorial assumes using Maven version 3.9 and Java version >= 15._ example, using Maven: - - ```sh + ```bash mvn exec:java -Dexec.mainClass="com.influxdbv3.App" ``` diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md b/content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md index 2d14246e3..7434d2b8d 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md +++ b/content/influxdb/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md @@ -36,6 +36,7 @@ list_code_example: | FlightInfo flightInfo = sqlClient.execute(query, auth); } } + ``` --- [Apache Arrow Flight SQL for Java](https://arrow.apache.org/docs/java/reference/org/apache/arrow/flight/sql/package-summary.html) integrates with Java applications to query and retrieve data from Flight database servers using RPC and SQL. @@ -483,6 +484,8 @@ Follow these steps to build and run the application using Docker: - **`HOST`**: your {{% product-name %}} hostname (URL without the "https://") - **`TOKEN`**: your [{{% product-name %}} database token](/influxdb/cloud-dedicated/get-started/setup/) with _read_ permission to the database + + ```sh docker build \ --build-arg DATABASE_NAME=INFLUX_DATABASE \ @@ -495,6 +498,8 @@ Follow these steps to build and run the application using Docker: 4. To run the application in a new Docker container, enter the following command: + + ```sh docker run javaflight ``` diff --git a/content/influxdb/cloud/write-data/no-code/third-party.md b/content/influxdb/cloud/write-data/no-code/third-party.md index faae29d8a..8ce11364d 100644 --- a/content/influxdb/cloud/write-data/no-code/third-party.md +++ b/content/influxdb/cloud/write-data/no-code/third-party.md @@ -9,68 +9,145 @@ menu: parent: No-code solutions --- +Write data to InfluxDB by configuring third-party technologies that don't require coding. -A number of third-party technologies can be configured to send line protocol directly to InfluxDB. +## Prerequisites -If you're using any of the following technologies, check out the handy links below to configure these technologies to write data to InfluxDB (**no additional software to download or install**): +- Authentication credentials for your InfluxDB instance: your InfluxDB host URL, + [organization](/influxdb/cloud/admin/organizations/), + [bucket](/influxdb/cloud/admin/buckets/), and an [API token](/influxdb/cloud/admin/tokens/) + with write permission on the bucket. -- (Write metrics and log events only) [Configure Vector 0.9 or later](#configure-vector) -- [Configure Apache NiFi 1.8 or later](#configure-apache-nifi) -- [Configure OpenHAB 3.0 or later](#configure-openhab) -- [Configure Apache JMeter 5.2 or later](#configure-apache-jmeter) -- [Configure FluentD 1.x or later](#configure-fluentd) + To setup InfluxDB and create credentials, follow the + [Get started](/influxdb/cloud/get-started/) guide. -#### Configure Vector +- Access to one of the third-party tools listed in this guide. -1. View the **Vector documentation**: - - For write metrics, [InfluxDB Metrics Sink](https://vector.dev/docs/reference/sinks/influxdb_metrics/) - - For log events, [InfluxDB Logs Sink](https://vector.dev/docs/reference/sinks/influxdb_logs/) -2. Under **Configuration**, click **v2** to view configuration settings. -3. Scroll down to **How It Works** for more detail: - - [InfluxDB Metrics Sink – How It Works ](https://vector.dev/docs/reference/sinks/influxdb_metrics/#how-it-works) - - [InfluxDB Logs Sink – How It Works](https://vector.dev/docs/reference/sinks/influxdb_logs/#how-it-works) +You can configure the following third-party tools to send line protocol data +directly to InfluxDB without writing code: -#### Configure Apache NiFi +{{% note %}} +Many third-party integrations are community contributions. +If there's an integration missing from the list below, please [open a docs issue](https://github.com/influxdata/docs-v2/issues/new/choose) to let us know. +{{% /note %}} -See the _[InfluxDB Processors for Apache NiFi Readme](https://github.com/influxdata/nifi-influxdb-bundle#influxdb-processors-for-apache-nifi)_ for details. +- [Vector 0.9 or later](#configure-vector) -#### Configure OpenHAB +- [Apache NiFi 1.8 or later](#configure-apache-nifi) -See the _[InfluxDB Persistence Readme](https://github.com/openhab/openhab-addons/tree/master/bundles/org.openhab.persistence.influxdb)_ for details. +- [OpenHAB 3.0 or later](#configure-openhab) -#### Configure Apache JMeter +- [Apache JMeter 5.2 or later](#configure-apache-jmeter) - +- [Apache Pulsar](#configure-apache-pulsar) -To configure Apache JMeter, complete the following steps in InfluxDB and JMeter. +- [FluentD 1.x or later](#configure-fluentd) -##### In InfluxDB -1. [Find the name of your organization](/influxdb/cloud/admin/organizations/view-orgs/) (needed to create a bucket and token). -2. [Create a bucket using the influx CLI](/influxdb/cloud/admin/buckets/create-bucket/#create-a-bucket-using-the-influx-cli) and name it `jmeter`. -3. [Create a token](/influxdb/cloud/admin/tokens/create-token/). +## Configure Vector -##### In JMeter +> Vector is a lightweight and ultra-fast tool for building observability pipelines. +> +> {{% cite %}}-- [Vector documentation](https://vector.dev/docs/){{% /cite %}} + +Configure Vector to write metrics and log events to an InfluxDB instance. + +1. Configure your [InfluxDB authentication credentials](#prerequisites) for Vector to write to your bucket. + - View example configurations: + - [InfluxDB metrics sink configuration](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#configuration) + - [InfluxDB logs sink configuration](https://vector.dev/docs/reference/configuration/sinks/influxdb_logs/#example-configurations) + - Use the following Vector configuration fields for InfluxDB v2 credentials: + - [`endpoint`](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#endpoint): + the URL (including scheme, host, and port) for your InfluxDB instance + - [`org`](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#org): + the name of your InfluxDB organization + - [`bucket`](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#bucket): + the name of the bucket to write data to + - [`token`](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#token): + an API token with write permission on the specified bucket + +3. Configure the data that you want Vector to write to InfluxDB. + - View [examples of metrics events and configurations](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#examples). + - View [Telemetry log metrics](https://vector.dev/docs/reference/configuration/sinks/influxdb_logs/#telemetry). + +4. For more detail, see the **How it works** sections: + - [InfluxDB metrics sink–-How it works](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#how-it-works) + - [InfluxDB logs sink–-How it works](https://vector.dev/docs/reference/configuration/sinks/influxdb_logs/#how-it-works) + +## Configure Apache NiFi + +> [Apache NiFi](https://nifi.apache.org/documentation/v1/) is a software project from the Apache Software Foundation designed to automate the flow of data between software systems. +> +> {{% cite %}}-- [Wikipedia](https://en.wikipedia.org/wiki/Apache_NiFi){{% /cite %}} + +The InfluxDB processors for Apache NiFi lets you write NiFi Record structured +data into InfluxDB v2. + +See +_[InfluxDB Processors for Apache NiFi](https://github.com/influxdata/nifi-influxdb-bundle#influxdb-processors-for-apache-nifi)_ +on GitHub for details. + +## Configure OpenHAB + +> The open Home Automation Bus (openHAB, pronounced ˈəʊpənˈhæb) is an open source, technology agnostic home automation platform +> +> {{% cite %}}-- [openHAB documentation](https://www.openhab.org/docs/){{% /cite %}} + +> [The InfluxDB Persistence add-on] service allows you to persist and query states using the [InfluxDB] time series database. +> +> {{% cite %}}-- [openHAB InfluxDB persistence add-on](https://github.com/openhab/openhab-addons/tree/main/bundles/org.openhab.persistence.influxdb){{% /cite %}} + +See +_[InfluxDB Persistence add-on](https://github.com/openhab/openhab-addons/tree/master/bundles/org.openhab.persistence.influxdb)_ +on GitHub for details. + +## Configure Apache JMeter + +> [Apache JMeter](https://jmeter.apache.org/) is an Apache project that can be used as a load testing tool for +> analyzing and measuring the performance of a variety of services, with a focus +> on web applications. +> +> {{% cite %}}-- [Wikipedia](https://en.wikipedia.org/wiki/Apache_JMeter){{% /cite %}} 1. Create a [Backend Listener](https://jmeter.apache.org/usermanual/component_reference.html#Backend_Listener) using the _**InfluxDBBackendListenerClient**_ implementation. 2. In the **Backend Listener implementation** field, enter: - ``` + ```text org.apache.jmeter.visualizers.backend.influxdb.influxdbBackendListenerClient ``` 3. Under **Parameters**, specify the following: - **influxdbMetricsSender**: - ``` + ```text org.apache.jmeter.visualizers.backend.influxdb.HttpMetricsSender ``` - **influxdbUrl**: _(include the bucket and org you created in InfluxDB)_ - ``` + ```text https://cloud2.influxdata.com/api/v2/write?org=my-org&bucket=jmeter ``` - **application**: `InfluxDB2` - - **influxdbToken**: _your InfluxDB API token_ + - **influxdbToken**: _your InfluxDB API token with write permission on the + specified bucket_ - Include additional parameters as needed. -4. Click **Add** to add the _**InfluxDBBackendListenerClient**_ implementation. +1. Click **Add** to add the _**InfluxDBBackendListenerClient**_ implementation. -#### Configure FluentD +## Configure Apache Pulsar -See the _[influxdb-plugin-fluent Readme](https://github.com/influxdata/influxdb-plugin-fluent)_ for details. +> Apache Pulsar is an open source, distributed messaging and streaming platform +> built for the cloud. +> +> The InfluxDB sink connector pulls messages from Pulsar topics and persists the +messages to InfluxDB. +> +> {{% cite %}}-- [Apache Pulsar](https://pulsar.apache.org/){{% /cite %}} + +See _[InfluxDB sink connector](https://pulsar.apache.org/docs/en/io-influxdb-sink/)_ +for details. + +## Configure FluentD + +> [Fluentd](https://www.fluentd.org/) is a cross-platform open-source data +> collection software project. +> +> {{% cite %}}-- [Wikipedia](https://en.wikipedia.org/wiki/Fluentd){{% /cite %}} + +See _[influxdb-plugin-fluent](https://github.com/influxdata/influxdb-plugin-fluent)_ +on GitHub for details. diff --git a/content/influxdb/clustered/process-data/visualize/grafana.md b/content/influxdb/clustered/process-data/visualize/grafana.md index e7d9380f2..ffa12258a 100644 --- a/content/influxdb/clustered/process-data/visualize/grafana.md +++ b/content/influxdb/clustered/process-data/visualize/grafana.md @@ -30,16 +30,12 @@ Use [Grafana](https://grafana.com/) to query and visualize data stored in > > {{% cite %}}-- [Grafana documentation](https://grafana.com/docs/grafana/latest/introduction/){{% /cite %}} - - - [Install Grafana or login to Grafana Cloud](#install-grafana-or-login-to-grafana-cloud) - [InfluxDB data source](#influxdb-data-source) - [Create an InfluxDB data source](#create-an-influxdb-data-source) - [Query InfluxDB with Grafana](#query-influxdb-with-grafana) - [Build visualizations with Grafana](#build-visualizations-with-grafana) - - ## Install Grafana or login to Grafana Cloud If using the open source version of **Grafana**, follow the diff --git a/content/influxdb/v2/write-data/developer-tools/scrape-prometheus-metrics.md b/content/influxdb/v2/write-data/developer-tools/scrape-prometheus-metrics.md index caf1d816a..94aa94a29 100644 --- a/content/influxdb/v2/write-data/developer-tools/scrape-prometheus-metrics.md +++ b/content/influxdb/v2/write-data/developer-tools/scrape-prometheus-metrics.md @@ -48,7 +48,7 @@ endpoint and write them to InfluxDB{{% cloud-only %}} Cloud{{% /cloud-only %}}, [metric parsing version](/influxdb/v2/reference/prometheus-metrics/) to use _(version `2` is recommended)_. 2. Add the [InfluxDB v2 output plugin](/telegraf/v1/plugins/#output-influxdb_v2) - to your Telegraf configuration file and configure it to to write to + to your Telegraf configuration file and configure it to write to InfluxDB{{% cloud-only %}} Cloud{{% /cloud-only %}}. ##### Example telegraf.conf diff --git a/content/influxdb/v2/write-data/no-code/third-party.md b/content/influxdb/v2/write-data/no-code/third-party.md index b2562d192..a409db4ea 100644 --- a/content/influxdb/v2/write-data/no-code/third-party.md +++ b/content/influxdb/v2/write-data/no-code/third-party.md @@ -9,17 +9,29 @@ menu: parent: No-code solutions --- +Write data to InfluxDB by configuring third-party technologies that don't require coding. -A number of third-party technologies can be configured to send line protocol directly to InfluxDB. +## Prerequisites +- Authentication credentials for your InfluxDB instance: your InfluxDB host URL, + [organization](/influxdb/v2/admin/organizations/), + [bucket](/influxdb/v2/admin/buckets/), and an [API token](/influxdb/v2/admin/tokens/) + with write permission on the bucket. -If you're using any of the following technologies, check out the handy links below to configure these technologies to write data to InfluxDB (**no additional software to download or install**). + To setup InfluxDB and create credentials, follow the + [Get started](/influxdb/v2/get-started/) guide. + +- Access to one of the third-party tools listed in this guide. + +You can configure the following third-party tools to send line protocol data +directly to InfluxDB without writing code: {{% note %}} -Many third-party integrations are community contributions. If there's an integration missing from the list below, please [open a docs issue](https://github.com/influxdata/docs-v2/issues/new/choose) to let us know. +Many third-party integrations are community contributions. +If there's an integration missing from the list below, please [open a docs issue](https://github.com/influxdata/docs-v2/issues/new/choose) to let us know. {{% /note %}} -- (Write metrics and log events only) [Vector 0.9 or later](#configure-vector) +- [Vector 0.9 or later](#configure-vector) - [Apache NiFi 1.8 or later](#configure-apache-nifi) @@ -32,61 +44,110 @@ Many third-party integrations are community contributions. If there's an integra - [FluentD 1.x or later](#configure-fluentd) -#### Configure Vector +## Configure Vector -1. View the **Vector documentation**: - - For write metrics, [InfluxDB Metrics Sink](https://vector.dev/docs/reference/sinks/influxdb_metrics/) - - For log events, [InfluxDB Logs Sink](https://vector.dev/docs/reference/sinks/influxdb_logs/) -2. Under **Configuration**, click **v2** to view configuration settings. -3. Scroll down to **How It Works** for more detail: - - [InfluxDB Metrics Sink – How It Works ](https://vector.dev/docs/reference/sinks/influxdb_metrics/#how-it-works) - - [InfluxDB Logs Sink – How It Works](https://vector.dev/docs/reference/sinks/influxdb_logs/#how-it-works) +> Vector is a lightweight and ultra-fast tool for building observability pipelines. +> +> {{% cite %}}-- [Vector documentation](https://vector.dev/docs/){{% /cite %}} -#### Configure Apache NiFi +Configure Vector to write metrics and log events to an InfluxDB instance. -See the _[InfluxDB Processors for Apache NiFi Readme](https://github.com/influxdata/nifi-influxdb-bundle#influxdb-processors-for-apache-nifi)_ for details. +1. Configure your [InfluxDB authentication credentials](#prerequisites) for Vector to write to your bucket. + - View example configurations: + - [InfluxDB metrics sink configuration](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#configuration) + - [InfluxDB logs sink configuration](https://vector.dev/docs/reference/configuration/sinks/influxdb_logs/#example-configurations) + - Use the following Vector configuration fields for InfluxDB v2 credentials: + - [`endpoint`](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#endpoint): + the URL (including scheme, host, and port) for your InfluxDB instance + - [`org`](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#org): + the name of your InfluxDB organization + - [`bucket`](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#bucket): + the name of the bucket to write data to + - [`token`](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#token): + an API token with write permission on the specified bucket -#### Configure OpenHAB +3. Configure the data that you want Vector to write to InfluxDB. + - View [examples of metrics events and configurations](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#examples). + - View [Telemetry log metrics](https://vector.dev/docs/reference/configuration/sinks/influxdb_logs/#telemetry). -See the _[InfluxDB Persistence Readme](https://github.com/openhab/openhab-addons/tree/master/bundles/org.openhab.persistence.influxdb)_ for details. +4. For more detail, see the **How it works** sections: + - [InfluxDB metrics sink–-How it works](https://vector.dev/docs/reference/configuration/sinks/influxdb_metrics/#how-it-works) + - [InfluxDB logs sink–-How it works](https://vector.dev/docs/reference/configuration/sinks/influxdb_logs/#how-it-works) -#### Configure Apache JMeter +## Configure Apache NiFi - +> [Apache NiFi](https://nifi.apache.org/documentation/v1/) is a software project from the Apache Software Foundation designed to automate the flow of data between software systems. +> +> {{% cite %}}-- [Wikipedia](https://en.wikipedia.org/wiki/Apache_NiFi){{% /cite %}} -To configure Apache JMeter, complete the following steps in InfluxDB and JMeter. +The InfluxDB processors for Apache NiFi lets you write NiFi Record structured +data into InfluxDB v2. -##### In InfluxDB +See +_[InfluxDB Processors for Apache NiFi](https://github.com/influxdata/nifi-influxdb-bundle#influxdb-processors-for-apache-nifi)_ +on GitHub for details. -1. [Find the name of your organization](/influxdb/v2/admin/organizations/view-orgs/) (needed to create a bucket and token). -2. [Create a bucket using the influx CLI](/influxdb/v2/admin/buckets/create-bucket/#create-a-bucket-using-the-influx-cli) and name it `jmeter`. -3. [Create a token](/influxdb/v2/admin/tokens/create-token/). +## Configure OpenHAB -##### In JMeter +> The open Home Automation Bus (openHAB, pronounced ˈəʊpənˈhæb) is an open source, technology agnostic home automation platform +> +> {{% cite %}}-- [openHAB documentation](https://www.openhab.org/docs/){{% /cite %}} + +> [The InfluxDB Persistence add-on] service allows you to persist and query states using the [InfluxDB] time series database. +> +> {{% cite %}}-- [openHAB InfluxDB persistence add-on](https://github.com/openhab/openhab-addons/tree/main/bundles/org.openhab.persistence.influxdb){{% /cite %}} + +See +_[InfluxDB Persistence add-on](https://github.com/openhab/openhab-addons/tree/master/bundles/org.openhab.persistence.influxdb)_ +on GitHub for details. + +## Configure Apache JMeter + +> [Apache JMeter](https://jmeter.apache.org/) is an Apache project that can be used as a load testing tool for +> analyzing and measuring the performance of a variety of services, with a focus +> on web applications. +> +> {{% cite %}}-- [Wikipedia](https://en.wikipedia.org/wiki/Apache_JMeter){{% /cite %}} 1. Create a [Backend Listener](https://jmeter.apache.org/usermanual/component_reference.html#Backend_Listener) using the _**InfluxDBBackendListenerClient**_ implementation. 2. In the **Backend Listener implementation** field, enter: - ``` + ```text org.apache.jmeter.visualizers.backend.influxdb.influxdbBackendListenerClient ``` 3. Under **Parameters**, specify the following: - **influxdbMetricsSender**: - ``` + ```text org.apache.jmeter.visualizers.backend.influxdb.HttpMetricsSender ``` - **influxdbUrl**: _(include the bucket and org you created in InfluxDB)_ - ``` + ```text http://localhost:8086/api/v2/write?org=my-org&bucket=jmeter ``` - **application**: `InfluxDB2` - - **influxdbToken**: _your InfluxDB API token_ + - **influxdbToken**: _your InfluxDB API token with write permission on the + specified bucket_ - Include additional parameters as needed. -4. Click **Add** to add the _**InfluxDBBackendListenerClient**_ implementation. +1. Click **Add** to add the _**InfluxDBBackendListenerClient**_ implementation. -#### Configure Apache Pulsar +## Configure Apache Pulsar -See _[InfluxDB sink connector](https://pulsar.apache.org/docs/en/io-influxdb-sink/)_ for details. +> Apache Pulsar is an open source, distributed messaging and streaming platform +> built for the cloud. +> +> The InfluxDB sink connector pulls messages from Pulsar topics and persists the +messages to InfluxDB. +> +> {{% cite %}}-- [Apache Pulsar](https://pulsar.apache.org/){{% /cite %}} -#### Configure FluentD +See _[InfluxDB sink connector](https://pulsar.apache.org/docs/en/io-influxdb-sink/)_ +for details. -See the _[influxdb-plugin-fluent Readme](https://github.com/influxdata/influxdb-plugin-fluent)_ for details. +## Configure FluentD + +> [Fluentd](https://www.fluentd.org/) is a cross-platform open-source data +> collection software project. +> +> {{% cite %}}-- [Wikipedia](https://en.wikipedia.org/wiki/Fluentd){{% /cite %}} + +See _[influxdb-plugin-fluent](https://github.com/influxdata/influxdb-plugin-fluent)_ +on GitHub for details. From c8173aa2139715e0a2a034df26d72f02f0ed1f3d Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:36:02 +0100 Subject: [PATCH 38/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Scott Anderson --- .../cloud-serverless/reference/client-libraries/v3/java.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 8aa4563cb..02ddb201d 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -25,6 +25,7 @@ The documentation for this client library is available on GitHub. ## Installation ### Maven + ```xml com.influxdb From 9116463032a4ce2c134c6a2844e1a1fba89338e8 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:38:10 +0100 Subject: [PATCH 39/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Jason Stirnaman --- .../cloud-serverless/reference/client-libraries/v3/java.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 02ddb201d..97232009b 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -35,6 +35,9 @@ The documentation for this client library is available on GitHub. ``` ### Gradle + +To use Gradle to install the client library in your project, add the following to your `build.gradle` dependencies: + ```groovy implementation group: 'com.influxdb', name: 'influxdb3-java', version: 'latest.release' ``` From 727b298f469d8986af7c65a268c4266cf0a58766 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:39:19 +0100 Subject: [PATCH 40/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Jason Stirnaman --- .../cloud-serverless/reference/client-libraries/v3/java.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 97232009b..70ac90530 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -42,7 +42,9 @@ To use Gradle to install the client library in your project, add the following t implementation group: 'com.influxdb', name: 'influxdb3-java', version: 'latest.release' ``` -## Sample Code +## Example: write and query data + +The following example shows how to use `influxdb3-java` to write and query data stored in {{% product-name %}}: ```java public class HelloInfluxDB { From ee5c39f069b937622cfa90fa89bc76483ae882d4 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:40:07 +0100 Subject: [PATCH 41/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Scott Anderson --- .../cloud-serverless/reference/client-libraries/v3/java.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 70ac90530..1617ee5c1 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -48,7 +48,7 @@ The following example shows how to use `influxdb3-java` to write and query data ```java public class HelloInfluxDB { - private static final String HOST_URL = "https://eu-central-1-1.aws.cloud2.influxdata.com"; // URL information is present in the cloud portal + private static final String HOST_URL = "https://{{< influxdb/host >}}"; private static final String DATABASE = "java"; // Database name is the bucket name present in the cloud portal private static final char[] API_TOKEN = "API_TOKEN".toCharArray(); // Avoid hard-coding API_TOKEN in production. It is present in the cloud portal. From 9ae63dc6f356a87185183a5638942a050a9ea63e Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:40:32 +0100 Subject: [PATCH 42/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Jason Stirnaman --- .../cloud-serverless/reference/client-libraries/v3/java.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 1617ee5c1..e4290fdad 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -49,7 +49,7 @@ The following example shows how to use `influxdb3-java` to write and query data ```java public class HelloInfluxDB { private static final String HOST_URL = "https://{{< influxdb/host >}}"; - private static final String DATABASE = "java"; // Database name is the bucket name present in the cloud portal + private static final String DATABASE = "java"; // your bucket in InfluxDB Cloud Serverless private static final char[] API_TOKEN = "API_TOKEN".toCharArray(); // Avoid hard-coding API_TOKEN in production. It is present in the cloud portal. // Authenticate, Write and Query data from the serverless InfluxDB From f1a3d213b8901d2e9b0ce40a0c6ef3952d60bba1 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:42:09 +0100 Subject: [PATCH 43/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Jason Stirnaman --- .../cloud-serverless/reference/client-libraries/v3/java.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index e4290fdad..e78ced299 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -52,7 +52,7 @@ public class HelloInfluxDB { private static final String DATABASE = "java"; // your bucket in InfluxDB Cloud Serverless private static final char[] API_TOKEN = "API_TOKEN".toCharArray(); // Avoid hard-coding API_TOKEN in production. It is present in the cloud portal. - // Authenticate, Write and Query data from the serverless InfluxDB + // Create a client instance, and then write and query data in InfluxDB Cloud Serverless. public static void main(String[] args) { try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, API_TOKEN, DATABASE)) { writeData(client); From 2cf6f2c80bd0681755922b5f7626d2a2a30ebcc8 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:42:59 +0100 Subject: [PATCH 44/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Jason Stirnaman --- .../cloud-serverless/reference/client-libraries/v3/java.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index e78ced299..fedc76132 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -64,7 +64,8 @@ public class HelloInfluxDB { } } - // Write sample measurement using Point class API + // Use the Point class to construct time series data. + // Call client.writePoint to write the point as line protocol to your bucket. private static void writeData(InfluxDBClient client) { Point point = Point.measurement("temperature") .setTag("location", "London") From 0c3162fd8f5ce059420bac73ca7e31e84974b584 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:44:03 +0100 Subject: [PATCH 45/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Jason Stirnaman --- .../cloud-serverless/reference/client-libraries/v3/java.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index fedc76132..ec69bc76c 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -98,7 +98,7 @@ public class HelloInfluxDB { } } ``` -## Running the program +## Run the program to write and query data Build the project and then run the executable .jar file with this [JVM Flag](https://arrow.apache.org/docs/java/install.html).

From 92a84700f2d86c4bd871e39b7fc38fb46282d9fe Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:45:39 +0100 Subject: [PATCH 46/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Jason Stirnaman --- .../cloud-serverless/reference/client-libraries/v3/java.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index ec69bc76c..c0f24325b 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -104,5 +104,5 @@ Build the project and then run the executable .jar file with this [JVM Flag](htt

**Example:** ```sh - java --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar target/{your-jar-file}.jar + java --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar target/PROJECT_NAME.jar ``` From 73aff38235cc8af68a2d44d1829469353f0796b7 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:45:50 +0100 Subject: [PATCH 47/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Jason Stirnaman --- .../cloud-serverless/reference/client-libraries/v3/java.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index c0f24325b..7ca8dad01 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -102,7 +102,6 @@ public class HelloInfluxDB { Build the project and then run the executable .jar file with this [JVM Flag](https://arrow.apache.org/docs/java/install.html).

-**Example:** ```sh java --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar target/PROJECT_NAME.jar ``` From 0f49abc04f3d6e743f03003c3c0f3876bc6cf3be Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:49:15 +0100 Subject: [PATCH 48/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Jason Stirnaman --- .../cloud-serverless/reference/client-libraries/v3/java.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 7ca8dad01..a606c7085 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -24,7 +24,10 @@ The documentation for this client library is available on GitHub. ## Installation -### Maven +### Install using Maven + +To use Maven to install the client library in your project, add the following to your `pom.xml`: + ```xml From 996064e9085e5ff3cff498d26ea8115c3f082c16 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 11:53:11 +0100 Subject: [PATCH 49/96] Update content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md Co-authored-by: Jason Stirnaman --- .../cloud-serverless/reference/client-libraries/v3/java.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index a606c7085..f9eebaea4 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -104,7 +104,6 @@ public class HelloInfluxDB { ## Run the program to write and query data Build the project and then run the executable .jar file with this [JVM Flag](https://arrow.apache.org/docs/java/install.html). -

```sh java --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar target/PROJECT_NAME.jar ``` From eb440e16f2666d49540c35b33728f426225a94d5 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 12:17:26 +0100 Subject: [PATCH 50/96] Update java.md Incorporated feedback and improved the instructions --- .../reference/client-libraries/v3/java.md | 23 +++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index f9eebaea4..53fd9ebdf 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -22,9 +22,11 @@ The documentation for this client library is available on GitHub. InfluxDB v3 Java client library -## Installation +## Setup & Installation -### Install using Maven +Create a command line java application using Maven or Gradle. + +### Maven To use Maven to install the client library in your project, add the following to your `pom.xml`: @@ -49,12 +51,15 @@ implementation group: 'com.influxdb', name: 'influxdb3-java', version: 'latest.r The following example shows how to use `influxdb3-java` to write and query data stored in {{% product-name %}}: +### Initialize the application + +Create a `HelloInfluxDB.java` class with the following information: + ```java public class HelloInfluxDB { private static final String HOST_URL = "https://{{< influxdb/host >}}"; private static final String DATABASE = "java"; // your bucket in InfluxDB Cloud Serverless - private static final char[] API_TOKEN = "API_TOKEN".toCharArray(); // Avoid hard-coding API_TOKEN in production. It is present in the cloud portal. - + private static final char[] API_TOKEN = System.getenv("API_TOKEN"); // your API Token found in InfluxDB Cloud Serverless stored locally // Create a client instance, and then write and query data in InfluxDB Cloud Serverless. public static void main(String[] args) { try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, API_TOKEN, DATABASE)) { @@ -66,7 +71,11 @@ public class HelloInfluxDB { e.printStackTrace(); } } +``` +### Write the data + +```java // Use the Point class to construct time series data. // Call client.writePoint to write the point as line protocol to your bucket. private static void writeData(InfluxDBClient client) { @@ -83,7 +92,11 @@ public class HelloInfluxDB { e.printStackTrace(); } } +``` +### Query the data + +```java // Query the latest 10 measurements using SQL private static void queryData(InfluxDBClient client) { System.out.printf("--------------------------------------------------------%n"); @@ -101,9 +114,11 @@ public class HelloInfluxDB { } } ``` + ## Run the program to write and query data Build the project and then run the executable .jar file with this [JVM Flag](https://arrow.apache.org/docs/java/install.html). ```sh java --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar target/PROJECT_NAME.jar ``` +You should be able to also confirm the newly written data in your InfluxDB Cloud Serverless. From dacf28953176ddf427c034c0e745090b42195435 Mon Sep 17 00:00:00 2001 From: Suyash Joshi <395039+suyashcjoshi@users.noreply.github.com> Date: Wed, 24 Jul 2024 12:25:35 +0100 Subject: [PATCH 51/96] Update java.md Updated link to sample project on GitHub --- .../cloud-serverless/reference/client-libraries/v3/java.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 53fd9ebdf..3526a718e 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -49,7 +49,7 @@ implementation group: 'com.influxdb', name: 'influxdb3-java', version: 'latest.r ## Example: write and query data -The following example shows how to use `influxdb3-java` to write and query data stored in {{% product-name %}}: +The following example, also available on [GitHub](https://github.com/suyashcjoshi/SimpleJavaInfluxDB/tree/main) shows how to use `influxdb3-java` to write and query data stored in {{% product-name %}}: ### Initialize the application From 421f48416fe24c3a1a4c2fe4b81b372862500de5 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 24 Jul 2024 18:30:10 -0500 Subject: [PATCH 52/96] chore(v3): Add Java client library interface and API - Fix Python client library reference. - Removed `list_code_example` from both due to render problems. --- .../reference/client-libraries/v3/java.md | 263 +++++++++++++++--- .../reference/client-libraries/v3/python.md | 66 ++--- 2 files changed, 253 insertions(+), 76 deletions(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 3526a718e..0e1d18412 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -3,7 +3,6 @@ title: Java client library for InfluxDB v3 list_title: Java description: > The InfluxDB v3 `influxdb3-java` Java client library integrates with application code to write and query data stored in an InfluxDB Cloud Serverless bucket. -external_url: https://github.com/InfluxCommunity/influxdb3-java menu: influxdb_cloud_serverless: name: Java @@ -15,22 +14,144 @@ aliases: - /cloud-serverless/query-data/sql/execute-queries/java/ --- -The InfluxDB v3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates with Java application code -to write and query data stored in an {{% product-name %}} bucket. +The InfluxDB v3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates +with Java application code to write and query data stored in an {{% product-name %}} +bucket. -The documentation for this client library is available on GitHub. +InfluxDB client libraries provide configurable batch writing of data to {{% product-name %}}. +Client libraries can be used to construct line protocol data, transform data from other formats +to line protocol, and batch write line protocol data to InfluxDB HTTP APIs. -InfluxDB v3 Java client library +InfluxDB v3 client libraries can query {{% product-name %}} using SQL or InfluxQL. +The `influxdb3-java` Java client library wraps the Apache Arrow `org.apache.arrow.flight.FlightClient` +in a convenient InfluxDB v3 interface for executing SQL and InfluxQL queries, requesting +server metadata, and retrieving data from {{% product-name %}} using the Flight protocol with gRPC. -## Setup & Installation - -Create a command line java application using Maven or Gradle. - -### Maven - -To use Maven to install the client library in your project, add the following to your `pom.xml`: +- [Installation](#installation) + - [Using Maven](#using-maven) + - [Using Gradle](#using-gradle) +- [Importing the client](#importing-the-client) +- [API reference](#api-reference) +- [Classes](#classes) +- [Interface InfluxDBClient](#interface-influxdbclient) + - [Initialize with credential parameters](#initialize-with-credential-parameters) + - [InfluxDBClient instance methods](#influxdbclient-instance-methods) + - [InfluxDBClient.writePoint](#influxdbclientwritepoint) + - [InfluxDBClient.query](#influxdbclientquery) +#### Example: write and query data + +The following example shows how to use `influxdb3-java` to write and query data stored in {{% product-name %}}. + +```java +package com.influxdata.demo; + +import com.influxdb.v3.client.InfluxDBClient; +import com.influxdb.v3.client.Point; +import com.influxdb.v3.client.query.QueryOptions; +import com.influxdb.v3.client.query.QueryType; + +import java.time.Instant; +import java.util.stream.Stream; + +public class HelloInfluxDB { + private static final String HOST_URL = "https://{{< influxdb/host >}}"; // your Cloud Serverless region URL + private static final String DATABASE = "java"; // your Cloud Serverless bucket + private static final char[] API_TOKEN = System.getenv("API_TOKEN"); // your local environment variable that stores your API Token + + // Create a client instance that writes and queries data in your bucket. + public static void main(String[] args) { + // Instantiate the client with your InfluxDB credentials + try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, API_TOKEN, DATABASE)) { + writeData(client); + queryData(client); + } + catch (Exception e) { + System.err.println("An error occurred while connecting to InfluxDB Cloud Serverless!"); + e.printStackTrace(); + } + } + + // Use the Point class to construct time series data. + private static void writeData(InfluxDBClient client) { + Point point = Point.measurement("temperature") + .setTag("location", "London") + .setField("value", 30.01) + .setTimestamp(Instant.now().minusSeconds(10)); + try { + client.writePoint(point); + System.out.println("Data is written to the bucket."); + } + catch (Exception e) { + System.err.println("Failed to write data to the bucket."); + e.printStackTrace(); + } + } + + // Use SQL to query the most recent 10 measurements + private static void queryData(InfluxDBClient client) { + System.out.printf("--------------------------------------------------------%n"); + System.out.printf("| %-8s | %-8s | %-30s |%n", "location", "value", "time"); + System.out.printf("--------------------------------------------------------%n"); + + String sql = "select time,location,value from temperature order by time desc limit 10"; + try (Stream stream = client.query(sql)) { + stream.forEach(row -> System.out.printf("| %-8s | %-8s | %-30s |%n", row[1], row[2], row[0])); + } + catch (Exception e) { + System.err.println("Failed to query data from the bucket."); + e.printStackTrace(); + } + } +} +``` + +{{% cite %}}Source: [suyashcjoshi/SimpleJavaInfluxDB](https://github.com/suyashcjoshi/SimpleJavaInfluxDB/) on GitHub{{% /cite %}} + +Replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [bucket](/influxdb/cloud-serverless/admin/buckets/) +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a local environment variable that stores your [token](/influxdb/cloud-serverless/admin/tokens/)--the token must have read and write permission to the specified bucket. + +### Run the example to write and query data + +1. Build an executable JAR for the project--for example, using Maven: + + + + ```bash + mvn package + ``` + +2. In your terminal, run the `java` command to write and query data in your bucket: + + + + ```bash + java \ + --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED \ + -jar target/PROJECT_NAME.jar + ``` + + Include the following in your command: + + - [`--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED`](https://arrow.apache.org/docs/java/install.html#id3): with Java version 9 or later and Apache Arrow version 16 or later, exposes JDK internals for Arrow. + For more options, see the [Apache Arrow Java install documentation](https://arrow.apache.org/docs/java/install.html). + - `-jar target/PROJECT_NAME.jar`: your `.jar` file to run. + +The output is the newly written data from your {{< product-name >}} bucket. + +## Installation + +Include `com.influxdb.influxdb3-java` in your project dependencies. + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Maven pom.xml](#) +[Gradle dependency script](#) +{{% /code-tabs %}} +{{% code-tab-content %}} ```xml com.influxdb @@ -38,28 +159,84 @@ To use Maven to install the client library in your project, add the following to RELEASE ``` - -### Gradle - -To use Gradle to install the client library in your project, add the following to your `build.gradle` dependencies: - +{{% /code-tab-content %}} +{{% code-tab-content %}} + ```groovy -implementation group: 'com.influxdb', name: 'influxdb3-java', version: 'latest.release' +dependencies { + + implementation group: 'com.influxdb', name: 'influxdb3-java', version: 'latest.release' + +} ``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} -## Example: write and query data +## Importing the client -The following example, also available on [GitHub](https://github.com/suyashcjoshi/SimpleJavaInfluxDB/tree/main) shows how to use `influxdb3-java` to write and query data stored in {{% product-name %}}: +The `influxdb3-java` client library package provides +`com.influxdb.v3.client` classes for constructing, writing, and querying data +stored in {{< product-name >}}. -### Initialize the application +## API reference -Create a `HelloInfluxDB.java` class with the following information: +- [Interface InfluxDBClient](#interface-influxdbclient) + - [Initialize with credential parameters](#initialize-with-credential-parameters) + - [InfluxDBClient instance methods](#influxdbclient-instance-methods) + - [InfluxDBClient.writePoint](#influxdbclientwritepoint) + - [InfluxDBClient.query](#influxdbclientquery) + + +## Interface InfluxDBClient + +Provides an interface for interacting with InfluxDB APIs for writing and querying data. + +The `InfluxDBClient.getInstance` constructor initializes and returns a client instance with the following: + +- A _write client_ configured for writing to the database. +- An Arrow _Flight client_ configured for querying the database. + +To initialize a client, call `getInstance` and pass your credentials as one of +the following types: + +- [parameters](#initialize-with-credential-parameters) +- a [`ClientConfig`](https://github.com/InfluxCommunity/influxdb3-java/blob/main/src/main/java/com/influxdb/v3/client/config/ClientConfig.java) +- a database connection string--for example: + + ```java + "https://{{< influxdb/host >}}" + + "?token=API_TOKEN&database=DATABASE_NAME" + ``` + +### Initialize with credential parameters ```java +static InfluxDBClient getInstance(@Nonnull final String host, + @Nullable final char[] token, + @Nullable final String database) +``` + +- **`host`** (string): The host URL of the InfluxDB instance. +- **`database`** (string): The bucket to use for writing and querying. +- **`token`** (string): An API token with read/write permissions. + +#### Example: initialize with credential parameters + +```java +package com.influxdata.demo; + +import com.influxdb.v3.client.InfluxDBClient; +import com.influxdb.v3.client.Point; +import com.influxdb.v3.client.query.QueryOptions; +import com.influxdb.v3.client.query.QueryType; + +import java.time.Instant; +import java.util.stream.Stream; + public class HelloInfluxDB { private static final String HOST_URL = "https://{{< influxdb/host >}}"; - private static final String DATABASE = "java"; // your bucket in InfluxDB Cloud Serverless - private static final char[] API_TOKEN = System.getenv("API_TOKEN"); // your API Token found in InfluxDB Cloud Serverless stored locally + private static final String DATABASE = "DATABASE_NAME"; // your Cloud Serverless bucket + private static final char[] API_TOKEN = System.getenv("API_TOKEN"); // an environment variable for your Cloud Serverless API Token // Create a client instance, and then write and query data in InfluxDB Cloud Serverless. public static void main(String[] args) { try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, API_TOKEN, DATABASE)) { @@ -73,11 +250,30 @@ public class HelloInfluxDB { } ``` -### Write the data +#### Default tags + +- _Optional_: To include default + [tags](/influxdb/cloud-serverless/reference/glossary/#tag) in all written data, + pass a `Map` of tag keys and values. + + ```java + InfluxDBClient getInstance(@Nonnull final String host, + @Nullable final char[] token, + @Nullable final String database, + @Nullable Map defaultTags) + ``` + +### InfluxDBClient instance methods + +#### InfluxDBClient.writePoint + +1. Use the `com.influxdb.v3.client.Point` class to create time series data. +2. Call the `client.writePoint()` method to write points as line protocol in your + bucket. ```java // Use the Point class to construct time series data. - // Call client.writePoint to write the point as line protocol to your bucket. + // Call client.writePoint to write the point in your bucket. private static void writeData(InfluxDBClient client) { Point point = Point.measurement("temperature") .setTag("location", "London") @@ -94,7 +290,12 @@ public class HelloInfluxDB { } ``` -### Query the data +#### InfluxDBClient.query + +To query data and process the results: + +1. Call `client.query()` and provide your SQL query as a string. +2. Use the result stream's built-in iterator to process row data. ```java // Query the latest 10 measurements using SQL @@ -115,10 +316,4 @@ public class HelloInfluxDB { } ``` -## Run the program to write and query data - -Build the project and then run the executable .jar file with this [JVM Flag](https://arrow.apache.org/docs/java/install.html). -```sh - java --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar target/PROJECT_NAME.jar -``` -You should be able to also confirm the newly written data in your InfluxDB Cloud Serverless. +View the InfluxDB v3 Java client library \ No newline at end of file diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md index f75a6d175..4e1781478 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md @@ -15,45 +15,9 @@ aliases: - /influxdb/cloud-serverless/reference/client-libraries/v3/pyinflux3/ related: - /influxdb/cloud-serverless/query-data/execute-queries/troubleshoot/ -list_code_example: > - - - ```python - from influxdb_client_3 import(InfluxDBClient3, - WriteOptions, - write_client_options) - - # Instantiate batch writing options for the client - - write_options = WriteOptions() - wco = write_client_options(write_options=write_options) - - # Instantiate an InfluxDB v3 client - - with InfluxDBClient3(host=f"{{< influxdb/host >}}", - database=f"BUCKET_NAME", - token=f"API_TOKEN", - write_client_options=wco) as client: - - # Write data in batches - client.write_file(file='./data/home-sensor-data.csv', timestamp_column='time', - tag_columns=["room"]) - - # Execute a query and retrieve data formatted as a PyArrow Table - - table = client.query( - '''SELECT * - FROM home - WHERE time >= now() - INTERVAL '90 days' - ORDER BY time''') - ``` --- -The InfluxDB v3 [`influxdb3-python` Python client library](https://github.com/InfluxCommunity/influxdb3-python) +The InfluxDB v3 [`influxdb3-python` Python client library](https://github.com/InfluxCommunity/influxdb3-python/) integrates {{% product-name %}} write and query operations with Python scripts and applications. InfluxDB client libraries provide configurable batch writing of data to {{% product-name %}}. @@ -85,8 +49,8 @@ Code samples in this page use the [Get started home sensor sample data](/influxd - [Class WriteOptions](#class-writeoptions) - [Parameters](#parameters-4) - [Functions](#functions) - - [Function write_client_options(\*\*kwargs)](#function-write_client_optionskwargs) - - [Function flight_client_options(\*\*kwargs)](#function-flight_client_optionskwargs) + - [Function write_client_options(**kwargs)](#function-write_client_optionskwargs) + - [Function flight_client_options(**kwargs)](#function-flight_client_optionskwargs) - [Constants](#constants) - [Exceptions](#exceptions) @@ -137,12 +101,17 @@ The `influxdb_client_3` module includes the following classes and functions. - [Writing modes](#writing-modes) - [InfluxDBClient3 instance methods](#influxdbclient3-instance-methods) - [InfluxDBClient3.write](#influxdbclient3write) - - [InfluxDBClient3.write_file](#influxdbclient3write_file) + - [InfluxDBClient3.write\_file](#influxdbclient3write_file) - [InfluxDBClient3.query](#influxdbclient3query) - [InfluxDBClient3.close](#influxdbclient3close) - [Class Point](#class-point) - [Class WriteOptions](#class-writeoptions) - [Parameters](#parameters-4) +- [Functions](#functions) + - [Function write\_client\_options(\*\*kwargs)](#function-write_client_optionskwargs) + - [Function flight\_client\_options(\*\*kwargs)](#function-flight_client_optionskwargs) +- [Constants](#constants) +- [Exceptions](#exceptions) ## Class InfluxDBClient3 @@ -186,10 +155,10 @@ Given that `write_client_options` isn't specified, the client uses the default [ ```python import os ``` - - --> + + ```python from influxdb_client_3 import InfluxDBClient3 @@ -216,6 +185,7 @@ To explicitly specify synchronous mode, create a client with `write_options=SYNC import os ``` --> + ```python @@ -270,6 +240,7 @@ specify callback functions for the response status (success, error, or retryable import os ``` --> + ```python @@ -348,6 +319,7 @@ Writes a record or a list of records to InfluxDB. import os ``` --> + ```python @@ -401,6 +373,7 @@ data to InfluxDB. import os ``` --> + ```python @@ -534,6 +507,7 @@ and how to write data from CSV and JSON files to InfluxDB: import os ``` --> + ```python @@ -636,6 +610,7 @@ Returns all data in the query result as an Arrow table ([`pyarrow.Table`](https: import os ``` --> + ```python @@ -672,6 +647,7 @@ In the examples, replace the following: import os ``` --> + ```python @@ -698,6 +674,7 @@ print(table.select(['room', 'temp'])) import os ``` --> + ```python @@ -723,6 +700,7 @@ print(pd.to_markdown()) import os ``` --> + ```python @@ -750,6 +728,7 @@ print(table.schema) import os ``` --> + ```python @@ -776,6 +755,7 @@ Pass `timeout=` for [`FlightCallOptions`](https://arrow.apach import os ``` --> + ```python @@ -980,3 +960,5 @@ Replace the following: ## Exceptions - `influxdb_client_3.InfluxDBError`: Exception class raised for InfluxDB-related errors + +View the InfluxDB v3 Python client library From 9d53ffe64b7e4676eb0621a6b90c9f00b0ea057d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 24 Jul 2024 18:40:03 -0500 Subject: [PATCH 53/96] fix(v3): Remove unnecessary escape slashes. --- .../reference/client-libraries/v3/python.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md index 4e1781478..d0e05113d 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md @@ -101,15 +101,15 @@ The `influxdb_client_3` module includes the following classes and functions. - [Writing modes](#writing-modes) - [InfluxDBClient3 instance methods](#influxdbclient3-instance-methods) - [InfluxDBClient3.write](#influxdbclient3write) - - [InfluxDBClient3.write\_file](#influxdbclient3write_file) + - [InfluxDBClient3.write_file](#influxdbclient3write_file) - [InfluxDBClient3.query](#influxdbclient3query) - [InfluxDBClient3.close](#influxdbclient3close) - [Class Point](#class-point) - [Class WriteOptions](#class-writeoptions) - [Parameters](#parameters-4) - [Functions](#functions) - - [Function write\_client\_options(\*\*kwargs)](#function-write_client_optionskwargs) - - [Function flight\_client\_options(\*\*kwargs)](#function-flight_client_optionskwargs) + - [Function write_client_options(**kwargs)](#function-write_client_optionskwargs) + - [Function flight_client_options(**kwargs)](#function-flight_client_optionskwargs) - [Constants](#constants) - [Exceptions](#exceptions) From 74b01feb344a57aeb19c75da82fc538ef47182ca Mon Sep 17 00:00:00 2001 From: Josh Powers Date: Thu, 25 Jul 2024 09:10:24 -0600 Subject: [PATCH 54/96] Release influxctl v2.9.4 --- data/products.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/products.yml b/data/products.yml index 7cab39e49..50d93fbcd 100644 --- a/data/products.yml +++ b/data/products.yml @@ -55,7 +55,7 @@ influxdb_cloud_dedicated: list_order: 3 latest: cloud-dedicated link: "https://www.influxdata.com/contact-sales-form/" - latest_cli: 2.9.3 + latest_cli: 2.9.4 placeholder_host: cluster-id.a.influxdb.io influxdb_clustered: From 5f7d23cc7317fb65879665ae424e4dd8f2a2a72e Mon Sep 17 00:00:00 2001 From: Josh Powers Date: Thu, 25 Jul 2024 09:13:02 -0600 Subject: [PATCH 55/96] Update release notes --- .../reference/release-notes/influxctl.md | 11 +++++++++++ .../clustered/reference/release-notes/influxctl.md | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/content/influxdb/cloud-dedicated/reference/release-notes/influxctl.md b/content/influxdb/cloud-dedicated/reference/release-notes/influxctl.md index 4a93bb44f..a01c3c7f8 100644 --- a/content/influxdb/cloud-dedicated/reference/release-notes/influxctl.md +++ b/content/influxdb/cloud-dedicated/reference/release-notes/influxctl.md @@ -11,6 +11,17 @@ menu: weight: 202 --- +## v2.9.4 {date="2024-07-25"} + +### Bug Fixes + +- Resolve crash when parsing error message and authentication was null. + +### Dependency Updates + +- Update `golang.org/x/mod` from 0.18.0 to 0.19.0 +- Update `google.golang.org/grpc` from 1.64.0 to 1.65.0 + ## v2.9.3 {date="2024-06-26"} ### Bug Fixes diff --git a/content/influxdb/clustered/reference/release-notes/influxctl.md b/content/influxdb/clustered/reference/release-notes/influxctl.md index 40039fa65..9f6c0ce8d 100644 --- a/content/influxdb/clustered/reference/release-notes/influxctl.md +++ b/content/influxdb/clustered/reference/release-notes/influxctl.md @@ -12,6 +12,17 @@ weight: 202 canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/ --- +## v2.9.4 {date="2024-07-25"} + +### Bug Fixes + +- Resolve crash when parsing error message and authentication was null. + +### Dependency Updates + +- Update `golang.org/x/mod` from 0.18.0 to 0.19.0 +- Update `google.golang.org/grpc` from 1.64.0 to 1.65.0 + ## v2.9.3 {date="2024-06-26"} ### Bug Fixes From 96654954602e66e96afd63596a8caafbedd210c8 Mon Sep 17 00:00:00 2001 From: Jack <56563911+jdockerty@users.noreply.github.com> Date: Thu, 25 Jul 2024 16:44:20 +0100 Subject: [PATCH 56/96] docs(clustered): add section for troubleshooting licensing (#5534) * docs: troubleshooting licensing * fix(clustered): Licensing - Revise install and licensing docs. * chore(ci): Skip kubectl in tests. * Update content/influxdb/clustered/admin/licensing.md Co-authored-by: Scott Anderson --------- Co-authored-by: Jason Stirnaman Co-authored-by: Jason Stirnaman Co-authored-by: Scott Anderson --- content/influxdb/clustered/admin/licensing.md | 21 +++-- .../influxdb/clustered/install/licensing.md | 83 ++++++++++++++++++- 2 files changed, 94 insertions(+), 10 deletions(-) diff --git a/content/influxdb/clustered/admin/licensing.md b/content/influxdb/clustered/admin/licensing.md index 0e0ede2a5..90f716bbe 100644 --- a/content/influxdb/clustered/admin/licensing.md +++ b/content/influxdb/clustered/admin/licensing.md @@ -58,6 +58,8 @@ install your license. 3. Use `kubectl` to apply and create the `License` resource in your InfluxDB namespace: + + ```sh kubectl apply --filename license.yml --namespace influxdb ``` @@ -85,21 +87,22 @@ per hour) while running. ## Recover from a license misconfiguration -If you deploy a licensed release of InfluxDB Clustered without an invalid or +If you deploy a licensed release of InfluxDB Clustered with an invalid or expired license, many of the pods in your cluster will crash on startup and will likely enter a `CrashLoopBackoff` state without ever running or becoming healthy. -Because the license is stored in a volume-mounted Kubernetes secret, invalid -licenses affect both old and new pods. +Because InfluxDB stores the license in a volume-mounted Kubernetes secret, invalid +licenses affect old and new pods. -Once a valid `License` resource is applied, new pods will begin to start up normally. -Licenses are validated when the `License` resource is applied. If the license -is invalid when you attempt to apply it, the InfluxDB clustered license -controller will not add or update the required secret. +After you apply a valid `License` resource, new pods will begin to start up normally. + +InfluxDB validates a license when you apply it. +If the license is invalid when you try to apply it, the `license controller` +won't add or update the required secret. ## Renew your license -In advance of your license expiration, your InfluxData sales representative will -contact you regarding license renewal. +Before your license expires, your InfluxData sales representative will +contact you about license renewal. You may also contact your sales representative at any time. --- diff --git a/content/influxdb/clustered/install/licensing.md b/content/influxdb/clustered/install/licensing.md index 1d913fe4b..0dd843780 100644 --- a/content/influxdb/clustered/install/licensing.md +++ b/content/influxdb/clustered/install/licensing.md @@ -40,10 +40,12 @@ To deactivate license enforcement, remove the `useLicensedBinaries` feature flag 3. Use `kubectl` to apply and create the `License` resource in your InfluxDB namespace: + + ```sh kubectl apply --filename license.yml --namespace influxdb ``` - + 4. Update your `AppInstance` resource to enable the `useLicensedBinaries` feature flag. Add the `useLicensedBinaries` entry to the `.spec.package.spec.featureFlags` @@ -101,4 +103,83 @@ spec: Replace {{% code-placeholder-key %}}`PACKAGE_VERSION`{{% /code-placeholder-key %}} with the version number to upgrade to. +## Troubleshoot licensing + +After you have activated licensing, use the following signals to verify licensing +and troubleshoot issues with your {{< product-name omit="Clustered" >}} +cluster. + +In your commands, replace the following: + +- {{% code-placeholder-key %}}`NAMESPACE`{{% /code-placeholder-key %}}: + your [InfluxDB namespace](/influxdb/clustered/install/configure-cluster/#create-a-namespace-for-influxdb) +- {{% code-placeholder-key %}}`POD_NAME`{{% /code-placeholder-key %}}: + your [InfluxDB Kubernetes pod](/influxdb/clustered/install/deploy/#inspect-cluster-pods) + +### Verify database components + +After you [install your license](#install-your-influxdb-license), +run the following command to check that database pods start up and are in the +`Running` state: + + + +{{% code-placeholders "NAMESPACE" %}} + +```sh +kubectl get pods -l app=iox --namespace NAMESPACE +``` + +{{% /code-placeholders %}} + +If a `Pod` fails to start, run the following command to view pod information: + + + +{{% code-placeholders "POD_NAME|NAMESPACE" %}} + +```sh +kubectl describe pod POD_NAME --namespace NAMESPACE +``` + +{{% /code-placeholders %}} + +### Verify the `Secret` exists + +Run the following command to verify that the licensing activation created a +`iox-license` secret: + + + +{{% code-placeholders "NAMESPACE" %}} + +```sh +kubectl get secret iox-license --namespace NAMESPACE +``` + +If the secret doesn't exist, +[view `license-controller` logs](#view-license-controller-logs) for +more information or errors. + +{{% /code-placeholders %}} + +### View `license controller` logs + +The `license controller` component creates a `Secret` named `iox-license` from your +`License`. + +To view `license controller` logs for troubleshooting, run the following +command: + + + +{{% code-placeholders "NAMESPACE" %}} + +```sh +kubectl logs deployment/license-controller --namespace NAMESPACE +``` + +{{% /code-placeholders %}} + + {{< page-nav prev="/influxdb/clustered/install/configure-cluster/" prevText="Configure your cluster" next="/influxdb/clustered/install/deploy/" nextText="Deploy your cluster" >}} From b373ac745d283d84bdcfbb48d218458675c0056a Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 25 Jul 2024 11:46:16 -0500 Subject: [PATCH 57/96] Apply suggestions from code review Co-authored-by: Scott Anderson --- .../reference/client-libraries/v3/java.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 0e1d18412..092129da2 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -33,7 +33,7 @@ server metadata, and retrieving data from {{% product-name %}} using the Flight - [Importing the client](#importing-the-client) - [API reference](#api-reference) - [Classes](#classes) -- [Interface InfluxDBClient](#interface-influxdbclient) +- [InfluxDBClient interface](#influxdbclient-interface) - [Initialize with credential parameters](#initialize-with-credential-parameters) - [InfluxDBClient instance methods](#influxdbclient-instance-methods) - [InfluxDBClient.writePoint](#influxdbclientwritepoint) @@ -187,9 +187,9 @@ stored in {{< product-name >}}. - [InfluxDBClient.query](#influxdbclientquery) -## Interface InfluxDBClient +## InfluxDBClient interface -Provides an interface for interacting with InfluxDB APIs for writing and querying data. +`InfluxDBClient` provides an interface for interacting with InfluxDB APIs for writing and querying data. The `InfluxDBClient.getInstance` constructor initializes and returns a client instance with the following: @@ -248,6 +248,7 @@ public class HelloInfluxDB { e.printStackTrace(); } } +} ``` #### Default tags @@ -313,7 +314,6 @@ To query data and process the results: e.printStackTrace(); } } -} ``` View the InfluxDB v3 Java client library \ No newline at end of file From 7df2059eb86b1a5472880c0863f999f10356aba7 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 25 Jul 2024 16:43:15 -0600 Subject: [PATCH 58/96] InfluxDB 2.7.8 --- .../influxdb/v2/reference/release-notes/influxdb.md | 10 ++++++++++ data/products.yml | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/content/influxdb/v2/reference/release-notes/influxdb.md b/content/influxdb/v2/reference/release-notes/influxdb.md index 7cb723105..2dcf11020 100644 --- a/content/influxdb/v2/reference/release-notes/influxdb.md +++ b/content/influxdb/v2/reference/release-notes/influxdb.md @@ -8,6 +8,16 @@ menu: weight: 101 --- +## v2.7.8 {date="2024-07-25"} + +### Bug Fixes + +- Prevent an infinite loop in `measurementFieldSetChangeMgr`. +- Prevent `Store.validateArgs` from wrongfully overwriting start and end Unix + times. + +--- + ## v2.7.7 {date="2024-07-12"} ### Features diff --git a/data/products.yml b/data/products.yml index 50d93fbcd..ffa90729a 100644 --- a/data/products.yml +++ b/data/products.yml @@ -21,7 +21,7 @@ influxdb: - v1.7 latest: v2.7 latest_patches: - v2: 2.7.7 + v2: 2.7.8 v1: 1.8.10 latest_cli: v2: 2.7.5 From 13c5e771bbaaf0d8ab7fd8c8af1033183d02a33a Mon Sep 17 00:00:00 2001 From: wayne Date: Thu, 25 Jul 2024 16:43:47 -0600 Subject: [PATCH 59/96] fix(clustered): adjust keycloak AppInstance config example (#5536) * fix(clustered): adjust keycloak AppInstance config example * Update content/influxdb/clustered/install/configure-cluster.md Co-authored-by: Scott Anderson --------- Co-authored-by: Scott Anderson --- .../influxdb/clustered/install/configure-cluster.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/content/influxdb/clustered/install/configure-cluster.md b/content/influxdb/clustered/install/configure-cluster.md index 3c521f681..bda192af7 100644 --- a/content/influxdb/clustered/install/configure-cluster.md +++ b/content/influxdb/clustered/install/configure-cluster.md @@ -605,8 +605,8 @@ following fields in your `myinfluxdb.yml` configuration file: _If using Microsoft Entra ID (formerly Azure Active Directory), set the name to `azure`_. - `jwksEndpoint`: JWKS endpoint provide by your identity provider. - - `users`: List of OAuth2 user IDs to grant administrative access to - your InfluxDB cluster. IDs are provided by your identity provider. + - `users`: List of OAuth2 users to grant administrative access to your + InfluxDB cluster. IDs are provided by your identity provider. Below are examples for **Keycloak**, **Auth0**, and **Microsoft Entra ID**, but other OAuth2 providers should work as well: @@ -634,7 +634,12 @@ spec: jwksEndpoint: |- https://KEYCLOAK_HOST/auth/realms/KEYCLOAK_REALM/protocol/openid-connect/certs users: - - KEYCLOAK_USER_ID + # All fields are required but `firstName`, `lastName`, and `email` can be + # arbitrary values. However, `id` must match the user ID provided by Keycloak. + - id: KEYCLOAK_USER_ID + firstName: Marty + lastName: McFly + email: mcfly@influxdata.com ``` {{% /code-placeholders %}} From 58113fa54130bd0aaba70bb9e4d137ae3314bcf8 Mon Sep 17 00:00:00 2001 From: Gunnar Aasen Date: Fri, 26 Jul 2024 10:42:35 -0700 Subject: [PATCH 60/96] InfluxDB 2.7.8 release notes --- .../influxdb/v2/reference/release-notes/influxdb.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/content/influxdb/v2/reference/release-notes/influxdb.md b/content/influxdb/v2/reference/release-notes/influxdb.md index 2dcf11020..1a161b1f2 100644 --- a/content/influxdb/v2/reference/release-notes/influxdb.md +++ b/content/influxdb/v2/reference/release-notes/influxdb.md @@ -12,9 +12,13 @@ weight: 101 ### Bug Fixes -- Prevent an infinite loop in `measurementFieldSetChangeMgr`. -- Prevent `Store.validateArgs` from wrongfully overwriting start and end Unix - times. +- Prevent an infinite loop in write path. +- Fix `range()` filter behavior for timestamps before 1970-01-01 (UNIX time 0). +- Update to latest `influxdb-templates`. + +### Maintenance + +- Update user interface (UI) with various improvements. --- From b573c23e804a5d53a40e12bc660281e71877a9e3 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 30 Jul 2024 10:00:14 -0500 Subject: [PATCH 61/96] feat(v2): Use Docker Compose with secrets and `_FILE` env variables: - Add guide for installing v2 using Compose, secrets, and InfluxDB `_FILE` env variables. - Add project compose.yaml configuration for the same. - Content looks good in Hugo, but I'm getting an error from pytest that I haven't identified yet. --- compose.yaml | 32 ++ content/influxdb/v2/install/_index.md | 335 +++++++++++------- .../influxdb/v2/install/use-docker-compose.md | 152 ++++++++ 3 files changed, 385 insertions(+), 134 deletions(-) create mode 100644 content/influxdb/v2/install/use-docker-compose.md diff --git a/compose.yaml b/compose.yaml index 76b477f8b..2a03f144e 100644 --- a/compose.yaml +++ b/compose.yaml @@ -1,6 +1,13 @@ # This is a Docker Compose file for the InfluxData documentation site. ## Run documentation tests for code samples. name: influxdata-docs +secrets: + influxdb2-admin-username: + file: ~/.env.influxdb2-admin-username + influxdb2-admin-password: + file: ~/.env.influxdb2-admin-password + influxdb2-admin-token: + file: ~/.env.influxdb2-admin-token services: local-dev: build: @@ -331,6 +338,31 @@ services: source: test-content target: /app/content working_dir: /app + influxdb2: + image: influxdb:2 + ports: + - 8086:8086 + environment: + DOCKER_INFLUXDB_INIT_MODE: setup + DOCKER_INFLUXDB_INIT_USERNAME_FILE: /run/secrets/influxdb2-admin-username + DOCKER_INFLUXDB_INIT_PASSWORD_FILE: /run/secrets/influxdb2-admin-password + DOCKER_INFLUXDB_INIT_ADMIN_TOKEN_FILE: /run/secrets/influxdb2-admin-token + DOCKER_INFLUXDB_INIT_ORG: docs + DOCKER_INFLUXDB_INIT_BUCKET: home + profiles: + - v2 + - local + secrets: + - influxdb2-admin-username + - influxdb2-admin-password + - influxdb2-admin-token + volumes: + - type: volume + source: influxdb2-data + target: /var/lib/influxdb2 + - type: volume + source: influxdb2-config + target: /etc/influxdb2 volumes: test-content: cloud-tmp: diff --git a/content/influxdb/v2/install/_index.md b/content/influxdb/v2/install/_index.md index 85ccebb32..03d9e7572 100644 --- a/content/influxdb/v2/install/_index.md +++ b/content/influxdb/v2/install/_index.md @@ -84,36 +84,36 @@ For information about using the `influx` CLI, see the 2. Unpackage the InfluxDB binary. - Do one of the following: + Do one of the following: - - In **Finder**, double-click the downloaded package file. - - In your terminal (for example, **Terminal** or **[iTerm2](https://www.iterm2.com/)**), use `tar` to unpackage the file--for example, enter the following command to extract it into the current directory: + - In **Finder**, double-click the downloaded package file. + - In your terminal (for example, **Terminal** or **[iTerm2](https://www.iterm2.com/)**), use `tar` to unpackage the file--for example, enter the following command to extract it into the current directory: - + - ```sh - # Unpackage contents to the current working directory - tar zxvf ~/Downloads/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz - ``` + ```sh + # Unpackage contents to the current working directory + tar zxvf ~/Downloads/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz + ``` 3. Optional: Place the `influxd` binary in your `$PATH`--for example, copy the binary to `/usr/local/bin`: - + - ```sh - # (Optional) Copy the influxd binary to your $PATH - sudo cp influxdb2-{{< latest-patch >}}/influxd /usr/local/bin/ - ``` + ```sh + # (Optional) Copy the influxd binary to your $PATH + sudo cp influxdb2-{{< latest-patch >}}/influxd /usr/local/bin/ + ``` - With the `influxd` binary in your `$PATH` (`/usr/local/bin`), you can enter `influxd` in your terminal to start the server. + With the `influxd` binary in your `$PATH` (`/usr/local/bin`), you can enter `influxd` in your terminal to start the server. - If you choose not to move the `influxd` binary into your `$PATH`, enter the path to the binary to start the server--for example: + If you choose not to move the `influxd` binary into your `$PATH`, enter the path to the binary to start the server--for example: - + - ```sh - ./influxdb2-{{< latest-patch >}}/influxd - ``` + ```sh + ./influxdb2-{{< latest-patch >}}/influxd + ``` {{< expand-wrapper >}} {{% expand "Recommended – Set appropriate directory permissions" %}} @@ -162,21 +162,21 @@ If `gpg` is not available, see the [GnuPG homepage](https://gnupg.org/download/) ``` 2. Download the signature file for the release by adding `.asc` to the download URL, - and then use `gpg` to verify the download signature--for example: + and then use `gpg` to verify the download signature--for example: - ```sh - curl -s https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz.asc \ - | gpg --verify - ~/Downloads/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz \ - 2>&1 | grep 'InfluxData Package Signing Key ' - ``` + ```sh + curl -s https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz.asc \ + | gpg --verify - ~/Downloads/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz \ + 2>&1 | grep 'InfluxData Package Signing Key ' + ``` - If successful, the output is the following: + If successful, the output is the following: - + - ``` - gpg: Good signature from "InfluxData Package Signing Key " [unknown] - ``` + ``` + gpg: Good signature from "InfluxData Package Signing Key " [unknown] + ``` {{% /expand %}} {{< /expand-wrapper >}} @@ -290,61 +290,70 @@ You can use systemd to customize [InfluxDB configuration options](/influxdb/v2/r ### Manually download and install the influxd binary -1. In your browser or your terminal, download the InfluxDB binary for your system architecture (AMD64 or ARM). +_If necessary, adjust the example file paths and utilities for your system._ + +1. In your browser or your terminal, download the InfluxDB binary for your + system architecture (AMD64 or ARM). InfluxDB v2 (amd64) InfluxDB v2 (arm) ```sh # Use curl to download the amd64 binary. - curl -LO https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz + curl -LO \ + https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz ``` ```sh # Use curl to download the arm64 binary. - curl -LO https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz + curl -LO \ + https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz ``` -2. Extract the downloaded binary. +2. Extract the downloaded binary--for example, enter the following command + for your system: - _**Note:** The following commands are examples. Adjust the filenames, paths, and utilities if necessary._ + ```sh + # amd64 + tar xvzf ./influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz + ``` - ```sh - # amd64 - tar xvzf ./influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz - ``` - - ```sh - # arm64 - tar xvzf ./influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz - ``` + ```sh + # arm64 + tar xvzf ./influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz + ``` 3. Optional: Place the extracted `influxd` executable binary in your system `$PATH`. - ```sh - # amd64 - sudo cp ./influxdb2-{{< latest-patch >}}/usr/bin/influxd /usr/local/bin/ - ``` + ```sh + # amd64 + sudo cp ./influxdb2-{{< latest-patch >}}/usr/bin/influxd /usr/local/bin/ + ``` - ```sh - # arm64 - sudo cp ./influxdb2-{{< latest-patch >}}/usr/bin/influxd /usr/local/bin/ - ``` + ```sh + # arm64 + sudo cp ./influxdb2-{{< latest-patch >}}/usr/bin/influxd /usr/local/bin/ + ``` - If you choose to not move the `influxd` binary into your `$PATH`, enter the path to the binary to start the server--for example: + If you choose to not move the `influxd` binary into your `$PATH`, enter the + path to the binary to start the server--for example: - + - ```sh - ./influxdb2-{{< latest-patch >}}/usr/bin/influxd - ``` + ```sh + ./influxdb2-{{< latest-patch >}}/usr/bin/influxd + ``` {{< expand-wrapper >}} {{% expand "Recommended – Set appropriate directory permissions" %}} -To prevent unwanted access to data, set the permissions on the influxdb `data-dir` to not be world readable. -If installing on a server, we recommend setting a umask of `0027` to properly permission all newly created files. -To set umask, use a UMask directive in a systemd unit file or run Influxdb as a specific user that has the umask properly set--for example, enter the following command in your terminal: +To prevent unwanted access to data, set the permissions on the influxdb +`data-dir` to not be world readable. +If installing on a server, we recommend setting a umask of `0027` to properly +permission all newly created files. +To set umask, use a UMask directive in a systemd unit file or run Influxdb as a +specific user that has the umask properly set--for example, enter the following +command in your terminal: @@ -386,8 +395,8 @@ To install `gpg`, see the [GnuPG installation instructions](https://gnupg.org/do gpg: key D8FF8E1F7DF8B07E: public key "InfluxData Package Signing Key " imported ``` -2. Download the signature file for the release by adding `.asc` to the download URL, - and then use `gpg` to verify the download signature--for example: +2. Download the signature file for the release by adding `.asc` to the download + URL, and then use `gpg` to verify the download signature--for example: ```sh curl -sL https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz.asc \ @@ -443,7 +452,10 @@ _You'll install the `influx CLI` in a [later step](#download-and-install-the-inf InfluxDB v2 (Windows) -Expand the downloaded archive into `C:\Program Files\InfluxData\` and rename the files if desired. +Expand the downloaded archive into `C:\Program Files\InfluxData\` and rename the +files if desired. + + ```powershell Expand-Archive .\influxdb2-{{< latest-patch >}}-windows.zip -DestinationPath 'C:\Program Files\InfluxData\' @@ -453,7 +465,11 @@ mv 'C:\Program Files\InfluxData\influxdb2-{{< latest-patch >}}' 'C:\Program File {{< expand-wrapper >}} {{% expand "Recommended – Set appropriate directory permissions" %}} -To prevent unwanted access to data, we recommend setting the permissions on the influxdb `data-dir` to not be world readable--for example: enter the following commands in your terminal: +To prevent unwanted access to data, we recommend setting the permissions on the +influxdb `data-dir` to not be world readable--for example: enter the following +commands in your terminal: + + ```powershell $acl = Get-Acl "C:\Users\\.influxdbv2" @@ -473,63 +489,108 @@ $acl | Set-Acl "C:\Users\\.influxdbv2" ### Install and set up InfluxDB in a container -The following guide uses [Docker CLI commands](https://docs.docker.com/reference/cli/docker/) to set Docker and InfluxDB options, but you can also use Dockerfiles and Docker Compose. +The following steps show to use the +[Docker CLI](https://docs.docker.com/reference/cli/docker/) to set up and +run InfluxDB. but you can also +[use Docker Compose](/influxdb/v2/install/use-docker-compose). -1. Follow instructions to install [Docker Desktop](https://www.docker.com/get-started/) for your system. -2. Start a Docker container from the [`influxdb` Docker Hub image](https://hub.docker.com/_/influxdb)--for example, in your terminal, enter the `docker run influxdb:2` command with command line flags for initial setup options and file system mounts. +_The following guide uses Docker mounted +[volumes](https://docs.docker.com/storage/volumes/) to persist InfluxDB +configuration and data. +Persisting your data to a file system outside the container ensures that your +data isn't deleted if you delete the container._ - The following example uses the Docker `--mount` option to persist InfluxDB configuration and data to [volumes](https://docs.docker.com/storage/volumes/). - _Persisting your data to a file system outside the container ensures that your data isn't deleted if you delete the container._ +1. Install [Docker Desktop](https://www.docker.com/get-started/) for your system. - +2. Start a Docker container from the + [`influxdb` Docker Hub image](https://hub.docker.com/_/influxdb)--for example, + in your terminal, enter the `docker run influxdb:2` command with command line + flags for initial setup options and file system mounts. + +_If you don't specify InfluxDB initial setup options, you can +[set up manually](#set-up-influxdb) later using the UI or CLI in a running +container._ + + {{% code-placeholders "ADMIN_(USERNAME|PASSWORD)|ORG_NAME|BUCKET_NAME" %}} - ```sh - docker run \ - --name influxdb2 \ - --publish 8086:8086 \ - --mount type=volume,source=influxdb2-data,target=/var/lib/influxdb2 \ - --mount type=volume,source=influxdb2-config,target=/etc/influxdb2 \ - --env DOCKER_INFLUXDB_INIT_MODE=setup \ - --env DOCKER_INFLUXDB_INIT_USERNAME=ADMIN_USERNAME \ - --env DOCKER_INFLUXDB_INIT_PASSWORD=ADMIN_PASSWORD \ - --env DOCKER_INFLUXDB_INIT_ORG=ORG_NAME \ - --env DOCKER_INFLUXDB_INIT_BUCKET=BUCKET_NAME \ - influxdb:2 - ``` +```sh +docker run \ + --name influxdb2 \ + --publish 8086:8086 \ + --mount type=volume,source=influxdb2-data,target=/var/lib/influxdb2 \ + --mount type=volume,source=influxdb2-config,target=/etc/influxdb2 \ + --env DOCKER_INFLUXDB_INIT_MODE=setup \ + --env DOCKER_INFLUXDB_INIT_USERNAME=ADMIN_USERNAME \ + --env DOCKER_INFLUXDB_INIT_PASSWORD=ADMIN_PASSWORD \ + --env DOCKER_INFLUXDB_INIT_ORG=ORG_NAME \ + --env DOCKER_INFLUXDB_INIT_BUCKET=BUCKET_NAME \ + influxdb:2 +``` {{% /code-placeholders %}} - The command passes the following arguments: +The command passes the following arguments: - - `--publish 8086:8086`: Exposes the InfluxDB [UI](/influxdb/v2/get-started/#influxdb-user-interface-ui) and [HTTP API](/influxdb/v2/reference/api/) on the host's `8086` port. - - `--mount type=volume,source=influxdb2-data,target=/var/lib/influxdb2`: Creates a volume named `influxdb2-data` mapped to the [InfluxDB data directory](/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) to persist data outside the container. - - `--mount type=volume,source=influxdb2-config,target=/etc/influxdb2`: Creates a volume named `influxdb2-config` mapped to the [InfluxDB configuration directory](/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) to make configurations available outside the container. - - `-e DOCKER_INFLUXDB_INIT_MODE=setup`: Environment variable that invokes the automated setup of the initial organization, user, bucket, and token when creating the container. - - `-e DOCKER_INFLUXDB_INIT_`: Environment variables for initial setup options--replace the following with your own values: +- `--publish 8086:8086`: Exposes the InfluxDB + [UI](/influxdb/v2/get-started/#influxdb-user-interface-ui) and + [HTTP API](/influxdb/v2/reference/api/) on the host's `8086` port. +- `--mount type=volume,source=influxdb2-data,target=/var/lib/influxdb2`: Creates + a volume named `influxdb2-data` mapped to the + [InfluxDB data directory](/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) + to persist data outside the container. +- `--mount type=volume,source=influxdb2-config,target=/etc/influxdb2`: Creates a + volume named `influxdb2-config` mapped to the + [InfluxDB configuration directory](/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) + to make configurations available outside the container. +- `--env DOCKER_INFLUXDB_INIT_MODE=setup`: Environment variable that invokes the + automated setup of the initial organization, user, bucket, and token when creating the container. +- `--env DOCKER_INFLUXDB_INIT_`: Environment variables for initial + setup options--replace the following with your own values: - - {{% code-placeholder-key %}}`ADMIN_USERNAME`{{% /code-placeholder-key %}}: The username for the initial [user](/influxdb/v2/admin/users/)--an admin user with an API [Operator token](/influxdb/v2/admin/tokens/#operator-token). - - {{% code-placeholder-key %}}`ADMIN_PASSWORD`{{% /code-placeholder-key %}}: The password for the initial [user](/influxdb/v2/admin/users/). - - {{% code-placeholder-key %}}`ORG_NAME`{{% /code-placeholder-key %}}: The name for the initial [organization](/influxdb/v2/admin/organizations/). - - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: The name for the initial [bucket](/influxdb/v2/admin/buckets/). - - For more options, see the [`influxdb` Docker Hub image](https://hub.docker.com/_/influxdb) documentation. - _If you don't specify InfluxDB initial setup options, you can [set up manually](#set-up-influxdb) later using the UI or CLI in a running container._ + - {{% code-placeholder-key %}}`ADMIN_USERNAME`{{% /code-placeholder-key %}}: + The username for the initial [user](/influxdb/v2/admin/users/)--an admin + user with an API [Operator token](/influxdb/v2/admin/tokens/#operator-token). + - {{% code-placeholder-key %}}`ADMIN_PASSWORD`{{% /code-placeholder-key %}}: + The password for the initial [user](/influxdb/v2/admin/users/). + - {{% code-placeholder-key %}}`ORG_NAME`{{% /code-placeholder-key %}}: + The name for the initial [organization](/influxdb/v2/admin/organizations/). + - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: + The name for the initial [bucket](/influxdb/v2/admin/buckets/). If successful, the command starts InfluxDB initialized with the user, organization, bucket, and _[Operator token](/influxdb/v2/admin/tokens/#operator-token)_, and logs to stdout. -You can view the Operator token in the `/etc/influxdb2/influx-configs` file and use it to authorize [creating an All Access token](#optional-create-all-access-tokens). -_To run the InfluxDB container in [detached mode](https://docs.docker.com/engine/reference/run/#detached-vs-foreground), - include the `--detach` flag in the `docker run` command._ +You can view the Operator token in the `/etc/influxdb2/influx-configs` file and +use it to authorize +[creating an All Access token](#optional-create-all-access-tokens). + +_To run the InfluxDB container in +[detached mode](https://docs.docker.com/engine/reference/run/#detached-vs-foreground), +include the `--detach` flag in the `docker run` command._ + +For more InfluxDB configuration options, +see the [`influxdb` Docker Hub image](https://hub.docker.com/_/influxdb) +documentation. ### Run InfluxDB CLI commands in a container -When you start a container using the `influxdb` Docker Hub image, it also installs the [`influx` CLI](/influxdb/v2/tools/influx-cli/) in the container. -With InfluxDB setup and running in the container, you can use the Docker CLI [`docker exec`](https://docs.docker.com/reference/cli/docker/container/exec/) command to interact with the `influx` and `influxd` CLIs inside the container. +When you start a container using the `influxdb` Docker Hub image, it also +installs the [`influx` CLI](/influxdb/v2/tools/influx-cli/) in the container. +With InfluxDB setup and running in the container, you can use the Docker CLI +[`docker exec`](https://docs.docker.com/reference/cli/docker/container/exec/) +command to interact with the `influx` and `influxd` CLIs inside the container. -To use the `influx` CLI in the container, run `docker exec -it influx `--for example: +#### Syntax + + + +```sh +docker exec -it ` +``` + +#### Examples @@ -538,7 +599,9 @@ To use the `influx` CLI in the container, run `docker exec -it docker exec -it influxdb2 influx config ls ``` -```bash + + +```sh # View the server configuration docker exec -it influxdb2 influx server-config # Inspect server details @@ -547,7 +610,9 @@ docker exec -it influxdb2 influxd inspect -d ### Manage files in mounted volumes -To copy files, such as the InfluxDB server `config.yml` file, between your local file system and a volume, use the [`docker container cp` command](https://docs.docker.com/reference/cli/docker/container/cp/). +To copy files, such as the InfluxDB server `config.yml` file, between your local +file system and a volume, use the +[`docker container cp` command](https://docs.docker.com/reference/cli/docker/container/cp/). {{% /tab-content %}} @@ -567,56 +632,56 @@ InfluxData also makes [Helm charts](https://github.com/influxdata/helm-charts) a - ```sh - # with minikube - minikube start - ``` + ```sh + # with minikube + minikube start + ``` - + - ```sh - # with kind - kind create cluster - ``` + ```sh + # with kind + kind create cluster + ``` 3. Apply the [sample InfluxDB configuration](https://github.com/influxdata/docs-v2/blob/master/static/downloads/influxdb-k8-minikube.yaml) by running: - + - ```sh - kubectl apply -f https://raw.githubusercontent.com/influxdata/docs-v2/master/static/downloads/influxdb-k8-minikube.yaml - ``` + ```sh + kubectl apply -f https://raw.githubusercontent.com/influxdata/docs-v2/master/static/downloads/influxdb-k8-minikube.yaml + ``` - This creates an `influxdb` Namespace, Service, and StatefulSet. - A PersistentVolumeClaim is also created to store data written to InfluxDB. + This creates an `influxdb` Namespace, Service, and StatefulSet. + A PersistentVolumeClaim is also created to store data written to InfluxDB. - **Important**: Always inspect YAML manifests before running `kubectl apply -f `! + **Important**: always inspect YAML manifests before running `kubectl apply -f `! 4. Ensure the Pod is running: - + - ```sh - kubectl get pods -n influxdb - ``` + ```sh + kubectl get pods -n influxdb + ``` 5. Ensure the Service is available: - + - ```sh - kubectl describe service -n influxdb influxdb - ``` + ```sh + kubectl describe service -n influxdb influxdb + ``` - You should see an IP address after `Endpoints` in the command's output. + You should see an IP address after `Endpoints` in the command's output. 6. Forward port 8086 from inside the cluster to localhost: - + - ```sh - kubectl port-forward -n influxdb service/influxdb 8086:8086 - ``` + ```sh + kubectl port-forward -n influxdb service/influxdb 8086:8086 + ``` {{% /tab-content %}} @@ -629,7 +694,7 @@ To run InfluxDB on Raspberry Pi, you need: - a Raspberry Pi 4+ or 400 - a 64-bit operating system. - We recommend installing a [64-bit version of Ubuntu](https://ubuntu.com/download/raspberry-pi) + _Recommended_ : a [64-bit version of Ubuntu](https://ubuntu.com/download/raspberry-pi) of Ubuntu Desktop or Ubuntu Server compatible with 64-bit Raspberry Pi. ### Install Linux binaries @@ -746,6 +811,8 @@ influxd In **Powershell**, navigate into `C:\Program Files\InfluxData\influxdb` and start InfluxDB by running the `influxd` daemon: + + ```powershell cd -Path 'C:\Program Files\InfluxData\influxdb' ./influxd diff --git a/content/influxdb/v2/install/use-docker-compose.md b/content/influxdb/v2/install/use-docker-compose.md new file mode 100644 index 000000000..129f79b25 --- /dev/null +++ b/content/influxdb/v2/install/use-docker-compose.md @@ -0,0 +1,152 @@ +--- +title: Install InfluxDB using Docker Compose +description: Use Docker Compose and secrets to install and set up InfluxDB OSS. +menu: + influxdb_v2: + name: Use Docker Compose + parent: Install InfluxDB +weight: 2 +influxdb/v2/tags: [install] +related: + - /influxdb/v2/install/ + - /influxdb/v2/reference/cli/influx/auth/ + - /influxdb/v2/reference/cli/influx/config/ + - /influxdb/v2/reference/cli/influx/ + - /influxdb/v2/admin/tokens/ +--- + +Use Docker Compose to install and set up InfluxDB v2, the time series platform +is purpose-built to collect, store, process and visualize metrics and events. + +When you use Docker Compose to create an InfluxDB container, you can use +Compose [`secrets`](https://docs.docker.com/compose/use-secrets/) to control +access to sensitive credentials such as username, password, and token and +prevent leaking them in your `docker inspect` output. + +The `influxdb` Docker image provides the following environment +variables to use with Compose `secrets`: + +- `DOCKER_INFLUXDB_INIT_USERNAME_FILE`: the container's path to the file that + contains the username for your initial [user](/influxdb/v2/admin/users/). +- `DOCKER_INFLUXDB_INIT_PASSWORD_FILE`: the container's path to the file that + contains the password for your initial [user](/influxdb/v2/admin/users/). +- `DOCKER_INFLUXDB_INIT_ADMIN_TOKEN_FILE`: the container's path to the file that + contains a token to use for your initial + [Operator token](/influxdb/v2/admin/tokens/#operator-token). + If you don't specify an initial token, InfluxDB generates one for you. + +## Set up using Docker Compose secrets + +Follow steps to set up and run InfluxDB using Docker Compose and `secrets`: + +1. If you haven't already, install + [Docker Desktop](https://www.docker.com/get-started/) for your system. + +2. Copy the following `compose.yaml` into your project directory. + + ```yml + # compose.yaml + services: + influxdb2: + image: influxdb:2 + ports: + - 8086:8086 + environment: + DOCKER_INFLUXDB_INIT_MODE: setup + DOCKER_INFLUXDB_INIT_USERNAME_FILE: /run/secrets/influxdb2-admin-username + DOCKER_INFLUXDB_INIT_PASSWORD_FILE: /run/secrets/influxdb2-admin-password + DOCKER_INFLUXDB_INIT_ADMIN_TOKEN_FILE: /run/secrets/influxdb2-admin-token + DOCKER_INFLUXDB_INIT_ORG: docs + DOCKER_INFLUXDB_INIT_BUCKET: home + secrets: + - influxdb2-admin-username + - influxdb2-admin-password + - influxdb2-admin-token + volumes: + - type: volume + source: influxdb2-data + target: /var/lib/influxdb2 + - type: volume + source: influxdb2-config + target: /etc/influxdb2 + secrets: + influxdb2-admin-username: + file: ~/.env.influxdb2-admin-username + influxdb2-admin-password: + file: ~/.env.influxdb2-admin-password + influxdb2-admin-token: + file: ~/.env.influxdb2-admin-token + ``` + +3. For each secret in `compose.yaml`, create a file that contains the secret + value--for example: + + - `~/.env.influxdb2-admin-username`: + + ```text + admin + ``` + + - `~/.env.influxdb2-admin-password`: + + ```text + MyInitialAdminPassword + ``` + + - `~/.env.influxdb2-admin-token`: + + ```text + MyInitialAdminToken0== + ``` + +4. To set up and run InfluxDB, enter the following command in your + terminal: + + + + ```sh + docker compose up influxdb2 + ``` + +At runtime, the `influxdb` image: + +1. Mounts `secrets` files from your host filesystem to `/run/secrets/` +in the container. +2. Assigns the environment variables to the specified files--for example: + + ```yaml + environment: + DOCKER_INFLUXDB_INIT_USERNAME_FILE: /run/secrets/influxdb2-admin-username + DOCKER_INFLUXDB_INIT_PASSWORD_FILE: /run/secrets/influxdb2-admin-password + DOCKER_INFLUXDB_INIT_ADMIN_TOKEN_FILE: /run/secrets/influxdb2-admin-token + ``` + +3. Retrieves the secrets from the mounted files and runs setup. +4. Starts InfluxDB. +5. Runs any custom initialization scripts mounted inside the container's + `/docker-entrypoint-initdb.d/` path. + +If successful, InfluxDB initializes the user, password, organization, bucket, +and _[Operator token](/influxdb/v2/admin/tokens/#operator-token)_, and then +logs to stdout. + +_Although Docker prevents inadvertently exposing secrets (for example, in +`docker inspect` output), a +user that has access to the running container's filesystem can view the secrets._ + +### Run InfluxDB CLI commands in a container + +After you start a container using the `influxdb` Docker Hub image, you can +[use `docker exec` with the `influx` and `influxd` +CLIs](/influxdb/v2/install/#run-influxdb-cli-commands-in-a-container) inside the +container. + +### Manage files in mounted volumes + +To copy files, such as the InfluxDB server `config.yml` file, between your local +file system and a volume, use the +[`docker container cp` command](https://docs.docker.com/reference/cli/docker/container/cp/). + +For more InfluxDB and Docker configuration options, +see the [`influxdb` Docker Hub image](https://hub.docker.com/_/influxdb) +documentation. From 8ab4d4491c6c07a017cc179172dbe25ba20de033 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 30 Jul 2024 10:07:46 -0500 Subject: [PATCH 62/96] chore(ci): Add remark-lint to project - Add remark-lint to compose.yaml - Add base config for remark-lint --- .ci/Dockerfile.remark | 26 + .ci/app/package.json | 13 + .ci/remark-lint/yarn.lock | 2577 +++++++++++++++++++++++++++++++++++++ compose.yaml | 11 + content/.remarkrc.yaml | 13 + 5 files changed, 2640 insertions(+) create mode 100644 .ci/Dockerfile.remark create mode 100644 .ci/app/package.json create mode 100644 .ci/remark-lint/yarn.lock create mode 100644 content/.remarkrc.yaml diff --git a/.ci/Dockerfile.remark b/.ci/Dockerfile.remark new file mode 100644 index 000000000..71d775c55 --- /dev/null +++ b/.ci/Dockerfile.remark @@ -0,0 +1,26 @@ +FROM registry.gitlab.com/pipeline-components/remark-lint:latest + + +WORKDIR /app/ + +# Generic +#RUN apk add --no-cache +COPY /.ci/app /app/ +#COPY /.ci/remark-lint/package.json /app/ + +# Node +ENV PATH "$PATH:/app/node_modules/.bin/" +RUN yarn install && yarn cache clean +ENV NODE_PATH=/app/node_modules/ +RUN ln -nfs /app/node_modules /node_modules + +# Build arguments +ARG BUILD_DATE +ARG BUILD_REF + +# Labels +LABEL \ + org.label-schema.build-date=${BUILD_DATE} \ + org.label-schema.name="Remark-lint" \ + org.label-schema.schema-version="1.0" \ + org.label-schema.url="https://pipeline-components.gitlab.io/" diff --git a/.ci/app/package.json b/.ci/app/package.json new file mode 100644 index 000000000..cc6d1d69e --- /dev/null +++ b/.ci/app/package.json @@ -0,0 +1,13 @@ +{ + "name": "remark-lint", + "license": "MIT", + "devDependencies": { + "remark-cli": "12.0.1", + "remark-preset-lint-consistent": "6.0.0", + "remark-preset-lint-markdown-style-guide": "6.0.0", + "remark-preset-lint-recommended": "7.0.0", + "remark-frontmatter": "5.0.0", + "remark-lint-frontmatter-schema": "3.15.4", + "remark-lint-no-shell-dollars": "4.0.0" + } +} diff --git a/.ci/remark-lint/yarn.lock b/.ci/remark-lint/yarn.lock new file mode 100644 index 000000000..ec982abc6 --- /dev/null +++ b/.ci/remark-lint/yarn.lock @@ -0,0 +1,2577 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@apidevtools/json-schema-ref-parser@11.1.0": + version "11.1.0" + resolved "https://registry.yarnpkg.com/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-11.1.0.tgz#0608ed1ba47c377c6732e7185f2ea06731b58fde" + integrity sha512-g/VW9ZQEFJAOwAyUb8JFf7MLiLy2uEB4rU270rGzDwICxnxMlPy0O11KVePSgS36K1NI29gSlK84n5INGhd4Ag== + dependencies: + "@jsdevtools/ono" "^7.1.3" + "@types/json-schema" "^7.0.13" + "@types/lodash.clonedeep" "^4.5.7" + js-yaml "^4.1.0" + lodash.clonedeep "^4.5.0" + +"@babel/code-frame@^7.21.4": + version "7.24.7" + resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.24.7.tgz#882fd9e09e8ee324e496bd040401c6f046ef4465" + integrity sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA== + dependencies: + "@babel/highlight" "^7.24.7" + picocolors "^1.0.0" + +"@babel/helper-validator-identifier@^7.24.7": + version "7.24.7" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz#75b889cfaf9e35c2aaf42cf0d72c8e91719251db" + integrity sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w== + +"@babel/highlight@^7.24.7": + version "7.24.7" + resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.24.7.tgz#a05ab1df134b286558aae0ed41e6c5f731bf409d" + integrity sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw== + dependencies: + "@babel/helper-validator-identifier" "^7.24.7" + chalk "^2.4.2" + js-tokens "^4.0.0" + picocolors "^1.0.0" + +"@isaacs/cliui@^8.0.2": + version "8.0.2" + resolved "https://registry.yarnpkg.com/@isaacs/cliui/-/cliui-8.0.2.tgz#b37667b7bc181c168782259bab42474fbf52b550" + integrity sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA== + dependencies: + string-width "^5.1.2" + string-width-cjs "npm:string-width@^4.2.0" + strip-ansi "^7.0.1" + strip-ansi-cjs "npm:strip-ansi@^6.0.1" + wrap-ansi "^8.1.0" + wrap-ansi-cjs "npm:wrap-ansi@^7.0.0" + +"@jsdevtools/ono@^7.1.3": + version "7.1.3" + resolved "https://registry.yarnpkg.com/@jsdevtools/ono/-/ono-7.1.3.tgz#9df03bbd7c696a5c58885c34aa06da41c8543796" + integrity sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg== + +"@npmcli/config@^8.0.0": + version "8.3.4" + resolved "https://registry.yarnpkg.com/@npmcli/config/-/config-8.3.4.tgz#e2712c2215bb2659f39718b23bf7401f9ac1da59" + integrity sha512-01rtHedemDNhUXdicU7s+QYz/3JyV5Naj84cvdXGH4mgCdL+agmSYaLF4LUG4vMCLzhBO8YtS0gPpH1FGvbgAw== + dependencies: + "@npmcli/map-workspaces" "^3.0.2" + "@npmcli/package-json" "^5.1.1" + ci-info "^4.0.0" + ini "^4.1.2" + nopt "^7.2.1" + proc-log "^4.2.0" + semver "^7.3.5" + walk-up-path "^3.0.1" + +"@npmcli/git@^5.0.0": + version "5.0.8" + resolved "https://registry.yarnpkg.com/@npmcli/git/-/git-5.0.8.tgz#8ba3ff8724192d9ccb2735a2aa5380a992c5d3d1" + integrity sha512-liASfw5cqhjNW9UFd+ruwwdEf/lbOAQjLL2XY2dFW/bkJheXDYZgOyul/4gVvEV4BWkTXjYGmDqMw9uegdbJNQ== + dependencies: + "@npmcli/promise-spawn" "^7.0.0" + ini "^4.1.3" + lru-cache "^10.0.1" + npm-pick-manifest "^9.0.0" + proc-log "^4.0.0" + promise-inflight "^1.0.1" + promise-retry "^2.0.1" + semver "^7.3.5" + which "^4.0.0" + +"@npmcli/map-workspaces@^3.0.2": + version "3.0.6" + resolved "https://registry.yarnpkg.com/@npmcli/map-workspaces/-/map-workspaces-3.0.6.tgz#27dc06c20c35ef01e45a08909cab9cb3da08cea6" + integrity sha512-tkYs0OYnzQm6iIRdfy+LcLBjcKuQCeE5YLb8KnrIlutJfheNaPvPpgoFEyEFgbjzl5PLZ3IA/BWAwRU0eHuQDA== + dependencies: + "@npmcli/name-from-folder" "^2.0.0" + glob "^10.2.2" + minimatch "^9.0.0" + read-package-json-fast "^3.0.0" + +"@npmcli/name-from-folder@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@npmcli/name-from-folder/-/name-from-folder-2.0.0.tgz#c44d3a7c6d5c184bb6036f4d5995eee298945815" + integrity sha512-pwK+BfEBZJbKdNYpHHRTNBwBoqrN/iIMO0AiGvYsp3Hoaq0WbgGSWQR6SCldZovoDpY3yje5lkFUe6gsDgJ2vg== + +"@npmcli/package-json@^5.1.1": + version "5.2.0" + resolved "https://registry.yarnpkg.com/@npmcli/package-json/-/package-json-5.2.0.tgz#a1429d3111c10044c7efbfb0fce9f2c501f4cfad" + integrity sha512-qe/kiqqkW0AGtvBjL8TJKZk/eBBSpnJkUWvHdQ9jM2lKHXRYYJuyNpJPlJw3c8QjC2ow6NZYiLExhUaeJelbxQ== + dependencies: + "@npmcli/git" "^5.0.0" + glob "^10.2.2" + hosted-git-info "^7.0.0" + json-parse-even-better-errors "^3.0.0" + normalize-package-data "^6.0.0" + proc-log "^4.0.0" + semver "^7.5.3" + +"@npmcli/promise-spawn@^7.0.0": + version "7.0.2" + resolved "https://registry.yarnpkg.com/@npmcli/promise-spawn/-/promise-spawn-7.0.2.tgz#1d53d34ffeb5d151bfa8ec661bcccda8bbdfd532" + integrity sha512-xhfYPXoV5Dy4UkY0D+v2KkwvnDfiA/8Mt3sWCGI/hM03NsYIH8ZaG6QzS9x7pje5vHZBZJ2v6VRFVTWACnqcmQ== + dependencies: + which "^4.0.0" + +"@pkgjs/parseargs@^0.11.0": + version "0.11.0" + resolved "https://registry.yarnpkg.com/@pkgjs/parseargs/-/parseargs-0.11.0.tgz#a77ea742fab25775145434eb1d2328cf5013ac33" + integrity sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg== + +"@types/concat-stream@^2.0.0": + version "2.0.3" + resolved "https://registry.yarnpkg.com/@types/concat-stream/-/concat-stream-2.0.3.tgz#1f5c2ad26525716c181191f7ed53408f78eb758e" + integrity sha512-3qe4oQAPNwVNwK4C9c8u+VJqv9kez+2MR4qJpoPFfXtgxxif1QbFusvXzK0/Wra2VX07smostI2VMmJNSpZjuQ== + dependencies: + "@types/node" "*" + +"@types/debug@^4.0.0": + version "4.1.12" + resolved "https://registry.yarnpkg.com/@types/debug/-/debug-4.1.12.tgz#a155f21690871953410df4b6b6f53187f0500917" + integrity sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ== + dependencies: + "@types/ms" "*" + +"@types/estree-jsx@^1.0.0": + version "1.0.5" + resolved "https://registry.yarnpkg.com/@types/estree-jsx/-/estree-jsx-1.0.5.tgz#858a88ea20f34fe65111f005a689fa1ebf70dc18" + integrity sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg== + dependencies: + "@types/estree" "*" + +"@types/estree@*": + version "1.0.5" + resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.5.tgz#a6ce3e556e00fd9895dd872dd172ad0d4bd687f4" + integrity sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw== + +"@types/hast@^3.0.0": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@types/hast/-/hast-3.0.4.tgz#1d6b39993b82cea6ad783945b0508c25903e15aa" + integrity sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ== + dependencies: + "@types/unist" "*" + +"@types/is-empty@^1.0.0": + version "1.2.3" + resolved "https://registry.yarnpkg.com/@types/is-empty/-/is-empty-1.2.3.tgz#a2d55ea8a5ec57bf61e411ba2a9e5132fe4f0899" + integrity sha512-4J1l5d79hoIvsrKh5VUKVRA1aIdsOb10Hu5j3J2VfP/msDnfTdGPmNp2E1Wg+vs97Bktzo+MZePFFXSGoykYJw== + +"@types/json-schema@^7.0.13": + version "7.0.15" + resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.15.tgz#596a1747233694d50f6ad8a7869fcb6f56cf5841" + integrity sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA== + +"@types/lodash.clonedeep@^4.5.7": + version "4.5.9" + resolved "https://registry.yarnpkg.com/@types/lodash.clonedeep/-/lodash.clonedeep-4.5.9.tgz#ea48276c7cc18d080e00bb56cf965bcceb3f0fc1" + integrity sha512-19429mWC+FyaAhOLzsS8kZUsI+/GmBAQ0HFiCPsKGU+7pBXOQWhyrY6xNNDwUSX8SMZMJvuFVMF9O5dQOlQK9Q== + dependencies: + "@types/lodash" "*" + +"@types/lodash@*": + version "4.17.7" + resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.17.7.tgz#2f776bcb53adc9e13b2c0dfd493dfcbd7de43612" + integrity sha512-8wTvZawATi/lsmNu10/j2hk1KEP0IvjubqPE3cu1Xz7xfXXt5oCq3SNUz4fMIP4XGF9Ky+Ue2tBA3hcS7LSBlA== + +"@types/mdast@^4.0.0": + version "4.0.4" + resolved "https://registry.yarnpkg.com/@types/mdast/-/mdast-4.0.4.tgz#7ccf72edd2f1aa7dd3437e180c64373585804dd6" + integrity sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA== + dependencies: + "@types/unist" "*" + +"@types/ms@*": + version "0.7.34" + resolved "https://registry.yarnpkg.com/@types/ms/-/ms-0.7.34.tgz#10964ba0dee6ac4cd462e2795b6bebd407303433" + integrity sha512-nG96G3Wp6acyAgJqGasjODb+acrI7KltPiRxzHPXnP3NgI28bpQDRv53olbqGXbfcgF5aiiHmO3xpwEpS5Ld9g== + +"@types/node@*": + version "22.0.0" + resolved "https://registry.yarnpkg.com/@types/node/-/node-22.0.0.tgz#04862a2a71e62264426083abe1e27e87cac05a30" + integrity sha512-VT7KSYudcPOzP5Q0wfbowyNLaVR8QWUdw+088uFWwfvpY6uCWaXpqV6ieLAu9WBcnTa7H4Z5RLK8I5t2FuOcqw== + dependencies: + undici-types "~6.11.1" + +"@types/node@^20.0.0": + version "20.14.13" + resolved "https://registry.yarnpkg.com/@types/node/-/node-20.14.13.tgz#bf4fe8959ae1c43bc284de78bd6c01730933736b" + integrity sha512-+bHoGiZb8UiQ0+WEtmph2IWQCjIqg8MDZMAV+ppRRhUZnquF5mQkP/9vpSwJClEiSM/C7fZZExPzfU0vJTyp8w== + dependencies: + undici-types "~5.26.4" + +"@types/supports-color@^8.0.0": + version "8.1.3" + resolved "https://registry.yarnpkg.com/@types/supports-color/-/supports-color-8.1.3.tgz#b769cdce1d1bb1a3fa794e35b62c62acdf93c139" + integrity sha512-Hy6UMpxhE3j1tLpl27exp1XqHD7n8chAiNPzWfz16LPZoMMoSc4dzLl6w9qijkEb/r5O1ozdu1CWGA2L83ZeZg== + +"@types/text-table@^0.2.0": + version "0.2.5" + resolved "https://registry.yarnpkg.com/@types/text-table/-/text-table-0.2.5.tgz#f9c609b81c943e9fc8d73ef82ad2f2a78be5f53b" + integrity sha512-hcZhlNvMkQG/k1vcZ6yHOl6WAYftQ2MLfTHcYRZ2xYZFD8tGVnE3qFV0lj1smQeDSR7/yY0PyuUalauf33bJeA== + +"@types/unist@*", "@types/unist@^3.0.0": + version "3.0.2" + resolved "https://registry.yarnpkg.com/@types/unist/-/unist-3.0.2.tgz#6dd61e43ef60b34086287f83683a5c1b2dc53d20" + integrity sha512-dqId9J8K/vGi5Zr7oo212BGii5m3q5Hxlkwy3WpYuKPklmBEvsbMYYyLxAQpSffdLl/gdW0XUpKWFvYmyoWCoQ== + +"@types/unist@^2.0.0": + version "2.0.10" + resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.10.tgz#04ffa7f406ab628f7f7e97ca23e290cd8ab15efc" + integrity sha512-IfYcSBWE3hLpBg8+X2SEa8LVkJdJEkT2Ese2aaLs3ptGdVtABxndrMaxuFlQ1qdFf9Q5rDvDpxI3WwgvKFAsQA== + +abbrev@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/abbrev/-/abbrev-2.0.0.tgz#cf59829b8b4f03f89dda2771cb7f3653828c89bf" + integrity sha512-6/mh1E2u2YgEsCHdY0Yx5oW+61gZU+1vXaoiHHrpKeuRNNgFvS+/jrwHiQhB5apAf5oB7UB7E19ol2R2LKH8hQ== + +ajv-formats@2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-2.1.1.tgz#6e669400659eb74973bbf2e33327180a0996b520" + integrity sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA== + dependencies: + ajv "^8.0.0" + +ajv@8.12.0: + version "8.12.0" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.12.0.tgz#d1a0527323e22f53562c567c00991577dfbe19d1" + integrity sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA== + dependencies: + fast-deep-equal "^3.1.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + uri-js "^4.2.2" + +ajv@^8.0.0: + version "8.17.1" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.17.1.tgz#37d9a5c776af6bc92d7f4f9510eba4c0a60d11a6" + integrity sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g== + dependencies: + fast-deep-equal "^3.1.3" + fast-uri "^3.0.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + +ansi-regex@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" + integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== + +ansi-regex@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.0.1.tgz#3183e38fae9a65d7cb5e53945cd5897d0260a06a" + integrity sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA== + +ansi-styles@^3.2.1: + version "3.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" + integrity sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA== + dependencies: + color-convert "^1.9.0" + +ansi-styles@^4.0.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" + integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== + dependencies: + color-convert "^2.0.1" + +ansi-styles@^6.1.0: + version "6.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.1.tgz#0e62320cf99c21afff3b3012192546aacbfb05c5" + integrity sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug== + +anymatch@~3.1.2: + version "3.1.3" + resolved "https://registry.yarnpkg.com/anymatch/-/anymatch-3.1.3.tgz#790c58b19ba1720a84205b57c618d5ad8524973e" + integrity sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw== + dependencies: + normalize-path "^3.0.0" + picomatch "^2.0.4" + +argparse@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" + integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== + +bail@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/bail/-/bail-2.0.2.tgz#d26f5cd8fe5d6f832a31517b9f7c356040ba6d5d" + integrity sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw== + +balanced-match@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" + integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== + +binary-extensions@^2.0.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-2.3.0.tgz#f6e14a97858d327252200242d4ccfe522c445522" + integrity sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw== + +brace-expansion@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.1.tgz#1edc459e0f0c548486ecf9fc99f2221364b9a0ae" + integrity sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA== + dependencies: + balanced-match "^1.0.0" + +braces@~3.0.2: + version "3.0.3" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.3.tgz#490332f40919452272d55a8480adc0c441358789" + integrity sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA== + dependencies: + fill-range "^7.1.1" + +buffer-from@^1.0.0: + version "1.1.2" + resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" + integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== + +ccount@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/ccount/-/ccount-2.0.1.tgz#17a3bf82302e0870d6da43a01311a8bc02a3ecf5" + integrity sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg== + +chalk@^2.4.2: + version "2.4.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424" + integrity sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ== + dependencies: + ansi-styles "^3.2.1" + escape-string-regexp "^1.0.5" + supports-color "^5.3.0" + +chalk@^5.0.0: + version "5.3.0" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.3.0.tgz#67c20a7ebef70e7f3970a01f90fa210cb6860385" + integrity sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w== + +character-entities-html4@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/character-entities-html4/-/character-entities-html4-2.1.0.tgz#1f1adb940c971a4b22ba39ddca6b618dc6e56b2b" + integrity sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA== + +character-entities-legacy@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz#76bc83a90738901d7bc223a9e93759fdd560125b" + integrity sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ== + +character-entities@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/character-entities/-/character-entities-2.0.2.tgz#2d09c2e72cd9523076ccb21157dff66ad43fcc22" + integrity sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ== + +character-reference-invalid@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz#85c66b041e43b47210faf401278abf808ac45cb9" + integrity sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw== + +chokidar@^3.0.0: + version "3.6.0" + resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.6.0.tgz#197c6cc669ef2a8dc5e7b4d97ee4e092c3eb0d5b" + integrity sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw== + dependencies: + anymatch "~3.1.2" + braces "~3.0.2" + glob-parent "~5.1.2" + is-binary-path "~2.1.0" + is-glob "~4.0.1" + normalize-path "~3.0.0" + readdirp "~3.6.0" + optionalDependencies: + fsevents "~2.3.2" + +ci-info@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-4.0.0.tgz#65466f8b280fc019b9f50a5388115d17a63a44f2" + integrity sha512-TdHqgGf9odd8SXNuxtUBVx8Nv+qZOejE6qyqiy5NtbYYQOeFa6zmHkxlPzmaLxWWHsU6nJmB7AETdVPi+2NBUg== + +collapse-white-space@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/collapse-white-space/-/collapse-white-space-2.1.0.tgz#640257174f9f42c740b40f3b55ee752924feefca" + integrity sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw== + +color-convert@^1.9.0: + version "1.9.3" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8" + integrity sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg== + dependencies: + color-name "1.1.3" + +color-convert@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" + integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== + dependencies: + color-name "~1.1.4" + +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" + integrity sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== + +color-name@~1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" + integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== + +comma-separated-tokens@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz#4e89c9458acb61bc8fef19f4529973b2392839ee" + integrity sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg== + +concat-stream@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/concat-stream/-/concat-stream-2.0.0.tgz#414cf5af790a48c60ab9be4527d56d5e41133cb1" + integrity sha512-MWufYdFw53ccGjCA+Ol7XJYpAlW6/prSMzuPOTRnJGcGzuhLn4Scrz7qf6o8bROZ514ltazcIFJZevcfbo0x7A== + dependencies: + buffer-from "^1.0.0" + inherits "^2.0.3" + readable-stream "^3.0.2" + typedarray "^0.0.6" + +cross-spawn@^7.0.0: + version "7.0.3" + resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.3.tgz#f73a85b9d5d41d045551c177e2882d4ac85728a6" + integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w== + dependencies: + path-key "^3.1.0" + shebang-command "^2.0.0" + which "^2.0.1" + +debug@^4.0.0: + version "4.3.6" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.6.tgz#2ab2c38fbaffebf8aa95fdfe6d88438c7a13c52b" + integrity sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg== + dependencies: + ms "2.1.2" + +decode-named-character-reference@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/decode-named-character-reference/-/decode-named-character-reference-1.0.2.tgz#daabac9690874c394c81e4162a0304b35d824f0e" + integrity sha512-O8x12RzrUF8xyVcY0KJowWsmaJxQbmy0/EtnNtHRpsOcT7dFk5W598coHqBVpmWo1oQQfsCqfCmkZN5DJrZVdg== + dependencies: + character-entities "^2.0.0" + +dequal@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/dequal/-/dequal-2.0.3.tgz#2644214f1997d39ed0ee0ece72335490a7ac67be" + integrity sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA== + +devlop@^1.0.0, devlop@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/devlop/-/devlop-1.1.0.tgz#4db7c2ca4dc6e0e834c30be70c94bbc976dc7018" + integrity sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA== + dependencies: + dequal "^2.0.0" + +eastasianwidth@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/eastasianwidth/-/eastasianwidth-0.2.0.tgz#696ce2ec0aa0e6ea93a397ffcf24aa7840c827cb" + integrity sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA== + +emoji-regex@^10.2.1: + version "10.3.0" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-10.3.0.tgz#76998b9268409eb3dae3de989254d456e70cfe23" + integrity sha512-QpLs9D9v9kArv4lfDEgg1X/gN5XLnf/A6l9cs8SPZLRZR3ZkY9+kwIQTxm+fsSej5UMYGE8fdoaZVIBlqG0XTw== + +emoji-regex@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" + integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== + +emoji-regex@^9.2.2: + version "9.2.2" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-9.2.2.tgz#840c8803b0d8047f4ff0cf963176b32d4ef3ed72" + integrity sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg== + +err-code@^2.0.2: + version "2.0.3" + resolved "https://registry.yarnpkg.com/err-code/-/err-code-2.0.3.tgz#23c2f3b756ffdfc608d30e27c9a941024807e7f9" + integrity sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA== + +error-ex@^1.3.2: + version "1.3.2" + resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.2.tgz#b4ac40648107fdcdcfae242f428bea8a14d4f1bf" + integrity sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g== + dependencies: + is-arrayish "^0.2.1" + +escape-string-regexp@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + integrity sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg== + +escape-string-regexp@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz#4683126b500b61762f2dbebace1806e8be31b1c8" + integrity sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw== + +extend@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/extend/-/extend-3.0.2.tgz#f8b1136b4071fbd8eb140aff858b1019ec2915fa" + integrity sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g== + +fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: + version "3.1.3" + resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" + integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== + +fast-uri@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.0.1.tgz#cddd2eecfc83a71c1be2cc2ef2061331be8a7134" + integrity sha512-MWipKbbYiYI0UC7cl8m/i/IWTqfC8YXsqjzybjddLsFjStroQzsHXkc73JutMvBiXmOvapk+axIl79ig5t55Bw== + +fault@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/fault/-/fault-2.0.1.tgz#d47ca9f37ca26e4bd38374a7c500b5a384755b6c" + integrity sha512-WtySTkS4OKev5JtpHXnib4Gxiurzh5NCGvWrFaZ34m6JehfTUhKZvn9njTfw48t6JumVQOmrKqpmGcdwxnhqBQ== + dependencies: + format "^0.2.0" + +fill-range@^7.1.1: + version "7.1.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.1.1.tgz#44265d3cac07e3ea7dc247516380643754a05292" + integrity sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg== + dependencies: + to-regex-range "^5.0.1" + +find-up@6.3.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-6.3.0.tgz#2abab3d3280b2dc7ac10199ef324c4e002c8c790" + integrity sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw== + dependencies: + locate-path "^7.1.0" + path-exists "^5.0.0" + +foreground-child@^3.1.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/foreground-child/-/foreground-child-3.2.1.tgz#767004ccf3a5b30df39bed90718bab43fe0a59f7" + integrity sha512-PXUUyLqrR2XCWICfv6ukppP96sdFwWbNEnfEMt7jNsISjMsvaLNinAHNDYyvkyU+SZG2BTSbT5NjG+vZslfGTA== + dependencies: + cross-spawn "^7.0.0" + signal-exit "^4.0.1" + +format@^0.2.0: + version "0.2.2" + resolved "https://registry.yarnpkg.com/format/-/format-0.2.2.tgz#d6170107e9efdc4ed30c9dc39016df942b5cb58b" + integrity sha512-wzsgA6WOq+09wrU1tsJ09udeR/YZRaeArL9e1wPbFg3GG2yDnC2ldKpxs4xunpFF9DgqCqOIra3bc1HWrJ37Ww== + +fsevents@~2.3.2: + version "2.3.3" + resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6" + integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw== + +glob-parent@~5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== + dependencies: + is-glob "^4.0.1" + +glob@^10.0.0, glob@^10.2.2: + version "10.4.5" + resolved "https://registry.yarnpkg.com/glob/-/glob-10.4.5.tgz#f4d9f0b90ffdbab09c9d77f5f29b4262517b0956" + integrity sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg== + dependencies: + foreground-child "^3.1.0" + jackspeak "^3.1.2" + minimatch "^9.0.4" + minipass "^7.1.2" + package-json-from-dist "^1.0.0" + path-scurry "^1.11.1" + +has-flag@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-3.0.0.tgz#b5d454dc2199ae225699f3467e5a07f3b955bafd" + integrity sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw== + +hosted-git-info@^7.0.0: + version "7.0.2" + resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-7.0.2.tgz#9b751acac097757667f30114607ef7b661ff4f17" + integrity sha512-puUZAUKT5m8Zzvs72XWy3HtvVbTWljRE66cP60bxJzAqf2DgICo7lYTY2IHUmLnNpjYvw5bvmoHvPc0QO2a62w== + dependencies: + lru-cache "^10.0.1" + +ignore@^5.0.0: + version "5.3.1" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.3.1.tgz#5073e554cd42c5b33b394375f538b8593e34d4ef" + integrity sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw== + +import-meta-resolve@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/import-meta-resolve/-/import-meta-resolve-4.1.0.tgz#f9db8bead9fafa61adb811db77a2bf22c5399706" + integrity sha512-I6fiaX09Xivtk+THaMfAwnA3MVA5Big1WHF1Dfx9hFuvNIWpXnorlkzhcQf6ehrqQiiZECRt1poOAkPmer3ruw== + +inherits@^2.0.3: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + +ini@^4.1.2, ini@^4.1.3: + version "4.1.3" + resolved "https://registry.yarnpkg.com/ini/-/ini-4.1.3.tgz#4c359675a6071a46985eb39b14e4a2c0ec98a795" + integrity sha512-X7rqawQBvfdjS10YU1y1YVreA3SsLrW9dX2CewP2EbBJM4ypVNLDkO5y04gejPwKIY9lR+7r9gn3rFPt/kmWFg== + +is-alphabetical@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-alphabetical/-/is-alphabetical-2.0.1.tgz#01072053ea7c1036df3c7d19a6daaec7f19e789b" + integrity sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ== + +is-alphanumerical@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz#7c03fbe96e3e931113e57f964b0a368cc2dfd875" + integrity sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw== + dependencies: + is-alphabetical "^2.0.0" + is-decimal "^2.0.0" + +is-arrayish@^0.2.1: + version "0.2.1" + resolved "https://registry.yarnpkg.com/is-arrayish/-/is-arrayish-0.2.1.tgz#77c99840527aa8ecb1a8ba697b80645a7a926a9d" + integrity sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg== + +is-binary-path@~2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/is-binary-path/-/is-binary-path-2.1.0.tgz#ea1f7f3b80f064236e83470f86c09c254fb45b09" + integrity sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw== + dependencies: + binary-extensions "^2.0.0" + +is-buffer@^2.0.0: + version "2.0.5" + resolved "https://registry.yarnpkg.com/is-buffer/-/is-buffer-2.0.5.tgz#ebc252e400d22ff8d77fa09888821a24a658c191" + integrity sha512-i2R6zNFDwgEHJyQUtJEk0XFi1i0dPFn/oqjK3/vPCcDeJvW5NQ83V8QbicfF1SupOaB0h8ntgBC2YiE7dfyctQ== + +is-decimal@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-decimal/-/is-decimal-2.0.1.tgz#9469d2dc190d0214fd87d78b78caecc0cc14eef7" + integrity sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A== + +is-empty@^1.0.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/is-empty/-/is-empty-1.2.0.tgz#de9bb5b278738a05a0b09a57e1fb4d4a341a9f6b" + integrity sha512-F2FnH/otLNJv0J6wc73A5Xo7oHLNnqplYqZhUu01tD54DIPvxIRSTSLkrUB/M0nHO4vo1O9PDfN4KoTxCzLh/w== + +is-extglob@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" + integrity sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ== + +is-fullwidth-code-point@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" + integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== + +is-glob@^4.0.1, is-glob@~4.0.1: + version "4.0.3" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" + integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== + dependencies: + is-extglob "^2.1.1" + +is-hexadecimal@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz#86b5bf668fca307498d319dfc03289d781a90027" + integrity sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg== + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +is-plain-obj@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-4.1.0.tgz#d65025edec3657ce032fd7db63c97883eaed71f0" + integrity sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg== + +isexe@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" + integrity sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw== + +isexe@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/isexe/-/isexe-3.1.1.tgz#4a407e2bd78ddfb14bea0c27c6f7072dde775f0d" + integrity sha512-LpB/54B+/2J5hqQ7imZHfdU31OlgQqx7ZicVlkm9kzg9/w8GKLEcFfJl/t7DCEDueOyBAD6zCCwTO6Fzs0NoEQ== + +jackspeak@^3.1.2: + version "3.4.3" + resolved "https://registry.yarnpkg.com/jackspeak/-/jackspeak-3.4.3.tgz#8833a9d89ab4acde6188942bd1c53b6390ed5a8a" + integrity sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw== + dependencies: + "@isaacs/cliui" "^8.0.2" + optionalDependencies: + "@pkgjs/parseargs" "^0.11.0" + +js-tokens@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" + integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== + +js-yaml@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602" + integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA== + dependencies: + argparse "^2.0.1" + +json-parse-even-better-errors@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-3.0.2.tgz#b43d35e89c0f3be6b5fbbe9dc6c82467b30c28da" + integrity sha512-fi0NG4bPjCHunUJffmLd0gxssIgkNmArMvis4iNah6Owg1MCJjWhEcDLmsK6iGkJq3tHwbDkTlce70/tmXN4cQ== + +json-schema-traverse@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" + integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== + +json5@^2.0.0: + version "2.2.3" + resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" + integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== + +lines-and-columns@^2.0.3: + version "2.0.4" + resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-2.0.4.tgz#d00318855905d2660d8c0822e3f5a4715855fc42" + integrity sha512-wM1+Z03eypVAVUCE7QdSqpVIvelbOakn1M0bPDoA4SGWPx3sNDVUiMo3L6To6WWGClB7VyXnhQ4Sn7gxiJbE6A== + +load-plugin@^6.0.0: + version "6.0.3" + resolved "https://registry.yarnpkg.com/load-plugin/-/load-plugin-6.0.3.tgz#b0eb8ea2361744f0e54850ccbc4c8a2d94ffabe3" + integrity sha512-kc0X2FEUZr145odl68frm+lMJuQ23+rTXYmR6TImqPtbpmXC4vVXbWKDQ9IzndA0HfyQamWfKLhzsqGSTxE63w== + dependencies: + "@npmcli/config" "^8.0.0" + import-meta-resolve "^4.0.0" + +locate-path@^7.1.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-7.2.0.tgz#69cb1779bd90b35ab1e771e1f2f89a202c2a8a8a" + integrity sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA== + dependencies: + p-locate "^6.0.0" + +lodash.clonedeep@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz#e23f3f9c4f8fbdde872529c1071857a086e5ccef" + integrity sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ== + +longest-streak@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/longest-streak/-/longest-streak-3.1.0.tgz#62fa67cd958742a1574af9f39866364102d90cd4" + integrity sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g== + +lru-cache@^10.0.1, lru-cache@^10.2.0: + version "10.4.3" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-10.4.3.tgz#410fc8a17b70e598013df257c2446b7f3383f119" + integrity sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ== + +markdown-extensions@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/markdown-extensions/-/markdown-extensions-2.0.0.tgz#34bebc83e9938cae16e0e017e4a9814a8330d3c4" + integrity sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q== + +mdast-comment-marker@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/mdast-comment-marker/-/mdast-comment-marker-3.0.0.tgz#8233f27c985ac7be53678ecb453dd9648fa1b5c5" + integrity sha512-bt08sLmTNg00/UtVDiqZKocxqvQqqyQZAg1uaRuO/4ysXV5motg7RolF5o5yy/sY1rG0v2XgZEqFWho1+2UquA== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-mdx-expression "^2.0.0" + +mdast-util-directive@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-directive/-/mdast-util-directive-3.0.0.tgz#3fb1764e705bbdf0afb0d3f889e4404c3e82561f" + integrity sha512-JUpYOqKI4mM3sZcNxmF/ox04XYFFkNwr0CFlrQIkCwbvH0xzMCqkMqAde9wRd80VAhaUrwFwKm2nxretdT1h7Q== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + parse-entities "^4.0.0" + stringify-entities "^4.0.0" + unist-util-visit-parents "^6.0.0" + +mdast-util-from-markdown@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.1.tgz#32a6e8f512b416e1f51eb817fc64bd867ebcd9cc" + integrity sha512-aJEUyzZ6TzlsX2s5B4Of7lN7EQtAxvtradMMglCQDyaTFgse6CmtmdJ15ElnVRlCg1vpNyVtbem0PWzlNieZsA== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + decode-named-character-reference "^1.0.0" + devlop "^1.0.0" + mdast-util-to-string "^4.0.0" + micromark "^4.0.0" + micromark-util-decode-numeric-character-reference "^2.0.0" + micromark-util-decode-string "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + unist-util-stringify-position "^4.0.0" + +mdast-util-frontmatter@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-frontmatter/-/mdast-util-frontmatter-2.0.1.tgz#f5f929eb1eb36c8a7737475c7eb438261f964ee8" + integrity sha512-LRqI9+wdgC25P0URIJY9vwocIzCcksduHQ9OF2joxQoyTNVduwLAFUzjoopuRJbJAReaKrNQKAZKL3uCMugWJA== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + escape-string-regexp "^5.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + micromark-extension-frontmatter "^2.0.0" + +mdast-util-heading-style@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-heading-style/-/mdast-util-heading-style-3.0.0.tgz#f1a02b2d0950e8535713f54de5ee0eea82413f51" + integrity sha512-tsUfM9Kj9msjlemA/38Z3pvraQay880E3zP2NgIthMoGcpU9bcPX9oSM6QC/+eFXGGB4ba+VCB1dKAPHB7Veug== + dependencies: + "@types/mdast" "^4.0.0" + +mdast-util-mdx-expression@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.0.tgz#4968b73724d320a379110d853e943a501bfd9d87" + integrity sha512-fGCu8eWdKUKNu5mohVGkhBXCXGnOTLuFqOvGMvdikr+J1w7lDJgxThOKpwRWzzbyXAU2hhSwsmssOY4yTokluw== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-mdx-jsx@^3.0.0: + version "3.1.2" + resolved "https://registry.yarnpkg.com/mdast-util-mdx-jsx/-/mdast-util-mdx-jsx-3.1.2.tgz#daae777c72f9c4a106592e3025aa50fb26068e1b" + integrity sha512-eKMQDeywY2wlHc97k5eD8VC+9ASMjN8ItEZQNGwJ6E0XWKiW/Z0V5/H8pvoXUf+y+Mj0VIgeRRbujBmFn4FTyA== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + ccount "^2.0.0" + devlop "^1.1.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + parse-entities "^4.0.0" + stringify-entities "^4.0.0" + unist-util-remove-position "^5.0.0" + unist-util-stringify-position "^4.0.0" + vfile-message "^4.0.0" + +mdast-util-mdx@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-mdx/-/mdast-util-mdx-3.0.0.tgz#792f9cf0361b46bee1fdf1ef36beac424a099c41" + integrity sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w== + dependencies: + mdast-util-from-markdown "^2.0.0" + mdast-util-mdx-expression "^2.0.0" + mdast-util-mdx-jsx "^3.0.0" + mdast-util-mdxjs-esm "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-mdxjs-esm@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-mdxjs-esm/-/mdast-util-mdxjs-esm-2.0.1.tgz#019cfbe757ad62dd557db35a695e7314bcc9fa97" + integrity sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-phrasing@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/mdast-util-phrasing/-/mdast-util-phrasing-4.1.0.tgz#7cc0a8dec30eaf04b7b1a9661a92adb3382aa6e3" + integrity sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w== + dependencies: + "@types/mdast" "^4.0.0" + unist-util-is "^6.0.0" + +mdast-util-to-markdown@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.0.tgz#9813f1d6e0cdaac7c244ec8c6dabfdb2102ea2b4" + integrity sha512-SR2VnIEdVNCJbP6y7kVTJgPLifdr8WEU440fQec7qHoHOUz/oJ2jmNRqdDQ3rbiStOXb2mCDGTuwsK5OPUgYlQ== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + longest-streak "^3.0.0" + mdast-util-phrasing "^4.0.0" + mdast-util-to-string "^4.0.0" + micromark-util-decode-string "^2.0.0" + unist-util-visit "^5.0.0" + zwitch "^2.0.0" + +mdast-util-to-string@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz#7a5121475556a04e7eddeb67b264aae79d312814" + integrity sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg== + dependencies: + "@types/mdast" "^4.0.0" + +micromark-core-commonmark@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-core-commonmark/-/micromark-core-commonmark-2.0.1.tgz#9a45510557d068605c6e9a80f282b2bb8581e43d" + integrity sha512-CUQyKr1e///ZODyD1U3xit6zXwy1a8q2a1S1HKtIlmgvurrEpaw/Y9y6KSIbF8P59cn/NjzHyO+Q2fAyYLQrAA== + dependencies: + decode-named-character-reference "^1.0.0" + devlop "^1.0.0" + micromark-factory-destination "^2.0.0" + micromark-factory-label "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-factory-title "^2.0.0" + micromark-factory-whitespace "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-classify-character "^2.0.0" + micromark-util-html-tag-name "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-resolve-all "^2.0.0" + micromark-util-subtokenize "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-frontmatter@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-frontmatter/-/micromark-extension-frontmatter-2.0.0.tgz#651c52ffa5d7a8eeed687c513cd869885882d67a" + integrity sha512-C4AkuM3dA58cgZha7zVnuVxBhDsbttIMiytjgsM2XbHAB2faRVaHRle40558FBN+DJcrLNCoqG5mlrpdU4cRtg== + dependencies: + fault "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-destination@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-factory-destination/-/micromark-factory-destination-2.0.0.tgz#857c94debd2c873cba34e0445ab26b74f6a6ec07" + integrity sha512-j9DGrQLm/Uhl2tCzcbLhy5kXsgkHUrjJHg4fFAeoMRwJmJerT9aw4FEhIbZStWN8A3qMwOp1uzHr4UL8AInxtA== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-label@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-factory-label/-/micromark-factory-label-2.0.0.tgz#17c5c2e66ce39ad6f4fc4cbf40d972f9096f726a" + integrity sha512-RR3i96ohZGde//4WSe/dJsxOX6vxIg9TimLAS3i4EhBAFx8Sm5SmqVfR8E87DPSR31nEAjZfbt91OMZWcNgdZw== + dependencies: + devlop "^1.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-space@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz#5e7afd5929c23b96566d0e1ae018ae4fcf81d030" + integrity sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-title@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-factory-title/-/micromark-factory-title-2.0.0.tgz#726140fc77892af524705d689e1cf06c8a83ea95" + integrity sha512-jY8CSxmpWLOxS+t8W+FG3Xigc0RDQA9bKMY/EwILvsesiRniiVMejYTE4wumNc2f4UbAa4WsHqe3J1QS1sli+A== + dependencies: + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-whitespace@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.0.tgz#9e92eb0f5468083381f923d9653632b3cfb5f763" + integrity sha512-28kbwaBjc5yAI1XadbdPYHX/eDnqaUFVikLwrO7FDnKG7lpgxnvk/XGRhX/PN0mOZ+dBSZ+LgunHS+6tYQAzhA== + dependencies: + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-character@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-util-character/-/micromark-util-character-2.1.0.tgz#31320ace16b4644316f6bf057531689c71e2aee1" + integrity sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ== + dependencies: + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-chunked@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-chunked/-/micromark-util-chunked-2.0.0.tgz#e51f4db85fb203a79dbfef23fd41b2f03dc2ef89" + integrity sha512-anK8SWmNphkXdaKgz5hJvGa7l00qmcaUQoMYsBwDlSKFKjc6gjGXPDw3FNL3Nbwq5L8gE+RCbGqTw49FK5Qyvg== + dependencies: + micromark-util-symbol "^2.0.0" + +micromark-util-classify-character@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-classify-character/-/micromark-util-classify-character-2.0.0.tgz#8c7537c20d0750b12df31f86e976d1d951165f34" + integrity sha512-S0ze2R9GH+fu41FA7pbSqNWObo/kzwf8rN/+IGlW/4tC6oACOs8B++bh+i9bVyNnwCcuksbFwsBme5OCKXCwIw== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-combine-extensions@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.0.tgz#75d6ab65c58b7403616db8d6b31315013bfb7ee5" + integrity sha512-vZZio48k7ON0fVS3CUgFatWHoKbbLTK/rT7pzpJ4Bjp5JjkZeasRfrS9wsBdDJK2cJLHMckXZdzPSSr1B8a4oQ== + dependencies: + micromark-util-chunked "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-decode-numeric-character-reference@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.1.tgz#2698bbb38f2a9ba6310e359f99fcb2b35a0d2bd5" + integrity sha512-bmkNc7z8Wn6kgjZmVHOX3SowGmVdhYS7yBpMnuMnPzDq/6xwVA604DuOXMZTO1lvq01g+Adfa0pE2UKGlxL1XQ== + dependencies: + micromark-util-symbol "^2.0.0" + +micromark-util-decode-string@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-decode-string/-/micromark-util-decode-string-2.0.0.tgz#7dfa3a63c45aecaa17824e656bcdb01f9737154a" + integrity sha512-r4Sc6leeUTn3P6gk20aFMj2ntPwn6qpDZqWvYmAG6NgvFTIlj4WtrAudLi65qYoaGdXYViXYw2pkmn7QnIFasA== + dependencies: + decode-named-character-reference "^1.0.0" + micromark-util-character "^2.0.0" + micromark-util-decode-numeric-character-reference "^2.0.0" + micromark-util-symbol "^2.0.0" + +micromark-util-encode@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-encode/-/micromark-util-encode-2.0.0.tgz#0921ac7953dc3f1fd281e3d1932decfdb9382ab1" + integrity sha512-pS+ROfCXAGLWCOc8egcBvT0kf27GoWMqtdarNfDcjb6YLuV5cM3ioG45Ys2qOVqeqSbjaKg72vU+Wby3eddPsA== + +micromark-util-html-tag-name@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.0.tgz#ae34b01cbe063363847670284c6255bb12138ec4" + integrity sha512-xNn4Pqkj2puRhKdKTm8t1YHC/BAjx6CEwRFXntTaRf/x16aqka6ouVoutm+QdkISTlT7e2zU7U4ZdlDLJd2Mcw== + +micromark-util-normalize-identifier@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.0.tgz#91f9a4e65fe66cc80c53b35b0254ad67aa431d8b" + integrity sha512-2xhYT0sfo85FMrUPtHcPo2rrp1lwbDEEzpx7jiH2xXJLqBuy4H0GgXk5ToU8IEwoROtXuL8ND0ttVa4rNqYK3w== + dependencies: + micromark-util-symbol "^2.0.0" + +micromark-util-resolve-all@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.0.tgz#189656e7e1a53d0c86a38a652b284a252389f364" + integrity sha512-6KU6qO7DZ7GJkaCgwBNtplXCvGkJToU86ybBAUdavvgsCiG8lSSvYxr9MhwmQ+udpzywHsl4RpGJsYWG1pDOcA== + dependencies: + micromark-util-types "^2.0.0" + +micromark-util-sanitize-uri@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.0.tgz#ec8fbf0258e9e6d8f13d9e4770f9be64342673de" + integrity sha512-WhYv5UEcZrbAtlsnPuChHUAsu/iBPOVaEVsntLBIdpibO0ddy8OzavZz3iL2xVvBZOpolujSliP65Kq0/7KIYw== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-encode "^2.0.0" + micromark-util-symbol "^2.0.0" + +micromark-util-subtokenize@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-subtokenize/-/micromark-util-subtokenize-2.0.1.tgz#76129c49ac65da6e479c09d0ec4b5f29ec6eace5" + integrity sha512-jZNtiFl/1aY73yS3UGQkutD0UbhTt68qnRpw2Pifmz5wV9h8gOVsN70v+Lq/f1rKaU/W8pxRe8y8Q9FX1AOe1Q== + dependencies: + devlop "^1.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-symbol@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz#12225c8f95edf8b17254e47080ce0862d5db8044" + integrity sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw== + +micromark-util-types@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-util-types/-/micromark-util-types-2.0.0.tgz#63b4b7ffeb35d3ecf50d1ca20e68fc7caa36d95e" + integrity sha512-oNh6S2WMHWRZrmutsRmDDfkzKtxF+bc2VxLC9dvtrDIRFln627VsFP6fLMgTryGDljgLPjkrzQSDcPrjPyDJ5w== + +micromark@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/micromark/-/micromark-4.0.0.tgz#84746a249ebd904d9658cfabc1e8e5f32cbc6249" + integrity sha512-o/sd0nMof8kYff+TqcDx3VSrgBTcZpSvYcAHIfHhv5VAuNmisCxjhx6YmxS8PFEpb9z5WKWKPdzf0jM23ro3RQ== + dependencies: + "@types/debug" "^4.0.0" + debug "^4.0.0" + decode-named-character-reference "^1.0.0" + devlop "^1.0.0" + micromark-core-commonmark "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-combine-extensions "^2.0.0" + micromark-util-decode-numeric-character-reference "^2.0.0" + micromark-util-encode "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-resolve-all "^2.0.0" + micromark-util-sanitize-uri "^2.0.0" + micromark-util-subtokenize "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +minimatch@9.0.3: + version "9.0.3" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.3.tgz#a6e00c3de44c3a542bfaae70abfc22420a6da825" + integrity sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg== + dependencies: + brace-expansion "^2.0.1" + +minimatch@^9.0.0, minimatch@^9.0.4: + version "9.0.5" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.5.tgz#d74f9dd6b57d83d8e98cfb82133b03978bc929e5" + integrity sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow== + dependencies: + brace-expansion "^2.0.1" + +minimist@^1.0.0: + version "1.2.8" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" + integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== + +"minipass@^5.0.0 || ^6.0.2 || ^7.0.0", minipass@^7.1.2: + version "7.1.2" + resolved "https://registry.yarnpkg.com/minipass/-/minipass-7.1.2.tgz#93a9626ce5e5e66bd4db86849e7515e92340a707" + integrity sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw== + +ms@2.1.2: + version "2.1.2" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009" + integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w== + +nopt@^7.2.1: + version "7.2.1" + resolved "https://registry.yarnpkg.com/nopt/-/nopt-7.2.1.tgz#1cac0eab9b8e97c9093338446eddd40b2c8ca1e7" + integrity sha512-taM24ViiimT/XntxbPyJQzCG+p4EKOpgD3mxFwW38mGjVUrfERQOeY4EDHjdnptttfHuHQXFx+lTP08Q+mLa/w== + dependencies: + abbrev "^2.0.0" + +normalize-package-data@^6.0.0: + version "6.0.2" + resolved "https://registry.yarnpkg.com/normalize-package-data/-/normalize-package-data-6.0.2.tgz#a7bc22167fe24025412bcff0a9651eb768b03506" + integrity sha512-V6gygoYb/5EmNI+MEGrWkC+e6+Rr7mTmfHrxDbLzxQogBkgzo76rkok0Am6thgSF7Mv2nLOajAJj5vDJZEFn7g== + dependencies: + hosted-git-info "^7.0.0" + semver "^7.3.5" + validate-npm-package-license "^3.0.4" + +normalize-path@^3.0.0, normalize-path@~3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65" + integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA== + +npm-install-checks@^6.0.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/npm-install-checks/-/npm-install-checks-6.3.0.tgz#046552d8920e801fa9f919cad569545d60e826fe" + integrity sha512-W29RiK/xtpCGqn6f3ixfRYGk+zRyr+Ew9F2E20BfXxT5/euLdA/Nm7fO7OeTGuAmTs30cpgInyJ0cYe708YTZw== + dependencies: + semver "^7.1.1" + +npm-normalize-package-bin@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/npm-normalize-package-bin/-/npm-normalize-package-bin-3.0.1.tgz#25447e32a9a7de1f51362c61a559233b89947832" + integrity sha512-dMxCf+zZ+3zeQZXKxmyuCKlIDPGuv8EF940xbkC4kQVDTtqoh6rJFO+JTKSA6/Rwi0getWmtuy4Itup0AMcaDQ== + +npm-package-arg@^11.0.0: + version "11.0.3" + resolved "https://registry.yarnpkg.com/npm-package-arg/-/npm-package-arg-11.0.3.tgz#dae0c21199a99feca39ee4bfb074df3adac87e2d" + integrity sha512-sHGJy8sOC1YraBywpzQlIKBE4pBbGbiF95U6Auspzyem956E0+FtDtsx1ZxlOJkQCZ1AFXAY/yuvtFYrOxF+Bw== + dependencies: + hosted-git-info "^7.0.0" + proc-log "^4.0.0" + semver "^7.3.5" + validate-npm-package-name "^5.0.0" + +npm-pick-manifest@^9.0.0: + version "9.1.0" + resolved "https://registry.yarnpkg.com/npm-pick-manifest/-/npm-pick-manifest-9.1.0.tgz#83562afde52b0b07cb6244361788d319ce7e8636" + integrity sha512-nkc+3pIIhqHVQr085X9d2JzPzLyjzQS96zbruppqC9aZRm/x8xx6xhI98gHtsfELP2bE+loHq8ZaHFHhe+NauA== + dependencies: + npm-install-checks "^6.0.0" + npm-normalize-package-bin "^3.0.0" + npm-package-arg "^11.0.0" + semver "^7.3.5" + +p-limit@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-4.0.0.tgz#914af6544ed32bfa54670b061cafcbd04984b644" + integrity sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ== + dependencies: + yocto-queue "^1.0.0" + +p-locate@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-6.0.0.tgz#3da9a49d4934b901089dca3302fa65dc5a05c04f" + integrity sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw== + dependencies: + p-limit "^4.0.0" + +package-json-from-dist@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/package-json-from-dist/-/package-json-from-dist-1.0.0.tgz#e501cd3094b278495eb4258d4c9f6d5ac3019f00" + integrity sha512-dATvCeZN/8wQsGywez1mzHtTlP22H8OEfPrVMLNr4/eGa+ijtLn/6M5f0dY8UKNrC2O9UCU6SSoG3qRKnt7STw== + +parse-entities@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/parse-entities/-/parse-entities-4.0.1.tgz#4e2a01111fb1c986549b944af39eeda258fc9e4e" + integrity sha512-SWzvYcSJh4d/SGLIOQfZ/CoNv6BTlI6YEQ7Nj82oDVnRpwe/Z/F1EMx42x3JAOwGBlCjeCH0BRJQbQ/opHL17w== + dependencies: + "@types/unist" "^2.0.0" + character-entities "^2.0.0" + character-entities-legacy "^3.0.0" + character-reference-invalid "^2.0.0" + decode-named-character-reference "^1.0.0" + is-alphanumerical "^2.0.0" + is-decimal "^2.0.0" + is-hexadecimal "^2.0.0" + +parse-json@^7.0.0: + version "7.1.1" + resolved "https://registry.yarnpkg.com/parse-json/-/parse-json-7.1.1.tgz#68f7e6f0edf88c54ab14c00eb700b753b14e2120" + integrity sha512-SgOTCX/EZXtZxBE5eJ97P4yGM5n37BwRU+YMsH4vNzFqJV/oWFXXCmwFlgWUM4PrakybVOueJJ6pwHqSVhTFDw== + dependencies: + "@babel/code-frame" "^7.21.4" + error-ex "^1.3.2" + json-parse-even-better-errors "^3.0.0" + lines-and-columns "^2.0.3" + type-fest "^3.8.0" + +path-exists@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-5.0.0.tgz#a6aad9489200b21fab31e49cf09277e5116fb9e7" + integrity sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ== + +path-key@^3.1.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/path-key/-/path-key-3.1.1.tgz#581f6ade658cbba65a0d3380de7753295054f375" + integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== + +path-scurry@^1.11.1: + version "1.11.1" + resolved "https://registry.yarnpkg.com/path-scurry/-/path-scurry-1.11.1.tgz#7960a668888594a0720b12a911d1a742ab9f11d2" + integrity sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA== + dependencies: + lru-cache "^10.2.0" + minipass "^5.0.0 || ^6.0.2 || ^7.0.0" + +picocolors@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.0.1.tgz#a8ad579b571952f0e5d25892de5445bcfe25aaa1" + integrity sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew== + +picomatch@^2.0.4, picomatch@^2.2.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" + integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== + +pluralize@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/pluralize/-/pluralize-8.0.0.tgz#1a6fa16a38d12a1901e0320fa017051c539ce3b1" + integrity sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA== + +proc-log@^4.0.0, proc-log@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/proc-log/-/proc-log-4.2.0.tgz#b6f461e4026e75fdfe228b265e9f7a00779d7034" + integrity sha512-g8+OnU/L2v+wyiVK+D5fA34J7EH8jZ8DDlvwhRCMxmMj7UCBvxiO1mGeN+36JXIKF4zevU4kRBd8lVgG9vLelA== + +promise-inflight@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/promise-inflight/-/promise-inflight-1.0.1.tgz#98472870bf228132fcbdd868129bad12c3c029e3" + integrity sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g== + +promise-retry@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/promise-retry/-/promise-retry-2.0.1.tgz#ff747a13620ab57ba688f5fc67855410c370da22" + integrity sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g== + dependencies: + err-code "^2.0.2" + retry "^0.12.0" + +punycode@^2.1.0: + version "2.3.1" + resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.1.tgz#027422e2faec0b25e1549c3e1bd8309b9133b6e5" + integrity sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg== + +quotation@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/quotation/-/quotation-2.0.3.tgz#b94c05128209a63b40b4e20e0f8f1a38adea7e0b" + integrity sha512-yEc24TEgCFLXx7D4JHJJkK4JFVtatO8fziwUxY4nB/Jbea9o9CVS3gt22mA0W7rPYAGW2fWzYDSOtD94PwOyqA== + +read-package-json-fast@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/read-package-json-fast/-/read-package-json-fast-3.0.2.tgz#394908a9725dc7a5f14e70c8e7556dff1d2b1049" + integrity sha512-0J+Msgym3vrLOUB3hzQCuZHII0xkNGCtz/HJH9xZshwv9DbDwkw1KaE3gx/e2J5rpEY5rtOy6cyhKOPrkP7FZw== + dependencies: + json-parse-even-better-errors "^3.0.0" + npm-normalize-package-bin "^3.0.0" + +readable-stream@^3.0.2: + version "3.6.2" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.2.tgz#56a9b36ea965c00c5a93ef31eb111a0f11056967" + integrity sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA== + dependencies: + inherits "^2.0.3" + string_decoder "^1.1.1" + util-deprecate "^1.0.1" + +readdirp@~3.6.0: + version "3.6.0" + resolved "https://registry.yarnpkg.com/readdirp/-/readdirp-3.6.0.tgz#74a370bd857116e245b29cc97340cd431a02a6c7" + integrity sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA== + dependencies: + picomatch "^2.2.1" + +remark-cli@12.0.1: + version "12.0.1" + resolved "https://registry.yarnpkg.com/remark-cli/-/remark-cli-12.0.1.tgz#991ede01adfdf0471177c381168105da4b93f99a" + integrity sha512-2NAEOACoTgo+e+YAaCTODqbrWyhMVmlUyjxNCkTrDRHHQvH6+NbrnqVvQaLH/Q8Ket3v90A43dgAJmXv8y5Tkw== + dependencies: + import-meta-resolve "^4.0.0" + markdown-extensions "^2.0.0" + remark "^15.0.0" + unified-args "^11.0.0" + +remark-frontmatter@5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-frontmatter/-/remark-frontmatter-5.0.0.tgz#b68d61552a421ec412c76f4f66c344627dc187a2" + integrity sha512-XTFYvNASMe5iPN0719nPrdItC9aU0ssC4v14mH1BCi1u0n1gAocqcujWUrByftZTbLhRtiKRyjYTSIOcr69UVQ== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-frontmatter "^2.0.0" + micromark-extension-frontmatter "^2.0.0" + unified "^11.0.0" + +remark-lint-blockquote-indentation@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-blockquote-indentation/-/remark-lint-blockquote-indentation-4.0.0.tgz#8b3860881c224d8e3f017ec516acf37dd2df1c03" + integrity sha512-hdUvn+KsJbBKpY9jLY01PmfpJ/WGhLu9GJMXQGU8ADXJc+F5DWSgKAr6GQ1IUKqvGYdEML/KZ61WomWFUuecVA== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-checkbox-character-style@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-checkbox-character-style/-/remark-lint-checkbox-character-style-5.0.0.tgz#f41628a77bb3062391c3c2cdaa639e7be6719416" + integrity sha512-K0G/Nok59fb2q5KUxcemBVt+ymnhTkDVLJAatZ4PAh9At8y0DGctHdU27jWsuvO0Fs7Zy62Usk7IJE2VO89p1w== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-code-block-style@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-code-block-style/-/remark-lint-code-block-style-4.0.0.tgz#cd85582e11a5182fcbca59a1591e39c6867d2bcc" + integrity sha512-LKBKMVruEO0tzDnnnqi1TfUcnwY6Mo7cVtZM4E4pKt3KMhtvgU2wD68/MxDOEJd0pmnLrEgIadv74bY0gWhZpg== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-definition-case@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-definition-case/-/remark-lint-definition-case-4.0.0.tgz#28048d2e75c890bd18e6cc6f7bb9a0e29783566b" + integrity sha512-XBmMmj8ii0KZUuJf7ZaVXDGp2+DWE02re9qn/6mV23rBpsDmpz7U1lQWRlwFQIE5q5bxIxP5pX7hDeTH0Egy9Q== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-definition-spacing@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-definition-spacing/-/remark-lint-definition-spacing-4.0.0.tgz#c12a74bb079efc27d57a852337d87cc42ddc7e50" + integrity sha512-t6nP8unz6z/DLBTWeOmDFHPFbX3E2PbNgt2fTazRbVnMC6z3o25hBzg5hI6DL0MPt2ZTRX++rJsGRjb+vgh/tQ== + dependencies: + "@types/mdast" "^4.0.0" + longest-streak "^3.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-emphasis-marker@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-emphasis-marker/-/remark-lint-emphasis-marker-4.0.0.tgz#9d2f6515116479641ec6e602e3c8e7276a81c165" + integrity sha512-xIRiB4PFWUOyIslN/UOPL6Lh+J0VD4R11+jo+W4hpGMNsg58l+2SgtdbinlXzDeoBxmaaka9n/sYpJ7cJWEIPQ== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-fenced-code-flag@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-fenced-code-flag/-/remark-lint-fenced-code-flag-4.0.0.tgz#32876ea1a53958fba1109c9d8ebe1e890b26f3d9" + integrity sha512-Zs0wJd4nRvBo/9NWQVfWg5Ykapbo0Zzw/SyZc3f0h73S1gTZZcfeU+bA5oDivlBdcUgLBsyHRE0QaoaVvN3/Wg== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + quotation "^2.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-fenced-code-marker@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-fenced-code-marker/-/remark-lint-fenced-code-marker-4.0.0.tgz#eb2587fdc7711fb890e646d5902761c54c2f88ce" + integrity sha512-WFN88Rx78m4/HSbW3Kx2XAYbVfzYns4bJd9qpwDD90DA3nc59zciYd01xi6Bk3n9vSs5gIlmG7xkwxVHHJ8KCA== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-file-extension@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-file-extension/-/remark-lint-file-extension-3.0.0.tgz#2277a9f6d57ea3a824d46487e88003fcea1d20ac" + integrity sha512-wrOKiGvcl/ftB7FkeX2/l13ALvhKXV77HGR8AXo86cVY2pD+K0WdOC52DV3ldgpUXpWzE9kcgF8bbkxwzKpFFg== + dependencies: + "@types/mdast" "^4.0.0" + quotation "^2.0.0" + unified-lint-rule "^3.0.0" + +remark-lint-final-definition@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/remark-lint-final-definition/-/remark-lint-final-definition-4.0.1.tgz#3cdad27cdc03491666efdad24bf03469a70f33f4" + integrity sha512-51T9oSdA7wuhjSdgGo0snO1BY39Igt9cJQi7XpgtgFsbfQk8zSSAUAc/rLabY6+YCTpcPs6qmwvLXZ4mPX6Qlg== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-mdx "^3.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-final-newline@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-final-newline/-/remark-lint-final-newline-3.0.0.tgz#f436b4c228ae088b80072f7c3eac97678232e10a" + integrity sha512-NaPyn6FiOn3IV/6gIcwWfJmgraPT2IaVLjhakfPglZkKVfn/FrOfETyY8Bp+HLoSRI9967OH0yRDnK7/pPIWeQ== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + unified-lint-rule "^3.0.0" + vfile-location "^5.0.0" + +remark-lint-frontmatter-schema@3.15.4: + version "3.15.4" + resolved "https://registry.yarnpkg.com/remark-lint-frontmatter-schema/-/remark-lint-frontmatter-schema-3.15.4.tgz#8ec05a5fe4e08f5077ef66ba91f9639d4cc3a0bb" + integrity sha512-egChkbtCCG4hw1F2qoipzSxp6Ea9z4pxaVkWYa36DnCZ9fn3GhCNyOUjbFSIvdhVcWN+AqvHdqPbXC9Pp81Hmg== + dependencies: + "@apidevtools/json-schema-ref-parser" "11.1.0" + ajv "8.12.0" + ajv-formats "2.1.1" + find-up "6.3.0" + minimatch "9.0.3" + unified-lint-rule "2.1.2" + yaml "2.3.3" + +remark-lint-hard-break-spaces@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-hard-break-spaces/-/remark-lint-hard-break-spaces-4.0.0.tgz#6392f242a4188b346ed196a6e8c6834af1a31c82" + integrity sha512-zCTq7/xfM0ZL3bMopXse9DH2nk38wE1LrxmYwnTrqASBLnEAJWE2U2//tRGVMEBfSAnNvmIo96twz6zkLWjbGA== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit "^5.0.0" + +remark-lint-heading-increment@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-heading-increment/-/remark-lint-heading-increment-4.0.0.tgz#3dfe78334dfafc8e856e5396bc1f9f9ced36e441" + integrity sha512-TARnsjXWzY/yLwxh/y4+KnDSXO3Koue8Crp55T8G9pjj3vw+XgTAG35zSpIIY9HmGiQ2a3R0SOj2pAxATpnckg== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-mdx "^3.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-heading-style@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-heading-style/-/remark-lint-heading-style-4.0.0.tgz#9c7b5b8fb210132ac2db8e541efc10569c2cef66" + integrity sha512-dQ6Jul5K0+aNUvrq4W7H0+osSoC9hsmwHZqBFq000+eMP/hWJqI8tuudw1rap8HHYuOsKLRbB5q+Fr7G+3Vw+Q== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-heading-style "^3.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-link-title-style@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-link-title-style/-/remark-lint-link-title-style-4.0.0.tgz#4f78f9ba7178e095aa15b882e5ecdf720f05942a" + integrity sha512-cihTO5dkhjMj/evYIDAvRdQHD82OQeF4fNAq8FLb81HmFKo77VlSF6CK55H1bvlZogfJG58uN/5d1tSsOdcEbg== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-list-item-bullet-indent@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-list-item-bullet-indent/-/remark-lint-list-item-bullet-indent-5.0.0.tgz#1b2428c49e3220795aafec535e96da85d54d4a26" + integrity sha512-qq22QaxsDjfsL7aWGIPmP3P0N99CJBQQW1+iSrhYAMCDzqVlw6I3wPNAeR6s8mcoeHT8YlT6eQH3V8xJ0SlW6w== + dependencies: + "@types/mdast" "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + +remark-lint-list-item-content-indent@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-list-item-content-indent/-/remark-lint-list-item-content-indent-4.0.0.tgz#2aa75671757ad9b183eec5a334e251d50de8c527" + integrity sha512-L4GZgWQQ54qWKbnDle3dbEOtnq+qdmZJ70lpM3yMFEMHs4xejqPKsIoiYeUtIV0rYHHCWS7IlLzcgYUK9vENQw== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-list-item-indent@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-list-item-indent/-/remark-lint-list-item-indent-4.0.0.tgz#d72e7ef4c7ea238987e5475e33439b7efbe46389" + integrity sha512-Yd6/g8CH9e4vlPAPNgl7F575uKhP+pTo/qwGkE61GOcgEVNJ/529hjumUhyQ4sOAX0YAPAjxvq6fJvb4AhVOOA== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-list-item-spacing@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-list-item-spacing/-/remark-lint-list-item-spacing-5.0.0.tgz#a95a4b8824b3f50f5cd6d5a33f99275f63c04f4f" + integrity sha512-d6p+1tcwNE+Pp6Tu2DwiKlyC1zYY3f1igL6AlcBIH0RmROVEfZR4IDFH/LcVyTkzqh1lPMFAJXWK4bpScpcO3g== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-maximum-heading-length@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-maximum-heading-length/-/remark-lint-maximum-heading-length-4.0.0.tgz#29b6adcc319bde4374429e9e39487d94a476543b" + integrity sha512-UCQxUd0zZyi6RUbpoK5KsxC50ppVqVk0hSgrSPot4wB6PHRgYMALU2fDkEcAjLDc/Y2TayG3IaZEKdqe+84Cwg== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-mdx "^3.0.0" + mdast-util-to-string "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-maximum-line-length@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/remark-lint-maximum-line-length/-/remark-lint-maximum-line-length-4.0.1.tgz#4c5c347b6dd15653aba7ef0cc81971f3dd08a630" + integrity sha512-hQlh8UrRfhkO4FU7z7t1Bu5ethj1y2iBncO5AOWF38RAmlHaZdB2lQxNA8IvUZITGJYpT1aThdFTEf+58lv08Q== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-mdx "^3.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit "^5.0.0" + +remark-lint-no-blockquote-without-marker@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-blockquote-without-marker/-/remark-lint-no-blockquote-without-marker-6.0.0.tgz#cc243d86f6548492150b5a7871f99afad9653973" + integrity sha512-fBhoTpkWcl5tG4FdwPdJIyb8XLrdr6MdLk1+K2BQ6Rom3rRsIYvuox4ohxOunNrXuth8xyw8kC6wDmODR44oFw== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-directive "^3.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-location "^5.0.0" + +remark-lint-no-consecutive-blank-lines@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-consecutive-blank-lines/-/remark-lint-no-consecutive-blank-lines-5.0.0.tgz#bbfbdcdc2e228b6379b7268ac489a56b6e07d1a0" + integrity sha512-HsDZbFlelBVO3mEJDXd9v4z0HLB8pqxWnsV+I4ILYFp5lKYf6NxJaLBWFtP1gAg1+95WxityGLkGtYqmicDjpg== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-directive "^3.0.0" + mdast-util-mdx "^3.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-no-duplicate-definitions@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-duplicate-definitions/-/remark-lint-no-duplicate-definitions-4.0.0.tgz#ac9ff0f7dd373fd58521f57406625e03ef40ce42" + integrity sha512-21fcOACkCyhNsHkedKlpvqIywYx+5zGR507bW8e59gzdGhTbnBwQ9du4ACmN9jxPTfIBhUVMz0bWezkGrHE7Bg== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-no-duplicate-headings@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-duplicate-headings/-/remark-lint-no-duplicate-headings-4.0.0.tgz#0b5b4150b984d68a294359781728d9cca060e2a5" + integrity sha512-FgBU/JCdR5MitHM+hnOcgBGO5ZCNV8epzuHIglFlJeb8ow23YhhNgmGvyk7RGrZrYuU5R9uQq23N4dF0g9atCA== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-mdx "^3.0.0" + mdast-util-to-string "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-no-emphasis-as-heading@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-emphasis-as-heading/-/remark-lint-no-emphasis-as-heading-4.0.0.tgz#85daf2b230ec464f6edd255e80ae36e6a20e0b37" + integrity sha512-JViGYbuO/xzZThK+qVTNjtLM0v1xMTWFTWt2OJzAkDaGS6T9ZB5ZtRVSBFEMG0SF3dvpJwxe+3ABTsuPBdlYsA== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-no-file-name-articles@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-file-name-articles/-/remark-lint-no-file-name-articles-3.0.0.tgz#3061b26a0992331a93c5082f8f2826d5f2c17a2a" + integrity sha512-il4IseupahbV2TVfFjfDVL/EQw7jBWVlMVsv4K2cgl5uPIjiCjFGQypqKnWl6pZDN0oNOs/DE8gBdyuDjldJaA== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + +remark-lint-no-file-name-consecutive-dashes@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-file-name-consecutive-dashes/-/remark-lint-no-file-name-consecutive-dashes-3.0.0.tgz#930d90fe2795afc6fab6b6995235d166b806c4f3" + integrity sha512-3vSI1LOQlu8NSCpWLsKELa8dS9HU+YVZE0U43/DNkdEcnZmlJLpTHQjBTMZUHQipRgoOO+TOSyXFyN/H+2lbuQ== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + +remark-lint-no-file-name-irregular-characters@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-file-name-irregular-characters/-/remark-lint-no-file-name-irregular-characters-3.0.0.tgz#8460f6924ab30200c383f8b1fb9077d3785607bd" + integrity sha512-DhGreliHNU7lLTARQujsaLAn8fUPY0V+H0LSmOUuowBZPtIRWeNdQhunSp96RvsuYdqAdERXe0WuH58i3pRqrg== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + +remark-lint-no-file-name-mixed-case@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-file-name-mixed-case/-/remark-lint-no-file-name-mixed-case-3.0.0.tgz#8b911007d0b9e1e24ec4a93527b03d83b63a6e0c" + integrity sha512-MXXNHdGB6P46itkf8gRP0kxQL85KfAj9YOOBqNtGsgI/8J5rsyM/rz1Ac20Xe+5C5oGi71+7EO/TExKu/+7dfw== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + +remark-lint-no-file-name-outer-dashes@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-file-name-outer-dashes/-/remark-lint-no-file-name-outer-dashes-3.0.0.tgz#9bae02f4ecddb59d20e8977a62deb13ebe3ee230" + integrity sha512-3kgamCp39mdlCtqF/+JLwwS4VpSj5wvVwRythUfrpW7993I9kF67dBsaU545aEzWSK+UJZqjb40i0m2VfnBRfQ== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + +remark-lint-no-heading-content-indent@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-heading-content-indent/-/remark-lint-no-heading-content-indent-5.0.0.tgz#a83956dab3675dfe032ac1a7523d874be6185121" + integrity sha512-psYSlD2BjcVkgpeXOLwPcYFBrbtJWp8E8JX1J4vSfoHPeY6aIxgYxXkf57cjGTApfRL8xawBmMDiF1FgQvpZYg== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-no-heading-punctuation@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-heading-punctuation/-/remark-lint-no-heading-punctuation-4.0.0.tgz#da19bc0fb6d76e443067429b4cc15660bc392d3e" + integrity sha512-7V23C3Q4yX9zEOLZdbv6o8wVxxeWB/F+h9by55zPyk2AwbqF2t2xevnAmN3XFmKZABDTqLwjQxtK6bCVv/S1PQ== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-mdx "^3.0.0" + mdast-util-to-string "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-no-literal-urls@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-literal-urls/-/remark-lint-no-literal-urls-4.0.0.tgz#5b2c40f8ce2c102d823959e7933ae395cd5f8018" + integrity sha512-rl/3Ai4Ax9IH/fRpOJZuXk1HgYX6oFTauhmBOilpqbq/YT2kN3FuXaneXdRfKv1bgMdHaLKxHWxGj/mDyA2n8w== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-to-string "^4.0.0" + micromark-util-character "^2.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-no-multiple-toplevel-headings@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-multiple-toplevel-headings/-/remark-lint-no-multiple-toplevel-headings-4.0.0.tgz#7e9b0a6fdd00e938b0c2dd33744b690d9b3899f8" + integrity sha512-JW11iYxza7asDdhQuKfr8SH1u4NBOCQ4U7Ru0HrKCPcT4y/AB1C1il5uMQzbcervgYPBq69xzyQ24+AJeL0t3A== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-mdx "^3.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-no-shell-dollars@4.0.0, remark-lint-no-shell-dollars@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-shell-dollars/-/remark-lint-no-shell-dollars-4.0.0.tgz#ddc98aaf49a01c408a7b616fe8f6e3dc8e626e15" + integrity sha512-ye2h8FzjsgqqQV0HHN2g9N4FqI3eD9Gpgu7tU5ADIJyQ3mUJdwBoFn7IlGnpmumR1fb/l6u/AhRavIZxXYqG+Q== + dependencies: + "@types/mdast" "^4.0.0" + collapse-white-space "^2.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-no-shortcut-reference-image@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-shortcut-reference-image/-/remark-lint-no-shortcut-reference-image-4.0.0.tgz#eb3aa7aec0d41c64f5a18986cbd3e7e62fa98b7f" + integrity sha512-YEiCpW5F/8/LZyxlOuVK2L/n0NJ1AB0AJK7oP39OVyEk3Xl7w+JQi6nZ3KiH6REh+PWGqKn6M0KEPL9cT/iAOw== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-no-shortcut-reference-link@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-shortcut-reference-link/-/remark-lint-no-shortcut-reference-link-4.0.0.tgz#44c332c3b939dbb9d6b60d9cbcd5929f72658fe7" + integrity sha512-6jka2Zz3I6G2MvDcKrwADYhTOxHMFMK854u1cfBEIH5/XnCCXROtoqiiDtbZw+NJqbmwsBKvGL4t2gnmEJUmgg== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-no-table-indentation@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-table-indentation/-/remark-lint-no-table-indentation-5.0.0.tgz#ce526bc4ff6407378d2b23cbcb6bb8c7f830479a" + integrity sha512-MaLmnzgirpnRiRjWwrsyOX0RmP2eG4YAv169MtsxTVa6O3CpUDwTuTzivudE9L0kVvTlyF9DXEmdyjm85LDyVA== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-location "^5.0.0" + +remark-lint-no-undefined-references@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-undefined-references/-/remark-lint-no-undefined-references-5.0.0.tgz#2155f00a95b793ecac1921f7b45ce7c5d6087256" + integrity sha512-O0q8bHpRHK1T85oqO+uep4BkvQnZZp3y+wahDeeLLq9dCJfF56sq6Tt5OOTt1BAOZlpobS3OPQHUiJWYP6hX1w== + dependencies: + "@types/mdast" "^4.0.0" + collapse-white-space "^2.0.0" + devlop "^1.0.0" + micromark-util-normalize-identifier "^2.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-location "^5.0.0" + +remark-lint-no-unused-definitions@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-no-unused-definitions/-/remark-lint-no-unused-definitions-4.0.0.tgz#fc7f715d084283ca8b3a3c2e7b6afe87ace9765e" + integrity sha512-YCZ6k575NCTx7mnN+9ls0G6YgMsZHi0LYQqfLW8MNVHBtbpTBvfmk8I39bmsvuKWeBD98weZoXSDqIiIGg+Q/g== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + unified-lint-rule "^3.0.0" + unist-util-visit "^5.0.0" + +remark-lint-ordered-list-marker-style@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-ordered-list-marker-style/-/remark-lint-ordered-list-marker-style-4.0.0.tgz#9a6e8867484ec3edf8ec85699e5cca6a11163102" + integrity sha512-xZ7Xppy5fzACH4b9h1b4lTzVtNY2AlUkNTfl1Oe6cIKN8tk3juFxN0wL2RpktPtSZ7iRIabzFmg6l8WPhlASJA== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + micromark-util-character "^2.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-ordered-list-marker-value@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-ordered-list-marker-value/-/remark-lint-ordered-list-marker-value-4.0.0.tgz#a0724a161b2dbcd6dd0be6088e851b3183baab0e" + integrity sha512-7UjNU2Nv9LGEONTU9GPmTVoNoGKD5aL1X2xHzMbSJiTc50bfcazYqZawO+qj1pQ04WPhto1qHnl0HRB5wwSVwA== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-phrasing "^4.0.0" + micromark-util-character "^2.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-rule-style@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-rule-style/-/remark-lint-rule-style-4.0.0.tgz#8634deab41768b467329ff8212e982cef583c3f1" + integrity sha512-Kt7IHMB5IbLgRFKaFUmB895sV3PTD0MBgN9CvXKxr1wHFF43S6tabjFIBSoQqyJRlhH0S3rK6Lvopofa009gLg== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-strong-marker@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-strong-marker/-/remark-lint-strong-marker-4.0.0.tgz#bbaae75846ccea9753a2f6935d1fb9a3114b9461" + integrity sha512-YcvuzakYhQWdCH+1E30sUY+wyvq+PNa77NZAMAYO/cS/pZczFB+q4Ccttw4Q+No/chX8oMfe0GYtm8dDWLei/g== + dependencies: + "@types/mdast" "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-table-cell-padding@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-table-cell-padding/-/remark-lint-table-cell-padding-5.0.0.tgz#652392e3b8c61153023e6c14793b30dd1fb2c6b7" + integrity sha512-LNyiHDQZBIOqcQGG1tYsZHW7g0v8OyRmRgDrD5WEsMaAYfM6EiECUokN/Q4py9h4oM/2KUSrdZbtfuZmy87/kA== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + devlop "^1.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint-table-pipe-alignment@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-table-pipe-alignment/-/remark-lint-table-pipe-alignment-4.0.0.tgz#2eada610d36ef7e7409f5b21e8e308c26e9620a1" + integrity sha512-nx+xpEIWQRLOcq9hIbUIvhSE1NYRmDJmCY3cMoHJ1sIW7dRXMHyWfpWTgu7mpREKwSQdE0q4qnzk8McQQSkIcg== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + devlop "^1.0.0" + mdast-util-phrasing "^4.0.0" + pluralize "^8.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-table-pipes@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-table-pipes/-/remark-lint-table-pipes-5.0.0.tgz#d796f504cf3a2f8b5396b001830492b9eb716758" + integrity sha512-e7jzAScDrt5+eMomh099TZJBN2K9ldDxBu9iYhNu5C0YsdAvnckJkgilsuClxFpmx4LCVYaX0EGbt/hQ3LB3xg== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + +remark-lint-unordered-list-marker-style@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/remark-lint-unordered-list-marker-style/-/remark-lint-unordered-list-marker-style-4.0.0.tgz#91c3a31f795678cd86da8bc5997f924e64920263" + integrity sha512-XlP4Wr4KJNovyWVv0H5axfUlF23iE9Kt2SxaVq4+ieum5YcMmKE6KsL+aqt3kiJb60SH1u6a0bxKFvdM/9riOA== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-phrasing "^4.0.0" + unified-lint-rule "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit-parents "^6.0.0" + vfile-message "^4.0.0" + +remark-lint@^10.0.0: + version "10.0.0" + resolved "https://registry.yarnpkg.com/remark-lint/-/remark-lint-10.0.0.tgz#161b24a18223a68ec2ed8d77e46015b5a0bd8bb5" + integrity sha512-E8yHHDOJ8b+qI0G49BRu24pe8t0fNNBWv8ENQJpCGNrVeTeyBIGEbaUe1yuF7OG8faA6PVpcN/pqWjzW9fcBWQ== + dependencies: + "@types/mdast" "^4.0.0" + remark-message-control "^8.0.0" + unified "^11.0.0" + +remark-message-control@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/remark-message-control/-/remark-message-control-8.0.0.tgz#1d5880f33c05a65fcd60dcf0572b8198e9935d97" + integrity sha512-brpzOO+jdyE/mLqvqqvbogmhGxKygjpCUCG/PwSCU43+JZQ+RM+sSzkCWBcYvgF3KIAVNIoPsvXjBkzO7EdsYQ== + dependencies: + "@types/mdast" "^4.0.0" + mdast-comment-marker "^3.0.0" + unified-message-control "^5.0.0" + vfile "^6.0.0" + +remark-parse@^11.0.0: + version "11.0.0" + resolved "https://registry.yarnpkg.com/remark-parse/-/remark-parse-11.0.0.tgz#aa60743fcb37ebf6b069204eb4da304e40db45a1" + integrity sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-from-markdown "^2.0.0" + micromark-util-types "^2.0.0" + unified "^11.0.0" + +remark-preset-lint-consistent@6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/remark-preset-lint-consistent/-/remark-preset-lint-consistent-6.0.0.tgz#8ee11b681e1d40f1fd7a5ca1cf2c832df306db56" + integrity sha512-W3fwxajdietwjnFyTH5x2le63hxWGVOXxIs7KjRqU+5wkkN6ZQyuwPeeomblmS9wQr50fkidhXNHNDyCXtqgxQ== + dependencies: + remark-lint "^10.0.0" + remark-lint-blockquote-indentation "^4.0.0" + remark-lint-checkbox-character-style "^5.0.0" + remark-lint-code-block-style "^4.0.0" + remark-lint-emphasis-marker "^4.0.0" + remark-lint-fenced-code-marker "^4.0.0" + remark-lint-heading-style "^4.0.0" + remark-lint-link-title-style "^4.0.0" + remark-lint-list-item-content-indent "^4.0.0" + remark-lint-ordered-list-marker-style "^4.0.0" + remark-lint-ordered-list-marker-value "^4.0.0" + remark-lint-rule-style "^4.0.0" + remark-lint-strong-marker "^4.0.0" + remark-lint-table-cell-padding "^5.0.0" + unified "^11.0.0" + +remark-preset-lint-markdown-style-guide@6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/remark-preset-lint-markdown-style-guide/-/remark-preset-lint-markdown-style-guide-6.0.0.tgz#f6f186d94391a5e8c9752a63a0c41a7a14b2464a" + integrity sha512-izsfNTHeqrRP64VWV6OdJnSUDwKFSthMKiiDcu14ODpPV0t7YiotCQWzgc7L4eW9Ctcp4aB4nHNLSuDmwhEWrQ== + dependencies: + remark-lint "^10.0.0" + remark-lint-blockquote-indentation "^4.0.0" + remark-lint-code-block-style "^4.0.0" + remark-lint-definition-case "^4.0.0" + remark-lint-definition-spacing "^4.0.0" + remark-lint-emphasis-marker "^4.0.0" + remark-lint-fenced-code-flag "^4.0.0" + remark-lint-fenced-code-marker "^4.0.0" + remark-lint-file-extension "^3.0.0" + remark-lint-final-definition "^4.0.0" + remark-lint-hard-break-spaces "^4.0.0" + remark-lint-heading-increment "^4.0.0" + remark-lint-heading-style "^4.0.0" + remark-lint-link-title-style "^4.0.0" + remark-lint-list-item-content-indent "^4.0.0" + remark-lint-list-item-indent "^4.0.0" + remark-lint-list-item-spacing "^5.0.0" + remark-lint-maximum-heading-length "^4.0.0" + remark-lint-maximum-line-length "^4.0.0" + remark-lint-no-blockquote-without-marker "^6.0.0" + remark-lint-no-consecutive-blank-lines "^5.0.0" + remark-lint-no-duplicate-headings "^4.0.0" + remark-lint-no-emphasis-as-heading "^4.0.0" + remark-lint-no-file-name-articles "^3.0.0" + remark-lint-no-file-name-consecutive-dashes "^3.0.0" + remark-lint-no-file-name-irregular-characters "^3.0.0" + remark-lint-no-file-name-mixed-case "^3.0.0" + remark-lint-no-file-name-outer-dashes "^3.0.0" + remark-lint-no-heading-punctuation "^4.0.0" + remark-lint-no-literal-urls "^4.0.0" + remark-lint-no-multiple-toplevel-headings "^4.0.0" + remark-lint-no-shell-dollars "^4.0.0" + remark-lint-no-shortcut-reference-image "^4.0.0" + remark-lint-no-shortcut-reference-link "^4.0.0" + remark-lint-no-table-indentation "^5.0.0" + remark-lint-ordered-list-marker-style "^4.0.0" + remark-lint-ordered-list-marker-value "^4.0.0" + remark-lint-rule-style "^4.0.0" + remark-lint-strong-marker "^4.0.0" + remark-lint-table-cell-padding "^5.0.0" + remark-lint-table-pipe-alignment "^4.0.0" + remark-lint-table-pipes "^5.0.0" + remark-lint-unordered-list-marker-style "^4.0.0" + unified "^11.0.0" + +remark-preset-lint-recommended@7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/remark-preset-lint-recommended/-/remark-preset-lint-recommended-7.0.0.tgz#fec4288b9a148f63fb04f3f447bc0db1049ec835" + integrity sha512-A9aPDL78OO12xG2a83DVd+M2QzdBMjn545fbXj40BFJdpt9t//MADkPAwRfpMCBkKi+iECPUTFCb3Jm8SsFG2w== + dependencies: + remark-lint "^10.0.0" + remark-lint-final-newline "^3.0.0" + remark-lint-hard-break-spaces "^4.0.0" + remark-lint-list-item-bullet-indent "^5.0.0" + remark-lint-list-item-indent "^4.0.0" + remark-lint-no-blockquote-without-marker "^6.0.0" + remark-lint-no-duplicate-definitions "^4.0.0" + remark-lint-no-heading-content-indent "^5.0.0" + remark-lint-no-literal-urls "^4.0.0" + remark-lint-no-shortcut-reference-image "^4.0.0" + remark-lint-no-shortcut-reference-link "^4.0.0" + remark-lint-no-undefined-references "^5.0.0" + remark-lint-no-unused-definitions "^4.0.0" + remark-lint-ordered-list-marker-style "^4.0.0" + unified "^11.0.0" + +remark-stringify@^11.0.0: + version "11.0.0" + resolved "https://registry.yarnpkg.com/remark-stringify/-/remark-stringify-11.0.0.tgz#4c5b01dd711c269df1aaae11743eb7e2e7636fd3" + integrity sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-to-markdown "^2.0.0" + unified "^11.0.0" + +remark@^15.0.0: + version "15.0.1" + resolved "https://registry.yarnpkg.com/remark/-/remark-15.0.1.tgz#ac7e7563260513b66426bc47f850e7aa5862c37c" + integrity sha512-Eht5w30ruCXgFmxVUSlNWQ9iiimq07URKeFS3hNc8cUWy1llX4KDWfyEDZRycMc+znsN9Ux5/tJ/BFdgdOwA3A== + dependencies: + "@types/mdast" "^4.0.0" + remark-parse "^11.0.0" + remark-stringify "^11.0.0" + unified "^11.0.0" + +require-from-string@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/require-from-string/-/require-from-string-2.0.2.tgz#89a7fdd938261267318eafe14f9c32e598c36909" + integrity sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw== + +retry@^0.12.0: + version "0.12.0" + resolved "https://registry.yarnpkg.com/retry/-/retry-0.12.0.tgz#1b42a6266a21f07421d1b0b54b7dc167b01c013b" + integrity sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow== + +safe-buffer@~5.2.0: + version "5.2.1" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6" + integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== + +semver@^7.1.1, semver@^7.3.5, semver@^7.5.3: + version "7.6.3" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.6.3.tgz#980f7b5550bc175fb4dc09403085627f9eb33143" + integrity sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A== + +shebang-command@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-2.0.0.tgz#ccd0af4f8835fbdc265b82461aaf0c36663f34ea" + integrity sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA== + dependencies: + shebang-regex "^3.0.0" + +shebang-regex@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" + integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== + +signal-exit@^4.0.1: + version "4.1.0" + resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-4.1.0.tgz#952188c1cbd546070e2dd20d0f41c0ae0530cb04" + integrity sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw== + +space-separated-tokens@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz#1ecd9d2350a3844572c3f4a312bceb018348859f" + integrity sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q== + +spdx-correct@^3.0.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/spdx-correct/-/spdx-correct-3.2.0.tgz#4f5ab0668f0059e34f9c00dce331784a12de4e9c" + integrity sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA== + dependencies: + spdx-expression-parse "^3.0.0" + spdx-license-ids "^3.0.0" + +spdx-exceptions@^2.1.0: + version "2.5.0" + resolved "https://registry.yarnpkg.com/spdx-exceptions/-/spdx-exceptions-2.5.0.tgz#5d607d27fc806f66d7b64a766650fa890f04ed66" + integrity sha512-PiU42r+xO4UbUS1buo3LPJkjlO7430Xn5SVAhdpzzsPHsjbYVflnnFdATgabnLude+Cqu25p6N+g2lw/PFsa4w== + +spdx-expression-parse@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz#cf70f50482eefdc98e3ce0a6833e4a53ceeba679" + integrity sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q== + dependencies: + spdx-exceptions "^2.1.0" + spdx-license-ids "^3.0.0" + +spdx-license-ids@^3.0.0: + version "3.0.18" + resolved "https://registry.yarnpkg.com/spdx-license-ids/-/spdx-license-ids-3.0.18.tgz#22aa922dcf2f2885a6494a261f2d8b75345d0326" + integrity sha512-xxRs31BqRYHwiMzudOrpSiHtZ8i/GeionCBDSilhYRj+9gIcI8wCZTlXZKu9vZIVqViP3dcp9qE5G6AlIaD+TQ== + +"string-width-cjs@npm:string-width@^4.2.0": + version "4.2.3" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" + integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.1" + +string-width@^4.1.0: + version "4.2.3" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" + integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.1" + +string-width@^5.0.1, string-width@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-5.1.2.tgz#14f8daec6d81e7221d2a357e668cab73bdbca794" + integrity sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA== + dependencies: + eastasianwidth "^0.2.0" + emoji-regex "^9.2.2" + strip-ansi "^7.0.1" + +string-width@^6.0.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-6.1.0.tgz#96488d6ed23f9ad5d82d13522af9e4c4c3fd7518" + integrity sha512-k01swCJAgQmuADB0YIc+7TuatfNvTBVOoaUWJjTB9R4VJzR5vNWzf5t42ESVZFPS8xTySF7CAdV4t/aaIm3UnQ== + dependencies: + eastasianwidth "^0.2.0" + emoji-regex "^10.2.1" + strip-ansi "^7.0.1" + +string_decoder@^1.1.1: + version "1.3.0" + resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.3.0.tgz#42f114594a46cf1a8e30b0a84f56c78c3edac21e" + integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== + dependencies: + safe-buffer "~5.2.0" + +stringify-entities@^4.0.0: + version "4.0.4" + resolved "https://registry.yarnpkg.com/stringify-entities/-/stringify-entities-4.0.4.tgz#b3b79ef5f277cc4ac73caeb0236c5ba939b3a4f3" + integrity sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg== + dependencies: + character-entities-html4 "^2.0.0" + character-entities-legacy "^3.0.0" + +"strip-ansi-cjs@npm:strip-ansi@^6.0.1": + version "6.0.1" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" + integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== + dependencies: + ansi-regex "^5.0.1" + +strip-ansi@^6.0.0, strip-ansi@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" + integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== + dependencies: + ansi-regex "^5.0.1" + +strip-ansi@^7.0.0, strip-ansi@^7.0.1: + version "7.1.0" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.1.0.tgz#d5b6568ca689d8561370b0707685d22434faff45" + integrity sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ== + dependencies: + ansi-regex "^6.0.1" + +supports-color@^5.3.0: + version "5.5.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" + integrity sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow== + dependencies: + has-flag "^3.0.0" + +supports-color@^9.0.0: + version "9.4.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-9.4.0.tgz#17bfcf686288f531db3dea3215510621ccb55954" + integrity sha512-VL+lNrEoIXww1coLPOmiEmK/0sGigko5COxI09KzHc2VJXJsQ37UaQ+8quuxjDeA7+KnLGTWRyOXSLLR2Wb4jw== + +text-table@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/text-table/-/text-table-0.2.0.tgz#7f5ee823ae805207c00af2df4a84ec3fcfa570b4" + integrity sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw== + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +trough@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/trough/-/trough-2.2.0.tgz#94a60bd6bd375c152c1df911a4b11d5b0256f50f" + integrity sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw== + +type-fest@^3.8.0: + version "3.13.1" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-3.13.1.tgz#bb744c1f0678bea7543a2d1ec24e83e68e8c8706" + integrity sha512-tLq3bSNx+xSpwvAJnzrK0Ep5CLNWjvFTOp71URMaAEWBfRb9nnJiBoUe0tF8bI4ZFO3omgBR6NvnbzVUT3Ly4g== + +typedarray@^0.0.6: + version "0.0.6" + resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" + integrity sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA== + +undici-types@~5.26.4: + version "5.26.5" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-5.26.5.tgz#bcd539893d00b56e964fd2657a4866b221a65617" + integrity sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA== + +undici-types@~6.11.1: + version "6.11.1" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.11.1.tgz#432ea6e8efd54a48569705a699e62d8f4981b197" + integrity sha512-mIDEX2ek50x0OlRgxryxsenE5XaQD4on5U2inY7RApK3SOJpofyw7uW2AyfMKkhAxXIceo2DeWGVGwyvng1GNQ== + +unified-args@^11.0.0: + version "11.0.1" + resolved "https://registry.yarnpkg.com/unified-args/-/unified-args-11.0.1.tgz#5c82564616288b8d99feed7326c2223097d30726" + integrity sha512-WEQghE91+0s3xPVs0YW6a5zUduNLjmANswX7YbBfksHNDGMjHxaWCql4SR7c9q0yov/XiIEdk6r/LqfPjaYGcw== + dependencies: + "@types/text-table" "^0.2.0" + chalk "^5.0.0" + chokidar "^3.0.0" + comma-separated-tokens "^2.0.0" + json5 "^2.0.0" + minimist "^1.0.0" + strip-ansi "^7.0.0" + text-table "^0.2.0" + unified-engine "^11.0.0" + +unified-engine@^11.0.0: + version "11.2.1" + resolved "https://registry.yarnpkg.com/unified-engine/-/unified-engine-11.2.1.tgz#8f9c05b3f262930666b1cdb83108c15dd39d6cdd" + integrity sha512-xBAdZ8UY2X4R9Hm6X6kMne4Nz0PlpOc1oE6DPeqJnewr5Imkb8uT5Eyvy1h7xNekPL3PSWh3ZJyNrMW6jnNQBg== + dependencies: + "@types/concat-stream" "^2.0.0" + "@types/debug" "^4.0.0" + "@types/is-empty" "^1.0.0" + "@types/node" "^20.0.0" + "@types/unist" "^3.0.0" + concat-stream "^2.0.0" + debug "^4.0.0" + extend "^3.0.0" + glob "^10.0.0" + ignore "^5.0.0" + is-empty "^1.0.0" + is-plain-obj "^4.0.0" + load-plugin "^6.0.0" + parse-json "^7.0.0" + trough "^2.0.0" + unist-util-inspect "^8.0.0" + vfile "^6.0.0" + vfile-message "^4.0.0" + vfile-reporter "^8.0.0" + vfile-statistics "^3.0.0" + yaml "^2.0.0" + +unified-lint-rule@2.1.2: + version "2.1.2" + resolved "https://registry.yarnpkg.com/unified-lint-rule/-/unified-lint-rule-2.1.2.tgz#3ca2c6199b84aa8b48b60fda0f61b8eba55807d5" + integrity sha512-JWudPtRN7TLFHVLEVZ+Rm8FUb6kCAtHxEXFgBGDxRSdNMnGyTU5zyYvduHSF/liExlFB3vdFvsAHnNVE/UjAwA== + dependencies: + "@types/unist" "^2.0.0" + trough "^2.0.0" + unified "^10.0.0" + vfile "^5.0.0" + +unified-lint-rule@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/unified-lint-rule/-/unified-lint-rule-3.0.0.tgz#75f8d7fbd9664e198a65f1399ab06c3950b54a70" + integrity sha512-Sz96ILLsTy3djsG3H44zFb2b77MFf9CQVYnV3PWkxgRX8/n31fFrr+JnzUaJ6cbOHTtZnL1A71+YodsTjzwAew== + dependencies: + "@types/unist" "^3.0.0" + trough "^2.0.0" + unified "^11.0.0" + vfile "^6.0.0" + +unified-message-control@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/unified-message-control/-/unified-message-control-5.0.0.tgz#7268a9a5d695c2591149ebe35e37eb200b852d7e" + integrity sha512-B2cSAkpuMVVmPP90KCfKdBhm1e9KYJ+zK3x5BCa0N65zpq1Ybkc9C77+M5qwR8FWO7RF3LM5QRRPZtgjW6DUCw== + dependencies: + "@types/unist" "^3.0.0" + devlop "^1.0.0" + space-separated-tokens "^2.0.0" + unist-util-is "^6.0.0" + unist-util-visit "^5.0.0" + vfile "^6.0.0" + vfile-location "^5.0.0" + vfile-message "^4.0.0" + +unified@^10.0.0: + version "10.1.2" + resolved "https://registry.yarnpkg.com/unified/-/unified-10.1.2.tgz#b1d64e55dafe1f0b98bb6c719881103ecf6c86df" + integrity sha512-pUSWAi/RAnVy1Pif2kAoeWNBa3JVrx0MId2LASj8G+7AiHWoKZNTomq6LG326T68U7/e263X6fTdcXIy7XnF7Q== + dependencies: + "@types/unist" "^2.0.0" + bail "^2.0.0" + extend "^3.0.0" + is-buffer "^2.0.0" + is-plain-obj "^4.0.0" + trough "^2.0.0" + vfile "^5.0.0" + +unified@^11.0.0: + version "11.0.5" + resolved "https://registry.yarnpkg.com/unified/-/unified-11.0.5.tgz#f66677610a5c0a9ee90cab2b8d4d66037026d9e1" + integrity sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA== + dependencies: + "@types/unist" "^3.0.0" + bail "^2.0.0" + devlop "^1.0.0" + extend "^3.0.0" + is-plain-obj "^4.0.0" + trough "^2.0.0" + vfile "^6.0.0" + +unist-util-inspect@^8.0.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/unist-util-inspect/-/unist-util-inspect-8.1.0.tgz#ff2729b543c483041b3c29cbe04c5460a406ee25" + integrity sha512-mOlg8Mp33pR0eeFpo5d2902ojqFFOKMMG2hF8bmH7ZlhnmjFgh0NI3/ZDwdaBJNbvrS7LZFVrBVtIE9KZ9s7vQ== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-is@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/unist-util-is/-/unist-util-is-6.0.0.tgz#b775956486aff107a9ded971d996c173374be424" + integrity sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-position@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/unist-util-position/-/unist-util-position-5.0.0.tgz#678f20ab5ca1207a97d7ea8a388373c9cf896be4" + integrity sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-remove-position@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/unist-util-remove-position/-/unist-util-remove-position-5.0.0.tgz#fea68a25658409c9460408bc6b4991b965b52163" + integrity sha512-Hp5Kh3wLxv0PHj9m2yZhhLt58KzPtEYKQQ4yxfYFEO7EvHwzyDYnduhHnY1mDxoqr7VUwVuHXk9RXKIiYS1N8Q== + dependencies: + "@types/unist" "^3.0.0" + unist-util-visit "^5.0.0" + +unist-util-stringify-position@^3.0.0: + version "3.0.3" + resolved "https://registry.yarnpkg.com/unist-util-stringify-position/-/unist-util-stringify-position-3.0.3.tgz#03ad3348210c2d930772d64b489580c13a7db39d" + integrity sha512-k5GzIBZ/QatR8N5X2y+drfpWG8IDBzdnVj6OInRNWm1oXrzydiaAT2OQiA8DPRRZyAKb9b6I2a6PxYklZD0gKg== + dependencies: + "@types/unist" "^2.0.0" + +unist-util-stringify-position@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz#449c6e21a880e0855bf5aabadeb3a740314abac2" + integrity sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-visit-parents@^6.0.0: + version "6.0.1" + resolved "https://registry.yarnpkg.com/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz#4d5f85755c3b8f0dc69e21eca5d6d82d22162815" + integrity sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw== + dependencies: + "@types/unist" "^3.0.0" + unist-util-is "^6.0.0" + +unist-util-visit@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/unist-util-visit/-/unist-util-visit-5.0.0.tgz#a7de1f31f72ffd3519ea71814cccf5fd6a9217d6" + integrity sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg== + dependencies: + "@types/unist" "^3.0.0" + unist-util-is "^6.0.0" + unist-util-visit-parents "^6.0.0" + +uri-js@^4.2.2: + version "4.4.1" + resolved "https://registry.yarnpkg.com/uri-js/-/uri-js-4.4.1.tgz#9b1a52595225859e55f669d928f88c6c57f2a77e" + integrity sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== + dependencies: + punycode "^2.1.0" + +util-deprecate@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" + integrity sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw== + +validate-npm-package-license@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz#fc91f6b9c7ba15c857f4cb2c5defeec39d4f410a" + integrity sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew== + dependencies: + spdx-correct "^3.0.0" + spdx-expression-parse "^3.0.0" + +validate-npm-package-name@^5.0.0: + version "5.0.1" + resolved "https://registry.yarnpkg.com/validate-npm-package-name/-/validate-npm-package-name-5.0.1.tgz#a316573e9b49f3ccd90dbb6eb52b3f06c6d604e8" + integrity sha512-OljLrQ9SQdOUqTaQxqL5dEfZWrXExyyWsozYlAWFawPVNuD83igl7uJD2RTkNMbniIYgt8l81eCJGIdQF7avLQ== + +vfile-location@^5.0.0: + version "5.0.3" + resolved "https://registry.yarnpkg.com/vfile-location/-/vfile-location-5.0.3.tgz#cb9eacd20f2b6426d19451e0eafa3d0a846225c3" + integrity sha512-5yXvWDEgqeiYiBe1lbxYF7UMAIm/IcopxMHrMQDq3nvKcjPKIhZklUKL+AE7J7uApI4kwe2snsK+eI6UTj9EHg== + dependencies: + "@types/unist" "^3.0.0" + vfile "^6.0.0" + +vfile-message@^3.0.0: + version "3.1.4" + resolved "https://registry.yarnpkg.com/vfile-message/-/vfile-message-3.1.4.tgz#15a50816ae7d7c2d1fa87090a7f9f96612b59dea" + integrity sha512-fa0Z6P8HUrQN4BZaX05SIVXic+7kE3b05PWAtPuYP9QLHsLKYR7/AlLW3NtOrpXRLeawpDLMsVkmk5DG0NXgWw== + dependencies: + "@types/unist" "^2.0.0" + unist-util-stringify-position "^3.0.0" + +vfile-message@^4.0.0: + version "4.0.2" + resolved "https://registry.yarnpkg.com/vfile-message/-/vfile-message-4.0.2.tgz#c883c9f677c72c166362fd635f21fc165a7d1181" + integrity sha512-jRDZ1IMLttGj41KcZvlrYAaI3CfqpLpfpf+Mfig13viT6NKvRzWZ+lXz0Y5D60w6uJIBAOGq9mSHf0gktF0duw== + dependencies: + "@types/unist" "^3.0.0" + unist-util-stringify-position "^4.0.0" + +vfile-reporter@^8.0.0: + version "8.1.1" + resolved "https://registry.yarnpkg.com/vfile-reporter/-/vfile-reporter-8.1.1.tgz#ac06a5a68f1b480609c443062dffea1cfa2d11b1" + integrity sha512-qxRZcnFSQt6pWKn3PAk81yLK2rO2i7CDXpy8v8ZquiEOMLSnPw6BMSi9Y1sUCwGGl7a9b3CJT1CKpnRF7pp66g== + dependencies: + "@types/supports-color" "^8.0.0" + string-width "^6.0.0" + supports-color "^9.0.0" + unist-util-stringify-position "^4.0.0" + vfile "^6.0.0" + vfile-message "^4.0.0" + vfile-sort "^4.0.0" + vfile-statistics "^3.0.0" + +vfile-sort@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/vfile-sort/-/vfile-sort-4.0.0.tgz#fa1929065b62fe5311e5391c9434f745e8641703" + integrity sha512-lffPI1JrbHDTToJwcq0rl6rBmkjQmMuXkAxsZPRS9DXbaJQvc642eCg6EGxcX2i1L+esbuhq+2l9tBll5v8AeQ== + dependencies: + vfile "^6.0.0" + vfile-message "^4.0.0" + +vfile-statistics@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/vfile-statistics/-/vfile-statistics-3.0.0.tgz#0f5cd00c611c1862b13a9b5bc5599efaf465f2cf" + integrity sha512-/qlwqwWBWFOmpXujL/20P+Iuydil0rZZNglR+VNm6J0gpLHwuVM5s7g2TfVoswbXjZ4HuIhLMySEyIw5i7/D8w== + dependencies: + vfile "^6.0.0" + vfile-message "^4.0.0" + +vfile@^5.0.0: + version "5.3.7" + resolved "https://registry.yarnpkg.com/vfile/-/vfile-5.3.7.tgz#de0677e6683e3380fafc46544cfe603118826ab7" + integrity sha512-r7qlzkgErKjobAmyNIkkSpizsFPYiUPuJb5pNW1RB4JcYVZhs4lIbVqk8XPk033CV/1z8ss5pkax8SuhGpcG8g== + dependencies: + "@types/unist" "^2.0.0" + is-buffer "^2.0.0" + unist-util-stringify-position "^3.0.0" + vfile-message "^3.0.0" + +vfile@^6.0.0: + version "6.0.2" + resolved "https://registry.yarnpkg.com/vfile/-/vfile-6.0.2.tgz#ef49548ea3d270097a67011921411130ceae7deb" + integrity sha512-zND7NlS8rJYb/sPqkb13ZvbbUoExdbi4w3SfRrMq6R3FvnLQmmfpajJNITuuYm6AZ5uao9vy4BAos3EXBPf2rg== + dependencies: + "@types/unist" "^3.0.0" + unist-util-stringify-position "^4.0.0" + vfile-message "^4.0.0" + +walk-up-path@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/walk-up-path/-/walk-up-path-3.0.1.tgz#c8d78d5375b4966c717eb17ada73dbd41490e886" + integrity sha512-9YlCL/ynK3CTlrSRrDxZvUauLzAswPCrsaCgilqFevUYpeEW0/3ScEjaa3kbW/T0ghhkEr7mv+fpjqn1Y1YuTA== + +which@^2.0.1: + version "2.0.2" + resolved "https://registry.yarnpkg.com/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1" + integrity sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA== + dependencies: + isexe "^2.0.0" + +which@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/which/-/which-4.0.0.tgz#cd60b5e74503a3fbcfbf6cd6b4138a8bae644c1a" + integrity sha512-GlaYyEb07DPxYCKhKzplCWBJtvxZcZMrL+4UkrTSJHHPyZU4mYYTv3qaOe77H7EODLSSopAUFAc6W8U4yqvscg== + dependencies: + isexe "^3.1.1" + +"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0": + version "7.0.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" + integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +wrap-ansi@^8.1.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-8.1.0.tgz#56dc22368ee570face1b49819975d9b9a5ead214" + integrity sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ== + dependencies: + ansi-styles "^6.1.0" + string-width "^5.0.1" + strip-ansi "^7.0.1" + +yaml@2.3.3: + version "2.3.3" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.3.3.tgz#01f6d18ef036446340007db8e016810e5d64aad9" + integrity sha512-zw0VAJxgeZ6+++/su5AFoqBbZbrEakwu+X0M5HmcwUiBL7AzcuPKjj5we4xfQLp78LkEMpD0cOnUhmgOVy3KdQ== + +yaml@^2.0.0: + version "2.5.0" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.5.0.tgz#c6165a721cf8000e91c36490a41d7be25176cf5d" + integrity sha512-2wWLbGbYDiSqqIKoPjar3MPgB94ErzCtrNE1FdqGuaO0pi2JGjmE8aW8TDZwzU7vuxcGRdL/4gPQwQ7hD5AMSw== + +yocto-queue@^1.0.0: + version "1.1.1" + resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-1.1.1.tgz#fef65ce3ac9f8a32ceac5a634f74e17e5b232110" + integrity sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g== + +zwitch@^2.0.0: + version "2.0.4" + resolved "https://registry.yarnpkg.com/zwitch/-/zwitch-2.0.4.tgz#c827d4b0acb76fc3e685a4c6ec2902d51070e9d7" + integrity sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A== diff --git a/compose.yaml b/compose.yaml index 2a03f144e..3dd3e03da 100644 --- a/compose.yaml +++ b/compose.yaml @@ -363,6 +363,17 @@ services: - type: volume source: influxdb2-config target: /etc/influxdb2 + remark-lint: + build: + context: . + dockerfile: .ci/Dockerfile.remark + command: ["remark", "content/${PRODUCT_PATH}"] + profiles: + - lint + volumes: + - type: bind + source: ./content + target: /app/content volumes: test-content: cloud-tmp: diff --git a/content/.remarkrc.yaml b/content/.remarkrc.yaml new file mode 100644 index 000000000..48bb1a365 --- /dev/null +++ b/content/.remarkrc.yaml @@ -0,0 +1,13 @@ +settings: + bullet: "-" + +plugins: + # Before you can configure plugins for remark here, you need to add them to + # the `devDependencies` in the `package.json` file--for CI: `/.ci/app/package.json`. + - remark-frontmatter + - remark-lint-frontmatter-schema + - remark-lint-no-shell-dollars + # Check that markdown is consistent (list items have the same indentation) + - remark-preset-lint-consistent + # - remark-preset-lint-markdown-style-guide + # - remark-preset-lint-recommended \ No newline at end of file From 66b0ddff049813cd745a07366199865a83f42569 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 30 Jul 2024 13:57:19 -0500 Subject: [PATCH 63/96] feat(v3): Port Java client library examples to Dedicated and Clustered. - Fixes Serverless examples and adds references. - Ports the previously published Serverless Java reference to Dedicated and Clustered. --- .../reference/client-libraries/v3/java.md | 350 +++++++++++++++++- .../reference/client-libraries/v3/java.md | 119 ++++-- .../reference/client-libraries/v3/java.md | 349 ++++++++++++++++- 3 files changed, 772 insertions(+), 46 deletions(-) diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/java.md b/content/influxdb/cloud-dedicated/reference/client-libraries/v3/java.md index ca1a19ee5..f31a946d1 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-dedicated/reference/client-libraries/v3/java.md @@ -3,7 +3,6 @@ title: Java client library for InfluxDB v3 list_title: Java description: > The InfluxDB v3 `influxdb3-java` Java client library integrates with application code to write and query data stored in an InfluxDB Cloud Dedicated database. -external_url: https://github.com/InfluxCommunity/influxdb3-java menu: influxdb_cloud_dedicated: name: Java @@ -13,9 +12,350 @@ influxdb/cloud-dedicated/tags: [Flight client, Java, gRPC, SQL, Flight SQL, clie weight: 201 --- -The InfluxDB v3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates with Java application code -to write and query data stored in an {{% product-name %}} database. +The InfluxDB v3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates +with Java application code to write and query data stored in {{% product-name %}}. -The documentation for this client library is available on GitHub. +InfluxDB client libraries provide configurable batch writing of data to {{% product-name %}}. +Use client libraries to construct line protocol data, transform data from other formats +to line protocol, and batch write line protocol data to InfluxDB HTTP APIs. -InfluxDB v3 Java client library +InfluxDB v3 client libraries can query {{% product-name %}} using SQL or InfluxQL. +The `influxdb3-java` Java client library wraps the Apache Arrow `org.apache.arrow.flight.FlightClient` +in a convenient InfluxDB v3 interface for executing SQL and InfluxQL queries, requesting +server metadata, and retrieving data from {{% product-name %}} using the Flight protocol with gRPC. + +- [Installation](#installation) + - [Using Maven](#using-maven) + - [Using Gradle](#using-gradle) +- [Importing the client](#importing-the-client) +- [API reference](#api-reference) +- [Classes](#classes) +- [InfluxDBClient interface](#influxdbclient-interface) + - [Initialize with credential parameters](#initialize-with-credential-parameters) + - [InfluxDBClient instance methods](#influxdbclient-instance-methods) + - [InfluxDBClient.writePoint](#influxdbclientwritepoint) + - [InfluxDBClient.query](#influxdbclientquery) + + +#### Example: write and query data + +The following example shows how to use `influxdb3-java` to write and query data stored in {{% product-name %}}. + +{{% code-placeholders "DATABASE_NAME | DATABASE_TOKEN" %}} + +```java +package com.influxdata.demo; + +import com.influxdb.v3.client.InfluxDBClient; +import com.influxdb.v3.client.Point; +import com.influxdb.v3.client.query.QueryOptions; +import com.influxdb.v3.client.query.QueryType; + +import java.time.Instant; +import java.util.stream.Stream; + +public class HelloInfluxDB { + private static final String HOST_URL = "https://{{< influxdb/host >}}"; // your cluster URL + private static final String DATABASE = "DATABASE_NAME"; // your InfluxDB database name + private static final char[] TOKEN = System.getenv("DATABASE_TOKEN"); // a local environment variable that stores your database token + + // Create a client instance that writes and queries data in your database. + public static void main(String[] args) { + // Instantiate the client with your InfluxDB credentials + try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, TOKEN, DATABASE)) { + writeData(client); + queryData(client); + } + catch (Exception e) { + System.err.println("An error occurred while connecting to InfluxDB!"); + e.printStackTrace(); + } + } + + // Use the Point class to construct time series data. + private static void writeData(InfluxDBClient client) { + Point point = Point.measurement("temperature") + .setTag("location", "London") + .setField("value", 30.01) + .setTimestamp(Instant.now().minusSeconds(10)); + try { + client.writePoint(point); + System.out.println("Data is written to the database."); + } + catch (Exception e) { + System.err.println("Failed to write data to the database."); + e.printStackTrace(); + } + } + + // Use SQL to query the most recent 10 measurements + private static void queryData(InfluxDBClient client) { + System.out.printf("--------------------------------------------------------%n"); + System.out.printf("| %-8s | %-8s | %-30s |%n", "location", "value", "time"); + System.out.printf("--------------------------------------------------------%n"); + + String sql = "select time,location,value from temperature order by time desc limit 10"; + try (Stream stream = client.query(sql)) { + stream.forEach(row -> System.out.printf("| %-8s | %-8s | %-30s |%n", row[1], row[2], row[0])); + } + catch (Exception e) { + System.err.println("Failed to query data from the database."); + e.printStackTrace(); + } + } +} +``` + +{{% cite %}}Source: [suyashcjoshi/SimpleJavaInfluxDB](https://github.com/suyashcjoshi/SimpleJavaInfluxDB/) on GitHub{{% /cite %}} + +{{% /code-placeholders %}} + +Replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + the name of your {{% product-name %}} + [database](/influxdb/cloud-dedicated/admin/databases/) to read and write data to +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a + local environment variable that stores your + [token](/influxdb/cloud-dedicated/admin/tokens/database/)--the token must have + read and write permissions on the specified database. + +### Run the example to write and query data + +1. Build an executable JAR for the project--for example, using Maven: + + + + ```bash + mvn package + ``` + +2. In your terminal, run the `java` command to write and query data in your database: + + + + ```bash + java \ + --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED \ + -jar target/PROJECT_NAME.jar + ``` + + Include the following in your command: + + - [`--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED`](https://arrow.apache.org/docs/java/install.html#id3): with Java version 9 or later and Apache Arrow version 16 or later, exposes JDK internals for Arrow. + For more options, see the [Apache Arrow Java install documentation](https://arrow.apache.org/docs/java/install.html). + - `-jar target/PROJECT_NAME.jar`: your `.jar` file to run. + +The output is the newly written data from your {{< product-name >}} database. + +## Installation + +Include `com.influxdb.influxdb3-java` in your project dependencies. + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Maven pom.xml](#) +[Gradle dependency script](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +```xml + + com.influxdb + influxdb3-java + RELEASE + +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} + +```groovy +dependencies { + + implementation group: 'com.influxdb', name: 'influxdb3-java', version: 'latest.release' + +} +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Importing the client + +The `influxdb3-java` client library package provides +`com.influxdb.v3.client` classes for constructing, writing, and querying data +stored in {{< product-name >}}. + +## API reference + +- [Interface InfluxDBClient](#interface-influxdbclient) + - [Initialize with credential parameters](#initialize-with-credential-parameters) + - [InfluxDBClient instance methods](#influxdbclient-instance-methods) + - [InfluxDBClient.writePoint](#influxdbclientwritepoint) + - [InfluxDBClient.query](#influxdbclientquery) + + +## InfluxDBClient interface + +`InfluxDBClient` provides an interface for interacting with InfluxDB APIs for writing and querying data. + +The `InfluxDBClient.getInstance` constructor initializes and returns a client instance with the following: + +- A _write client_ configured for writing to the database. +- An Arrow _Flight client_ configured for querying the database. + +To initialize a client, call `getInstance` and pass your credentials as one of +the following types: + +- [parameters](#initialize-with-credential-parameters) +- a [`ClientConfig`](https://github.com/InfluxCommunity/influxdb3-java/blob/main/src/main/java/com/influxdb/v3/client/config/ClientConfig.java) +- a [database connection string](#initialize-using-a-database-connection-string) + +### Initialize with credential parameters + +{{% code-placeholders "host | database | token" %}} + +```java +static InfluxDBClient getInstance(@Nonnull final String host, + @Nullable final char[] token, + @Nullable final String database) +``` + +{{% /code-placeholders %}} + +- {{% code-placeholder-key %}}`host`{{% /code-placeholder-key %}} (string): The host URL of the InfluxDB instance. +- {{% code-placeholder-key %}}`database`{{% /code-placeholder-key %}} (string): The [database](/influxdb/cloud-dedicated/admin/databases/) to use for writing and querying. +- {{% code-placeholder-key %}}`token`{{% /code-placeholder-key %}} (char array): A [database token](/influxdb/cloud-dedicated/admin/tokens/database/) with read/write permissions. + +#### Example: initialize with credential parameters + +{{% code-placeholders "DATABASE_NAME | DATABASE_TOKEN" %}} + +```java +package com.influxdata.demo; + +import com.influxdb.v3.client.InfluxDBClient; +import com.influxdb.v3.client.Point; +import com.influxdb.v3.client.query.QueryOptions; +import com.influxdb.v3.client.query.QueryType; + +import java.time.Instant; +import java.util.stream.Stream; + +public class HelloInfluxDB { + private static final String HOST_URL = "https://{{< influxdb/host >}}"; + private static final String DATABASE = "DATABASE_NAME"; + private static final char[] TOKEN = System.getenv("DATABASE_TOKEN"); + + // Create a client instance, and then write and query data in InfluxDB. + public static void main(String[] args) { + try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, DATABASE_TOKEN, DATABASE)) { + writeData(client); + queryData(client); + } + catch (Exception e) { + System.err.println("An error occurred while connecting to InfluxDB!"); + e.printStackTrace(); + } + } +} +``` + +{{% /code-placeholders %}} + +Replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a + [database token](/influxdb/cloud-dedicated/admin/tokens/database/) that has + the necessary permissions on the specified database. + +#### Default tags + +To include default [tags](/influxdb/cloud-dedicated/reference/glossary/#tag) in +all written data, pass a `Map` of tag keys and values. + +```java +InfluxDBClient getInstance(@Nonnull final String host, + @Nullable final char[] token, + @Nullable final String database, + @Nullable Map defaultTags) +``` + +### Initialize using a database connection string + +{{% code-placeholders "DATABASE_NAME | API_TOKEN" %}} + +```java +"https://{{< influxdb/host >}}" ++ "?token=DATABASE_TOKEN&database=DATABASE_NAME" +``` + +{{% /code-placeholders %}} + +Replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a + [database token](/influxdb/cloud-dedicated/admin/tokens/database/) that has + the necessary permissions on the specified database. + +### InfluxDBClient instance methods + +#### InfluxDBClient.writePoint + +To write points as line protocol to a database: + +1. [Initialize the `client`](#initialize-with-credential-parameters)--your + token must have write permission on the specified database. +2. Use the `com.influxdb.v3.client.Point` class to create time series data. +3. Call the `client.writePoint()` method to write points as line protocol in your + database. + +```java + // Use the Point class to construct time series data. + // Call client.writePoint to write the point in your database. + private static void writeData(InfluxDBClient client) { + Point point = Point.measurement("temperature") + .setTag("location", "London") + .setField("value", 30.01) + .setTimestamp(Instant.now().minusSeconds(10)); + try { + client.writePoint(point); + System.out.println("Data written to the database."); + } + catch (Exception e) { + System.err.println("Failed to write data to the database."); + e.printStackTrace(); + } + } +``` + +#### InfluxDBClient.query + +To query data and process the results: + +1. [Initialize the `client`](#initialize-with-credential-parameters)--the + token must have read permission on the database you want to query. +2. Call `client.query()` and provide your SQL query as a string. +3. Use the result stream's built-in iterator to process row data. + +```java + // Query the latest 10 measurements using SQL + private static void queryData(InfluxDBClient client) { + System.out.printf("--------------------------------------------------------%n"); + System.out.printf("| %-8s | %-8s | %-30s |%n", "location", "value", "time"); + System.out.printf("--------------------------------------------------------%n"); + + String sql = "select time,location,value from temperature order by time desc limit 10"; + try (Stream stream = client.query(sql)) { + stream.forEach(row -> System.out.printf("| %-8s | %-8s | %-30s |%n", row[1], row[2], row[0])); + } + catch (Exception e) { + System.err.println("Failed to query data from the database."); + e.printStackTrace(); + } + } +``` + +View the InfluxDB v3 Java client library diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md index 092129da2..3ceed7434 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/java.md @@ -15,11 +15,10 @@ aliases: --- The InfluxDB v3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates -with Java application code to write and query data stored in an {{% product-name %}} -bucket. +with Java application code to write and query data stored in {{% product-name %}}. InfluxDB client libraries provide configurable batch writing of data to {{% product-name %}}. -Client libraries can be used to construct line protocol data, transform data from other formats +Use client libraries to construct line protocol data, transform data from other formats to line protocol, and batch write line protocol data to InfluxDB HTTP APIs. InfluxDB v3 client libraries can query {{% product-name %}} using SQL or InfluxQL. @@ -44,6 +43,8 @@ server metadata, and retrieving data from {{% product-name %}} using the Flight The following example shows how to use `influxdb3-java` to write and query data stored in {{% product-name %}}. +{{% code-placeholders "DATABASE_NAME | API_TOKEN" %}} + ```java package com.influxdata.demo; @@ -57,18 +58,18 @@ import java.util.stream.Stream; public class HelloInfluxDB { private static final String HOST_URL = "https://{{< influxdb/host >}}"; // your Cloud Serverless region URL - private static final String DATABASE = "java"; // your Cloud Serverless bucket - private static final char[] API_TOKEN = System.getenv("API_TOKEN"); // your local environment variable that stores your API Token + private static final String DATABASE = "DATABASE_NAME"; // your InfluxDB bucket + private static final char[] TOKEN = System.getenv("API_TOKEN"); // a local environment variable that stores your API token // Create a client instance that writes and queries data in your bucket. public static void main(String[] args) { // Instantiate the client with your InfluxDB credentials - try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, API_TOKEN, DATABASE)) { + try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, TOKEN, DATABASE)) { writeData(client); queryData(client); } catch (Exception e) { - System.err.println("An error occurred while connecting to InfluxDB Cloud Serverless!"); + System.err.println("An error occurred while connecting to InfluxDB!"); e.printStackTrace(); } } @@ -109,10 +110,17 @@ public class HelloInfluxDB { {{% cite %}}Source: [suyashcjoshi/SimpleJavaInfluxDB](https://github.com/suyashcjoshi/SimpleJavaInfluxDB/) on GitHub{{% /cite %}} +{{% /code-placeholders %}} + Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [bucket](/influxdb/cloud-serverless/admin/buckets/) -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a local environment variable that stores your [token](/influxdb/cloud-serverless/admin/tokens/)--the token must have read and write permission to the specified bucket. +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + the name of your {{% product-name %}} + [bucket](/influxdb/cloud-serverless/admin/buckets/) to read and write data to +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a local + environment variable that stores your + [token](/influxdb/cloud-serverless/admin/tokens/)--the token must have read + and write permissions on the specified bucket. ### Run the example to write and query data @@ -193,35 +201,36 @@ stored in {{< product-name >}}. The `InfluxDBClient.getInstance` constructor initializes and returns a client instance with the following: -- A _write client_ configured for writing to the database. -- An Arrow _Flight client_ configured for querying the database. +- A _write client_ configured for writing to the bucket. +- An Arrow _Flight client_ configured for querying the bucket. To initialize a client, call `getInstance` and pass your credentials as one of the following types: - [parameters](#initialize-with-credential-parameters) - a [`ClientConfig`](https://github.com/InfluxCommunity/influxdb3-java/blob/main/src/main/java/com/influxdb/v3/client/config/ClientConfig.java) -- a database connection string--for example: - - ```java - "https://{{< influxdb/host >}}" - + "?token=API_TOKEN&database=DATABASE_NAME" - ``` +- a [database connection string](#initialize-using-a-database-connection-string) ### Initialize with credential parameters +{{% code-placeholders "host | database | token" %}} + ```java static InfluxDBClient getInstance(@Nonnull final String host, @Nullable final char[] token, @Nullable final String database) ``` -- **`host`** (string): The host URL of the InfluxDB instance. -- **`database`** (string): The bucket to use for writing and querying. -- **`token`** (string): An API token with read/write permissions. +{{% /code-placeholders %}} + +- {{% code-placeholder-key %}}`host`{{% /code-placeholder-key %}} (string): The host URL of the InfluxDB instance. +- {{% code-placeholder-key %}}`database`{{% /code-placeholder-key %}} (string): The [bucket](/influxdb/cloud-serverless/admin/buckets/) to use for writing and querying. +- {{% code-placeholder-key %}}`token`{{% /code-placeholder-key %}} (char array): A [token](/influxdb/cloud-serverless/admin/tokens/) with read/write permissions. #### Example: initialize with credential parameters +{{% code-placeholders "DATABASE_NAME | API_TOKEN" %}} + ```java package com.influxdata.demo; @@ -235,9 +244,10 @@ import java.util.stream.Stream; public class HelloInfluxDB { private static final String HOST_URL = "https://{{< influxdb/host >}}"; - private static final String DATABASE = "DATABASE_NAME"; // your Cloud Serverless bucket - private static final char[] API_TOKEN = System.getenv("API_TOKEN"); // an environment variable for your Cloud Serverless API Token - // Create a client instance, and then write and query data in InfluxDB Cloud Serverless. + private static final String DATABASE = "DATABASE_NAME"; + private static final char[] API_TOKEN = System.getenv("API_TOKEN"); + + // Create a client instance, and then write and query data in InfluxDB. public static void main(String[] args) { try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, API_TOKEN, DATABASE)) { writeData(client); @@ -251,25 +261,58 @@ public class HelloInfluxDB { } ``` +{{% /code-placeholders %}} + +Replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + your {{% product-name %}} [bucket](/influxdb/cloud-serverless/admin/buckets/) +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a local + environment variable that stores your + [token](/influxdb/cloud-serverless/admin/tokens/)--the token must have the + necessary permissions on the specified bucket. + #### Default tags -- _Optional_: To include default - [tags](/influxdb/cloud-serverless/reference/glossary/#tag) in all written data, - pass a `Map` of tag keys and values. +To include default [tags](/influxdb/cloud-serverless/reference/glossary/#tag) in +all written data, pass a `Map` of tag keys and values. - ```java - InfluxDBClient getInstance(@Nonnull final String host, - @Nullable final char[] token, - @Nullable final String database, - @Nullable Map defaultTags) - ``` +```java +InfluxDBClient getInstance(@Nonnull final String host, + @Nullable final char[] token, + @Nullable final String database, + @Nullable Map defaultTags) +``` + +### Initialize using a database connection string + +{{% code-placeholders "DATABASE_NAME | API_TOKEN" %}} + +```java +"https://{{< influxdb/host >}}" ++ "?token=API_TOKEN&database=DATABASE_NAME" +``` + +{{% /code-placeholders %}} + +Replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + your {{% product-name %}} [bucket](/influxdb/cloud-serverless/admin/buckets/) +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a + [token](/influxdb/cloud-serverless/admin/tokens/) that has the + necessary permissions on the specified bucket. ### InfluxDBClient instance methods #### InfluxDBClient.writePoint -1. Use the `com.influxdb.v3.client.Point` class to create time series data. -2. Call the `client.writePoint()` method to write points as line protocol in your +To write points as line protocol to a bucket: + +1. [Initialize the `client`](#initialize-with-credential-parameters)--your + token must have write permission on the specified bucket. +2. Use the `com.influxdb.v3.client.Point` class to create time series data. +3. Call the `client.writePoint()` method to write points as line protocol in your bucket. ```java @@ -295,8 +338,10 @@ public class HelloInfluxDB { To query data and process the results: -1. Call `client.query()` and provide your SQL query as a string. -2. Use the result stream's built-in iterator to process row data. +1. [Initialize the `client`](#initialize-with-credential-parameters)--your + token must have read permission on the bucket you want to query. +2. Call `client.query()` and provide your SQL query as a string. +3. Use the result stream's built-in iterator to process row data. ```java // Query the latest 10 measurements using SQL @@ -316,4 +361,4 @@ To query data and process the results: } ``` -View the InfluxDB v3 Java client library \ No newline at end of file +View the InfluxDB v3 Java client library diff --git a/content/influxdb/clustered/reference/client-libraries/v3/java.md b/content/influxdb/clustered/reference/client-libraries/v3/java.md index c686721d6..191fe2568 100644 --- a/content/influxdb/clustered/reference/client-libraries/v3/java.md +++ b/content/influxdb/clustered/reference/client-libraries/v3/java.md @@ -13,9 +13,350 @@ influxdb/clustered/tags: [Flight client, Java, gRPC, SQL, Flight SQL, client lib weight: 201 --- -The InfluxDB v3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates with Java application code -to write and query data stored in an {{% product-name %}} database. +The InfluxDB v3 [`influxdb3-java` Java client library](https://github.com/InfluxCommunity/influxdb3-java) integrates +with Java application code to write and query data stored in {{% product-name %}}. -The documentation for this client library is available on GitHub. +InfluxDB client libraries provide configurable batch writing of data to {{% product-name %}}. +Use client libraries to construct line protocol data, transform data from other formats +to line protocol, and batch write line protocol data to InfluxDB HTTP APIs. -InfluxDB v3 Java client library +InfluxDB v3 client libraries can query {{% product-name %}} using SQL or InfluxQL. +The `influxdb3-java` Java client library wraps the Apache Arrow `org.apache.arrow.flight.FlightClient` +in a convenient InfluxDB v3 interface for executing SQL and InfluxQL queries, requesting +server metadata, and retrieving data from {{% product-name %}} using the Flight protocol with gRPC. + +- [Installation](#installation) + - [Using Maven](#using-maven) + - [Using Gradle](#using-gradle) +- [Importing the client](#importing-the-client) +- [API reference](#api-reference) +- [Classes](#classes) +- [InfluxDBClient interface](#influxdbclient-interface) + - [Initialize with credential parameters](#initialize-with-credential-parameters) + - [InfluxDBClient instance methods](#influxdbclient-instance-methods) + - [InfluxDBClient.writePoint](#influxdbclientwritepoint) + - [InfluxDBClient.query](#influxdbclientquery) + + +#### Example: write and query data + +The following example shows how to use `influxdb3-java` to write and query data stored in {{% product-name %}}. + +{{% code-placeholders "DATABASE_NAME | DATABASE_TOKEN" %}} + +```java +package com.influxdata.demo; + +import com.influxdb.v3.client.InfluxDBClient; +import com.influxdb.v3.client.Point; +import com.influxdb.v3.client.query.QueryOptions; +import com.influxdb.v3.client.query.QueryType; + +import java.time.Instant; +import java.util.stream.Stream; + +public class HelloInfluxDB { + private static final String HOST_URL = "https://{{< influxdb/host >}}"; // your cluster URL + private static final String DATABASE = "DATABASE_NAME"; // your InfluxDB database name + private static final char[] TOKEN = System.getenv("DATABASE_TOKEN"); // a local environment variable that stores your database token + + // Create a client instance that writes and queries data in your database. + public static void main(String[] args) { + // Instantiate the client with your InfluxDB credentials + try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, TOKEN, DATABASE)) { + writeData(client); + queryData(client); + } + catch (Exception e) { + System.err.println("An error occurred while connecting to InfluxDB!"); + e.printStackTrace(); + } + } + + // Use the Point class to construct time series data. + private static void writeData(InfluxDBClient client) { + Point point = Point.measurement("temperature") + .setTag("location", "London") + .setField("value", 30.01) + .setTimestamp(Instant.now().minusSeconds(10)); + try { + client.writePoint(point); + System.out.println("Data is written to the database."); + } + catch (Exception e) { + System.err.println("Failed to write data to the database."); + e.printStackTrace(); + } + } + + // Use SQL to query the most recent 10 measurements + private static void queryData(InfluxDBClient client) { + System.out.printf("--------------------------------------------------------%n"); + System.out.printf("| %-8s | %-8s | %-30s |%n", "location", "value", "time"); + System.out.printf("--------------------------------------------------------%n"); + + String sql = "select time,location,value from temperature order by time desc limit 10"; + try (Stream stream = client.query(sql)) { + stream.forEach(row -> System.out.printf("| %-8s | %-8s | %-30s |%n", row[1], row[2], row[0])); + } + catch (Exception e) { + System.err.println("Failed to query data from the database."); + e.printStackTrace(); + } + } +} +``` + +{{% cite %}}Source: [suyashcjoshi/SimpleJavaInfluxDB](https://github.com/suyashcjoshi/SimpleJavaInfluxDB/) on GitHub{{% /cite %}} + +{{% /code-placeholders %}} + +Replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + the name of your {{% product-name %}} + [database](/influxdb/clustered/admin/databases/) to read and write data to +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a + local environment variable that stores your + [token](/influxdb/clustered/admin/tokens/database/)--the token must have + read and write permissions on the specified database. + +### Run the example to write and query data + +1. Build an executable JAR for the project--for example, using Maven: + + + + ```bash + mvn package + ``` + +2. In your terminal, run the `java` command to write and query data in your database: + + + + ```bash + java \ + --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED \ + -jar target/PROJECT_NAME.jar + ``` + + Include the following in your command: + + - [`--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED`](https://arrow.apache.org/docs/java/install.html#id3): with Java version 9 or later and Apache Arrow version 16 or later, exposes JDK internals for Arrow. + For more options, see the [Apache Arrow Java install documentation](https://arrow.apache.org/docs/java/install.html). + - `-jar target/PROJECT_NAME.jar`: your `.jar` file to run. + +The output is the newly written data from your {{< product-name >}} database. + +## Installation + +Include `com.influxdb.influxdb3-java` in your project dependencies. + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Maven pom.xml](#) +[Gradle dependency script](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +```xml + + com.influxdb + influxdb3-java + RELEASE + +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} + +```groovy +dependencies { + + implementation group: 'com.influxdb', name: 'influxdb3-java', version: 'latest.release' + +} +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Importing the client + +The `influxdb3-java` client library package provides +`com.influxdb.v3.client` classes for constructing, writing, and querying data +stored in {{< product-name >}}. + +## API reference + +- [Interface InfluxDBClient](#interface-influxdbclient) + - [Initialize with credential parameters](#initialize-with-credential-parameters) + - [InfluxDBClient instance methods](#influxdbclient-instance-methods) + - [InfluxDBClient.writePoint](#influxdbclientwritepoint) + - [InfluxDBClient.query](#influxdbclientquery) + + +## InfluxDBClient interface + +`InfluxDBClient` provides an interface for interacting with InfluxDB APIs for writing and querying data. + +The `InfluxDBClient.getInstance` constructor initializes and returns a client instance with the following: + +- A _write client_ configured for writing to the database. +- An Arrow _Flight client_ configured for querying the database. + +To initialize a client, call `getInstance` and pass your credentials as one of +the following types: + +- [parameters](#initialize-with-credential-parameters) +- a [`ClientConfig`](https://github.com/InfluxCommunity/influxdb3-java/blob/main/src/main/java/com/influxdb/v3/client/config/ClientConfig.java) +- a [database connection string](#initialize-using-a-database-connection-string) + +### Initialize with credential parameters + +{{% code-placeholders "host | database | token" %}} + +```java +static InfluxDBClient getInstance(@Nonnull final String host, + @Nullable final char[] token, + @Nullable final String database) +``` + +{{% /code-placeholders %}} + +- {{% code-placeholder-key %}}`host`{{% /code-placeholder-key %}} (string): The host URL of the InfluxDB instance. +- {{% code-placeholder-key %}}`database`{{% /code-placeholder-key %}} (string): The [database](/influxdb/clustered/admin/databases/) to use for writing and querying. +- {{% code-placeholder-key %}}`token`{{% /code-placeholder-key %}} (char array): A [database token](/influxdb/clustered/admin/tokens/database/) with read/write permissions. + +#### Example: initialize with credential parameters + +{{% code-placeholders "DATABASE_NAME | DATABASE_TOKEN" %}} + +```java +package com.influxdata.demo; + +import com.influxdb.v3.client.InfluxDBClient; +import com.influxdb.v3.client.Point; +import com.influxdb.v3.client.query.QueryOptions; +import com.influxdb.v3.client.query.QueryType; + +import java.time.Instant; +import java.util.stream.Stream; + +public class HelloInfluxDB { + private static final String HOST_URL = "https://{{< influxdb/host >}}"; + private static final String DATABASE = "DATABASE_NAME"; + private static final char[] TOKEN = System.getenv("DATABASE_TOKEN"); + + // Create a client instance, and then write and query data in InfluxDB. + public static void main(String[] args) { + try (InfluxDBClient client = InfluxDBClient.getInstance(HOST_URL, DATABASE_TOKEN, DATABASE)) { + writeData(client); + queryData(client); + } + catch (Exception e) { + System.err.println("An error occurred while connecting to InfluxDB!"); + e.printStackTrace(); + } + } +} +``` + +{{% /code-placeholders %}} + +Replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a + [database token](/influxdb/clustered/admin/tokens/database/) that has + the necessary permissions on the specified database. + +#### Default tags + +To include default [tags](/influxdb/clustered/reference/glossary/#tag) in +all written data, pass a `Map` of tag keys and values. + +```java +InfluxDBClient getInstance(@Nonnull final String host, + @Nullable final char[] token, + @Nullable final String database, + @Nullable Map defaultTags) +``` + +### Initialize using a database connection string + +{{% code-placeholders "DATABASE_NAME | API_TOKEN" %}} + +```java +"https://{{< influxdb/host >}}" ++ "?token=DATABASE_TOKEN&database=DATABASE_NAME" +``` + +{{% /code-placeholders %}} + +Replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a + [database token](/influxdb/clustered/admin/tokens/database/) that has + the necessary permissions on the specified database. + +### InfluxDBClient instance methods + +#### InfluxDBClient.writePoint + +To write points as line protocol to a database: + +1. [Initialize the `client`](#initialize-with-credential-parameters)--your + token must have write permission on the specified database. +2. Use the `com.influxdb.v3.client.Point` class to create time series data. +3. Call the `client.writePoint()` method to write points as line protocol in your + database. + +```java + // Use the Point class to construct time series data. + // Call client.writePoint to write the point in your database. + private static void writeData(InfluxDBClient client) { + Point point = Point.measurement("temperature") + .setTag("location", "London") + .setField("value", 30.01) + .setTimestamp(Instant.now().minusSeconds(10)); + try { + client.writePoint(point); + System.out.println("Data written to the database."); + } + catch (Exception e) { + System.err.println("Failed to write data to the database."); + e.printStackTrace(); + } + } +``` + +#### InfluxDBClient.query + +To query data and process the results: + +1. [Initialize the `client`](#initialize-with-credential-parameters)--the + token must have read permission on the database you want to query. +2. Call `client.query()` and provide your SQL query as a string. +3. Use the result stream's built-in iterator to process row data. + +```java + // Query the latest 10 measurements using SQL + private static void queryData(InfluxDBClient client) { + System.out.printf("--------------------------------------------------------%n"); + System.out.printf("| %-8s | %-8s | %-30s |%n", "location", "value", "time"); + System.out.printf("--------------------------------------------------------%n"); + + String sql = "select time,location,value from temperature order by time desc limit 10"; + try (Stream stream = client.query(sql)) { + stream.forEach(row -> System.out.printf("| %-8s | %-8s | %-30s |%n", row[1], row[2], row[0])); + } + catch (Exception e) { + System.err.println("Failed to query data from the database."); + e.printStackTrace(); + } + } +``` + +View the InfluxDB v3 Java client library From 4465d8562f92b4c1c453ebaa943410821fedeef8 Mon Sep 17 00:00:00 2001 From: Adam Date: Tue, 30 Jul 2024 16:00:43 -0700 Subject: [PATCH 64/96] Replace startsWith with startswith method The startswith method is not capitalized: https://docs.python.org/3/library/stdtypes.html#str.startswith --- .../cloud-dedicated/reference/client-libraries/v3/python.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/python.md b/content/influxdb/cloud-dedicated/reference/client-libraries/v3/python.md index 2fdd4e9f9..6ea1c9859 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v3/python.md +++ b/content/influxdb/cloud-dedicated/reference/client-libraries/v3/python.md @@ -282,16 +282,16 @@ status = None # Define callbacks for write responses def success(self, data: str): status = "Success writing batch: data: {data}" - assert status.startsWith('Success'), f"Expected {status} to be success" + assert status.startswith('Success'), f"Expected {status} to be success" def error(self, data: str, err: InfluxDBError): status = f"Error writing batch: config: {self}, data: {data}, error: {err}" - assert status.startsWith('Success'), f"Expected {status} to be success" + assert status.startswith('Success'), f"Expected {status} to be success" def retry(self, data: str, err: InfluxDBError): status = f"Retry error writing batch: config: {self}, data: {data}, error: {err}" - assert status.startsWith('Success'), f"Expected {status} to be success" + assert status.startswith('Success'), f"Expected {status} to be success" # Instantiate WriteOptions for batching write_options = WriteOptions() From 11bc7d5168c0cc35737f6a92c6ce2a885f5c078c Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 30 Jul 2024 18:18:26 -0500 Subject: [PATCH 65/96] fix(v2): http-write-timeout - Fix the http-write-timeout definition, which should be similar to https://pkg.go.dev/net/http#Server.WriteTimeout - Add a Vale spelling config for v2 server options - Add influxdb to the test container packages (for testing service influxdb...) - Add Dockerfile config and test setup for testing some InfluxDB startup config options (using influxd) --- .ci/vale/styles/InfluxDBv2/ServerConfig.yml | 10 + .../InfluxDBv2/Terms/query-functions.txt | 76 +++++++ .../Terms/server-config-options.txt | 70 +++++++ .../vocabularies/InfluxDataDocs/accept.txt | 2 +- Dockerfile.pytest | 6 + content/influxdb/v2/.vale.ini | 17 ++ .../influxdb/v2/reference/config-options.md | 196 +++++++++++++++++- lefthook.yml | 4 +- test/scripts/prepare-content.sh | 3 +- 9 files changed, 379 insertions(+), 5 deletions(-) create mode 100644 .ci/vale/styles/InfluxDBv2/ServerConfig.yml create mode 100644 .ci/vale/styles/InfluxDBv2/Terms/query-functions.txt create mode 100644 .ci/vale/styles/InfluxDBv2/Terms/server-config-options.txt create mode 100644 content/influxdb/v2/.vale.ini diff --git a/.ci/vale/styles/InfluxDBv2/ServerConfig.yml b/.ci/vale/styles/InfluxDBv2/ServerConfig.yml new file mode 100644 index 000000000..aae5fa410 --- /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 000000000..60ceb5b7e --- /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 000000000..587ca980f --- /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 83be41c7b..dae2608d1 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 293676a70..b47718c82 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 000000000..06147959c --- /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 bd500d2ca..71ce2fafe 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 bcf27775f..24349243e 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 8047ef6df..c37e0280f 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. From a36b33f602dc0091838388671d2c81d93dc7647c Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 31 Jul 2024 10:21:23 -0500 Subject: [PATCH 66/96] fix(v3): Broken URL due to missing delete-predicate.md (closes #5448) - Duplicate from OSS - Repeat warnings that you can't delete data in Serverless --- .../reference/cli/influx/delete/_index.md | 8 +++++ .../reference/syntax/delete-predicate.md | 32 +++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/delete/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/delete/_index.md index a6e904c0b..7c6e2dde3 100644 --- a/content/influxdb/cloud-serverless/reference/cli/influx/delete/_index.md +++ b/content/influxdb/cloud-serverless/reference/cli/influx/delete/_index.md @@ -24,3 +24,11 @@ This command is only supported when used with **InfluxDB OSS v2** and {{% /warn %}} {{< duplicate-oss >}} + +{{% warn %}} +#### InfluxDB Cloud Serverless does not support data deletion + +InfluxDB Cloud Serverless does not currently support deleting data. +This command is only supported when used with **InfluxDB OSS v2** and +**InfluxDB Cloud (TSM)**. +{{% /warn %}} diff --git a/content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md b/content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md new file mode 100644 index 000000000..edcbe5113 --- /dev/null +++ b/content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md @@ -0,0 +1,32 @@ +--- +title: Delete predicate syntax +list_title: Delete predicate +description: > + InfluxDB uses an InfluxQL-like predicate syntax to determine what data points to delete. +menu: + influxdb_cloud_serverless: + parent: Syntax + name: Delete predicate +weight: 104 +influxdb/cloud-serverless/tags: [syntax, delete] +related: + - /influxdb/cloud-serverless/write-data/delete-data/ + - /influxdb/cloud-serverless/reference/cli/influx/delete/ +--- +{{% warn %}} +#### InfluxDB Cloud Serverless does not support data deletion + +InfluxDB Cloud Serverless does not currently support deleting data. +This command is only supported when used with **InfluxDB OSS v2** and +**InfluxDB Cloud (TSM)**. +{{% /warn %}} + +{{< duplicate-oss >}} + +{{% warn %}} +#### InfluxDB Cloud Serverless does not support data deletion + +InfluxDB Cloud Serverless does not currently support deleting data. +This command is only supported when used with **InfluxDB OSS v2** and +**InfluxDB Cloud (TSM)**. +{{% /warn %}} \ No newline at end of file From d4a8abd5ef79938a0dc1ab829c2863dfb262767a Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 31 Jul 2024 15:23:41 -0500 Subject: [PATCH 67/96] fix(v2): Broken link for 2.0 beta migration Closes #5483 - Restore, update, and revise the v2-beta-to-v2 migration guide. - Skips all influx tests. --- .../v2/install/upgrade/v2-beta-to-v2.md | 346 ++++++++++++++++++ 1 file changed, 346 insertions(+) create mode 100644 content/influxdb/v2/install/upgrade/v2-beta-to-v2.md diff --git a/content/influxdb/v2/install/upgrade/v2-beta-to-v2.md b/content/influxdb/v2/install/upgrade/v2-beta-to-v2.md new file mode 100644 index 000000000..6eaeb60a9 --- /dev/null +++ b/content/influxdb/v2/install/upgrade/v2-beta-to-v2.md @@ -0,0 +1,346 @@ +--- +title: Upgrade from InfluxDB 2.0 beta to InfluxDB 2.0 +description: > + To upgrade from InfluxDB 2.0 beta 16 or earlier to InfluxDB 2.x, first + follow these steps to upgrade your InfluxDB beta instance, data, and resources + to InfluxDB 2.0. +menu: + influxdb_v2: + parent: Upgrade InfluxDB + name: InfluxDB 2.0 beta to 2.0 +aliases: + - /influxdb/v2.0/reference/rc0-upgrade-guide/ + - /influxdb/v2.0/reference/rc1-upgrade-guide/ + - /influxdb/v2.0/reference/upgrading/rc-upgrade-guide/ + - /influxdb/v2.0/upgrade/v2-beta-to-v2/ +weight: 11 +related: + - /influxdb/v2/install/upgrade/v2-to-v2/ +--- + +To upgrade from InfluxDB 2.0 beta 16 or earlier to InfluxDB 2.x, first +follow these steps to upgrade your InfluxDB beta instance, data, and resources to +[InfluxDB 2.0](https://github.com/influxdata/influxdb/releases/tag/v2.0.9). + +Depending on how you have set up your InfluxDB beta instance and the importance +of your existing resources and data, you can determine which steps apply to +you--for example, if you don't want to migrate your data and resources, +then you can skip those sections. + +1. [Disable existing integrations](#1-disable-existing-integrations) +2. [Stop existing InfluxDB beta instance](#2-stop-existing-influxdb-beta-instance) +3. [(Optional) Rename existing InfluxDB binaries](#3-optional-rename-existing-influxdb-binaries) +4. [Move existing data and start the latest InfluxDB](#4-move-existing-data-and-start-the-latest-influxdb) +5. [Start old InfluxDB beta instance](#5-start-old-influxdb-beta-instance) +6. [Create configuration profiles for the InfluxDB CLI](#6-create-configuration-profiles-for-the-influxdb-cli) +7. [Copy all resources from old instance to the new one](#7-copy-all-resources-from-old-instance-to-the-new-one) +8. [Set up integrations to point to new instance](#8-set-up-integrations-to-point-to-new-instance) +9. [Load historical data into new instance](#9-load-historical-data-into-new-instance) + +### Why is this manual process required? + +To ensure that existing InfluxQL integrations work with the latest release, +we had to make breaking changes to the underlying storage engine for InfluxDB 2.0. + +{{% note %}} +If you have questions while upgrading, +[open an issue](https://github.com/influxdata/influxdb/issues) +or join the [Community Slack workspace](https://influxcommunity.slack.com/) to +get immediate help. +{{% /note %}} + +## 1. Disable existing integrations + +To begin, shut off all integrations that are reading from, writing to, or monitoring your InfluxDB instance. +This includes Telegraf, client libraries, and any custom applications. + +## 2. Stop existing InfluxDB beta instance + +Next, shut down your existing InfluxDB beta instance. +You can manually stop the individual process using **Control+c** +(or by finding the process ID with `ps aux | grep -i influxd` and using `sudo kill -9 `). +If you've set `influxd` to run as a system process, follow the same steps you would use to disable any system process. + +## 3. (Optional) Rename existing InfluxDB binaries + +To easily identify your existing InfluxDB binaries, rename them `influx_old` and `influxd_old`. +This is helpful if you've installed the binaries in your `$PATH`. +We use the names `influxd_old` for this guide, but you can use whatever you like. + +## 4. Move existing data and start the latest InfluxDB + +If you haven't already, +[download and install InfluxDB 2.0](https://github.com/influxdata/influxdb/releases/tag/v2.0.9) +for your system, but don't run the setup process yet. +Be careful not to overwrite the existing binaries. + +To move data between the two instances, first configure both the old and new instances of InfluxDB to run at the same time. +If you download the latest InfluxDB beta and try to start it with existing data, +most likely it won't start and the following error message appears: + +``` +Incompatible InfluxDB 2.0 version found. +Move all files outside of engine_path before influxd will start. +``` + +To avoid this error, run the following command to move your existing data to a another location (anywhere you like): + + + +```sh +mv ~/.influxdbv2 ~/.influxdbv2_old +``` + +Start the latest InfluxDB version by running: + + + +```sh +influxd +``` + +{{% note %}} +If you were using specific [command line flags](/influxdb/v2/reference/cli/influxd/#flags) for InfluxDB beta, you can use those same command line flags. +{{% /note %}} + +Because the data folder path has changed for InfluxDB v2, everything will be empty. +You can visit http://localhost:8086 in your browser and see a setup page, but don't go through the setup process yet. + +## 5. Start old InfluxDB beta instance + +You can now start your old InfluxDB instance and point it to your old data directory: + + + +```sh +./influxd_old \ + --bolt-path ~/.influxdbv2_old/influxd.bolt \ + --engine-path ~/.influxdbv2_old/engine +``` + +Double-check that InfluxDB is working by visiting your InfluxDB beta instance URL (probably http://localhost:9999) and logging in. +Your data and resources should still be there. + +{{% note %}} +If you see a "missing migration" error, manually edit your bolt file to remove +the migration--for example: + +1. _Recommended_: **Backup your old `influxd.bolt` file**--manually editing this + file could cause you to lose all your data. +2. Use [BoltBrowser](https://github.com/br0xen/boltbrowser) to open and edit + your old `influxd.bolt` file +3. To remove the migration, highlight the record under the `migrationsv1` path + and press **D**. +{{% /note %}} + +Now, the new instance and old instance of InfluxDB are running simultaneously. + +## 6. Create configuration profiles for the InfluxDB CLI + +Next, set up your InfluxDB CLI to connect to your old and new instances. + +### a. Configure old profile + +If you've used the CLI before, copy your existing `configs` file to your new data directory: + + + +```sh +cp ~/.influxdbv2_old/configs ~/.influxdbv2/configs +``` + +_Recommended_: rename the old configuration file to something like `influx_old`. + +{{< keep-url >}} +```toml +[influx_old] + url = "http://localhost:9999" + token = "" + org = "influxdata" + active = true +``` + +If you've never used the CLI before, create a new configuration profile to +connect to your old instance using the `influx config` command. + + + +{{< keep-url >}} +```sh +influx config create \ + --config-name influx_old \ + --host-url http://localhost:9999 \ + --org influxdata \ + --token +``` + +To list configurations, enter the following command: + + + +{{< keep-url >}} +```sh +influx config ls +``` + +The output lists the configuration profile for your old instance: + +``` +Active Name URL Org +* influx_old http://localhost:9999 InfluxData +``` + +### b. Configure new profile + +Next set up your new instance, which automatically creates a configuration profile for you. + +The `influx setup` command automatically creates a config profile named `default`. +Make sure you don't already have a profile with that name before you run the command. + +Run the `influx setup` command and answer the prompts. + +**Don't use the same bucket name** as a bucket in your existing instance. +Otherwise, a name collision and file conflict occurs when you try to copy your +resources. +You'll delete this dummy bucket later, after you migrate your resources. + + + +```sh +influx setup +``` + +The command prompts you to configure credentials: + +``` +Welcome to InfluxDB 2.0! +Please type your primary username: admin + +Please type your password: + +Please type your password again: + +Please type your primary organization name: InfluxData + +Please type your primary bucket name: dummy_bucket + +Please type your retention period in hours. +Or press ENTER for infinite.: + +You have entered: + Username: admin + Organization: InfluxData + Bucket: dummy_bucket + Retention Period: infinite +Confirm? (y/n): y + +Config default has been stored in /Users/rsavage/.influxdbv2/configs. +User Organization Bucket +admin InfluxData dummy_bucket +``` + +You now have two config profiles: +one named `default` that points to your new instance, and one named `influx_old` that points to your old instance. + + + +{{< keep-url >}} +```sh +$ influx config ls +Active Name URL Org + default http://localhost:8086 InfluxData +* influx_old http://localhost:9999 InfluxData +``` + +You can now send commands to each of them as needed using the [`-c, --active-config`](/influxdb/v2/reference/cli/influx/#commands) option in the CLI. + +## 7. Copy all resources from old instance to the new one + +Use config profiles to export all resources from the old instance and apply them to your new instance. +(The only things that will not be copied over are [scraper configurations](/influxdb/v2/write-data/no-code/scrape-data/manage-scrapers/). +You will need to manually reconfigure those.) + +Copy all your existing InfluxDB resources, such as dashboards, tasks, and alerts, to your new instance by running the following command: + + + +```sh +influx export all -c influx_old | influx apply -c default +``` + +(To learn more about this command, see +[`influx export`](/influxdb/v2/reference/cli/influx/export/) and +[`influx apply`](/influxdb/v2/reference/cli/influx/apply/).) + +The output is a list of the resources created in your new instance. +If successful, you can delete the bucket created during the setup. + + + +```sh +LABELS +add | -remove | unchanged ++-----+------------------------+----+---------------+---------+-------------+ +| +/- | METADATA NAME | ID | RESOURCE NAME | COLOR | DESCRIPTION | ++-----+------------------------+----+---------------+---------+-------------+ +| + | tasty-northcutt-c9c001 | | something | #326BBA | | ++-----+------------------------+----+---------------+---------+-------------+ +| TOTAL | 1 | ++-----+------------------------+----+---------------+---------+-------------+ +​ +BUCKETS +add | -remove | unchanged ++-----+------------------------+----+---------------+------------------+-------------+ +| +/- | METADATA NAME | ID | RESOURCE NAME | RETENTION PERIOD | DESCRIPTION | ++-----+------------------------+----+---------------+------------------+-------------+ +| + | fasting-taussig-c9c007 | | apps | 0s | | ++-----+------------------------+----+---------------+------------------+-------------+ ++-----+------------------------+----+---------------+------------------+-------------+ +| + | great-davinci-c9c005 | | new_telegraf | 0s | | ++-----+------------------------+----+---------------+------------------+-------------+ ++-----+------------------------+----+---------------+------------------+-------------+ +| + | stubborn-hugle-c9c003 | | telegraf | 719h59m59s | | ++-----+------------------------+----+---------------+------------------+-------------+ +| TOTAL | 3 | ++-----+------------------------+----+---------------+------------------+-------------+ +``` + +Now, you have all the resources from your old instance stored in your new instance. +Sign in to your new instance (by default http://localhost:8086) and take a look. +You will see dashboards, but you haven't yet migrated your old data. + +## 8. Set up integrations to point to new instance + +Re-enable any integrations you disabled in step 2. +You will need to re-enable Telegraf, client libraries, custom applications, +or third-party data sinks using new tokens and credentials. + +## 9. Load historical data into new instance + +Use the CLI to export and then re-import your data using the command below. +(For the range, pick a time before your bucket's retention period, or something a really long time ago if you have an unlimited retention period.) + + + +```sh +influx query -c influx_old \ + 'from(bucket: "my-bucket") |> range(start: -3y)' --raw > my-bucket.csv +``` + +Then write to the new bucket: + + + +```sh +influx write -c default --format csv -b my-bucket -f my-bucket.csv +``` + +Repeat that process for each bucket. + +## Verify InfluxDB resources, data, and integrations + +Verify that the latest version of InfluxDB is running with all your resources, data, and integrations configured. +Double-check that everything is there and it is working as expected. +Once you're set up with the latest InfluxDB, you can safely turn off your old instance and archive the previous data directory. + +## Upgrade to the latest InfluxDB v2 version + +Follow steps to [upgrade from InfluxDB 2.0 to the latest InfluxDB 2.x version](/influxdb/v2/install/upgrade/v2-to-v2/). From 6ba60c6ad1b1a871d141cc7b8082d617cdecc195 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 31 Jul 2024 15:43:47 -0500 Subject: [PATCH 68/96] fix: move package file for Dependabot --- .ci/Dockerfile.remark | 3 +-- .ci/{app => remark-lint}/package.json | 0 .ci/remark-lint/yarn.lock | 6 +++--- 3 files changed, 4 insertions(+), 5 deletions(-) rename .ci/{app => remark-lint}/package.json (100%) diff --git a/.ci/Dockerfile.remark b/.ci/Dockerfile.remark index 71d775c55..fd4f59159 100644 --- a/.ci/Dockerfile.remark +++ b/.ci/Dockerfile.remark @@ -5,8 +5,7 @@ WORKDIR /app/ # Generic #RUN apk add --no-cache -COPY /.ci/app /app/ -#COPY /.ci/remark-lint/package.json /app/ +COPY /.ci/remark-lint /app/ # Node ENV PATH "$PATH:/app/node_modules/.bin/" diff --git a/.ci/app/package.json b/.ci/remark-lint/package.json similarity index 100% rename from .ci/app/package.json rename to .ci/remark-lint/package.json diff --git a/.ci/remark-lint/yarn.lock b/.ci/remark-lint/yarn.lock index ec982abc6..cff3cc08f 100644 --- a/.ci/remark-lint/yarn.lock +++ b/.ci/remark-lint/yarn.lock @@ -190,9 +190,9 @@ integrity sha512-nG96G3Wp6acyAgJqGasjODb+acrI7KltPiRxzHPXnP3NgI28bpQDRv53olbqGXbfcgF5aiiHmO3xpwEpS5Ld9g== "@types/node@*": - version "22.0.0" - resolved "https://registry.yarnpkg.com/@types/node/-/node-22.0.0.tgz#04862a2a71e62264426083abe1e27e87cac05a30" - integrity sha512-VT7KSYudcPOzP5Q0wfbowyNLaVR8QWUdw+088uFWwfvpY6uCWaXpqV6ieLAu9WBcnTa7H4Z5RLK8I5t2FuOcqw== + version "22.0.2" + resolved "https://registry.yarnpkg.com/@types/node/-/node-22.0.2.tgz#9fb1a2b31970871e8bf696f0e8a40d2e6d2bd04e" + integrity sha512-yPL6DyFwY5PiMVEwymNeqUTKsDczQBJ/5T7W/46RwLU/VH+AA8aT5TZkvBviLKLbbm0hlfftEkGrNzfRk/fofQ== dependencies: undici-types "~6.11.1" From 79805ce5707fd5364dd0fa41a1d40651f8c4e7e2 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 31 Jul 2024 16:42:30 -0500 Subject: [PATCH 69/96] fix(clustered): clustered reference docs for `influxctl` incorrectly show `influxctl cluster list` subcommand Fixes #5472 - Add note to command in Clustered docs. --- .../clustered/reference/cli/influxctl/cluster/list.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md b/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md index b8c01ce88..4434ed7f5 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md +++ b/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md @@ -9,6 +9,17 @@ menu: weight: 301 --- +{{% warn %}} + +#### Doesn't work with InfluxDB Clustered + +The `influxctl cluster list` command doesn't work for {{% product-name %}} +clusters. +To retrieve cluster information, use the [`influxctl cluster get ` +command](/influxdb/clustered/reference/cli/influxctl/cluster/get/). + +{{% /warn %}} + The `influxctl cluster list` command returns information about all InfluxDB clusters associated with your account ID. From 5614600c6caaba68966a076349b78678488ad433 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 31 Jul 2024 17:18:47 -0500 Subject: [PATCH 70/96] fix(5544): python str.startswith in examples - startsWith should be startswith for Python - The test should have failed; the callbacks don't seem to be working now. --- .../reference/client-libraries/v3/python.md | 6 +++--- .../clustered/reference/client-libraries/v3/python.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md b/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md index d0e05113d..492e8d1d9 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v3/python.md @@ -254,16 +254,16 @@ status = None # Define callbacks for write responses def success(self, data: str): status = "Success writing batch: data: {data}" - assert status.startsWith('Success'), f"Expected {status} to be success" + assert status.startswith('Success'), f"Expected {status} to be success" def error(self, data: str, err: InfluxDBError): status = f"Error writing batch: config: {self}, data: {data}, error: {err}" - assert status.startsWith('Success'), f"Expected {status} to be success" + assert status.startswith('Success'), f"Expected {status} to be success" def retry(self, data: str, err: InfluxDBError): status = f"Retry error writing batch: config: {self}, data: {data}, error: {err}" - assert status.startsWith('Success'), f"Expected {status} to be success" + assert status.startswith('Success'), f"Expected {status} to be success" # Instantiate WriteOptions for batching write_options = WriteOptions() diff --git a/content/influxdb/clustered/reference/client-libraries/v3/python.md b/content/influxdb/clustered/reference/client-libraries/v3/python.md index 47f571a8b..dca98614a 100644 --- a/content/influxdb/clustered/reference/client-libraries/v3/python.md +++ b/content/influxdb/clustered/reference/client-libraries/v3/python.md @@ -282,16 +282,16 @@ status = None # Define callbacks for write responses def success(self, data: str): status = "Success writing batch: data: {data}" - assert status.startsWith('Success'), f"Expected {status} to be success" + assert status.startswith('Success'), f"Expected {status} to be success" def error(self, data: str, err: InfluxDBError): status = f"Error writing batch: config: {self}, data: {data}, error: {err}" - assert status.startsWith('Success'), f"Expected {status} to be success" + assert status.startswith('Success'), f"Expected {status} to be success" def retry(self, data: str, err: InfluxDBError): status = f"Retry error writing batch: config: {self}, data: {data}, error: {err}" - assert status.startsWith('Success'), f"Expected {status} to be success" + assert status.startswith('Success'), f"Expected {status} to be success" # Instantiate WriteOptions for batching write_options = WriteOptions() From 699e57d83f143cf15eff2b99b5e17e78517997fd Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Fri, 2 Aug 2024 09:01:13 -0500 Subject: [PATCH 71/96] Update list.md --- .../influxdb/clustered/reference/cli/influxctl/cluster/list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md b/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md index 4434ed7f5..a95a4fbbf 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md +++ b/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md @@ -13,7 +13,7 @@ weight: 301 #### Doesn't work with InfluxDB Clustered -The `influxctl cluster list` command doesn't work for {{% product-name %}} +The `influxctl cluster list` command won't work with {{% product-name %}} clusters. To retrieve cluster information, use the [`influxctl cluster get ` command](/influxdb/clustered/reference/cli/influxctl/cluster/get/). From bdb0a55a4db821a68bc468f280ef91a535e0800e Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Fri, 2 Aug 2024 09:02:02 -0500 Subject: [PATCH 72/96] Update content/influxdb/clustered/reference/cli/influxctl/cluster/list.md --- .../influxdb/clustered/reference/cli/influxctl/cluster/list.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md b/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md index a95a4fbbf..3696d132e 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md +++ b/content/influxdb/clustered/reference/cli/influxctl/cluster/list.md @@ -13,8 +13,7 @@ weight: 301 #### Doesn't work with InfluxDB Clustered -The `influxctl cluster list` command won't work with {{% product-name %}} -clusters. +The `influxctl cluster list` command won't work with {{% product-name %}}. To retrieve cluster information, use the [`influxctl cluster get ` command](/influxdb/clustered/reference/cli/influxctl/cluster/get/). From 3b6a5fa74ffe91e56d72df8db5625be5f3376200 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Fri, 2 Aug 2024 09:26:06 -0500 Subject: [PATCH 73/96] fix(flux): Write, Query, and Prometheus menu name - Replaces `menu: flux_0_x` with the correct menu attributes in frontmatter. - These have apparently been broken like this for some time. --- content/flux/v0/prometheus/_index.md | 4 +++- content/flux/v0/query-data/_index.md | 4 +++- content/flux/v0/write-data/_index.md | 4 +++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/content/flux/v0/prometheus/_index.md b/content/flux/v0/prometheus/_index.md index ba0d76b6f..6f68a771c 100644 --- a/content/flux/v0/prometheus/_index.md +++ b/content/flux/v0/prometheus/_index.md @@ -3,7 +3,9 @@ title: Work with Prometheus description: > Flux provides tools for scraping and processing raw [Prometheus-formatted metrics](https://prometheus.io/docs/concepts/data_model/) from an HTTP-accessible endpoint. -menu: flux_0_x +menu: + flux_v0: + name: Work with Prometheus weight: 8 flux/v0/tags: [prometheus] --- diff --git a/content/flux/v0/query-data/_index.md b/content/flux/v0/query-data/_index.md index 038424f8a..5ca025636 100644 --- a/content/flux/v0/query-data/_index.md +++ b/content/flux/v0/query-data/_index.md @@ -2,7 +2,9 @@ title: Query data sources description: > Query different data sources with Flux including InfluxDB, SQL databases, CSV, and Prometheus. -menu: flux_0_x +menu: + flux_v0: + name: Query data sources weight: 5 --- diff --git a/content/flux/v0/write-data/_index.md b/content/flux/v0/write-data/_index.md index 293c3ee98..9707438ae 100644 --- a/content/flux/v0/write-data/_index.md +++ b/content/flux/v0/write-data/_index.md @@ -2,7 +2,9 @@ title: Write to data sources description: > Write to different data sources with Flux including InfluxDB, SQL databases, CSV, and Prometheus. -menu: flux_0_x +menu: + flux_v0: + name: Write to data sources weight: 5 --- From 279e81afe3d1eb4250f22e2390c5f3c4a3acadeb Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 2 Aug 2024 20:27:02 -0600 Subject: [PATCH 74/96] InfluxDB Clustered Helm install (#5540) * WIP helm install * WIP helm install * WIP helm install * configure clustered with helm * Apply suggestions from code review Co-authored-by: Jason Stirnaman * updates to clustered install docs --------- Co-authored-by: Jason Stirnaman --- .../install/configure-cluster/_index.md | 27 + .../directly.md} | 33 +- .../install/configure-cluster/use-helm.md | 964 ++++++++++++++++++ content/influxdb/clustered/install/deploy.md | 41 +- .../influxdb/clustered/install/licensing.md | 80 +- layouts/shortcodes/page-nav.html | 5 +- 6 files changed, 1111 insertions(+), 39 deletions(-) create mode 100644 content/influxdb/clustered/install/configure-cluster/_index.md rename content/influxdb/clustered/install/{configure-cluster.md => configure-cluster/directly.md} (97%) create mode 100644 content/influxdb/clustered/install/configure-cluster/use-helm.md diff --git a/content/influxdb/clustered/install/configure-cluster/_index.md b/content/influxdb/clustered/install/configure-cluster/_index.md new file mode 100644 index 000000000..f36a260ec --- /dev/null +++ b/content/influxdb/clustered/install/configure-cluster/_index.md @@ -0,0 +1,27 @@ +--- +title: Configure your InfluxDB cluster +description: > + InfluxDB Clustered deployments are managed using Kubernetes and configured using + a YAML configuration file. +menu: + influxdb_clustered: + name: Configure your cluster + parent: Install InfluxDB Clustered +weight: 130 +related: + - /influxdb/clustered/admin/upgrade/ +--- + +InfluxDB Clustered deployments are managed using Kubernetes and configured using +a YAML configuration file. +Apply configuration settings to your cluster by editing and applying a +Kubernetes custom resource (CRD) called `AppInstance`. +The AppInstance CRD is defined in a YAML file (use example-customer.yml as a +template) or, if using the InfluxDB Clustered Helm chart, is provided by the +chart and configured in a `values.yaml` file. + +Use one of the following methods to configure your InfluxDB cluster: + +{{< children type="anchored-list" >}} + +{{< children >}} diff --git a/content/influxdb/clustered/install/configure-cluster.md b/content/influxdb/clustered/install/configure-cluster/directly.md similarity index 97% rename from content/influxdb/clustered/install/configure-cluster.md rename to content/influxdb/clustered/install/configure-cluster/directly.md index bda192af7..41f277923 100644 --- a/content/influxdb/clustered/install/configure-cluster.md +++ b/content/influxdb/clustered/install/configure-cluster/directly.md @@ -1,19 +1,19 @@ --- -title: Configure your InfluxDB cluster +title: Use the InfluxDB AppInstance resource configuration +list_title: Configure your InfluxDB AppInstance resource directly description: > - InfluxDB Clustered deployments are managed using Kubernetes and configured using - a YAML configuration file. + Configure your InfluxDB cluster by editing configuration options in + the provided `AppInstance` resource. +menu: menu: influxdb_clustered: - name: Configure your cluster - parent: Install InfluxDB Clustered -weight: 130 -related: - - /influxdb/clustered/admin/upgrade/ + name: Configure AppInstance + parent: Configure your cluster +weight: 220 --- -InfluxDB Clustered deployments are managed using Kubernetes and configured using -a YAML configuration file. InfluxData provides the following items: +Manage your InfluxDB Clustered deployments using Kubernetes and apply configuration settings using +a YAML configuration file. - **`influxdb-docker-config.json`**: an authenticated Docker configuration file. The InfluxDB Clustered software is in a secure container registry. @@ -28,7 +28,8 @@ a YAML configuration file. InfluxData provides the following items: {{% note %}} -This documentation refers to a `myinfluxdb.yml` file that you copy from `example-customer.yml` and edit for your InfluxDB cluster. +This documentation refers to a `myinfluxdb.yml` file that you copy from +`example-customer.yml` and edit for your InfluxDB cluster. {{% /note %}} @@ -62,7 +63,9 @@ The InfluxDB installation, update, and upgrade processes are driven by editing and applying a [Kubernetes custom resource (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) called `AppInstance`. The `AppInstance` CRD is defined in a YAML file (use `example-customer.yml` as a -template) that contains key information, such as: +template). + +The `AppInstance` resource contains key information, such as: - Name of the target namespace - Version of the InfluxDB package @@ -101,7 +104,7 @@ InfluxData provides an `app-instance-schema.json` JSON schema file that VS Code ### Create a namespace for InfluxDB -Create a namespace for InfluxDB. For example, using `kubectl`:: +Create a namespace for InfluxDB--for example, enter the following `kubectl` command in your terminal: ```sh kubectl create namespace influxdb @@ -130,9 +133,9 @@ container images required to run InfluxDB Clustered. Your Kubernetes Cluster needs access to the container registry to pull down and install InfluxDB. -There are two main scenarios: +When pulling InfluxDB Clustered images, there are two main scenarios: -- You have a kubernetes cluster that can pull from the InfluxData container registry. +- You have a Kubernetes cluster that can pull from the InfluxData container registry. - You run in an environment with no network interfaces ("air-gapped") and you can only access a private container registry. diff --git a/content/influxdb/clustered/install/configure-cluster/use-helm.md b/content/influxdb/clustered/install/configure-cluster/use-helm.md new file mode 100644 index 000000000..a4717ca15 --- /dev/null +++ b/content/influxdb/clustered/install/configure-cluster/use-helm.md @@ -0,0 +1,964 @@ +--- +title: Configure your InfluxDB cluster using Helm +description: > + Use Helm to configure and deploy your InfluxDB Clustered `AppInstance` resource. +menu: + influxdb_clustered: + name: Use Helm + parent: Configure your cluster +weight: 230 +--- + +Manage your InfluxDB Clustered deployments using Kubernetes and apply configuration settings using a YAML configuration file. +The [InfluxDB Clustered Helm chart](https://github.com/influxdata/helm-charts/tree/master/charts/influxdb3-clustered) +provides an alternative method for deploying your InfluxDB cluster using +[Helm](https://helm.sh/). It acts as a wrapper for the InfluxDB `AppInstance` +resource. When using Helm, apply configuration options in a +a `values.yaml` on your local machine. + + InfluxData provides the following items: + +- **`influxdb-docker-config.json`**: an authenticated Docker configuration file. + The InfluxDB Clustered software is in a secure container registry. + This file grants access to the collection of container images required to + install InfluxDB Clustered. + +--- + +## Configuration data + +When ready to install InfluxDB, have the following information available: + +- **InfluxDB cluster hostname**: the hostname Kubernetes uses to expose InfluxDB API endpoints +- **PostgreSQL-style data source name (DSN)**: used to access your + PostgreSQL-compatible database that stores the InfluxDB Catalog. +- **Object store credentials** _(AWS S3 or S3-compatible)_ + - Endpoint URL + - Access key + - Bucket name + - Region (required for S3, may not be required for other object stores) +- **Local storage information** _(for ingester pods)_ + - Storage class + - Storage size +- **OAuth2 provider credentials** + - Client ID + - JWKS endpoint + - Device authorization endpoint + - Token endpoint + +InfluxDB is deployed to a Kubernetes namespace which, throughout the following +installation procedure, is referred to as the _target_ namespace. +For simplicity, we assume this namespace is `influxdb`, however +you may use any name you like. + +### AppInstance resource + +The InfluxDB installation, update, and upgrade processes are driven by editing +and applying a [Kubernetes custom resource (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) +called `AppInstance`. +The `AppInstance` CRD is included in the InfluxDB Clustered Helm chart and can +be configured by applying custom settings in the `values.yaml` included in the +chart. + +The `AppInstance` resource contains key information, such as: + +- Name of the target namespace +- Version of the InfluxDB package +- Reference to the InfluxDB container registry pull secrets +- Hostname where the InfluxDB API is exposed +- Parameters to connect to [external prerequisites](/influxdb/clustered/install/prerequisites/) + +### Kubit operator + +The InfluxDB Clustered Helm chart also includes the +[`kubecfg kubit` operator](https://github.com/kubecfg/kubit) (maintained by InfluxData) +which simplifies the installation and management of the InfluxDB Clustered package. +It manages the application of the jsonnet templates used to install, manage, and +update an InfluxDB cluster. + +## Configure your cluster + +1. [Install Helm](#install-helm) +2. [Create a values.yaml file](#create-a-valuesyaml-file) +3. [Create a namespace for InfluxDB](#create-a-namespace-for-influxdb) +4. [Configure access to the InfluxDB container registry](#configure-access-to-the-influxdb-container-registry) +5. [Set up cluster ingress](#set-up-cluster-ingress) +6. [Modify the configuration file to point to prerequisites](#modify-the-configuration-file-to-point-to-prerequisites) +7. [Provide a custom certificate authority bundle](#provide-a-custom-certificate-authority-bundle) + (Optional) + +### Install Helm + +If you haven't already, [install Helm](https://helm.sh/docs/intro/install/) on +your local machine. + +### Create a values.yaml file + +Download or copy the base `values.yaml` for the InfluxDB Clustered Helm chart +from GitHub and store it locally. For example--if using cURL: + +```bash +curl -O https://raw.githubusercontent.com/influxdata/helm-charts/master/charts/influxdb3-clustered/values.yaml +``` + +Or you can copy the default `values.yaml` from GitHub: + +View values.yaml on GitHub + +### Create a namespace for InfluxDB + +Create a namespace for InfluxDB. For example, using `kubectl`: + +```sh +kubectl create namespace influxdb +``` + +If you use a namespace name other than `influxdb`, update the `namespaceOverride` +field in your `values.yaml` to use your custom namespace name. + +### Configure access to the InfluxDB container registry + +The provided `influxdb-docker-config.json` grants access to a collection of +container images required to run InfluxDB Clustered. +Your Kubernetes Cluster needs access to the container registry to pull down and +install InfluxDB. + +When pulling images, there are two main scenarios: + +- You have a Kubernetes cluster that can pull from the InfluxData container registry. +- You run in an environment with no network interfaces ("air-gapped") and you + can only access a private container registry. + +In both scenarios, you need a valid container registry secret file. +Use [crane](https://github.com/google/go-containerregistry/tree/main/cmd/crane) +to create a container registry secret file. + +1. [Install crane](https://github.com/google/go-containerregistry/tree/main/cmd/crane#installation) +2. Use the following command to create a container registry secret file and + retrieve the necessary secrets: + +{{% code-placeholders "PACKAGE_VERSION" %}} + +```sh +mkdir /tmp/influxdbsecret +cp influxdb-docker-config.json /tmp/influxdbsecret/config.json +DOCKER_CONFIG=/tmp/influxdbsecret \ + crane manifest \ + us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:PACKAGE_VERSION +``` + +{{% /code-placeholders %}} + +--- + +Replace {{% code-placeholder-key %}}`PACKAGE_VERSION`{{% /code-placeholder-key %}} +with your InfluxDB Clustered package version. + +--- + +If your Docker configuration is valid and you’re able to connect to the container +registry, the command succeeds and the output is the JSON manifest for the Docker +image, similar to the following: + +{{< expand-wrapper >}} +{{% expand "View JSON manifest" %}} + +```json +{ + "schemaVersion": 2, + "config": { + "mediaType": "application/vnd.kubecfg.bundle.config.v1+json", + "digest": "sha256:6900d2f248e678176c68f3768e7e48958bb96a59232070ff31b3b018cf299aa7", + "size": 8598 + }, + "layers": [ + { + "mediaType": "application/vnd.kubecfg.bundle.tar+gzip", + "digest": "sha256:7c1d62e76287035a9b22b2c155f328fae9beff2c6aa7a09a2dd2697539f41d98", + "size": 404059 + } + ], + "annotations": { + "org.opencontainers.image.created": "1970-01-01T00:00:00Z", + "org.opencontainers.image.revision": "unknown", + "org.opencontainers.image.source": "kubecfg pack" + } +} +``` + +{{% /expand %}} +{{< /expand-wrapper >}} + +If there’s a problem with the Docker configuration, crane won't retrieve the +manifest and the output is similar to the following error: + +```sh +Error: fetching manifest us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:: GET https://us-docker.pkg.dev/v2/token?scope=repository%3Ainfluxdb2-artifacts%2Fclustered%2Finfluxdb%3Apull&service=: DENIED: Permission "artifactregistry.repositories.downloadArtifacts" denied on resource "projects/influxdb2-artifacts/locations/us/repositories/clustered" (or it may not exist) +``` + +{{< tabs-wrapper >}} +{{% tabs %}} +[Public registry (non-air-gapped)](#) +[Private registry (air-gapped)](#) +{{% /tabs %}} + +{{% tab-content %}} + + + +#### Public registry (non-air-gapped) + +To pull from the InfluxData registry, you need to create a Kubernetes secret in the target namespace. + +```sh +kubectl create secret docker-registry gar-docker-secret \ + --from-file=.dockerconfigjson=influxdb-docker-config.json \ + --namespace influxdb +``` + +If successful, the output is the following: + +```text +secret/gar-docker-secret created +``` + +By default, this secret is named `gar-docker-secret`. +If you change the name of this secret, you must also change the value of the +`imagePullSecrets.name` field in your `values.yaml`. + + + +{{% /tab-content %}} +{{% tab-content %}} + + + +#### Private registry (air-gapped) + +If your Kubernetes cluster can't use a public network to download container images +from our container registry, do the following: + +1. Copy the images from the InfluxDB registry to your own private registry. +2. Configure your `AppInstance` resource with a reference to your private + registry name. +3. Provide credentials to your private registry. + +The list of images that you need to copy is included in the package metadata. +You can obtain it with any standard OCI image inspection tool. For example: + +{{% code-placeholders "PACKAGE_VERSION" %}} + +```sh +DOCKER_CONFIG=/tmp/influxdbsecret \ +crane config \ + us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:PACKAGE_VERSION \ + | jq -r '.metadata["oci.image.list"].images[]' \ + > /tmp/images.txt +``` + +{{% /code-placeholders %}} + +The output is a list of image names, similar to the following: + +``` +us-docker.pkg.dev/influxdb2-artifacts/idpe/idpe-cd-ioxauth@sha256:5f015a7f28a816df706b66d59cb9d6f087d24614f485610619f0e3a808a73864 +us-docker.pkg.dev/influxdb2-artifacts/iox/iox@sha256:b59d80add235f29b806badf7410239a3176bc77cf2dc335a1b07ab68615b870c +... +``` + +Use `crane` to copy the images to your private registry: + +{{% code-placeholders "REGISTRY_HOSTNAME" %}} + +```sh + + +{{% /tab-content %}} +{{< /tabs-wrapper >}} + +### Set up cluster ingress + +{{% note %}} +InfluxDB Clustered components use gRPC/HTTP2 protocols. If using an external load balancer, +you may need to explicitly enable these protocols on your load balancers. +{{% /note %}} + +The InfluxDB Clustered Helm chart includes the +[Kubernetes Nginx Ingress Controller](https://github.com/kubernetes/ingress-nginx). +Add a valid TLS Certificate to the cluster as a secret. +Provide the paths to the TLS certificate file and key file: + +{{% code-placeholders "TLS_(CERT|KEY)_PATH" %}} + +```sh +kubectl create secret tls ingress-tls \ + --namespace influxdb \ + --cert TLS_CERT_PATH \ + --key TLS_KEY_PATH +``` + +{{% /code-placeholders %}} + +--- + +Replace the following: + +- _{{% code-placeholder-key %}}`TLS_CERT_PATH`{{% /code-placeholder-key %}}: + Path to the certificate file on your local machine._ +- _{{% code-placeholder-key %}}`TLS_KEY_PATH`{{% /code-placeholder-key %}}: + Path to the certificate secret key file on your local machine._ + +--- + +Provide the TLS certificate secret to the InfluxDB configuration in the +[Configure ingress step](#configure-ingress). + +### Modify the configuration file to point to prerequisites + +Update your `values.yaml` file with credentials necessary to connect your +cluster to your prerequisites. + +- [Configure ingress](#configure-ingress) +- [Configure the object store](#configure-the-object-store) +- [Configure the catalog database](#configure-the-catalog-database) +- [Configure local storage for ingesters](#configure-local-storage-for-ingesters) +- [Configure your OAuth2 provider](#configure-your-oauth2-provider) +- [Configure the size of your cluster](#configure-the-size-of-your-cluster) + +#### Configure ingress + +To configure ingress, provide values for the following fields in your +`values.yaml`: + +- **`ingress.hosts`: Cluster hostnames** + + Provide the hostnames that Kubernetes should use to expose the InfluxDB API + endpoints--for example: `{{< influxdb/host >}}`. + + _You can provide multiple hostnames. The ingress layer accepts incoming + requests for all listed hostnames. This can be useful if you want to have + distinct paths for your internal and external traffic._ + + {{% note %}} + You are responsible for configuring and managing DNS. Options include: + +- Manually managing DNS records +- Using [external-dns](https://github.com/kubernetes-sigs/external-dns) to + synchronize exposed Kubernetes services and ingresses with DNS providers. + {{% /note %}} + +- **`ingress.tlsSecretName`: TLS certificate secret name** + + Provide the name of the secret that + [contains your TLS certificate and key](#set-up-cluster-ingress). + The examples in this guide use the name `ingress-tls`. + + _The `tlsSecretName` field is optional. You may want to use it if you already + have a TLS certificate for your DNS name._ + + {{< expand-wrapper >}} + {{% expand "Use cert-manager and Let's Encrypt to manage TLS certificates" %}} + +If you instead want to automatically create an [ACME](https://datatracker.ietf.org/doc/html/rfc8555) +certificate (for example, using [Let's Encrypt](https://letsencrypt.org/)), refer +to the [cert-manager documentation](https://cert-manager.io/docs/usage/ingress/). +In `ingress.tlsSecretName`, provide a name for the secret it should create. + +{{% note %}} +If you choose to use cert-manager, it's your responsibility to install and configure it. +{{% /note %}} +{{% /expand %}} +{{< /expand-wrapper >}} + +{{% code-callout "ingress-tls|cluster-host\.com" "green" %}} + +```yaml +ingress: + hosts: + - {{< influxdb/host >}} + tlsSecretName: ingress-tls +``` + +{{% /code-callout %}} + +#### Configure the object store + +To connect your InfluxDB cluster to your object store. The information required +to connect to your object store depends on your object storage provider. + +{{< tabs-wrapper >}} +{{% tabs %}} +[Amazon S3 or S3-compatible](#) +[Azure Blob Storage](#) +[Google Cloud Storage](#) +{{% /tabs %}} + +{{% tab-content %}} + + + +If using Amazon S3 or an S3-compatible object store, provide values for the +following fields in your `values.yaml`: + +- `objectStore` + - `bucket`: Object storage bucket name + - `s3`: + - `endpoint`: Object storage endpoint URL + - `allowHttp`: _Set to `true` to allow unencrypted HTTP connections_ + - `accessKey.value`: Object storage access key + _(can use a `value` literal or `valueFrom` to retrieve the value from a secret)_ + - `secretKey.value`: Object storage secret key + _(can use a `value` literal or `valueFrom` to retrieve the value from a secret)_ + - `region`: Object storage region + +{{% code-placeholders "S3_(URL|ACCESS_KEY|SECRET_KEY|BUCKET_NAME|REGION)" %}} + +```yml +objectStore: + # Bucket that the Parquet files will be stored in + bucket: S3_BUCKET_NAME + + s3: + # URL for S3 Compatible object store + endpoint: S3_URL + + # Set to true to allow communication over HTTP (instead of HTTPS) + allowHttp: 'false' + + # S3 Access Key + # This can also be provided as a valueFrom: secretKeyRef: + accessKey: + value: S3_ACCESS_KEY + + # S3 Secret Key + # This can also be provided as a valueFrom: secretKeyRef: + secretKey: + value: S3_SECRET_KEY + + # This value is required for AWS S3, it may or may not be required for other providers. + region: S3_REGION +``` + +{{% /code-placeholders %}} + +--- + +Replace the following: + +- {{% code-placeholder-key %}}`S3_BUCKET_NAME`{{% /code-placeholder-key %}}: Object storage bucket name +- {{% code-placeholder-key %}}`S3_URL`{{% /code-placeholder-key %}}: Object storage endpoint URL +- {{% code-placeholder-key %}}`S3_ACCESS_KEY`{{% /code-placeholder-key %}}: Object storage access key +- {{% code-placeholder-key %}}`S3_SECRET_KEY`{{% /code-placeholder-key %}}: Object storage secret key +- {{% code-placeholder-key %}}`S3_REGION`{{% /code-placeholder-key %}}: Object storage region + +--- + + + +{{% /tab-content %}} +{{% tab-content %}} + + + +If using Azure Blob Storage as your object store, provide values for the +following fields in your `values.yaml`: + +- `objectStore` + - `bucket`: Azure Blob Storage bucket name + - `azure`: + - `accessKey.value`: Azure Blob Storage access key + _(can use a `value` literal or `valueFrom` to retrieve the value from a secret)_ + - `account.value`: Azure Blob Storage account ID + _(can use a `value` literal or `valueFrom` to retrieve the value from a secret)_ + +{{% code-placeholders "AZURE_(BUCKET_NAME|ACCESS_KEY|STORAGE_ACCOUNT)" %}} + +```yml +objectStore: + # Bucket that the Parquet files will be stored in + bucket: AZURE_BUCKET_NAME + + azure: + # Azure Blob Storage Access Key + # This can also be provided as a valueFrom: + accessKey: + value: AZURE_ACCESS_KEY + + # Azure Blob Storage Account + # This can also be provided as a valueFrom: secretKeyRef: + account: + value: AZURE_STORAGE_ACCOUNT +``` + +{{% /code-placeholders %}} + +--- + +Replace the following: + +- {{% code-placeholder-key %}}`AZURE_BUCKET_NAME`{{% /code-placeholder-key %}}: Object storage bucket name +- {{% code-placeholder-key %}}`AZURE_ACCESS_KEY`{{% /code-placeholder-key %}}: Azure Blob Storage access key +- {{% code-placeholder-key %}}`AZURE_STORAGE_ACCOUNT`{{% /code-placeholder-key %}}: Azure Blob Storage account ID + +--- + + + +{{% /tab-content %}} +{{% tab-content %}} + + + +If using Google Cloud Storage as your object store, provide values for the +following fields in your `values.yaml`: + +- `objectStore` + - `bucket`: Google Cloud Storage bucket name + - `google`: + - `serviceAccountSecret.name`: the Kubernetes Secret name that contains your + Google IAM service account credentials + - `serviceAccountSecret.key`: the key inside of your Google IAM secret that + contains your Google IAM account credentials + +{{% code-placeholders "GOOGLE_(BUCKET_NAME|IAM_SECRET|CREDENTIALS_KEY)" %}} + +```yml +objectStore: + # Bucket that the Parquet files will be stored in + bucket: GOOGLE_BUCKET_NAME + + google: + # This section is not needed if you are using GKE Workload Identity. + # It is only required to use explicit service account secrets (JSON files) + serviceAccountSecret: + # Kubernetes Secret name containing the credentials for a Google IAM + # Service Account. + name: GOOGLE_IAM_SECRET + # The key within the Secret containing the credentials. + key: GOOGLE_CREDENTIALS_KEY +``` + +{{% /code-placeholders %}} + +--- + +Replace the following: + +- {{% code-placeholder-key %}}`GOOGLE_BUCKET_NAME`{{% /code-placeholder-key %}}: + Google Cloud Storage bucket name +- {{% code-placeholder-key %}}`GOOGLE_IAM_SECRET`{{% /code-placeholder-key %}}: + the Kubernetes Secret name that contains your Google IAM service account + credentials +- {{% code-placeholder-key %}}`GOOGLE_CREDENTIALS_KEY`{{% /code-placeholder-key %}}: + the key inside of your Google IAM secret that contains your Google IAM account + credentials + +--- + + + +{{% /tab-content %}} +{{< /tabs-wrapper >}} + +#### Configure the catalog database + +The InfluxDB catalog is a PostgreSQL-compatible relational database that stores +metadata about your time series data. +To connect your InfluxDB cluster to your PostgreSQL-compatible database, +provide values for the following fields in your `values.yaml`: + +{{% note %}} +We recommend storing sensitive credentials, such as your PostgreSQL-compatible DSN, +as secrets in your Kubernetes cluster. +{{% /note %}} + +- `catalog.dsn` + - `SecretName`: Secret name + - `SecretKey`: Key in the secret that contains the DSN + +{{% code-placeholders "SECRET_(NAME|KEY)" %}} + +```yml +catalog: + # Secret name and key within the secret containing the dsn string to connect + # to the catalog + dsn: + # Kubernetes Secret name containing the dsn for the catalog. + SecretName: SECRET_NAME + # The key within the Secret containing the dsn. + SecretKey: SECRET_KEY +``` + +{{% /code-placeholders %}} + +--- + +Replace the following: + +- {{% code-placeholder-key %}}`SECRET_NAME`{{% /code-placeholder-key %}}: + Name of the secret containing your PostgreSQL-compatible DSN +- {{% code-placeholder-key %}}`SECRET_KEY`{{% /code-placeholder-key %}}: + Key in the secret that references your PostgreSQL-compatible DSN + +--- + +{{% note %}} + +##### PostgreSQL instances without TLS or SSL + +If your PostgreSQL-compatible instance runs without TLS or SSL, you must include +the `sslmode=disable` parameter in the DSN. For example: + +{{% code-callout "sslmode=disable" %}} + +``` +postgres://username:passw0rd@mydomain:5432/influxdb?sslmode=disable +``` + +{{% /code-callout %}} +{{% /note %}} + +#### Configure local storage for ingesters + +InfluxDB ingesters require local storage to store the Write Ahead Log (WAL) for +incoming data. +To connect your InfluxDB cluster to local storage, provide values for the +following fields in your `values.yaml`: + +- `ingesterStorage` + - `storageClassName`: [Kubernetes storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/). + This differs based on the Kubernetes environment and desired storage characteristics. + - `storage`: Storage size. We recommend a minimum of 2 gibibytes (`2Gi`). + +{{% code-placeholders "STORAGE_(CLASS|SIZE)" %}} + +```yaml +ingesterStorage: + # (Optional) Set the storage class. This will differ based on the K8s + # environment and desired storage characteristics. + # If not set, the default storage class will be used. + storageClassName: STORAGE_CLASS + # Set the storage size (minimum 2Gi recommended) + storage: STORAGE_SIZE +``` + +{{% /code-placeholders %}} + +--- + +Replace the following: + +- {{% code-placeholder-key %}}`STORAGE_CLASS`{{% /code-placeholder-key %}}: + [Kubernetes storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/) +- {{% code-placeholder-key %}}`STORAGE_SIZE`{{% /code-placeholder-key %}}: + Storage size (example: `2Gi`) + +--- + +#### Configure your OAuth2 provider + +InfluxDB Clustered uses OAuth2 to authenticate administrative access to your cluster. +To connect your InfluxDB cluster to your OAuth2 provide, provide values for the +following fields in your `values.yaml`: + +- `admin` + - `identityProvider`: Identity provider name. + _If using Microsoft Entra ID (formerly Azure Active Directory), set the name + to `azure`_. + - `jwksEndpoint`: JWKS endpoint provide by your identity provider. + - `users`: List of OAuth2 users to grant administrative access to your + InfluxDB cluster. IDs are provided by your identity provider. + +Below are examples for **Keycloak**, **Auth0**, and **Microsoft Entra ID**, but +other OAuth2 providers should work as well: + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Keycloak](#) +[Auth0](#) +[Microsoft Entra ID](#) +{{% /code-tabs %}} +{{% code-tab-content %}} + +{{% code-callout "keycloak" "green" %}} +{{% code-placeholders "KEYCLOAK_(HOST|REALM|USER_ID)" %}} + +```yaml +admin: + # The identity provider to be used e.g. "keycloak", "auth0", "azure", etc + # Note for Azure Active Directory it must be exactly "azure" + identityProvider: keycloak + # The JWKS endpoint provided by the Identity Provider + jwksEndpoint: |- + https://KEYCLOAK_HOST/auth/realms/KEYCLOAK_REALM/protocol/openid-connect/certs + # The list of users to grant access to Clustered via influxctl + users: + # All fields are required but `firstName`, `lastName`, and `email` can be + # arbitrary values. However, `id` must match the user ID provided by Keycloak. + - id: KEYCLOAK_USER_ID + firstName: Marty + lastName: McFly + email: mcfly@influxdata.com +``` + +{{% /code-placeholders %}} +{{% /code-callout %}} + +--- + +Replace the following: + +- {{% code-placeholder-key %}}`KEYCLOAK_HOST`{{% /code-placeholder-key %}}: + Host and port of your Keycloak server +- {{% code-placeholder-key %}}`KEYCLOAK_REALM`{{% /code-placeholder-key %}}: + Keycloak realm +- {{% code-placeholder-key %}}`KEYCLOAK_USER_ID`{{% /code-placeholder-key %}}: + Keycloak user ID to grant InfluxDB administrative access to + +--- + +{{% /code-tab-content %}} +{{% code-tab-content %}} + +{{% code-callout "auth0" "green" %}} +{{% code-placeholders "AUTH0_(HOST|USER_ID)" %}} + +```yaml +admin: + # The identity provider to be used e.g. "keycloak", "auth0", "azure", etc + # Note for Azure Active Directory it must be exactly "azure" + identityProvider: auth0 + # The JWKS endpoint provided by the Identity Provider + jwksEndpoint: |- + https://AUTH0_HOST/.well-known/openid-configuration + # The list of users to grant access to Clustered via influxctl + users: + - AUTH0_USER_ID +``` + +{{% /code-placeholders %}} +{{% /code-callout %}} + +--- + +Replace the following: + +- {{% code-placeholder-key %}}`AUTH0_HOST`{{% /code-placeholder-key %}}: + Host and port of your Auth0 server +- {{% code-placeholder-key %}}`AUTH0_USER_ID`{{% /code-placeholder-key %}}: + Auth0 user ID to grant InfluxDB administrative access to + +--- + +{{% /code-tab-content %}} +{{% code-tab-content %}} + +{{% code-callout "azure" "green" %}} +{{% code-placeholders "AZURE_(USER|TENANT)_ID" %}} + +```yaml +admin: + # The identity provider to be used e.g. "keycloak", "auth0", "azure", etc + # Note for Azure Active Directory it must be exactly "azure" + identityProvider: azure + # The JWKS endpoint provided by the Identity Provider + jwksEndpoint: |- + https://login.microsoftonline.com/AZURE_TENANT_ID/discovery/v2.0/keys + # The list of users to grant access to Clustered via influxctl + users: + - AZURE_USER_ID +``` + +{{% /code-placeholders %}} +{{% /code-callout %}} + +--- + +Replace the following: + +- {{% code-placeholder-key %}}`AZURE_TENANT_ID`{{% /code-placeholder-key %}}: + Microsoft Entra tenant ID +- {{% code-placeholder-key %}}`AZURE_USER_ID`{{% /code-placeholder-key %}}: + Microsoft Entra user ID to grant InfluxDB administrative access to + _(See [Find user IDs with Microsoft Entra ID](/influxdb/clustered/install/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ + +--- + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +##### Adding users + +Finally, add all the users you wish to have access to use `influxctl`. +Update the `admin.users` field with a list of these users. + + +#### Configure the size of your cluster + +By default, an InfluxDB cluster is configured with the following: + +- **3 ingesters**: + Ensures redundancy on the write path. +- **1 compactor**: + While you can have multiple compactors, it is more efficient to scale the + compactor vertically (assign more CPU and memory) rather than horizontally + (increase the number of compactors). +- **1 querier**: + The optimal number of queriers depends on the number of concurrent queries you are + likely to have and how long they take to execute. + +The default values provide a good starting point for testing. +Once you have your cluster up and running and are looking for scaling recommendations, +please [contact the InfluxData Support team](https://support.influxdata.com). +We are happy to work with you to identify appropriate scale settings based on +your anticipated workload. + +**To use custom scale settings for your InfluxDB cluster**, modify the following fields +in your values.yaml`. If omitted, your cluster will use the default scale settings. + +- `resources` + - `ingester.requests` + - `cpu`: CPU resource units to assign to ingesters + - `memory`: Memory resource units to assign to ingesters + - `replicas`: Number of ingester replicas to provision + - `compactor.requests` + - `cpu`: CPU resource units to assign to compactors + - `memory`: Memory resource units to assign to compactors + - `replicas`: Number of compactor replicas to provision + - `querier.requests` + - `cpu`: CPU resource units to assign to queriers + - `memory`: Memory resource units to assign to queriers + - `replicas`: Number of querier replicas to provision + - `router.requests` + - `cpu`: CPU resource units to assign to routers + - `memory`: Memory resource units to assign to routers + - `replicas`: Number of router replicas to provision + +###### Related Kubernetes documentation + +- [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) +- [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) + +{{% code-placeholders "(INGESTER|COMPACTOR|QUERIER|ROUTER)_(CPU|MEMORY|REPLICAS)" %}} + +```yml +# The following settings tune the various pods for their cpu/memory/replicas +# based on workload needs. Only uncomment the specific resources you want +# to change. Anything left commented will use the package default. +resources: + # The ingester handles data being written + ingester: + requests: + cpu: INGESTER_CPU + memory: INGESTER_MEMORY + replicas: INGESTER_REPLICAS # Default is 3 + + # The compactor reorganizes old data to improve query and storage efficiency. + compactor: + requests: + cpu: COMPACTOR_CPU + memory: COMPACTOR_MEMORY + replicas: COMPACTOR_REPLICAS # Default is 1 + + # The querier handles querying data. + querier: + requests: + cpu: QUERIER_CPU + memory: QUERIER_MEMORY + replicas: QUERIER_REPLICAS # Default is 1 + + # The router performs some api routing. + router: + requests: + cpu: ROUTER_CPU + memory: ROUTER_MEMORY + replicas: ROUTER_REPLICAS # Default is 1 +``` + +{{% /code-placeholders %}} + +### Provide a custom certificate authority bundle {note="Optional"} + +InfluxDB attempts to make TLS connections to the services it depends on; notably +the [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog), +and the [Object store](/influxdb/clustered/reference/internals/storage-engine/#object-store). +InfluxDB validates the certificates for all of the connections it makes. + +**If you host these services yourself and you use a private or otherwise not +well-known certificate authority to issue certificates to theses services**, +InfluxDB will not recognize the issuer and will be unable to validate the certificates. +To allow InfluxDB to validate these certificates, provide a PEM certificate +bundle containing your custom certificate authority chain. + +1. Use `kubectl` to create a config map containing your PEM bundle. + Your certificate authority administrator should provide you with a + PEM-formatted certificate bundle file. + + {{% note %}} +This PEM-formatted bundle file is *not* the certificate that InfluxDB uses to +host its own TLS endpoints. This bundle establishes a chain of trust for the +external services that InfluxDB depends on. + {{% /note %}} + + In the example below, `private_ca.pem` is the certificate bundle file. + + ```sh + kubectl --namespace influxdb create configmap custom-ca --from-file=certs.pem=/path/to/private_ca.pem + ``` + + {{% note %}} +It's possible to append multiple certificates into the same bundle. +This can help if you need to include intermediate certificates or explicitly +include leaf certificates. Leaf certificates should be included before any +intermediate certificates they depend on. The root certificate should +be last in the bundle. + {{% /note %}} + +2. Update your `values.yaml` to enable custom egress and refer to your + certificate authority config map. Set `useCustomEgress` to `true` and update + the `egress` property to refer to that config map. For example: + + ```yml + useCustomEgress: true + egress: + # # If you're using a custom CA you will need to specify the full custom CA bundle here. + # # + # # NOTE: the custom CA is currently only honoured for outbound requests used to obtain + # # the JWT public keys from your identiy provider (see `jwksEndpoint`). + customCertificates: + valueFrom: + configMapKeyRef: + key: ca.pem + name: custom-ca + ``` + +{{< page-nav prev="/influxdb/clustered/install/auth/" prevText="Set up authentication" next="/influxdb/clustered/install/licensing" nextText="Install your license" tab="Helm" >}} diff --git a/content/influxdb/clustered/install/deploy.md b/content/influxdb/clustered/install/deploy.md index cb6d95142..67903c252 100644 --- a/content/influxdb/clustered/install/deploy.md +++ b/content/influxdb/clustered/install/deploy.md @@ -23,16 +23,16 @@ following tools: InfluxDB Clustered uses an `AppInstance` Kubernetes custom resource (CR) to configure and deploy your InfluxDB Cluster. -Installing a `CustomResourceDefinition` (CRD) requires cluster-wide permissions and may cause `kubectl` to -fail if you do not have those permissions in your cluster. +Installing a `CustomResourceDefinition` (CRD) requires cluster-wide permissions +and may cause `kubectl` to fail if you do not have those permissions in your cluster. `kubectl` uses your local credentials to install the `AppInstance` CRD. If you do not have the necessary permissions, you can -[use the `kubit` CLI to manually install the package in your cluster](?t=kubit#kubectl-or-kubit). +[use the `kubit` CLI to manually install the package in your cluster](?t=kubit#kubectl-kubit-helm). {{% note %}} **If you meet any of the following criteria, -[install and use the `kubit` CLI](?t=kubit#kubectl-or-kubit) +[install and use the `kubit` CLI](?t=kubit#kubectl-kubit-helm) on your local machine. This allows you to act as the operator would and deploy your cluster, but from your terminal.** @@ -44,14 +44,19 @@ your cluster, but from your terminal.** - You do not want to run the operator in your Kubernetes cluster. {{% /note %}} - +You can also use [Helm](https://helm.sh/) and the +[InfluxDB Clustered Helm chart](https://github.com/influxdata/helm-charts/tree/master/charts/influxdb3-clustered) +to deploy your InfluxDB cluster. - + + + {{< tabs-wrapper >}} {{% tabs %}} [kubectl](#) [kubit](#) +[Helm](#) {{% /tabs %}} {{% tab-content %}} @@ -91,6 +96,30 @@ for tool dependencies, meaning the required versions are tracked by `kubit`. +{{% /tab-content %}} +{{% tab-content %}} + + + +1. Add the InfluxData Helm chart repository: + + ```bash + helm repo add influxdata https://helm.influxdata.com/ + ``` + +2. Deploy your Helm chart using your modified local `values.yaml`: + + ```bash + helm upgrade \ + --install \ + influxdb \ + influxdata/influxdb3-clustered \ + -f ./values.yml \ + --namespace influxdb + ``` + + + {{% /tab-content %}} {{< /tabs-wrapper >}} diff --git a/content/influxdb/clustered/install/licensing.md b/content/influxdb/clustered/install/licensing.md index 0dd843780..df245008f 100644 --- a/content/influxdb/clustered/install/licensing.md +++ b/content/influxdb/clustered/install/licensing.md @@ -5,7 +5,7 @@ description: > Clustered software. menu: influxdb_clustered: - name: Install your License + name: Install your license parent: Install InfluxDB Clustered weight: 135 influxdb/clustered/tags: [licensing] @@ -47,20 +47,44 @@ To deactivate license enforcement, remove the `useLicensedBinaries` feature flag ``` 4. - Update your `AppInstance` resource to enable the `useLicensedBinaries` feature flag. - Add the `useLicensedBinaries` entry to the `.spec.package.spec.featureFlags` - property--for example: + Update your `AppInstance` resource to activate the `useLicensedBinaries` feature flag: + + - If configuring the `AppInstance` resource directly, add the + `useLicensedBinaries` entry to the `.spec.package.spec.featureFlags` + property. + - If using the [InfluxDB Clustered Helm chart](https://github.com/influxdata/helm-charts/tree/master/charts/influxdb3-clustered), add the `useLicensedBinaries` entry to the + `featureFlags` property in your `values.yaml`. - ```yml - apiVersion: kubecfg.dev/v1alpha1 - kind: AppInstance - # ... + {{< code-tabs-wrapper >}} +{{% code-tabs %}} +[AppInstance](#) +[Helm](#) +{{% /code-tabs %}} +{{% code-tab-content %}} + +```yml +apiVersion: kubecfg.dev/v1alpha1 +kind: AppInstance +# ... +spec: + package: spec: - package: - spec: - featureFlags: - - useLicensedBinaries - ``` + featureFlags: + - useLicensedBinaries +``` + +{{% /code-tab-content %}} +{{% code-tab-content %}} + +```yml +# values.yaml + +featureFlags: + - useLicensedBinaries +``` + +{{% /code-tab-content %}} + {{< /code-tabs-wrapper >}} InfluxDB Clustered detects the `License` resource and extracts the credentials into a secret required by InfluxDB Clustered Kubernetes pods. @@ -73,8 +97,12 @@ If you are currently using a non-licensed preview release of InfluxDB Clustered and want to upgrade to a licensed release, do the following: 1. [Install an InfluxDB license](#install-your-influxdb-license) -2. In your `myinfluxdb.yml`, update the package version defined in - `spec.package.image` to use a licensed release. +2. If you [use the `AppInstance` resource configuration](/influxdb/clustered/install/configure-cluster/directly/) to configure your cluster, in your `myinfluxdb.yml`, + update the package version defined in `spec.package.image` to use a licensed + release. + + If using the InfluxDB Clustered Helm chart, update the `image.tag` property + in your `values.yaml`to use a licensed release. {{% warn %}} #### Upgrade to checkpoint releases first @@ -88,6 +116,13 @@ corrupt or lost data. {{% code-placeholders "PACKAGE_VERSION" %}} +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[AppInstance](#) +[Helm](#) +{{% /code-tabs %}} +{{% code-tab-content %}} + ```yml apiVersion: kubecfg.dev/v1alpha1 kind: AppInstance @@ -98,6 +133,19 @@ spec: image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:PACKAGE_VERSION ``` +{{% /code-tab-content %}} +{{% code-tab-content %}} + +```yml +# values.yaml + +image: + tag: PACKAGE_VERSION +``` + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + {{% /code-placeholders %}} Replace {{% code-placeholder-key %}}`PACKAGE_VERSION`{{% /code-placeholder-key %}} with @@ -182,4 +230,4 @@ kubectl logs deployment/license-controller --namespace NAMESPACE {{% /code-placeholders %}} -{{< page-nav prev="/influxdb/clustered/install/configure-cluster/" prevText="Configure your cluster" next="/influxdb/clustered/install/deploy/" nextText="Deploy your cluster" >}} +{{< page-nav prev="/influxdb/clustered/install/configure-cluster/" prevText="Configure your cluster" next="/influxdb/clustered/install/deploy/" nextText="Deploy your cluster" keepTab=true >}} diff --git a/layouts/shortcodes/page-nav.html b/layouts/shortcodes/page-nav.html index eff32cf10..bbc78e324 100644 --- a/layouts/shortcodes/page-nav.html +++ b/layouts/shortcodes/page-nav.html @@ -5,7 +5,8 @@ {{ $prevPage := .Site.GetPage (replaceRE `\/$` "" $prev) }} {{ $nextPage := .Site.GetPage (replaceRE `\/$` "" $next) }} {{ $keepTab := .Get "keepTab" | default false}} +{{ $tab := .Get "tab" | default ""}}
-{{ if ne (len $prev) 0 }}{{ if ne (len $prevText) 0 }}{{ $prevText }}{{ else if $prevPage.Params.list_title }}{{ $prevPage.Params.list_title }}{{ else }}{{ $prevPage.Title }}{{ end }}{{ end }} -{{ if ne (len $next) 0 }}{{ if ne (len $nextText) 0 }}{{ $nextText }}{{ else if $nextPage.Params.list_title }}{{ $nextPage.Params.list_title }}{{ else }}{{ $nextPage.Title }}{{ end }}{{ end }} +{{ if ne (len $prev) 0 }}{{ if ne (len $prevText) 0 }}{{ $prevText }}{{ else if $prevPage.Params.list_title }}{{ $prevPage.Params.list_title }}{{ else }}{{ $prevPage.Title }}{{ end }}{{ end }} +{{ if ne (len $next) 0 }}{{ if ne (len $nextText) 0 }}{{ $nextText }}{{ else if $nextPage.Params.list_title }}{{ $nextPage.Params.list_title }}{{ else }}{{ $nextPage.Title }}{{ end }}{{ end }}
\ No newline at end of file From bf4417a5773392df218455c5d83cfc88dd5ec7ac Mon Sep 17 00:00:00 2001 From: Jack <56563911+jdockerty@users.noreply.github.com> Date: Sat, 3 Aug 2024 08:21:26 +0100 Subject: [PATCH 75/96] docs: add system table warning (#5546) Co-authored-by: Jason Stirnaman --- .../clustered/reference/internals/system-tables.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/influxdb/clustered/reference/internals/system-tables.md b/content/influxdb/clustered/reference/internals/system-tables.md index 9f557bb9e..7241273e8 100644 --- a/content/influxdb/clustered/reference/internals/system-tables.md +++ b/content/influxdb/clustered/reference/internals/system-tables.md @@ -13,6 +13,14 @@ related: - /influxdb/clustered/reference/sql/information-schema/ --- +{{% warn %}} +Queries of InfluxDB system tables may affect production performance while +system tables are accessed. + +System tables are not currently part of the stable API and the schema may change +in subsequent releases. +{{% /warn %}} + InfluxDB system measurements contain time series data used by and generated from the InfluxDB internal monitoring system. From 53dedf22432596241f9be39a582e60da1905825a Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 5 Aug 2024 09:18:27 -0500 Subject: [PATCH 76/96] fix(v2): missing volumes section in Docker compose example - Closes #5551 --- content/influxdb/v2/install/use-docker-compose.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/content/influxdb/v2/install/use-docker-compose.md b/content/influxdb/v2/install/use-docker-compose.md index 129f79b25..c3b43a3d8 100644 --- a/content/influxdb/v2/install/use-docker-compose.md +++ b/content/influxdb/v2/install/use-docker-compose.md @@ -76,9 +76,12 @@ Follow steps to set up and run InfluxDB using Docker Compose and `secrets`: file: ~/.env.influxdb2-admin-password influxdb2-admin-token: file: ~/.env.influxdb2-admin-token + volumes: + influxdb2-data: + influxdb2-config: ``` -3. For each secret in `compose.yaml`, create a file that contains the secret +1. For each secret in `compose.yaml`, create a file that contains the secret value--for example: - `~/.env.influxdb2-admin-username`: @@ -99,7 +102,7 @@ Follow steps to set up and run InfluxDB using Docker Compose and `secrets`: MyInitialAdminToken0== ``` -4. To set up and run InfluxDB, enter the following command in your +2. To set up and run InfluxDB, enter the following command in your terminal: From 0485bad99089233009efd8d87b5152c48fd9cac8 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 5 Aug 2024 09:33:08 -0500 Subject: [PATCH 77/96] Update content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md Co-authored-by: Scott Anderson --- .../reference/syntax/delete-predicate.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md b/content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md index edcbe5113..2f0e1a0ee 100644 --- a/content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md +++ b/content/influxdb/cloud-serverless/reference/syntax/delete-predicate.md @@ -20,13 +20,3 @@ InfluxDB Cloud Serverless does not currently support deleting data. This command is only supported when used with **InfluxDB OSS v2** and **InfluxDB Cloud (TSM)**. {{% /warn %}} - -{{< duplicate-oss >}} - -{{% warn %}} -#### InfluxDB Cloud Serverless does not support data deletion - -InfluxDB Cloud Serverless does not currently support deleting data. -This command is only supported when used with **InfluxDB OSS v2** and -**InfluxDB Cloud (TSM)**. -{{% /warn %}} \ No newline at end of file From c4dbae2c32a5400066ddabf2e7fc9852f89edbeb Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 5 Aug 2024 10:05:55 -0500 Subject: [PATCH 78/96] fix(v2): Revert number changes. --- content/influxdb/v2/install/use-docker-compose.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/influxdb/v2/install/use-docker-compose.md b/content/influxdb/v2/install/use-docker-compose.md index c3b43a3d8..17cc0fccd 100644 --- a/content/influxdb/v2/install/use-docker-compose.md +++ b/content/influxdb/v2/install/use-docker-compose.md @@ -81,7 +81,7 @@ Follow steps to set up and run InfluxDB using Docker Compose and `secrets`: influxdb2-config: ``` -1. For each secret in `compose.yaml`, create a file that contains the secret +3. For each secret in `compose.yaml`, create a file that contains the secret value--for example: - `~/.env.influxdb2-admin-username`: @@ -102,7 +102,7 @@ Follow steps to set up and run InfluxDB using Docker Compose and `secrets`: MyInitialAdminToken0== ``` -2. To set up and run InfluxDB, enter the following command in your +4. To set up and run InfluxDB, enter the following command in your terminal: From ae7778d91c2d427a92faaaf59c6710ec41b74b79 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 5 Aug 2024 11:08:53 -0500 Subject: [PATCH 79/96] fix(clustered): remove link to missing users page: - Closes https://github.com/influxdata/DAR/issues/436 - Hide link until users page is added - Cleanup --- .../install/configure-cluster/directly.md | 29 +++++++++++-------- 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/content/influxdb/clustered/install/configure-cluster/directly.md b/content/influxdb/clustered/install/configure-cluster/directly.md index 41f277923..cea18f965 100644 --- a/content/influxdb/clustered/install/configure-cluster/directly.md +++ b/content/influxdb/clustered/install/configure-cluster/directly.md @@ -89,6 +89,8 @@ The `AppInstance` resource contains key information, such as: Copy the provided `example-customer.yml` file to create a new configuration file specific to your InfluxDB cluster. For example, `myinfluxdb.yml`. + + ```sh cp example-customer.yml myinfluxdb.yml ``` @@ -735,34 +737,37 @@ Replace the following: {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -##### Adding users +##### Add users -Finally, add all the users you wish to have access to use `influxctl`. -Update the `spec.package.spec.admin.users` field with a list of these users. +Finally, to give users access to use `influxctl`, add the list of users to the `spec.package.spec.admin.users` field. + + #### Configure the size of your cluster -By default, an InfluxDB cluster is configured with the following: +##### Default scale settings -- **3 ingesters**: +- **3 ingesters**: Ensures redundancy on the write path. -- **1 compactor**: +- **1 compactor**: While you can have multiple compactors, it is more efficient to scale the compactor vertically (assign more CPU and memory) rather than horizontally (increase the number of compactors). -- **1 querier**: +- **1 querier**: The optimal number of queriers depends on the number of concurrent queries you are likely to have and how long they take to execute. The default values provide a good starting point for testing. -Once you have your cluster up and running and are looking for scaling recommendations, +Once you have your cluster up and running and are looking for scaling recommendations +for your anticipated workload, please [contact the InfluxData Support team](https://support.influxdata.com). -We are happy to work with you to identify appropriate scale settings based on -your anticipated workload. -**To use custom scale settings for your InfluxDB cluster**, modify the following fields -in your `myinfluxdb.yml`. If omitted, your cluster will use the default scale settings. +##### Customize scale settings + +**To use custom scale settings for your InfluxDB cluster**, edit values for the following fields +in your `myinfluxdb.yml`. If omitted, your cluster uses the default scale settings. - `spec.package.spec.resources` - `ingester.requests` From 1cae8c84495ba02573757acafd9efb37bbbbd43f Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 5 Aug 2024 12:27:09 -0500 Subject: [PATCH 80/96] chore(clustered): cleanup --- .../install/configure-cluster/directly.md | 65 ++++++++++++------- 1 file changed, 43 insertions(+), 22 deletions(-) diff --git a/content/influxdb/clustered/install/configure-cluster/directly.md b/content/influxdb/clustered/install/configure-cluster/directly.md index cea18f965..1b8f622aa 100644 --- a/content/influxdb/clustered/install/configure-cluster/directly.md +++ b/content/influxdb/clustered/install/configure-cluster/directly.md @@ -89,7 +89,7 @@ The `AppInstance` resource contains key information, such as: Copy the provided `example-customer.yml` file to create a new configuration file specific to your InfluxDB cluster. For example, `myinfluxdb.yml`. - + ```sh cp example-customer.yml myinfluxdb.yml @@ -108,6 +108,8 @@ InfluxData provides an `app-instance-schema.json` JSON schema file that VS Code Create a namespace for InfluxDB--for example, enter the following `kubectl` command in your terminal: + + ```sh kubectl create namespace influxdb ``` @@ -124,6 +126,8 @@ update an InfluxDB cluster. Use `kubectl` to install the [kubecfg kubit](https://github.com/kubecfg/kubit) operator. + + ```sh kubectl apply -k 'https://github.com/kubecfg/kubit//kustomize/global?ref=v0.0.15' ``` @@ -150,6 +154,8 @@ Use [crane](https://github.com/google/go-containerregistry/tree/main/cmd/crane) {{% code-placeholders "PACKAGE_VERSION" %}} + + ```sh mkdir /tmp/influxdbsecret cp influxdb-docker-config.json /tmp/influxdbsecret/config.json @@ -258,6 +264,8 @@ You can obtain it with any standard OCI image inspection tool. For example: {{% code-placeholders "PACKAGE_VERSION" %}} + + ```sh DOCKER_CONFIG=/tmp/influxdbsecret \ crane config \ @@ -280,6 +288,8 @@ Use `crane` to copy the images to your private registry: {{% code-placeholders "REGISTRY_HOSTNAME" %}} + + ```sh + ```sh kubectl create secret tls ingress-tls \ --namespace influxdb \ @@ -838,44 +850,53 @@ spec: ### Provide a custom certificate authority bundle {note="Optional"} -InfluxDB attempts to make TLS connections to the services it depends on; notably -the [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog), +InfluxDB attempts to make TLS connections to the services it depends on--notably, +the [Catalog](/influxdb/clustered/reference/internals/storage-engine/#catalog) and the [Object store](/influxdb/clustered/reference/internals/storage-engine/#object-store). -InfluxDB validates the certificates for all of the connections it makes. +InfluxDB validates certificates for all connections. -**If you host these services yourself and you use a private or otherwise not -well-known certificate authority to issue certificates to theses services**, -InfluxDB will not recognize the issuer and will be unable to validate the certificates. -To allow InfluxDB to validate these certificates, provide a PEM certificate -bundle containing your custom certificate authority chain. +_If you host dependent services yourself and you use a private or otherwise not +well-known certificate authority to issue certificates to them, +InfluxDB won't recognize the issuer and can't validate the certificates._ +To allow InfluxDB to validate the certificates from your custom CA, +configure the `AppInstance` resource to use a **PEM certificate +bundle** that contains your custom certificate authority chain. -1. Use `kubectl` to create a config map containing your PEM bundle. +1. Use `kubectl` to create a config map that contains your PEM-formatted + certificate bundle file. Your certificate authority administrator should provide you with a - PEM-formatted certificate bundle file. + PEM-formatted bundle file. {{% note %}} -This PEM-formatted bundle file is *not* the certificate that InfluxDB uses to -host its own TLS endpoints. This bundle establishes a chain of trust for the +This PEM bundle file establishes a chain of trust for the external services that InfluxDB depends on. +It's *not* the certificate that InfluxDB uses to +host its own TLS endpoints. {{% /note %}} - In the example below, `private_ca.pem` is the certificate bundle file. + In the example, replace `/path/to/private_ca.pem` with the path to your PEM-formatted certificate bundle file: + + ```sh kubectl --namespace influxdb create configmap custom-ca --from-file=certs.pem=/path/to/private_ca.pem ``` {{% note %}} -It's possible to append multiple certificates into the same bundle. -This can help if you need to include intermediate certificates or explicitly -include leaf certificates. Leaf certificates should be included before any -intermediate certificates they depend on. The root certificate should -be last in the bundle. +#### Bundle multiple certificates + +You can append multiple certificates into the same bundle. +This approach helps when you need to include intermediate certificates or explicitly include leaf certificates. + +Include certificates in the bundle in the following order: + +1. Leaf certificates +2. Intermediate certificates required by leaf certificates +3. Root certificate {{% /note %}} -2. Update your `AppInstance` resource in your `myinfluxdb.yml` to refer to your - certificate authority config map. Update the `.spec.package.spec.egress` - property to refer to that config map. For example: +2. In `myinfluxdb.yml`, update the `.spec.package.spec.egress` field to refer + to the config map that you generated in the preceding step--for example: ```yml spec: From 88e02cc00809f1684f2cb5fef733429147208664 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 5 Aug 2024 16:22:08 -0500 Subject: [PATCH 81/96] hotfix: cleanup --- content/influxdb/v2/install/_index.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/content/influxdb/v2/install/_index.md b/content/influxdb/v2/install/_index.md index 03d9e7572..6c31336aa 100644 --- a/content/influxdb/v2/install/_index.md +++ b/content/influxdb/v2/install/_index.md @@ -145,8 +145,6 @@ If `gpg` is not available, see the [GnuPG homepage](https://gnupg.org/download/) ``` --> - - ```sh curl -s https://repos.influxdata.com/influxdata-archive_compat.key \ | gpg --import - 2>&1 \ @@ -489,7 +487,7 @@ $acl | Set-Acl "C:\Users\\.influxdbv2" ### Install and set up InfluxDB in a container -The following steps show to use the +The following steps show how to use the [Docker CLI](https://docs.docker.com/reference/cli/docker/) to set up and run InfluxDB. but you can also [use Docker Compose](/influxdb/v2/install/use-docker-compose). @@ -511,10 +509,10 @@ _If you don't specify InfluxDB initial setup options, you can [set up manually](#set-up-influxdb) later using the UI or CLI in a running container._ - - {{% code-placeholders "ADMIN_(USERNAME|PASSWORD)|ORG_NAME|BUCKET_NAME" %}} + + ```sh docker run \ --name influxdb2 \ @@ -630,7 +628,7 @@ InfluxData also makes [Helm charts](https://github.com/influxdata/helm-charts) a 2. Start a local cluster: - + ```sh # with minikube From bd48f82deea3436633f4f10a5e4c656225864e73 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Tue, 6 Aug 2024 14:26:02 -0600 Subject: [PATCH 82/96] Manage users in InfluxDB Clustered (#5555) * manage clustered users * added related links to clustered user management * add back link to clustered manage users * fixed typos, added links * Apply suggestions from code review Co-authored-by: Jason Stirnaman * remove unnecessary test skip comments --------- Co-authored-by: Jason Stirnaman --- .../styles/layouts/_syntax-highlighting.scss | 3 + .../admin/custom-partitions/_index.md | 2 +- .../clustered/admin/databases/_index.md | 2 +- .../influxdb/clustered/admin/tables/_index.md | 2 +- .../influxdb/clustered/admin/tokens/_index.md | 4 +- .../influxdb/clustered/admin/users/_index.md | 34 +- content/influxdb/clustered/admin/users/add.md | 347 ++++++++++++++++++ .../influxdb/clustered/admin/users/remove.md | 131 +++++++ .../install/configure-cluster/directly.md | 8 +- .../install/configure-cluster/use-helm.md | 10 +- 10 files changed, 519 insertions(+), 24 deletions(-) create mode 100644 content/influxdb/clustered/admin/users/add.md create mode 100644 content/influxdb/clustered/admin/users/remove.md diff --git a/assets/styles/layouts/_syntax-highlighting.scss b/assets/styles/layouts/_syntax-highlighting.scss index 6e1e49e06..0e43f6b13 100644 --- a/assets/styles/layouts/_syntax-highlighting.scss +++ b/assets/styles/layouts/_syntax-highlighting.scss @@ -114,6 +114,9 @@ pre[class*="language-"] { .nl, /* Name.Label */ .si /* Literal.String.Interpol */ { color: $article-code-accent4 } + + .gd /* Generic.Deleted strike-through*/ + { text-decoration: line-through; } .m, /* Literal.Number */ .ni, /* Name.Entity */ diff --git a/content/influxdb/clustered/admin/custom-partitions/_index.md b/content/influxdb/clustered/admin/custom-partitions/_index.md index 70c4e14fb..2a39ba30b 100644 --- a/content/influxdb/clustered/admin/custom-partitions/_index.md +++ b/content/influxdb/clustered/admin/custom-partitions/_index.md @@ -7,7 +7,7 @@ description: > menu: influxdb_clustered: parent: Administer InfluxDB Clustered -weight: 103 +weight: 104 influxdb/clustered/tags: [storage] related: - /influxdb/clustered/reference/internals/storage-engine/ diff --git a/content/influxdb/clustered/admin/databases/_index.md b/content/influxdb/clustered/admin/databases/_index.md index 1dbb4a19a..31c6f0a1e 100644 --- a/content/influxdb/clustered/admin/databases/_index.md +++ b/content/influxdb/clustered/admin/databases/_index.md @@ -9,7 +9,7 @@ description: > menu: influxdb_clustered: parent: Administer InfluxDB Clustered -weight: 102 +weight: 103 influxdb/clustered/tags: [databases] --- diff --git a/content/influxdb/clustered/admin/tables/_index.md b/content/influxdb/clustered/admin/tables/_index.md index 991704d89..17c6d9416 100644 --- a/content/influxdb/clustered/admin/tables/_index.md +++ b/content/influxdb/clustered/admin/tables/_index.md @@ -8,7 +8,7 @@ description: > menu: influxdb_clustered: parent: Administer InfluxDB Clustered -weight: 102 +weight: 103 influxdb/clustered/tags: [tables] --- diff --git a/content/influxdb/clustered/admin/tokens/_index.md b/content/influxdb/clustered/admin/tokens/_index.md index 26823dfe9..5cd83a97f 100644 --- a/content/influxdb/clustered/admin/tokens/_index.md +++ b/content/influxdb/clustered/admin/tokens/_index.md @@ -8,13 +8,13 @@ description: > menu: influxdb_clustered: parent: Administer InfluxDB Clustered -weight: 102 +weight: 103 influxdb/clustered/tags: [tokens] --- InfluxDB uses token authentication to authorize access to data in your {{< product-name omit=" Clustered" >}} cluster. -There are two types of tokens: +With {{< product-name >}}, there are two types of tokens: - [Database tokens](#database-tokens) - [Management tokens](#management-tokens) diff --git a/content/influxdb/clustered/admin/users/_index.md b/content/influxdb/clustered/admin/users/_index.md index e2e9a2dc7..f08e5ae98 100644 --- a/content/influxdb/clustered/admin/users/_index.md +++ b/content/influxdb/clustered/admin/users/_index.md @@ -1,18 +1,32 @@ --- -title: Manage InfluxDB Clustered users +title: Manage users in your InfluxDB cluster description: > - Add or remove users by updating your `myinfluxdb.yml` file and re-applying the configuration. + Manage users with administrative access to your InfluxDB cluster through your + identity provider and your InfluxDB `AppInstance` resource. menu: influxdb_clustered: name: Manage users parent: Administer InfluxDB Clustered -weight: 101 -draft: true +weight: 102 +cascade: + related: + - /influxdb/clustered/install/auth/ + - /influxdb/clustered/install/configure-cluster/ --- -To add or remove users, update the users list in the `myinfluxdb.yml` file. -The users list is found at `spec.package.spec.admin.users`. -After updating the list, re-apply `myinfluxdb.yml`. -To learn how to apply `myinfluxdb.yml`, see [Deploy an InfluxDB cluster](/influxdb/clustered/install/deploy). -After `myinfluxdb.yml` has been applied, updates take a couple of minutes to complete. -When the updates are finished, new users will have been added, and removed users will have been deleted. +Manage users with administrative access to your InfluxDB cluster through your +[identity provider](/influxdb/clustered/install/auth/) and your InfluxDB +`AppInstance` resource. Administrative access lets users perform actions like +creating databases and tokens. + +{{% note %}} +#### Users versus database tokens + +All _users_ have administrative access to your cluster and can perform +administrative actions in your InfluxDB cluster. +_Database tokens_ authorize read and write access to databases in your InfluxDB +cluster. A person or client doesn't need to be a user to read and write data in your cluster, +but they must have a database token. +{{% /note %}} + +{{< children >}} diff --git a/content/influxdb/clustered/admin/users/add.md b/content/influxdb/clustered/admin/users/add.md new file mode 100644 index 000000000..e4ed4859c --- /dev/null +++ b/content/influxdb/clustered/admin/users/add.md @@ -0,0 +1,347 @@ +--- +title: Add a user to your InfluxDB cluster +list_title: Add a user +description: > + Add a user with administrative access to your InfluxDB cluster through your + identity provider and your InfluxDB `AppInstance` resource. +menu: + influxdb_clustered: + name: Add a user + parent: Manage users +weight: 201 +--- + +Add a user with administrative access to your InfluxDB cluster through your +[identity provider](/influxdb/clustered/install/auth/) and your InfluxDB +`AppInstance` resource: + +1. Use your identity provider to create an OAuth2 account for the user that + needs administrative access to your InfluxDB cluster. + + **Refer to your identity provider's documentation for information about + adding users:** + + - [Keycloak: Creating users {{% icon "export" %}}](https://www.keycloak.org/docs/latest/server_admin/#proc-creating-user_server_administration_guide) + - [Microsoft Entra ID: How to create, invite, and delete users {{% icon "export" %}}](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/add-users) + - [Auth0: Team member management {{% icon "export" %}}](https://auth0.com/docs/get-started/auth0-teams/team-member-management) + +2. Add the user to your InfluxDB `AppInstance` resource. + You can edit your `AppInstance` resource directly in your `myinfluxdb.yml`, + or, if you're using the + [InfluxDB Clustered Helm chart](https://github.com/influxdata/helm-charts/tree/master/charts/influxdb3-clustered), + you can add users to your `values.yaml` to modify your `AppInstance` + resource. Required credentials depend on your identity provider. + + {{< tabs-wrapper >}} +{{% tabs %}} +[AppInstance](#) +[Helm](#) +{{% /tabs %}} + +{{% tab-content %}} + + +If editing your `AppInstance` resource directly, provide values for the +following fields in your `myinfluxdb.yml` configuration file: + +- `spec.package.spec.admin` + - `identityProvider`: Identity provider name. + _If using Microsoft Entra ID (formerly Azure Active Directory), set the name + to `azure`_. + - `jwksEndpoint`: JWKS endpoint provide by your identity provider. + - `users`: List of OAuth2 users to grant administrative access to your + InfluxDB cluster. IDs are provided by your identity provider. + +Below are examples for **Keycloak**, **Auth0**, and **Microsoft Entra ID**, but +other OAuth2 providers should work as well: + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Keycloak](#) +[Auth0](#) +[Microsoft Entra ID](#) +{{% /code-tabs %}} +{{% code-tab-content %}} + +{{% code-callout "keycloak" "green" %}} +{{% code-placeholders "KEYCLOAK_(HOST|REALM|USER_ID)" %}} + +```yaml +apiVersion: kubecfg.dev/v1alpha1 +kind: AppInstance +# ... +spec: + package: + spec: + admin: + identityProvider: keycloak + jwksEndpoint: |- + https://KEYCLOAK_HOST/auth/realms/KEYCLOAK_REALM/protocol/openid-connect/certs + users: + # All fields are required but `firstName`, `lastName`, and `email` can be + # arbitrary values. However, `id` must match the user ID provided by Keycloak. + - id: KEYCLOAK_USER_ID + firstName: Marty + lastName: McFly + email: mcfly@influxdata.com +``` + +{{% /code-placeholders %}} +{{% /code-callout %}} + +Replace the following: + +- {{% code-placeholder-key %}}`KEYCLOAK_HOST`{{% /code-placeholder-key %}}: + Host and port of your Keycloak server +- {{% code-placeholder-key %}}`KEYCLOAK_REALM`{{% /code-placeholder-key %}}: + Keycloak realm +- {{% code-placeholder-key %}}`KEYCLOAK_USER_ID`{{% /code-placeholder-key %}}: + Keycloak user ID to grant InfluxDB administrative access to + _(See [Find user IDs with Keycloak](/influxdb/clustered/install/auth/#find-user-ids-with-keycloak))_ + +--- + +{{% /code-tab-content %}} +{{% code-tab-content %}} + +{{% code-callout "auth0" "green" %}} +{{% code-placeholders "AUTH0_(HOST|USER_ID)" %}} + +```yaml +apiVersion: kubecfg.dev/v1alpha1 +kind: AppInstance +# ... +spec: + package: + spec: + admin: + identityProvider: auth0 + jwksEndpoint: |- + https://AUTH0_HOST/.well-known/openid-configuration + users: + - AUTH0_USER_ID +``` + +{{% /code-placeholders %}} +{{% /code-callout %}} + +Replace the following: + +- {{% code-placeholder-key %}}`AUTH0_HOST`{{% /code-placeholder-key %}}: + Host and port of your Auth0 server +- {{% code-placeholder-key %}}`AUTH0_USER_ID`{{% /code-placeholder-key %}}: + Auth0 user ID to grant InfluxDB administrative access to + +--- + +{{% /code-tab-content %}} +{{% code-tab-content %}} + +{{% code-callout "azure" "green" %}} +{{% code-placeholders "AZURE_(USER|TENANT)_ID" %}} + +```yaml +apiVersion: kubecfg.dev/v1alpha1 +kind: AppInstance +# ... +spec: + package: + spec: + admin: + identityProvider: azure + jwksEndpoint: |- + https://login.microsoftonline.com/AZURE_TENANT_ID/discovery/v2.0/keys + users: + - AZURE_USER_ID +``` + +{{% /code-placeholders %}} +{{% /code-callout %}} + +Replace the following: + +- {{% code-placeholder-key %}}`AZURE_TENANT_ID`{{% /code-placeholder-key %}}: + Microsoft Entra tenant ID +- {{% code-placeholder-key %}}`AZURE_USER_ID`{{% /code-placeholder-key %}}: + Microsoft Entra user ID to grant InfluxDB administrative access to + _(See [Find user IDs with Microsoft Entra ID](/influxdb/clustered/install/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ + +--- + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + + +{{% /tab-content %}} +{{% tab-content %}} + + +If using the InfluxDB Clustered Helm chart, provide values for the following +fields in your `values.yaml`: + +- `admin` + - `identityProvider`: Identity provider name. + _If using Microsoft Entra ID (formerly Azure Active Directory), set the name + to `azure`_. + - `jwksEndpoint`: JWKS endpoint provide by your identity provider. + - `users`: List of OAuth2 users to grant administrative access to your + InfluxDB cluster. IDs are provided by your identity provider. + +Below are examples for **Keycloak**, **Auth0**, and **Microsoft Entra ID**, but +other OAuth2 providers should work as well: + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Keycloak](#) +[Auth0](#) +[Microsoft Entra ID](#) +{{% /code-tabs %}} +{{% code-tab-content %}} + +{{% code-callout "keycloak" "green" %}} +{{% code-placeholders "KEYCLOAK_(HOST|REALM|USER_ID)" %}} + +```yaml +admin: + # The identity provider to be used (such as "keycloak", "auth0", or "azure") + # Note, use "azure" for Azure Active Directory + identityProvider: keycloak + # The JWKS endpoint provided by the Identity Provider + jwksEndpoint: |- + https://KEYCLOAK_HOST/auth/realms/KEYCLOAK_REALM/protocol/openid-connect/certs + # The list of users to grant access to Clustered via influxctl + users: + # All fields are required but `firstName`, `lastName`, and `email` can be + # arbitrary values. However, `id` must match the user ID provided by Keycloak. + - id: KEYCLOAK_USER_ID + firstName: Marty + lastName: McFly + email: mcfly@influxdata.com +``` + +{{% /code-placeholders %}} +{{% /code-callout %}} + +Replace the following: + +- {{% code-placeholder-key %}}`KEYCLOAK_HOST`{{% /code-placeholder-key %}}: + Host and port of your Keycloak server +- {{% code-placeholder-key %}}`KEYCLOAK_REALM`{{% /code-placeholder-key %}}: + Keycloak realm +- {{% code-placeholder-key %}}`KEYCLOAK_USER_ID`{{% /code-placeholder-key %}}: + Keycloak user ID to grant InfluxDB administrative access to + +--- + +{{% /code-tab-content %}} +{{% code-tab-content %}} + +{{% code-callout "auth0" "green" %}} +{{% code-placeholders "AUTH0_(HOST|USER_ID)" %}} + +```yaml +admin: + # The identity provider to be used e.g. "keycloak", "auth0", "azure", etc + # Note, use "azure" for Azure Active Directory. + identityProvider: auth0 + # The JWKS endpoint provided by the Identity Provider + jwksEndpoint: |- + https://AUTH0_HOST/.well-known/openid-configuration + # The list of users to grant access to Clustered via influxctl + users: + - AUTH0_USER_ID +``` + +{{% /code-placeholders %}} +{{% /code-callout %}} + +Replace the following: + +- {{% code-placeholder-key %}}`AUTH0_HOST`{{% /code-placeholder-key %}}: + Host and port of your Auth0 server +- {{% code-placeholder-key %}}`AUTH0_USER_ID`{{% /code-placeholder-key %}}: + Auth0 user ID to grant InfluxDB administrative access to + +--- + +{{% /code-tab-content %}} +{{% code-tab-content %}} + +{{% code-callout "azure" "green" %}} +{{% code-placeholders "AZURE_(USER|TENANT)_ID" %}} + +```yaml +admin: + # The identity provider to be used e.g. "keycloak", "auth0", "azure", etc + # Note, use "azure" for Azure Active Directory. + identityProvider: azure + # The JWKS endpoint provided by the Identity Provider + jwksEndpoint: |- + https://login.microsoftonline.com/AZURE_TENANT_ID/discovery/v2.0/keys + # The list of users to grant access to Clustered via influxctl + users: + - AZURE_USER_ID +``` + +{{% /code-placeholders %}} +{{% /code-callout %}} + +Replace the following: + +- {{% code-placeholder-key %}}`AZURE_TENANT_ID`{{% /code-placeholder-key %}}: + Microsoft Entra tenant ID +- {{% code-placeholder-key %}}`AZURE_USER_ID`{{% /code-placeholder-key %}}: + Microsoft Entra user ID to grant InfluxDB administrative access to + _(See [Find user IDs with Microsoft Entra ID](/influxdb/clustered/install/auth/?t=Microsoft+Entra+ID#find-user-ids-with-microsoft-entra-id))_ + +--- + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + + +{{% /tab-content %}} + {{< /tabs-wrapper >}} + +3. Apply the change to your InfluxDB cluster. + + - If updating the `AppInstance` resource directly, use `kubectl` to apply + the change. + - If using the InfluxDB Clustered Helm chart, use `helm` to apply the change. + + {{< code-tabs-wrapper >}} +{{% code-tabs %}} +[kubectl](#) +[Helm](#) +{{% /code-tabs %}} +{{% code-tab-content %}} + + + +```bash +kubectl apply \ + --filename myinfluxdb.yml \ + --namespace influxdb +``` + +{{% /code-tab-content %}} +{{% code-tab-content %}} + + + +```bash +helm upgrade \ + influxdb \ + influxdata/influxdb3-clustered \ + -f ./values.yaml \ + --namespace influxdb +``` + +{{% /code-tab-content %}} + {{< /code-tabs-wrapper >}} + +Once applied, the added user is granted administrative access to your InfluxDB +cluster and can use `influxctl` to perform administrative actions. +See [Set up Authorization--Configure influxctl](/influxdb/clustered/install/auth/#configure-influxctl) +for information about configuring the new user's `influxctl` client to communicate +and authenticate with your InfluxDB cluster's identity provider. diff --git a/content/influxdb/clustered/admin/users/remove.md b/content/influxdb/clustered/admin/users/remove.md new file mode 100644 index 000000000..2c36ceb61 --- /dev/null +++ b/content/influxdb/clustered/admin/users/remove.md @@ -0,0 +1,131 @@ +--- +title: Remove a user from your InfluxDB cluster +list_title: Remove a user +description: > + Remove a user with administrative access from your InfluxDB cluster. +menu: + influxdb_clustered: + name: Remove a user + parent: Manage users +weight: 201 +--- + +Remove a user with administrative access from your InfluxDB cluster: + +1. Remove or deactivate the user in your identity provider. + + **Refer to your identity provider's documentation for information about + removing users:** + + - [Keycloak: Deleting a user {{% icon "export" %}}](https://www.keycloak.org/docs/latest/server_admin/#proc-deleting-user_server_administration_guide) + - [Microsoft Entra ID: How to create, invite, and delete users {{% icon "export" %}}](https://learn.microsoft.com/en-us/entra/fundamentals/how-to-create-delete-users#delete-a-user) + - [Auth0: Team member management {{% icon "export" %}}](https://auth0.com/docs/get-started/auth0-teams/team-member-management#delete-an-existing-team-member) + +2. Remove the user from your InfluxDB `AppInstance` resource. + You can edit your `AppInstance` resource directly in your `myinfluxdb.yml`, + or, if you're using the + [InfluxDB Clustered Helm chart](https://github.com/influxdata/helm-charts/tree/master/charts/influxdb3-clustered), + you can remove users from your `values.yaml` to modify your `AppInstance` + resource. + + {{< tabs-wrapper >}} +{{% tabs %}} +[AppInstance](#) +[Helm](#) +{{% /tabs %}} + +{{% tab-content %}} + + +If editing your `AppInstance` resource directly, remove the user from the list +of users in the `spec.package.spec.admin.users` field in your `myinfluxdb.yml` +configuration file--for example: + +```diff +apiVersion: kubecfg.dev/v1alpha1 +kind: AppInstance +# ... +spec: + package: + spec: + admin: + # ... + users: + - id: XXooXoXXooXXXoo1 + firstName: Marty + lastName: McFly + email: mcfly@influxdata.com +- - id: XXooXoXXooXXXoo2 +- firstName: John +- lastName: Doe +- email: j.doe@influxdata.com +``` + + +{{% /tab-content %}} +{{% tab-content %}} + + +If using the InfluxDB Clustered Helm chart, remove the user from the list of +users in the `admin.users` field in your in your `values.yaml`--for example: + +```diff +admin: + # ... + users: + - id: XXooXoXXooXXXoo1 + firstName: Marty + lastName: McFly + email: mcfly@influxdata.com +- - id: XXooXoXXooXXXoo2 +- firstName: John +- lastName: Doe +- email: j.doe@influxdata.com +``` + + +{{% /tab-content %}} + {{< /tabs-wrapper >}} + +3. Apply the change to your InfluxDB cluster. + + - If updating the `AppInstance` resource directly, use `kubectl` to apply + the change. + - If using the InfluxDB Clustered Helm chart, use `helm` to apply the change. + + {{< code-tabs-wrapper >}} +{{% code-tabs %}} +[kubectl](#) +[Helm](#) +{{% /code-tabs %}} +{{% code-tab-content %}} + + + +```bash +kubectl apply \ + --filename myinfluxdb.yml \ + --namespace influxdb +``` + +{{% /code-tab-content %}} +{{% code-tab-content %}} + + + +```bash +helm upgrade \ + influxdb \ + influxdata/influxdb3-clustered \ + -f ./values.yaml \ + --namespace influxdb +``` + +{{% /code-tab-content %}} + {{< /code-tabs-wrapper >}} + +{{% note %}} +After you complete step 1 above, the removed user no longer has administrative +access to your InfluxDB cluster. +However, you should still remove them from your `AppInstance` resource. +{{% /note %}} diff --git a/content/influxdb/clustered/install/configure-cluster/directly.md b/content/influxdb/clustered/install/configure-cluster/directly.md index 1b8f622aa..fca4952d4 100644 --- a/content/influxdb/clustered/install/configure-cluster/directly.md +++ b/content/influxdb/clustered/install/configure-cluster/directly.md @@ -751,11 +751,9 @@ Replace the following: ##### Add users -Finally, to give users access to use `influxctl`, add the list of users to the `spec.package.spec.admin.users` field. - - +Finally, to give users access to use `influxctl`, add the list of users to the +`spec.package.spec.admin.users` field. +See [Manage users](/influxdb/clustered/admin/users/) for more details. #### Configure the size of your cluster diff --git a/content/influxdb/clustered/install/configure-cluster/use-helm.md b/content/influxdb/clustered/install/configure-cluster/use-helm.md index a4717ca15..e85c4acb3 100644 --- a/content/influxdb/clustered/install/configure-cluster/use-helm.md +++ b/content/influxdb/clustered/install/configure-cluster/use-helm.md @@ -7,6 +7,8 @@ menu: name: Use Helm parent: Configure your cluster weight: 230 +related: + - /influxdb/clustered/admin/users/ --- Manage your InfluxDB Clustered deployments using Kubernetes and apply configuration settings using a YAML configuration file. @@ -816,11 +818,11 @@ Replace the following: {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -##### Adding users +##### Add users -Finally, add all the users you wish to have access to use `influxctl`. -Update the `admin.users` field with a list of these users. - +Finally, add the users you wish to have access to use `influxctl`. +Update the `admin.users` field with a list of the users. +See [Manage users](/influxdb/clustered/admin/users/) for more details. #### Configure the size of your cluster From 26105f05e42941e8c20497775ecf63a26166613c Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 7 Aug 2024 13:55:26 -0500 Subject: [PATCH 83/96] fix(ci): set CONTENT_PATH env variable for each product --- compose.yaml | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/compose.yaml b/compose.yaml index 3dd3e03da..35d66f2a0 100644 --- a/compose.yaml +++ b/compose.yaml @@ -38,8 +38,6 @@ services: cloud-pytest: image: influxdata/docs-pytest build: - args: - - CONTENT_PATH=content/influxdb/cloud context: . dockerfile: Dockerfile.pytest entrypoint: @@ -50,6 +48,8 @@ services: # In the command, pass file paths to test. # The container preprocesses the files for testing and runs the tests. - content/influxdb/cloud/**/*.md + environment: + - CONTENT_PATH=content/influxdb/cloud profiles: - test - v2 @@ -87,8 +87,6 @@ services: cloud-dedicated-pytest: image: influxdata/docs-pytest build: - args: - - CONTENT_PATH=content/influxdb/cloud-dedicated context: . dockerfile: Dockerfile.pytest entrypoint: @@ -99,6 +97,8 @@ services: # In the command, pass file paths to test. # The container preprocesses the files for testing and runs the tests. - content/influxdb/cloud-dedicated/**/*.md + environment: + - CONTENT_PATH=content/influxdb/cloud-dedicated profiles: - test - v3 @@ -141,8 +141,6 @@ services: cloud-serverless-pytest: image: influxdata/docs-pytest build: - args: - - CONTENT_PATH=content/influxdb/cloud-serverless context: . dockerfile: Dockerfile.pytest entrypoint: @@ -153,6 +151,8 @@ services: # In the command, pass file paths to test. # The container preprocesses the files for testing and runs the tests. - content/influxdb/cloud-serverless/**/*.md + environment: + - CONTENT_PATH=content/influxdb/cloud-serverless profiles: - test - v3 @@ -190,8 +190,6 @@ services: clustered-pytest: image: influxdata/docs-pytest build: - args: - - CONTENT_PATH=content/influxdb/clustered context: . dockerfile: Dockerfile.pytest entrypoint: @@ -202,6 +200,8 @@ services: # In the command, pass file paths to test. # The container preprocesses the files for testing and runs the tests. - content/influxdb/clustered/**/*.md + environment: + - CONTENT_PATH=content/influxdb/clustered profiles: - test - v3 @@ -244,8 +244,6 @@ services: telegraf-pytest: image: influxdata/docs-pytest build: - args: - - CONTENT_PATH=content/telegraf context: . dockerfile: Dockerfile.pytest entrypoint: @@ -256,6 +254,8 @@ services: # In the command, pass file paths to test. # The container preprocesses the files for testing and runs the tests. - content/telegraf/**/*.md + environment: + - CONTENT_PATH=content/telegraf profiles: - test stdin_open: true @@ -292,8 +292,6 @@ services: v2-pytest: image: influxdata/docs-pytest build: - args: - - CONTENT_PATH=content/influxdb/v2 context: . dockerfile: Dockerfile.pytest entrypoint: @@ -304,6 +302,8 @@ services: # In the command, pass file paths to test. # The container preprocesses the files for testing and runs the tests. - content/influxdb/v2/**/*.md + environment: + - CONTENT_PATH=content/influxdb/v2 profiles: - test - v2 @@ -348,7 +348,9 @@ services: DOCKER_INFLUXDB_INIT_PASSWORD_FILE: /run/secrets/influxdb2-admin-password DOCKER_INFLUXDB_INIT_ADMIN_TOKEN_FILE: /run/secrets/influxdb2-admin-token DOCKER_INFLUXDB_INIT_ORG: docs - DOCKER_INFLUXDB_INIT_BUCKET: home + DOCKER_INFLUXDB_INIT_BUCKET: get-started + INFLUX_ORG: docs + INFLUX_BUCKET: get-started profiles: - v2 - local @@ -367,7 +369,7 @@ services: build: context: . dockerfile: .ci/Dockerfile.remark - command: ["remark", "content/${PRODUCT_PATH}"] + command: ["remark", "${CONTENT_PATH}"] profiles: - lint volumes: From 67e4084cf050df679aa856120d36b54b5703c6eb Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 7 Aug 2024 13:58:43 -0500 Subject: [PATCH 84/96] chore(ci): substitute v2 placeholders for tests, move setup to run-tests, fix env variables and broken use of parse_yaml --- test/scripts/prepare-content.sh | 15 ++++----------- test/scripts/run-tests.sh | 26 ++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 11 deletions(-) diff --git a/test/scripts/prepare-content.sh b/test/scripts/prepare-content.sh index c37e0280f..d678362a4 100644 --- a/test/scripts/prepare-content.sh +++ b/test/scripts/prepare-content.sh @@ -84,8 +84,12 @@ function substitute_placeholders { s/example-db/$INFLUX_DATABASE/g; s/get-started/$INFLUX_DATABASE/g; /os.getenv("MANAGEMENT_TOKEN")/! s/INFLUX_MANAGEMENT_TOKEN/$MANAGEMENT_TOKEN/g; + /os.getenv("ORG_NAME")/! s/ORG_NAME/$INFLUX_ORG_NAME/g; + /os.getenv("ORG_ID")/! s/ORG_ID/$INFLUX_ORG/g; + /os.getenv("PASSWORD")/! s/PASSWORD/$INFLUX_PASSWORD/g; /os.getenv("ORG_ID")/! s/ORG_ID/$INFLUX_ORG/g; /os.getenv("RETENTION_POLICY")/! s/RETENTION_POLICY_NAME\|RETENTION_POLICY/$INFLUX_RETENTION_POLICY/g; + /os.getenv("USERNAME")/! s/USERNAME/$INFLUX_USERNAME/g; s/CONFIG_NAME/CONFIG_$(shuf -i 0-100 -n1)/g; s/TEST_RUN/TEST_RUN_$(date +%s)/g; s|/path/to/custom/assets-dir|/app/custom-assets|g;' \ @@ -109,16 +113,6 @@ function substitute_placeholders { done } -setup() { - # Set up the environment for the tests. - # Parse YAML config files into dotenv files to be used by tests. - mkdir -p /app/appdata && (parse_yaml /src/data/products.yml > /app/appdata/.env.products) - - # Miscellaneous test setup. - # For macOS samples. - mkdir -p ~/Downloads && rm -rf ~/Downloads/* -} - prepare_tests() { echo "Preparing test files: $*" SRC_FILES="$*" @@ -130,7 +124,6 @@ prepare_tests() { done cd /app substitute_placeholders - setup } prepare_tests "$*" diff --git a/test/scripts/run-tests.sh b/test/scripts/run-tests.sh index 488da2804..7f0588f98 100644 --- a/test/scripts/run-tests.sh +++ b/test/scripts/run-tests.sh @@ -23,6 +23,32 @@ tests="${*:2}" rm -rf /app/"${CONTENT_PATH}"/* bash /src/test/scripts/prepare-content.sh $tests + + +setup() { + # Set up the environment for the tests. + + ## Store test configuration in /app/appdata. + mkdir -p /app/appdata + + ## Parse YAML config files into dotenv files to be used by tests. + ## You must source the parse_yaml function before you can use it. + source /usr/local/bin/parse_yaml + parse_yaml /src/data/products.yml > /app/appdata/.env.products + chmod -R +x /app/appdata/ + + ## Source non-sensitive environment variables for all test runners. + set -a + source /app/appdata/.env.* + set +a + + # Miscellaneous test setup. + # For macOS samples. + mkdir -p ~/Downloads && rm -rf ~/Downloads/* +} + +setup + if [[ $runner == "pytest" ]]; then pytest \ -s \ From ef61afc6ec3b1a876cea8b1f0aee048821cae4e5 Mon Sep 17 00:00:00 2001 From: Jacob Marble Date: Wed, 7 Aug 2024 12:51:29 -0700 Subject: [PATCH 85/96] fix(write-api): Serverless write 201 response codes Helps https://github.com/influxdata/idpe/issues/18710 InfluxDB v3 Serverless will soon return 201 or 204, in cases where it currently returns 204. --- api-docs/cloud-serverless/v2/ref.yml | 54 ++++++++++--------- .../write-data/troubleshoot.md | 3 +- 2 files changed, 31 insertions(+), 26 deletions(-) diff --git a/api-docs/cloud-serverless/v2/ref.yml b/api-docs/cloud-serverless/v2/ref.yml index 17148b502..47cb51516 100644 --- a/api-docs/cloud-serverless/v2/ref.yml +++ b/api-docs/cloud-serverless/v2/ref.yml @@ -262,8 +262,8 @@ tags: |  Code  | Status | Description | |:-----------:|:------------------------ |:--------------------- | | `200` | Success | | - | `201` | Created | Successfully created a resource. The response body may contain details. | - | `204` | No content | The request succeeded. InfluxDB doesn't typically return a response body for the operation. The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints return a response body if some points are written and some are rejected. | + | `201` | Created | Successfully created a resource. The response body may contain details, for example [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) response bodies contain details of partial write failures. | + | `204` | No content | The request succeeded. | | `400` | Bad request | InfluxDB can't parse the request due to an incorrect parameter or bad syntax. For _writes_, the error may indicate one of the following problems:
  • Line protocol is malformed. The response body contains the first malformed line in the data and indicates what was expected.
  • The batch contains a point with the same series as other points, but one of the field values has a different data type.
  • `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
| | `401` | Unauthorized | May indicate one of the following:
  • `Authorization: Token` header is missing or malformed
  • API token value is missing from the header
  • API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/cloud-serverless/security/tokens/)
| | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | @@ -7487,14 +7487,17 @@ paths: InfluxDB Cloud Serverless does the following when you send a write request: - 1. Validates the request. - 2. If successful, attempts to [ingest the data](/influxdb/cloud-serverless/reference/internals/durability/#data-ingest); [error](/influxdb/cloud-serverless/write-data/troubleshoot/#review-http-status-codes) otherwise. - 3. If some or all points in the batch are written, responds with an HTTP `204 "No Content"` status code, acknowledging that data is written and queryable; error otherwise. + 1. Validates the request. + 2. If successful, attempts to [ingest data](/influxdb/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-serverless/write-data/troubleshoot/#review-http-status-codes). + 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: - - `204 "No Content"`: Data in the batch is written and queryable. - - `400 "Bad Request"`: The entire batch is rejected. + - `204 No Content`: all data in the batch is ingested + - `201 Created`: some points in the batch are ingested and queryable, and some points are rejected + - `400 Bad Request`: all data is rejected - If some points in the batch are rejected, the response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points). + The response body contains error details about [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + + Writes are synchronous--the response status indicates the final status of the write and all ingested data is queryable. To ensure that InfluxDB handles writes in the order you request them, wait for the response before you send the next request. @@ -7636,12 +7639,9 @@ paths: - [Best practices for optimizing writes](/influxdb/cloud-serverless/write-data/best-practices/optimize-writes/) required: true responses: - '204': + '201': description: | - Success. - Data in the batch is written and queryable. - - If some points in the batch are rejected, the response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + Success ("Created"). Some points in the batch are written and queryable, and some points are rejected. The response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. content: application/json: examples: @@ -7653,6 +7653,8 @@ paths: message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' schema: $ref: '#/components/schemas/LineProtocolError' + '204': + description: Success ("No Content"). All data in the batch is written and queryable. '400': description: | All data in the batch was rejected and not written. @@ -7916,18 +7918,21 @@ paths: description: | Writes data to a bucket. - Use this endpoint to send data in [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) format to InfluxDB. + Use this endpoint for [InfluxDB v1 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v1/) when sending data in [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) format to InfluxDB. InfluxDB Cloud Serverless does the following when you send a write request: - 1. Validates the request. - 2. If successful, attempts to [ingest the data](/influxdb/cloud-serverless/reference/internals/durability/#data-ingest); [error](/influxdb/cloud-serverless/write-data/troubleshoot/#review-http-status-codes) otherwise. - 3. If some or all points in the batch are written, responds with an HTTP `204 "No Content"` status code, acknowledging that data is written and queryable; error otherwise. + 1. Validates the request. + 2. If successful, attempts to [ingest data](/influxdb/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-serverless/write-data/troubleshoot/#review-http-status-codes). + 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: - - `204 "No Content"`: Data in the batch is written and queryable. - - `400 "Bad Request"`: The entire batch is rejected. + - `204 No Content`: all data in the batch is ingested + - `201 Created`: some points in the batch are ingested and queryable, and some points are rejected + - `400 Bad Request`: all data is rejected - If some points in the batch are rejected, the response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points). + The response body contains error details about [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + + Writes are synchronous--the response status indicates the final status of the write and all ingested data is queryable. To ensure that InfluxDB handles writes in the order you request them, wait for the response before you send the next request. @@ -7995,12 +8000,9 @@ paths: description: Line protocol body required: true responses: - '204': + '201': description: | - Success. - Data in the batch is written and queryable. - - If some points in the batch are rejected, the response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + Success ("Created"). Some points in the batch are written and queryable, and some points are rejected. The response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. content: application/json: examples: @@ -8012,6 +8014,8 @@ paths: message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' schema: $ref: '#/components/schemas/LineProtocolError' + '204': + description: Success ("No Content"). All data in the batch is written and queryable. '400': description: | All data in the batch is rejected and not written. diff --git a/content/influxdb/cloud-serverless/write-data/troubleshoot.md b/content/influxdb/cloud-serverless/write-data/troubleshoot.md index d5d97cb6e..de9ab7dc3 100644 --- a/content/influxdb/cloud-serverless/write-data/troubleshoot.md +++ b/content/influxdb/cloud-serverless/write-data/troubleshoot.md @@ -51,7 +51,8 @@ The `message` property of the response body may contain additional details about | HTTP response code | Response body | Description | | :-------------------------------| :--------------------------------------------------------------- | :------------- | -| `204 "No Content"` | error details about rejected points, up to 100 points: `line` contains the first rejected line, `message` describes rejected points | If InfluxDB ingested some or all of the data | +| `201 "Created"` | error details about rejected points, up to 100 points, `line` contains the first rejected line, `message` describes rejections | If some of the data is ingested and some of the data is rejected | +| `204 "No Content"` | no response body | If InfluxDB ingested all of the data in the batch | | `400 "Bad request"` | `line` contains the first malformed line, `message` describes rejected points | If request data is malformed | | `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb/cloud-serverless/admin/tokens/) doesn't have [permission](/influxdb/cloud-serverless/admin/tokens/create-token/) to write to the bucket. See [examples using credentials](/influxdb/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) in write requests. | | `403 "Forbidden"` | `message` contains details about the error | If the data isn't allowed (for example, falls outside of the bucket's retention period). From c83339029c418895b6605037f8832ddc2c8cfbfa Mon Sep 17 00:00:00 2001 From: Fraser Savage Date: Fri, 9 Aug 2024 15:45:38 +0100 Subject: [PATCH 86/96] fix(write-api): Update Cloud Serverless outside-retention failure to HTTP 422 --- api-docs/cloud-serverless/v2/ref.yml | 7 +++++++ .../influxdb/cloud-serverless/write-data/troubleshoot.md | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/api-docs/cloud-serverless/v2/ref.yml b/api-docs/cloud-serverless/v2/ref.yml index 47cb51516..2cc273595 100644 --- a/api-docs/cloud-serverless/v2/ref.yml +++ b/api-docs/cloud-serverless/v2/ref.yml @@ -7705,6 +7705,13 @@ paths: InfluxDB rejected the batch and did not write any data. InfluxDB returns this error if the payload exceeds the 50MB size limit. + '422': + description: | + Unprocessable Entity. + + The request contained data outside the bucket's retention window, causing InfluxDB to reject the batch and write no data. + + The response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points). '429': description: | Too many requests. diff --git a/content/influxdb/cloud-serverless/write-data/troubleshoot.md b/content/influxdb/cloud-serverless/write-data/troubleshoot.md index de9ab7dc3..dd85c6a9b 100644 --- a/content/influxdb/cloud-serverless/write-data/troubleshoot.md +++ b/content/influxdb/cloud-serverless/write-data/troubleshoot.md @@ -55,9 +55,9 @@ The `message` property of the response body may contain additional details about | `204 "No Content"` | no response body | If InfluxDB ingested all of the data in the batch | | `400 "Bad request"` | `line` contains the first malformed line, `message` describes rejected points | If request data is malformed | | `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb/cloud-serverless/admin/tokens/) doesn't have [permission](/influxdb/cloud-serverless/admin/tokens/create-token/) to write to the bucket. See [examples using credentials](/influxdb/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) in write requests. | -| `403 "Forbidden"` | `message` contains details about the error | If the data isn't allowed (for example, falls outside of the bucket's retention period). | `404 "Not found"` | requested **resource type** (for example, "organization" or "bucket"), and **resource name** | If a requested resource (for example, organization or bucket) wasn't found | | `413 “Request too large”` | cannot read data: points in batch is too large | If a request exceeds the maximum [global limit](/influxdb/cloud-serverless/admin/billing/limits/) | +| `422 "Unprocessable Entity"` | `message` contains details about the error | If the data isn't allowed (for example, falls outside of the bucket's retention period). | `429 “Too many requests”` | | If the number of requests exceeds the [adjustable service quota](/influxdb/cloud-serverless/admin/billing/limits/#adjustable-service-quotas). The `Retry-After` header contains the number of seconds to wait before trying the write again. | If a request exceeds your plan's [adjustable service quotas](/influxdb/cloud-serverless/admin/billing/limits/#adjustable-service-quotas) | `500 "Internal server error"` | | Default status for an error | | `503 "Service unavailable"` | | If the server is temporarily unavailable to accept writes. The `Retry-After` header contains the number of seconds to wait before trying the write again. From 749c59b52579b0795357fe9173f44ee50936ddd0 Mon Sep 17 00:00:00 2001 From: Fraser Savage Date: Fri, 9 Aug 2024 15:51:18 +0100 Subject: [PATCH 87/96] fix(write-api): Update Cloud Dedicated outside-retention failure to HTTP 422 --- api-docs/cloud-dedicated/v2/ref.yml | 7 +++++++ .../influxdb/cloud-dedicated/write-data/troubleshoot.md | 3 ++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/api-docs/cloud-dedicated/v2/ref.yml b/api-docs/cloud-dedicated/v2/ref.yml index 21cfdea6e..941e27a13 100644 --- a/api-docs/cloud-dedicated/v2/ref.yml +++ b/api-docs/cloud-dedicated/v2/ref.yml @@ -703,6 +703,13 @@ paths: schema: $ref: '#/components/schemas/LineProtocolLengthError' description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written. + '422': + description: | + Unprocessable Entity. + + The request contained data outside the bucket's retention window, causing InfluxDB to reject the batch and write no data. + + The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points). '429': description: Token is temporarily over quota. The Retry-After header describes when to try the write again. headers: diff --git a/content/influxdb/cloud-dedicated/write-data/troubleshoot.md b/content/influxdb/cloud-dedicated/write-data/troubleshoot.md index a18054c86..0650edfbc 100644 --- a/content/influxdb/cloud-dedicated/write-data/troubleshoot.md +++ b/content/influxdb/cloud-dedicated/write-data/troubleshoot.md @@ -56,8 +56,9 @@ The `message` property of the response body may contain additional details about | `400 "Bad request"` | error details about rejected points, up to 100 points: `line` contains the first rejected line, `message` describes rejections line | If request data is malformed | | `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb/cloud-dedicated/admin/tokens/) doesn't have [permission](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/#examples) to write to the database. See [examples using credentials](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) in write requests. | | `404 "Not found"` | requested **resource type** (for example, "organization" or "database"), and **resource name** | If a requested resource (for example, organization or database) wasn't found | +| `422 "Unprocessable Entity"` | `message` contains details about the error | If the data isn't allowed (for example, falls outside of the bucket's retention period). | `500 "Internal server error"` | | Default status for an error | -| `503 "Service unavailable"` | | If the server is temporarily unavailable to accept writes. The `Retry-After` header contains the number of seconds to wait before trying the write again. +| `503 "Service unavailable"` | | If the server is temporarily unavailable to accept writes. The `Retry-After` header contains the number of seconds to wait before trying the write again. The `message` property of the response body may contain additional details about the error. If your data did not write to the database, see how to [troubleshoot rejected points](#troubleshoot-rejected-points). From 57eb8c6aa4edec70400f0c6cb807269b8c9cf2f9 Mon Sep 17 00:00:00 2001 From: Fraser Savage Date: Fri, 9 Aug 2024 16:17:43 +0100 Subject: [PATCH 88/96] refactor(write-api): Use proper product terms for Dedicated Co-authored-by: Scott Anderson --- api-docs/cloud-dedicated/v2/ref.yml | 2 +- api-docs/cloud-serverless/v2/ref.yml | 2 +- content/influxdb/cloud-dedicated/write-data/troubleshoot.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/api-docs/cloud-dedicated/v2/ref.yml b/api-docs/cloud-dedicated/v2/ref.yml index 941e27a13..ddaf7fc7e 100644 --- a/api-docs/cloud-dedicated/v2/ref.yml +++ b/api-docs/cloud-dedicated/v2/ref.yml @@ -707,7 +707,7 @@ paths: description: | Unprocessable Entity. - The request contained data outside the bucket's retention window, causing InfluxDB to reject the batch and write no data. + The request contained data outside the database’s retention period. InfluxDB rejected the batch and wrote no data. The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points). '429': diff --git a/api-docs/cloud-serverless/v2/ref.yml b/api-docs/cloud-serverless/v2/ref.yml index 2cc273595..d6047bc77 100644 --- a/api-docs/cloud-serverless/v2/ref.yml +++ b/api-docs/cloud-serverless/v2/ref.yml @@ -7709,7 +7709,7 @@ paths: description: | Unprocessable Entity. - The request contained data outside the bucket's retention window, causing InfluxDB to reject the batch and write no data. + The request contained data outside the bucket's retention period. InfluxDB rejected the batch and wrote no data. The response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points). '429': diff --git a/content/influxdb/cloud-dedicated/write-data/troubleshoot.md b/content/influxdb/cloud-dedicated/write-data/troubleshoot.md index 0650edfbc..97720907d 100644 --- a/content/influxdb/cloud-dedicated/write-data/troubleshoot.md +++ b/content/influxdb/cloud-dedicated/write-data/troubleshoot.md @@ -56,7 +56,7 @@ The `message` property of the response body may contain additional details about | `400 "Bad request"` | error details about rejected points, up to 100 points: `line` contains the first rejected line, `message` describes rejections line | If request data is malformed | | `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb/cloud-dedicated/admin/tokens/) doesn't have [permission](/influxdb/cloud-dedicated/reference/cli/influxctl/token/create/#examples) to write to the database. See [examples using credentials](/influxdb/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb) in write requests. | | `404 "Not found"` | requested **resource type** (for example, "organization" or "database"), and **resource name** | If a requested resource (for example, organization or database) wasn't found | -| `422 "Unprocessable Entity"` | `message` contains details about the error | If the data isn't allowed (for example, falls outside of the bucket's retention period). +| `422 "Unprocessable Entity"` | `message` contains details about the error | If the data isn't allowed (for example, falls outside of the database’s retention period). | `500 "Internal server error"` | | Default status for an error | | `503 "Service unavailable"` | | If the server is temporarily unavailable to accept writes. The `Retry-After` header contains the number of seconds to wait before trying the write again. From 80371454bab71d8cbde7c131ca37adc8ae6d0515 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 9 Aug 2024 18:46:36 -0600 Subject: [PATCH 89/96] Update the v3 storage diagram with missing components (#5558) * update v3 storage diagram with missing components * remove orphaned style tag from svg * Apply suggestions from code review --- .../reference/internals/storage-engine.md | 34 +++ .../influxdb/clustered/admin/scale-cluster.md | 18 +- .../reference/internals/storage-engine.md | 36 ++++ static/svgs/v3-storage-architecture.svg | 196 ++++++++---------- 4 files changed, 168 insertions(+), 116 deletions(-) diff --git a/content/influxdb/cloud-dedicated/reference/internals/storage-engine.md b/content/influxdb/cloud-dedicated/reference/internals/storage-engine.md index 508dab4ad..80de0c545 100644 --- a/content/influxdb/cloud-dedicated/reference/internals/storage-engine.md +++ b/content/influxdb/cloud-dedicated/reference/internals/storage-engine.md @@ -23,11 +23,13 @@ queries, and is optimized to reduce storage cost. - [Storage engine diagram](#storage-engine-diagram) - [Storage engine components](#storage-engine-components) + - [Router](#router) - [Ingester](#ingester) - [Querier](#querier) - [Catalog](#catalog) - [Object store](#object-store) - [Compactor](#compactor) + - [Garbage collector](#garbage-collector) - [Scaling strategies](#scaling-strategies) - [Vertical scaling](#vertical-scaling) - [Horizontal scaling](#horizontal-scaling) @@ -38,11 +40,29 @@ queries, and is optimized to reduce storage cost. ## Storage engine components +- [Router](#router) - [Ingester](#ingester) - [Querier](#querier) - [Catalog](#catalog) - [Object store](#object-store) - [Compactor](#compactor) +- [Garbage collector](#garbage-collector) + +### Router + +The Router (also known as the Ingest Router) parses incoming line +protocol and then routes it to [Ingesters](#ingester). +To ensure write durability, the Router replicates data to two or more of the +available Ingesters. + +##### Router scaling strategies + +The Router can be scaled both [vertically](#vertical-scaling) and +[horizontally](#horizontal-scaling). +Horizontal scaling increases write throughput and is typically the most +effective scaling strategy for the Router. +Vertical scaling (specifically increased CPU) improves the Router's ability to +parse incoming line protocol with lower latency. ### Ingester @@ -150,6 +170,20 @@ increasing the available CPU) is the most effective scaling strategy for the Com Horizontal scaling increases compaction throughput, but not as efficiently as vertical scaling. +### Garbage collector + +The Garbage collector runs background jobs that evict expired or deleted data, +remove obsolete compaction files, and reclaim space in both the [Catalog](#catalog) and the +[Object store](#object-store). + +##### Garbage collector scaling strategies + +The Garbage collector is not designed for distributed load and should _not_ be +scaled horizontally. The Garbage collector does not perform CPU- or +memory-intensive work, so [vertical scaling](#vertical-scaling) should only be +considered only if you observe very high CPU usage or if the container regularly +runs out of memory. + --- ## Scaling strategies diff --git a/content/influxdb/clustered/admin/scale-cluster.md b/content/influxdb/clustered/admin/scale-cluster.md index 061a3e702..31aa9042f 100644 --- a/content/influxdb/clustered/admin/scale-cluster.md +++ b/content/influxdb/clustered/admin/scale-cluster.md @@ -262,13 +262,22 @@ to automatically scale your cluster as needed. ## Recommended scaling strategies per component +- [Router](#router) - [Ingester](#ingester) - [Querier](#querier) -- [Router](#router) - [Compactor](#compactor) - [Catalog](#catalog) - [Object store](#object-store) +### Router + +The Router can be scaled both [vertically](#vertical-scaling) and +[horizontally](#horizontal-scaling). +Horizontal scaling increases write throughput and is typically the most +effective scaling strategy for the Router. +Vertical scaling (specifically increased CPU) improves the Router's ability to +parse incoming line protocol with lower latency. + ### Ingester The Ingester can be scaled both [vertically](#vertical-scaling) and @@ -322,13 +331,6 @@ Horizontal scaling increases query throughput to handle more concurrent queries. Vertical scaling improves the Querier’s ability to process computationally intensive queries. -### Router - -The Router can be scaled both [vertically](#vertical-scaling) and -[horizontally](#horizontal-scaling). -Horizontal scaling increases request throughput and is typically the most effective -scaling strategy for the Router. - ### Compactor The Compactor can be scaled both [vertically](#vertical-scaling) and diff --git a/content/influxdb/clustered/reference/internals/storage-engine.md b/content/influxdb/clustered/reference/internals/storage-engine.md index c26add10d..7425df27d 100644 --- a/content/influxdb/clustered/reference/internals/storage-engine.md +++ b/content/influxdb/clustered/reference/internals/storage-engine.md @@ -11,6 +11,7 @@ menu: parent: InfluxDB internals influxdb/clustered/tags: [storage, internals] related: + - /influxdb/clustered/admin/scale-cluster/ - /influxdb/clustered/admin/custom-partitions/ --- @@ -23,11 +24,13 @@ queries, and is optimized to reduce storage cost. - [Storage engine diagram](#storage-engine-diagram) - [Storage engine components](#storage-engine-components) + - [Router](#router) - [Ingester](#ingester) - [Querier](#querier) - [Catalog](#catalog) - [Object store](#object-store) - [Compactor](#compactor) + - [Garbage collector](#garbage-collector) ## Storage engine diagram @@ -35,11 +38,29 @@ queries, and is optimized to reduce storage cost. ## Storage engine components +- [Router](#router) - [Ingester](#ingester) - [Querier](#querier) - [Catalog](#catalog) - [Object store](#object-store) - [Compactor](#compactor) +- [Garbage collector](#garbage-collector) + +### Router + +The Router (also known as the Ingest Router) parses incoming line +protocol and then routes it to [Ingesters](#ingester). +To ensure write durability, the Router replicates data to two or more of the +available Ingesters. + +##### Router scaling strategies + +The Router can be scaled both [vertically](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) +and [horizontally](/influxdb/clustered/admin/scale-cluster/#horizontal-scaling). +Horizontal scaling increases write throughput and is typically the most +effective scaling strategy for the Router. +Vertical scaling (specifically increased CPU) improves the Router's ability to +parse incoming line protocol with lower latency. ### Ingester @@ -149,3 +170,18 @@ Because compaction is a compute-heavy process, vertical scaling (especially increasing the available CPU) is the most effective scaling strategy for the Compactor. Horizontal scaling increases compaction throughput, but not as efficiently as vertical scaling. + +### Garbage collector + +The Garbage collector runs background jobs that evict expired or deleted data, +remove obsolete compaction files, and reclaim space in both the [Catalog](#catalog) and the +[Object store](#object-store). + +##### Garbage collector scaling strategies + + +The Garbage collector is not designed for distributed load and should _not_ be +scaled horizontally. The Garbage collector does not perform CPU- or +memory-intensive work, so [vertical scaling](/influxdb/clustered/admin/scale-cluster/#vertical-scaling) +should only be considered only if you observe very high CPU usage or +if the container regularly runs out of memory. diff --git a/static/svgs/v3-storage-architecture.svg b/static/svgs/v3-storage-architecture.svg index f22289a03..f15cc5ca5 100644 --- a/static/svgs/v3-storage-architecture.svg +++ b/static/svgs/v3-storage-architecture.svg @@ -1,127 +1,107 @@ - - - - - - - - - -Ingester - - - - -Querier -Object StorageTime series data stored inApache Parquet format - -CatalogRelational metadataservice - + + + + + + + + + +Ingester + + + +Router + + + + +Querier +Object Storage +Time series data stored in +Apache Parquet format + - Compactor + Catalog + Relational metadata + service + + +Compactor + + + + - - - - - - - - - + + - - - - - - + + + - - - - - - - - - + + - - - - - - + + + + + + + + - - - - - - + + + - +Query yet-to-be-persisted data + +WAL +Short-term +persistence +Write requests +Query requests - - - - - - - - - - -Query yet-to-be-persisted data - - - -WALShort-termpersistence - - Write requests + + + + + + + + - Query requests + + + + + + + - - - - - - + + - - - - - - - - - - - - - - - - - - - +Garbage Collector + From a9f1ce6884b283b3e10861b18f17eb7061ad4fed Mon Sep 17 00:00:00 2001 From: Adam Date: Sat, 10 Aug 2024 10:44:30 -0700 Subject: [PATCH 90/96] Update regular-expression.md (#5562) Update "View regexp_* query example" lines to match the SQL example. Co-authored-by: Scott Anderson --- .../reference/sql/functions/regular-expression.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/influxdb/cloud-serverless/reference/sql/functions/regular-expression.md b/content/influxdb/cloud-serverless/reference/sql/functions/regular-expression.md index e6fd60eea..d2711f680 100644 --- a/content/influxdb/cloud-serverless/reference/sql/functions/regular-expression.md +++ b/content/influxdb/cloud-serverless/reference/sql/functions/regular-expression.md @@ -45,7 +45,7 @@ regexp_like(str, regexp[, flags]) - **U**: (ungreedy) Swap the meaning of `x*` and `x*?`. {{< expand-wrapper >}} -{{% expand "View `regexp_replace` query example" %}} +{{% expand "View `regexp_like` query example" %}} _The following example uses the sample data set provided in [Get started with InfluxDB tutorial](/influxdb/cloud-serverless/get-started/write/#construct-line-protocol)._ @@ -84,7 +84,7 @@ regexp_match(str, regexp, flags) - **i**: (insensitive) Ignore case when matching. {{< expand-wrapper >}} -{{% expand "View `regexp_replace` query example" %}} +{{% expand "View `regexp_match` query example" %}} _The following example uses the sample data set provided in [Get started with InfluxDB tutorial](/influxdb/cloud-serverless/get-started/write/#construct-line-protocol)._ From 92e8167745e2517880f1d1614aec6e9b49446abb Mon Sep 17 00:00:00 2001 From: mdevy-influxdata <53542066+mdevy-influxdata@users.noreply.github.com> Date: Sat, 10 Aug 2024 10:47:17 -0700 Subject: [PATCH 91/96] Update upgrade.md (#5560) removing mention of credentials. Co-authored-by: Scott Anderson --- content/influxdb/clustered/admin/upgrade.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/content/influxdb/clustered/admin/upgrade.md b/content/influxdb/clustered/admin/upgrade.md index b32bffd11..16c3cb587 100644 --- a/content/influxdb/clustered/admin/upgrade.md +++ b/content/influxdb/clustered/admin/upgrade.md @@ -65,16 +65,6 @@ All available InfluxDB Clustered package versions are provided at [oci.influxdata.com](https://oci.influxdata.com). Find the package version you want to upgrade to and copy the version number. -{{% note %}} - -#### oci.influxdata.com credentials - -[oci.influxdata.com](https://oci.influxdata.com) requires you to log in with -credentials provided by InfluxData. -If you don't have these credentials, -[contact InfluxData Support](https://support.influxdata.com). - -{{% /note %}} #### Checkpoint releases From 0d728a28a44428979311c5d0ec4b1d64da837e82 Mon Sep 17 00:00:00 2001 From: Gunnar Aasen Date: Tue, 13 Aug 2024 13:36:25 -0700 Subject: [PATCH 92/96] Enterprise 1.11.6 release notes --- .../v1/about-the-project/release-notes.md | 27 ++++++++++++++++++- data/products.yml | 2 +- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/content/enterprise_influxdb/v1/about-the-project/release-notes.md b/content/enterprise_influxdb/v1/about-the-project/release-notes.md index eca21f7b7..1595ac5f4 100644 --- a/content/enterprise_influxdb/v1/about-the-project/release-notes.md +++ b/content/enterprise_influxdb/v1/about-the-project/release-notes.md @@ -19,12 +19,37 @@ InfluxDB Enterprise builds are available. For more information, see [FIPS-compliant InfluxDB Enterprise builds](/enterprise_influxdb/v1/introduction/installation/fips-compliant/). {{% /note %}} +## v1.11.6 {date="2024-08-02"} + +### Bug Fixes + +- Prevent retention service from hanging, which could lead to a failure to remove old shards. +- Fix shard precreation service to pre-create shards for more than the first database. +- Fix issues with remote iterators caused by floating point literals being rounded in a way that causes precision loss and can drastically change the result. + This impacts InfluxQL statements that require creating remote iterators. + Clusters with replication across all data nodes are unlikely to see this issue. + The additional visible changes of this fix include: + - Changes precision of floating point numbers in error messages related to InfluxQL. + - Changes precision of floating point numbers in "EXPLAIN" and "EXPLAIN ANALYZE" output. + - Changes precision of floating point numbers from InfluxQL expressions included in tracing spans. +- Fix panic when empty tags are queried. +- Fix `influx_inspect` error when deleting last measurement. +- Improve TSM error handling. + +### Other + +- Upgrade Flux to v0.194.5. +- Upgrade Go to 1.21.10. +- Upgrade `protobuf` library. + +--- + ## v1.11.5 {date="2024-02-14"} {{% note %}} #### Upgrading from InfluxDB Enterprise v1.11.3 -If upgrading from InfluxDB Enterprise v1.11.3 to {{< latest-patch >}}, you can +If upgrading from InfluxDB Enterprise v1.11.3+ to {{< latest-patch >}}, you can now configure whether or not InfluxDB compacts series files on startup using the [`compact-series-file` configuration option](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#compact-series-file) in your [InfluxDB Enterprise data node configuration file](/enterprise_influxdb/v1/administration/configure/config-data-nodes/). diff --git a/data/products.yml b/data/products.yml index ffa90729a..60ca86008 100644 --- a/data/products.yml +++ b/data/products.yml @@ -113,7 +113,7 @@ enterprise_influxdb: - v1.7 latest: v1.11 latest_patches: - v1: 1.11.5 + v1: 1.11.6 flux: name: Flux From 2a39503ce1348b46278feb3cd9bb6e89b3fe2298 Mon Sep 17 00:00:00 2001 From: Gunnar Aasen Date: Mon, 19 Aug 2024 09:45:29 -0700 Subject: [PATCH 93/96] InfluxDB 2.7.9 and 2.7.10 --- .../v2/reference/release-notes/influxdb.md | 24 +++++++++++++++++++ data/products.yml | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/content/influxdb/v2/reference/release-notes/influxdb.md b/content/influxdb/v2/reference/release-notes/influxdb.md index 1a161b1f2..bc6202e2f 100644 --- a/content/influxdb/v2/reference/release-notes/influxdb.md +++ b/content/influxdb/v2/reference/release-notes/influxdb.md @@ -8,6 +8,30 @@ menu: weight: 101 --- +## v2.7.10 {date="2024-08-15"} + +### Bug Fixes + +- Update Flux to address performance regression. + +### Maintenance + +- Update Flux to 0.195.2. + +--- + +## v2.7.9 {date="2024-08-09"} + +### Bug Fixes + +- Fix UI build error. + +### Maintenance + +- Update `go` toolchain to 1.21.12. + +--- + ## v2.7.8 {date="2024-07-25"} ### Bug Fixes diff --git a/data/products.yml b/data/products.yml index 60ca86008..a01d42302 100644 --- a/data/products.yml +++ b/data/products.yml @@ -21,7 +21,7 @@ influxdb: - v1.7 latest: v2.7 latest_patches: - v2: 2.7.8 + v2: 2.7.10 v1: 1.8.10 latest_cli: v2: 2.7.5 From 636b7102607114725cbf7ca778412eb4c2b6fdfd Mon Sep 17 00:00:00 2001 From: Chunchun Ye <14298407+appletreeisyellow@users.noreply.github.com> Date: Tue, 20 Aug 2024 09:54:26 -0500 Subject: [PATCH 94/96] doc(serverless): add workaround for return data that is array/list (#5570) * chore: add workaround for return data that is array/list * chore: feedback Co-authored-by: Scott Anderson * chore: feedback Co-authored-by: Scott Anderson * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/troubleshoot.md --------- Co-authored-by: Scott Anderson --- .../query-data/troubleshoot-and-optimize/troubleshoot.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/troubleshoot.md b/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/troubleshoot.md index cabb4acaa..2cb99478e 100644 --- a/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/troubleshoot.md +++ b/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/troubleshoot.md @@ -28,6 +28,14 @@ If a query doesn't return any data, it might be due to the following: - Your data falls outside the time range (or other conditions) in the query--for example, the InfluxQL `SHOW TAG VALUES` command uses a default time range of 1 day. - The query (InfluxDB server) timed out. - The query client timed out. +- The query return type is not supported by the client library. + For example, array or list types may not be supported. + In this case, use `array_to_string()` to convert the array value to a string--for example: + + ```sql + SELECT array_to_string(array_agg([1, 2, 3]), ', ') + ``` + If a query times out or returns an error, it might be due to the following: From eb51d27f69ab126b622fe51e592169f9b24850eb Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Tue, 20 Aug 2024 09:05:54 -0600 Subject: [PATCH 95/96] hotfix: port array workaround to clustered and dedicated --- .../query-data/troubleshoot-and-optimize/troubleshoot.md | 7 +++++++ .../query-data/troubleshoot-and-optimize/troubleshoot.md | 1 - .../query-data/troubleshoot-and-optimize/troubleshoot.md | 7 +++++++ 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/troubleshoot.md b/content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/troubleshoot.md index b0ec24bfa..80b91422d 100644 --- a/content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/troubleshoot.md +++ b/content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/troubleshoot.md @@ -28,6 +28,13 @@ If a query doesn't return any data, it might be due to the following: - Your data falls outside the time range (or other conditions) in the query--for example, the InfluxQL `SHOW TAG VALUES` command uses a default time range of 1 day. - The query (InfluxDB server) timed out. - The query client timed out. +- The query return type is not supported by the client library. + For example, array or list types may not be supported. + In this case, use `array_to_string()` to convert the array value to a string--for example: + + ```sql + SELECT array_to_string(array_agg([1, 2, 3]), ', ') + ``` If a query times out or returns an error, it might be due to the following: diff --git a/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/troubleshoot.md b/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/troubleshoot.md index 2cb99478e..95f0d4e0c 100644 --- a/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/troubleshoot.md +++ b/content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/troubleshoot.md @@ -36,7 +36,6 @@ If a query doesn't return any data, it might be due to the following: SELECT array_to_string(array_agg([1, 2, 3]), ', ') ``` - If a query times out or returns an error, it might be due to the following: - a bad request diff --git a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/troubleshoot.md b/content/influxdb/clustered/query-data/troubleshoot-and-optimize/troubleshoot.md index 7454c13ed..ce6ac0473 100644 --- a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/troubleshoot.md +++ b/content/influxdb/clustered/query-data/troubleshoot-and-optimize/troubleshoot.md @@ -28,6 +28,13 @@ If a query doesn't return any data, it might be due to the following: - Your data falls outside the time range (or other conditions) in the query--for example, the InfluxQL `SHOW TAG VALUES` command uses a default time range of 1 day. - The query (InfluxDB server) timed out. - The query client timed out. +- The query return type is not supported by the client library. + For example, array or list types may not be supported. + In this case, use `array_to_string()` to convert the array value to a string--for example: + + ```sql + SELECT array_to_string(array_agg([1, 2, 3]), ', ') + ``` If a query times out or returns an error, it might be due to the following: From 78b99259bc315360c21aed77da837e7366e6a8a5 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Tue, 20 Aug 2024 09:12:51 -0600 Subject: [PATCH 96/96] hotfix: updated npm packages --- yarn.lock | 322 +++++++++++++++++++++++++++++------------------------- 1 file changed, 171 insertions(+), 151 deletions(-) diff --git a/yarn.lock b/yarn.lock index 683d2d900..71f7d2afc 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3,32 +3,32 @@ "@babel/code-frame@^7.0.0": - version "7.24.6" - resolved "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.6.tgz" - integrity sha512-ZJhac6FkEd1yhG2AHOmfcXG4ceoLltoCVJjN5XsWN9BifBQr+cHJbWi0h68HZuSORq+3WtJ2z0hwF2NG1b5kcA== + version "7.24.7" + resolved "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.7.tgz" + integrity sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA== dependencies: - "@babel/highlight" "^7.24.6" + "@babel/highlight" "^7.24.7" picocolors "^1.0.0" -"@babel/helper-validator-identifier@^7.24.6": - version "7.24.6" - resolved "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.6.tgz" - integrity sha512-4yA7s865JHaqUdRbnaxarZREuPTHrjpDT+pXoAZ1yhyo6uFnIEpS8VMu16siFOHDpZNKYv5BObhsB//ycbICyw== +"@babel/helper-validator-identifier@^7.24.7": + version "7.24.7" + resolved "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz" + integrity sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w== -"@babel/highlight@^7.24.6": - version "7.24.6" - resolved "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.6.tgz" - integrity sha512-2YnuOp4HAk2BsBrJJvYCbItHx0zWscI1C3zgWkz+wDyD9I7GIVrfnLyrR4Y1VR+7p+chAEcrgRQYZAGIKMV7vQ== +"@babel/highlight@^7.24.7": + version "7.24.7" + resolved "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.7.tgz" + integrity sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw== dependencies: - "@babel/helper-validator-identifier" "^7.24.6" + "@babel/helper-validator-identifier" "^7.24.7" chalk "^2.4.2" js-tokens "^4.0.0" picocolors "^1.0.0" "@evilmartians/lefthook@^1.7.1": - version "1.7.1" - resolved "https://registry.yarnpkg.com/@evilmartians/lefthook/-/lefthook-1.7.1.tgz#9278070fcfc0b03acaaa5d4fb1ccfd11527b7adf" - integrity sha512-Wp8DaTMHZM1tUV4Mow6nG+6zq+giruD5054zHmFIDLXlPQxqYxnZMqJg0aYxe16vYwqFmH6NIClEMRdtGucO0Q== + version "1.7.14" + resolved "https://registry.npmjs.org/@evilmartians/lefthook/-/lefthook-1.7.14.tgz" + integrity sha512-0FPRdmd7hIZXjTQKQjLnmqxx4xGRIM1oGN9pJ4PyI14tOqEAwstmLIbauqQpTVTj3MAPeylsQVXh9RGaq/F2/A== "@isaacs/cliui@^8.0.2": version "8.0.2" @@ -50,7 +50,7 @@ "@nodelib/fs.stat" "2.0.5" run-parallel "^1.1.9" -"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": +"@nodelib/fs.stat@^2.0.2", "@nodelib/fs.stat@2.0.5": version "2.0.5" resolved "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz" integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== @@ -96,9 +96,9 @@ integrity sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA== "@vvago/vale@^3.4.2": - version "3.4.2" - resolved "https://registry.npmjs.org/@vvago/vale/-/vale-3.4.2.tgz" - integrity sha512-ucMHEg9Hk9GrHkGXkFH1HlNTtF0H8X2FY3x0x00CRj3yFsEq/wzPSXqtrAzeNqd8dw6UAU5hrkOVUl0uShUoIg== + version "3.7.0" + resolved "https://registry.npmjs.org/@vvago/vale/-/vale-3.7.0.tgz" + integrity sha512-Jju27u/bQhQ0eogBTcTeqlpVF/5PejO3HFjuaD9tLVPgQ/1pb2pux0NMRq4idOtH8xotwyBO/dyPT9EbvnpGNQ== dependencies: axios "^1.4.0" rimraf "^5.0.0" @@ -153,21 +153,21 @@ asynckit@^0.4.0: integrity sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q== autoprefixer@>=10.2.5: - version "10.4.19" - resolved "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.19.tgz" - integrity sha512-BaENR2+zBZ8xXhM4pUaKUxlVdxZ0EZhjvbopwnXmxRUfqDmwSpC2lAi/QXvx7NRdPCo1WKEcEF6mV64si1z4Ew== + version "10.4.20" + resolved "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.20.tgz" + integrity sha512-XY25y5xSv/wEoqzDyXXME4AFfkZI0P23z6Fs3YgymDnKJkCGOnkL0iTxCa85UTqaSgfcqyf3UA6+c7wUvx/16g== dependencies: - browserslist "^4.23.0" - caniuse-lite "^1.0.30001599" + browserslist "^4.23.3" + caniuse-lite "^1.0.30001646" fraction.js "^4.3.7" normalize-range "^0.1.2" - picocolors "^1.0.0" + picocolors "^1.0.1" postcss-value-parser "^4.2.0" axios@^1.4.0, axios@^1.6.0: - version "1.7.2" - resolved "https://registry.npmjs.org/axios/-/axios-1.7.2.tgz" - integrity sha512-2A8QhOMrbomlDuiLeK9XibIBzuHeRcqqNOHp0Cyp5EoJ1IFDh+XZH3A6BkXtv0K4gFGCI0Y4BM7B1wOEi0Rmgw== + version "1.7.4" + resolved "https://registry.npmjs.org/axios/-/axios-1.7.4.tgz" + integrity sha512-DukmaFRnY6AzAALSH4J2M3k6PkaC+MfaAGdEERRWcC9q3/TWQwLpHR8ZRLKTdQ3aBDL64EdluRDjJqKw+BPZEw== dependencies: follow-redirects "^1.15.6" form-data "^4.0.0" @@ -236,15 +236,15 @@ braces@^3.0.3, braces@~3.0.2: dependencies: fill-range "^7.1.1" -browserslist@^4.23.0: - version "4.23.0" - resolved "https://registry.npmjs.org/browserslist/-/browserslist-4.23.0.tgz" - integrity sha512-QW8HiM1shhT2GuzkvklfjcKDiWFXHOeFCIA/huJPwHsslwcydgk7X+z2zXpEijP98UCY7HbubZt5J2Zgvf0CaQ== +browserslist@^4.23.3, "browserslist@>= 4.21.0": + version "4.23.3" + resolved "https://registry.npmjs.org/browserslist/-/browserslist-4.23.3.tgz" + integrity sha512-btwCFJVjI4YWDNfau8RhZ+B1Q/VLoUITrm3RlP6y1tYGWIOa+InuYiRGXUBXo8nA1qKmHMyLB/iVQg5TT4eFoA== dependencies: - caniuse-lite "^1.0.30001587" - electron-to-chromium "^1.4.668" - node-releases "^2.0.14" - update-browserslist-db "^1.0.13" + caniuse-lite "^1.0.30001646" + electron-to-chromium "^1.5.4" + node-releases "^2.0.18" + update-browserslist-db "^1.1.0" buffer-alloc-unsafe@^1.1.0: version "1.1.0" @@ -305,10 +305,10 @@ cacheable-request@^10.2.8: normalize-url "^8.0.0" responselike "^3.0.0" -caniuse-lite@^1.0.30001587, caniuse-lite@^1.0.30001599: - version "1.0.30001625" - resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001625.tgz" - integrity sha512-4KE9N2gcRH+HQhpeiRZXd+1niLB/XNLAhSy4z7fI8EzcbcPoAqjNInxVHTiTwWfTIV4w096XG8OtCOCQQKPv3w== +caniuse-lite@^1.0.30001646: + version "1.0.30001651" + resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001651.tgz" + integrity sha512-9Cf+Xv1jJNe1xPZLGuUXLNkE1BoDkqRqYyFJ9TDYSqhduqA4hu4oR9HluGoWYQC/aj8WHjsGVV+bwkh0+tegRg== careful-downloader@^3.0.0: version "3.0.0" @@ -386,16 +386,16 @@ color-convert@^2.0.1: dependencies: color-name "~1.1.4" -color-name@1.1.3: - version "1.1.3" - resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" - integrity sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== - color-name@~1.1.4: version "1.1.4" resolved "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz" integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz" + integrity sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== + combined-stream@^1.0.8: version "1.0.8" resolved "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz" @@ -435,9 +435,9 @@ crypto-random-string@^4.0.0: type-fest "^1.0.1" debug@^4.3.4: - version "4.3.4" - resolved "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz" - integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ== + version "4.3.6" + resolved "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz" + integrity sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg== dependencies: ms "2.1.2" @@ -533,10 +533,10 @@ eastasianwidth@^0.2.0: resolved "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz" integrity sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA== -electron-to-chromium@^1.4.668: - version "1.4.784" - resolved "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.784.tgz" - integrity sha512-9CZwh+sDrhDAeOEFh8s3PqwduzTyYIeYwZolc1b9ENAUt3ePu7R1sJSCWr/820ISssRxCJUyHI9Wb7j+0Uo1AA== +electron-to-chromium@^1.5.4: + version "1.5.12" + resolved "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.12.tgz" + integrity sha512-tIhPkdlEoCL1Y+PToq3zRNehUaKp3wBX/sr7aclAWdIWjvqAe/Im/H0SiCM4c1Q8BLPHCdoJTol+ZblflydehA== emoji-regex@^8.0.0: version "8.0.0" @@ -633,9 +633,9 @@ follow-redirects@^1.15.6: integrity sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA== foreground-child@^3.1.0: - version "3.1.1" - resolved "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz" - integrity sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg== + version "3.3.0" + resolved "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.0.tgz" + integrity sha512-Ld2g8rrAyMYFXBhEqMz8ZAHBi4J4uS1i/CxGMDnjyFWddMXLVcDp051DZfu+t7+ab7Wv6SMqpWmyFIj5UbfFvg== dependencies: cross-spawn "^7.0.0" signal-exit "^4.0.1" @@ -710,16 +710,16 @@ get-caller-file@^2.0.5: resolved "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz" integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg== -get-stdin@=8.0.0: - version "8.0.0" - resolved "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz" - integrity sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg== - get-stdin@^9.0.0: version "9.0.0" resolved "https://registry.npmjs.org/get-stdin/-/get-stdin-9.0.0.tgz" integrity sha512-dVKBjfWisLAicarI2Sf+JuBE/DghV4UzNAVe9yhEJuzeREd3JhOTE9cUaJTeSa77fsbQUK3pcOpJfM59+VKZaA== +get-stdin@=8.0.0: + version "8.0.0" + resolved "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz" + integrity sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg== + get-stream@^2.2.0: version "2.3.1" resolved "https://registry.npmjs.org/get-stream/-/get-stream-2.3.1.tgz" @@ -741,14 +741,15 @@ glob-parent@^5.1.2, glob-parent@~5.1.2: is-glob "^4.0.1" glob@^10.3.7: - version "10.4.1" - resolved "https://registry.npmjs.org/glob/-/glob-10.4.1.tgz" - integrity sha512-2jelhlq3E4ho74ZyVLN03oKdAZVUa6UDZzFLVH1H7dnoax+y9qyaq8zBkfDIggjniU19z0wU18y16jMB2eyVIw== + version "10.4.5" + resolved "https://registry.npmjs.org/glob/-/glob-10.4.5.tgz" + integrity sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg== dependencies: foreground-child "^3.1.0" jackspeak "^3.1.2" minimatch "^9.0.4" minipass "^7.1.2" + package-json-from-dist "^1.0.0" path-scurry "^1.11.1" glob@^7.1.3: @@ -764,9 +765,9 @@ glob@^7.1.3: path-is-absolute "^1.0.0" globby@^14.0.0: - version "14.0.1" - resolved "https://registry.npmjs.org/globby/-/globby-14.0.1.tgz" - integrity sha512-jOMLD2Z7MAhyG8aJpNOpmziMOP4rPLcc95oQPKXBazW82z+CEgPFBQvEpRUa1KeIMUJo4Wsm+q6uzO/Q/4BksQ== + version "14.0.2" + resolved "https://registry.npmjs.org/globby/-/globby-14.0.2.tgz" + integrity sha512-s3Fq41ZVh7vbbe2PN3nrW7yC7U7MFVc5c98/iTl9c2GawNMKx/J648KQRW6WKkuU8GIbbh2IXfIRQjOZnXcTnw== dependencies: "@sindresorhus/merge-streams" "^2.1.0" fast-glob "^3.3.2" @@ -802,7 +803,7 @@ has-flag@^3.0.0: resolved "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz" integrity sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw== -hasown@^2.0.0: +hasown@^2.0.2: version "2.0.2" resolved "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz" integrity sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ== @@ -830,9 +831,9 @@ http2-wrapper@^2.1.10: resolve-alpn "^1.2.0" hugo-extended@>=0.101.0: - version "0.126.1" - resolved "https://registry.npmjs.org/hugo-extended/-/hugo-extended-0.126.1.tgz" - integrity sha512-l67xrdep6aBx4tHmruMnwnGDlsUPIQMdJw0AWRgtJ6vsItlvsJfyma3PPd19NxFL2GE0I9D8UlyvnkT+zK35cg== + version "0.132.2" + resolved "https://registry.npmjs.org/hugo-extended/-/hugo-extended-0.132.2.tgz" + integrity sha512-KsEeBOratmFHaX8RnJSnkrqy4HaYn+GctHJRtUtoZJZ/mE1knogBKeB4Ss6T3juBwBS9PVF7hb9XSkjeJUAo2Q== dependencies: careful-downloader "^3.0.0" log-symbols "^5.1.0" @@ -844,9 +845,9 @@ ieee754@^1.1.13: integrity sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA== ignore@^5.2.4: - version "5.3.1" - resolved "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz" - integrity sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw== + version "5.3.2" + resolved "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz" + integrity sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g== inflight@^1.0.4: version "1.0.6" @@ -856,7 +857,7 @@ inflight@^1.0.4: once "^1.3.0" wrappy "1" -inherits@2, inherits@~2.0.0, inherits@~2.0.3: +inherits@~2.0.0, inherits@~2.0.3, inherits@2: version "2.0.4" resolved "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz" integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== @@ -874,11 +875,11 @@ is-binary-path@~2.1.0: binary-extensions "^2.0.0" is-core-module@^2.5.0: - version "2.13.1" - resolved "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.1.tgz" - integrity sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw== + version "2.15.0" + resolved "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.0.tgz" + integrity sha512-Dd+Lb2/zvk9SKy1TGCt1wFJFo/MWBPMX5x7KcvLajWTGuomczdQX61PvY5yK6SVACwpoexWo81IfFyoKY2QnTA== dependencies: - hasown "^2.0.0" + hasown "^2.0.2" is-extglob@^2.1.1: version "2.1.1" @@ -938,9 +939,9 @@ isexe@^2.0.0: integrity sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw== jackspeak@^3.1.2: - version "3.1.2" - resolved "https://registry.npmjs.org/jackspeak/-/jackspeak-3.1.2.tgz" - integrity sha512-kWmLKn2tRtfYMF/BakihVVRzBKOxz4gJMiL2Rj91WnAB5TPZumSH99R/Yf1qE1u4uRimvCSJfm6hnxohXeEXjQ== + version "3.4.3" + resolved "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz" + integrity sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw== dependencies: "@isaacs/cliui" "^8.0.2" optionalDependencies: @@ -977,7 +978,7 @@ jsonfile@^6.0.1: optionalDependencies: graceful-fs "^4.1.6" -jsox@^1.2.118: +jsox@^1.2.119: version "1.2.119" resolved "https://registry.npmjs.org/jsox/-/jsox-1.2.119.tgz" integrity sha512-f37obwxWKKuylcaOzNlUlzfDvURSCpqTXs8yEivhvsp86D/DTIySxP4v5Qdlg24qCuzDSZ0mJr3krc/f7TZ/5A== @@ -990,9 +991,9 @@ keyv@^4.5.3: json-buffer "3.0.1" lilconfig@^3.1.1: - version "3.1.1" - resolved "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.1.tgz" - integrity sha512-O18pf7nyvHTckunPWCV1XUNXU1piu01y2b7ATJ0ppkUkk8ocqVWBrYjJBCwHDjD/ZWcfyrA0P4gKhzWGi5EINQ== + version "3.1.2" + resolved "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.2.tgz" + integrity sha512-eop+wDAvpItUys0FWkHIKeC9ybYrTGbU41U5K7+bttZZeohvnY7M9dZ5kB21GNWiFT2q1OoPTvncPCgSOVO5ow== lines-and-columns@^1.1.6: version "1.2.4" @@ -1025,9 +1026,9 @@ lowercase-keys@^3.0.0: integrity sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ== lru-cache@^10.2.0: - version "10.2.2" - resolved "https://registry.npmjs.org/lru-cache/-/lru-cache-10.2.2.tgz" - integrity sha512-9hp3Vp2/hFQUiIwKo8XCeFVnrg8Pk3TYNPIR7tJADKi5YfcF7vEaK7avFHTlSy3kOKYaJQaalfEo6YuXdceBOQ== + version "10.4.3" + resolved "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz" + integrity sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ== lru-cache@^6.0.0: version "6.0.0" @@ -1086,9 +1087,9 @@ minimatch@^3.1.1: brace-expansion "^1.1.7" minimatch@^9.0.4: - version "9.0.4" - resolved "https://registry.npmjs.org/minimatch/-/minimatch-9.0.4.tgz" - integrity sha512-KqWh+VchfxcMNRAJjj2tnsSJdNbHsVgnkBhTNrW7AjVo6OvLtxw8zfT9oLw1JSohlFzJ8jCoTgaoXvJ+kHt6fw== + version "9.0.5" + resolved "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz" + integrity sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow== dependencies: brace-expansion "^2.0.1" @@ -1104,16 +1105,16 @@ minipass@^3.0.0: dependencies: yallist "^4.0.0" -minipass@^5.0.0: - version "5.0.0" - resolved "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz" - integrity sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ== - "minipass@^5.0.0 || ^6.0.2 || ^7.0.0", minipass@^7.1.2: version "7.1.2" resolved "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz" integrity sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw== +minipass@^5.0.0: + version "5.0.0" + resolved "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz" + integrity sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ== + minizlib@^2.1.1: version "2.1.2" resolved "https://registry.npmjs.org/minizlib/-/minizlib-2.1.2.tgz" @@ -1122,6 +1123,11 @@ minizlib@^2.1.1: minipass "^3.0.0" yallist "^4.0.0" +mkdirp@^1.0.3: + version "1.0.4" + resolved "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz" + integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== + "mkdirp@>=0.5 0": version "0.5.6" resolved "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.6.tgz" @@ -1129,11 +1135,6 @@ minizlib@^2.1.1: dependencies: minimist "^1.2.6" -mkdirp@^1.0.3: - version "1.0.4" - resolved "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz" - integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== - moo@^0.5.0: version "0.5.2" resolved "https://registry.npmjs.org/moo/-/moo-0.5.2.tgz" @@ -1159,10 +1160,10 @@ nearley@^2.20.1: railroad-diagrams "^1.0.0" randexp "0.4.6" -node-releases@^2.0.14: - version "2.0.14" - resolved "https://registry.npmjs.org/node-releases/-/node-releases-2.0.14.tgz" - integrity sha512-y10wOWt8yZpqXmOgRo77WaHEmhYQYGNA6y421PKsKYWEK8aW+cqAphborZDhqfyKrbZEN92CN1X2KbafY2s7Yw== +node-releases@^2.0.18: + version "2.0.18" + resolved "https://registry.npmjs.org/node-releases/-/node-releases-2.0.18.tgz" + integrity sha512-d9VeXT4SJ7ZeOqGX6R5EM022wpL+eWPooLI+5UpWn2jCT1aosUQEhQP214x33Wkwx3JQMvIm+tIoVOdodFS40g== node-sql-parser@^4.12.0: version "4.18.0" @@ -1227,6 +1228,11 @@ p-locate@^6.0.0: dependencies: p-limit "^4.0.0" +package-json-from-dist@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.0.tgz" + integrity sha512-dATvCeZN/8wQsGywez1mzHtTlP22H8OEfPrVMLNr4/eGa+ijtLn/6M5f0dY8UKNrC2O9UCU6SSoG3qRKnt7STw== + parse-json@^5.2.0: version "5.2.0" resolved "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz" @@ -1341,29 +1347,29 @@ postcss-value-parser@^4.2.0: resolved "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz" integrity sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ== -postcss@>=8.4.31: - version "8.4.38" - resolved "https://registry.npmjs.org/postcss/-/postcss-8.4.38.tgz" - integrity sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A== +postcss@^8.0.0, postcss@^8.1.0, postcss@>=8.0.9, postcss@>=8.4.31: + version "8.4.41" + resolved "https://registry.npmjs.org/postcss/-/postcss-8.4.41.tgz" + integrity sha512-TesUflQ0WKZqAvg52PWL6kHgLKP6xB6heTOdoYM0Wt2UHyxNa4K25EZZMgKns3BH1RLVbZCREPpLY0rhnNoHVQ== dependencies: nanoid "^3.3.7" - picocolors "^1.0.0" + picocolors "^1.0.1" source-map-js "^1.2.0" prettier-plugin-sql@^0.18.0: - version "0.18.0" - resolved "https://registry.npmjs.org/prettier-plugin-sql/-/prettier-plugin-sql-0.18.0.tgz" - integrity sha512-E7WXooLNtWyv79sYYHtQbfvXZ5B/OOR0ySBsB2evfrfvD4wJos1OKLBvVLC/a7+7YpG30bSUTgc2DEwz8ctPmQ== + version "0.18.1" + resolved "https://registry.npmjs.org/prettier-plugin-sql/-/prettier-plugin-sql-0.18.1.tgz" + integrity sha512-2+Nob2sg7hzLAKJoE6sfgtkhBZCqOzrWHZPvE4Kee/e80oOyI4qwy9vypeltqNBJwTtq3uiKPrCxlT03bBpOaw== dependencies: - jsox "^1.2.118" + jsox "^1.2.119" node-sql-parser "^4.12.0" sql-formatter "^15.0.2" tslib "^2.6.2" -prettier@^3.2.5: - version "3.2.5" - resolved "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz" - integrity sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A== +prettier@^3.0.3, prettier@^3.2.5: + version "3.3.3" + resolved "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz" + integrity sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew== pretty-hrtime@^1.0.3: version "1.0.3" @@ -1476,6 +1482,13 @@ reusify@^1.0.4: resolved "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz" integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw== +rimraf@^5.0.0: + version "5.0.10" + resolved "https://registry.npmjs.org/rimraf/-/rimraf-5.0.10.tgz" + integrity sha512-l0OE8wL34P4nJH/H2ffoaniAokM2qSmrtXHmlpvYr5AVVX8msAyW0l8NVJFDxlSK4u3Uh/f41cQheDVdnYijwQ== + dependencies: + glob "^10.3.7" + rimraf@2: version "2.7.1" resolved "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz" @@ -1483,13 +1496,6 @@ rimraf@2: dependencies: glob "^7.1.3" -rimraf@^5.0.0: - version "5.0.7" - resolved "https://registry.npmjs.org/rimraf/-/rimraf-5.0.7.tgz" - integrity sha512-nV6YcJo5wbLW77m+8KjH8aB/7/rxQy9SZ0HY5shnwULfS+9nmTtVXAJET5NdZmCzA4fPI/Hm1wo/Po/4mopOdg== - dependencies: - glob "^10.3.7" - run-parallel@^1.1.9: version "1.2.0" resolved "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz" @@ -1502,7 +1508,12 @@ safe-buffer@^5.1.1: resolved "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz" integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== -safe-buffer@~5.1.0, safe-buffer@~5.1.1: +safe-buffer@~5.1.0: + version "5.1.2" + resolved "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz" + integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g== + +safe-buffer@~5.1.1: version "5.1.2" resolved "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz" integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g== @@ -1515,9 +1526,9 @@ seek-bzip@^1.0.5: commander "^2.8.1" semver@^7.3.4: - version "7.6.2" - resolved "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz" - integrity sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w== + version "7.6.3" + resolved "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz" + integrity sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A== setimmediate@~1.0.4: version "1.0.5" @@ -1578,14 +1589,21 @@ spdx-license-ids@^3.0.0: integrity sha512-xxRs31BqRYHwiMzudOrpSiHtZ8i/GeionCBDSilhYRj+9gIcI8wCZTlXZKu9vZIVqViP3dcp9qE5G6AlIaD+TQ== sql-formatter@^15.0.2: - version "15.3.2" - resolved "https://registry.npmjs.org/sql-formatter/-/sql-formatter-15.3.2.tgz" - integrity sha512-pNxSMf5DtwhpZ8gUcOGCGZIWtCcyAUx9oLgAtlO4ag7DvlfnETL0BGqXaISc84pNrXvTWmt8Wal1FWKxdTsL3Q== + version "15.4.0" + resolved "https://registry.npmjs.org/sql-formatter/-/sql-formatter-15.4.0.tgz" + integrity sha512-h3uVulRmOfARvDejuSzs9GMbua/UmGCKiP08zyHT1PnG376zk9CHVsDAcKIc9TcIwIrDH3YULWwI4PrXdmLRVw== dependencies: argparse "^2.0.1" get-stdin "=8.0.0" nearley "^2.20.1" +string_decoder@~1.1.1: + version "1.1.1" + resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz" + integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== + dependencies: + safe-buffer "~5.1.0" + "string-width-cjs@npm:string-width@^4.2.0": version "4.2.3" resolved "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz" @@ -1595,7 +1613,16 @@ sql-formatter@^15.0.2: is-fullwidth-code-point "^3.0.0" strip-ansi "^6.0.1" -string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: +string-width@^4.1.0, string-width@^4.2.0: + version "4.2.3" + resolved "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz" + integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.1" + +string-width@^4.2.3: version "4.2.3" resolved "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz" integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== @@ -1613,13 +1640,6 @@ string-width@^5.0.1, string-width@^5.1.2: emoji-regex "^9.2.2" strip-ansi "^7.0.1" -string_decoder@~1.1.1: - version "1.1.1" - resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz" - integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== - dependencies: - safe-buffer "~5.1.0" - "strip-ansi-cjs@npm:strip-ansi@^6.0.1": version "6.0.1" resolved "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz" @@ -1778,10 +1798,10 @@ unzipper@^0.10.14: readable-stream "~2.3.6" setimmediate "~1.0.4" -update-browserslist-db@^1.0.13: - version "1.0.16" - resolved "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.16.tgz" - integrity sha512-KVbTxlBYlckhF5wgfyZXTWnMn7MMZjMu9XG8bPlliUOP9ThaF4QnhP8qrjrH7DRzHfSk0oQv1wToW+iA5GajEQ== +update-browserslist-db@^1.1.0: + version "1.1.0" + resolved "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz" + integrity sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ== dependencies: escalade "^3.1.2" picocolors "^1.0.1" @@ -1854,9 +1874,9 @@ yallist@^4.0.0: integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== yaml@^2.4.2: - version "2.4.2" - resolved "https://registry.npmjs.org/yaml/-/yaml-2.4.2.tgz" - integrity sha512-B3VqDZ+JAg1nZpaEmWtTXUlBneoGx6CPM9b0TENK6aoSu5t73dItudwdgmi6tHlIZZId4dZ9skcAQ2UbcyAeVA== + version "2.5.0" + resolved "https://registry.npmjs.org/yaml/-/yaml-2.5.0.tgz" + integrity sha512-2wWLbGbYDiSqqIKoPjar3MPgB94ErzCtrNE1FdqGuaO0pi2JGjmE8aW8TDZwzU7vuxcGRdL/4gPQwQ7hD5AMSw== yargs-parser@^21.1.1: version "21.1.1" @@ -1885,6 +1905,6 @@ yauzl@^2.4.2: fd-slicer "~1.1.0" yocto-queue@^1.0.0: - version "1.0.0" - resolved "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.0.0.tgz" - integrity sha512-9bnSc/HEW2uRy67wc+T8UwauLuPJVn28jb+GtJY16iiKWyvmYJRXVT4UamsAEGQfPohgr2q4Tq0sQbQlxTfi1g== + version "1.1.1" + resolved "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.1.1.tgz" + integrity sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g==