docs(controller): add Telegraf Controller API reference page#7314
Merged
Conversation
Add a reference page that introduces the Telegraf Controller HTTP API, covering the API base path, token authentication, and an example request. Point users to the interactive /api/docs reference served by their own instance instead of rendering the full API reference in the docs. Add cross-links from the token usage and authentication/authorization pages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Vale Style Check Results
✅ Check passed |
Contributor
|
Contributor
|
This was referenced Jun 11, 2026
Collaborator
Author
|
sanderson
added a commit
that referenced
this pull request
Jun 24, 2026
…and Telegraf Enterprise (#7384) * Telegraf Controller licensing documentation (#7262) * feat(telegraf-controller): add licensing section landing page * feat(telegraf-controller): add apply-license licensing page * feat(telegraf-controller): add manage-license licensing page * feat(telegraf-controller): add license-enforcement licensing page * feat(telegraf-controller): add troubleshoot licensing page * feat(telegraf-controller): publish Telegraf Enterprise overview page * feat(telegraf-controller): link Enterprise license management from settings * feat(telegraf-controller): add Enterprise license step to install guide * feat(telegraf-controller): document license and entitlements permissions * feat(telegraf-controller): document LICENSE_FILE_PATH and IdP license dependency * fix(telegraf-controller): apply review feedback to licensing docs * refactor(telegraf-controller): move licensing docs under telegraf-enterprise Relocate licensing pages from /telegraf/controller/licensing/ to /telegraf/controller/telegraf-enterprise/ so license management lives under the broader Telegraf Enterprise section, and update internal links accordingly. Also replaces a few "→" with ">" and em-dashes with commas for consistency. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix(telegraf-controller): add missing What users see in the UI section * chore(tc-licensing): address PR feedback --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> * docs(controller): document audit logging (#7269) * docs(controller): document audit logging Add a new audit-logs section under content/telegraf/controller/ with an overview (what gets audited, storage, integrity, license/permissions), a task-based enable-and-configure page covering retention and event forwarders, and a view-via-API page. Add an Audit logging section to the configuration options reference (eight AUDIT_* env vars and flags) and to the in-app Settings page (retention dropdown). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(controller): added telegraf/enterprise-feature shortcode, removed em-dashes * docs(controller): updates to address PR feedback --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * chore(tc-eula): update telegraf controller EULA for ga * docs(controller): document authentication providers (Local, LDAP, OIDC) (#7277) * docs(controller): document authentication providers (Local, LDAP, OIDC) Add task-based pages for local, LDAP, and OIDC authentication; broaden the authorization reference to cover identity providers; and update the settings and configuration-options reference to include the new authentication knobs. * docs(controller): document enterprise-upgrade shortcode and polish prose Document the new telegraf/enterprise-upgrade shortcode in DOCS-SHORTCODES.md and replace em-dash sentence breaks with regular punctuation across the Telegraf Controller authentication and Enterprise pages. * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * docs(controller): document TELEGRAF_CONTROLLER_TOKEN env var (#7306) * docs(controller): document TELEGRAF_CONTROLLER_TOKEN env var Telegraf 1.39 adds TELEGRAF_CONTROLLER_TOKEN for authenticating remote-configuration requests to Telegraf Controller, sent in the Authorization header using the Bearer scheme. Update the Telegraf Controller docs to recommend the new env var, note the Telegraf 1.39+ version requirement, and document INFLUX_TOKEN as the backward-compatible fallback (sent with the Token scheme; both schemes accepted by Controller). Updates the canonical tokens/use page, the configs/use config-fetch example, and all heartbeat TOML examples and recommendation callouts across configs/create, agents/create, and agents/status. * fix(link): fixed broken anchor link in telegraf controller docs * feat(tc-builder): marks Telegaf Builder as beta, adds menu item state badge (#7309) * feat(telegraf-ga): telegraf enterprise landing (#7308) * feat(telegraf): add Telegraf Enterprise landing page Add /telegraf/enterprise/ as the canonical SEO landing for the Telegraf Enterprise package. Covers what's included, free-vs-Enterprise comparison, licensing model, and routes into Telegraf, Telegraf Controller, and the operational license-management pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(controller): slim Telegraf Enterprise subsection to licensing wrapper The package overview (what's included, comparison, lifecycle) moves to the new canonical /telegraf/enterprise/ landing. The Controller subsection now scopes to licensing in Controller and links out to the canonical landing. Operational child pages (apply-license, manage-license, license-enforcement, troubleshoot) keep their existing URLs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(telegraf): add Telegraf Enterprise page to Telegraf v1 docs Telegraf users now discover the Enterprise option from within the Telegraf docs. The page leads with the agent support angle and links to the canonical /telegraf/enterprise/ landing for the full package overview. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(home): add Telegraf Enterprise card to homepage Adds a third card under the Telegraf section pointing at the new /telegraf/enterprise/ landing. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(telegraf): wire Telegraf Enterprise sidebar and site identity - Add telegraf_enterprise menu in hugo.yml with curated cross-section nav (Telegraf, Telegraf Controller, license-management operations, contact sales). Entries use explicit URLs since none are descendants of /telegraf/enterprise/. - Fix Telegraf Enterprise landing frontmatter to root the page in the telegraf_enterprise menu so the sidebar partial finds it. - Fix header/title.html: the loose 'currentVersion == "enterprise"' check was labeling /telegraf/enterprise/ as "InfluxDB 3 Enterprise". Add an explicit telegraf/enterprise case before the generic match. - Fix sidebar.html search placeholder: previously every non-v1 Telegraf URL was labeled "Search Telegraf Controller". Add an explicit enterprise case. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(telegraf): repoint enterprise-upgrade shortcode to internal landing The CTA now drives users to /telegraf/enterprise/ on docs.influxdata.com instead of jumping straight to the marketing site. Button text changes from "Upgrade to Enterprise" to "Learn about Telegraf Enterprise" since the destination is now informational rather than a purchase path. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(telegraf): repoint Enterprise-offering links to canonical landing Internal links across Controller docs that referenced /telegraf/controller/telegraf-enterprise/ in the context of the Enterprise *offering* (Telegraf Enterprise licenses, features, related docs) now point at the canonical /telegraf/enterprise/ landing. Two exceptions retain Controller-internal targets: - settings.md "Manage your license" now points at the specific manage-license operational page rather than the wrapper. - Operational alias targets and child-page links in the Controller telegraf-enterprise/ subsection are unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(telegraf): polish Telegraf Controller and Enterprise for GA - Bump telegraf_controller in products.yml from 0.0.5-beta to 1.0.0 GA. - Add telegraf_enterprise entry to products.yml so the topnav product selector and other layout consumers can find it (versions/latest reuse the Controller GA numbers since Enterprise's components track Controller). - Homepage: replace "New" badges on InfluxDB 3 Core/Enterprise/Explorer with version chips; mark Telegraf Controller and Telegraf Enterprise as "New"; tighten Enterprise card copy ("Upgrade to Telegraf Enterprise" CTA points at marketing contact-sales). - Topnav product selector: add Telegraf Enterprise; flip Controller from beta to New. - Drop telegraf/controller from special-state.html productPathWhitelist — Controller is GA, no longer needs the beta special-state banner. - Add .alt-color link style (gradient underline + arrow on hover) for the "Which InfluxDB 3 should I use?" homepage CTA. - Tighten feedback.html community-link conditional so non-InfluxDB products see only Slack as the preferred community channel. - Telegraf Enterprise licensing wrapper: add {{< telegraf/enterprise-upgrade >}} shortcode so the wrapper carries a visible CTA back to the canonical landing. - Update apply/manage/license-enforcement/troubleshoot pages' menu parent from "Telegraf Enterprise" to "Telegraf Enterprise licensing" to match the slim wrapper's new title. - Revert enterprise-upgrade shortcode CTA copy to "Upgrade to Enterprise". Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix(styles): fix responsive styles for Telegraf Enterprise CTA --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(controller): cross-link user sign-in and API token sections (#7324) Co-authored-by: Claude <claude@anthropic.com> * chore(controller): remove Docker examples, add powershell examples (#7315) * chore(controller): remove Docker examples, add powershell examples * chore(controller): removed ephemeral planning docs * feat(telegraf): standardize Enterprise contact-sales CTA and menu (#7355) Centralize the Telegraf Enterprise "contact sales" CTA on a campaign URL via the cta-link shortcode and product link config, add magenta/large button styles and a purchase landing page, and drive the telegraf_enterprise section nav from page frontmatter instead of hardcoded config menu entries. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs(controller): document public endpoints settings (#7354) Add a Public endpoints section to the Telegraf Controller Settings page describing the cosmetic User Interface URL, API URL, and Heartbeat URL settings, their auto-detected fallbacks, validation rules, and how to set them. These are display-only base URLs configured through the Settings UI or API, with no CLI flags or environment variables. * chore(tc-licensing): updated language around licensing * docs(controller): add Telegraf Controller API reference page (#7314) Add a reference page that introduces the Telegraf Controller HTTP API, covering the API base path, token authentication, and an example request. Point users to the interactive /api/docs reference served by their own instance instead of rendering the full API reference in the docs. Add cross-links from the token usage and authentication/authorization pages. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Get started with Telegraf Controller (#7332) * WIP get started with telegraf controller * WIP get started with telegraf controller * WIP telegraf controller get started * chore(tc-gs): WIP telegraf controller getting started * feat(tc-get-started): minor updates to the telegraf controller getting started guide * Update commands syntax in get-started.md * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * chore(tc): misc updates --------- Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * chore(img): add telegraf controller screenshots (#7380) * chore(img): WIP updated telegraf controller images * chore(img): add telegraf controller screenshots, update telegraf marketo form * docs(controller): document PostgreSQL and server TLS options (#7379) Add PostgreSQL client TLS configuration (sslmode, sslrootcert, DATABASE_CA_CERT/PGSSLROOTCERT, DATABASE_SSL_NO_VERIFY) to the configuration options reference and a PostgreSQL-over-TLS example to the install guide. Update the server TLS section with the new --ssl-cert and --ssl-key flags and note that HTTPS covers the web interface, API, and heartbeat service. * chore(notif): adds telegraf enterprise GA announcement (#7382) * chore(tc-version): WIP update tc download links * fix(marketo): update marketo form config to match standard convention * release(telegraf-controller): add Telegraf Controller v1.0.0 release notes (#7383) * chore(misc): added tc downloads, updated tc get started, updated eula date --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Claude <claude@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
/api/docsreference served by their own instance instead of rendering the full API reference in the docs.Checklist
npx hugo --quiet)