docs(influxdb3): Update token documentation for Docker Compose and CI/CD #6756
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add 'description' field to offline admin token schema alongside 'expiry_millis' - Add new section for Docker Compose with preconfigured admin tokens - Document Docker secrets for secure token management - Add CI/CD setup instructions using environment variables - Standardize on INFLUXDB3_AUTH_TOKEN environment variable Both 'description' and 'expiry_millis' are optional fields supported by the InfluxDB 3 server when reading preconfigured token files.
Contributor
|
jstirnaman
added a commit
that referenced
this pull request
Jan 20, 2026
…es (#6750) * test(influxdb3): Improve InfluxDB 3 Core and Enterprise Docker services Improve Docker Compose services and initialization script for testing InfluxDB 3 Core and Enterprise endpoints. compose.yaml changes: - Add influxdb3-core service with per-worktree data isolation - Add influxdb3-core-noauth service for endpoint testing without auth - Add influxdb3-enterprise service with trial license configuration - Fix env_file handling (use optional path, remove variable override) - Add detailed usage comments for each service New files: - test/scripts/init-influxdb3.sh: Helper script to initialize services, create directories, and validate configuration - Enterprise configuration uses shared data at ~/influxdata-docs/.influxdb3/ to persist license and data across worktrees. - .claude/skills/influxdb3-test-setup/SKILL.md. It covers: 1. Architecture overview - Shows the directory structure for shared vs per-worktree data 2. Quick reference - Common commands table 3. Setup workflows - Core only, Enterprise only, or both 4. Worktree-specific databases - How to create isolated databases named after the worktree 5. Test environment configuration - Setting up .env.test files for code block tests 6. Troubleshooting - Common issues (license, auth, ports) 7. Service comparison - Core vs Enterprise differences The skill references the init script but keeps database creation as a separate workflow step, allowing flexibility for different testing scenarios. * docs(copilot): Document influxdb3-test-setup skill in Copilot instructions (#6751) * Initial plan * docs(copilot): Add influxdb3-test-setup skill documentation to instructions - Add InfluxDB 3 Test Setup subsection under Testing section with quick reference commands - Add Skills section under Specialized Instructions with all available skills - Document influxdb3-test-setup skill alongside existing skills (cypress-e2e-testing, docs-cli-workflow, hugo-template-dev) - Include links to skill files and brief descriptions for discoverability Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * chore(ci): Refactor InfluxDB 3 token handling to use JSON secrets - Store Core and Enterprise tokens as JSON files with metadata - Update SKILL.md instructions for jq-based token extraction - Use Docker secrets for secure token mounting in compose.yaml - Update init-influxdb3.sh to generate JSON token files - Refactor compose.yaml to mount token files as secrets, not binds - Standardize API examples and environment setup for new token format * docs(influxdb3): Update token documentation for Docker Compose and CI/CD (#6756) - Add 'description' field to offline admin token schema alongside 'expiry_millis' - Add new section for Docker Compose with preconfigured admin tokens - Document Docker secrets for secure token management - Add CI/CD setup instructions using environment variables - Standardize on INFLUXDB3_AUTH_TOKEN environment variable Both 'description' and 'expiry_millis' are optional fields supported by the InfluxDB 3 server when reading preconfigured token files. * Revert "docs(influxdb3): Update token documentation for Docker Compose and CI…" (#6757) This reverts commit 5c786ac. --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates InfluxDB 3 Core and Enterprise documentation to better support Docker Compose deployments and CI/CD workflows with preconfigured admin tokens.
Token Format Verification
Both Core and Enterprise tokens are in the correct JSON format:
{ "token": "apiv3_...", "name": "admin", "description": "Admin token for InfluxDB 3 Core/Enterprise" }Docker Secrets Verification
Both services correctly mount tokens as Docker secrets:
/run/secrets/influxdb3-core-token✅/run/secrets/influxdb3-enterprise-admin-token✅Changes
1. Updated Offline Admin Token Schema
File:
content/shared/influxdb3-admin/tokens/admin/preconfigured.mddescriptionfield as an optional field alongsideexpiry_millis2. Added Docker Compose Setup Documentation
File:
content/shared/influxdb3-get-started/setup.mdNew expandable section: "Docker Compose with preconfigured admin tokens"
Rationale
Token File Format Flexibility
The InfluxDB 3 server accepts offline token files with either:
expiry_millis(generated by CLI--offlineoption)description(manually created for documentation/reference)Docker Secrets Benefits
docker inspectoutputCI/CD Support
Enables automated deployments by:
Related
INFLUXDB3_AUTH_TOKENenvironment variable (already documented)