Commit Graph

12 Commits (b4da11518bf6b4a6c6f0f3ef8d600bfc665a4da8)

Author SHA1 Message Date
Jason Stirnaman de0f526bdf
Reorganize Serverless DBRP for v1 queries and writes, explain DBRP and auto bucket defaults (#5257)
* chore(v3): DBRP: Update Serverless API ref (#5234)

* chore(ci): Tests: substitute placeholders in JSON body parameters

* chore(v3): DBRP: copy page from influxql to admin/dbrps.

* chore(ci): Trying to prevent "a Influx..."

* chore(ci): Allow autogen

* chore(serverless): DBRP glossary entry

* chore(v2): add default DBRP note

* chore(v3): use product-name shortcode

* chore(v3): use product-name shortcode, clarify retention period and mapping

* chore(serverless): Create Bucket:

- add missing example for Data Explorer
- move Retention Period syntax and define retentionRules syntax
- setup for tests

* chore(serverless): Create Bucket:

- add missing example for Data Explorer
- move Retention Period syntax and define retentionRules syntax
- setup for tests

* chore(serverless): Update bucket: alias to match other products

* chore(v3): Serverless for prototyping: update with DBRP behavior

* Serverless auto-generated buckets have 3-day default retention period
Fixes #5234

- v1-compat guide:
  - passes tests
  - explains DBRPs (default, automatic, and management)
  - migrate DBRP content from query-data/influxql/dbrp
- v2-compat guide:
  - fix TOC
  - add list code example
- rename influxdb-v1-api to api/v1-http, migrate params from v1-compat guide, and explain DBRP in context
- add write-data/api/v1-http and migrate content from v1-compat guide
- move optimize and troubleshooting up to /query-data
- add Related items support for paths containing http
- substitute placeholders in tests

* chore(test): update configuration in README

* fix(serverless): Optimize queries parent

* fix(serverless): create-bucket cleanup

* fix: cleanup

* fix: close tag

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix(v3): permission to create dbrp-mapped bucket

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-12-05 16:48:25 -06:00
Jason Stirnaman de4fe4c0ba
Fix: Placeholder cleanup (#5164)
* chore(ci): Update vocab.

* chore(test): Set language-specific replacements for code sample tests

This is a bit of kludge to allow for language-specific replacement patterns
while keeping the code samples valid when a user replaces placeholder strings with their own and copies the sample.
This is necessary for executing (not for validating syntax) of the code samples.

- Workaround for identifying language-specific replacements for pytest-codeblocks test runs.
- Uses Python f-strings to identify Python-specific placeholders.
- To import os for your code sample and hide it from users, wrap it in a comment and use the `pytest-codeblocks:cont` comment tag. See d0ca7e22b8/README.md?plain=1#L117

* fix(v3): Cleanup: fix link and grammar
2023-10-04 09:36:20 -05:00
Jason Stirnaman 35f3f09edb
Python test placeholders (#5161)
* chore(ci): Update vocab.

* chore(test): Set language-specific replacements for code sample tests

This is a bit of kludge to allow for language-specific replacement patterns
while keeping the code samples valid when a user replaces placeholder strings with their own and copies the sample.
This is necessary for executing (not for validating syntax) of the code samples.

- Workaround for identifying language-specific replacements for pytest-codeblocks test runs.
- Uses Python f-strings to identify Python-specific placeholders.
- To import os for your code sample and hide it from users, wrap it in a comment and use the `pytest-codeblocks:cont` comment tag. See d0ca7e22b8/README.md?plain=1#L117
2023-10-03 10:09:47 -05:00
Jason Stirnaman 4197c01712
feature(dedicated): InfluxDB Flight responses and errors (Closes #5114): (#5115)
* feature(dedicated): InfluxDB Flight responses and errors (Closes #5114):

- Describe Flight+gRPC high-level request semantics.
- Relationship between gRPC, Flight, InfluxDB
- List error codes using by InfluxDB, how they translate to Flight and gRPC statuses.
- Example errors, what they mean, possible causes

Co-authored by: Jay Clifford<@Jayclifford345>

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* fix(v3): Apply suggestions from @alamb. Refine organization, add stream and RecordBatch sections.

* fix(v3): improve stream, schema, batch

* fix(v3): toc

* fix(v3): troubleshoot flight (Flight responses and errors when querying v3 #5114):

- gRPC server-side streaming and nomenclature.

* fix(v3): Fix evaluation and prototyping #5120

* fix(v3): rename, update v3 Python reference, fix params (closes Flight responses and errors when querying v3 #5114)

* fix(v3): file name

* Update content/influxdb/cloud-dedicated/query-data/execute-queries/troubleshoot.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/query-data/execute-queries/troubleshoot.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-serverless/query-data/execute-queries/troubleshoot.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-serverless/query-data/execute-queries/troubleshoot.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix(v3): add PR suggestions

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-09-05 13:00:29 -05:00
Jason Stirnaman ed545d81d1
Data durability: write ahead vs S3 replication (#5112)
Fixes #5111
- Clarify intro.
2023-08-25 13:31:18 -05:00
Jason Stirnaman da36218fb2
Execute queries reorg (#5100)
* chore(ci): Add git pre-commit hook script with Vale linting

* fix(v3): Get started: update cloud lib parameters and signatures.

* fix(v3): v1-api: move to Execute queries and cleanup params

* fix(v3): Add Execute queries > Client libraries

* fix(v3): Python and Go client library guides: reorg and cleanup.

* fix(v3): Spelling

* chore(v3): Go client lib reference.

* chore(ci): Add upsample to accepted terms.

* fix(v3): Fix pandas guides.

* fix(v3): Get started: query cleanup.

* fix(v3): cleanup go-flight

* fix(v3): Data explorer cleanup.

* fix(v3): clean up client lib index

* fix(v3): API cleanup.

* fix(v3): add metadata

* fix(v3): Cleanup

* fix(v3): Required indicator

* Update content/influxdb/cloud-serverless/query-data/execute-queries/influxdb-v1-api.md

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md

* Update content/influxdb/cloud-serverless/reference/client-libraries/flight/python-flightsql-dbapi.md

* Update content/influxdb/cloud-dedicated/get-started/query.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-serverless/reference/client-libraries/flight/java-flightsql.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/get-started/query.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-08-24 15:11:28 -05:00
Jason Stirnaman fe2748d5e6
chore: Add Vale instructions to Contributing, update tested Hugo version (#5088) 2023-08-17 10:21:46 -05:00
Jason Stirnaman ded51cc323
Cloud Dedicated security and token detail (#5084)
* chore(dedicated): WIP - auth (#5078)

* chore(dedicated): add security and token details (Closes #5078)

* Update content/influxdb/cloud-dedicated/reference/internals/security.md

* Update content/influxdb/cloud-dedicated/reference/internals/security.md

* Update content/influxdb/cloud-dedicated/reference/internals/security.md

* Update content/influxdb/cloud-dedicated/reference/internals/security.md

* Update content/influxdb/cloud-dedicated/reference/internals/security.md

* Update content/influxdb/cloud-dedicated/reference/internals/security.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/reference/internals/security.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* chore(ci): Vale: Ignore "application"

* fix(dedicated): replace "permissions sets", user provisioning correction

* Update content/influxdb/cloud-dedicated/reference/internals/security.md

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-08-14 15:22:46 -05:00
Jason Stirnaman 9404fda2f3
chore(ci): Add vale script, configuration, and fixes (#5081)
- Adds VSCode directory-specific configurations for Vale
- Adds a simple shell script to run Vale for dedicated, serverless, and telegraf.
- Adds vocab and spelling configuration.
- Fixes some spelling and style errors in serverless and dedicated.
2023-08-11 13:50:31 -05:00
Jason Stirnaman 4b6494969b
chore(telegraf): Update input and output data formats from Telegraf docs (Closes #5054): (#5072)
* Telegraf parser docs aren't consistent with the available parsers. Include parser docs from Telegraf repo, separately from data formats.
 #5054

* chore(telegraf): Update input and output data formats from Telegraf docs (Closes #5054):

- Update input data formats with latest from Telegraf docs.
- Revise output data format descriptions and frontmatter.
- Trying not to change too much yet; ideally, we'd settle on style for Telegraf docs and only pull from there.

* fix(telegraf): set list titles, fix frontmatter

* Delete accidentally committed file

* Update content/telegraf/v1.27/configure_plugins/template-patterns.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/data_formats/input/xpath_json.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/configure_plugins/template-patterns.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/data_formats/input/xpath_json.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/data_formats/input/xpath_json.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/data_formats/input/xpath_json.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/data_formats/input/xpath_json.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/configure_plugins/template-patterns.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/configure_plugins/template-patterns.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/configure_plugins/template-patterns.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/configure_plugins/template-patterns.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/telegraf/v1.27/configure_plugins/template-patterns.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix(telegraf): configuration cleanup and apply suggestions

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-08-08 11:03:42 -05:00
Jason Stirnaman caa7ae69f7
chore(ci): Vale: ignore words, ignore spelling and ellipses in table cells (#5066) 2023-08-01 15:00:28 -05:00
Jason Stirnaman b2b6f235dd
Vale linter config (#5060)
* chore(quality-of-life): Initial commit of Vale config, InfluxDataDocs style, and Vocab files for linting docs.

* Update content/influxdb/cloud-dedicated/.vale.ini

* Update content/influxdb/cloud-serverless/.vale.ini

* chore(ci): add terms.

* chore(ci): add vale terms

* chore(ci): add vale terms
2023-08-01 10:38:04 -05:00