Merge branch 'master' into 5949-add-api-reference-examples-to-influxdb3

pull/6002/head
Jameelah Mercer 2025-05-02 11:22:32 -07:00 committed by GitHub
commit 38a9aaf6b0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 46 additions and 47 deletions

View File

@ -1,51 +1,64 @@
# GitHub Copilot Instructions for InfluxData Documentation # GitHub Copilot Instructions for InfluxData Documentation
## Purpose and Scope ## Purpose and scope
GitHub Copilot should help document InfluxData products by creating clear, accurate technical content with proper code examples, frontmatter, and formatting. GitHub Copilot should help document InfluxData products by creating clear, accurate technical content with proper code examples, frontmatter, and formatting.
## Documentation Structure ## Documentation structure
- **Product version data**: `/data/products.yml` - **Product version data**: `/data/products.yml`
- **Products**: - **Products**:
- InfluxDB 3 Core - InfluxDB 3 Core
- Documentation source path: `/content/influxdb3/core` - Documentation source path: `/content/influxdb3/core`
- Published for the web: https://docs.influxdata.com/influxdb3/core/
- Code repositories: https://github.com/influxdata/influxdb, https://github.com/influxdata/influxdb3_core - Code repositories: https://github.com/influxdata/influxdb, https://github.com/influxdata/influxdb3_core
- InfluxDB 3 Enterprise - InfluxDB 3 Enterprise
- Documentation source path: `/content/influxdb3/enterprise` - Documentation source path: `/content/influxdb3/enterprise`
- Published for the web: https://docs.influxdata.com/influxdb3/enterprise/
- Code repositories: https://github.com/influxdata/influxdb, https://github.com/influxdata/influxdb3_enterprise - Code repositories: https://github.com/influxdata/influxdb, https://github.com/influxdata/influxdb3_enterprise
- InfluxDB Cloud Dedicated - InfluxDB Cloud Dedicated
- Documentation source path: `/content/influxdb3/cloud-dedicated` - Documentation source path: `/content/influxdb3/cloud-dedicated`
- Published for the web: https://docs.influxdata.com/influxdb3/cloud-dedicated/
- Code repository: https://github.com/influxdata/influxdb - Code repository: https://github.com/influxdata/influxdb
- InfluxDB Cloud Serverless - InfluxDB Cloud Serverless
- Documentation source path: `/content/influxdb3/cloud-serverless` - Documentation source path: `/content/influxdb3/cloud-serverless`
- Published for the web: https://docs.influxdata.com/influxdb3/cloud-serverless/
- Code repository: https://github.com/influxdata/idpe - Code repository: https://github.com/influxdata/idpe
- InfluxDB Cloud v2 (TSM) - InfluxDB Cloud v2 (TSM)
- Documentation source path: `/content/influxdb/cloud` - Documentation source path: `/content/influxdb/cloud`
- Published for the web: https://docs.influxdata.com/influxdb/cloud/
- Code repository: https://github.com/influxdata/idpe - Code repository: https://github.com/influxdata/idpe
- InfluxDB Clustered - InfluxDB Clustered
- Documentation source path: `/content/influxdb3/clustered` - Documentation source path: `/content/influxdb3/clustered`
- Published for the web: https://docs.influxdata.com/influxdb3/clustered/
- Code repository: https://github.com/influxdata/influxdb - Code repository: https://github.com/influxdata/influxdb
- InfluxDB Enterprise v1 (1.x) - InfluxDB Enterprise v1 (1.x)
- Documentation source path: `/content/influxdb/enterprise_influxdb` - Documentation source path: `/content/influxdb/enterprise_influxdb`
- Published for the web: https://docs.influxdata.com/enterprise_influxdb/v1/
- Code repository: https://github.com/influxdata/influxdb - Code repository: https://github.com/influxdata/influxdb
- InfluxDB OSS 1.x - InfluxDB OSS 1.x
- Documentation source path: `/content/influxdb/v1` - Documentation source path: `/content/influxdb/v1`
- Published for the web: https://docs.influxdata.com/influxdb/v1/
- Code repository: https://github.com/influxdata/influxdb - Code repository: https://github.com/influxdata/influxdb
- InfluxDB OSS 2.x - InfluxDB OSS 2.x
- Documentation source path: `/content/influxdb/v2` - Documentation source path: `/content/influxdb/v2`
- Published for the web: https://docs.influxdata.com/influxdb/v2/
- Code repository: https://github.com/influxdata/influxdb - Code repository: https://github.com/influxdata/influxdb
- Telegraf - Telegraf
- Documentation source path: `/content/telegraf/v1` - Documentation source path: `/content/telegraf/v1`
- Published for the web: https://docs.influxdata.com/telegraf/v1/
- Code repository: https://github.com/influxdata/telegraf - Code repository: https://github.com/influxdata/telegraf
- Kapacitor - Kapacitor
- Documentation source path: `/content/kapacitor/v1` - Documentation source path: `/content/kapacitor/v1`
- Published for the web: https://docs.influxdata.com/kapacitor/v1/
- Code repository: https://github.com/influxdata/kapacitor - Code repository: https://github.com/influxdata/kapacitor
- Chronograf - Chronograf
- Documentation source path: `/content/chronograf/v1` - Documentation source path: `/content/chronograf/v1`
- Published for the web: https://docs.influxdata.com/chronograf/v1/
- Code repository: https://github.com/influxdata/chronograf - Code repository: https://github.com/influxdata/chronograf
- Flux - Flux
- Documentation source path: `/content/flux/v0` - Documentation source path: `/content/flux/v0`
- Published for the web: https://docs.influxdata.com/flux/v0/
- Code repository: https://github.com/influxdata/flux - Code repository: https://github.com/influxdata/flux
- **InfluxData-supported tools**: - **InfluxData-supported tools**:
- InfluxDB API client libraries - InfluxDB API client libraries
@ -57,11 +70,19 @@ GitHub Copilot should help document InfluxData products by creating clear, accur
- **Repository**: https://github.com/influxdata/docs-v2 - **Repository**: https://github.com/influxdata/docs-v2
- **Framework**: Hugo static site generator - **Framework**: Hugo static site generator
## Style Guidelines ## Style guidelines
- Follow Google Developer Documentation style guidelines - Follow Google Developer Documentation style guidelines
- For API references, follow YouTube Data API style - For API references, follow YouTube Data API style
- Use semantic line feeds (one sentence per line) - Use semantic line feeds (one sentence per line)
- Format code examples to fit within 80 characters
- Command line examples:
- Should be formatted as code blocks
- Should use long options (e.g., `--option` instead of `-o`)
- Use cURL for API examples
- Format to fit within 80 characters
- Should use `--data-urlencode` for query parameters
- Should use `--header` for headers
- Use only h2-h6 headings in content (h1 comes from frontmatter title properties) - Use only h2-h6 headings in content (h1 comes from frontmatter title properties)
- Use sentence case for headings - Use sentence case for headings
- Use GitHub callout syntax - Use GitHub callout syntax
@ -69,7 +90,7 @@ GitHub Copilot should help document InfluxData products by creating clear, accur
- Use appropriate product names and versions consistently - Use appropriate product names and versions consistently
- Follow InfluxData vocabulary guidelines - Follow InfluxData vocabulary guidelines
## Markdown and Shortcodes ## Markdown and shortcodes
- Include proper frontmatter for each page: - Include proper frontmatter for each page:
@ -93,7 +114,7 @@ GitHub Copilot should help document InfluxData products by creating clear, accur
- Navigation: `{{< page-nav >}}` - Navigation: `{{< page-nav >}}`
- Diagrams: `{{< diagram >}}`, `{{< filesystem-diagram >}}` - Diagrams: `{{< diagram >}}`, `{{< filesystem-diagram >}}`
## Code Examples and Testing ## Code examples and testing
- Provide complete, working examples with proper testing annotations: - Provide complete, working examples with proper testing annotations:
@ -124,7 +145,7 @@ Table: keys: [_start, _stop, _field, _measurement]
- Include necessary environment variables - Include necessary environment variables
- Show proper credential handling for authenticated commands - Show proper credential handling for authenticated commands
## API Documentation ## API documentation
- `/api-docs` contains OpenAPI spec files used for API reference documentation - `/api-docs` contains OpenAPI spec files used for API reference documentation
- Follow OpenAPI specification patterns - Follow OpenAPI specification patterns
@ -132,20 +153,28 @@ Table: keys: [_start, _stop, _field, _measurement]
- Include complete request/response examples - Include complete request/response examples
- Document required headers and authentication - Document required headers and authentication
## Versioning and Product Differentiation ## Versioning and product differentiation
- Clearly distinguish between different InfluxDB versions (1.x, 2.x, 3.x) - Clearly distinguish between different InfluxDB versions (1.x, 2.x, 3.x)
- Use correct terminology for each product variant - Use correct terminology for each product variant
- Apply appropriate UI descriptions and screenshots - Apply appropriate UI descriptions and screenshots
- Reference appropriate query language per version - Reference appropriate query language per version
## Development Tools ## Development tools
- Vale.sh linter for style checking - Vale.sh linter for style checking
- Configuration file: `.vale.ini`
- Docker for local development and testing - Docker for local development and testing
- pytest and pytest-codeblocks for validating code examples - pytest and pytest-codeblocks for validating code examples
- Pre-commit hooks for quality assurance - Use cypress for testing documentation UI and links
- Prettier for code formatting
- ESLint for JavaScript and TypeScript linting
- Lefthook (NPM package) for managing pre-commit hooks for quality assurance
## Code style
- Use modern JavaScript (ES6+) syntax
## Related repositories ## Related repositories
- **Internal dcumentation assistance requests**: https://github.com/influxdata/DAR/issues - **Internal documentation assistance requests**: https://github.com/influxdata/DAR/issues Documentation

