Commit Graph

79 Commits (06512e3e931f90d7cc7ea6455220a66e1012bc75)

Author SHA1 Message Date
Jason Stirnaman ca24b3be54
Influxdb3 config options (#6419)
* docs(cli): fix global vs serve-specific flag documentation

- Remove --verbose from global flags (it's serve-specific)
- Document --num-io-threads as global-only flag
- Add clear examples showing correct flag positioning
- Update serve.md files with global flag usage notes
- Fix config-options.md to separate Core/Enterprise examples

Resolves incorrect CLI usage patterns that would cause errors.
Global flags must go before 'serve', serve-specific flags go after.

* docs(cli): remove Tokio runtime options from CLI index pages

- Remove detailed Tokio runtime options tables from CLI index pages
- Replace with simplified global options and link to config-options
- Add examples showing correct global flag positioning
- Fix --verbose usage to be serve-specific (after serve command)
- Add --num-io-threads example as global flag (before serve command)

These detailed options are now documented in config-options.md with
proper global vs serve-specific categorization.
2025-10-20 10:17:56 -05:00
Jason Stirnaman d5866d1737 feat(influxdb3): Data retention in Core and Enterprise:
- Adds /reference/internals/data-retention/ for data retention behavior and retention period details
- admin/databases and admin/tables:
  - Adds examples for API and retention period
  - Adds cautions and behavior notes for Core retention
- reference/cli/influxdb3: Adds usage examples and details
- Closes /influxdata/DAR/issues/548
2025-10-10 15:00:52 -05:00
Jason Stirnaman 55017154fb feat(influxdb3): add install package command documentation
- Create shared CLI documentation for install package command
- Add Enterprise and Core frontmatter files referencing shared content
- Add --node-spec option to create trigger command for Enterprise
- Update code-placeholders to use new fenced code block syntax

Closes influxdata/DAR#6301
2025-09-11 16:23:39 -05:00
Scott Anderson 8f729f9500
chore(sql): Update SQL reference with additional functions (#6359)
* feat(sql): WIP added struct and map functions

* chore(sql): update sql reference with new functions

* chore(sql): migrate sql reference function updates to other projects

* chore(sql): readd deleted cache functions pages

* Update content/shared/sql-reference/functions/array.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix(sql): fixed broken anchor links

* fix(sql): fixed typos

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-09-05 08:26:38 -06:00
Scott Anderson 3222c7a9fb
InfluxDB 3.4 offline tokens (#6346)
* update: add 3.4 notes

* update: 3.4 notes

* Update content/shared/v3-core-enterprise-release-notes/_index.md

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

* Update content/shared/v3-core-enterprise-release-notes/_index.md

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

* Update content/shared/v3-core-enterprise-release-notes/_index.md

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

* Update content/shared/v3-core-enterprise-release-notes/_index.md

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

* Update content/shared/v3-core-enterprise-release-notes/_index.md

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

* Update content/shared/v3-core-enterprise-release-notes/_index.md

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

* Update content/shared/v3-core-enterprise-release-notes/_index.md

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

* Update content/shared/v3-core-enterprise-release-notes/_index.md

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

* Update content/shared/v3-core-enterprise-release-notes/_index.md

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

* feat(influxdb-3.4): added cli updates for influxdb 3.4

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: add whitespace to influxdb3 write doc

* feat(offline-tokens): add offline tokens to config options page

* feat(offline-tokens): add task-based offline token docs

* fix(links): fixed broken links and added TOC to offline tokens guide

* Apply suggestions from code review

Co-authored-by: マルコメ <akio.muto@bnt.benextgroup.jp>

* chore(offline-tokens): add token string security standards

* chore(offline-tokens): add note about token string prefix

---------

Co-authored-by: Peter Barnett <peter.barnett03@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: マルコメ <akio.muto@bnt.benextgroup.jp>
2025-08-28 07:03:03 -06:00
peterbarnett03 3df82f362e
fix: remove buffer-mem-limit-mb (#6341) 2025-08-27 08:32:06 -06:00
Jason Stirnaman 081952249b hotfix(influxdb3): processing engine source and description (closes #6335) 2025-08-22 17:50:19 -05:00
Jason Stirnaman f23026982b chore(monolith): Move telemetry reference to shared/influxdb3-reference. Revise description, disable, and product names. 2025-08-14 14:41:05 -05:00
Jason Stirnaman 8f16fa42ed
Merge branch 'master' into pbarnett/add-telemetry-docs 2025-08-14 14:03:40 -05:00
Peter Barnett 5492ba9eef fix: remember the 3 2025-08-14 11:52:59 -04:00
Scott Anderson 4d5d509234 fix(monolith): add configurable db, table, and column limits to enterprise 2025-08-14 10:44:58 -05:00
Peter Barnett 963d0a8d21 docs: add usage telemetry documentation 2025-08-14 11:29:44 -04:00
Jason Stirnaman df1069ba65 chore(3ent): Add --num-core config option (still missing from the CLI --help) 2025-08-06 12:54:56 -05:00
Jason Stirnaman 407a5e6de6 1. Updated Core serve.md Options Section
- Updated /content/influxdb3/core/reference/cli/influxdb3/serve.md with 84 Core-compatible options
  - Excluded 21 Enterprise-only options (like cluster-id, license-email, license-file, mode, compaction options, clustering options, etc.)
  - All options now link to the Core configuration documentation
  - Fixed the environment variables link to point to Core instead of Enterprise

2. Updated Enterprise serve.md Options Section

  - Updated /content/influxdb3/enterprise/reference/cli/influxdb3/serve.md with all 105 configuration options
  - Includes both Core and Enterprise-only options
  - Maintains proper required option markers for node-id and cluster-id
  - All options link to the Enterprise configuration documentation

3. Verified Content Consistency

  - Core serve.md: Contains examples without cluster-id parameter (appropriate for Core)
  - Enterprise serve.md: Contains examples with both node-id and cluster-id parameters, plus Enterprise-specific mode examples
  - Both maintain consistent structure and troubleshooting sections appropriate to their respective products
  - Environment variables sections correctly reference their respective configuration documentation

4. Allow Vale to accept "parquet" in lowercase when it appears in:
  - Command-line options (e.g., --parquet-mem-cache-size)
  - Hyphenated configuration names (e.g., parquet-mem-cache-prune-interval)
  - Code blocks or inline code (e.g., `parquet`)

  Key Changes Made:

  - Core: Now includes 84 options (was 69), excluding Enterprise-only features
  - Enterprise: Now includes all 105 options (was 78), comprehensive coverage
  - Alphabetical ordering: Both option tables are now properly alphabetized
  - New options added: Many previously missing options like buffer-mem-limit-mb, tcp-listener-file-path, telemetry-*, wal-replay-*, etc.
  - Proper segregation: Core users no longer see Enterprise-only configuration options
  - Vale allows Parquet or parquet in the appropriate context
2025-08-06 12:54:56 -05:00
Jason Stirnaman 06608aea6c feat(influxdb3): add v3.3.0 release notes and admin token recovery documentation
- Add v3.3.0 release notes with grouped categories for Core and Enterprise features/fixes
- Document admin token recovery server feature (--admin-token-recovery-http-bind)
- Add recovery server option to CLI serve command reference (alphabetically sorted)
- Add configuration details for admin token recovery in config options
- Update regenerate token documentation with lost token recovery instructions
- Include security warnings about unauthenticated recovery endpoint
- Fix Vale linting issues (Parquet capitalization, remove exclamation point)

Related to influxdb PR #26594
2025-07-30 07:59:13 -05:00
Jason Stirnaman beeb428470 feat(v3): Add naming restrictions reference and guidelines:
- Fixes influxdata/DAR#515: discourages the use of a leading underscore in database and table names in all InfluxDB 3 versions, but doesn't disallow it
- Add detailed naming restrictions reference for all InfluxDB 3 versions
- Add basic guidelines in table and database creation guides.
- Core and Ent table guides are forthcoming in a separate PR
2025-07-10 16:10:27 -05:00
Jason Stirnaman aacef0a06a Add missing CLI options\
Fix `create token --admin` name in frontmatter
Improve schedule trigger docs with more detail:

  1. Core API documentation
  (/api-docs/influxdb3/core/v3/ref.yml):
    - Added missing duration units (weeks, months, years)
    - Added "Maximum interval: 1 year"
  2. Enterprise API documentation
  (/api-docs/influxdb3/enterprise/v3/ref.yml):
    - Added missing duration units (weeks, months, years)
    - Added "Maximum interval: 1 year"
  3. CLI reference documentation
  (/content/shared/influxdb3-cli/create/trigger.md):
    - Added complete list of supported duration units
    - Added "Maximum interval is 1 year" note

  All documentation now consistently reflects:
  - The complete set of supported duration units for
  every triggers
  - The 1-year maximum limit for interval-based
  scheduling
  - Clear examples showing the syntax
2025-07-08 13:24:52 -05:00
Jason Stirnaman 16f79c9549
Merge branch 'master' into jts-6160-3-2-cli 2025-06-27 18:30:41 -05:00
Jason Stirnaman 8e040c8eb3 fix(core,ent3): and related params are required (closes #6166) 2025-06-27 14:44:28 -05:00
Jason Stirnaman 429e3fc079
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-06-27 14:00:02 -05:00
Jason Stirnaman 6dac142127 feat(influxdb3): Core and Ent: CLI reference for update database, update table (Ent3 only)- Add CLI reference for influxdb3 update database command and retention period option in Core and Ent
- Add CLI ref for influxdb3 update table and ret. period option in Ent- Change volume source to /test for core and ent3 in compose.yaml
- Add alt_links instructions in CONTRIBUTING.md
2025-06-27 12:49:39 -05:00
Jason Stirnaman 52e6eeca8a feat: Update InfluxDB 3 CLI documentation for v3.2.0 features
- Add influxdb3 show license command documentation for Enterprise
- Update create database command with --retention-period option
- Update create table command with Enterprise --retention-period option
- Update delete database/table commands with --hard-delete options
- Update CLI command index to include license command
- Update planning documentation for CLI sync process
- Closes #6160
2025-06-26 16:59:21 -05:00
Jason Stirnaman 29a81be296 fix(influxdb3): Get started fixes 2025-06-24 10:21:32 -05:00
Jason Stirnaman 30f1ed07d0 fix(influxdb3): CLI links, create token parent, ignore cypress/downloads/* 2025-06-23 16:27:25 -05:00
Scott Anderson 4d22388bd9 WIP monolith get started, enterprise multi-node, file index docs 2025-06-17 17:12:42 -06:00
Jason Stirnaman 5e714ee693
Apply suggestions from code review 2025-06-11 11:06:47 -05:00
Peter Barnett 27181fd5b3 fix: update enterprise config options 2025-06-09 19:35:02 -04:00
Jameelah Mercer 0ee28e33a5
Merge branch 'master' into 6021-add-schedule-plugin-test-docs 2025-06-09 06:22:27 -07:00
Jason Stirnaman 01e872269d fix(mono): Bad anchors caused by {{< product-name >}} shortcode 2025-05-29 00:12:37 -05:00
Jason Stirnaman 7bf799c3d0 fix(mono): Update descriptions to be more operator-specific 2025-05-28 23:39:50 -05:00
Jason Stirnaman 2318cf7ac7 feat(mono): 3.1 admin tokens:
- Updates get-started and admin guides, CLI references
- Adds admin token CLI reference page
- Operator token (_admin) - system-generated, non-expiring
- Named admin tokens - user-defined with expiration support
- Resource tokens (Enterprise only) - database and system tokens
- Core vs Enterprise token limits properly documented
- Create the initial operator token
2025-05-28 22:41:03 -05:00
meelahme 20366d1144 docs: add schedule_plugin route files for Core and Enterprise 2025-05-24 12:18:55 +09:00
Jameelah Mercer 0f853d0900
Merge branch 'master' into 5949-add-api-reference-examples-to-influxdb3 2025-05-05 13:32:27 -07:00
Jason Stirnaman 91d4a9b525 chore(ent3): Add license file option to serve command list and sort the options 2025-05-02 17:55:35 -05:00
Jameelah Mercer 38a9aaf6b0
Merge branch 'master' into 5949-add-api-reference-examples-to-influxdb3 2025-05-02 11:22:32 -07:00
Jason Stirnaman f0864152a5 chore(influxdb3): Specify when data-dir is required, emphasize in license.md that license email and license file are mutually exclusive 2025-05-02 13:10:25 -05:00
Jason Stirnaman 43663d0836 fix(ent3): License options: clarify license email and license file are mutally exclusive (Closes #6039):
- Add examples using license email or license file
- Add license file entry in config-options and note they're mutually exclusive.
2025-05-02 12:47:06 -05:00
Michael Gattozzi be7b57f042
feat: Remove --ram-pool-data-bytes flag in docs
This command no longer exists in InfluxDB 3 Core/Enterprise. This commit
removes any reference to this flag.

Closes https://github.com/influxdata/influxdb/issues/26343
Closes #6034
2025-05-01 11:53:45 -04:00
meelahme b16ea65c05 chore(cli): remove delete plugin.md from enterprise CLI reference 2025-04-30 16:37:42 -07:00
meelahme dfd1a9ceba chore(cli): remove create plugin.md from enterprise CLI reference 2025-04-30 16:31:06 -07:00
Jason Stirnaman e9d3cb46d8
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-04-28 10:29:16 -05:00
Jason Stirnaman bcb1977844 fix(influxdb3): create token --permission parent 2025-04-28 08:43:04 -05:00
Jason Stirnaman 6358ec8b6f chore(influxdb3): Tokens: Guides and references for list and create admin and resource tokens. 2025-04-28 00:16:53 -05:00
Jameelah Mercer 699a51ccbc
Merge branch 'master' into 5950-reference-influxdb3-processing-engine 2025-04-23 10:49:25 -07:00
Jason Stirnaman ed7395d145 fix(influxdb3): Core and Enterprise: remove outdated serve --bearer-token arg (Closes #6007) 2025-04-21 15:59:32 -05:00
Jason Stirnaman ac79824ade feat(auth): Core and Enterprise: add ABAC auth reference 2025-04-21 12:54:13 -05:00
Jason Stirnaman 1dbe6c263f chore: add SOURCE comment anchor 2025-04-21 09:57:26 -05:00
Jason Stirnaman be4a88aca0
Merge branch 'master' into 5950-reference-influxdb3-processing-engine 2025-04-17 15:32:45 -05:00
Jason Stirnaman 4c7c19baaf chore(influxdb3): shared glossary suitable for all InfluxDB 3 versions. Currently, only using for Enterprise and Core 2025-04-15 12:07:18 -05:00
Scott Anderson 25bdf6e608 add --help-all flag to influxdb3 commands 2025-04-14 18:07:22 -06:00