View File

@ -201,4 +201,4 @@ Manually-created management tokens authenticate directly with your InfluxDB
cluster and don't require human interaction with your identity provider. cluster and don't require human interaction with your identity provider.
<!-- - Infrastructure management --> <!-- - Infrastructure management -->
{{< page-nav next="/influxdb/clustered/get-started/setup/" >}} {{< page-nav next="/influxdb3/cloud-dedicated/get-started/setup/" >}}

View File

@ -289,7 +289,7 @@ influxctl query \
> #### Query using stored credentials > #### Query using stored credentials
> >
> Optionally, you can configure `database` and `token` query credentials in your `influxctl` > Optionally, you can configure `database` and `token` query credentials in your `influxctl`
> [connection profile](/influxdb/clustered/reference/cli/influxctl/#create-a-configuration-file). > [connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#create-a-configuration-file).
> >
> The `--database` and `--token` command line flags override credentials in your > The `--database` and `--token` command line flags override credentials in your
> configuration file. > configuration file.

View File

@ -68,7 +68,7 @@ to write the [home sensor sample data](#home-sensor-data-line-protocol) to your
{{< product-name omit=" Clustered" >}} cluster. {{< product-name omit=" Clustered" >}} cluster.
Provide the following: Provide the following:
- The [database](/influxdb/clustered/admin/databases/) name using the - The [database](/influxdb3/cloud-dedicated/admin/databases/) name using the
`--database` flag `--database` flag
- A [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) - A [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens)
(with write permissions on the target database) using the `--token` flag (with write permissions on the target database) using the `--token` flag

View File

@ -82,7 +82,6 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
| | `--datafusion-config` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-config)_ | | | `--datafusion-config` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-config)_ |
| | `--max-http-request-size` | _See [configuration options](/influxdb3/core/reference/config-options/#max-http-request-size)_ | | | `--max-http-request-size` | _See [configuration options](/influxdb3/core/reference/config-options/#max-http-request-size)_ |
| | `--http-bind` | _See [configuration options](/influxdb3/core/reference/config-options/#http-bind)_ | | | `--http-bind` | _See [configuration options](/influxdb3/core/reference/config-options/#http-bind)_ |
| | `--ram-pool-data-bytes` | _See [configuration options](/influxdb3/core/reference/config-options/#ram-pool-data-bytes)_ |
| | `--exec-mem-pool-bytes` | _See [configuration options](/influxdb3/core/reference/config-options/#exec-mem-pool-bytes)_ | | | `--exec-mem-pool-bytes` | _See [configuration options](/influxdb3/core/reference/config-options/#exec-mem-pool-bytes)_ |
| | `--gen1-duration` | _See [configuration options](/influxdb3/core/reference/config-options/#gen1-duration)_ | | | `--gen1-duration` | _See [configuration options](/influxdb3/core/reference/config-options/#gen1-duration)_ |
| | `--wal-flush-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#wal-flush-interval)_ | | | `--wal-flush-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#wal-flush-interval)_ |
@ -169,4 +168,4 @@ LOG_FILTER=debug influxdb3 serve \
Verify your `--object-store` setting and ensure all required parameters for that storage type are provided. Verify your `--object-store` setting and ensure all required parameters for that storage type are provided.
- **Permission errors when using S3, Google Cloud, or Azure storage** - **Permission errors when using S3, Google Cloud, or Azure storage**
Check that your authentication credentials are correct and have sufficient permissions. Check that your authentication credentials are correct and have sufficient permissions.

View File

@ -107,7 +107,6 @@ influxdb3 serve
- [max-http-request-size](#max-http-request-size) - [max-http-request-size](#max-http-request-size)
- [http-bind](#http-bind) - [http-bind](#http-bind)
- [Memory](#memory) - [Memory](#memory)
- [ram-pool-data-bytes](#ram-pool-data-bytes)
- [exec-mem-pool-bytes](#exec-mem-pool-bytes) - [exec-mem-pool-bytes](#exec-mem-pool-bytes)
- [buffer-mem-limit-mb](#buffer-mem-limit-mb) - [buffer-mem-limit-mb](#buffer-mem-limit-mb)
- [force-snapshot-mem-threshold](#force-snapshot-mem-threshold) - [force-snapshot-mem-threshold](#force-snapshot-mem-threshold)
@ -779,23 +778,10 @@ Defines the address on which InfluxDB serves HTTP API requests.
### Memory ### Memory
- [ram-pool-data-bytes](#ram-pool-data-bytes)
- [exec-mem-pool-bytes](#exec-mem-pool-bytes) - [exec-mem-pool-bytes](#exec-mem-pool-bytes)
- [buffer-mem-limit-mb](#buffer-mem-limit-mb) - [buffer-mem-limit-mb](#buffer-mem-limit-mb)
- [force-snapshot-mem-threshold](#force-snapshot-mem-threshold) - [force-snapshot-mem-threshold](#force-snapshot-mem-threshold)
#### ram-pool-data-bytes
Specifies the size of the RAM cache used to store data, in bytes.
**Default:** `1073741824`
| influxdb3 serve option | Environment variable |
| :---------------------- | :------------------------------ |
| `--ram-pool-data-bytes` | `INFLUXDB3_RAM_POOL_DATA_BYTES` |
---
#### exec-mem-pool-bytes #### exec-mem-pool-bytes
Specifies the size of the memory pool used during query execution, in bytes. Specifies the size of the memory pool used during query execution, in bytes.

View File

@ -87,7 +87,6 @@ influxdb3 serve [OPTIONS] \
| | `--datafusion-config` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-config)_ | | | `--datafusion-config` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-config)_ |
| | `--max-http-request-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#max-http-request-size)_ | | | `--max-http-request-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#max-http-request-size)_ |
| | `--http-bind` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#http-bind)_ | | | `--http-bind` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#http-bind)_ |
| | `--ram-pool-data-bytes` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#ram-pool-data-bytes)_ |
| | `--exec-mem-pool-bytes` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#exec-mem-pool-bytes)_ | | | `--exec-mem-pool-bytes` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#exec-mem-pool-bytes)_ |
| | `--gen1-duration` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#gen1-duration)_ | | | `--gen1-duration` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#gen1-duration)_ |
| | `--wal-flush-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-flush-interval)_ | | | `--wal-flush-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-flush-interval)_ |
@ -218,4 +217,4 @@ LOG_FILTER=debug influxdb3 serve \
Verify your `--object-store` setting and ensure all required parameters for that storage type are provided. Verify your `--object-store` setting and ensure all required parameters for that storage type are provided.
- **Permission errors when using S3, Google Cloud, or Azure storage** - **Permission errors when using S3, Google Cloud, or Azure storage**
Check that your authentication credentials are correct and have sufficient permissions. Check that your authentication credentials are correct and have sufficient permissions.

View File

@ -111,7 +111,6 @@ influxdb3 serve
- [max-http-request-size](#max-http-request-size) - [max-http-request-size](#max-http-request-size)
- [http-bind](#http-bind) - [http-bind](#http-bind)
- [Memory](#memory) - [Memory](#memory)
- [ram-pool-data-bytes](#ram-pool-data-bytes)
- [exec-mem-pool-bytes](#exec-mem-pool-bytes) - [exec-mem-pool-bytes](#exec-mem-pool-bytes)
- [force-snapshot-mem-threshold](#force-snapshot-mem-threshold) - [force-snapshot-mem-threshold](#force-snapshot-mem-threshold)
- [Write-Ahead Log (WAL)](#write-ahead-log-wal) - [Write-Ahead Log (WAL)](#write-ahead-log-wal)
@ -827,23 +826,10 @@ Defines the address on which InfluxDB serves HTTP API requests.
### Memory ### Memory
- [ram-pool-data-bytes](#ram-pool-data-bytes)
- [exec-mem-pool-bytes](#exec-mem-pool-bytes) - [exec-mem-pool-bytes](#exec-mem-pool-bytes)
- [buffer-mem-limit-mb](#buffer-mem-limit-mb) - [buffer-mem-limit-mb](#buffer-mem-limit-mb)
- [force-snapshot-mem-threshold](#force-snapshot-mem-threshold) - [force-snapshot-mem-threshold](#force-snapshot-mem-threshold)
#### ram-pool-data-bytes
Specifies the size of the RAM cache used to store data, in bytes.
**Default:** `1073741824`
| influxdb3 serve option | Environment variable |
| :---------------------- | :------------------------------ |
| `--ram-pool-data-bytes` | `INFLUXDB3_RAM_POOL_DATA_BYTES` |
---
#### exec-mem-pool-bytes #### exec-mem-pool-bytes
Specifies the size of memory pool used during query execution. Specifies the size of memory pool used during query execution.

View File

@ -25,7 +25,7 @@
- Catalog limits for databases, tables, and columns are now configurable using `influxdb3 serve` options: - Catalog limits for databases, tables, and columns are now configurable using `influxdb3 serve` options:
- `--num-database-limit` - `--num-database-limit`
- `--num-table-limit` - `--num-table-limit`
- `--num-columns-per-table-limit` - `--num-total-columns-per-table-limit`
- Improvements to licensing prompts for clarity - Improvements to licensing prompts for clarity
- Other general performance improvements - Other general performance improvements
@ -144,4 +144,4 @@ For Enterprise, additional parameters for the `serve` command have been consolid
| `--read-from-node-ids`<br>`--compact-from-node-ids` | `--cluster-id` | | `--read-from-node-ids`<br>`--compact-from-node-ids` | `--cluster-id` |
| `--run-compactions`<br>`--mode=compactor` | `--mode=compact`<br>`--mode=compact` | | `--run-compactions`<br>`--mode=compactor` | `--mode=compact`<br>`--mode=compact` |
In addition to the above changes, `--cluster-id` is now a required parameter for all new instances. In addition to the above changes, `--cluster-id` is now a required parameter for all new instances.